Struct: kms.GenerateDataKeyOutput

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

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, s3manager.WriterReadFrom

Structure Field Summary collapse

CiphertextBlob []byte

The encrypted copy of the data key.
KeyId *string

The Amazon Resource Name (key ARN (docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) of the KMS key that encrypted the data key.
Plaintext []byte

The plaintext data key.
_ struct{}

Service Operations collapse

GoString() string operation

GoString returns the string representation.
SetCiphertextBlob([]byte) *GenerateDataKeyOutput operation

SetCiphertextBlob sets the CiphertextBlob field's value.
SetKeyId(string) *GenerateDataKeyOutput operation

SetKeyId sets the KeyId field's value.
SetPlaintext([]byte) *GenerateDataKeyOutput operation

SetPlaintext sets the Plaintext field's value.
String() string operation

String returns the string representation.

Structure Field Details

CiphertextBlob []byte `min:"1" type:"blob"`

The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. CiphertextBlob is automatically base64 encoded/decoded by the SDK.

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

The Amazon Resource Name (key ARN (docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) of the KMS key that encrypted the data key.

Plaintext []byte `min:"1" type:"blob" sensitive:"true"`

The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.

If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.

Plaintext is a sensitive parameter and its value will be replaced with “sensitive” in string returned by GenerateDataKeyOutput's String and GoString methods.

Plaintext is automatically base64 encoded/decoded by the SDK.

_ struct{} `type:"structure"`

Method Details

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



11604
11605
11606

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

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

func (s GenerateDataKeyOutput) SetCiphertextBlob(v []byte) GenerateDataKeyOutput

SetCiphertextBlob sets the CiphertextBlob field's value.

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

func (s *GenerateDataKeyOutput) SetCiphertextBlob(v []byte) *GenerateDataKeyOutput {
	s.CiphertextBlob = v
	return s
}

func (s GenerateDataKeyOutput) SetKeyId(v string) GenerateDataKeyOutput

SetKeyId sets the KeyId field's value.

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

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

func (s GenerateDataKeyOutput) SetPlaintext(v []byte) GenerateDataKeyOutput

SetPlaintext sets the Plaintext field's value.

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

func (s *GenerateDataKeyOutput) SetPlaintext(v []byte) *GenerateDataKeyOutput {
	s.Plaintext = v
	return s
}

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



11595
11596
11597

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

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