You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::KMS::Types::UpdateCustomKeyStoreRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::KMS::Types::UpdateCustomKeyStoreRequest
- Defined in:
- (unknown)
Overview
When passing UpdateCustomKeyStoreRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
custom_key_store_id: "CustomKeyStoreIdType", # required
new_custom_key_store_name: "CustomKeyStoreNameType",
key_store_password: "KeyStorePasswordType",
cloud_hsm_cluster_id: "CloudHsmClusterIdType",
}
Instance Attribute Summary collapse
-
#cloud_hsm_cluster_id ⇒ String
Associates the custom key store with a related AWS CloudHSM cluster.
-
#custom_key_store_id ⇒ String
Identifies the custom key store that you want to update.
-
#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. -
#new_custom_key_store_name ⇒ String
Changes the friendly name of the custom key store to the value that you specify.
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 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 operation.
#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.
#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.
#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.