AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::KMS::Model::CustomKeyStoresListEntry Class Reference

#include <CustomKeyStoresListEntry.h>

Public Member Functions

 CustomKeyStoresListEntry ()
 
 CustomKeyStoresListEntry (Aws::Utils::Json::JsonView jsonValue)
 
CustomKeyStoresListEntryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetCustomKeyStoreId () const
 
bool CustomKeyStoreIdHasBeenSet () const
 
void SetCustomKeyStoreId (const Aws::String &value)
 
void SetCustomKeyStoreId (Aws::String &&value)
 
void SetCustomKeyStoreId (const char *value)
 
CustomKeyStoresListEntryWithCustomKeyStoreId (const Aws::String &value)
 
CustomKeyStoresListEntryWithCustomKeyStoreId (Aws::String &&value)
 
CustomKeyStoresListEntryWithCustomKeyStoreId (const char *value)
 
const Aws::StringGetCustomKeyStoreName () const
 
bool CustomKeyStoreNameHasBeenSet () const
 
void SetCustomKeyStoreName (const Aws::String &value)
 
void SetCustomKeyStoreName (Aws::String &&value)
 
void SetCustomKeyStoreName (const char *value)
 
CustomKeyStoresListEntryWithCustomKeyStoreName (const Aws::String &value)
 
CustomKeyStoresListEntryWithCustomKeyStoreName (Aws::String &&value)
 
CustomKeyStoresListEntryWithCustomKeyStoreName (const char *value)
 
const Aws::StringGetCloudHsmClusterId () const
 
bool CloudHsmClusterIdHasBeenSet () const
 
void SetCloudHsmClusterId (const Aws::String &value)
 
void SetCloudHsmClusterId (Aws::String &&value)
 
void SetCloudHsmClusterId (const char *value)
 
CustomKeyStoresListEntryWithCloudHsmClusterId (const Aws::String &value)
 
CustomKeyStoresListEntryWithCloudHsmClusterId (Aws::String &&value)
 
CustomKeyStoresListEntryWithCloudHsmClusterId (const char *value)
 
const Aws::StringGetTrustAnchorCertificate () const
 
bool TrustAnchorCertificateHasBeenSet () const
 
void SetTrustAnchorCertificate (const Aws::String &value)
 
void SetTrustAnchorCertificate (Aws::String &&value)
 
void SetTrustAnchorCertificate (const char *value)
 
CustomKeyStoresListEntryWithTrustAnchorCertificate (const Aws::String &value)
 
CustomKeyStoresListEntryWithTrustAnchorCertificate (Aws::String &&value)
 
CustomKeyStoresListEntryWithTrustAnchorCertificate (const char *value)
 
const ConnectionStateTypeGetConnectionState () const
 
bool ConnectionStateHasBeenSet () const
 
void SetConnectionState (const ConnectionStateType &value)
 
void SetConnectionState (ConnectionStateType &&value)
 
CustomKeyStoresListEntryWithConnectionState (const ConnectionStateType &value)
 
CustomKeyStoresListEntryWithConnectionState (ConnectionStateType &&value)
 
const ConnectionErrorCodeTypeGetConnectionErrorCode () const
 
bool ConnectionErrorCodeHasBeenSet () const
 
void SetConnectionErrorCode (const ConnectionErrorCodeType &value)
 
void SetConnectionErrorCode (ConnectionErrorCodeType &&value)
 
CustomKeyStoresListEntryWithConnectionErrorCode (const ConnectionErrorCodeType &value)
 
CustomKeyStoresListEntryWithConnectionErrorCode (ConnectionErrorCodeType &&value)
 
const Aws::Utils::DateTimeGetCreationDate () const
 
bool CreationDateHasBeenSet () const
 
void SetCreationDate (const Aws::Utils::DateTime &value)
 
void SetCreationDate (Aws::Utils::DateTime &&value)
 
CustomKeyStoresListEntryWithCreationDate (const Aws::Utils::DateTime &value)
 
CustomKeyStoresListEntryWithCreationDate (Aws::Utils::DateTime &&value)
 

Detailed Description

Contains information about each custom key store in the custom key store list.

See Also:

AWS API Reference

Definition at line 35 of file CustomKeyStoresListEntry.h.

Constructor & Destructor Documentation

◆ CustomKeyStoresListEntry() [1/2]

Aws::KMS::Model::CustomKeyStoresListEntry::CustomKeyStoresListEntry ( )

◆ CustomKeyStoresListEntry() [2/2]

Aws::KMS::Model::CustomKeyStoresListEntry::CustomKeyStoresListEntry ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CloudHsmClusterIdHasBeenSet()

bool Aws::KMS::Model::CustomKeyStoresListEntry::CloudHsmClusterIdHasBeenSet ( ) const
inline

A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.

Definition at line 136 of file CustomKeyStoresListEntry.h.

