Struct: kms.GenerateDataKeyPairOutput

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

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, s3manager.WriterReadFrom

Structure Field Summary collapse

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 private key.
KeyPairSpec *string

The type of data key pair that was generated.
PrivateKeyCiphertextBlob []byte

The encrypted copy of the private key.
PrivateKeyPlaintext []byte

The plaintext copy of the private key.
PublicKey []byte

The public key (in plaintext).
_ struct{}

Service Operations collapse

GoString() string operation

GoString returns the string representation.
SetKeyId(string) *GenerateDataKeyPairOutput operation

SetKeyId sets the KeyId field's value.
SetKeyPairSpec(string) *GenerateDataKeyPairOutput operation

SetKeyPairSpec sets the KeyPairSpec field's value.
SetPrivateKeyCiphertextBlob([]byte) *GenerateDataKeyPairOutput operation

SetPrivateKeyCiphertextBlob sets the PrivateKeyCiphertextBlob field's value.
SetPrivateKeyPlaintext([]byte) *GenerateDataKeyPairOutput operation

SetPrivateKeyPlaintext sets the PrivateKeyPlaintext field's value.
SetPublicKey([]byte) *GenerateDataKeyPairOutput operation

SetPublicKey sets the PublicKey field's value.
String() string operation

String returns the string representation.

Structure Field Details

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 private key.

KeyPairSpec *string `type:"string" enum:"DataKeyPairSpec"`

The type of data key pair that was generated.

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

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

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

The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

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

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

PrivateKeyPlaintext is automatically base64 encoded/decoded by the SDK.

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

The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. PublicKey is automatically base64 encoded/decoded by the SDK.

_ struct{} `type:"structure"`

Method Details

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



11800
11801
11802

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

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

func (s GenerateDataKeyPairOutput) SetKeyId(v string) GenerateDataKeyPairOutput

SetKeyId sets the KeyId field's value.

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

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

func (s GenerateDataKeyPairOutput) SetKeyPairSpec(v string) GenerateDataKeyPairOutput

SetKeyPairSpec sets the KeyPairSpec field's value.

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

func (s *GenerateDataKeyPairOutput) SetKeyPairSpec(v string) *GenerateDataKeyPairOutput {
	s.KeyPairSpec = &v
	return s
}

func (s GenerateDataKeyPairOutput) SetPrivateKeyCiphertextBlob(v []byte) GenerateDataKeyPairOutput

SetPrivateKeyCiphertextBlob sets the PrivateKeyCiphertextBlob field's value.

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

func (s *GenerateDataKeyPairOutput) SetPrivateKeyCiphertextBlob(v []byte) *GenerateDataKeyPairOutput {
	s.PrivateKeyCiphertextBlob = v
	return s
}

func (s GenerateDataKeyPairOutput) SetPrivateKeyPlaintext(v []byte) GenerateDataKeyPairOutput

SetPrivateKeyPlaintext sets the PrivateKeyPlaintext field's value.

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

func (s *GenerateDataKeyPairOutput) SetPrivateKeyPlaintext(v []byte) *GenerateDataKeyPairOutput {
	s.PrivateKeyPlaintext = v
	return s
}

func (s GenerateDataKeyPairOutput) SetPublicKey(v []byte) GenerateDataKeyPairOutput

SetPublicKey sets the PublicKey field's value.

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

func (s *GenerateDataKeyPairOutput) SetPublicKey(v []byte) *GenerateDataKeyPairOutput {
	s.PublicKey = v
	return s
}

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



11791
11792
11793

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

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