com.amazonaws.services.kms.model

Class UpdateCustomKeyStoreRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.UpdateCustomKeyStoreRequest

All Implemented Interfaces:

Serializable, Cloneable

public class UpdateCustomKeyStoreRequest
extends AmazonWebServiceRequest
implements Serializable

Changes the properties of a custom key store. Use the CustomKeyStoreId parameter to identify the custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store.

You can only update a custom key store that is disconnected. To disconnect the custom key store, use DisconnectCustomKeyStore. To reconnect the custom key store after the update completes, use ConnectCustomKeyStore. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation.

Use the NewCustomKeyStoreName parameter to change the friendly name of the custom key store to the value that you specify.

Use the KeyStorePassword parameter tell AWS KMS the current password of the kmsuser crypto user (CU) in the associated AWS CloudHSM cluster. You can use this parameter to fix connection failures that occur when AWS KMS cannot log into the associated cluster because the kmsuser password has changed. This value does not change the password in the AWS CloudHSM cluster.

Use the CloudHsmClusterId parameter to associate the custom key store with a related AWS CloudHSM cluster, that is, a cluster that shares a backup history with the original cluster. You can use this parameter to repair a custom key store if its AWS CloudHSM cluster becomes corrupted or is deleted, or when you need to create or restore a cluster from a backup.

The cluster ID must identify a AWS CloudHSM cluster with the following requirements.

• The cluster must be active and be in the same AWS account and Region as the custom key store.

• The cluster must have the same cluster certificate as the original cluster. You cannot use this parameter to associate the custom key store with an unrelated cluster. To view the cluster certificate, use the AWS CloudHSM DescribeClusters operation. Clusters that share a backup history have the same cluster certificate.

• The cluster must be configured with subnets in at least two different Availability Zones in the Region. Because AWS CloudHSM is not supported in all Availability Zones, we recommend that the cluster have subnets in all Availability Zones in the Region.

• The cluster must contain at least two active HSMs, each in a different Availability Zone.

If the operation succeeds, it returns a JSON object with no properties.

This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateCustomKeyStoreRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCloudHsmClusterId() Associates the custom key store with a related AWS CloudHSM cluster.
String	getCustomKeyStoreId() Identifies the custom key store that you want to update.
String	getKeyStorePassword() Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store.
String	getNewCustomKeyStoreName() Changes the friendly name of the custom key store to the value that you specify.
int	hashCode()
void	setCloudHsmClusterId(String cloudHsmClusterId) Associates the custom key store with a related AWS CloudHSM cluster.
void	setCustomKeyStoreId(String customKeyStoreId) Identifies the custom key store that you want to update.
void	setKeyStorePassword(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.
void	setNewCustomKeyStoreName(String newCustomKeyStoreName) Changes the friendly name of the custom key store to the value that you specify.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateCustomKeyStoreRequest	withCloudHsmClusterId(String cloudHsmClusterId) Associates the custom key store with a related AWS CloudHSM cluster.
UpdateCustomKeyStoreRequest	withCustomKeyStoreId(String customKeyStoreId) Identifies the custom key store that you want to update.
UpdateCustomKeyStoreRequest	withKeyStorePassword(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	withNewCustomKeyStoreName(String newCustomKeyStoreName) Changes the friendly name of the custom key store to the value that you specify.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateCustomKeyStoreRequest

public UpdateCustomKeyStoreRequest()

Method Detail

getCustomKeyStoreId

public String getCustomKeyStoreId()

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.

Constraints:
Length: 1 - 64

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.

setCustomKeyStoreId

public void setCustomKeyStoreId(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.

Constraints:
Length: 1 - 64

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.

withCustomKeyStoreId

public UpdateCustomKeyStoreRequest withCustomKeyStoreId(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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64

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:

A reference to this updated object so that method calls can be chained together.

getNewCustomKeyStoreName

public String getNewCustomKeyStoreName()

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.

Constraints:
Length: 1 - 256

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.

setNewCustomKeyStoreName

public void setNewCustomKeyStoreName(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.

Constraints:
Length: 1 - 256

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.

withNewCustomKeyStoreName

public UpdateCustomKeyStoreRequest withNewCustomKeyStoreName(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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256

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:

A reference to this updated object so that method calls can be chained together.

getKeyStorePassword

public String getKeyStorePassword()

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.

Constraints:
Length: 1 -

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.

setKeyStorePassword

public void setKeyStorePassword(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.

Constraints:
Length: 1 -

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.

withKeyStorePassword

public UpdateCustomKeyStoreRequest withKeyStorePassword(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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 -

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:

A reference to this updated object so that method calls can be chained together.

getCloudHsmClusterId

public String getCloudHsmClusterId()

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 with the original cluster. You cannot use this parameter to associate a custom key store with a different cluster.

Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.

Constraints:
Length: 19 - 24

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 with the original cluster. You cannot use this parameter to associate a custom key store with a different cluster.

Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.

setCloudHsmClusterId

public void setCloudHsmClusterId(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 with the original cluster. You cannot use this parameter to associate a custom key store with a different cluster.

Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.

Constraints:
Length: 19 - 24

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 with the original cluster. You cannot use this parameter to associate a custom key store with a different cluster.

Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.

withCloudHsmClusterId

public UpdateCustomKeyStoreRequest withCloudHsmClusterId(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 with the original cluster. You cannot use this parameter to associate a custom key store with a different cluster.

Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.

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

Constraints:
Length: 19 - 24

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 with the original cluster. You cannot use this parameter to associate a custom key store with a different cluster.

Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object