software.amazon.awssdk.services.kms.model

Interface CreateCustomKeyStoreRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateCustomKeyStoreRequest.Builder,CreateCustomKeyStoreRequest>, KmsRequest.Builder, SdkBuilder<CreateCustomKeyStoreRequest.Builder,CreateCustomKeyStoreRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateCustomKeyStoreRequest

public static interface CreateCustomKeyStoreRequest.Builder
extends KmsRequest.Builder, SdkPojo, CopyableBuilder<CreateCustomKeyStoreRequest.Builder,CreateCustomKeyStoreRequest>

Method Summary

Modifier and Type	Method and Description
CreateCustomKeyStoreRequest.Builder	cloudHsmClusterId(String cloudHsmClusterId) Identifies the AWS CloudHSM cluster for the custom key store.
CreateCustomKeyStoreRequest.Builder	customKeyStoreName(String customKeyStoreName) Specifies a friendly name for the custom key store.
CreateCustomKeyStoreRequest.Builder	keyStorePassword(String keyStorePassword) Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster.
CreateCustomKeyStoreRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateCustomKeyStoreRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateCustomKeyStoreRequest.Builder	trustAnchorCertificate(String trustAnchorCertificate) Enter the content of the trust anchor certificate for the cluster.

Methods inherited from interface software.amazon.awssdk.services.kms.model.KmsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

customKeyStoreName

CreateCustomKeyStoreRequest.Builder customKeyStoreName(String customKeyStoreName)

Specifies a friendly name for the custom key store. The name must be unique in your AWS account.

Parameters:

customKeyStoreName - Specifies a friendly name for the custom key store. The name must be unique in your AWS account.

Returns:

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

cloudHsmClusterId

CreateCustomKeyStoreRequest.Builder cloudHsmClusterId(String cloudHsmClusterId)

Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

Parameters:

cloudHsmClusterId - Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

Returns:

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

trustAnchorCertificate

CreateCustomKeyStoreRequest.Builder trustAnchorCertificate(String trustAnchorCertificate)

Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.

Parameters:

trustAnchorCertificate - Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.

Returns:

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

keyStorePassword

CreateCustomKeyStoreRequest.Builder keyStorePassword(String keyStorePassword)

Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.

This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.

Parameters:

keyStorePassword - Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.

This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.

Returns:

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

overrideConfiguration

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

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