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.MacieV2.Types.RevealConfiguration

Description

Synopsis

data RevealConfiguration = RevealConfiguration' {
- kmsKeyId :: Maybe Text
- status :: RevealStatus
}
newRevealConfiguration :: RevealStatus -> RevealConfiguration
revealConfiguration_kmsKeyId :: Lens' RevealConfiguration (Maybe Text)
revealConfiguration_status :: Lens' RevealConfiguration RevealStatus

Documentation

data RevealConfiguration Source #

Specifies the configuration settings for retrieving occurrences of sensitive data reported by findings, and the status of the configuration for an Amazon Macie account. When you enable the configuration for the first time, your request must specify an Key Management Service (KMS) key. Otherwise, an error occurs. Macie uses the specified key to encrypt the sensitive data that you retrieve.

See: newRevealConfiguration smart constructor.

Constructors

RevealConfiguration'

Fields

kmsKeyId :: Maybe Text
The Amazon Resource Name (ARN), ID, or alias of the KMS key to use to encrypt sensitive data that's retrieved. The key must be an existing, customer managed, symmetric encryption key that's in the same Amazon Web Services Region as the Amazon Macie account.
If this value specifies an alias, it must include the following prefix: alias/. If this value specifies a key that's owned by another Amazon Web Services account, it must specify the ARN of the key or the ARN of the key's alias.
status :: RevealStatus
The status of the configuration for the Amazon Macie account. In a request, valid values are: ENABLED, enable the configuration for the account; and, DISABLED, disable the configuration for the account. In a response, possible values are: ENABLED, the configuration is currently enabled for the account; and, DISABLED, the configuration is currently disabled for the account.

Instances

Instances details

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

newRevealConfiguration Source #

Arguments

:: RevealStatus	`$sel:status:RevealConfiguration'`
-> RevealConfiguration

Create a value of RevealConfiguration 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:RevealConfiguration', revealConfiguration_kmsKeyId - The Amazon Resource Name (ARN), ID, or alias of the KMS key to use to encrypt sensitive data that's retrieved. The key must be an existing, customer managed, symmetric encryption key that's in the same Amazon Web Services Region as the Amazon Macie account.

If this value specifies an alias, it must include the following prefix: alias/. If this value specifies a key that's owned by another Amazon Web Services account, it must specify the ARN of the key or the ARN of the key's alias.

$sel:status:RevealConfiguration', revealConfiguration_status - The status of the configuration for the Amazon Macie account. In a request, valid values are: ENABLED, enable the configuration for the account; and, DISABLED, disable the configuration for the account. In a response, possible values are: ENABLED, the configuration is currently enabled for the account; and, DISABLED, the configuration is currently disabled for the account.

revealConfiguration_kmsKeyId :: Lens' RevealConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN), ID, or alias of the KMS key to use to encrypt sensitive data that's retrieved. The key must be an existing, customer managed, symmetric encryption key that's in the same Amazon Web Services Region as the Amazon Macie account.

If this value specifies an alias, it must include the following prefix: alias/. If this value specifies a key that's owned by another Amazon Web Services account, it must specify the ARN of the key or the ARN of the key's alias.

revealConfiguration_status :: Lens' RevealConfiguration RevealStatus Source #

The status of the configuration for the Amazon Macie account. In a request, valid values are: ENABLED, enable the configuration for the account; and, DISABLED, disable the configuration for the account. In a response, possible values are: ENABLED, the configuration is currently enabled for the account; and, DISABLED, the configuration is currently disabled for the account.