software.amazon.awssdk.services.acmpca.model

Class CreateCertificateAuthorityRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.acmpca.model.AcmPcaRequest

software.amazon.awssdk.services.acmpca.model.CreateCertificateAuthorityRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateCertificateAuthorityRequest.Builder,CreateCertificateAuthorityRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateCertificateAuthorityRequest
extends AcmPcaRequest
implements ToCopyableBuilder<CreateCertificateAuthorityRequest.Builder,CreateCertificateAuthorityRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateCertificateAuthorityRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateCertificateAuthorityRequest.Builder	builder()
CertificateAuthorityConfiguration	certificateAuthorityConfiguration() Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.
CertificateAuthorityType	certificateAuthorityType() The type of the certificate authority.
String	certificateAuthorityTypeAsString() The type of the certificate authority.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	idempotencyToken() Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action.
KeyStorageSecurityStandard	keyStorageSecurityStandard() Specifies a cryptographic key management compliance standard used for handling CA keys.
String	keyStorageSecurityStandardAsString() Specifies a cryptographic key management compliance standard used for handling CA keys.
RevocationConfiguration	revocationConfiguration() Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM Private CA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the CRL Distribution Points extension of your CA certificate.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateCertificateAuthorityRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Key-value pairs that will be attached to the new private CA.
CreateCertificateAuthorityRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

certificateAuthorityConfiguration

public final CertificateAuthorityConfiguration certificateAuthorityConfiguration()

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

Returns:

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

revocationConfiguration

public final RevocationConfiguration revocationConfiguration()

Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM Private CA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the CRL Distribution Points extension of your CA certificate. For more information, see the CrlConfiguration structure.

Returns:

Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM Private CA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the CRL Distribution Points extension of your CA certificate. For more information, see the CrlConfiguration structure.

certificateAuthorityType

public final CertificateAuthorityType certificateAuthorityType()

The type of the certificate authority.

If the service returns an enum value that is not available in the current SDK version, certificateAuthorityType will return CertificateAuthorityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from certificateAuthorityTypeAsString().

Returns:

The type of the certificate authority.

See Also:

CertificateAuthorityType

certificateAuthorityTypeAsString

public final String certificateAuthorityTypeAsString()

The type of the certificate authority.

If the service returns an enum value that is not available in the current SDK version, certificateAuthorityType will return CertificateAuthorityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from certificateAuthorityTypeAsString().

Returns:

The type of the certificate authority.

See Also:

CertificateAuthorityType

idempotencyToken

public final 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, ACM Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificate authorities.

Returns:

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, ACM Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificate authorities.

keyStorageSecurityStandard

public final KeyStorageSecurityStandard keyStorageSecurityStandard()

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

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

Note: FIPS_140_2_LEVEL_3_OR_HIGHER is not supported in Region ap-northeast-3. When creating a CA in the ap-northeast-3, 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."

If the service returns an enum value that is not available in the current SDK version, keyStorageSecurityStandard will return KeyStorageSecurityStandard.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyStorageSecurityStandardAsString().

Returns:

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

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

Note: FIPS_140_2_LEVEL_3_OR_HIGHER is not supported in Region ap-northeast-3. When creating a CA in the ap-northeast-3, 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."

See Also:

KeyStorageSecurityStandard

keyStorageSecurityStandardAsString

public final String keyStorageSecurityStandardAsString()

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

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

Note: FIPS_140_2_LEVEL_3_OR_HIGHER is not supported in Region ap-northeast-3. When creating a CA in the ap-northeast-3, 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."

If the service returns an enum value that is not available in the current SDK version, keyStorageSecurityStandard will return KeyStorageSecurityStandard.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyStorageSecurityStandardAsString().

Returns:

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

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

Note: FIPS_140_2_LEVEL_3_OR_HIGHER is not supported in Region ap-northeast-3. When creating a CA in the ap-northeast-3, 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."

See Also:

KeyStorageSecurityStandard

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

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.

toBuilder

public CreateCertificateAuthorityRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCertificateAuthorityRequest.Builder,CreateCertificateAuthorityRequest>

Specified by:

toBuilder in class AcmPcaRequest

builder

public static CreateCertificateAuthorityRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateCertificateAuthorityRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo