software.amazon.awssdk.services.kms.model

Interface UpdateCustomKeyStoreRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateCustomKeyStoreRequest

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

Method Summary

Modifier and Type	Method and Description
UpdateCustomKeyStoreRequest.Builder	cloudHsmClusterId(String cloudHsmClusterId) Associates the custom key store with a related AWS CloudHSM cluster.
UpdateCustomKeyStoreRequest.Builder	customKeyStoreId(String customKeyStoreId) Identifies the custom key store that you want to update.
UpdateCustomKeyStoreRequest.Builder	keyStorePassword(String keyStorePassword) Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store.
UpdateCustomKeyStoreRequest.Builder	newCustomKeyStoreName(String newCustomKeyStoreName) Changes the friendly name of the custom key store to the value that you specify.
UpdateCustomKeyStoreRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateCustomKeyStoreRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

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

equalsBySdkFields, 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

customKeyStoreId

UpdateCustomKeyStoreRequest.Builder customKeyStoreId(String customKeyStoreId)

Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Parameters:

customKeyStoreId - Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Returns:

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

newCustomKeyStoreName

UpdateCustomKeyStoreRequest.Builder newCustomKeyStoreName(String newCustomKeyStoreName)

Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the AWS account.

Parameters:

newCustomKeyStoreName - Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the AWS account.

Returns:

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

keyStorePassword

UpdateCustomKeyStoreRequest.Builder keyStorePassword(String keyStorePassword)

Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store.

This parameter tells AWS KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

Parameters:

keyStorePassword - Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store.

This parameter tells AWS KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

Returns:

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

cloudHsmClusterId

UpdateCustomKeyStoreRequest.Builder cloudHsmClusterId(String cloudHsmClusterId)

Associates the custom key store with a related AWS CloudHSM cluster.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

Parameters:

cloudHsmClusterId - Associates the custom key store with a related AWS CloudHSM cluster.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

Returns:

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

overrideConfiguration

UpdateCustomKeyStoreRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateCustomKeyStoreRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder