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

Interface Certificate.Builder

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

  • Method Details

    • arn

      Certificate.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the certificate.

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

    • name

      Certificate.Builder name(String name)

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

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

    • domainName

      Certificate.Builder domainName(String domainName)

      The domain name of the certificate.

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

    • status

      Certificate.Builder status(String status)

      The validation status of the certificate.

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

    • status

      Certificate.Builder status(CertificateStatus status)

      The validation status of the certificate.

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

    • serialNumber

      Certificate.Builder serialNumber(String serialNumber)

      The serial number of the certificate.

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

    • subjectAlternativeNames

      Certificate.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) of the certificate.

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

    • subjectAlternativeNames

      Certificate.Builder subjectAlternativeNames(String... subjectAlternativeNames)

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

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

    • domainValidationRecords

      Certificate.Builder domainValidationRecords(Collection<DomainValidationRecord> domainValidationRecords)

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

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

    • domainValidationRecords

      Certificate.Builder domainValidationRecords(DomainValidationRecord... domainValidationRecords)

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

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

    • domainValidationRecords

      Certificate.Builder domainValidationRecords(Consumer<DomainValidationRecord.Builder>... domainValidationRecords)

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

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

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

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

    • requestFailureReason

      Certificate.Builder requestFailureReason(String requestFailureReason)

      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 Amazon Web Services Support Center to contact Amazon Web Services 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 Amazon Web Services 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:
      requestFailureReason - 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 Amazon Web Services Support Center to contact Amazon Web Services 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 Amazon Web Services 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.

    • inUseResourceCount

      Certificate.Builder inUseResourceCount(Integer inUseResourceCount)

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

      Parameters:
      inUseResourceCount - The number of Lightsail resources that the certificate is attached to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keyAlgorithm

      Certificate.Builder keyAlgorithm(String keyAlgorithm)

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

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

    • createdAt

      Certificate.Builder createdAt(Instant createdAt)

      The timestamp when the certificate was created.

      Parameters:
      createdAt - The timestamp when the certificate was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • issuedAt

      Certificate.Builder issuedAt(Instant issuedAt)

      The timestamp when the certificate was issued.

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

    • issuerCA

      Certificate.Builder issuerCA(String issuerCA)

      The certificate authority that issued the certificate.

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

    • notBefore

      Certificate.Builder notBefore(Instant notBefore)

      The timestamp when the certificate is first valid.

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

    • notAfter

      Certificate.Builder notAfter(Instant notAfter)

      The timestamp when the certificate expires.

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

    • eligibleToRenew

      Certificate.Builder eligibleToRenew(String eligibleToRenew)

      The renewal eligibility of the certificate.

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

    • renewalSummary

      Certificate.Builder renewalSummary(RenewalSummary 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 Certificate.Builder renewalSummary(Consumer<RenewalSummary.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 RenewalSummary.Builder avoiding the need to create one manually via RenewalSummary.builder().

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

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

    • revokedAt

      Certificate.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.

    • revocationReason

      Certificate.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.

    • tags

      Certificate.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

      Certificate.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

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

    • supportCode

      Certificate.Builder supportCode(String supportCode)

      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.

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