com.amazonaws.services.kms.model

Class DescribeCustomKeyStoresRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.DescribeCustomKeyStoresRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DescribeCustomKeyStoresRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Gets information about custom key stores in the account and region.

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.

By default, this operation returns information about all custom key stores in the account and region. To get only information about a particular custom key store, use either the CustomKeyStoreName or CustomKeyStoreId parameter (but not both).

To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the ConnectionState element in the response. If an attempt to connect the custom key store failed, the ConnectionState value is FAILED and the ConnectionErrorCode element in the response indicates the cause of the failure. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.

Custom key stores have a DISCONNECTED connection state if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If your custom key store state is CONNECTED but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if any.

For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the AWS Key Management Service Developer Guide.

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

Required permissions: kms:DescribeCustomKeyStores (IAM policy)

Related operations:

• ConnectCustomKeyStore

• CreateCustomKeyStore

• DeleteCustomKeyStore

• DisconnectCustomKeyStore

• UpdateCustomKeyStore

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeCustomKeyStoresRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getCustomKeyStoreId() Gets only information about the specified custom key store.
java.lang.String	getCustomKeyStoreName() Gets only information about the specified custom key store.
java.lang.Integer	getLimit() Use this parameter to specify the maximum number of items to return.
java.lang.String	getMarker() Use this parameter in a subsequent request after you receive a response with truncated results.
int	hashCode()
void	setCustomKeyStoreId(java.lang.String customKeyStoreId) Gets only information about the specified custom key store.
void	setCustomKeyStoreName(java.lang.String customKeyStoreName) Gets only information about the specified custom key store.
void	setLimit(java.lang.Integer limit) Use this parameter to specify the maximum number of items to return.
void	setMarker(java.lang.String marker) Use this parameter in a subsequent request after you receive a response with truncated results.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeCustomKeyStoresRequest	withCustomKeyStoreId(java.lang.String customKeyStoreId) Gets only information about the specified custom key store.
DescribeCustomKeyStoresRequest	withCustomKeyStoreName(java.lang.String customKeyStoreName) Gets only information about the specified custom key store.
DescribeCustomKeyStoresRequest	withLimit(java.lang.Integer limit) Use this parameter to specify the maximum number of items to return.
DescribeCustomKeyStoresRequest	withMarker(java.lang.String marker) Use this parameter in a subsequent request after you receive a response with truncated results.

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

DescribeCustomKeyStoresRequest

public DescribeCustomKeyStoresRequest()

Method Detail

getCustomKeyStoreId

public java.lang.String getCustomKeyStoreId()

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Constraints:
Length: 1 - 64

Returns:

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

setCustomKeyStoreId

public void setCustomKeyStoreId(java.lang.String customKeyStoreId)

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Constraints:
Length: 1 - 64

Parameters:

customKeyStoreId -

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

withCustomKeyStoreId

public DescribeCustomKeyStoresRequest withCustomKeyStoreId(java.lang.String customKeyStoreId)

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

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

Constraints:
Length: 1 - 64

Parameters:

customKeyStoreId -

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Returns:

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

getCustomKeyStoreName

public java.lang.String getCustomKeyStoreName()

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Constraints:
Length: 1 - 256

Returns:

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

setCustomKeyStoreName

public void setCustomKeyStoreName(java.lang.String customKeyStoreName)

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Constraints:
Length: 1 - 256

Parameters:

customKeyStoreName -

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

withCustomKeyStoreName

public DescribeCustomKeyStoresRequest withCustomKeyStoreName(java.lang.String customKeyStoreName)

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

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

Constraints:
Length: 1 - 256

Parameters:

customKeyStoreName -

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Returns:

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

getLimit

public java.lang.Integer getLimit()

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

Constraints:
Range: 1 - 1000

Returns:

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

setLimit

public void setLimit(java.lang.Integer limit)

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

Constraints:
Range: 1 - 1000

Parameters:

limit -

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

withLimit

public DescribeCustomKeyStoresRequest withLimit(java.lang.Integer limit)

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

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

Constraints:
Range: 1 - 1000

Parameters:

limit -

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

Returns:

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

getMarker

public java.lang.String getMarker()

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

Returns:

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

setMarker

public void setMarker(java.lang.String marker)

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

Parameters:

marker -

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

withMarker

public DescribeCustomKeyStoresRequest withMarker(java.lang.String marker)

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

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

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

Parameters:

marker -

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

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