AWS SDK for C++  1.9.104
AWS SDK for C++
Public Member Functions | List of all members
Aws::Lightsail::Model::Certificate Class Reference

#include <Certificate.h>

Public Member Functions

 Certificate ()
 
 Certificate (Aws::Utils::Json::JsonView jsonValue)
 
Certificateoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
CertificateWithArn (const Aws::String &value)
 
CertificateWithArn (Aws::String &&value)
 
CertificateWithArn (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CertificateWithName (const Aws::String &value)
 
CertificateWithName (Aws::String &&value)
 
CertificateWithName (const char *value)
 
const Aws::StringGetDomainName () const
 
bool DomainNameHasBeenSet () const
 
void SetDomainName (const Aws::String &value)
 
void SetDomainName (Aws::String &&value)
 
void SetDomainName (const char *value)
 
CertificateWithDomainName (const Aws::String &value)
 
CertificateWithDomainName (Aws::String &&value)
 
CertificateWithDomainName (const char *value)
 
const CertificateStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const CertificateStatus &value)
 
void SetStatus (CertificateStatus &&value)
 
CertificateWithStatus (const CertificateStatus &value)
 
CertificateWithStatus (CertificateStatus &&value)
 
const Aws::StringGetSerialNumber () const
 
bool SerialNumberHasBeenSet () const
 
void SetSerialNumber (const Aws::String &value)
 
void SetSerialNumber (Aws::String &&value)
 
void SetSerialNumber (const char *value)
 
CertificateWithSerialNumber (const Aws::String &value)
 
CertificateWithSerialNumber (Aws::String &&value)
 
CertificateWithSerialNumber (const char *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)
 
CertificateWithSubjectAlternativeNames (const Aws::Vector< Aws::String > &value)
 
CertificateWithSubjectAlternativeNames (Aws::Vector< Aws::String > &&value)
 
CertificateAddSubjectAlternativeNames (const Aws::String &value)
 
CertificateAddSubjectAlternativeNames (Aws::String &&value)
 
CertificateAddSubjectAlternativeNames (const char *value)
 
const Aws::Vector< DomainValidationRecord > & GetDomainValidationRecords () const
 
bool DomainValidationRecordsHasBeenSet () const
 
void SetDomainValidationRecords (const Aws::Vector< DomainValidationRecord > &value)
 
void SetDomainValidationRecords (Aws::Vector< DomainValidationRecord > &&value)
 
CertificateWithDomainValidationRecords (const Aws::Vector< DomainValidationRecord > &value)
 
CertificateWithDomainValidationRecords (Aws::Vector< DomainValidationRecord > &&value)
 
CertificateAddDomainValidationRecords (const DomainValidationRecord &value)
 
CertificateAddDomainValidationRecords (DomainValidationRecord &&value)
 
const Aws::StringGetRequestFailureReason () const
 
bool RequestFailureReasonHasBeenSet () const
 
void SetRequestFailureReason (const Aws::String &value)
 
void SetRequestFailureReason (Aws::String &&value)
 
void SetRequestFailureReason (const char *value)
 
CertificateWithRequestFailureReason (const Aws::String &value)
 
CertificateWithRequestFailureReason (Aws::String &&value)
 
CertificateWithRequestFailureReason (const char *value)
 
int GetInUseResourceCount () const
 
bool InUseResourceCountHasBeenSet () const
 
void SetInUseResourceCount (int value)
 
CertificateWithInUseResourceCount (int value)
 
const Aws::StringGetKeyAlgorithm () const
 
bool KeyAlgorithmHasBeenSet () const
 
void SetKeyAlgorithm (const Aws::String &value)
 
void SetKeyAlgorithm (Aws::String &&value)
 
void SetKeyAlgorithm (const char *value)
 
CertificateWithKeyAlgorithm (const Aws::String &value)
 
CertificateWithKeyAlgorithm (Aws::String &&value)
 
CertificateWithKeyAlgorithm (const char *value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
CertificateWithCreatedAt (const Aws::Utils::DateTime &value)
 
CertificateWithCreatedAt (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetIssuedAt () const
 
bool IssuedAtHasBeenSet () const
 
void SetIssuedAt (const Aws::Utils::DateTime &value)
 
void SetIssuedAt (Aws::Utils::DateTime &&value)
 
CertificateWithIssuedAt (const Aws::Utils::DateTime &value)
 
CertificateWithIssuedAt (Aws::Utils::DateTime &&value)
 
const Aws::StringGetIssuerCA () const
 
bool IssuerCAHasBeenSet () const
 
void SetIssuerCA (const Aws::String &value)
 
void SetIssuerCA (Aws::String &&value)
 
void SetIssuerCA (const char *value)
 
CertificateWithIssuerCA (const Aws::String &value)
 
CertificateWithIssuerCA (Aws::String &&value)
 
CertificateWithIssuerCA (const char *value)
 
const Aws::Utils::DateTimeGetNotBefore () const
 
bool NotBeforeHasBeenSet () const
 
void SetNotBefore (const Aws::Utils::DateTime &value)
 
void SetNotBefore (Aws::Utils::DateTime &&value)
 
CertificateWithNotBefore (const Aws::Utils::DateTime &value)
 
CertificateWithNotBefore (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetNotAfter () const
 
bool NotAfterHasBeenSet () const
 
void SetNotAfter (const Aws::Utils::DateTime &value)
 
void SetNotAfter (Aws::Utils::DateTime &&value)
 
CertificateWithNotAfter (const Aws::Utils::DateTime &value)
 
CertificateWithNotAfter (Aws::Utils::DateTime &&value)
 
const Aws::StringGetEligibleToRenew () const
 
bool EligibleToRenewHasBeenSet () const
 
void SetEligibleToRenew (const Aws::String &value)
 
void SetEligibleToRenew (Aws::String &&value)
 
void SetEligibleToRenew (const char *value)
 
CertificateWithEligibleToRenew (const Aws::String &value)
 
CertificateWithEligibleToRenew (Aws::String &&value)
 
CertificateWithEligibleToRenew (const char *value)
 
const RenewalSummaryGetRenewalSummary () const
 
bool RenewalSummaryHasBeenSet () const
 
void SetRenewalSummary (const RenewalSummary &value)
 
void SetRenewalSummary (RenewalSummary &&value)
 
CertificateWithRenewalSummary (const RenewalSummary &value)
 
CertificateWithRenewalSummary (RenewalSummary &&value)
 
const Aws::Utils::DateTimeGetRevokedAt () const
 
bool RevokedAtHasBeenSet () const
 
void SetRevokedAt (const Aws::Utils::DateTime &value)
 
void SetRevokedAt (Aws::Utils::DateTime &&value)
 
CertificateWithRevokedAt (const Aws::Utils::DateTime &value)
 
CertificateWithRevokedAt (Aws::Utils::DateTime &&value)
 
const Aws::StringGetRevocationReason () const
 
bool RevocationReasonHasBeenSet () const
 
void SetRevocationReason (const Aws::String &value)
 
void SetRevocationReason (Aws::String &&value)
 
void SetRevocationReason (const char *value)
 
CertificateWithRevocationReason (const Aws::String &value)
 
CertificateWithRevocationReason (Aws::String &&value)
 
CertificateWithRevocationReason (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)
 
CertificateWithTags (const Aws::Vector< Tag > &value)
 
CertificateWithTags (Aws::Vector< Tag > &&value)
 
CertificateAddTags (const Tag &value)
 
CertificateAddTags (Tag &&value)
 
const Aws::StringGetSupportCode () const
 
bool SupportCodeHasBeenSet () const
 
void SetSupportCode (const Aws::String &value)
 
void SetSupportCode (Aws::String &&value)
 
void SetSupportCode (const char *value)
 
CertificateWithSupportCode (const Aws::String &value)
 
CertificateWithSupportCode (Aws::String &&value)
 
CertificateWithSupportCode (const char *value)
 

Detailed Description

Describes the full details of an Amazon Lightsail SSL/TLS certificate.

To get a summary of a certificate, use the GetCertificates action and ommit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

See Also:

AWS API Reference

Definition at line 42 of file Certificate.h.

Constructor & Destructor Documentation

◆ Certificate() [1/2]

Aws::Lightsail::Model::Certificate::Certificate ( )

◆ Certificate() [2/2]

Aws::Lightsail::Model::Certificate::Certificate ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddDomainValidationRecords() [1/2]

Certificate& Aws::Lightsail::Model::Certificate::AddDomainValidationRecords ( const DomainValidationRecord value)
inline

An array of objects that describe the domain validation records of the certificate.

Definition at line 350 of file Certificate.h.

◆ AddDomainValidationRecords() [2/2]

Certificate& Aws::Lightsail::Model::Certificate::AddDomainValidationRecords ( DomainValidationRecord &&  value)
inline

An array of objects that describe the domain validation records of the certificate.

Definition at line 356 of file Certificate.h.

◆ AddSubjectAlternativeNames() [1/3]

Certificate& Aws::Lightsail::Model::Certificate::AddSubjectAlternativeNames ( Aws::String &&  value)
inline

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) of the certificate.

Definition at line 300 of file Certificate.h.

◆ AddSubjectAlternativeNames() [2/3]

Certificate& Aws::Lightsail::Model::Certificate::AddSubjectAlternativeNames ( const Aws::String value)
inline

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) of the certificate.

Definition at line 293 of file Certificate.h.

◆ AddSubjectAlternativeNames() [3/3]

Certificate& Aws::Lightsail::Model::Certificate::AddSubjectAlternativeNames ( const char *  value)
inline

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) of the certificate.

Definition at line 307 of file Certificate.h.

◆ AddTags() [1/2]

Certificate& Aws::Lightsail::Model::Certificate::AddTags ( const Tag value)
inline

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

Definition at line 1157 of file Certificate.h.

◆ AddTags() [2/2]

Certificate& Aws::Lightsail::Model::Certificate::AddTags ( Tag &&  value)
inline

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

Definition at line 1165 of file Certificate.h.

◆ ArnHasBeenSet()

bool Aws::Lightsail::Model::Certificate::ArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the certificate.

Definition at line 59 of file Certificate.h.

◆ CreatedAtHasBeenSet()

bool Aws::Lightsail::Model::Certificate::CreatedAtHasBeenSet ( ) const
inline

The timestamp when the certificate was created.

Definition at line 782 of file Certificate.h.

◆ DomainNameHasBeenSet()

bool Aws::Lightsail::Model::Certificate::DomainNameHasBeenSet ( ) const
inline

The domain name of the certificate.

Definition at line 141 of file Certificate.h.

◆ DomainValidationRecordsHasBeenSet()

bool Aws::Lightsail::Model::Certificate::DomainValidationRecordsHasBeenSet ( ) const
inline

An array of objects that describe the domain validation records of the certificate.

Definition at line 320 of file Certificate.h.

