Network.AWS.CertificateManager.RequestCertificate

Requests an ACM certificate for use with other AWS 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.

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 - 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.
• rcValidationMethod - 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.
• 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 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 . 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.
• rcOptions - 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 SSLTLS 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 <http:docs.aws.amazon.comacmlatestuserguide/acm-bestpractices.html#best-practices-transparency Opting Out of Certificate Transparency Logging> .
• rcDomainValidationOptions - The domain name that you want ACM to use to send you emails so that you can validate domain ownership.
• rcCertificateAuthorityARN - 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 AWS 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
• rcDomainName - 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 63 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length.

data RequestCertificate

See: requestCertificate smart constructor.

Instances

Eq RequestCertificate

Methods

(==) :: RequestCertificate -> RequestCertificate -> Bool

(/=) :: RequestCertificate -> RequestCertificate -> Bool

Data RequestCertificate

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RequestCertificate -> c RequestCertificate

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RequestCertificate

toConstr :: RequestCertificate -> Constr

dataTypeOf :: RequestCertificate -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RequestCertificate)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RequestCertificate)

gmapT :: (forall b. Data b => b -> b) -> RequestCertificate -> RequestCertificate

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RequestCertificate -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RequestCertificate -> r

gmapQ :: (forall d. Data d => d -> u) -> RequestCertificate -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RequestCertificate -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RequestCertificate -> m RequestCertificate

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RequestCertificate -> m RequestCertificate

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RequestCertificate -> m RequestCertificate

Read RequestCertificate

Methods

readsPrec :: Int -> ReadS RequestCertificate

readList :: ReadS [RequestCertificate]

readPrec :: ReadPrec RequestCertificate

readListPrec :: ReadPrec [RequestCertificate]

Show RequestCertificate

Methods

showsPrec :: Int -> RequestCertificate -> ShowS

show :: RequestCertificate -> String

showList :: [RequestCertificate] -> ShowS

Generic RequestCertificate

Associated Types

type Rep RequestCertificate :: * -> *

Methods

from :: RequestCertificate -> Rep RequestCertificate x

to :: Rep RequestCertificate x -> RequestCertificate

Hashable RequestCertificate

Methods

hashWithSalt :: Int -> RequestCertificate -> Int

hash :: RequestCertificate -> Int

ToJSON RequestCertificate

Methods

toJSON :: RequestCertificate -> Value

toEncoding :: RequestCertificate -> Encoding

toJSONList :: [RequestCertificate] -> Value

toEncodingList :: [RequestCertificate] -> Encoding

NFData RequestCertificate

Methods

rnf :: RequestCertificate -> ()

AWSRequest RequestCertificate

Associated Types

type Rs RequestCertificate :: *

Methods

request :: RequestCertificate -> Request RequestCertificate

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * RequestCertificate -> ClientResponse -> m (Response RequestCertificate)

ToHeaders RequestCertificate

Methods

toHeaders :: RequestCertificate -> [Header]

ToPath RequestCertificate

Methods

toPath :: RequestCertificate -> ByteString

ToQuery RequestCertificate

Methods

toQuery :: RequestCertificate -> QueryString

type Rep RequestCertificate

type Rep RequestCertificate = D1 * (MetaData "RequestCertificate" "Network.AWS.CertificateManager.RequestCertificate" "amazonka-certificatemanager-1.6.0-LNRG7szGK7RAaShN2e3B6s" False) (C1 * (MetaCons "RequestCertificate'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_rcIdempotencyToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rcValidationMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ValidationMethod))) (S1 * (MetaSel (Just Symbol "_rcSubjectAlternativeNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (List1 Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_rcOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe CertificateOptions))) (S1 * (MetaSel (Just Symbol "_rcDomainValidationOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (List1 DomainValidationOption))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rcCertificateAuthorityARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_rcDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs 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.

rcValidationMethod :: Lens' RequestCertificate (Maybe 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.

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

rcOptions :: Lens' RequestCertificate (Maybe CertificateOptions)

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 SSLTLS 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 <http:docs.aws.amazon.comacmlatestuserguide/acm-bestpractices.html#best-practices-transparency Opting Out of Certificate Transparency Logging> .

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

The domain name that you want ACM to use to send you emails so that you can validate domain ownership.

rcCertificateAuthorityARN :: Lens' RequestCertificate (Maybe Text)

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

rcDomainName :: Lens' RequestCertificate Text

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 63 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length.

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

See: requestCertificateResponse smart constructor.

Instances

Eq RequestCertificateResponse

Methods

(==) :: RequestCertificateResponse -> RequestCertificateResponse -> Bool

(/=) :: RequestCertificateResponse -> RequestCertificateResponse -> Bool

Data RequestCertificateResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RequestCertificateResponse -> c RequestCertificateResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RequestCertificateResponse

toConstr :: RequestCertificateResponse -> Constr

dataTypeOf :: RequestCertificateResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RequestCertificateResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RequestCertificateResponse)

gmapT :: (forall b. Data b => b -> b) -> RequestCertificateResponse -> RequestCertificateResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RequestCertificateResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RequestCertificateResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> RequestCertificateResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RequestCertificateResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RequestCertificateResponse -> m RequestCertificateResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RequestCertificateResponse -> m RequestCertificateResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RequestCertificateResponse -> m RequestCertificateResponse

Read RequestCertificateResponse

Methods

readsPrec :: Int -> ReadS RequestCertificateResponse

readList :: ReadS [RequestCertificateResponse]

readPrec :: ReadPrec RequestCertificateResponse

readListPrec :: ReadPrec [RequestCertificateResponse]

Show RequestCertificateResponse

Methods

showsPrec :: Int -> RequestCertificateResponse -> ShowS

show :: RequestCertificateResponse -> String

showList :: [RequestCertificateResponse] -> ShowS

Generic RequestCertificateResponse

Associated Types

type Rep RequestCertificateResponse :: * -> *

Methods

from :: RequestCertificateResponse -> Rep RequestCertificateResponse x

to :: Rep RequestCertificateResponse x -> RequestCertificateResponse

NFData RequestCertificateResponse

Methods

rnf :: RequestCertificateResponse -> ()

type Rep RequestCertificateResponse

type Rep RequestCertificateResponse = D1 * (MetaData "RequestCertificateResponse" "Network.AWS.CertificateManager.RequestCertificate" "amazonka-certificatemanager-1.6.0-LNRG7szGK7RAaShN2e3B6s" False) (C1 * (MetaCons "RequestCertificateResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_rcrsCertificateARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_rcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

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.