Class: Aws::KMS::Types::EncapsulateRequest

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::EncapsulateRequest

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 generate the shared secret and its encapsulated form.

• #grant_tokens ⇒ Array<String>

  A list of grant tokens.

• #key_id ⇒ String

  Identifies an asymmetric ML-KEM KMS key.

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 2631

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

#encapsulation_algorithm ⇒ String

Specifies the key encapsulation algorithm used to generate the shared secret and its encapsulated form. The only valid value is ML_KEM.

Returns:

• (String)

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

class EncapsulateRequest < Struct.new(
  :key_id,
  :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 2631

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

#key_id ⇒ String

Identifies an asymmetric ML-KEM KMS key. KMS uses the public key in the specified key pair to encapsulate the shared secret. ML-KEM KMS keys have a KeySpec value of ML_KEM_512, ML_KEM_768, or ML_KEM_1024 and a KeyUsage value of ENCAPSULATE_DECAPSULATE. To find the KeySpec and KeyUsage of a 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.

Returns:

• (String)

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

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