Struct: kms.GenerateDataKeyWithoutPlaintextInput

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

Implemented Interfaces

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

Structure Field Summary collapse

EncryptionContext map[string]*string

Specifies the encryption context that will be used when encrypting the data key.
GrantTokens []*string

A list of grant tokens.
KeyId *string

Specifies the symmetric encryption KMS key that encrypts the data key.
KeySpec *string

The length of the data key.
NumberOfBytes *int64

The length of the data key in bytes.
_ struct{}

Service Operations collapse

GoString() string operation

GoString returns the string representation.
SetEncryptionContext(map[string]*string) *GenerateDataKeyWithoutPlaintextInput operation

SetEncryptionContext sets the EncryptionContext field's value.
SetGrantTokens([]*string) *GenerateDataKeyWithoutPlaintextInput operation

SetGrantTokens sets the GrantTokens field's value.
SetKeyId(string) *GenerateDataKeyWithoutPlaintextInput operation

SetKeyId sets the KeyId field's value.
SetKeySpec(string) *GenerateDataKeyWithoutPlaintextInput operation

SetKeySpec sets the KeySpec field's value.
SetNumberOfBytes(int64) *GenerateDataKeyWithoutPlaintextInput operation

SetNumberOfBytes sets the NumberOfBytes 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

EncryptionContext map[string]*string `type:"map"`

Specifies the encryption context that will be used when encrypting the data key.

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

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context (docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the Key Management Service Developer Guide.

GrantTokens []*string `type:"list"`

A list of grant tokens.

For more information, see Grant Tokens (docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) in the AWS Key Management Service Developer Guide.

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

Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with “alias/”. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

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

KeyId is a required field

KeySpec *string `type:"string" enum:"DataKeySpec"`

The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

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

The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.

_ struct{} `type:"structure"`

Method Details

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



12100
12101
12102

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

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

func (s GenerateDataKeyWithoutPlaintextInput) SetEncryptionContext(v map[string]string) *GenerateDataKeyWithoutPlaintextInput

SetEncryptionContext sets the EncryptionContext field's value.

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

func (s *GenerateDataKeyWithoutPlaintextInput) SetEncryptionContext(v map[string]*string) *GenerateDataKeyWithoutPlaintextInput {
	s.EncryptionContext = v
	return s
}

func (s GenerateDataKeyWithoutPlaintextInput) SetGrantTokens(v []string) *GenerateDataKeyWithoutPlaintextInput

SetGrantTokens sets the GrantTokens field's value.

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

func (s *GenerateDataKeyWithoutPlaintextInput) SetGrantTokens(v []*string) *GenerateDataKeyWithoutPlaintextInput {
	s.GrantTokens = v
	return s
}

func (s GenerateDataKeyWithoutPlaintextInput) SetKeyId(v string) GenerateDataKeyWithoutPlaintextInput

SetKeyId sets the KeyId field's value.

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

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

func (s GenerateDataKeyWithoutPlaintextInput) SetKeySpec(v string) GenerateDataKeyWithoutPlaintextInput

SetKeySpec sets the KeySpec field's value.

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

func (s *GenerateDataKeyWithoutPlaintextInput) SetKeySpec(v string) *GenerateDataKeyWithoutPlaintextInput {
	s.KeySpec = &v
	return s
}

func (s GenerateDataKeyWithoutPlaintextInput) SetNumberOfBytes(v int64) GenerateDataKeyWithoutPlaintextInput

SetNumberOfBytes sets the NumberOfBytes field's value.

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

func (s *GenerateDataKeyWithoutPlaintextInput) SetNumberOfBytes(v int64) *GenerateDataKeyWithoutPlaintextInput {
	s.NumberOfBytes = &v
	return s
}

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



12091
12092
12093

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

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

func (s *GenerateDataKeyWithoutPlaintextInput) Validate() error

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

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

func (s *GenerateDataKeyWithoutPlaintextInput) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "GenerateDataKeyWithoutPlaintextInput"}
	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.NumberOfBytes != nil && *s.NumberOfBytes < 1 {
		invalidParams.Add(request.NewErrParamMinValue("NumberOfBytes", 1))
	}

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