Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.APIGateway.GenerateClientCertificate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Generates a ClientCertificate resource.

Creating a Request

generateClientCertificate :: GenerateClientCertificate #

Creates a value of GenerateClientCertificate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gccDescription - The description of the ClientCertificate .

data GenerateClientCertificate #

A request to generate a ClientCertificate resource.

See: generateClientCertificate smart constructor.

Instances

Eq GenerateClientCertificate #
Methods (==) :: GenerateClientCertificate -> GenerateClientCertificate -> Bool # (/=) :: GenerateClientCertificate -> GenerateClientCertificate -> Bool #
Data GenerateClientCertificate #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GenerateClientCertificate -> c GenerateClientCertificate # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GenerateClientCertificate # toConstr :: GenerateClientCertificate -> Constr # dataTypeOf :: GenerateClientCertificate -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c GenerateClientCertificate) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GenerateClientCertificate) # gmapT :: (forall b. Data b => b -> b) -> GenerateClientCertificate -> GenerateClientCertificate # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GenerateClientCertificate -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GenerateClientCertificate -> r # gmapQ :: (forall d. Data d => d -> u) -> GenerateClientCertificate -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GenerateClientCertificate -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GenerateClientCertificate -> m GenerateClientCertificate # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GenerateClientCertificate -> m GenerateClientCertificate # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GenerateClientCertificate -> m GenerateClientCertificate #
Read GenerateClientCertificate #
Methods readsPrec :: Int -> ReadS GenerateClientCertificate # readList :: ReadS [GenerateClientCertificate] # readPrec :: ReadPrec GenerateClientCertificate # readListPrec :: ReadPrec [GenerateClientCertificate] #
Show GenerateClientCertificate #
Methods showsPrec :: Int -> GenerateClientCertificate -> ShowS # show :: GenerateClientCertificate -> String # showList :: [GenerateClientCertificate] -> ShowS #
Generic GenerateClientCertificate #
Associated Types type Rep GenerateClientCertificate :: * -> * # Methods from :: GenerateClientCertificate -> Rep GenerateClientCertificate x # to :: Rep GenerateClientCertificate x -> GenerateClientCertificate #
Hashable GenerateClientCertificate #
Methods hashWithSalt :: Int -> GenerateClientCertificate -> Int # hash :: GenerateClientCertificate -> Int #
ToJSON GenerateClientCertificate #
Methods toJSON :: GenerateClientCertificate -> Value # toEncoding :: GenerateClientCertificate -> Encoding # toJSONList :: [GenerateClientCertificate] -> Value # toEncodingList :: [GenerateClientCertificate] -> Encoding #
NFData GenerateClientCertificate #
Methods rnf :: GenerateClientCertificate -> () #
AWSRequest GenerateClientCertificate #
Associated Types type Rs GenerateClientCertificate :: * # Methods request :: GenerateClientCertificate -> Request GenerateClientCertificate # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GenerateClientCertificate -> ClientResponse -> m (Response GenerateClientCertificate) #
ToHeaders GenerateClientCertificate #
Methods toHeaders :: GenerateClientCertificate -> [Header] #
ToPath GenerateClientCertificate #
Methods toPath :: GenerateClientCertificate -> ByteString #
ToQuery GenerateClientCertificate #
Methods toQuery :: GenerateClientCertificate -> QueryString #
type Rep GenerateClientCertificate #
type Rep GenerateClientCertificate = D1 * (MetaData "GenerateClientCertificate" "Network.AWS.APIGateway.GenerateClientCertificate" "amazonka-apigateway-1.6.0-6sEXF2HuGsL3K99fRnfViy" True) (C1 * (MetaCons "GenerateClientCertificate'" PrefixI True) (S1 * (MetaSel (Just Symbol "_gccDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Text))))
type Rs GenerateClientCertificate #
type Rs GenerateClientCertificate = ClientCertificate

Request Lenses

gccDescription :: Lens' GenerateClientCertificate (Maybe Text) #

The description of the ClientCertificate .

Destructuring the Response

clientCertificate :: ClientCertificate #

Creates a value of ClientCertificate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ccPemEncodedCertificate - The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
ccClientCertificateId - The identifier of the client certificate.
ccCreatedDate - The timestamp when the client certificate was created.
ccExpirationDate - The timestamp when the client certificate will expire.
ccDescription - The description of the client certificate.

data ClientCertificate #

Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.Use Client-Side Certificate

See: clientCertificate smart constructor.

Instances

Eq ClientCertificate #
Methods (==) :: ClientCertificate -> ClientCertificate -> Bool # (/=) :: ClientCertificate -> ClientCertificate -> Bool #
Data ClientCertificate #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ClientCertificate -> c ClientCertificate # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ClientCertificate # toConstr :: ClientCertificate -> Constr # dataTypeOf :: ClientCertificate -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c ClientCertificate) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ClientCertificate) # gmapT :: (forall b. Data b => b -> b) -> ClientCertificate -> ClientCertificate # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ClientCertificate -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ClientCertificate -> r # gmapQ :: (forall d. Data d => d -> u) -> ClientCertificate -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ClientCertificate -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ClientCertificate -> m ClientCertificate # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ClientCertificate -> m ClientCertificate # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ClientCertificate -> m ClientCertificate #
Read ClientCertificate #
Methods readsPrec :: Int -> ReadS ClientCertificate # readList :: ReadS [ClientCertificate] # readPrec :: ReadPrec ClientCertificate # readListPrec :: ReadPrec [ClientCertificate] #
Show ClientCertificate #
Methods showsPrec :: Int -> ClientCertificate -> ShowS # show :: ClientCertificate -> String # showList :: [ClientCertificate] -> ShowS #
Generic ClientCertificate #
Associated Types type Rep ClientCertificate :: * -> * # Methods from :: ClientCertificate -> Rep ClientCertificate x # to :: Rep ClientCertificate x -> ClientCertificate #
Hashable ClientCertificate #
Methods hashWithSalt :: Int -> ClientCertificate -> Int # hash :: ClientCertificate -> Int #
FromJSON ClientCertificate #
Methods parseJSON :: Value -> Parser ClientCertificate # parseJSONList :: Value -> Parser [ClientCertificate] #
NFData ClientCertificate #
Methods rnf :: ClientCertificate -> () #
type Rep ClientCertificate #
type Rep ClientCertificate = D1 * (MetaData "ClientCertificate" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.0-6sEXF2HuGsL3K99fRnfViy" False) (C1 * (MetaCons "ClientCertificate'" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "_ccPemEncodedCertificate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ccClientCertificateId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((::) (S1 * (MetaSel (Just Symbol "_ccCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) ((::) (S1 * (MetaSel (Just Symbol "_ccExpirationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_ccDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))

Response Lenses

ccPemEncodedCertificate :: Lens' ClientCertificate (Maybe Text) #

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

ccClientCertificateId :: Lens' ClientCertificate (Maybe Text) #

The identifier of the client certificate.

ccCreatedDate :: Lens' ClientCertificate (Maybe UTCTime) #

The timestamp when the client certificate was created.

ccExpirationDate :: Lens' ClientCertificate (Maybe UTCTime) #

The timestamp when the client certificate will expire.

ccDescription :: Lens' ClientCertificate (Maybe Text) #

The description of the client certificate.