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",
}

Constant Summary collapse

SENSITIVE =
[:key_store_password]

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_hsm_cluster_idString

Associates the custom key store with a related 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 and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must [fulfill the requirements] for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the

DescribeClusters][2

operation.

[1]: docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore [2]: docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html

Returns:

  • (String)

5352
5353
5354
5355
5356
5357
5358
5359
# File 'lib/aws-sdk-kms/types.rb', line 5352

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

#custom_key_store_idString

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)

5352
5353
5354
5355
5356
5357
5358
5359
# File 'lib/aws-sdk-kms/types.rb', line 5352

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

#key_store_passwordString

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

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

Returns:

  • (String)

5352
5353
5354
5355
5356
5357
5358
5359
# File 'lib/aws-sdk-kms/types.rb', line 5352

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

#new_custom_key_store_nameString

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 Amazon Web Services account.

Returns:

  • (String)

5352
5353
5354
5355
5356
5357
5358
5359
# File 'lib/aws-sdk-kms/types.rb', line 5352

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