Network.AWS.CertificateManager.RequestCertificate

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. You can also specify additional FQDNs 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. After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the AWS Certificate Manager User Guide.

Creating a Request

requestCertificate

Arguments

:: Text

rcDomainName

-> RequestCertificate

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
• rcSubjectAlternativeNames
• rcDomainValidationOptions
• rcDomainName

data RequestCertificate

See: requestCertificate smart constructor.

Instances

Eq RequestCertificate

Data RequestCertificate

Read RequestCertificate

Show RequestCertificate

Generic RequestCertificate

ToJSON RequestCertificate

Hashable RequestCertificate

AWSRequest RequestCertificate

ToPath RequestCertificate

ToHeaders RequestCertificate

ToQuery RequestCertificate

type Rep RequestCertificate

type Rs RequestCertificate = RequestCertificateResponse

Request Lenses

rcIdempotencyToken :: Lens' RequestCertificate (Maybe Text)

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))

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.

rcDomainValidationOptions :: Lens' RequestCertificate (Maybe (NonEmpty DomainValidationOption))

The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the Domain value or a superdomain of the Domain value. For example, if you requested a certificate for 'test.example.com' and specify DomainValidationOptions of 'example.com', ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses:

• admin'example.com
• administrator'example.com
• hostmaster'example.com
• postmaster'example.com
• webmaster'example.com

rcDomainName :: Lens' RequestCertificate Text

Fully qualified domain name (FQDN), such as www.example.com, of the site 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.

Destructuring the Response

requestCertificateResponse

Arguments

:: Int

rcrsResponseStatus

-> RequestCertificateResponse

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
• rcrsResponseStatus

data RequestCertificateResponse

See: requestCertificateResponse smart constructor.

Instances

Eq RequestCertificateResponse

Data RequestCertificateResponse

Read RequestCertificateResponse

Show RequestCertificateResponse

Generic RequestCertificateResponse

type Rep RequestCertificateResponse

Response Lenses

rcrsCertificateARN :: Lens' RequestCertificateResponse (Maybe Text)

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

The response status code.