software.amazon.awssdk.services.kms.model

Class UpdateCustomKeyStoreRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kms.model.KmsRequest

software.amazon.awssdk.services.kms.model.UpdateCustomKeyStoreRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateCustomKeyStoreRequest.Builder,UpdateCustomKeyStoreRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateCustomKeyStoreRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateCustomKeyStoreRequest.Builder	builder()
String	cloudHsmClusterId() Associates the custom key store with a related AWS CloudHSM cluster.
String	customKeyStoreId() Identifies the custom key store that you want to update.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
String	newCustomKeyStoreName() Changes the friendly name of the custom key store to the value that you specify.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateCustomKeyStoreRequest.Builder>	serializableBuilderClass()
UpdateCustomKeyStoreRequest.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

customKeyStoreId

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

Returns:

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.

newCustomKeyStoreName

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

Returns:

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.

keyStorePassword

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

Returns:

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.

cloudHsmClusterId

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

Returns:

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.

toBuilder

public UpdateCustomKeyStoreRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateCustomKeyStoreRequest.Builder,UpdateCustomKeyStoreRequest>

Specified by:

toBuilder in class KmsRequest

builder

public static UpdateCustomKeyStoreRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo