Package software.amazon.awssdk.services.acmpca.model

Interface CertificateAuthority.Builder

    • Method Detail

      • arn

        CertificateAuthority.Builder arn​(String arn)

        Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .

        Parameters:
        arn - Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ownerAccount

        CertificateAuthority.Builder ownerAccount​(String ownerAccount)

        The Amazon Web Services account ID that owns the certificate authority.

        Parameters:
        ownerAccount - The Amazon Web Services account ID that owns the certificate authority.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdAt

        CertificateAuthority.Builder createdAt​(Instant createdAt)

        Date and time at which your private CA was created.

        Parameters:
        createdAt - Date and time at which your private CA was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastStateChangeAt

        CertificateAuthority.Builder lastStateChangeAt​(Instant lastStateChangeAt)

        Date and time at which your private CA was last updated.

        Parameters:
        lastStateChangeAt - Date and time at which your private CA was last updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serial

        CertificateAuthority.Builder serial​(String serial)

        Serial number of your private CA.

        Parameters:
        serial - Serial number of your private CA.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • notBefore

        CertificateAuthority.Builder notBefore​(Instant notBefore)

        Date and time before which your private CA certificate is not valid.

        Parameters:
        notBefore - Date and time before which your private CA certificate is not valid.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • notAfter

        CertificateAuthority.Builder notAfter​(Instant notAfter)

        Date and time after which your private CA certificate is not valid.

        Parameters:
        notAfter - Date and time after which your private CA certificate is not valid.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failureReason

        CertificateAuthority.Builder failureReason​(String failureReason)

        Reason the request to create your private CA failed.

        Parameters:
        failureReason - Reason the request to create your private CA failed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        FailureReason, FailureReason

      • failureReason

        CertificateAuthority.Builder failureReason​(FailureReason failureReason)

        Reason the request to create your private CA failed.

        Parameters:
        failureReason - Reason the request to create your private CA failed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        FailureReason, FailureReason

      • certificateAuthorityConfiguration

        CertificateAuthority.Builder certificateAuthorityConfiguration​(CertificateAuthorityConfiguration certificateAuthorityConfiguration)

        Your private CA configuration.

        Parameters:
        certificateAuthorityConfiguration - Your private CA configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • revocationConfiguration

        CertificateAuthority.Builder revocationConfiguration​(RevocationConfiguration revocationConfiguration)

        Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA.

        Parameters:
        revocationConfiguration - Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • restorableUntil

        CertificateAuthority.Builder restorableUntil​(Instant restorableUntil)

        The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.

        Parameters:
        restorableUntil - The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyStorageSecurityStandard

        CertificateAuthority.Builder keyStorageSecurityStandard​(String keyStorageSecurityStandard)

        Defines a cryptographic key management compliance standard used for handling CA keys.

        Default: FIPS_140_2_LEVEL_3_OR_HIGHER

        Note: Amazon Web Services Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."

        Parameters:
        keyStorageSecurityStandard - Defines a cryptographic key management compliance standard used for handling CA keys.

        Default: FIPS_140_2_LEVEL_3_OR_HIGHER

        Note: Amazon Web Services Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."

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

      • keyStorageSecurityStandard

        CertificateAuthority.Builder keyStorageSecurityStandard​(KeyStorageSecurityStandard keyStorageSecurityStandard)

        Defines a cryptographic key management compliance standard used for handling CA keys.

        Default: FIPS_140_2_LEVEL_3_OR_HIGHER

        Note: Amazon Web Services Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."

        Parameters:
        keyStorageSecurityStandard - Defines a cryptographic key management compliance standard used for handling CA keys.

        Default: FIPS_140_2_LEVEL_3_OR_HIGHER

        Note: Amazon Web Services Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."

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

      • usageMode

        CertificateAuthority.Builder usageMode​(String usageMode)

        Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.

        The default value is GENERAL_PURPOSE.

        Parameters:
        usageMode - Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.

        The default value is GENERAL_PURPOSE.

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

      • usageMode

        CertificateAuthority.Builder usageMode​(CertificateAuthorityUsageMode usageMode)

        Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.

        The default value is GENERAL_PURPOSE.

        Parameters:
        usageMode - Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.

        The default value is GENERAL_PURPOSE.

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