Struct: kms.EnableKeyRotationInput

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

Implemented Interfaces

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

Structure Field Summary collapse

Service Operations collapse

Structure Field Details

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

Identifies a symmetric encryption KMS key. You cannot enable automatic rotation of asymmetric KMS keys (docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html), HMAC KMS keys (docs.aws.amazon.com/kms/latest/developerguide/hmac.html), KMS keys with imported key material (docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html), or KMS keys in a custom key store (docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html). To enable or disable automatic rotation of a set of related multi-Region keys (docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate), set the property on the primary 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 EnableKeyRotationInput) 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”.



11115
11116
11117
// File 'service/kms/api.go', line 11115

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

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

SetKeyId sets the KeyId field's value.



11136
11137
11138
11139
// File 'service/kms/api.go', line 11136

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

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



11106
11107
11108
// File 'service/kms/api.go', line 11106

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

func (s *EnableKeyRotationInput) Validate() error

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



11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
// File 'service/kms/api.go', line 11120

func (s *EnableKeyRotationInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "EnableKeyRotationInput"} 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 }