Package software.amazon.awssdk.services.acm.model

Interface CertificateDetail.Builder

    • Method Detail

      • certificateArn

        CertificateDetail.Builder certificateArn​(String certificateArn)

        The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

        Parameters:
        certificateArn - The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domainName

        CertificateDetail.Builder domainName​(String domainName)

        The fully qualified domain name for the certificate, such as www.example.com or example.com.

        Parameters:
        domainName - The fully qualified domain name for the certificate, such as www.example.com or example.com.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subjectAlternativeNames

        CertificateDetail.Builder subjectAlternativeNames​(Collection<String> subjectAlternativeNames)

        One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

        Parameters:
        subjectAlternativeNames - One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subjectAlternativeNames

        CertificateDetail.Builder subjectAlternativeNames​(String... subjectAlternativeNames)

        One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

        Parameters:
        subjectAlternativeNames - One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domainValidationOptions

        CertificateDetail.Builder domainValidationOptions​(Collection<DomainValidation> domainValidationOptions)

        Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

        Parameters:
        domainValidationOptions - Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domainValidationOptions

        CertificateDetail.Builder domainValidationOptions​(DomainValidation... domainValidationOptions)

        Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

        Parameters:
        domainValidationOptions - Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domainValidationOptions

        CertificateDetail.Builder domainValidationOptions​(Consumer<DomainValidation.Builder>... domainValidationOptions)

        Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #domainValidationOptions(List).

        Parameters:
        domainValidationOptions - a consumer that will call methods on DomainValidation.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #domainValidationOptions(java.util.Collection)

      • serial

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

      • subject

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

      • issuer

        CertificateDetail.Builder issuer​(String issuer)

        The name of the certificate authority that issued and signed the certificate.

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

      • createdAt

        CertificateDetail.Builder createdAt​(Instant createdAt)

        The time at which the certificate was requested.

        Parameters:
        createdAt - The time at which the certificate was requested.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • issuedAt

        CertificateDetail.Builder issuedAt​(Instant issuedAt)

        The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.

        Parameters:
        issuedAt - The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • importedAt

        CertificateDetail.Builder importedAt​(Instant importedAt)

        The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.

        Parameters:
        importedAt - The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        CertificateDetail.Builder status​(String status)

        The status of the certificate.

        A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

        Parameters:
        status - The status of the certificate.

        A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

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

      • status

        CertificateDetail.Builder status​(CertificateStatus status)

        The status of the certificate.

        A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

        Parameters:
        status - The status of the certificate.

        A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

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

      • revokedAt

        CertificateDetail.Builder revokedAt​(Instant revokedAt)

        The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.

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

      • revocationReason

        CertificateDetail.Builder revocationReason​(String revocationReason)

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

        Parameters:
        revocationReason - The reason the certificate was revoked. This value exists 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, RevocationReason

      • revocationReason

        CertificateDetail.Builder revocationReason​(RevocationReason revocationReason)

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

        Parameters:
        revocationReason - The reason the certificate was revoked. This value exists 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, RevocationReason

      • notBefore

        CertificateDetail.Builder notBefore​(Instant notBefore)

        The time before which the certificate is not valid.

        Parameters:
        notBefore - The time before which the certificate is not valid.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • notAfter

        CertificateDetail.Builder notAfter​(Instant notAfter)

        The time after which the certificate is not valid.

        Parameters:
        notAfter - The time after which the certificate is not valid.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyAlgorithm

        CertificateDetail.Builder keyAlgorithm​(String keyAlgorithm)

        The algorithm that was used to generate the public-private key pair.

        Parameters:
        keyAlgorithm - The algorithm that was used to generate the public-private key pair.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KeyAlgorithm, KeyAlgorithm

      • keyAlgorithm

        CertificateDetail.Builder keyAlgorithm​(KeyAlgorithm keyAlgorithm)

        The algorithm that was used to generate the public-private key pair.

        Parameters:
        keyAlgorithm - The algorithm that was used to generate the public-private key pair.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KeyAlgorithm, KeyAlgorithm

      • signatureAlgorithm

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

      • inUseBy

        CertificateDetail.Builder inUseBy​(Collection<String> inUseBy)

        A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.

        Parameters:
        inUseBy - A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inUseBy

        CertificateDetail.Builder inUseBy​(String... inUseBy)

        A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.

        Parameters:
        inUseBy - A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failureReason

        CertificateDetail.Builder failureReason​(String failureReason)

        The reason the certificate request failed. This value exists only when the certificate status is FAILED. For more information, see Certificate Request Failed in the Certificate Manager User Guide.

        Parameters:
        failureReason - The reason the certificate request failed. This value exists only when the certificate status is FAILED. For more information, see Certificate Request Failed in the Certificate Manager User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        FailureReason, FailureReason

      • failureReason

        CertificateDetail.Builder failureReason​(FailureReason failureReason)

        The reason the certificate request failed. This value exists only when the certificate status is FAILED. For more information, see Certificate Request Failed in the Certificate Manager User Guide.

        Parameters:
        failureReason - The reason the certificate request failed. This value exists only when the certificate status is FAILED. For more information, see Certificate Request Failed in the Certificate Manager User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        FailureReason, FailureReason

      • type

        CertificateDetail.Builder type​(String type)

        The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide.

        Parameters:
        type - The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CertificateType, CertificateType

      • type

        CertificateDetail.Builder type​(CertificateType type)

        The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide.

        Parameters:
        type - The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CertificateType, CertificateType

      • renewalSummary

        CertificateDetail.Builder renewalSummary​(RenewalSummary renewalSummary)

        Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.

        Parameters:
        renewalSummary - Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyUsages

        CertificateDetail.Builder keyUsages​(Collection<KeyUsage> keyUsages)

        A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

        Parameters:
        keyUsages - A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyUsages

        CertificateDetail.Builder keyUsages​(KeyUsage... keyUsages)

        A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

        Parameters:
        keyUsages - A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyUsages

        CertificateDetail.Builder keyUsages​(Consumer<KeyUsage.Builder>... keyUsages)

        A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #keyUsages(List).

        Parameters:
        keyUsages - a consumer that will call methods on KeyUsage.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #keyUsages(java.util.Collection)

      • extendedKeyUsages

        CertificateDetail.Builder extendedKeyUsages​(Collection<ExtendedKeyUsage> extendedKeyUsages)

        Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

        Parameters:
        extendedKeyUsages - Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • extendedKeyUsages

        CertificateDetail.Builder extendedKeyUsages​(ExtendedKeyUsage... extendedKeyUsages)

        Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

        Parameters:
        extendedKeyUsages - Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • extendedKeyUsages

        CertificateDetail.Builder extendedKeyUsages​(Consumer<ExtendedKeyUsage.Builder>... extendedKeyUsages)

        Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #extendedKeyUsages(List).

        Parameters:
        extendedKeyUsages - a consumer that will call methods on ExtendedKeyUsage.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #extendedKeyUsages(java.util.Collection)

      • certificateAuthorityArn

        CertificateDetail.Builder certificateAuthorityArn​(String certificateAuthorityArn)

        The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the certificate. This has the following format:

        arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

        Parameters:
        certificateAuthorityArn - The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the certificate. This has the following format:

        arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

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

      • renewalEligibility

        CertificateDetail.Builder renewalEligibility​(String renewalEligibility)

        Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

        Parameters:
        renewalEligibility - Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RenewalEligibility, RenewalEligibility

      • renewalEligibility

        CertificateDetail.Builder renewalEligibility​(RenewalEligibility renewalEligibility)

        Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

        Parameters:
        renewalEligibility - Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RenewalEligibility, RenewalEligibility

      • options

        CertificateDetail.Builder options​(CertificateOptions options)

        Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure.

        Parameters:
        options - Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.