◆ ConnectionErrorCodeHasBeenSet()

bool Aws::KMS::Model::CustomKeyStoresListEntry::ConnectionErrorCodeHasBeenSet ( ) const
inline

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 AWS Key Management Service Developer Guide.

Valid values are:

  • CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.

  • INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.

  • INTERNAL_ERROR - AWS 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 - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS 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 AWS KMS from connecting to the custom key store.

  • SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS 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 AWS Key Management Service Developer Guide.

  • USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS 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 AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS 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 AWS Key Management Service Developer Guide.

  • USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS 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.

Definition at line 461 of file CustomKeyStoresListEntry.h.

◆ ConnectionStateHasBeenSet()

bool Aws::KMS::Model::CustomKeyStoresListEntry::ConnectionStateHasBeenSet ( ) const
inline

Indicates whether the custom key store is connected to its AWS CloudHSM cluster.

You can create and use CMKs 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 AWS 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 AWS Key Management Service Developer Guide.

Definition at line 282 of file CustomKeyStoresListEntry.h.

◆ CreationDateHasBeenSet()

bool Aws::KMS::Model::CustomKeyStoresListEntry::CreationDateHasBeenSet ( ) const
inline

The date and time when the custom key store was created.

Definition at line 684 of file CustomKeyStoresListEntry.h.

◆ CustomKeyStoreIdHasBeenSet()

bool Aws::KMS::Model::CustomKeyStoresListEntry::CustomKeyStoreIdHasBeenSet ( ) const
inline

A unique identifier for the custom key store.

Definition at line 52 of file CustomKeyStoresListEntry.h.

◆ CustomKeyStoreNameHasBeenSet()

bool Aws::KMS::Model::CustomKeyStoresListEntry::CustomKeyStoreNameHasBeenSet ( ) const
inline

The user-specified friendly name for the custom key store.

Definition at line 93 of file CustomKeyStoresListEntry.h.

◆ GetCloudHsmClusterId()

const Aws::String& Aws::KMS::Model::CustomKeyStoresListEntry::GetCloudHsmClusterId ( ) const
inline

A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.

Definition at line 130 of file CustomKeyStoresListEntry.h.

◆ GetConnectionErrorCode()

const ConnectionErrorCodeType& Aws::KMS::Model::CustomKeyStoresListEntry::GetConnectionErrorCode ( ) const
inline

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 AWS Key Management Service Developer Guide.

Valid values are:

  • CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.

  • INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.

  • INTERNAL_ERROR - AWS 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 - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS 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 AWS KMS from connecting to the custom key store.

  • SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS 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 AWS Key Management Service Developer Guide.

  • USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS 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 AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS 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 AWS Key Management Service Developer Guide.

  • USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS 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.

Definition at line 408 of file CustomKeyStoresListEntry.h.

◆ GetConnectionState()

const ConnectionStateType& Aws::KMS::Model::CustomKeyStoresListEntry::GetConnectionState ( ) const
inline

Indicates whether the custom key store is connected to its AWS CloudHSM cluster.

You can create and use CMKs 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 AWS 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 AWS Key Management Service Developer Guide.

Definition at line 264 of file CustomKeyStoresListEntry.h.

◆ GetCreationDate()

const Aws::Utils::DateTime& Aws::KMS::Model::CustomKeyStoresListEntry::GetCreationDate ( ) const
inline

The date and time when the custom key store was created.

Definition at line 679 of file CustomKeyStoresListEntry.h.

◆ GetCustomKeyStoreId()

const Aws::String& Aws::KMS::Model::CustomKeyStoresListEntry::GetCustomKeyStoreId ( ) const
inline

A unique identifier for the custom key store.

Definition at line 47 of file CustomKeyStoresListEntry.h.

◆ GetCustomKeyStoreName()

const Aws::String& Aws::KMS::Model::CustomKeyStoresListEntry::GetCustomKeyStoreName ( ) const
inline

The user-specified friendly name for the custom key store.

Definition at line 88 of file CustomKeyStoresListEntry.h.

◆ GetTrustAnchorCertificate()

const Aws::String& Aws::KMS::Model::CustomKeyStoresListEntry::GetTrustAnchorCertificate ( ) const
inline

The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.

Definition at line 182 of file CustomKeyStoresListEntry.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::KMS::Model::CustomKeyStoresListEntry::Jsonize ( ) const

◆ operator=()

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCloudHsmClusterId() [1/3]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetCloudHsmClusterId ( const Aws::String value)
inline

A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.

Definition at line 142 of file CustomKeyStoresListEntry.h.

◆ SetCloudHsmClusterId() [2/3]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetCloudHsmClusterId ( Aws::String &&  value)
inline

A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.

Definition at line 148 of file CustomKeyStoresListEntry.h.

