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 - 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 - 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 - 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 * administratorexample.com * hostmasterexample.com * postmasterexample.com * [e-mail]
• rcDomainName - 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

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 => Logger -> Service -> Proxy * RequestCertificate -> ClientResponse -> m (Response RequestCertificate)

ToPath RequestCertificate

Methods

toPath :: RequestCertificate -> ByteString

ToHeaders RequestCertificate

Methods

toHeaders :: RequestCertificate -> [Header]

ToQuery RequestCertificate

Methods

toQuery :: RequestCertificate -> QueryString

type Rep RequestCertificate

type Rep RequestCertificate = D1 (MetaData "RequestCertificate" "Network.AWS.CertificateManager.RequestCertificate" "amazonka-certificatemanager-1.4.5-1PooRU18e9TGfT3Ofqp2pv" False) (C1 (MetaCons "RequestCertificate'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rcIdempotencyToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rcSubjectAlternativeNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_rcDomainValidationOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 DomainValidationOption)))) (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.

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: * adminexample.com * administratorexample.com * hostmasterexample.com * postmasterexample.com * [e-mail]

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 - 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.4.5-1PooRU18e9TGfT3Ofqp2pv" False) (C1 (MetaCons "RequestCertificateResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rcrsCertificateARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (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.