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

Class: Aws::KMS::Types::ReEncryptRequest

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 ReEncryptRequest data as a hash:

{
  ciphertext_blob: "data", # required
  source_encryption_context: {
    "EncryptionContextKey" => "EncryptionContextValue",
  },
  destination_key_id: "KeyIdType", # required
  destination_encryption_context: {
    "EncryptionContextKey" => "EncryptionContextValue",
  },
  grant_tokens: ["GrantTokenType"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#ciphertext_blobString

Ciphertext of the data to reencrypt.

Returns:

  • (String)


2072
2073
2074
2075
2076
2077
2078
2079
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2072

class ReEncryptRequest < Struct.new(
  :ciphertext_blob,
  :source_encryption_context,
  :destination_key_id,
  :destination_encryption_context,
  :grant_tokens)
  include Aws::Structure
end

#destination_encryption_contextHash<String,String>

Encryption context to use when the data is reencrypted.

Returns:

  • (Hash<String,String>)


2072
2073
2074
2075
2076
2077
2078
2079
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2072

class ReEncryptRequest < Struct.new(
  :ciphertext_blob,
  :source_encryption_context,
  :destination_key_id,
  :destination_encryption_context,
  :grant_tokens)
  include Aws::Structure
end

#destination_key_idString

A unique identifier for the CMK that is used to reencrypt the data.

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.

Returns:

  • (String)


2072
2073
2074
2075
2076
2077
2078
2079
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2072

class ReEncryptRequest < Struct.new(
  :ciphertext_blob,
  :source_encryption_context,
  :destination_key_id,
  :destination_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>)


2072
2073
2074
2075
2076
2077
2078
2079
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2072

class ReEncryptRequest < Struct.new(
  :ciphertext_blob,
  :source_encryption_context,
  :destination_key_id,
  :destination_encryption_context,
  :grant_tokens)
  include Aws::Structure
end

#source_encryption_contextHash<String,String>

Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

Returns:

  • (Hash<String,String>)


2072
2073
2074
2075
2076
2077
2078
2079
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2072

class ReEncryptRequest < Struct.new(
  :ciphertext_blob,
  :source_encryption_context,
  :destination_key_id,
  :destination_encryption_context,
  :grant_tokens)
  include Aws::Structure
end