Class LoadBalancerTlsCertificate

java.lang.Object
software.amazon.awssdk.services.lightsail.model.LoadBalancerTlsCertificate
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LoadBalancerTlsCertificate.Builder,LoadBalancerTlsCertificate>
@Generated("software.amazon.awssdk:codegen") public final class LoadBalancerTlsCertificate extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LoadBalancerTlsCertificate.Builder,LoadBalancerTlsCertificate>

Describes a load balancer SSL/TLS certificate.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

See Also:

  • Method Details

    • name

      public final String name()

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

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

    • arn

      public final String arn()

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

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

    • supportCode

      public final String supportCode()

      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.

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

    • createdAt

      public final Instant createdAt()

      The time when you created your SSL/TLS certificate.

      Returns:
      The time when you created your SSL/TLS certificate.

    • location

      public final ResourceLocation location()

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

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

    • resourceType

      public final ResourceType 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

      If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

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

      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      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

      If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

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

      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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

    • loadBalancerName

      public final String loadBalancerName()

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

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

    • isAttached

      public final Boolean isAttached()

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

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

    • status

      public final LoadBalancerTlsCertificateStatus status()

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

      If the service returns an enum value that is not available in the current SDK version, status will return LoadBalancerTlsCertificateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The validation status of the SSL/TLS certificate. Valid values are below.
      See Also:

    • statusAsString

      public final String statusAsString()

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

      If the service returns an enum value that is not available in the current SDK version, status will return LoadBalancerTlsCertificateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The validation status of the SSL/TLS certificate. Valid values are below.
      See Also:

    • domainName

      public final String domainName()

      The domain name for your SSL/TLS certificate.

      Returns:
      The domain name for your SSL/TLS certificate.

    • hasDomainValidationRecords

      public final boolean hasDomainValidationRecords()
      For responses, this returns true if the service returned a value for the DomainValidationRecords property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • domainValidationRecords

      public final List<LoadBalancerTlsCertificateDomainValidationRecord> domainValidationRecords()

      An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDomainValidationRecords() method.

      Returns:
      An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.

    • failureReason

      public final LoadBalancerTlsCertificateFailureReason failureReason()

      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.

      If the service returns an enum value that is not available in the current SDK version, failureReason will return LoadBalancerTlsCertificateFailureReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureReasonAsString().

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

      See Also:

    • failureReasonAsString

      public final String failureReasonAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, failureReason will return LoadBalancerTlsCertificateFailureReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureReasonAsString().

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

      See Also:

    • issuedAt

      public final Instant issuedAt()

      The time when the SSL/TLS certificate was issued.

      Returns:
      The time when the SSL/TLS certificate was issued.

    • issuer

      public final String issuer()

      The issuer of the certificate.

      Returns:
      The issuer of the certificate.

    • keyAlgorithm

      public final String keyAlgorithm()

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

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

    • notAfter

      public final Instant notAfter()

      The timestamp when the SSL/TLS certificate expires.

      Returns:
      The timestamp when the SSL/TLS certificate expires.

    • notBefore

      public final Instant notBefore()

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

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

    • renewalSummary

      public final LoadBalancerTlsCertificateRenewalSummary renewalSummary()

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

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

    • revocationReason

      public final LoadBalancerTlsCertificateRevocationReason revocationReason()

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

      If the service returns an enum value that is not available in the current SDK version, revocationReason will return LoadBalancerTlsCertificateRevocationReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from revocationReasonAsString().

      Returns:
      The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.
      See Also:

    • revocationReasonAsString

      public final String revocationReasonAsString()

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

      If the service returns an enum value that is not available in the current SDK version, revocationReason will return LoadBalancerTlsCertificateRevocationReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from revocationReasonAsString().

      Returns:
      The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.
      See Also:

    • revokedAt

      public final Instant revokedAt()

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

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

    • serial

      public final String serial()

      The serial number of the certificate.

      Returns:
      The serial number of the certificate.

    • signatureAlgorithm

      public final String signatureAlgorithm()

      The algorithm that was used to sign the certificate.

      Returns:
      The algorithm that was used to sign the certificate.

    • subject

      public final String subject()

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

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

    • hasSubjectAlternativeNames

      public final boolean hasSubjectAlternativeNames()
      For responses, this returns true if the service returned a value for the SubjectAlternativeNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • subjectAlternativeNames

      public final List<String> subjectAlternativeNames()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubjectAlternativeNames() method.

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

    • toBuilder

      public LoadBalancerTlsCertificate.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<LoadBalancerTlsCertificate.Builder,LoadBalancerTlsCertificate>
      Returns:
      a builder for type T

    • builder

      public static LoadBalancerTlsCertificate.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LoadBalancerTlsCertificate.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.