Class: Aws::XRay::Types::PutEncryptionConfigRequest

Inherits:

Struct

Object
Struct
Aws::XRay::Types::PutEncryptionConfigRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-xray/types.rb

Overview

Note:

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

{
  key_id: "EncryptionKeyId",
  type: "NONE", # required, accepts NONE, KMS
}

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#key_id ⇒ String

An Amazon Web Services KMS key in one of the following formats:.
#type ⇒ String

The type of encryption.

Instance Attribute Details

#key_id ⇒ `String`

An Amazon Web Services KMS key in one of the following formats:

Alias - The name of the key. For example, ‘alias/MyKey`.
**Key ID** - The KMS key ID of the key. For example, ‘ae4aa6d49-a4d8-9df9-a475-4ff6d7898456`. Amazon Web Services X-Ray does not support asymmetric KMS keys.
ARN - The full Amazon Resource Name of the key ID or alias. For example, ‘arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456`. Use this format to specify a key in a different account.

Omit this key if you set ‘Type` to `NONE`.

Returns:

(String)

# File 'lib/aws-sdk-xray/types.rb', line 2079

class PutEncryptionConfigRequest < Struct.new(
  :key_id,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ `String`

The type of encryption. Set to ‘KMS` to use your own key for encryption. Set to `NONE` for default encryption.