AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::ACM::Model::RequestCertificateRequest Class Reference

#include <RequestCertificateRequest.h>

+ Inheritance diagram for Aws::ACM::Model::RequestCertificateRequest:

Public Member Functions

 RequestCertificateRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetDomainName () const
 
bool DomainNameHasBeenSet () const
 
void SetDomainName (const Aws::String &value)
 
void SetDomainName (Aws::String &&value)
 
void SetDomainName (const char *value)
 
RequestCertificateRequestWithDomainName (const Aws::String &value)
 
RequestCertificateRequestWithDomainName (Aws::String &&value)
 
RequestCertificateRequestWithDomainName (const char *value)
 
const ValidationMethodGetValidationMethod () const
 
bool ValidationMethodHasBeenSet () const
 
void SetValidationMethod (const ValidationMethod &value)
 
void SetValidationMethod (ValidationMethod &&value)
 
RequestCertificateRequestWithValidationMethod (const ValidationMethod &value)
 
RequestCertificateRequestWithValidationMethod (ValidationMethod &&value)
 
const Aws::Vector< Aws::String > & GetSubjectAlternativeNames () const
 
bool SubjectAlternativeNamesHasBeenSet () const
 
void SetSubjectAlternativeNames (const Aws::Vector< Aws::String > &value)
 
void SetSubjectAlternativeNames (Aws::Vector< Aws::String > &&value)
 
RequestCertificateRequestWithSubjectAlternativeNames (const Aws::Vector< Aws::String > &value)
 
RequestCertificateRequestWithSubjectAlternativeNames (Aws::Vector< Aws::String > &&value)
 
RequestCertificateRequestAddSubjectAlternativeNames (const Aws::String &value)
 
RequestCertificateRequestAddSubjectAlternativeNames (Aws::String &&value)
 
RequestCertificateRequestAddSubjectAlternativeNames (const char *value)
 
const Aws::StringGetIdempotencyToken () const
 
bool IdempotencyTokenHasBeenSet () const
 
void SetIdempotencyToken (const Aws::String &value)
 
void SetIdempotencyToken (Aws::String &&value)
 
void SetIdempotencyToken (const char *value)
 
RequestCertificateRequestWithIdempotencyToken (const Aws::String &value)
 
RequestCertificateRequestWithIdempotencyToken (Aws::String &&value)
 
RequestCertificateRequestWithIdempotencyToken (const char *value)
 
const Aws::Vector< DomainValidationOption > & GetDomainValidationOptions () const
 
bool DomainValidationOptionsHasBeenSet () const
 
void SetDomainValidationOptions (const Aws::Vector< DomainValidationOption > &value)
 
void SetDomainValidationOptions (Aws::Vector< DomainValidationOption > &&value)
 
RequestCertificateRequestWithDomainValidationOptions (const Aws::Vector< DomainValidationOption > &value)
 
RequestCertificateRequestWithDomainValidationOptions (Aws::Vector< DomainValidationOption > &&value)
 
RequestCertificateRequestAddDomainValidationOptions (const DomainValidationOption &value)
 
RequestCertificateRequestAddDomainValidationOptions (DomainValidationOption &&value)
 
const CertificateOptionsGetOptions () const
 
bool OptionsHasBeenSet () const
 
void SetOptions (const CertificateOptions &value)
 
void SetOptions (CertificateOptions &&value)
 
RequestCertificateRequestWithOptions (const CertificateOptions &value)
 
RequestCertificateRequestWithOptions (CertificateOptions &&value)
 
const Aws::StringGetCertificateAuthorityArn () const
 
bool CertificateAuthorityArnHasBeenSet () const
 
void SetCertificateAuthorityArn (const Aws::String &value)
 
void SetCertificateAuthorityArn (Aws::String &&value)
 
void SetCertificateAuthorityArn (const char *value)
 
RequestCertificateRequestWithCertificateAuthorityArn (const Aws::String &value)
 
RequestCertificateRequestWithCertificateAuthorityArn (Aws::String &&value)
 
