Struct: kms.DisableKeyInput

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 the KMS key to disable.

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 DisableKeyInput) 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”.



10725
10726
10727
// File 'service/kms/api.go', line 10725

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

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

SetKeyId sets the KeyId field's value.



10746
10747
10748
10749
// File 'service/kms/api.go', line 10746

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

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



10716
10717
10718
// File 'service/kms/api.go', line 10716

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

func (s *DisableKeyInput) Validate() error

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



10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
// File 'service/kms/api.go', line 10730

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