You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::KMS::Types::CreateCustomKeyStoreRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateCustomKeyStoreRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  custom_key_store_name: "CustomKeyStoreNameType", # required
  cloud_hsm_cluster_id: "CloudHsmClusterIdType", # required
  trust_anchor_certificate: "TrustAnchorCertificateType", # required
  key_store_password: "KeyStorePasswordType", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_hsm_cluster_id ⇒ String

Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

Returns:

  • (String) —

    Identifies the AWS CloudHSM cluster for the custom key store.

#custom_key_store_name ⇒ String

Specifies a friendly name for the custom key store. The name must be unique in your AWS account.

Returns:

  • (String) —

    Specifies a friendly name for the custom key store.

#key_store_password ⇒ String

Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.

The password must be a string of 7 to 32 characters. Its value is case sensitive.

This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.

Returns:

  • (String) —

    Enter the password of the [ kmsuser crypto user (CU) account][1] in the specified AWS CloudHSM cluster.

#trust_anchor_certificate ⇒ String

Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.

Returns:

  • (String) —

    Enter the content of the trust anchor certificate for the cluster.