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 |
Requests an ACM Certificate for use with other AWS services. To request an ACM Certificate, you must specify the fully qualified domain name (FQDN) for your site in the DomainName
parameter. You can also specify additional FQDNs in the SubjectAlternativeNames
parameter if users can reach your site by using other names.
For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate. Email is sent to three registered contact addresses in the WHOIS database and to five common system administration addresses formed from the DomainName
you enter or the optional ValidationDomain
parameter. For more information, see Validate Domain Ownership .
After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the AWS Certificate Manager User Guide .
- requestCertificate :: Text -> RequestCertificate
- data RequestCertificate
- rcIdempotencyToken :: Lens' RequestCertificate (Maybe Text)
- rcSubjectAlternativeNames :: Lens' RequestCertificate (Maybe (NonEmpty Text))
- rcDomainValidationOptions :: Lens' RequestCertificate (Maybe (NonEmpty DomainValidationOption))
- rcDomainName :: Lens' RequestCertificate Text
- requestCertificateResponse :: Int -> RequestCertificateResponse
- data RequestCertificateResponse
- rcrsCertificateARN :: Lens' RequestCertificateResponse (Maybe Text)
- rcrsResponseStatus :: Lens' RequestCertificateResponse Int
Creating a Request
Creates a value of RequestCertificate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcIdempotencyToken
- Customer chosen string that can be used to distinguish between calls toRequestCertificate
. Idempotency tokens time out after one hour. Therefore, if you callRequestCertificate
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.rcSubjectAlternativeNames
- 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 theDomainName
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 limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see Limits .rcDomainValidationOptions
- The domain name that you want ACM to use to send you emails to validate your ownership of the domain.rcDomainName
- Fully qualified domain name (FQDN), such as www.example.com, of the site 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 maximum length of a 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.
data RequestCertificate Source #
See: requestCertificate
smart constructor.
Request Lenses
rcIdempotencyToken :: 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.
rcSubjectAlternativeNames :: 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 limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see Limits .
rcDomainValidationOptions :: Lens' RequestCertificate (Maybe (NonEmpty DomainValidationOption)) Source #
The domain name that you want ACM to use to send you emails to validate your ownership of the domain.
rcDomainName :: Lens' RequestCertificate Text Source #
Fully qualified domain name (FQDN), such as www.example.com, of the site 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 maximum length of a 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.
Destructuring the Response
requestCertificateResponse Source #
Creates a value of RequestCertificateResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcrsCertificateARN
- 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
rcrsResponseStatus
- -- | The response status code.
data RequestCertificateResponse Source #
See: requestCertificateResponse
smart constructor.
Response Lenses
rcrsCertificateARN :: 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
rcrsResponseStatus :: Lens' RequestCertificateResponse Int Source #
- - | The response status code.