Package software.amazon.awssdk.services.lightsail.model

Interface LoadBalancerTlsCertificate.Builder

All Superinterfaces:
Buildable, CopyableBuilder<LoadBalancerTlsCertificate.Builder,LoadBalancerTlsCertificate>, SdkBuilder<LoadBalancerTlsCertificate.Builder,LoadBalancerTlsCertificate>, SdkPojo
Enclosing class:
LoadBalancerTlsCertificate
public static interface LoadBalancerTlsCertificate.Builder extends SdkPojo, CopyableBuilder<LoadBalancerTlsCertificate.Builder,LoadBalancerTlsCertificate>

  • Method Details

    • name

      LoadBalancerTlsCertificate.Builder name(String name)

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

      Parameters:
      name - The name of the SSL/TLS certificate (e.g., my-certificate).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      LoadBalancerTlsCertificate.Builder arn(String arn)

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

      Parameters:
      arn - The Amazon Resource Name (ARN) of the SSL/TLS certificate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportCode

      LoadBalancerTlsCertificate.Builder supportCode(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      LoadBalancerTlsCertificate.Builder createdAt(Instant createdAt)

      The time when you created your SSL/TLS certificate.

      Parameters:
      createdAt - The time when you created your SSL/TLS certificate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • location

      LoadBalancerTlsCertificate.Builder location(ResourceLocation location)

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

      Parameters:
      location - The Amazon Web Services Region and Availability Zone where you created your certificate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • location

      default LoadBalancerTlsCertificate.Builder location(Consumer<ResourceLocation.Builder> location)

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

      This is a convenience method that creates an instance of the ResourceLocation.Builder avoiding the need to create one manually via ResourceLocation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to location(ResourceLocation).

      Parameters:
      location - a consumer that will call methods on ResourceLocation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceType

      LoadBalancerTlsCertificate.Builder resourceType(String resourceType)

      The resource type (e.g., 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

      Parameters:
      resourceType - The resource type (e.g., 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceType

      LoadBalancerTlsCertificate.Builder resourceType(ResourceType resourceType)

      The resource type (e.g., 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

      Parameters:
      resourceType - The resource type (e.g., 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      LoadBalancerTlsCertificate.Builder tags(Collection<Tag> tags)

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

      Parameters:
      tags - The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      LoadBalancerTlsCertificate.Builder tags(Tag... tags)

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

      Parameters:
      tags - The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      LoadBalancerTlsCertificate.Builder tags(Consumer<Tag.Builder>... tags)

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

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • loadBalancerName

      LoadBalancerTlsCertificate.Builder loadBalancerName(String loadBalancerName)

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

      Parameters:
      loadBalancerName - The load balancer name where your SSL/TLS certificate is attached.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isAttached

      LoadBalancerTlsCertificate.Builder isAttached(Boolean isAttached)

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

      Parameters:
      isAttached - When true, the SSL/TLS certificate is attached to the Lightsail load balancer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      LoadBalancerTlsCertificate.Builder status(String status)

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

      Parameters:
      status - The validation status of the SSL/TLS certificate. Valid values are below.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      LoadBalancerTlsCertificate.Builder status(LoadBalancerTlsCertificateStatus status)

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

      Parameters:
      status - The validation status of the SSL/TLS certificate. Valid values are below.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • domainName

      LoadBalancerTlsCertificate.Builder domainName(String domainName)

      The domain name for your SSL/TLS certificate.

      Parameters:
      domainName - The domain name for your SSL/TLS certificate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainValidationRecords

      LoadBalancerTlsCertificate.Builder domainValidationRecords(Collection<LoadBalancerTlsCertificateDomainValidationRecord> domainValidationRecords)

      An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.

      Parameters:
      domainValidationRecords - An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainValidationRecords

      LoadBalancerTlsCertificate.Builder domainValidationRecords(LoadBalancerTlsCertificateDomainValidationRecord... domainValidationRecords)

      An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.

      Parameters:
      domainValidationRecords - An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainValidationRecords

      LoadBalancerTlsCertificate.Builder domainValidationRecords(Consumer<LoadBalancerTlsCertificateDomainValidationRecord.Builder>... domainValidationRecords)

      An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.

      This is a convenience method that creates an instance of the LoadBalancerTlsCertificateDomainValidationRecord.Builder avoiding the need to create one manually via LoadBalancerTlsCertificateDomainValidationRecord.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to domainValidationRecords(List<LoadBalancerTlsCertificateDomainValidationRecord>).

      Parameters:
      domainValidationRecords - a consumer that will call methods on LoadBalancerTlsCertificateDomainValidationRecord.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failureReason

      LoadBalancerTlsCertificate.Builder failureReason(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failureReason

      LoadBalancerTlsCertificate.Builder failureReason(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • issuedAt

      LoadBalancerTlsCertificate.Builder issuedAt(Instant issuedAt)

      The time when the SSL/TLS certificate was issued.

      Parameters:
      issuedAt - The time when the SSL/TLS certificate was issued.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • issuer

      LoadBalancerTlsCertificate.Builder issuer(String issuer)

      The issuer of the certificate.

      Parameters:
      issuer - The issuer of the certificate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keyAlgorithm

      LoadBalancerTlsCertificate.Builder keyAlgorithm(String keyAlgorithm)

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

      Parameters:
      keyAlgorithm - The algorithm used to generate the key pair (the public and private key).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notAfter

      LoadBalancerTlsCertificate.Builder notAfter(Instant notAfter)

      The timestamp when the SSL/TLS certificate expires.

      Parameters:
      notAfter - The timestamp when the SSL/TLS certificate expires.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notBefore

      LoadBalancerTlsCertificate.Builder notBefore(Instant notBefore)

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

      Parameters:
      notBefore - The timestamp when the SSL/TLS certificate is first valid.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • renewalSummary

      LoadBalancerTlsCertificate.Builder renewalSummary(LoadBalancerTlsCertificateRenewalSummary renewalSummary)

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

      Parameters:
      renewalSummary - An object that describes the status of the certificate renewal managed by Lightsail.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • renewalSummary

      default LoadBalancerTlsCertificate.Builder renewalSummary(Consumer<LoadBalancerTlsCertificateRenewalSummary.Builder> renewalSummary)

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

      This is a convenience method that creates an instance of the LoadBalancerTlsCertificateRenewalSummary.Builder avoiding the need to create one manually via LoadBalancerTlsCertificateRenewalSummary.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to renewalSummary(LoadBalancerTlsCertificateRenewalSummary).

      Parameters:
      renewalSummary - a consumer that will call methods on LoadBalancerTlsCertificateRenewalSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • revocationReason

      LoadBalancerTlsCertificate.Builder revocationReason(String revocationReason)

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

      Parameters:
      revocationReason - The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • revocationReason

      LoadBalancerTlsCertificate.Builder revocationReason(LoadBalancerTlsCertificateRevocationReason revocationReason)

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

      Parameters:
      revocationReason - The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • revokedAt

      LoadBalancerTlsCertificate.Builder revokedAt(Instant revokedAt)

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

      Parameters:
      revokedAt - The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serial

      LoadBalancerTlsCertificate.Builder serial(String serial)

      The serial number of the certificate.

      Parameters:
      serial - The serial number of the certificate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • signatureAlgorithm

      LoadBalancerTlsCertificate.Builder signatureAlgorithm(String signatureAlgorithm)

      The algorithm that was used to sign the certificate.

      Parameters:
      signatureAlgorithm - The algorithm that was used to sign the certificate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subject

      LoadBalancerTlsCertificate.Builder subject(String subject)

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

      Parameters:
      subject - The name of the entity that is associated with the public key contained in the certificate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subjectAlternativeNames

      LoadBalancerTlsCertificate.Builder subjectAlternativeNames(Collection<String> subjectAlternativeNames)

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

      Parameters:
      subjectAlternativeNames - An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subjectAlternativeNames

      LoadBalancerTlsCertificate.Builder subjectAlternativeNames(String... subjectAlternativeNames)

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

      Parameters:
      subjectAlternativeNames - An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.