◆ SetCloudHsmClusterId() [3/3]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetCloudHsmClusterId ( const char *  value)
inline

A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.

Definition at line 154 of file CustomKeyStoresListEntry.h.

◆ SetConnectionErrorCode() [1/2]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetConnectionErrorCode ( const ConnectionErrorCodeType value)
inline

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 AWS Key Management Service Developer Guide.

Valid values are:

  • CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.

  • INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.

  • INTERNAL_ERROR - AWS 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 - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS 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 AWS KMS from connecting to the custom key store.

  • SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS 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 AWS Key Management Service Developer Guide.

  • USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS 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 AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS 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 AWS Key Management Service Developer Guide.

  • USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS 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.

Definition at line 514 of file CustomKeyStoresListEntry.h.

◆ SetConnectionErrorCode() [2/2]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetConnectionErrorCode ( ConnectionErrorCodeType &&  value)
inline

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 AWS Key Management Service Developer Guide.

Valid values are:

  • CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.

  • INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.

  • INTERNAL_ERROR - AWS 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 - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS 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 AWS KMS from connecting to the custom key store.

  • SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS 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 AWS Key Management Service Developer Guide.

  • USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS 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 AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS 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 AWS Key Management Service Developer Guide.

  • USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS 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.

Definition at line 567 of file CustomKeyStoresListEntry.h.

◆ SetConnectionState() [1/2]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetConnectionState ( const ConnectionStateType value)
inline

Indicates whether the custom key store is connected to its AWS CloudHSM cluster.

You can create and use CMKs 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 AWS 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 AWS Key Management Service Developer Guide.

Definition at line 300 of file CustomKeyStoresListEntry.h.

◆ SetConnectionState() [2/2]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetConnectionState ( ConnectionStateType &&  value)
inline

Indicates whether the custom key store is connected to its AWS CloudHSM cluster.

You can create and use CMKs 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 AWS 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 AWS Key Management Service Developer Guide.

Definition at line 318 of file CustomKeyStoresListEntry.h.

◆ SetCreationDate() [1/2]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetCreationDate ( const Aws::Utils::DateTime value)
inline

The date and time when the custom key store was created.

Definition at line 689 of file CustomKeyStoresListEntry.h.

◆ SetCreationDate() [2/2]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetCreationDate ( Aws::Utils::DateTime &&  value)
inline

The date and time when the custom key store was created.

Definition at line 694 of file CustomKeyStoresListEntry.h.

◆ SetCustomKeyStoreId() [1/3]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetCustomKeyStoreId ( const Aws::String value)
inline

A unique identifier for the custom key store.

Definition at line 57 of file CustomKeyStoresListEntry.h.

◆ SetCustomKeyStoreId() [2/3]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetCustomKeyStoreId ( Aws::String &&  value)
inline

A unique identifier for the custom key store.

Definition at line 62 of file CustomKeyStoresListEntry.h.

◆ SetCustomKeyStoreId() [3/3]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetCustomKeyStoreId ( const char *  value)
inline

A unique identifier for the custom key store.

Definition at line 67 of file CustomKeyStoresListEntry.h.

◆ SetCustomKeyStoreName() [1/3]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetCustomKeyStoreName ( const Aws::String value)
inline

The user-specified friendly name for the custom key store.

Definition at line 98 of file CustomKeyStoresListEntry.h.

◆ SetCustomKeyStoreName() [2/3]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetCustomKeyStoreName ( Aws::String &&  value)
inline

The user-specified friendly name for the custom key store.

Definition at line 103 of file CustomKeyStoresListEntry.h.

◆ SetCustomKeyStoreName() [3/3]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetCustomKeyStoreName ( const char *  value)
inline

The user-specified friendly name for the custom key store.

Definition at line 108 of file CustomKeyStoresListEntry.h.

◆ SetTrustAnchorCertificate() [1/3]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetTrustAnchorCertificate ( const Aws::String value)
inline

The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.

Definition at line 200 of file CustomKeyStoresListEntry.h.

◆ SetTrustAnchorCertificate() [2/3]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetTrustAnchorCertificate ( Aws::String &&  value)
inline

The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.

Definition at line 209 of file CustomKeyStoresListEntry.h.

◆ SetTrustAnchorCertificate() [3/3]

void Aws::KMS::Model::CustomKeyStoresListEntry::SetTrustAnchorCertificate ( const char *  value)
inline

The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.

Definition at line 218 of file CustomKeyStoresListEntry.h.

◆ TrustAnchorCertificateHasBeenSet()

bool Aws::KMS::Model::CustomKeyStoresListEntry::TrustAnchorCertificateHasBeenSet ( ) const
inline

The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.

Definition at line 191 of file CustomKeyStoresListEntry.h.

◆ WithCloudHsmClusterId() [1/3]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithCloudHsmClusterId ( const Aws::String value)
inline

A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.

