Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MQ.Types.EncryptionOptions

Description

Synopsis

data EncryptionOptions = EncryptionOptions' {
- kmsKeyId :: Maybe Text
- useAwsOwnedKey :: Bool
}
newEncryptionOptions :: Bool -> EncryptionOptions
encryptionOptions_kmsKeyId :: Lens' EncryptionOptions (Maybe Text)
encryptionOptions_useAwsOwnedKey :: Lens' EncryptionOptions Bool

Documentation

data EncryptionOptions Source #

Does not apply to RabbitMQ brokers.

Encryption options for the broker.

See: newEncryptionOptions smart constructor.

Constructors

EncryptionOptions'

Fields

kmsKeyId :: Maybe Text
The 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.
useAwsOwnedKey :: Bool
Enables the use of an AWS owned CMK using AWS Key Management Service (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.

Instances

Instances details

FromJSON EncryptionOptions Source #
Instance details Defined in Amazonka.MQ.Types.EncryptionOptions Methods parseJSON :: Value -> Parser EncryptionOptions # parseJSONList :: Value -> Parser [EncryptionOptions] #
ToJSON EncryptionOptions Source #
Instance details Defined in Amazonka.MQ.Types.EncryptionOptions Methods toJSON :: EncryptionOptions -> Value # toEncoding :: EncryptionOptions -> Encoding # toJSONList :: [EncryptionOptions] -> Value # toEncodingList :: [EncryptionOptions] -> Encoding #
Generic EncryptionOptions Source #
Instance details Defined in Amazonka.MQ.Types.EncryptionOptions Associated Types type Rep EncryptionOptions :: Type -> Type # Methods from :: EncryptionOptions -> Rep EncryptionOptions x # to :: Rep EncryptionOptions x -> EncryptionOptions #
Read EncryptionOptions Source #
Instance details Defined in Amazonka.MQ.Types.EncryptionOptions Methods readsPrec :: Int -> ReadS EncryptionOptions # readList :: ReadS [EncryptionOptions] # readPrec :: ReadPrec EncryptionOptions # readListPrec :: ReadPrec [EncryptionOptions] #
Show EncryptionOptions Source #
Instance details Defined in Amazonka.MQ.Types.EncryptionOptions Methods showsPrec :: Int -> EncryptionOptions -> ShowS # show :: EncryptionOptions -> String # showList :: [EncryptionOptions] -> ShowS #
NFData EncryptionOptions Source #
Instance details Defined in Amazonka.MQ.Types.EncryptionOptions Methods rnf :: EncryptionOptions -> () #
Eq EncryptionOptions Source #
Instance details Defined in Amazonka.MQ.Types.EncryptionOptions Methods (==) :: EncryptionOptions -> EncryptionOptions -> Bool # (/=) :: EncryptionOptions -> EncryptionOptions -> Bool #
Hashable EncryptionOptions Source #
Instance details Defined in Amazonka.MQ.Types.EncryptionOptions Methods hashWithSalt :: Int -> EncryptionOptions -> Int # hash :: EncryptionOptions -> Int #
type Rep EncryptionOptions Source #
Instance details Defined in Amazonka.MQ.Types.EncryptionOptions type Rep EncryptionOptions = D1 ('MetaData "EncryptionOptions" "Amazonka.MQ.Types.EncryptionOptions" "amazonka-mq-2.0-3ebKNoK022m255Abw9OF0s" 'False) (C1 ('MetaCons "EncryptionOptions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "useAwsOwnedKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))

newEncryptionOptions Source #

Arguments

:: Bool	`$sel:useAwsOwnedKey:EncryptionOptions'`
-> EncryptionOptions

Create a value of EncryptionOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:kmsKeyId:EncryptionOptions', encryptionOptions_kmsKeyId - The 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.

$sel:useAwsOwnedKey:EncryptionOptions', encryptionOptions_useAwsOwnedKey - Enables the use of an AWS owned CMK using AWS Key Management Service (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.

encryptionOptions_kmsKeyId :: Lens' EncryptionOptions (Maybe Text) Source #

The 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.

encryptionOptions_useAwsOwnedKey :: Lens' EncryptionOptions Bool Source #

Enables the use of an AWS owned CMK using AWS Key Management Service (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.