Copyright | (c) 2013-2017 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 |
Generates a ClientCertificate
resource.
- generateClientCertificate :: GenerateClientCertificate
- data GenerateClientCertificate
- gccDescription :: Lens' GenerateClientCertificate (Maybe Text)
- clientCertificate :: ClientCertificate
- data ClientCertificate
- ccPemEncodedCertificate :: Lens' ClientCertificate (Maybe Text)
- ccClientCertificateId :: Lens' ClientCertificate (Maybe Text)
- ccCreatedDate :: Lens' ClientCertificate (Maybe UTCTime)
- ccExpirationDate :: Lens' ClientCertificate (Maybe UTCTime)
- ccDescription :: Lens' ClientCertificate (Maybe Text)
Creating a Request
generateClientCertificate :: GenerateClientCertificate Source #
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 theClientCertificate
.
data GenerateClientCertificate Source #
A request to generate a ClientCertificate
resource.
See: generateClientCertificate
smart constructor.
Request Lenses
gccDescription :: Lens' GenerateClientCertificate (Maybe Text) Source #
The description of the ClientCertificate
.
Destructuring the Response
clientCertificate :: ClientCertificate Source #
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 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: clientCertificate
smart constructor.
Response Lenses
ccPemEncodedCertificate :: 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 .
ccClientCertificateId :: Lens' ClientCertificate (Maybe Text) Source #
The identifier of the client certificate.
ccCreatedDate :: Lens' ClientCertificate (Maybe UTCTime) Source #
The timestamp when the client certificate was created.
ccExpirationDate :: Lens' ClientCertificate (Maybe UTCTime) Source #
The timestamp when the client certificate will expire.
ccDescription :: Lens' ClientCertificate (Maybe Text) Source #
The description of the client certificate.