Definition at line 160 of file CustomKeyStoresListEntry.h.

◆ WithCloudHsmClusterId() [2/3]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithCloudHsmClusterId ( Aws::String &&  value)
inline

A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.

Definition at line 166 of file CustomKeyStoresListEntry.h.

◆ WithCloudHsmClusterId() [3/3]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithCloudHsmClusterId ( const char *  value)
inline

A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.

Definition at line 172 of file CustomKeyStoresListEntry.h.

◆ WithConnectionErrorCode() [1/2]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithConnectionErrorCode ( const ConnectionErrorCodeType value)
inline

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 AWS Key Management Service Developer Guide.

Valid values are:

  • CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.

  • INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.

  • INTERNAL_ERROR - AWS 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 - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS 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 AWS KMS from connecting to the custom key store.

  • SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS 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 AWS Key Management Service Developer Guide.

  • USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS 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 AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS 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 AWS Key Management Service Developer Guide.

  • USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS 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.

Definition at line 620 of file CustomKeyStoresListEntry.h.

◆ WithConnectionErrorCode() [2/2]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithConnectionErrorCode ( ConnectionErrorCodeType &&  value)
inline

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 AWS Key Management Service Developer Guide.

Valid values are:

  • CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.

  • INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.

  • INTERNAL_ERROR - AWS 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 - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS 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 AWS KMS from connecting to the custom key store.

  • SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the AWS 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 AWS Key Management Service Developer Guide.

  • USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS 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 AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS 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 AWS Key Management Service Developer Guide.

  • USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS 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.

Definition at line 673 of file CustomKeyStoresListEntry.h.

◆ WithConnectionState() [1/2]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithConnectionState ( const ConnectionStateType value)
inline

Indicates whether the custom key store is connected to its AWS CloudHSM cluster.

You can create and use CMKs 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 AWS 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 AWS Key Management Service Developer Guide.

Definition at line 336 of file CustomKeyStoresListEntry.h.

◆ WithConnectionState() [2/2]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithConnectionState ( ConnectionStateType &&  value)
inline

Indicates whether the custom key store is connected to its AWS CloudHSM cluster.

You can create and use CMKs 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 AWS 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 AWS Key Management Service Developer Guide.

Definition at line 354 of file CustomKeyStoresListEntry.h.

◆ WithCreationDate() [1/2]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithCreationDate ( const Aws::Utils::DateTime value)
inline

The date and time when the custom key store was created.

Definition at line 699 of file CustomKeyStoresListEntry.h.

◆ WithCreationDate() [2/2]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithCreationDate ( Aws::Utils::DateTime &&  value)
inline

The date and time when the custom key store was created.

Definition at line 704 of file CustomKeyStoresListEntry.h.

◆ WithCustomKeyStoreId() [1/3]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithCustomKeyStoreId ( const Aws::String value)
inline

A unique identifier for the custom key store.

Definition at line 72 of file CustomKeyStoresListEntry.h.

◆ WithCustomKeyStoreId() [2/3]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithCustomKeyStoreId ( Aws::String &&  value)
inline

A unique identifier for the custom key store.

Definition at line 77 of file CustomKeyStoresListEntry.h.

◆ WithCustomKeyStoreId() [3/3]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithCustomKeyStoreId ( const char *  value)
inline

A unique identifier for the custom key store.

Definition at line 82 of file CustomKeyStoresListEntry.h.

◆ WithCustomKeyStoreName() [1/3]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithCustomKeyStoreName ( const Aws::String value)
inline

The user-specified friendly name for the custom key store.

Definition at line 113 of file CustomKeyStoresListEntry.h.

◆ WithCustomKeyStoreName() [2/3]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithCustomKeyStoreName ( Aws::String &&  value)
inline

The user-specified friendly name for the custom key store.

Definition at line 118 of file CustomKeyStoresListEntry.h.

◆ WithCustomKeyStoreName() [3/3]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithCustomKeyStoreName ( const char *  value)
inline

The user-specified friendly name for the custom key store.

Definition at line 123 of file CustomKeyStoresListEntry.h.

◆ WithTrustAnchorCertificate() [1/3]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithTrustAnchorCertificate ( const Aws::String value)
inline

The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.

Definition at line 227 of file CustomKeyStoresListEntry.h.

◆ WithTrustAnchorCertificate() [2/3]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithTrustAnchorCertificate ( Aws::String &&  value)
inline

The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.

Definition at line 236 of file CustomKeyStoresListEntry.h.

◆ WithTrustAnchorCertificate() [3/3]

CustomKeyStoresListEntry& Aws::KMS::Model::CustomKeyStoresListEntry::WithTrustAnchorCertificate ( const char *  value)
inline

The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.

Definition at line 245 of file CustomKeyStoresListEntry.h.


The documentation for this class was generated from the following file: