software.amazon.awssdk.services.kms.model

Interface CustomKeyStoresListEntry.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CustomKeyStoresListEntry.Builder,CustomKeyStoresListEntry>, SdkBuilder<CustomKeyStoresListEntry.Builder,CustomKeyStoresListEntry>, SdkPojo

Enclosing class:

CustomKeyStoresListEntry

public static interface CustomKeyStoresListEntry.Builder
extends SdkPojo, CopyableBuilder<CustomKeyStoresListEntry.Builder,CustomKeyStoresListEntry>

Method Summary

Modifier and Type	Method and Description
CustomKeyStoresListEntry.Builder	cloudHsmClusterId(String cloudHsmClusterId) A unique identifier for the CloudHSM cluster that is associated with the custom key store.
CustomKeyStoresListEntry.Builder	connectionErrorCode(ConnectionErrorCodeType connectionErrorCode) Describes the connection error.
CustomKeyStoresListEntry.Builder	connectionErrorCode(String connectionErrorCode) Describes the connection error.
CustomKeyStoresListEntry.Builder	connectionState(ConnectionStateType connectionState) Indicates whether the custom key store is connected to its CloudHSM cluster.
CustomKeyStoresListEntry.Builder	connectionState(String connectionState) Indicates whether the custom key store is connected to its CloudHSM cluster.
CustomKeyStoresListEntry.Builder	creationDate(Instant creationDate) The date and time when the custom key store was created.
CustomKeyStoresListEntry.Builder	customKeyStoreId(String customKeyStoreId) A unique identifier for the custom key store.
CustomKeyStoresListEntry.Builder	customKeyStoreName(String customKeyStoreName) The user-specified friendly name for the custom key store.
CustomKeyStoresListEntry.Builder	trustAnchorCertificate(String trustAnchorCertificate) The trust anchor certificate of the associated CloudHSM cluster.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

customKeyStoreId

CustomKeyStoresListEntry.Builder customKeyStoreId(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.

customKeyStoreName

CustomKeyStoresListEntry.Builder customKeyStoreName(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.

cloudHsmClusterId

CustomKeyStoresListEntry.Builder cloudHsmClusterId(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.

trustAnchorCertificate

CustomKeyStoresListEntry.Builder trustAnchorCertificate(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.

connectionState

CustomKeyStoresListEntry.Builder connectionState(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, ConnectionStateType

connectionState

CustomKeyStoresListEntry.Builder connectionState(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, ConnectionStateType

connectionErrorCode

CustomKeyStoresListEntry.Builder connectionErrorCode(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, ConnectionErrorCodeType

connectionErrorCode

CustomKeyStoresListEntry.Builder connectionErrorCode(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, ConnectionErrorCodeType

creationDate

CustomKeyStoresListEntry.Builder creationDate(Instant 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.