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

Class: Aws::MQ::Types::EncryptionOptions

Inherits:

Struct

Object
Struct
Aws::MQ::Types::EncryptionOptions

show all

Defined in:: (unknown)

Overview

Note:

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

{
  kms_key_id: "__string",
  use_aws_owned_key: false, # required
}

Encryption options for the broker.

Returned by:

Instance Attribute Summary collapse

#kms_key_id ⇒ String
The symmetric customer master key (CMK) to use for the AWS Key Management Service (KMS).
#use_aws_owned_key ⇒ Boolean
Enables the use of an AWS owned CMK using AWS Key Management Service (KMS).

Instance Attribute Details

#kms_key_id ⇒ `String`

The symmetric customer master key (CMK) to use for the AWS Key Management Service (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.

Returns:

(String) —
The symmetric customer master key (CMK) to use for the AWS Key Management Service (KMS).

#use_aws_owned_key ⇒ `Boolean`

Enables the use of an AWS owned CMK using AWS Key Management Service (KMS).