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.

CreateCustomKeyStoreInput

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

type CreateCustomKeyStoreInput struct { CloudHsmClusterId *string `min:"19" type:"string" required:"true"` CustomKeyStoreName *string `min:"1" type:"string" required:"true"` KeyStorePassword *string `min:"1" type:"string" required:"true" sensitive:"true"` TrustAnchorCertificate *string `min:"1" type:"string" required:"true"` }

CloudHsmClusterId

Type: *string

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

CloudHsmClusterId is a required field

CustomKeyStoreName

Type: *string

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

CustomKeyStoreName is a required field

KeyStorePassword

Type: *string

Enter the password of the kmsuser (https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-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.

This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.

KeyStorePassword is a required field

TrustAnchorCertificate

Type: *string

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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html).

TrustAnchorCertificate is a required field

Method

GoString

func (s CreateCustomKeyStoreInput) GoString() string

GoString returns the string representation

SetCloudHsmClusterId

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

SetCloudHsmClusterId sets the CloudHsmClusterId field's value.

SetCustomKeyStoreName

func (s *CreateCustomKeyStoreInput) SetCustomKeyStoreName(v string) *CreateCustomKeyStoreInput

SetCustomKeyStoreName sets the CustomKeyStoreName field's value.

SetKeyStorePassword

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

SetKeyStorePassword sets the KeyStorePassword field's value.

SetTrustAnchorCertificate

func (s *CreateCustomKeyStoreInput) SetTrustAnchorCertificate(v string) *CreateCustomKeyStoreInput

SetTrustAnchorCertificate sets the TrustAnchorCertificate field's value.

String

func (s CreateCustomKeyStoreInput) String() string

String returns the string representation

Validate

func (s *CreateCustomKeyStoreInput) Validate() error

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

On this page: