com.amazonaws.services.kms.model

Class UpdateCustomKeyStoreRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.UpdateCustomKeyStoreRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateCustomKeyStoreRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateCustomKeyStoreRequest()

Method Summary

Modifier and Type	Method and Description
UpdateCustomKeyStoreRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCloudHsmClusterId() Associates the custom key store with a related 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 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 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 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.
UpdateCustomKeyStoreRequest	withCloudHsmClusterId(String cloudHsmClusterId) Associates the custom key store with a related 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 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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateCustomKeyStoreRequest

public UpdateCustomKeyStoreRequest()

Method Detail

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.

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.

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.

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.

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.

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.

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 Amazon Web Services 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 Amazon Web Services account.

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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services account.

Returns:

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

setKeyStorePassword

public void setKeyStorePassword(String keyStorePassword)

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

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

Parameters:

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

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

getKeyStorePassword

public String getKeyStorePassword()

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

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

Returns:

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

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

withKeyStorePassword

public UpdateCustomKeyStoreRequest withKeyStorePassword(String keyStorePassword)

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

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

Parameters:

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

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

Returns:

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

setCloudHsmClusterId

public void setCloudHsmClusterId(String cloudHsmClusterId)

Associates the custom key store with a related 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 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.

getCloudHsmClusterId

public String getCloudHsmClusterId()

Associates the custom key store with a related 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 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.

withCloudHsmClusterId

public UpdateCustomKeyStoreRequest withCloudHsmClusterId(String cloudHsmClusterId)

Associates the custom key store with a related 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 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.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateCustomKeyStoreRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()