AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

UpdateCustomKeyStoreInput

import "github.com/aws/aws-sdk-go/service/kms"

type UpdateCustomKeyStoreInput struct { CloudHsmClusterId *string `min:"19" type:"string"` CustomKeyStoreId *string `min:"1" type:"string" required:"true"` KeyStorePassword *string `min:"1" type:"string" sensitive:"true"` NewCustomKeyStoreName *string `min:"1" type:"string"` }

CloudHsmClusterId

Type: *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 (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) operation.

CustomKeyStoreId

Type: *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.

CustomKeyStoreId is a required field

KeyStorePassword

Type: *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.

NewCustomKeyStoreName

Type: *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.

Method

GoString

func (s UpdateCustomKeyStoreInput) GoString() string

GoString returns the string representation

SetCloudHsmClusterId

func (s *UpdateCustomKeyStoreInput) SetCloudHsmClusterId(v string) *UpdateCustomKeyStoreInput

SetCloudHsmClusterId sets the CloudHsmClusterId field's value.

SetCustomKeyStoreId

func (s *UpdateCustomKeyStoreInput) SetCustomKeyStoreId(v string) *UpdateCustomKeyStoreInput

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

SetKeyStorePassword

func (s *UpdateCustomKeyStoreInput) SetKeyStorePassword(v string) *UpdateCustomKeyStoreInput

SetKeyStorePassword sets the KeyStorePassword field's value.

SetNewCustomKeyStoreName

func (s *UpdateCustomKeyStoreInput) SetNewCustomKeyStoreName(v string) *UpdateCustomKeyStoreInput

SetNewCustomKeyStoreName sets the NewCustomKeyStoreName field's value.

String

func (s UpdateCustomKeyStoreInput) String() string

String returns the string representation

Validate

func (s *UpdateCustomKeyStoreInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: