Copyright	(c) 2013-2021 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

Amazonka.APIGateway.GenerateClientCertificate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Generates a ClientCertificate resource.

Synopsis

data GenerateClientCertificate = GenerateClientCertificate' {
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newGenerateClientCertificate :: GenerateClientCertificate
generateClientCertificate_description :: Lens' GenerateClientCertificate (Maybe Text)
generateClientCertificate_tags :: Lens' GenerateClientCertificate (Maybe (HashMap Text Text))
data ClientCertificate = ClientCertificate' {
- pemEncodedCertificate :: Maybe Text
- clientCertificateId :: Maybe Text
- createdDate :: Maybe POSIX
- expirationDate :: Maybe POSIX
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newClientCertificate :: ClientCertificate
clientCertificate_pemEncodedCertificate :: Lens' ClientCertificate (Maybe Text)
clientCertificate_clientCertificateId :: Lens' ClientCertificate (Maybe Text)
clientCertificate_createdDate :: Lens' ClientCertificate (Maybe UTCTime)
clientCertificate_expirationDate :: Lens' ClientCertificate (Maybe UTCTime)
clientCertificate_description :: Lens' ClientCertificate (Maybe Text)
clientCertificate_tags :: Lens' ClientCertificate (Maybe (HashMap Text Text))

Creating a Request

data GenerateClientCertificate Source #

A request to generate a ClientCertificate resource.

See: newGenerateClientCertificate smart constructor.

Constructors

GenerateClientCertificate'
Fields description :: Maybe Text The description of the ClientCertificate. tags :: Maybe (HashMap Text Text) The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with `aws:`. The tag value can be up to 256 characters.

Instances

Instances details

Eq GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods (==) :: GenerateClientCertificate -> GenerateClientCertificate -> Bool # (/=) :: GenerateClientCertificate -> GenerateClientCertificate -> Bool #
Read GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods readsPrec :: Int -> ReadS GenerateClientCertificate # readList :: ReadS [GenerateClientCertificate] # readPrec :: ReadPrec GenerateClientCertificate # readListPrec :: ReadPrec [GenerateClientCertificate] #
Show GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods showsPrec :: Int -> GenerateClientCertificate -> ShowS # show :: GenerateClientCertificate -> String # showList :: [GenerateClientCertificate] -> ShowS #
Generic GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Associated Types type Rep GenerateClientCertificate :: Type -> Type # Methods from :: GenerateClientCertificate -> Rep GenerateClientCertificate x # to :: Rep GenerateClientCertificate x -> GenerateClientCertificate #
NFData GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods rnf :: GenerateClientCertificate -> () #
Hashable GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods hashWithSalt :: Int -> GenerateClientCertificate -> Int # hash :: GenerateClientCertificate -> Int #
ToJSON GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods toJSON :: GenerateClientCertificate -> Value # toEncoding :: GenerateClientCertificate -> Encoding # toJSONList :: [GenerateClientCertificate] -> Value # toEncodingList :: [GenerateClientCertificate] -> Encoding #
AWSRequest GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Associated Types type AWSResponse GenerateClientCertificate # Methods request :: GenerateClientCertificate -> Request GenerateClientCertificate # response :: MonadResource m => Logger -> Service -> Proxy GenerateClientCertificate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GenerateClientCertificate))) #
ToHeaders GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods toHeaders :: GenerateClientCertificate -> [Header] #
ToPath GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods toPath :: GenerateClientCertificate -> ByteString #
ToQuery GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods toQuery :: GenerateClientCertificate -> QueryString #
type Rep GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate type Rep GenerateClientCertificate = D1 ('MetaData "GenerateClientCertificate" "Amazonka.APIGateway.GenerateClientCertificate" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GenerateClientCertificate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))
type AWSResponse GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate type AWSResponse GenerateClientCertificate = ClientCertificate

newGenerateClientCertificate :: GenerateClientCertificate Source #

Create a value of GenerateClientCertificate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:GenerateClientCertificate', generateClientCertificate_description - The description of the ClientCertificate.

$sel:tags:GenerateClientCertificate', generateClientCertificate_tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Request Lenses

generateClientCertificate_description :: Lens' GenerateClientCertificate (Maybe Text) Source #

The description of the ClientCertificate.

generateClientCertificate_tags :: Lens' GenerateClientCertificate (Maybe (HashMap Text Text)) Source #

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Destructuring the Response

data ClientCertificate Source #

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: newClientCertificate smart constructor.

Constructors

ClientCertificate'

Fields

pemEncodedCertificate :: Maybe Text
The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
clientCertificateId :: Maybe Text
The identifier of the client certificate.
createdDate :: Maybe POSIX
The timestamp when the client certificate was created.
expirationDate :: Maybe POSIX
The timestamp when the client certificate will expire.
description :: Maybe Text
The description of the client certificate.
tags :: Maybe (HashMap Text Text)
The collection of tags. Each tag element is associated with a given resource.

Instances

Instances details

Eq ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods (==) :: ClientCertificate -> ClientCertificate -> Bool # (/=) :: ClientCertificate -> ClientCertificate -> Bool #
Read ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods readsPrec :: Int -> ReadS ClientCertificate # readList :: ReadS [ClientCertificate] # readPrec :: ReadPrec ClientCertificate # readListPrec :: ReadPrec [ClientCertificate] #
Show ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods showsPrec :: Int -> ClientCertificate -> ShowS # show :: ClientCertificate -> String # showList :: [ClientCertificate] -> ShowS #
Generic ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Associated Types type Rep ClientCertificate :: Type -> Type # Methods from :: ClientCertificate -> Rep ClientCertificate x # to :: Rep ClientCertificate x -> ClientCertificate #
NFData ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods rnf :: ClientCertificate -> () #
Hashable ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods hashWithSalt :: Int -> ClientCertificate -> Int # hash :: ClientCertificate -> Int #
FromJSON ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods parseJSON :: Value -> Parser ClientCertificate # parseJSONList :: Value -> Parser [ClientCertificate] #
type Rep ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate type Rep ClientCertificate = D1 ('MetaData "ClientCertificate" "Amazonka.APIGateway.Types.ClientCertificate" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "ClientCertificate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pemEncodedCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "expirationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))

newClientCertificate :: ClientCertificate Source #

Create a value of ClientCertificate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:pemEncodedCertificate:ClientCertificate', clientCertificate_pemEncodedCertificate - The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

$sel:clientCertificateId:ClientCertificate', clientCertificate_clientCertificateId - The identifier of the client certificate.

$sel:createdDate:ClientCertificate', clientCertificate_createdDate - The timestamp when the client certificate was created.

$sel:expirationDate:ClientCertificate', clientCertificate_expirationDate - The timestamp when the client certificate will expire.

$sel:description:ClientCertificate', clientCertificate_description - The description of the client certificate.

$sel:tags:ClientCertificate', clientCertificate_tags - The collection of tags. Each tag element is associated with a given resource.

Response Lenses

clientCertificate_pemEncodedCertificate :: Lens' ClientCertificate (Maybe Text) Source #

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

clientCertificate_clientCertificateId :: Lens' ClientCertificate (Maybe Text) Source #

The identifier of the client certificate.

clientCertificate_createdDate :: Lens' ClientCertificate (Maybe UTCTime) Source #

The timestamp when the client certificate was created.

clientCertificate_expirationDate :: Lens' ClientCertificate (Maybe UTCTime) Source #

The timestamp when the client certificate will expire.

clientCertificate_description :: Lens' ClientCertificate (Maybe Text) Source #

The description of the client certificate.

clientCertificate_tags :: Lens' ClientCertificate (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.