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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kms/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
}

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_hsm_cluster_idString

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)


340
341
342
343
344
345
346
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 340

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_nameString

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

Returns:

  • (String)


340
341
342
343
344
345
346
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 340

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

#key_store_passwordString

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)


340
341
342
343
344
345
346
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 340

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

#trust_anchor_certificateString

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)


340
341
342
343
344
345
346
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 340

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