Class: Aws::KMS::Types::EncryptRequest

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::EncryptRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kms/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:plaintext]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks if your request will succeed.

• #encryption_algorithm ⇒ String

  Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.

• #encryption_context ⇒ Hash<String,String>

  Specifies the encryption context that will be used to encrypt the data.

• #grant_tokens ⇒ Array<String>

  A list of grant tokens.

• #key_id ⇒ String

  Identifies the KMS key to use in the encryption operation.

• #plaintext ⇒ String

  Data to be encrypted.

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 KMS API calls] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html

Returns:

• (Boolean)

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

class EncryptRequest < Struct.new(
  :key_id,
  :plaintext,
  :encryption_context,
  :grant_tokens,
  :encryption_algorithm,
  :dry_run)
  SENSITIVE = [:plaintext]
  include Aws::Structure
end

#encryption_algorithm ⇒ String

Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm must be compatible with the KMS key that you specify.

This parameter is required only for asymmetric KMS keys. The default value, ‘SYMMETRIC_DEFAULT`, is the algorithm used for symmetric encryption KMS keys. If you are using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.

The SM2PKE algorithm is only available in China Regions.

Returns:

• (String)

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

class EncryptRequest < Struct.new(
  :key_id,
  :plaintext,
  :encryption_context,
  :grant_tokens,
  :encryption_algorithm,
  :dry_run)
  SENSITIVE = [:plaintext]
  include Aws::Structure
end

#encryption_context ⇒ Hash<String,String>

Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for [cryptographic operations] with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

An *encryption context* is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see [Encryption context] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations [2]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context

Returns:

• (Hash<String,String>)

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

class EncryptRequest < Struct.new(
  :key_id,
  :plaintext,
  :encryption_context,
  :grant_tokens,
  :encryption_algorithm,
  :dry_run)
  SENSITIVE = [:plaintext]
  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*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token [2]: docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token

Returns:

• (Array<String>)

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

class EncryptRequest < Struct.new(
  :key_id,
  :plaintext,
  :encryption_context,
  :grant_tokens,
  :encryption_algorithm,
  :dry_run)
  SENSITIVE = [:plaintext]
  include Aws::Structure
end

#key_id ⇒ String

Identifies the KMS key to use in the encryption operation. The KMS key must have a ‘KeyUsage` of `ENCRYPT_DECRYPT`. To find the `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 'lib/aws-sdk-kms/types.rb', line 2372

class EncryptRequest < Struct.new(
  :key_id,
  :plaintext,
  :encryption_context,
  :grant_tokens,
  :encryption_algorithm,
  :dry_run)
  SENSITIVE = [:plaintext]
  include Aws::Structure
end

#plaintext ⇒ String

Data to be encrypted.

Returns:

• (String)

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

class EncryptRequest < Struct.new(
  :key_id,
  :plaintext,
  :encryption_context,
  :grant_tokens,
  :encryption_algorithm,
  :dry_run)
  SENSITIVE = [:plaintext]
  include Aws::Structure
end