Interface CreateCertificateAuthorityRequest.Builder

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

  • Method Details

    • certificateAuthorityConfiguration

      CreateCertificateAuthorityRequest.Builder certificateAuthorityConfiguration(CertificateAuthorityConfiguration certificateAuthorityConfiguration)

      Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.

      Parameters:
      certificateAuthorityConfiguration - Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • certificateAuthorityConfiguration

      default CreateCertificateAuthorityRequest.Builder certificateAuthorityConfiguration(Consumer<CertificateAuthorityConfiguration.Builder> certificateAuthorityConfiguration)

      Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.

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

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

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

    • revocationConfiguration

      CreateCertificateAuthorityRequest.Builder revocationConfiguration(RevocationConfiguration revocationConfiguration)

      Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. By default, both certificate validation mechanisms are disabled.

      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://".

      For more information, see the OcspConfiguration and CrlConfiguration types.

      Parameters:
      revocationConfiguration - Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. By default, both certificate validation mechanisms are disabled.

      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://".

      For more information, see the OcspConfiguration and CrlConfiguration types.

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

    • revocationConfiguration

      default CreateCertificateAuthorityRequest.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. By default, both certificate validation mechanisms are disabled.

      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://".

      For more information, see the OcspConfiguration and CrlConfiguration types.

      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:

    • certificateAuthorityType

      CreateCertificateAuthorityRequest.Builder certificateAuthorityType(String certificateAuthorityType)

      The type of the certificate authority.

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

    • certificateAuthorityType

      CreateCertificateAuthorityRequest.Builder certificateAuthorityType(CertificateAuthorityType certificateAuthorityType)

      The type of the certificate authority.

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

    • idempotencyToken

      CreateCertificateAuthorityRequest.Builder idempotencyToken(String idempotencyToken)

      Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action. Idempotency tokens for CreateCertificateAuthority time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificate authorities.

      Parameters:
      idempotencyToken - Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action. Idempotency tokens for CreateCertificateAuthority time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificate authorities.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keyStorageSecurityStandard

      CreateCertificateAuthorityRequest.Builder keyStorageSecurityStandard(String keyStorageSecurityStandard)

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

      Default: FIPS_140_2_LEVEL_3_OR_HIGHER

      Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you must provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for KeyStorageSecurityStandard . Failure to do this results in an InvalidArgsException with the message, "A certificate authority cannot be created in this region with the specified security standard."

      For information about security standard support in various Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.

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

      Default: FIPS_140_2_LEVEL_3_OR_HIGHER

      Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you must provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for KeyStorageSecurityStandard. Failure to do this results in an InvalidArgsException with the message, "A certificate authority cannot be created in this region with the specified security standard."

      For information about security standard support in various Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.

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

    • keyStorageSecurityStandard

      CreateCertificateAuthorityRequest.Builder keyStorageSecurityStandard(KeyStorageSecurityStandard keyStorageSecurityStandard)

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

      Default: FIPS_140_2_LEVEL_3_OR_HIGHER

      Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you must provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for KeyStorageSecurityStandard . Failure to do this results in an InvalidArgsException with the message, "A certificate authority cannot be created in this region with the specified security standard."

      For information about security standard support in various Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.

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

      Default: FIPS_140_2_LEVEL_3_OR_HIGHER

      Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you must provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for KeyStorageSecurityStandard. Failure to do this results in an InvalidArgsException with the message, "A certificate authority cannot be created in this region with the specified security standard."

      For information about security standard support in various Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.

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

    • tags

      CreateCertificateAuthorityRequest.Builder tags(Collection<Tag> tags)

      Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags.

      Parameters:
      tags - Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateCertificateAuthorityRequest.Builder tags(Tag... tags)

      Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags.

      Parameters:
      tags - Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateCertificateAuthorityRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags.

      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:

    • usageMode

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

    • usageMode

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

    • overrideConfiguration

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

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