CustomKeyStoresListEntry (AWS Java SDK for AWS KMS 1.12.60 API)

java.lang.Object
- com.amazonaws.services.kms.model.CustomKeyStoresListEntry

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CustomKeyStoresListEntry
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about each custom key store in the custom key store list.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CustomKeyStoresListEntry()

Constructors
Constructor and Description
`CustomKeyStoresListEntry()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CustomKeyStoresListEntry`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCloudHsmClusterId()` A unique identifier for the CloudHSM cluster that is associated with the custom key store.
`String`	`getConnectionErrorCode()` Describes the connection error.
`String`	`getConnectionState()` Indicates whether the custom key store is connected to its CloudHSM cluster.
`Date`	`getCreationDate()` The date and time when the custom key store was created.
`String`	`getCustomKeyStoreId()` A unique identifier for the custom key store.
`String`	`getCustomKeyStoreName()` The user-specified friendly name for the custom key store.
`String`	`getTrustAnchorCertificate()` The trust anchor certificate of the associated CloudHSM cluster.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setCloudHsmClusterId(String cloudHsmClusterId)` A unique identifier for the CloudHSM cluster that is associated with the custom key store.
`void`	`setConnectionErrorCode(String connectionErrorCode)` Describes the connection error.
`void`	`setConnectionState(String connectionState)` Indicates whether the custom key store is connected to its CloudHSM cluster.
`void`	`setCreationDate(Date creationDate)` The date and time when the custom key store was created.
`void`	`setCustomKeyStoreId(String customKeyStoreId)` A unique identifier for the custom key store.
`void`	`setCustomKeyStoreName(String customKeyStoreName)` The user-specified friendly name for the custom key store.
`void`	`setTrustAnchorCertificate(String trustAnchorCertificate)` The trust anchor certificate of the associated CloudHSM cluster.
`String`	`toString()` Returns a string representation of this object.
`CustomKeyStoresListEntry`	`withCloudHsmClusterId(String cloudHsmClusterId)` A unique identifier for the CloudHSM cluster that is associated with the custom key store.
`CustomKeyStoresListEntry`	`withConnectionErrorCode(ConnectionErrorCodeType connectionErrorCode)` Describes the connection error.
`CustomKeyStoresListEntry`	`withConnectionErrorCode(String connectionErrorCode)` Describes the connection error.
`CustomKeyStoresListEntry`	`withConnectionState(ConnectionStateType connectionState)` Indicates whether the custom key store is connected to its CloudHSM cluster.
`CustomKeyStoresListEntry`	`withConnectionState(String connectionState)` Indicates whether the custom key store is connected to its CloudHSM cluster.
`CustomKeyStoresListEntry`	`withCreationDate(Date creationDate)` The date and time when the custom key store was created.
`CustomKeyStoresListEntry`	`withCustomKeyStoreId(String customKeyStoreId)` A unique identifier for the custom key store.
`CustomKeyStoresListEntry`	`withCustomKeyStoreName(String customKeyStoreName)` The user-specified friendly name for the custom key store.
`CustomKeyStoresListEntry`	`withTrustAnchorCertificate(String trustAnchorCertificate)` The trust anchor certificate of the associated CloudHSM cluster.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CustomKeyStoresListEntry
```
public CustomKeyStoresListEntry()
```
- Method Detail
  - setCustomKeyStoreId
```
public void setCustomKeyStoreId(String customKeyStoreId)
```
    A unique identifier for the custom key store.
    
    Parameters:
    
    customKeyStoreId - A unique identifier for the custom key store.
  - getCustomKeyStoreId
```
public String getCustomKeyStoreId()
```
    A unique identifier for the custom key store.
    
    Returns:
    
    A unique identifier for the custom key store.
  - withCustomKeyStoreId
```
public CustomKeyStoresListEntry withCustomKeyStoreId(String customKeyStoreId)
```
    A unique identifier for the custom key store.
    
    Parameters:
    
    customKeyStoreId - A unique identifier for the custom key store.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomKeyStoreName
```
public void setCustomKeyStoreName(String customKeyStoreName)
```
    The user-specified friendly name for the custom key store.
    
    Parameters:
    
    customKeyStoreName - The user-specified friendly name for the custom key store.
  - getCustomKeyStoreName
```
public String getCustomKeyStoreName()
```
    The user-specified friendly name for the custom key store.
    
    Returns:
    
    The user-specified friendly name for the custom key store.
  - withCustomKeyStoreName
