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

Inherits:

Struct

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

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
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #key_id ⇒ String

  An AWS KMS customer master key (CMK) in one of the following formats:.

• #type ⇒ String

  The type of encryption.

Instance Attribute Details

#key_id ⇒ String

An AWS KMS customer master key (CMK) 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`.

• 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 1158

class PutEncryptionConfigRequest < Struct.new(
  :key_id,
  :type)
  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.

Returns:

• (String)

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

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