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)


1968
1969
1970
1971
1972
1973
1974
1975
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1968

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>)


1968
1969
1970
1971
1972
1973
1974
1975
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1968

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 to use to reencrypt the data. 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)


1968
1969
1970
1971
1972
1973
1974
1975
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1968

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>)


1968
1969
1970
1971
1972
1973
1974
1975
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1968

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>)


1968
1969
1970
1971
1972
1973
1974
1975
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 1968

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