Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Imports an SSLTLS certificate into AWS Certificate Manager (ACM) to use with <http:docs.aws.amazon.comacmlatestuserguide/acm-services.html ACM's integrated AWS services> .
For more information about importing certificates into ACM, including the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide .
To import a certificate, you must provide the certificate and the matching private key. When the certificate is not self-signed, you must also provide a certificate chain. You can omit the certificate chain when importing a self-signed certificate.
The certificate, private key, and certificate chain must be PEM-encoded. For more information about converting these items to PEM format, see Importing Certificates Troubleshooting in the AWS Certificate Manager User Guide .
To import a new certificate, omit the CertificateArn
field. Include this field only when you want to replace a previously imported certificate.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.
- importCertificate :: ByteString -> ByteString -> ImportCertificate
- data ImportCertificate
- icCertificateARN :: Lens' ImportCertificate (Maybe Text)
- icCertificateChain :: Lens' ImportCertificate (Maybe ByteString)
- icCertificate :: Lens' ImportCertificate ByteString
- icPrivateKey :: Lens' ImportCertificate ByteString
- importCertificateResponse :: Int -> ImportCertificateResponse
- data ImportCertificateResponse
- icrsCertificateARN :: Lens' ImportCertificateResponse (Maybe Text)
- icrsResponseStatus :: Lens' ImportCertificateResponse Int
Creating a Request
Creates a value of ImportCertificate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
icCertificateARN
- The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field.icCertificateChain
- The certificate chain. It must be PEM-encoded.-- Note: ThisLens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLens
accepts and returns only raw unencoded data.icCertificate
- The certificate to import. It must meet the following requirements: * Must be PEM-encoded. * Must contain a 1024-bit or 2048-bit RSA public key. * Must be valid at the time of import. You cannot import a certificate before its validity period begins (the certificate'sNotBefore
date) or after it expires (the certificate'sNotAfter
date).-- Note: ThisLens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLens
accepts and returns only raw unencoded data.icPrivateKey
- The private key that matches the public key in the certificate. It must meet the following requirements: * Must be PEM-encoded. * Must be unencrypted. You cannot import a private key that is protected by a password or passphrase.-- Note: ThisLens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLens
accepts and returns only raw unencoded data.
data ImportCertificate Source #
See: importCertificate
smart constructor.
Request Lenses
icCertificateARN :: Lens' ImportCertificate (Maybe Text) Source #
The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field.
icCertificateChain :: Lens' ImportCertificate (Maybe ByteString) Source #
The certificate chain. It must be PEM-encoded.-- Note: This Lens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens
accepts and returns only raw unencoded data.
icCertificate :: Lens' ImportCertificate ByteString Source #
The certificate to import. It must meet the following requirements: * Must be PEM-encoded. * Must contain a 1024-bit or 2048-bit RSA public key. * Must be valid at the time of import. You cannot import a certificate before its validity period begins (the certificate's NotBefore
date) or after it expires (the certificate's NotAfter
date).-- Note: This Lens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens
accepts and returns only raw unencoded data.
icPrivateKey :: Lens' ImportCertificate ByteString Source #
The private key that matches the public key in the certificate. It must meet the following requirements: * Must be PEM-encoded. * Must be unencrypted. You cannot import a private key that is protected by a password or passphrase.-- Note: This Lens
automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens
accepts and returns only raw unencoded data.
Destructuring the Response
importCertificateResponse Source #
Creates a value of ImportCertificateResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
icrsCertificateARN
- The Amazon Resource Name (ARN) of the imported certificate.icrsResponseStatus
- -- | The response status code.
data ImportCertificateResponse Source #
See: importCertificateResponse
smart constructor.
Response Lenses
icrsCertificateARN :: Lens' ImportCertificateResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the imported certificate.
icrsResponseStatus :: Lens' ImportCertificateResponse Int Source #
- - | The response status code.