```
public CustomKeyStoresListEntry withCustomKeyStoreName(String customKeyStoreName)
```
    The user-specified friendly name for the custom key store.
    
    Parameters:
    
    customKeyStoreName - The user-specified friendly name for the custom key store.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCloudHsmClusterId
```
public void setCloudHsmClusterId(String cloudHsmClusterId)
```
    A unique identifier for the CloudHSM cluster that is associated with the custom key store.
    
    Parameters:
    
    cloudHsmClusterId - A unique identifier for the CloudHSM cluster that is associated with the custom key store.
  - getCloudHsmClusterId
```
public String getCloudHsmClusterId()
```
    A unique identifier for the CloudHSM cluster that is associated with the custom key store.
    
    Returns:
    
    A unique identifier for the CloudHSM cluster that is associated with the custom key store.
  - withCloudHsmClusterId
```
public CustomKeyStoresListEntry withCloudHsmClusterId(String cloudHsmClusterId)
```
    A unique identifier for the CloudHSM cluster that is associated with the custom key store.
    
    Parameters:
    
    cloudHsmClusterId - A unique identifier for the CloudHSM cluster that is associated with the custom key store.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrustAnchorCertificate
```
public void setTrustAnchorCertificate(String trustAnchorCertificate)
```
    The trust anchor certificate of the associated CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
    
    Parameters:
    
    trustAnchorCertificate - The trust anchor certificate of the associated CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
  - getTrustAnchorCertificate
```
public String getTrustAnchorCertificate()
```
    The trust anchor certificate of the associated CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
    
    Returns:
    
    The trust anchor certificate of the associated CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
  - withTrustAnchorCertificate
```
public CustomKeyStoresListEntry withTrustAnchorCertificate(String trustAnchorCertificate)
```
    The trust anchor certificate of the associated CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
    
    Parameters:
    
    trustAnchorCertificate - The trust anchor certificate of the associated CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConnectionState
```
public void setConnectionState(String connectionState)
```
    Indicates whether the custom key store is connected to its CloudHSM cluster.
    
    You can create and use KMS keys in your custom key stores only when its connection state is CONNECTED.
    
    The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains at least one active HSM.
    
    A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the Key Management Service Developer Guide.
    
    Parameters:
    
    connectionState - Indicates whether the custom key store is connected to its CloudHSM cluster.
    
    You can create and use KMS keys in your custom key stores only when its connection state is CONNECTED.
    
    The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains at least one active HSM.
    
    A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the Key Management Service Developer Guide.
    
    See Also:
    
    ConnectionStateType
  - getConnectionState
```
public String getConnectionState()
```
    Indicates whether the custom key store is connected to its CloudHSM cluster.
    
    You can create and use KMS keys in your custom key stores only when its connection state is CONNECTED.
    
    The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains at least one active HSM.
    
    A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the Key Management Service Developer Guide.
    
    Returns:
    
    Indicates whether the custom key store is connected to its CloudHSM cluster.
    
    You can create and use KMS keys in your custom key stores only when its connection state is CONNECTED.
    
    The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains at least one active HSM.
    
    A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the Key Management Service Developer Guide.
    
    See Also:
    
    ConnectionStateType
  - withConnectionState
```
public CustomKeyStoresListEntry withConnectionState(String connectionState)
```
    Indicates whether the custom key store is connected to its CloudHSM cluster.
    
    You can create and use KMS keys in your custom key stores only when its connection state is CONNECTED.
    
    The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains at least one active HSM.
    
    A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the Key Management Service Developer Guide.
    
    Parameters:
    
    connectionState - Indicates whether the custom key store is connected to its CloudHSM cluster.
    
    You can create and use KMS keys in your custom key stores only when its connection state is CONNECTED.
    
    The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains at least one active HSM.
    
    A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the Key Management Service Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConnectionStateType
  - withConnectionState
```
public CustomKeyStoresListEntry withConnectionState(ConnectionStateType connectionState)
```
    Indicates whether the custom key store is connected to its CloudHSM cluster.
    
    You can create and use KMS keys in your custom key stores only when its connection state is CONNECTED.
    
    The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains at least one active HSM.
    
    A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the Key Management Service Developer Guide.
    
    Parameters:
    
    connectionState - Indicates whether the custom key store is connected to its CloudHSM cluster.
    
    You can create and use KMS keys in your custom key stores only when its connection state is CONNECTED.
    
    The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains at least one active HSM.
    
    A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the Key Management Service Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConnectionStateType
  - setConnectionErrorCode
