Struct: kms.UpdateKeyDescriptionInput

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

Implemented Interfaces

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

Structure Field Summary

• Description *string

  New description for the KMS key.

• KeyId *string

  Updates the description of the specified KMS key.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetDescription(string) *UpdateKeyDescriptionInput operation

  SetDescription sets the Description field's value.

• SetKeyId(string) *UpdateKeyDescriptionInput operation

  SetKeyId sets the KeyId 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

Description *string `type:"string" required:"true"`

New description for the KMS key.

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

Description is a required field

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

Updates the description of the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

KeyId is a required field

_ struct{} `type:"structure"`

Method Details

func (s UpdateKeyDescriptionInput) 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 17187

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

func (s *UpdateKeyDescriptionInput) SetDescription(v string) *UpdateKeyDescriptionInput

SetDescription sets the Description field's value.

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

func (s *UpdateKeyDescriptionInput) SetDescription(v string) *UpdateKeyDescriptionInput {
	s.Description = &v
	return s
}

func (s *UpdateKeyDescriptionInput) SetKeyId(v string) *UpdateKeyDescriptionInput

SetKeyId sets the KeyId field's value.

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

func (s *UpdateKeyDescriptionInput) SetKeyId(v string) *UpdateKeyDescriptionInput {
	s.KeyId = &v
	return s
}

func (s UpdateKeyDescriptionInput) 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 17178

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

func (s *UpdateKeyDescriptionInput) Validate() error

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

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

func (s *UpdateKeyDescriptionInput) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "UpdateKeyDescriptionInput"}
	if s.Description == nil {
		invalidParams.Add(request.NewErrParamRequired("Description"))
	}
	if s.KeyId == nil {
		invalidParams.Add(request.NewErrParamRequired("KeyId"))
	}
	if s.KeyId != nil && len(*s.KeyId) < 1 {
		invalidParams.Add(request.NewErrParamMinLen("KeyId", 1))
	}

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