Interface UpdateCertificateAuthorityRequest.Builder

All Superinterfaces:
AcmPcaRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<UpdateCertificateAuthorityRequest.Builder,UpdateCertificateAuthorityRequest>, SdkBuilder<UpdateCertificateAuthorityRequest.Builder,UpdateCertificateAuthorityRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateCertificateAuthorityRequest
public static interface UpdateCertificateAuthorityRequest.Builder extends AcmPcaRequest.Builder, SdkPojo, CopyableBuilder<UpdateCertificateAuthorityRequest.Builder,UpdateCertificateAuthorityRequest>

  • Method Details

    • certificateAuthorityArn

      UpdateCertificateAuthorityRequest.Builder certificateAuthorityArn(String certificateAuthorityArn)

      Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

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

      Parameters:
      certificateAuthorityArn - Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

      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.

    • revocationConfiguration

      UpdateCertificateAuthorityRequest.Builder revocationConfiguration(RevocationConfiguration revocationConfiguration)

      Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. If you don't supply this parameter, existing capibilites remain unchanged. For more information, see the OcspConfiguration and CrlConfiguration types.

      The following requirements apply to revocation configurations.

      • A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.

      • In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.

      • A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.

      • In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".

      If you update the S3BucketName of CrlConfiguration, you can break revocation for existing certificates. In other words, if you call UpdateCertificateAuthority to update the CRL configuration's S3 bucket name, Amazon Web Services Private CA only writes CRLs to the new S3 bucket. Certificates issued prior to this point will have the old S3 bucket name in your CRL Distribution Point (CDP) extension, essentially breaking revocation. If you must update the S3 bucket, you'll need to reissue old certificates to keep the revocation working. Alternatively, you can use a CustomCname in your CRL configuration if you might need to change the S3 bucket name in the future.

      Parameters:
      revocationConfiguration - Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. If you don't supply this parameter, existing capibilites remain unchanged. For more information, see the OcspConfiguration and CrlConfiguration types.

      The following requirements apply to revocation configurations.

      • A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.

      • In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.

      • A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.

      • In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".

      If you update the S3BucketName of CrlConfiguration, you can break revocation for existing certificates. In other words, if you call UpdateCertificateAuthority to update the CRL configuration's S3 bucket name, Amazon Web Services Private CA only writes CRLs to the new S3 bucket. Certificates issued prior to this point will have the old S3 bucket name in your CRL Distribution Point (CDP) extension, essentially breaking revocation. If you must update the S3 bucket, you'll need to reissue old certificates to keep the revocation working. Alternatively, you can use a CustomCname in your CRL configuration if you might need to change the S3 bucket name in the future.

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

    • revocationConfiguration

      default UpdateCertificateAuthorityRequest.Builder revocationConfiguration(Consumer<RevocationConfiguration.Builder> revocationConfiguration)

      Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. If you don't supply this parameter, existing capibilites remain unchanged. For more information, see the OcspConfiguration and CrlConfiguration types.

      The following requirements apply to revocation configurations.

      • A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.

      • In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.

      • A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.

      • In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".

      If you update the S3BucketName of CrlConfiguration, you can break revocation for existing certificates. In other words, if you call UpdateCertificateAuthority to update the CRL configuration's S3 bucket name, Amazon Web Services Private CA only writes CRLs to the new S3 bucket. Certificates issued prior to this point will have the old S3 bucket name in your CRL Distribution Point (CDP) extension, essentially breaking revocation. If you must update the S3 bucket, you'll need to reissue old certificates to keep the revocation working. Alternatively, you can use a CustomCname in your CRL configuration if you might need to change the S3 bucket name in the future.

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

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

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

    • status

      UpdateCertificateAuthorityRequest.Builder status(String status)

      Status of your private CA.

      Parameters:
      status - Status of your private CA.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      UpdateCertificateAuthorityRequest.Builder status(CertificateAuthorityStatus status)

      Status of your private CA.

      Parameters:
      status - Status of your private CA.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateCertificateAuthorityRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateCertificateAuthorityRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.