```
public void setConnectionErrorCode(String connectionErrorCode)
```
    Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in Key Management Service Developer Guide.
    
    Valid values are:
    - CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
    - INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.
    - INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
    - INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
    - NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
    - SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.
    - USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
    - USER_LOGGED_IN - The kmsuser CU account is logged into the the associated CloudHSM cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the Key Management Service Developer Guide.
    - USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
    Parameters:
    connectionErrorCode - Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in Key Management Service Developer Guide.
    
    Valid values are:
    
    CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
    
    INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.
    
    INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
    
    INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
    
    NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
    
    SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.
    
    USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
    
    USER_LOGGED_IN - The kmsuser CU account is logged into the the associated CloudHSM cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the Key Management Service Developer Guide.
    
    USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
    See Also:
    
    ConnectionErrorCodeType
  - getConnectionErrorCode
```
public String getConnectionErrorCode()
```
    Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in Key Management Service Developer Guide.
    
    Valid values are:
    - CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
    - INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.
    - INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
    - INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
    - NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
    - SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.
    - USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
    - USER_LOGGED_IN - The kmsuser CU account is logged into the the associated CloudHSM cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the Key Management Service Developer Guide.
    - USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
    Returns:
    Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in Key Management Service Developer Guide.
    
    Valid values are:
    
    CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
    
    INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.
    
    INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
    
    INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
    
    NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
    
    SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.
    
    USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
    
    USER_LOGGED_IN - The kmsuser CU account is logged into the the associated CloudHSM cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the Key Management Service Developer Guide.
    
    USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
    See Also:
    
    ConnectionErrorCodeType
  - withConnectionErrorCode
```
public CustomKeyStoresListEntry withConnectionErrorCode(String connectionErrorCode)
```
    Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in Key Management Service Developer Guide.
    
    Valid values are:
    - CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
    - INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.
    - INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
    - INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
    - NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
    - SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.
    - USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
    - USER_LOGGED_IN - The kmsuser CU account is logged into the the associated CloudHSM cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the Key Management Service Developer Guide.
    - USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
    Parameters:
    connectionErrorCode - Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in Key Management Service Developer Guide.
    
    Valid values are:
    
    CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
    
    INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.
    
    INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
    
    INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
    
    NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
    
    SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.
    
    USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
    
    USER_LOGGED_IN - The kmsuser CU account is logged into the the associated CloudHSM cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the Key Management Service Developer Guide.
    
    USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConnectionErrorCodeType
  - withConnectionErrorCode
```
public CustomKeyStoresListEntry withConnectionErrorCode(ConnectionErrorCodeType connectionErrorCode)
```
    Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in Key Management Service Developer Guide.
    
    Valid values are:
    - CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
    - INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.
    - INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
    - INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
    - NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
    - SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.
    - USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
    - USER_LOGGED_IN - The kmsuser CU account is logged into the the associated CloudHSM cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the Key Management Service Developer Guide.
    - USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
    Parameters:
    connectionErrorCode - Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in Key Management Service Developer Guide.
    
    Valid values are:
    
    CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
    
    INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.
    
    INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
    
    INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
    
    NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
    
    SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.
    
    USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
    
    USER_LOGGED_IN - The kmsuser CU account is logged into the the associated CloudHSM cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the Key Management Service Developer Guide.
    
    USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConnectionErrorCodeType
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The date and time when the custom key store was created.
    
    Parameters:
    
    creationDate - The date and time when the custom key store was created.
  - getCreationDate
```
public Date getCreationDate()
```
    The date and time when the custom key store was created.
    
    Returns:
    
    The date and time when the custom key store was created.
  - withCreationDate
```
public CustomKeyStoresListEntry withCreationDate(Date creationDate)
```
    The date and time when the custom key store was created.
    
    Parameters:
    
    creationDate - The date and time when the custom key store was created.
    
    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 CustomKeyStoresListEntry clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class CustomKeyStoresListEntry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CustomKeyStoresListEntry

Method Detail

setCustomKeyStoreId

getCustomKeyStoreId

withCustomKeyStoreId

setCustomKeyStoreName

getCustomKeyStoreName

withCustomKeyStoreName

setCloudHsmClusterId

getCloudHsmClusterId

withCloudHsmClusterId

setTrustAnchorCertificate

getTrustAnchorCertificate

withTrustAnchorCertificate

setConnectionState

getConnectionState

withConnectionState

withConnectionState

setConnectionErrorCode

getConnectionErrorCode

withConnectionErrorCode

withConnectionErrorCode

setCreationDate

getCreationDate

withCreationDate

toString

equals

hashCode

clone

marshall