◆ EligibleToRenewHasBeenSet()

bool Aws::Lightsail::Model::Certificate::EligibleToRenewHasBeenSet ( ) const
inline

The renewal eligibility of the certificate.

Definition at line 947 of file Certificate.h.

◆ GetArn()

const Aws::String& Aws::Lightsail::Model::Certificate::GetArn ( ) const
inline

The Amazon Resource Name (ARN) of the certificate.

Definition at line 54 of file Certificate.h.

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::Lightsail::Model::Certificate::GetCreatedAt ( ) const
inline

The timestamp when the certificate was created.

Definition at line 777 of file Certificate.h.

◆ GetDomainName()

const Aws::String& Aws::Lightsail::Model::Certificate::GetDomainName ( ) const
inline

The domain name of the certificate.

Definition at line 136 of file Certificate.h.

◆ GetDomainValidationRecords()

const Aws::Vector<DomainValidationRecord>& Aws::Lightsail::Model::Certificate::GetDomainValidationRecords ( ) const
inline

An array of objects that describe the domain validation records of the certificate.

Definition at line 314 of file Certificate.h.

◆ GetEligibleToRenew()

const Aws::String& Aws::Lightsail::Model::Certificate::GetEligibleToRenew ( ) const
inline

The renewal eligibility of the certificate.

Definition at line 942 of file Certificate.h.

◆ GetInUseResourceCount()

int Aws::Lightsail::Model::Certificate::GetInUseResourceCount ( ) const
inline

The number of Lightsail resources that the certificate is attached to.

Definition at line 707 of file Certificate.h.

◆ GetIssuedAt()

const Aws::Utils::DateTime& Aws::Lightsail::Model::Certificate::GetIssuedAt ( ) const
inline

The timestamp when the certificate was issued.

Definition at line 808 of file Certificate.h.

◆ GetIssuerCA()

const Aws::String& Aws::Lightsail::Model::Certificate::GetIssuerCA ( ) const
inline

The certificate authority that issued the certificate.

Definition at line 839 of file Certificate.h.

◆ GetKeyAlgorithm()

const Aws::String& Aws::Lightsail::Model::Certificate::GetKeyAlgorithm ( ) const
inline

The algorithm used to generate the key pair (the public and private key) of the certificate.

Definition at line 729 of file Certificate.h.

◆ GetName()

const Aws::String& Aws::Lightsail::Model::Certificate::GetName ( ) const
inline

The name of the certificate (e.g., my-certificate).

Definition at line 95 of file Certificate.h.

◆ GetNotAfter()

const Aws::Utils::DateTime& Aws::Lightsail::Model::Certificate::GetNotAfter ( ) const
inline

The timestamp when the certificate expires.

Definition at line 911 of file Certificate.h.

◆ GetNotBefore()

const Aws::Utils::DateTime& Aws::Lightsail::Model::Certificate::GetNotBefore ( ) const
inline

The timestamp when the certificate is first valid.

Definition at line 880 of file Certificate.h.

◆ GetRenewalSummary()

const RenewalSummary& Aws::Lightsail::Model::Certificate::GetRenewalSummary ( ) const
inline

An object that describes the status of the certificate renewal managed by Lightsail.

Definition at line 984 of file Certificate.h.

◆ GetRequestFailureReason()

const Aws::String& Aws::Lightsail::Model::Certificate::GetRequestFailureReason ( ) const
inline

The validation failure reason, if any, of the certificate.

The following failure reasons are possible:

  • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.

  • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.

    You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.

  • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.

    If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.

    If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.

  • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.

  • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.

Definition at line 400 of file Certificate.h.

◆ GetRevocationReason()

const Aws::String& Aws::Lightsail::Model::Certificate::GetRevocationReason ( ) const
inline

The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.

Definition at line 1058 of file Certificate.h.

◆ GetRevokedAt()

const Aws::Utils::DateTime& Aws::Lightsail::Model::Certificate::GetRevokedAt ( ) const
inline

The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.

Definition at line 1021 of file Certificate.h.

◆ GetSerialNumber()

const Aws::String& Aws::Lightsail::Model::Certificate::GetSerialNumber ( ) const
inline

The serial number of the certificate.

Definition at line 208 of file Certificate.h.

◆ GetStatus()

const CertificateStatus& Aws::Lightsail::Model::Certificate::GetStatus ( ) const
inline

The validation status of the certificate.

Definition at line 177 of file Certificate.h.

◆ GetSubjectAlternativeNames()

const Aws::Vector<Aws::String>& Aws::Lightsail::Model::Certificate::GetSubjectAlternativeNames ( ) const
inline

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) of the certificate.

Definition at line 251 of file Certificate.h.

◆ GetSupportCode()

const Aws::String& Aws::Lightsail::Model::Certificate::GetSupportCode ( ) const
inline

The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.

Definition at line 1173 of file Certificate.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::Lightsail::Model::Certificate::GetTags ( ) const
inline

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

Definition at line 1109 of file Certificate.h.

◆ InUseResourceCountHasBeenSet()

bool Aws::Lightsail::Model::Certificate::InUseResourceCountHasBeenSet ( ) const
inline

The number of Lightsail resources that the certificate is attached to.

Definition at line 712 of file Certificate.h.

◆ IssuedAtHasBeenSet()

bool Aws::Lightsail::Model::Certificate::IssuedAtHasBeenSet ( ) const
inline

The timestamp when the certificate was issued.

Definition at line 813 of file Certificate.h.

◆ IssuerCAHasBeenSet()

bool Aws::Lightsail::Model::Certificate::IssuerCAHasBeenSet ( ) const
inline

The certificate authority that issued the certificate.

Definition at line 844 of file Certificate.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Lightsail::Model::Certificate::Jsonize ( ) const

◆ KeyAlgorithmHasBeenSet()

bool Aws::Lightsail::Model::Certificate::KeyAlgorithmHasBeenSet ( ) const
inline

The algorithm used to generate the key pair (the public and private key) of the certificate.

Definition at line 735 of file Certificate.h.

◆ NameHasBeenSet()

bool Aws::Lightsail::Model::Certificate::NameHasBeenSet ( ) const
inline

The name of the certificate (e.g., my-certificate).

Definition at line 100 of file Certificate.h.

◆ NotAfterHasBeenSet()

bool Aws::Lightsail::Model::Certificate::NotAfterHasBeenSet ( ) const
inline

The timestamp when the certificate expires.

Definition at line 916 of file Certificate.h.

◆ NotBeforeHasBeenSet()

bool Aws::Lightsail::Model::Certificate::NotBeforeHasBeenSet ( ) const
inline

The timestamp when the certificate is first valid.

Definition at line 885 of file Certificate.h.

◆ operator=()

Certificate& Aws::Lightsail::Model::Certificate::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RenewalSummaryHasBeenSet()

bool Aws::Lightsail::Model::Certificate::RenewalSummaryHasBeenSet ( ) const
inline

An object that describes the status of the certificate renewal managed by Lightsail.

Definition at line 990 of file Certificate.h.

◆ RequestFailureReasonHasBeenSet()

bool Aws::Lightsail::Model::Certificate::RequestFailureReasonHasBeenSet ( ) const
inline

The validation failure reason, if any, of the certificate.

The following failure reasons are possible:

  • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.

  • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.

    You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.

  • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.

    If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.

    If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.

  • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.

  • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.

Definition at line 443 of file Certificate.h.

◆ RevocationReasonHasBeenSet()

bool Aws::Lightsail::Model::Certificate::RevocationReasonHasBeenSet ( ) const
inline

The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.

Definition at line 1064 of file Certificate.h.

◆ RevokedAtHasBeenSet()

bool Aws::Lightsail::Model::Certificate::RevokedAtHasBeenSet ( ) const
inline

The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.

Definition at line 1027 of file Certificate.h.

◆ SerialNumberHasBeenSet()

bool Aws::Lightsail::Model::Certificate::SerialNumberHasBeenSet ( ) const
inline

The serial number of the certificate.

Definition at line 213 of file Certificate.h.

◆ SetArn() [1/3]

void Aws::Lightsail::Model::Certificate::SetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the certificate.

Definition at line 69 of file Certificate.h.

◆ SetArn() [2/3]

void Aws::Lightsail::Model::Certificate::SetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the certificate.

Definition at line 64 of file Certificate.h.

◆ SetArn() [3/3]

void Aws::Lightsail::Model::Certificate::SetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the certificate.

Definition at line 74 of file Certificate.h.

◆ SetCreatedAt() [1/2]

void Aws::Lightsail::Model::Certificate::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the certificate was created.

Definition at line 792 of file Certificate.h.

◆ SetCreatedAt() [2/2]

void Aws::Lightsail::Model::Certificate::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

The timestamp when the certificate was created.

Definition at line 787 of file Certificate.h.

◆ SetDomainName() [1/3]

void Aws::Lightsail::Model::Certificate::SetDomainName ( Aws::String &&  value)
inline

The domain name of the certificate.

Definition at line 151 of file Certificate.h.

◆ SetDomainName() [2/3]

void Aws::Lightsail::Model::Certificate::SetDomainName ( const Aws::String value)
inline

The domain name of the certificate.

Definition at line 146 of file Certificate.h.

◆ SetDomainName() [3/3]

void Aws::Lightsail::Model::Certificate::SetDomainName ( const char *  value)
inline

The domain name of the certificate.

Definition at line 156 of file Certificate.h.

◆ SetDomainValidationRecords() [1/2]

void Aws::Lightsail::Model::Certificate::SetDomainValidationRecords ( Aws::Vector< DomainValidationRecord > &&  value)
inline

An array of objects that describe the domain validation records of the certificate.

Definition at line 332 of file Certificate.h.

◆ SetDomainValidationRecords() [2/2]

void Aws::Lightsail::Model::Certificate::SetDomainValidationRecords ( const Aws::Vector< DomainValidationRecord > &  value)
inline

An array of objects that describe the domain validation records of the certificate.

Definition at line 326 of file Certificate.h.

◆ SetEligibleToRenew() [1/3]

void Aws::Lightsail::Model::Certificate::SetEligibleToRenew ( Aws::String &&  value)
inline

The renewal eligibility of the certificate.

Definition at line 957 of file Certificate.h.

◆ SetEligibleToRenew() [2/3]

void Aws::Lightsail::Model::Certificate::SetEligibleToRenew ( const Aws::String value)
inline

The renewal eligibility of the certificate.

Definition at line 952 of file Certificate.h.

◆ SetEligibleToRenew() [3/3]

void Aws::Lightsail::Model::Certificate::SetEligibleToRenew ( const char *  value)
inline

The renewal eligibility of the certificate.

Definition at line 962 of file Certificate.h.

◆ SetInUseResourceCount()

void Aws::Lightsail::Model::Certificate::SetInUseResourceCount ( int  value)
inline

The number of Lightsail resources that the certificate is attached to.

Definition at line 717 of file Certificate.h.

◆ SetIssuedAt() [1/2]

void Aws::Lightsail::Model::Certificate::SetIssuedAt ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the certificate was issued.

Definition at line 823 of file Certificate.h.

◆ SetIssuedAt() [2/2]

void Aws::Lightsail::Model::Certificate::SetIssuedAt ( const Aws::Utils::DateTime value)
inline

The timestamp when the certificate was issued.

Definition at line 818 of file Certificate.h.

◆ SetIssuerCA() [1/3]

void Aws::Lightsail::Model::Certificate::SetIssuerCA ( Aws::String &&  value)
inline

The certificate authority that issued the certificate.

Definition at line 854 of file Certificate.h.

◆ SetIssuerCA() [2/3]

void Aws::Lightsail::Model::Certificate::SetIssuerCA ( const Aws::String value)
inline

The certificate authority that issued the certificate.

Definition at line 849 of file Certificate.h.

◆ SetIssuerCA() [3/3]

void Aws::Lightsail::Model::Certificate::SetIssuerCA ( const char *  value)
inline

The certificate authority that issued the certificate.

Definition at line 859 of file Certificate.h.

◆ SetKeyAlgorithm() [1/3]

void Aws::Lightsail::Model::Certificate::SetKeyAlgorithm ( Aws::String &&  value)
inline

The algorithm used to generate the key pair (the public and private key) of the certificate.

Definition at line 747 of file Certificate.h.

◆ SetKeyAlgorithm() [2/3]

void Aws::Lightsail::Model::Certificate::SetKeyAlgorithm ( const Aws::String value)
inline

The algorithm used to generate the key pair (the public and private key) of the certificate.

Definition at line 741 of file Certificate.h.

◆ SetKeyAlgorithm() [3/3]

void Aws::Lightsail::Model::Certificate::SetKeyAlgorithm ( const char *  value)
inline

The algorithm used to generate the key pair (the public and private key) of the certificate.

Definition at line 753 of file Certificate.h.

◆ SetName() [1/3]

void Aws::Lightsail::Model::Certificate::SetName ( Aws::String &&  value)
inline

The name of the certificate (e.g., my-certificate).

Definition at line 110 of file Certificate.h.

◆ SetName() [2/3]

void Aws::Lightsail::Model::Certificate::SetName ( const Aws::String value)
inline

The name of the certificate (e.g., my-certificate).

Definition at line 105 of file Certificate.h.

◆ SetName() [3/3]

void Aws::Lightsail::Model::Certificate::SetName ( const char *  value)
inline

The name of the certificate (e.g., my-certificate).

Definition at line 115 of file Certificate.h.

◆ SetNotAfter() [1/2]

void Aws::Lightsail::Model::Certificate::SetNotAfter ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the certificate expires.

Definition at line 926 of file Certificate.h.

◆ SetNotAfter() [2/2]

void Aws::Lightsail::Model::Certificate::SetNotAfter ( const Aws::Utils::DateTime value)
inline

The timestamp when the certificate expires.

Definition at line 921 of file Certificate.h.

◆ SetNotBefore() [1/2]

void Aws::Lightsail::Model::Certificate::SetNotBefore ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the certificate is first valid.

Definition at line 895 of file Certificate.h.

◆ SetNotBefore() [2/2]

void Aws::Lightsail::Model::Certificate::SetNotBefore ( const Aws::Utils::DateTime value)
inline

The timestamp when the certificate is first valid.

Definition at line 890 of file Certificate.h.

◆ SetRenewalSummary() [1/2]

void Aws::Lightsail::Model::Certificate::SetRenewalSummary ( const RenewalSummary value)
inline

An object that describes the status of the certificate renewal managed by Lightsail.

Definition at line 996 of file Certificate.h.

◆ SetRenewalSummary() [2/2]

void Aws::Lightsail::Model::Certificate::SetRenewalSummary ( RenewalSummary &&  value)
inline

An object that describes the status of the certificate renewal managed by Lightsail.

Definition at line 1002 of file Certificate.h.

◆ SetRequestFailureReason() [1/3]

void Aws::Lightsail::Model::Certificate::SetRequestFailureReason ( Aws::String &&  value)
inline

The validation failure reason, if any, of the certificate.

The following failure reasons are possible:

  • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.

  • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.

    You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.

  • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.

    If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.

    If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.

  • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.

  • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.

Definition at line 529 of file Certificate.h.

◆ SetRequestFailureReason() [2/3]

void Aws::Lightsail::Model::Certificate::SetRequestFailureReason ( const Aws::String value)
inline

The validation failure reason, if any, of the certificate.

The following failure reasons are possible:

  • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.

  • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.

    You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.

  • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.

    If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.

    If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.

  • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.

  • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.

Definition at line 486 of file Certificate.h.

◆ SetRequestFailureReason() [3/3]

void Aws::Lightsail::Model::Certificate::SetRequestFailureReason ( const char *  value)
inline

The validation failure reason, if any, of the certificate.

The following failure reasons are possible:

  • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.

  • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.

    You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.

  • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.

    If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.

    If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.

  • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.

  • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.

Definition at line 572 of file Certificate.h.

◆ SetRevocationReason() [1/3]

void Aws::Lightsail::Model::Certificate::SetRevocationReason ( Aws::String &&  value)
inline

The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.

Definition at line 1076 of file Certificate.h.

◆ SetRevocationReason() [2/3]

void Aws::Lightsail::Model::Certificate::SetRevocationReason ( const Aws::String value)
inline

The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.

Definition at line 1070 of file Certificate.h.

◆ SetRevocationReason() [3/3]

void Aws::Lightsail::Model::Certificate::SetRevocationReason ( const char *  value)
inline

The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.

Definition at line 1082 of file Certificate.h.

◆ SetRevokedAt() [1/2]

void Aws::Lightsail::Model::Certificate::SetRevokedAt ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.

Definition at line 1039 of file Certificate.h.

◆ SetRevokedAt() [2/2]

void Aws::Lightsail::Model::Certificate::SetRevokedAt ( const Aws::Utils::DateTime value)
inline

The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.

Definition at line 1033 of file Certificate.h.

◆ SetSerialNumber() [1/3]

void Aws::Lightsail::Model::Certificate::SetSerialNumber ( Aws::String &&  value)
inline

The serial number of the certificate.

Definition at line 223 of file Certificate.h.

◆ SetSerialNumber() [2/3]

void Aws::Lightsail::Model::Certificate::SetSerialNumber ( const Aws::String value)
inline

The serial number of the certificate.

Definition at line 218 of file Certificate.h.

◆ SetSerialNumber() [3/3]

void Aws::Lightsail::Model::Certificate::SetSerialNumber ( const char *  value)
inline

The serial number of the certificate.

Definition at line 228 of file Certificate.h.

◆ SetStatus() [1/2]

void Aws::Lightsail::Model::Certificate::SetStatus ( CertificateStatus &&  value)
inline

The validation status of the certificate.

Definition at line 192 of file Certificate.h.

◆ SetStatus() [2/2]

void Aws::Lightsail::Model::Certificate::SetStatus ( const CertificateStatus value)
inline

The validation status of the certificate.

Definition at line 187 of file Certificate.h.

◆ SetSubjectAlternativeNames() [1/2]

void Aws::Lightsail::Model::Certificate::SetSubjectAlternativeNames ( Aws::Vector< Aws::String > &&  value)
inline

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) of the certificate.

Definition at line 272 of file Certificate.h.

◆ SetSubjectAlternativeNames() [2/2]

void Aws::Lightsail::Model::Certificate::SetSubjectAlternativeNames ( const Aws::Vector< Aws::String > &  value)
inline

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) of the certificate.

Definition at line 265 of file Certificate.h.

◆ SetSupportCode() [1/3]

void Aws::Lightsail::Model::Certificate::SetSupportCode ( Aws::String &&  value)
inline

The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.

Definition at line 1194 of file Certificate.h.

◆ SetSupportCode() [2/3]

void Aws::Lightsail::Model::Certificate::SetSupportCode ( const Aws::String value)
inline

The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.

Definition at line 1187 of file Certificate.h.

◆ SetSupportCode() [3/3]

void Aws::Lightsail::Model::Certificate::SetSupportCode ( const char *  value)
inline

The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.

Definition at line 1201 of file Certificate.h.

◆ SetTags() [1/2]

void Aws::Lightsail::Model::Certificate::SetTags ( Aws::Vector< Tag > &&  value)
inline

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

Definition at line 1133 of file Certificate.h.

◆ SetTags() [2/2]

void Aws::Lightsail::Model::Certificate::SetTags ( const Aws::Vector< Tag > &  value)
inline

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

Definition at line 1125 of file Certificate.h.

◆ StatusHasBeenSet()

bool Aws::Lightsail::Model::Certificate::StatusHasBeenSet ( ) const
inline

The validation status of the certificate.

Definition at line 182 of file Certificate.h.

◆ SubjectAlternativeNamesHasBeenSet()

bool Aws::Lightsail::Model::Certificate::SubjectAlternativeNamesHasBeenSet ( ) const
inline

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) of the certificate.

Definition at line 258 of file Certificate.h.

◆ SupportCodeHasBeenSet()

bool Aws::Lightsail::Model::Certificate::SupportCodeHasBeenSet ( ) const
inline

The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.

Definition at line 1180 of file Certificate.h.

◆ TagsHasBeenSet()

bool Aws::Lightsail::Model::Certificate::TagsHasBeenSet ( ) const
inline

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

Definition at line 1117 of file Certificate.h.

◆ WithArn() [1/3]

Certificate& Aws::Lightsail::Model::Certificate::WithArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the certificate.

Definition at line 84 of file Certificate.h.

◆ WithArn() [2/3]

Certificate& Aws::Lightsail::Model::Certificate::WithArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the certificate.

Definition at line 79 of file Certificate.h.

◆ WithArn() [3/3]

Certificate& Aws::Lightsail::Model::Certificate::WithArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the certificate.

Definition at line 89 of file Certificate.h.

◆ WithCreatedAt() [1/2]

Certificate& Aws::Lightsail::Model::Certificate::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the certificate was created.

Definition at line 802 of file Certificate.h.

◆ WithCreatedAt() [2/2]

Certificate& Aws::Lightsail::Model::Certificate::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

The timestamp when the certificate was created.

Definition at line 797 of file Certificate.h.

◆ WithDomainName() [1/3]

Certificate& Aws::Lightsail::Model::Certificate::WithDomainName ( Aws::String &&  value)
inline

The domain name of the certificate.

Definition at line 166 of file Certificate.h.

◆ WithDomainName() [2/3]

Certificate& Aws::Lightsail::Model::Certificate::WithDomainName ( const Aws::String value)
inline

The domain name of the certificate.

Definition at line 161 of file Certificate.h.

◆ WithDomainName() [3/3]

Certificate& Aws::Lightsail::Model::Certificate::WithDomainName ( const char *  value)
inline

The domain name of the certificate.

Definition at line 171 of file Certificate.h.

◆ WithDomainValidationRecords() [1/2]

Certificate& Aws::Lightsail::Model::Certificate::WithDomainValidationRecords ( Aws::Vector< DomainValidationRecord > &&  value)
inline

An array of objects that describe the domain validation records of the certificate.

Definition at line 344 of file Certificate.h.

◆ WithDomainValidationRecords() [2/2]

Certificate& Aws::Lightsail::Model::Certificate::WithDomainValidationRecords ( const Aws::Vector< DomainValidationRecord > &  value)
inline

An array of objects that describe the domain validation records of the certificate.

Definition at line 338 of file Certificate.h.

◆ WithEligibleToRenew() [1/3]

Certificate& Aws::Lightsail::Model::Certificate::WithEligibleToRenew ( Aws::String &&  value)
inline

The renewal eligibility of the certificate.

Definition at line 972 of file Certificate.h.

◆ WithEligibleToRenew() [2/3]

Certificate& Aws::Lightsail::Model::Certificate::WithEligibleToRenew ( const Aws::String value)
inline

The renewal eligibility of the certificate.

Definition at line 967 of file Certificate.h.

◆ WithEligibleToRenew() [3/3]

Certificate& Aws::Lightsail::Model::Certificate::WithEligibleToRenew ( const char *  value)
inline

The renewal eligibility of the certificate.

Definition at line 977 of file Certificate.h.

◆ WithInUseResourceCount()

Certificate& Aws::Lightsail::Model::Certificate::WithInUseResourceCount ( int  value)
inline

The number of Lightsail resources that the certificate is attached to.

Definition at line 722 of file Certificate.h.

◆ WithIssuedAt() [1/2]

Certificate& Aws::Lightsail::Model::Certificate::WithIssuedAt ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the certificate was issued.

Definition at line 833 of file Certificate.h.

◆ WithIssuedAt() [2/2]

Certificate& Aws::Lightsail::Model::Certificate::WithIssuedAt ( const Aws::Utils::DateTime value)
inline

The timestamp when the certificate was issued.

Definition at line 828 of file Certificate.h.

◆ WithIssuerCA() [1/3]

Certificate& Aws::Lightsail::Model::Certificate::WithIssuerCA ( Aws::String &&  value)
inline

The certificate authority that issued the certificate.

Definition at line 869 of file Certificate.h.

◆ WithIssuerCA() [2/3]

Certificate& Aws::Lightsail::Model::Certificate::WithIssuerCA ( const Aws::String value)
inline

The certificate authority that issued the certificate.

Definition at line 864 of file Certificate.h.

◆ WithIssuerCA() [3/3]

Certificate& Aws::Lightsail::Model::Certificate::WithIssuerCA ( const char *  value)
inline

The certificate authority that issued the certificate.

Definition at line 874 of file Certificate.h.

◆ WithKeyAlgorithm() [1/3]

Certificate& Aws::Lightsail::Model::Certificate::WithKeyAlgorithm ( Aws::String &&  value)
inline

The algorithm used to generate the key pair (the public and private key) of the certificate.

Definition at line 765 of file Certificate.h.

◆ WithKeyAlgorithm() [2/3]

Certificate& Aws::Lightsail::Model::Certificate::WithKeyAlgorithm ( const Aws::String value)
inline

The algorithm used to generate the key pair (the public and private key) of the certificate.

Definition at line 759 of file Certificate.h.

◆ WithKeyAlgorithm() [3/3]

Certificate& Aws::Lightsail::Model::Certificate::WithKeyAlgorithm ( const char *  value)
inline

The algorithm used to generate the key pair (the public and private key) of the certificate.

Definition at line 771 of file Certificate.h.

◆ WithName() [1/3]

Certificate& Aws::Lightsail::Model::Certificate::WithName ( Aws::String &&  value)
inline

The name of the certificate (e.g., my-certificate).

Definition at line 125 of file Certificate.h.

◆ WithName() [2/3]

Certificate& Aws::Lightsail::Model::Certificate::WithName ( const Aws::String value)
inline

The name of the certificate (e.g., my-certificate).

Definition at line 120 of file Certificate.h.

◆ WithName() [3/3]

Certificate& Aws::Lightsail::Model::Certificate::WithName ( const char *  value)
inline

The name of the certificate (e.g., my-certificate).

Definition at line 130 of file Certificate.h.

◆ WithNotAfter() [1/2]

Certificate& Aws::Lightsail::Model::Certificate::WithNotAfter ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the certificate expires.

Definition at line 936 of file Certificate.h.

◆ WithNotAfter() [2/2]

Certificate& Aws::Lightsail::Model::Certificate::WithNotAfter ( const Aws::Utils::DateTime value)
inline

The timestamp when the certificate expires.

Definition at line 931 of file Certificate.h.

◆ WithNotBefore() [1/2]

Certificate& Aws::Lightsail::Model::Certificate::WithNotBefore ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the certificate is first valid.

Definition at line 905 of file Certificate.h.

◆ WithNotBefore() [2/2]

Certificate& Aws::Lightsail::Model::Certificate::WithNotBefore ( const Aws::Utils::DateTime value)
inline

The timestamp when the certificate is first valid.

Definition at line 900 of file Certificate.h.

◆ WithRenewalSummary() [1/2]

