Class: Aws::KMS::Types::EncryptRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::KMS::Types::EncryptRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-kms/types.rb
Overview
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
-
#encryption_context ⇒ Hash<String,String>
Name-value pair that specifies the encryption context to be used for authenticated encryption.
-
#grant_tokens ⇒ Array<String>
A list of grant tokens.
-
#key_id ⇒ String
A unique identifier for the customer master key (CMK).
-
#plaintext ⇒ String
Data to be encrypted.
Instance Attribute Details
#encryption_context ⇒ Hash<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].
[1]: docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html
776 777 778 779 780 781 782 |
# File 'lib/aws-sdk-kms/types.rb', line 776 class EncryptRequest < Struct.new( :key_id, :plaintext, :encryption_context, :grant_tokens) include Aws::Structure end |
#grant_tokens ⇒ Array<String>
A list of grant tokens.
For more information, see [Grant Tokens] in the *AWS Key Management Service Developer Guide*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token
776 777 778 779 780 781 782 |
# File 'lib/aws-sdk-kms/types.rb', line 776 class EncryptRequest < Struct.new( :key_id, :plaintext, :encryption_context, :grant_tokens) include Aws::Structure end |
#key_id ⇒ String
A unique identifier for the customer master key (CMK).
To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with ‘“alias/”`. To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
776 777 778 779 780 781 782 |
# File 'lib/aws-sdk-kms/types.rb', line 776 class EncryptRequest < Struct.new( :key_id, :plaintext, :encryption_context, :grant_tokens) include Aws::Structure end |
#plaintext ⇒ String
Data to be encrypted.
776 777 778 779 780 781 782 |
# File 'lib/aws-sdk-kms/types.rb', line 776 class EncryptRequest < Struct.new( :key_id, :plaintext, :encryption_context, :grant_tokens) include Aws::Structure end |