com.amazonaws.services.kms.model

Class DisconnectCustomKeyStoreRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.DisconnectCustomKeyStoreRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DisconnectCustomKeyStoreRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Disconnects the custom key store from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time.

While a custom key store is disconnected, all attempts to create customer master keys (CMKs) in the custom key store or to use existing CMKs in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data.

To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the ConnectCustomKeyStore operation.

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.

Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

Required permissions: kms:DisconnectCustomKeyStore (IAM policy)

Related operations:

• ConnectCustomKeyStore

• CreateCustomKeyStore

• DeleteCustomKeyStore

• DescribeCustomKeyStores

• UpdateCustomKeyStore

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DisconnectCustomKeyStoreRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getCustomKeyStoreId() Enter the ID of the custom key store you want to disconnect.
int	hashCode()
void	setCustomKeyStoreId(java.lang.String customKeyStoreId) Enter the ID of the custom key store you want to disconnect.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DisconnectCustomKeyStoreRequest	withCustomKeyStoreId(java.lang.String customKeyStoreId) Enter the ID of the custom key store you want to disconnect.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DisconnectCustomKeyStoreRequest

public DisconnectCustomKeyStoreRequest()

Method Detail

getCustomKeyStoreId

public java.lang.String getCustomKeyStoreId()

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

Constraints:
Length: 1 - 64

Returns:

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

setCustomKeyStoreId

public void setCustomKeyStoreId(java.lang.String customKeyStoreId)

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

Constraints:
Length: 1 - 64

Parameters:

customKeyStoreId -

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

withCustomKeyStoreId

public DisconnectCustomKeyStoreRequest withCustomKeyStoreId(java.lang.String customKeyStoreId)

Enter the ID of the custom key store you want to disconnect. 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 -

Enter the ID of the custom key store you want to disconnect. 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.

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object