Struct: kms.ScheduleKeyDeletionInput

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

Implemented Interfaces

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

Structure Field Summary

• KeyId *string

  The unique identifier of the KMS key to delete.

• PendingWindowInDays *int64
• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetKeyId(string) *ScheduleKeyDeletionInput operation

  SetKeyId sets the KeyId field's value.

• SetPendingWindowInDays(int64) *ScheduleKeyDeletionInput operation

  SetPendingWindowInDays sets the PendingWindowInDays 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

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

The unique identifier of the KMS key to delete.

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

PendingWindowInDays *int64 `min:"1" type:"integer"`

_ struct{} `type:"structure"`

Method Details

func (s ScheduleKeyDeletionInput) 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 16204

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

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

SetKeyId sets the KeyId field's value.

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

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

func (s *ScheduleKeyDeletionInput) SetPendingWindowInDays(v int64) *ScheduleKeyDeletionInput

SetPendingWindowInDays sets the PendingWindowInDays field's value.

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

func (s *ScheduleKeyDeletionInput) SetPendingWindowInDays(v int64) *ScheduleKeyDeletionInput {
	s.PendingWindowInDays = &v
	return s
}

func (s ScheduleKeyDeletionInput) 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 16195

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

func (s *ScheduleKeyDeletionInput) Validate() error

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

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

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

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