Class: Aws::KMS::Types::UpdateCustomKeyStoreRequest

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 UpdateCustomKeyStoreRequest data as a hash:

{
  custom_key_store_id: "CustomKeyStoreIdType", # required
  new_custom_key_store_name: "CustomKeyStoreNameType",
  key_store_password: "KeyStorePasswordType",
  cloud_hsm_cluster_id: "CloudHsmClusterIdType",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_hsm_cluster_id ⇒ String

Associates the custom key store with a related AWS CloudHSM cluster.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history with the original cluster. You cannot use this parameter to associate a custom key store with a different cluster.

Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the

DescribeClusters][1

operation.

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

Returns:

  • (String) 


2849
2850
2851
2852
2853
2854
2855
 
# File 'lib/aws-sdk-kms/types.rb', line 2849

class UpdateCustomKeyStoreRequest < Struct.new(
  :custom_key_store_id,
  :new_custom_key_store_name,
  :key_store_password,
  :cloud_hsm_cluster_id)
  include Aws::Structure
end

#custom_key_store_id ⇒ String

Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Returns:

  • (String) 


2849
2850
2851
2852
2853
2854
2855
 
# File 'lib/aws-sdk-kms/types.rb', line 2849

class UpdateCustomKeyStoreRequest < Struct.new(
  :custom_key_store_id,
  :new_custom_key_store_name,
  :key_store_password,
  :cloud_hsm_cluster_id)
  include Aws::Structure
end

#key_store_password ⇒ String

Enter the current password of the ‘kmsuser` crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store.

This parameter tells AWS KMS the current password of the ‘kmsuser` crypto user (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

Returns:

  • (String) 


2849
2850
2851
2852
2853
2854
2855
 
# File 'lib/aws-sdk-kms/types.rb', line 2849

class UpdateCustomKeyStoreRequest < Struct.new(
  :custom_key_store_id,
  :new_custom_key_store_name,
  :key_store_password,
  :cloud_hsm_cluster_id)
  include Aws::Structure
end

#new_custom_key_store_name ⇒ String

Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the AWS account.

Returns:

  • (String) 


2849
2850
2851
2852
2853
2854
2855
 
# File 'lib/aws-sdk-kms/types.rb', line 2849

class UpdateCustomKeyStoreRequest < Struct.new(
  :custom_key_store_id,
  :new_custom_key_store_name,
  :key_store_password,
  :cloud_hsm_cluster_id)
  include Aws::Structure
end