Struct: kms.RetireGrantInput

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

Implemented Interfaces

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

Structure Field Summary

• GrantId *string

  Unique identifier of the grant to retire.

• GrantToken *string

  Token that identifies the grant to be retired.

• KeyId *string

  The key ARN KMS key associated with the grant.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetGrantId(string) *RetireGrantInput operation

  SetGrantId sets the GrantId field's value.

• SetGrantToken(string) *RetireGrantInput operation

  SetGrantToken sets the GrantToken field's value.

• SetKeyId(string) *RetireGrantInput 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

GrantId *string `min:"1" type:"string"`

Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

GrantToken *string `min:"1" type:"string"`

Token that identifies the grant to be retired.

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

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

_ struct{} `type:"structure"`

Method Details

func (s RetireGrantInput) 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 16006

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

func (s *RetireGrantInput) SetGrantId(v string) *RetireGrantInput

SetGrantId sets the GrantId field's value.

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

func (s *RetireGrantInput) SetGrantId(v string) *RetireGrantInput {
	s.GrantId = &v
	return s
}

func (s *RetireGrantInput) SetGrantToken(v string) *RetireGrantInput

SetGrantToken sets the GrantToken field's value.

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

func (s *RetireGrantInput) SetGrantToken(v string) *RetireGrantInput {
	s.GrantToken = &v
	return s
}

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

SetKeyId sets the KeyId field's value.

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

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

func (s RetireGrantInput) 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 15997

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

func (s *RetireGrantInput) Validate() error

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

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

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

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