Struct: kms.UpdateCustomKeyStoreInput

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

Implemented Interfaces

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

Structure Field Summary

• CloudHsmClusterId *string

  Associates the custom key store with a related CloudHSM cluster.

• CustomKeyStoreId *string

  Identifies the custom key store that you want to update.

• KeyStorePassword *string

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

• NewCustomKeyStoreName *string

  Changes the friendly name of the custom key store to the value that you specify.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetCloudHsmClusterId(string) *UpdateCustomKeyStoreInput operation

  SetCloudHsmClusterId sets the CloudHsmClusterId field's value.

• SetCustomKeyStoreId(string) *UpdateCustomKeyStoreInput operation

  SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

• SetKeyStorePassword(string) *UpdateCustomKeyStoreInput operation

  SetKeyStorePassword sets the KeyStorePassword field's value.

• SetNewCustomKeyStoreName(string) *UpdateCustomKeyStoreInput operation

  SetNewCustomKeyStoreName sets the NewCustomKeyStoreName 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"`

Associates the custom key store with a related CloudHSM cluster. This parameter is valid only for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM.

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 (docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore) for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters (docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) operation.

To change this value, the CloudHSM key store must be disconnected.

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

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 *string `min:"7" type:"string" sensitive:"true"`

Enter the current password of the kmsuser crypto user (CU) in the CloudHSM cluster that is associated with the custom key store. This parameter is valid only for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM.

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.

To change this value, the CloudHSM key store must be disconnected.

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

NewCustomKeyStoreName *string `min:"1" 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 Amazon Web Services account.

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

To change this value, an CloudHSM key store must be disconnected. An external key store can be connected or disconnected.

_ struct{} `type:"structure"`

Method Details

func (s UpdateCustomKeyStoreInput) 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”.

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

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

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

SetCloudHsmClusterId sets the CloudHsmClusterId field's value.

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

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

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

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

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

func (s *UpdateCustomKeyStoreInput) SetCustomKeyStoreId(v string) *UpdateCustomKeyStoreInput {
	s.CustomKeyStoreId = &v
	return s
}

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

SetKeyStorePassword sets the KeyStorePassword field's value.

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

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

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

SetNewCustomKeyStoreName sets the NewCustomKeyStoreName field's value.

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

func (s *UpdateCustomKeyStoreInput) SetNewCustomKeyStoreName(v string) *UpdateCustomKeyStoreInput {
	s.NewCustomKeyStoreName = &v
	return s
}

func (s UpdateCustomKeyStoreInput) 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”.

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

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

func (s *UpdateCustomKeyStoreInput) Validate() error

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

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

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

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