You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass EncryptRequest data as a hash:

{
  key_id: "KeyIdType", # required
  plaintext: "data", # required
  encryption_context: {
    "EncryptionContextKey" => "EncryptionContextValue",
  },
  grant_tokens: ["GrantTokenType"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_contextHash<String,String>

Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt API or decryption will fail. For more information, see Encryption Context.

Returns:

  • (Hash<String,String>)


721
722
723
724
725
726
727
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 721

class EncryptRequest < Struct.new(
  :key_id,
  :plaintext,
  :encryption_context,
  :grant_tokens)
  include Aws::Structure
end

#grant_tokensArray<String>

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

  • (Array<String>)


721
722
723
724
725
726
727
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 721

class EncryptRequest < Struct.new(
  :key_id,
  :plaintext,
  :encryption_context,
  :grant_tokens)
  include Aws::Structure
end

#key_idString

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

  • Alias Name Example - alias/MyAliasName

Returns:

  • (String)


721
722
723
724
725
726
727
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 721

class EncryptRequest < Struct.new(
  :key_id,
  :plaintext,
  :encryption_context,
  :grant_tokens)
  include Aws::Structure
end

#plaintextString

Data to be encrypted.

Returns:

  • (String)


721
722
723
724
725
726
727
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 721

class EncryptRequest < Struct.new(
  :key_id,
  :plaintext,
  :encryption_context,
  :grant_tokens)
  include Aws::Structure
end