RequestCertificateRequestWithCertificateAuthorityArn (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
RequestCertificateRequestWithTags (const Aws::Vector< Tag > &value)
 
RequestCertificateRequestWithTags (Aws::Vector< Tag > &&value)
 
RequestCertificateRequestAddTags (const Tag &value)
 
RequestCertificateRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::ACM::ACMRequest
virtual ~ACMRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 26 of file RequestCertificateRequest.h.

Constructor & Destructor Documentation

◆ RequestCertificateRequest()

Aws::ACM::Model::RequestCertificateRequest::RequestCertificateRequest ( )

Member Function Documentation

◆ AddDomainValidationOptions() [1/2]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::AddDomainValidationOptions ( const DomainValidationOption value)
inline

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

Definition at line 520 of file RequestCertificateRequest.h.

◆ AddDomainValidationOptions() [2/2]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::AddDomainValidationOptions ( DomainValidationOption &&  value)
inline

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

Definition at line 526 of file RequestCertificateRequest.h.

◆ AddSubjectAlternativeNames() [1/3]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::AddSubjectAlternativeNames ( const Aws::String value)
inline

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 quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

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.

Definition at line 344 of file RequestCertificateRequest.h.

◆ AddSubjectAlternativeNames() [2/3]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::AddSubjectAlternativeNames ( Aws::String &&  value)
inline

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 quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

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.

Definition at line 366 of file RequestCertificateRequest.h.

◆ AddSubjectAlternativeNames() [3/3]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::AddSubjectAlternativeNames ( const char *  value)
inline

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 quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

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.

Definition at line 388 of file RequestCertificateRequest.h.

◆ AddTags() [1/2]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::AddTags ( const Tag value)
inline

One or more resource tags to associate with the certificate.

Definition at line 734 of file RequestCertificateRequest.h.

◆ AddTags() [2/2]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::AddTags ( Tag &&  value)
inline

One or more resource tags to associate with the certificate.

Definition at line 739 of file RequestCertificateRequest.h.

◆ CertificateAuthorityArnHasBeenSet()

bool Aws::ACM::Model::RequestCertificateRequest::CertificateAuthorityArnHasBeenSet ( ) const
inline

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

Definition at line 620 of file RequestCertificateRequest.h.

◆ DomainNameHasBeenSet()

bool Aws::ACM::Model::RequestCertificateRequest::DomainNameHasBeenSet ( ) const
inline

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

Definition at line 62 of file RequestCertificateRequest.h.

◆ DomainValidationOptionsHasBeenSet()

bool Aws::ACM::Model::RequestCertificateRequest::DomainValidationOptionsHasBeenSet ( ) const
inline

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

Definition at line 490 of file RequestCertificateRequest.h.

◆ GetCertificateAuthorityArn()

const Aws::String& Aws::ACM::Model::RequestCertificateRequest::GetCertificateAuthorityArn ( ) const
inline

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

Definition at line 607 of file RequestCertificateRequest.h.

◆ GetDomainName()

const Aws::String& Aws::ACM::Model::RequestCertificateRequest::GetDomainName ( ) const
inline

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

Definition at line 51 of file RequestCertificateRequest.h.

◆ GetDomainValidationOptions()

const Aws::Vector<DomainValidationOption>& Aws::ACM::Model::RequestCertificateRequest::GetDomainValidationOptions ( ) const
inline

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

Definition at line 484 of file RequestCertificateRequest.h.

◆ GetIdempotencyToken()

const Aws::String& Aws::ACM::Model::RequestCertificateRequest::GetIdempotencyToken ( ) const
inline

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.

Definition at line 400 of file RequestCertificateRequest.h.

◆ GetOptions()

const CertificateOptions& Aws::ACM::Model::RequestCertificateRequest::GetOptions ( ) const
inline

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 SSL/TLS 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 Opting Out of Certificate Transparency Logging.

Definition at line 538 of file RequestCertificateRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ACM::Model::RequestCertificateRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::ACM::ACMRequest.

◆ GetServiceRequestName()

virtual const char* Aws::ACM::Model::RequestCertificateRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file RequestCertificateRequest.h.

◆ GetSubjectAlternativeNames()

const Aws::Vector<Aws::String>& Aws::ACM::Model::RequestCertificateRequest::GetSubjectAlternativeNames ( ) const
inline

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 quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

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.

Definition at line 212 of file RequestCertificateRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::ACM::Model::RequestCertificateRequest::GetTags ( ) const
inline

One or more resource tags to associate with the certificate.

Definition at line 704 of file RequestCertificateRequest.h.

◆ GetValidationMethod()

const ValidationMethod& Aws::ACM::Model::RequestCertificateRequest::GetValidationMethod ( ) const
inline

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.

Definition at line 139 of file RequestCertificateRequest.h.

◆ IdempotencyTokenHasBeenSet()

bool Aws::ACM::Model::RequestCertificateRequest::IdempotencyTokenHasBeenSet ( ) const
inline

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.

Definition at line 411 of file RequestCertificateRequest.h.

◆ OptionsHasBeenSet()

bool Aws::ACM::Model::RequestCertificateRequest::OptionsHasBeenSet ( ) const
inline

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 SSL/TLS 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 Opting Out of Certificate Transparency Logging.

Definition at line 549 of file RequestCertificateRequest.h.

◆ SerializePayload()

Aws::String Aws::ACM::Model::RequestCertificateRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCertificateAuthorityArn() [1/3]

void Aws::ACM::Model::RequestCertificateRequest::SetCertificateAuthorityArn ( const Aws::String value)
inline

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

Definition at line 633 of file RequestCertificateRequest.h.

◆ SetCertificateAuthorityArn() [2/3]

void Aws::ACM::Model::RequestCertificateRequest::SetCertificateAuthorityArn ( Aws::String &&  value)
inline

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

Definition at line 646 of file RequestCertificateRequest.h.

◆ SetCertificateAuthorityArn() [3/3]

void Aws::ACM::Model::RequestCertificateRequest::SetCertificateAuthorityArn ( const char *  value)
inline

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

Definition at line 659 of file RequestCertificateRequest.h.

◆ SetDomainName() [1/3]

void Aws::ACM::Model::RequestCertificateRequest::SetDomainName ( const Aws::String value)
inline

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

Definition at line 73 of file RequestCertificateRequest.h.

◆ SetDomainName() [2/3]

void Aws::ACM::Model::RequestCertificateRequest::SetDomainName ( Aws::String &&  value)
inline

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

Definition at line 84 of file RequestCertificateRequest.h.

◆ SetDomainName() [3/3]

void Aws::ACM::Model::RequestCertificateRequest::SetDomainName ( const char *  value)
inline

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

Definition at line 95 of file RequestCertificateRequest.h.

◆ SetDomainValidationOptions() [1/2]

void Aws::ACM::Model::RequestCertificateRequest::SetDomainValidationOptions ( const Aws::Vector< DomainValidationOption > &  value)
inline

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

Definition at line 496 of file RequestCertificateRequest.h.

◆ SetDomainValidationOptions() [2/2]

void Aws::ACM::Model::RequestCertificateRequest::SetDomainValidationOptions ( Aws::Vector< DomainValidationOption > &&  value)
inline

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

Definition at line 502 of file RequestCertificateRequest.h.

◆ SetIdempotencyToken() [1/3]

void Aws::ACM::Model::RequestCertificateRequest::SetIdempotencyToken ( const Aws::String value)
inline

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.

Definition at line 422 of file RequestCertificateRequest.h.

◆ SetIdempotencyToken() [2/3]

void Aws::ACM::Model::RequestCertificateRequest::SetIdempotencyToken ( Aws::String &&  value)
inline

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.

Definition at line 433 of file RequestCertificateRequest.h.

◆ SetIdempotencyToken() [3/3]

void Aws::ACM::Model::RequestCertificateRequest::SetIdempotencyToken ( const char *  value)
inline

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.

Definition at line 444 of file RequestCertificateRequest.h.

◆ SetOptions() [1/2]

void Aws::ACM::Model::RequestCertificateRequest::SetOptions ( const CertificateOptions value)
inline

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 SSL/TLS 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 Opting Out of Certificate Transparency Logging.

Definition at line 560 of file RequestCertificateRequest.h.

◆ SetOptions() [2/2]

void Aws::ACM::Model::RequestCertificateRequest::SetOptions ( CertificateOptions &&  value)
inline

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 SSL/TLS 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 Opting Out of Certificate Transparency Logging.

Definition at line 571 of file RequestCertificateRequest.h.

◆ SetSubjectAlternativeNames() [1/2]

void Aws::ACM::Model::RequestCertificateRequest::SetSubjectAlternativeNames ( const Aws::Vector< Aws::String > &  value)
inline

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 quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

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.

Definition at line 256 of file RequestCertificateRequest.h.

◆ SetSubjectAlternativeNames() [2/2]

void Aws::ACM::Model::RequestCertificateRequest::SetSubjectAlternativeNames ( Aws::Vector< Aws::String > &&  value)
inline

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 quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

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.

Definition at line 278 of file RequestCertificateRequest.h.

◆ SetTags() [1/2]

void Aws::ACM::Model::RequestCertificateRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

One or more resource tags to associate with the certificate.

Definition at line 714 of file RequestCertificateRequest.h.

◆ SetTags() [2/2]

void Aws::ACM::Model::RequestCertificateRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

One or more resource tags to associate with the certificate.

Definition at line 719 of file RequestCertificateRequest.h.

◆ SetValidationMethod() [1/2]

void Aws::ACM::Model::RequestCertificateRequest::SetValidationMethod ( const ValidationMethod value)
inline

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.

Definition at line 159 of file RequestCertificateRequest.h.

◆ SetValidationMethod() [2/2]

void Aws::ACM::Model::RequestCertificateRequest::SetValidationMethod ( ValidationMethod &&  value)
inline

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.

Definition at line 169 of file RequestCertificateRequest.h.

◆ SubjectAlternativeNamesHasBeenSet()

bool Aws::ACM::Model::RequestCertificateRequest::SubjectAlternativeNamesHasBeenSet ( ) const
inline

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 quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

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.

Definition at line 234 of file RequestCertificateRequest.h.

◆ TagsHasBeenSet()

bool Aws::ACM::Model::RequestCertificateRequest::TagsHasBeenSet ( ) const
inline

One or more resource tags to associate with the certificate.

Definition at line 709 of file RequestCertificateRequest.h.

◆ ValidationMethodHasBeenSet()

bool Aws::ACM::Model::RequestCertificateRequest::ValidationMethodHasBeenSet ( ) const
inline

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.

Definition at line 149 of file RequestCertificateRequest.h.

◆ WithCertificateAuthorityArn() [1/3]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithCertificateAuthorityArn ( const Aws::String value)
inline

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

Definition at line 672 of file RequestCertificateRequest.h.

◆ WithCertificateAuthorityArn() [2/3]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithCertificateAuthorityArn ( Aws::String &&  value)
inline

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

Definition at line 685 of file RequestCertificateRequest.h.

◆ WithCertificateAuthorityArn() [3/3]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithCertificateAuthorityArn ( const char *  value)
inline

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

Definition at line 698 of file RequestCertificateRequest.h.

◆ WithDomainName() [1/3]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithDomainName ( const Aws::String value)
inline

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

Definition at line 106 of file RequestCertificateRequest.h.

◆ WithDomainName() [2/3]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithDomainName ( Aws::String &&  value)
inline

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

Definition at line 117 of file RequestCertificateRequest.h.

◆ WithDomainName() [3/3]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithDomainName ( const char *  value)
inline

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

Definition at line 128 of file RequestCertificateRequest.h.

◆ WithDomainValidationOptions() [1/2]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithDomainValidationOptions ( const Aws::Vector< DomainValidationOption > &  value)
inline

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

Definition at line 508 of file RequestCertificateRequest.h.

◆ WithDomainValidationOptions() [2/2]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithDomainValidationOptions ( Aws::Vector< DomainValidationOption > &&  value)
inline

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

Definition at line 514 of file RequestCertificateRequest.h.

◆ WithIdempotencyToken() [1/3]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithIdempotencyToken ( const Aws::String value)
inline

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.

Definition at line 455 of file RequestCertificateRequest.h.

◆ WithIdempotencyToken() [2/3]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithIdempotencyToken ( Aws::String &&  value)
inline

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.

Definition at line 466 of file RequestCertificateRequest.h.

◆ WithIdempotencyToken() [3/3]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithIdempotencyToken ( const char *  value)
inline

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.

Definition at line 477 of file RequestCertificateRequest.h.

◆ WithOptions() [1/2]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithOptions ( const CertificateOptions value)
inline

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 SSL/TLS 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 Opting Out of Certificate Transparency Logging.

Definition at line 582 of file RequestCertificateRequest.h.

◆ WithOptions() [2/2]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithOptions ( CertificateOptions &&  value)
inline

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 SSL/TLS 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 Opting Out of Certificate Transparency Logging.

Definition at line 593 of file RequestCertificateRequest.h.

◆ WithSubjectAlternativeNames() [1/2]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithSubjectAlternativeNames ( const Aws::Vector< Aws::String > &  value)
inline

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 quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

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.

Definition at line 300 of file RequestCertificateRequest.h.

◆ WithSubjectAlternativeNames() [2/2]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithSubjectAlternativeNames ( Aws::Vector< Aws::String > &&  value)
inline

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 quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.

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.

Definition at line 322 of file RequestCertificateRequest.h.

◆ WithTags() [1/2]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

One or more resource tags to associate with the certificate.

Definition at line 724 of file RequestCertificateRequest.h.

◆ WithTags() [2/2]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

One or more resource tags to associate with the certificate.

Definition at line 729 of file RequestCertificateRequest.h.

◆ WithValidationMethod() [1/2]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithValidationMethod ( const ValidationMethod value)
inline

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.

Definition at line 179 of file RequestCertificateRequest.h.

◆ WithValidationMethod() [2/2]

RequestCertificateRequest& Aws::ACM::Model::RequestCertificateRequest::WithValidationMethod ( ValidationMethod &&  value)
inline

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.

Definition at line 189 of file RequestCertificateRequest.h.


The documentation for this class was generated from the following file: