Skip to content

LoadBalancerTlsCertificate

Source code in docs_src/capo_lightsail/types/load_balancer_tls_certificate.py
class LoadBalancerTlsCertificate(TypedDict, closed=True):
    name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The name of the SSL/TLS certificate (<code>my-certificate</code>).</p>"""
    arn: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The Amazon Resource Name (ARN) of the SSL/TLS certificate.</p>"""
    support_code: NotRequired["capo_lightsail.types.string.string"]
    """<p>The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily.</p>"""
    created_at: NotRequired["capo_lightsail.types.iso_date.IsoDate"]
    """<p>The time when you created your SSL/TLS certificate.</p>"""
    location: NotRequired["capo_lightsail.types.resource_location.ResourceLocation"]
    """<p>The Amazon Web Services Region and Availability Zone where you created your certificate.</p>"""
    resource_type: NotRequired["capo_lightsail.types.resource_type.ResourceType"]
    """<p>The resource type (<code>LoadBalancerTlsCertificate</code>).</p> <ul> <li> <p> <b> <code>Instance</code> </b> - A Lightsail instance (a virtual private server)</p> </li> <li> <p> <b> <code>StaticIp</code> </b> - A static IP address</p> </li> <li> <p> <b> <code>KeyPair</code> </b> - The key pair used to connect to a Lightsail instance</p> </li> <li> <p> <b> <code>InstanceSnapshot</code> </b> - A Lightsail instance snapshot</p> </li> <li> <p> <b> <code>Domain</code> </b> - A DNS zone</p> </li> <li> <p> <b> <code>PeeredVpc</code> </b> - A peered VPC</p> </li> <li> <p> <b> <code>LoadBalancer</code> </b> - A Lightsail load balancer</p> </li> <li> <p> <b> <code>LoadBalancerTlsCertificate</code> </b> - An SSL/TLS certificate associated with a Lightsail load balancer</p> </li> <li> <p> <b> <code>Disk</code> </b> - A Lightsail block storage disk</p> </li> <li> <p> <b> <code>DiskSnapshot</code> </b> - A block storage disk snapshot</p> </li> </ul>"""
    tags: NotRequired["capo_lightsail.types.tag_list.TagList"]
    """<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>"""
    load_balancer_name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The load balancer name where your SSL/TLS certificate is attached.</p>"""
    is_attached: NotRequired["capo_lightsail.types.boolean.boolean"]
    """<p>When <code>true</code>, the SSL/TLS certificate is attached to the Lightsail load balancer.</p>"""
    status: NotRequired[
        "capo_lightsail.types.load_balancer_tls_certificate_status.LoadBalancerTlsCertificateStatus"
    ]
    """<p>The validation status of the SSL/TLS certificate. Valid values are below.</p>"""
    domain_name: NotRequired["capo_lightsail.types.domain_name.DomainName"]
    """<p>The domain name for your SSL/TLS certificate.</p>"""
    domain_validation_records: NotRequired[
        "capo_lightsail.types.load_balancer_tls_certificate_domain_validation_record_list.LoadBalancerTlsCertificateDomainValidationRecordList"
    ]
    """<p>An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.</p>"""
    failure_reason: NotRequired[
        "capo_lightsail.types.load_balancer_tls_certificate_failure_reason.LoadBalancerTlsCertificateFailureReason"
    ]
    """<p>The validation failure reason, if any, of the certificate.</p> <p>The following failure reasons are possible:</p> <ul> <li> <p> <b> <code>NO_AVAILABLE_CONTACTS</code> </b> - This failure applies to email validation, which is not available for Lightsail certificates.</p> </li> <li> <p> <b> <code>ADDITIONAL_VERIFICATION_REQUIRED</code> </b> - 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 <a href="https://console.aws.amazon.com/support/home">AWS Support Center</a> to contact AWS Support.</p> <note> <p>You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.</p> </note> </li> <li> <p> <b> <code>DOMAIN_NOT_ALLOWED</code> </b> - One or more of the domain names in the certificate request was reported as an unsafe domain by <a href="https://www.virustotal.com/gui/home/url">VirusTotal</a>. To correct the problem, search for your domain name on the <a href="https://www.virustotal.com/gui/home/url">VirusTotal</a> website. If your domain is reported as suspicious, see <a href="https://developers.google.com/web/fundamentals/security/hacked">Google Help for Hacked Websites</a> to learn what you can do.</p> <p>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.</p> <p>If you see this error and your domain is not included in the VirusTotal list, visit the <a href="https://console.aws.amazon.com/support/home">AWS Support Center</a> and create a case.</p> </li> <li> <p> <b> <code>INVALID_PUBLIC_DOMAIN</code> </b> - 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 <code>example.invalidpublicdomain</code> because <code>invalidpublicdomain</code> is not a valid top-level domain.</p> </li> <li> <p> <b> <code>OTHER</code> </b> - 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. </p> </li> </ul>"""
    issued_at: NotRequired["capo_lightsail.types.iso_date.IsoDate"]
    """<p>The time when the SSL/TLS certificate was issued.</p>"""
    issuer: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The issuer of the certificate.</p>"""
    key_algorithm: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The algorithm used to generate the key pair (the public and private key).</p>"""
    not_after: NotRequired["capo_lightsail.types.iso_date.IsoDate"]
    """<p>The timestamp when the SSL/TLS certificate expires.</p>"""
    not_before: NotRequired["capo_lightsail.types.iso_date.IsoDate"]
    """<p>The timestamp when the SSL/TLS certificate is first valid.</p>"""
    renewal_summary: NotRequired[
        "capo_lightsail.types.load_balancer_tls_certificate_renewal_summary.LoadBalancerTlsCertificateRenewalSummary"
    ]
    """<p>An object that describes the status of the certificate renewal managed by Lightsail.</p>"""
    revocation_reason: NotRequired[
        "capo_lightsail.types.load_balancer_tls_certificate_revocation_reason.LoadBalancerTlsCertificateRevocationReason"
    ]
    """<p>The reason the certificate was revoked. This value is present only when the certificate status is <code>REVOKED</code>.</p>"""
    revoked_at: NotRequired["capo_lightsail.types.iso_date.IsoDate"]
    """<p>The timestamp when the certificate was revoked. This value is present only when the certificate status is <code>REVOKED</code>.</p>"""
    serial: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The serial number of the certificate.</p>"""
    signature_algorithm: NotRequired[
        "capo_lightsail.types.non_empty_string.NonEmptyString"
    ]
    """<p>The algorithm that was used to sign the certificate.</p>"""
    subject: NotRequired["capo_lightsail.types.non_empty_string.NonEmptyString"]
    """<p>The name of the entity that is associated with the public key contained in the certificate.</p>"""
    subject_alternative_names: NotRequired[
        "capo_lightsail.types.string_list.StringList"
    ]
    """<p>An array of strings that specify the alternate domains (<code>example2.com</code>) and subdomains (<code>blog.example.com</code>) for the certificate.</p>"""

