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 |
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 .
- 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.rcDomainValidationOptions
- 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 theDomain
value or a superdomain of theDomain
value. For example, if you requested a certificate fortest.example.com
and specify DomainValidationOptions ofexample.com
, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses: * adminexample.com * administrator
example.com * hostmasterexample.com * postmaster
example.com * webmaster@example.comrcDomainName
- 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.
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.
rcDomainValidationOptions :: Lens' RequestCertificate (Maybe (NonEmpty DomainValidationOption)) Source #
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: * adminexample.com * administrator
example.com * hostmasterexample.com * postmaster
example.com * webmaster@example.com
rcDomainName :: Lens' RequestCertificate Text Source #
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 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.