Class: Aws::KMS::Types::CustomKeyStoresListEntry

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::CustomKeyStoresListEntry

Includes:

Structure

Defined in:

lib/aws-sdk-kms/types.rb

Overview

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

See Also:

• AWS API Documentation

Instance Attribute Summary

• #cloud_hsm_cluster_id ⇒ String

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

• #connection_error_code ⇒ String

  Describes the connection error.

• #connection_state ⇒ String

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

• #creation_date ⇒ Time

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

• #custom_key_store_id ⇒ String

  A unique identifier for the custom key store.

• #custom_key_store_name ⇒ String

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

• #trust_anchor_certificate ⇒ String

  The trust anchor certificate of the associated AWS CloudHSM cluster.

Instance Attribute Details

#cloud_hsm_cluster_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 621

class CustomKeyStoresListEntry < Struct.new(
  :custom_key_store_id,
  :custom_key_store_name,
  :cloud_hsm_cluster_id,
  :trust_anchor_certificate,
  :connection_state,
  :connection_error_code,
  :creation_date)
  include Aws::Structure
end

#connection_error_code ⇒ String

Describes the connection error. 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.

• ‘INVALID_CREDENTIALS` - AWS KMS does not have the correct password for the `kmsuser` crypto user in the AWS CloudHSM cluster.

• ‘NETWORK_ERRORS` - Network errors are preventing AWS KMS from connecting to the custom key store.

• ‘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 password value for the custom key store.

For help with connection failures, see [Troubleshooting Custom Key Stores] in the *AWS Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 621

class CustomKeyStoresListEntry < Struct.new(
  :custom_key_store_id,
  :custom_key_store_name,
  :cloud_hsm_cluster_id,
  :trust_anchor_certificate,
  :connection_state,
  :connection_error_code,
  :creation_date)
  include Aws::Structure
end

#connection_state ⇒ String

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. For help resolving a connection failure, see

Troubleshooting a Custom Key Store][1

in the *AWS Key Management

Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 621

class CustomKeyStoresListEntry < Struct.new(
  :custom_key_store_id,
  :custom_key_store_name,
  :cloud_hsm_cluster_id,
  :trust_anchor_certificate,
  :connection_state,
  :connection_error_code,
  :creation_date)
  include Aws::Structure
end

#creation_date ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-kms/types.rb', line 621

class CustomKeyStoresListEntry < Struct.new(
  :custom_key_store_id,
  :custom_key_store_name,
  :cloud_hsm_cluster_id,
  :trust_anchor_certificate,
  :connection_state,
  :connection_error_code,
  :creation_date)
  include Aws::Structure
end

#custom_key_store_id ⇒ String

A unique identifier for the custom key store.

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 621

class CustomKeyStoresListEntry < Struct.new(
  :custom_key_store_id,
  :custom_key_store_name,
  :cloud_hsm_cluster_id,
  :trust_anchor_certificate,
  :connection_state,
  :connection_error_code,
  :creation_date)
  include Aws::Structure
end

#custom_key_store_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 621

class CustomKeyStoresListEntry < Struct.new(
  :custom_key_store_id,
  :custom_key_store_name,
  :cloud_hsm_cluster_id,
  :trust_anchor_certificate,
  :connection_state,
  :connection_error_code,
  :creation_date)
  include Aws::Structure
end

#trust_anchor_certificate ⇒ String

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.

[1]: docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 621

class CustomKeyStoresListEntry < Struct.new(
  :custom_key_store_id,
  :custom_key_store_name,
  :cloud_hsm_cluster_id,
  :trust_anchor_certificate,
  :connection_state,
  :connection_error_code,
  :creation_date)
  include Aws::Structure
end