arn instance-attribute

arn: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the SSL/TLS certificate.

created_at instance-attribute

created_at: NotRequired[IsoDate]

The time when you created your SSL/TLS certificate.

domain_name instance-attribute

domain_name: NotRequired[DomainName]

The domain name for your SSL/TLS certificate.

domain_validation_records instance-attribute

domain_validation_records: NotRequired[
    LoadBalancerTlsCertificateDomainValidationRecordList
]

An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.

failure_reason instance-attribute

failure_reason: NotRequired[LoadBalancerTlsCertificateFailureReason]

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.

is_attached instance-attribute

is_attached: NotRequired[boolean]

When true, the SSL/TLS certificate is attached to the Lightsail load balancer.

issued_at instance-attribute

issued_at: NotRequired[IsoDate]

The time when the SSL/TLS certificate was issued.

issuer instance-attribute

issuer: NotRequired[NonEmptyString]

The issuer of the certificate.

key_algorithm instance-attribute

key_algorithm: NotRequired[NonEmptyString]

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

load_balancer_name instance-attribute

load_balancer_name: NotRequired[ResourceName]

The load balancer name where your SSL/TLS certificate is attached.

location instance-attribute

location: NotRequired[ResourceLocation]

The Amazon Web Services Region and Availability Zone where you created your certificate.

name instance-attribute

name: NotRequired[ResourceName]

The name of the SSL/TLS certificate (my-certificate).

not_after instance-attribute

not_after: NotRequired[IsoDate]

The timestamp when the SSL/TLS certificate expires.

not_before instance-attribute

not_before: NotRequired[IsoDate]

The timestamp when the SSL/TLS certificate is first valid.

renewal_summary instance-attribute

renewal_summary: NotRequired[LoadBalancerTlsCertificateRenewalSummary]

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

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

The resource type (LoadBalancerTlsCertificate).

  • Instance - A Lightsail instance (a virtual private server)

  • StaticIp - A static IP address

  • KeyPair - The key pair used to connect to a Lightsail instance

  • InstanceSnapshot - A Lightsail instance snapshot

  • Domain - A DNS zone

  • PeeredVpc - A peered VPC

  • LoadBalancer - A Lightsail load balancer

  • LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load balancer

  • Disk - A Lightsail block storage disk

  • DiskSnapshot - A block storage disk snapshot

revocation_reason instance-attribute

revocation_reason: NotRequired[LoadBalancerTlsCertificateRevocationReason]

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

revoked_at instance-attribute

revoked_at: NotRequired[IsoDate]

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

serial instance-attribute

serial: NotRequired[NonEmptyString]

The serial number of the certificate.

signature_algorithm instance-attribute

signature_algorithm: NotRequired[NonEmptyString]

The algorithm that was used to sign the certificate.

status instance-attribute

status: NotRequired[LoadBalancerTlsCertificateStatus]

The validation status of the SSL/TLS certificate. Valid values are below.

subject instance-attribute

subject: NotRequired[NonEmptyString]

The name of the entity that is associated with the public key contained in the certificate.

subject_alternative_names instance-attribute

subject_alternative_names: NotRequired[StringList]

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

support_code instance-attribute

support_code: NotRequired[string]

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

tags instance-attribute

tags: NotRequired[TagList]

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