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

Interface CertificateSummary.Builder

    • Method Detail

      • certificateArn

        CertificateSummary.Builder certificateArn​(String certificateArn)

        Amazon Resource Name (ARN) of the certificate. This is of the form:

        arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

        For more information about ARNs, see Amazon Resource Names (ARNs).

        Parameters:
        certificateArn - Amazon Resource Name (ARN) of the certificate. This is of the form:

        arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

        For more information about ARNs, see Amazon Resource Names (ARNs).

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

      • domainName

        CertificateSummary.Builder domainName​(String domainName)

        Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.

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

      • subjectAlternativeNameSummaries

        CertificateSummary.Builder subjectAlternativeNameSummaries​(Collection<String> subjectAlternativeNameSummaries)

        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.

        When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

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

        When called by ListCertificates , this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

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

      • subjectAlternativeNameSummaries

        CertificateSummary.Builder subjectAlternativeNameSummaries​(String... subjectAlternativeNameSummaries)

        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.

        When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

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

        When called by ListCertificates , this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

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

      • hasAdditionalSubjectAlternativeNames

        CertificateSummary.Builder hasAdditionalSubjectAlternativeNames​(Boolean hasAdditionalSubjectAlternativeNames)

        When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

        Parameters:
        hasAdditionalSubjectAlternativeNames - When called by ListCertificates , indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

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

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

      • type

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

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

      • keyAlgorithm

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

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

      • keyUsagesWithStrings

        CertificateSummary.Builder keyUsagesWithStrings​(Collection<String> 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.

      • keyUsagesWithStrings

        CertificateSummary.Builder keyUsagesWithStrings​(String... 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

        CertificateSummary.Builder keyUsages​(Collection<KeyUsageName> 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

        CertificateSummary.Builder keyUsages​(KeyUsageName... 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.

      • extendedKeyUsagesWithStrings

        CertificateSummary.Builder extendedKeyUsagesWithStrings​(Collection<String> 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.

      • extendedKeyUsagesWithStrings

        CertificateSummary.Builder extendedKeyUsagesWithStrings​(String... 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

        CertificateSummary.Builder extendedKeyUsages​(Collection<ExtendedKeyUsageName> 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

        CertificateSummary.Builder extendedKeyUsages​(ExtendedKeyUsageName... 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.

      • inUse

        CertificateSummary.Builder inUse​(Boolean inUse)

        Indicates whether the certificate is currently in use by any Amazon Web Services resources.

        Parameters:
        inUse - Indicates whether the certificate is currently in use by any Amazon Web Services resources.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • exported

        CertificateSummary.Builder exported​(Boolean exported)

        Indicates whether the certificate has been exported. This value exists only when the certificate type is PRIVATE.

        Parameters:
        exported - Indicates whether the certificate has been exported. This value exists only when the certificate type is PRIVATE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • renewalEligibility

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

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

      • notBefore

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

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

      • createdAt

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

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

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

      • revokedAt

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