Class: Aws::KMS::Types::DecapsulateRequest

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::DecapsulateRequest

Defined in:

gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks if your request will succeed.

• #encapsulation_algorithm ⇒ String

  Specifies the key encapsulation algorithm used to recover the shared secret.

• #grant_tokens ⇒ Array<String>

  A list of grant tokens.

• #key_id ⇒ String

  Identifies the asymmetric ML-KEM KMS key whose public key was used to produce the encapsulated shared secret.

• #shared_secret_ciphertext_blob ⇒ String

  The encapsulated (ciphertext) form of the shared secret to recover.

Instance Attribute Details

#dry_run ⇒ Boolean

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your permissions in the Key Management Service Developer Guide.

Returns:

• (Boolean)

# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1690

class DecapsulateRequest < Struct.new(
  :key_id,
  :shared_secret_ciphertext_blob,
  :encapsulation_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#encapsulation_algorithm ⇒ String

Specifies the key encapsulation algorithm used to recover the shared secret. The only valid value is ML_KEM.

Returns:

• (String)

# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1690

class DecapsulateRequest < Struct.new(
  :key_id,
  :shared_secret_ciphertext_blob,
  :encapsulation_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#grant_tokens ⇒ Array<String>

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1690

class DecapsulateRequest < Struct.new(
  :key_id,
  :shared_secret_ciphertext_blob,
  :encapsulation_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#key_id ⇒ String

Identifies the asymmetric ML-KEM KMS key whose public key was used to produce the encapsulated shared secret. KMS uses the private key in the specified key pair to decapsulate the shared secret.

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.

Returns:

• (String)

# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1690

class DecapsulateRequest < Struct.new(
  :key_id,
  :shared_secret_ciphertext_blob,
  :encapsulation_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#shared_secret_ciphertext_blob ⇒ String

The encapsulated (ciphertext) form of the shared secret to recover. This is the SharedSecretCiphertextBlob value that the Encapsulate operation returns. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Returns:

• (String)

# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1690

class DecapsulateRequest < Struct.new(
  :key_id,
  :shared_secret_ciphertext_blob,
  :encapsulation_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end