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 |
Requests an ACM certificate for use with other Amazon Web Services
services. To request an ACM certificate, you must specify a fully
qualified domain name (FQDN) in the DomainName
parameter. You can also
specify additional FQDNs in the SubjectAlternativeNames
parameter.
If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner.
ACM behavior differs from the https://tools.ietf.org/html/rfc6125#appendix-B.2RFC 6125 specification of the certificate validation process. first checks for a subject alternative name, and, if it finds one, ignores the common name (CN)
Synopsis
- data RequestCertificate = RequestCertificate' {
- idempotencyToken :: Maybe Text
- validationMethod :: Maybe ValidationMethod
- subjectAlternativeNames :: Maybe (NonEmpty Text)
- options :: Maybe CertificateOptions
- domainValidationOptions :: Maybe (NonEmpty DomainValidationOption)
- certificateAuthorityArn :: Maybe Text
- tags :: Maybe (NonEmpty Tag)
- domainName :: Text
- newRequestCertificate :: Text -> RequestCertificate
- requestCertificate_idempotencyToken :: Lens' RequestCertificate (Maybe Text)
- requestCertificate_validationMethod :: Lens' RequestCertificate (Maybe ValidationMethod)
- requestCertificate_subjectAlternativeNames :: Lens' RequestCertificate (Maybe (NonEmpty Text))
- requestCertificate_options :: Lens' RequestCertificate (Maybe CertificateOptions)
- requestCertificate_domainValidationOptions :: Lens' RequestCertificate (Maybe (NonEmpty DomainValidationOption))
- requestCertificate_certificateAuthorityArn :: Lens' RequestCertificate (Maybe Text)
- requestCertificate_tags :: Lens' RequestCertificate (Maybe (NonEmpty Tag))
- requestCertificate_domainName :: Lens' RequestCertificate Text
- data RequestCertificateResponse = RequestCertificateResponse' {
- certificateArn :: Maybe Text
- httpStatus :: Int
- newRequestCertificateResponse :: Int -> RequestCertificateResponse
- requestCertificateResponse_certificateArn :: Lens' RequestCertificateResponse (Maybe Text)
- requestCertificateResponse_httpStatus :: Lens' RequestCertificateResponse Int
Creating a Request
data RequestCertificate Source #
See: newRequestCertificate
smart constructor.
RequestCertificate' | |
|
Instances
newRequestCertificate Source #
Create a value of RequestCertificate
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:idempotencyToken:RequestCertificate'
, requestCertificate_idempotencyToken
- Customer chosen string that can be used to distinguish between calls to
RequestCertificate
. Idempotency tokens time out after one hour.
Therefore, if you call RequestCertificate
multiple times with the same
idempotency token within one hour, ACM recognizes that you are
requesting only one certificate and will issue only one. If you change
the idempotency token for each call, ACM recognizes that you are
requesting multiple certificates.
$sel:validationMethod:RequestCertificate'
, requestCertificate_validationMethod
- The method you want to use if you are requesting a public certificate to
validate that you own or control domain. You can
validate with DNS
or
validate with email.
We recommend that you use DNS validation.
$sel:subjectAlternativeNames:RequestCertificate'
, requestCertificate_subjectAlternativeNames
- Additional FQDNs to be included in the Subject Alternative Name
extension of the ACM certificate. For example, add the name
www.example.net to a certificate for which the DomainName
field is
www.example.com if users can reach your site by using either name. The
maximum number of domain names that you can add to an ACM certificate is
100. However, the initial quota is 10 domain names. If you need more
than 10 names, you must request a quota increase. For more information,
see
Quotas.
The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:
(63 octets).(63 octets).(63 octets).(61 octets)
is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.(64 octets).(63 octets).(63 octets).(61 octets)
is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.(63 octets).(63 octets).(63 octets).(62 octets)
is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.
$sel:options:RequestCertificate'
, requestCertificate_options
- Currently, you can use this parameter to specify whether to add the
certificate to a certificate transparency log. Certificate transparency
makes it possible to detect SSL/TLS certificates that have been
mistakenly or maliciously issued. Certificates that have not been logged
typically produce an error message in a browser. For more information,
see
Opting Out of Certificate Transparency Logging.
$sel:domainValidationOptions:RequestCertificate'
, requestCertificate_domainValidationOptions
- The domain name that you want ACM to use to send you emails so that you
can validate domain ownership.
$sel:certificateAuthorityArn:RequestCertificate'
, requestCertificate_certificateAuthorityArn
- The Amazon Resource Name (ARN) of the private certificate authority (CA)
that will be used to issue the certificate. If you do not provide an ARN
and you are trying to request a private certificate, ACM will attempt to
issue a public certificate. For more information about private CAs, see
the
Amazon Web Services Certificate Manager Private Certificate Authority (PCA)
user guide. The ARN must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
$sel:tags:RequestCertificate'
, requestCertificate_tags
- One or more resource tags to associate with the certificate.
$sel:domainName:RequestCertificate'
, requestCertificate_domainName
- Fully qualified domain name (FQDN), such as www.example.com, that you
want to secure with an ACM certificate. Use an asterisk (*) to create a
wildcard certificate that protects several sites in the same domain. For
example, *.example.com protects www.example.com, site.example.com, and
images.example.com.
The first domain name you enter cannot exceed 64 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length.
Request Lenses
requestCertificate_idempotencyToken :: Lens' RequestCertificate (Maybe Text) Source #
Customer chosen string that can be used to distinguish between calls to
RequestCertificate
. Idempotency tokens time out after one hour.
Therefore, if you call RequestCertificate
multiple times with the same
idempotency token within one hour, ACM recognizes that you are
requesting only one certificate and will issue only one. If you change
the idempotency token for each call, ACM recognizes that you are
requesting multiple certificates.
requestCertificate_validationMethod :: Lens' RequestCertificate (Maybe ValidationMethod) Source #
The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation.
requestCertificate_subjectAlternativeNames :: Lens' RequestCertificate (Maybe (NonEmpty Text)) Source #
Additional FQDNs to be included in the Subject Alternative Name
extension of the ACM certificate. For example, add the name
www.example.net to a certificate for which the DomainName
field is
www.example.com if users can reach your site by using either name. The
maximum number of domain names that you can add to an ACM certificate is
100. However, the initial quota is 10 domain names. If you need more
than 10 names, you must request a quota increase. For more information,
see
Quotas.
The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:
(63 octets).(63 octets).(63 octets).(61 octets)
is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.(64 octets).(63 octets).(63 octets).(61 octets)
is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.(63 octets).(63 octets).(63 octets).(62 octets)
is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.
requestCertificate_options :: Lens' RequestCertificate (Maybe CertificateOptions) Source #
Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see Opting Out of Certificate Transparency Logging.
requestCertificate_domainValidationOptions :: Lens' RequestCertificate (Maybe (NonEmpty DomainValidationOption)) Source #
The domain name that you want ACM to use to send you emails so that you can validate domain ownership.
requestCertificate_certificateAuthorityArn :: Lens' RequestCertificate (Maybe Text) Source #
The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the Amazon Web Services Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
requestCertificate_tags :: Lens' RequestCertificate (Maybe (NonEmpty Tag)) Source #
One or more resource tags to associate with the certificate.
requestCertificate_domainName :: Lens' RequestCertificate Text Source #
Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com.
The first domain name you enter cannot exceed 64 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length.
Destructuring the Response
data RequestCertificateResponse Source #
See: newRequestCertificateResponse
smart constructor.
RequestCertificateResponse' | |
|
Instances
newRequestCertificateResponse Source #
Create a value of RequestCertificateResponse
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:certificateArn:RequestCertificateResponse'
, requestCertificateResponse_certificateArn
- String that contains the ARN of the issued certificate. This must be of
the form:
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
$sel:httpStatus:RequestCertificateResponse'
, requestCertificateResponse_httpStatus
- The response's http status code.
Response Lenses
requestCertificateResponse_certificateArn :: Lens' RequestCertificateResponse (Maybe Text) Source #
String that contains the ARN of the issued certificate. This must be of the form:
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
requestCertificateResponse_httpStatus :: Lens' RequestCertificateResponse Int Source #
The response's http status code.