Certificate& Aws::Lightsail::Model::Certificate::WithRenewalSummary ( const RenewalSummary value)
inline

An object that describes the status of the certificate renewal managed by Lightsail.

Definition at line 1008 of file Certificate.h.

◆ WithRenewalSummary() [2/2]

Certificate& Aws::Lightsail::Model::Certificate::WithRenewalSummary ( RenewalSummary &&  value)
inline

An object that describes the status of the certificate renewal managed by Lightsail.

Definition at line 1014 of file Certificate.h.

◆ WithRequestFailureReason() [1/3]

Certificate& Aws::Lightsail::Model::Certificate::WithRequestFailureReason ( Aws::String &&  value)
inline

The validation failure reason, if any, of the certificate.

The following failure reasons are possible:

  • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.

  • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.

    You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.

  • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.

    If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.

    If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.

  • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.

  • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.

Definition at line 658 of file Certificate.h.

◆ WithRequestFailureReason() [2/3]

Certificate& Aws::Lightsail::Model::Certificate::WithRequestFailureReason ( const Aws::String value)
inline

The validation failure reason, if any, of the certificate.

The following failure reasons are possible:

  • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.

  • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.

    You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.

  • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.

    If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.

    If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.

  • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.

  • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.

Definition at line 615 of file Certificate.h.

◆ WithRequestFailureReason() [3/3]

Certificate& Aws::Lightsail::Model::Certificate::WithRequestFailureReason ( const char *  value)
inline

The validation failure reason, if any, of the certificate.

The following failure reasons are possible:

  • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.

  • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.

    You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.

  • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.

    If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.

    If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.

  • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.

  • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.

Definition at line 701 of file Certificate.h.

◆ WithRevocationReason() [1/3]

Certificate& Aws::Lightsail::Model::Certificate::WithRevocationReason ( Aws::String &&  value)
inline

The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.

Definition at line 1094 of file Certificate.h.

◆ WithRevocationReason() [2/3]

Certificate& Aws::Lightsail::Model::Certificate::WithRevocationReason ( const Aws::String value)
inline

The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.

Definition at line 1088 of file Certificate.h.

◆ WithRevocationReason() [3/3]

Certificate& Aws::Lightsail::Model::Certificate::WithRevocationReason ( const char *  value)
inline

The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.

Definition at line 1100 of file Certificate.h.

◆ WithRevokedAt() [1/2]

Certificate& Aws::Lightsail::Model::Certificate::WithRevokedAt ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.

Definition at line 1051 of file Certificate.h.

◆ WithRevokedAt() [2/2]

Certificate& Aws::Lightsail::Model::Certificate::WithRevokedAt ( const Aws::Utils::DateTime value)
inline

The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.

Definition at line 1045 of file Certificate.h.

◆ WithSerialNumber() [1/3]

Certificate& Aws::Lightsail::Model::Certificate::WithSerialNumber ( Aws::String &&  value)
inline

The serial number of the certificate.

Definition at line 238 of file Certificate.h.

◆ WithSerialNumber() [2/3]

Certificate& Aws::Lightsail::Model::Certificate::WithSerialNumber ( const Aws::String value)
inline

The serial number of the certificate.

Definition at line 233 of file Certificate.h.

◆ WithSerialNumber() [3/3]

Certificate& Aws::Lightsail::Model::Certificate::WithSerialNumber ( const char *  value)
inline

The serial number of the certificate.

Definition at line 243 of file Certificate.h.

◆ WithStatus() [1/2]

Certificate& Aws::Lightsail::Model::Certificate::WithStatus ( CertificateStatus &&  value)
inline

The validation status of the certificate.

Definition at line 202 of file Certificate.h.

◆ WithStatus() [2/2]

Certificate& Aws::Lightsail::Model::Certificate::WithStatus ( const CertificateStatus value)
inline

The validation status of the certificate.

Definition at line 197 of file Certificate.h.

◆ WithSubjectAlternativeNames() [1/2]

Certificate& Aws::Lightsail::Model::Certificate::WithSubjectAlternativeNames ( Aws::Vector< Aws::String > &&  value)
inline

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) of the certificate.

Definition at line 286 of file Certificate.h.

◆ WithSubjectAlternativeNames() [2/2]

Certificate& Aws::Lightsail::Model::Certificate::WithSubjectAlternativeNames ( const Aws::Vector< Aws::String > &  value)
inline

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) of the certificate.

Definition at line 279 of file Certificate.h.

◆ WithSupportCode() [1/3]

Certificate& Aws::Lightsail::Model::Certificate::WithSupportCode ( Aws::String &&  value)
inline

The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.

Definition at line 1215 of file Certificate.h.

◆ WithSupportCode() [2/3]

Certificate& Aws::Lightsail::Model::Certificate::WithSupportCode ( const Aws::String value)
inline

The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.

Definition at line 1208 of file Certificate.h.

◆ WithSupportCode() [3/3]

Certificate& Aws::Lightsail::Model::Certificate::WithSupportCode ( const char *  value)
inline

The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.

Definition at line 1222 of file Certificate.h.

◆ WithTags() [1/2]

Certificate& Aws::Lightsail::Model::Certificate::WithTags ( Aws::Vector< Tag > &&  value)
inline

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

Definition at line 1149 of file Certificate.h.

◆ WithTags() [2/2]

Certificate& Aws::Lightsail::Model::Certificate::WithTags ( const Aws::Vector< Tag > &  value)
inline

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

Definition at line 1141 of file Certificate.h.


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