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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutEncryptionConfigRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

See Also:

Instance Attribute Summary collapse

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. AWS X-Ray does not support asymmetric CMKs.

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

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

#type ⇒ String

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

Possible values:

  • NONE
  • KMS

Returns:

  • (String) —

    The type of encryption.