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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kms/types.rb

Overview

Note:

When making an API call, you may pass CreateCustomKeyStoreRequest data as a 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.

[1]: docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html

Returns:

  • (String) 


191
192
193
194
195
196
197
 
# File 'lib/aws-sdk-kms/types.rb', line 191

class CreateCustomKeyStoreRequest < Struct.new(
  :custom_key_store_name,
  :cloud_hsm_cluster_id,
  :trust_anchor_certificate,
  :key_store_password)
  include Aws::Structure
end

#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) 


191
192
193
194
195
196
197
 
# File 'lib/aws-sdk-kms/types.rb', line 191

class CreateCustomKeyStoreRequest < Struct.new(
  :custom_key_store_name,
  :cloud_hsm_cluster_id,
  :trust_anchor_certificate,
  :key_store_password)
  include Aws::Structure
end

#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.

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

[1]: docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser

Returns:

  • (String) 


191
192
193
194
195
196
197
 
# File 'lib/aws-sdk-kms/types.rb', line 191

class CreateCustomKeyStoreRequest < Struct.new(
  :custom_key_store_name,
  :cloud_hsm_cluster_id,
  :trust_anchor_certificate,
  :key_store_password)
  include Aws::Structure
end

#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].

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

Returns:

  • (String) 


191
192
193
194
195
196
197
 
# File 'lib/aws-sdk-kms/types.rb', line 191

class CreateCustomKeyStoreRequest < Struct.new(
  :custom_key_store_name,
  :cloud_hsm_cluster_id,
  :trust_anchor_certificate,
  :key_store_password)
  include Aws::Structure
end