Struct: kms.CreateCustomKeyStoreInput

import "../ibm-cos-sdk-go/service/kms"

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, request.Validator, s3manager.WriterReadFrom

Structure Field Summary collapse

CloudHsmClusterId *string

Identifies the CloudHSM cluster for an CloudHSM key store.
CustomKeyStoreName *string

Specifies a friendly name for the custom key store.
KeyStorePassword *string

Specifies the kmsuser password for an CloudHSM key store.
TrustAnchorCertificate *string

Specifies the certificate for an CloudHSM key store.
_ struct{}

Service Operations collapse

GoString() string operation

GoString returns the string representation.
SetCloudHsmClusterId(string) *CreateCustomKeyStoreInput operation

SetCloudHsmClusterId sets the CloudHsmClusterId field's value.
SetCustomKeyStoreName(string) *CreateCustomKeyStoreInput operation

SetCustomKeyStoreName sets the CustomKeyStoreName field's value.
SetKeyStorePassword(string) *CreateCustomKeyStoreInput operation

SetKeyStorePassword sets the KeyStorePassword field's value.
SetTrustAnchorCertificate(string) *CreateCustomKeyStoreInput operation

SetTrustAnchorCertificate sets the TrustAnchorCertificate field's value.
String() string operation

String returns the string representation.
Validate() error operation

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

Structure Field Details

CloudHsmClusterId *string `min:"19" type:"string" required:"true"`

Identifies the CloudHSM cluster for an CloudHSM key store. This parameter is required for custom key stores with CustomKeyStoreType of AWS_CLOUDHSM.

Enter the cluster ID of any active CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters (docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) operation.

CloudHsmClusterId is a required field

CustomKeyStoreName *string `min:"1" type:"string" required:"true"`

Specifies a friendly name for the custom key store. The name must be unique in your Amazon Web Services account and Region. This parameter is required for all custom key stores.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

CustomKeyStoreName is a required field

KeyStorePassword *string `min:"7" type:"string" required:"true" sensitive:"true"`

Specifies the kmsuser password for an CloudHSM key store. This parameter is required for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM.

Enter the password of the kmsuser crypto user (CU) account (docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser) in the specified CloudHSM cluster. KMS logs into the cluster as this user to manage key material on your behalf.

The password must be a string of 7 to 32 characters. Its value is case sensitive.

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

KeyStorePassword is a sensitive parameter and its value will be replaced with “sensitive” in string returned by CreateCustomKeyStoreInput's String and GoString methods.

KeyStorePassword is a required field

TrustAnchorCertificate *string `min:"1" type:"string" required:"true"`

Specifies the certificate for an CloudHSM key store. This parameter is required for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM.

Enter the content of the trust anchor certificate for the CloudHSM cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster (docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html).

TrustAnchorCertificate is a required field

_ struct{} `type:"structure"`

Method Details

func (s CreateCustomKeyStoreInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.



8758
8759
8760

// File 'service/kms/api.go', line 8758

func (s CreateCustomKeyStoreInput) GoString() string {
	return s.String()
}

func (s CreateCustomKeyStoreInput) SetCloudHsmClusterId(v string) CreateCustomKeyStoreInput

SetCloudHsmClusterId sets the CloudHsmClusterId field's value.

// File 'service/kms/api.go', line 8797

func (s *CreateCustomKeyStoreInput) SetCloudHsmClusterId(v string) *CreateCustomKeyStoreInput {
	s.CloudHsmClusterId = &v
	return s
}

func (s CreateCustomKeyStoreInput) SetCustomKeyStoreName(v string) CreateCustomKeyStoreInput

SetCustomKeyStoreName sets the CustomKeyStoreName field's value.

// File 'service/kms/api.go', line 8803

func (s *CreateCustomKeyStoreInput) SetCustomKeyStoreName(v string) *CreateCustomKeyStoreInput {
	s.CustomKeyStoreName = &v
	return s
}

func (s CreateCustomKeyStoreInput) SetKeyStorePassword(v string) CreateCustomKeyStoreInput

SetKeyStorePassword sets the KeyStorePassword field's value.

// File 'service/kms/api.go', line 8809

func (s *CreateCustomKeyStoreInput) SetKeyStorePassword(v string) *CreateCustomKeyStoreInput {
	s.KeyStorePassword = &v
	return s
}

func (s CreateCustomKeyStoreInput) SetTrustAnchorCertificate(v string) CreateCustomKeyStoreInput

SetTrustAnchorCertificate sets the TrustAnchorCertificate field's value.

// File 'service/kms/api.go', line 8815

func (s *CreateCustomKeyStoreInput) SetTrustAnchorCertificate(v string) *CreateCustomKeyStoreInput {
	s.TrustAnchorCertificate = &v
	return s
}

func (s CreateCustomKeyStoreInput) String() string

String returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.



8749
8750
8751

// File 'service/kms/api.go', line 8749

func (s CreateCustomKeyStoreInput) String() string {
	return awsutil.Prettify(s)
}

func (s *CreateCustomKeyStoreInput) Validate() error

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

// File 'service/kms/api.go', line 8763

func (s *CreateCustomKeyStoreInput) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "CreateCustomKeyStoreInput"}
	if s.CloudHsmClusterId == nil {
		invalidParams.Add(request.NewErrParamRequired("CloudHsmClusterId"))
	}
	if s.CloudHsmClusterId != nil && len(*s.CloudHsmClusterId) < 19 {
		invalidParams.Add(request.NewErrParamMinLen("CloudHsmClusterId", 19))
	}
	if s.CustomKeyStoreName == nil {
		invalidParams.Add(request.NewErrParamRequired("CustomKeyStoreName"))
	}
	if s.CustomKeyStoreName != nil && len(*s.CustomKeyStoreName) < 1 {
		invalidParams.Add(request.NewErrParamMinLen("CustomKeyStoreName", 1))
	}
	if s.KeyStorePassword == nil {
		invalidParams.Add(request.NewErrParamRequired("KeyStorePassword"))
	}
	if s.KeyStorePassword != nil && len(*s.KeyStorePassword) < 7 {
		invalidParams.Add(request.NewErrParamMinLen("KeyStorePassword", 7))
	}
	if s.TrustAnchorCertificate == nil {
		invalidParams.Add(request.NewErrParamRequired("TrustAnchorCertificate"))
	}
	if s.TrustAnchorCertificate != nil && len(*s.TrustAnchorCertificate) < 1 {
		invalidParams.Add(request.NewErrParamMinLen("TrustAnchorCertificate", 1))
	}

	if invalidParams.Len() > 0 {
		return invalidParams
	}
	return nil
}