Class: Aws::KMS::Types::DeriveSharedSecretResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[:shared_secret]

Instance Attribute Summary collapse

Instance Attribute Details

#ciphertext_for_recipientString

The plaintext shared secret encrypted with the public key in the attestation document.

This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

Returns:

  • (String)


1944
1945
1946
1947
1948
1949
1950
1951
1952
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1944

class DeriveSharedSecretResponse < Struct.new(
  :key_id,
  :shared_secret,
  :ciphertext_for_recipient,
  :key_agreement_algorithm,
  :key_origin)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end

#key_agreement_algorithmString

Identifies the key agreement algorithm used to derive the shared secret.

Returns:

  • (String)


1944
1945
1946
1947
1948
1949
1950
1951
1952
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1944

class DeriveSharedSecretResponse < Struct.new(
  :key_id,
  :shared_secret,
  :ciphertext_for_recipient,
  :key_agreement_algorithm,
  :key_origin)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end

#key_idString

Identifies the KMS key used to derive the shared secret.

Returns:

  • (String)


1944
1945
1946
1947
1948
1949
1950
1951
1952
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1944

class DeriveSharedSecretResponse < Struct.new(
  :key_id,
  :shared_secret,
  :ciphertext_for_recipient,
  :key_agreement_algorithm,
  :key_origin)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end

#key_originString

The source of the key material for the specified KMS key.

When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material.

The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.

Returns:

  • (String)


1944
1945
1946
1947
1948
1949
1950
1951
1952
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1944

class DeriveSharedSecretResponse < Struct.new(
  :key_id,
  :shared_secret,
  :ciphertext_for_recipient,
  :key_agreement_algorithm,
  :key_origin)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end

#shared_secretString

The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.

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

Returns:

  • (String)


1944
1945
1946
1947
1948
1949
1950
1951
1952
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1944

class DeriveSharedSecretResponse < Struct.new(
  :key_id,
  :shared_secret,
  :ciphertext_for_recipient,
  :key_agreement_algorithm,
  :key_origin)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end