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.AuditManager.Types.SourceKeyword

Description

Documentation

data SourceKeyword Source #

The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.

To learn more about the supported keywords that you can use when mapping a control data source, see the following pages in the /Audit Manager User Guide/:

See: newSourceKeyword smart constructor.

Constructors

SourceKeyword'

Fields

keywordInputType :: Maybe KeywordInputType
The input method for the keyword.
keywordValue :: Maybe Text
The value of the keyword that's used when mapping a control data source. For example, this can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call.
If you’re mapping a data source to a rule in Config, the keywordValue that you specify depends on the type of rule:
- For managed rules, you can use the rule identifier as the keywordValue. You can find the rule identifier from the list of Config managed rules.
  - Managed rule name: s3-bucket-acl-prohibited
    keywordValue: S3_BUCKET_ACL_PROHIBITED
- For custom rules, you form the keywordValue by adding the Custom_ prefix to the rule name. This prefix distinguishes the rule from a managed rule.
  - Custom rule name: my-custom-config-rule
    keywordValue: Custom_my-custom-config-rule
- For service-linked rules, you form the keywordValue by adding the Custom_ prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name.
  - Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w
    keywordValue: Custom_CustomRuleForAccount-conformance-pack
  - Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba
    keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled

Instances

Instances details

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

newSourceKeyword :: SourceKeyword Source #

Create a value of SourceKeyword 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:keywordInputType:SourceKeyword', sourceKeyword_keywordInputType - The input method for the keyword.

$sel:keywordValue:SourceKeyword', sourceKeyword_keywordValue - The value of the keyword that's used when mapping a control data source. For example, this can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call.

If you’re mapping a data source to a rule in Config, the keywordValue that you specify depends on the type of rule:

For managed rules, you can use the rule identifier as the keywordValue. You can find the rule identifier from the list of Config managed rules.
- Managed rule name: s3-bucket-acl-prohibited
  keywordValue: S3_BUCKET_ACL_PROHIBITED
For custom rules, you form the keywordValue by adding the Custom_ prefix to the rule name. This prefix distinguishes the rule from a managed rule.
- Custom rule name: my-custom-config-rule
  keywordValue: Custom_my-custom-config-rule
For service-linked rules, you form the keywordValue by adding the Custom_ prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name.
- Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w
  keywordValue: Custom_CustomRuleForAccount-conformance-pack
- Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba
  keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled

sourceKeyword_keywordInputType :: Lens' SourceKeyword (Maybe KeywordInputType) Source #

The input method for the keyword.

sourceKeyword_keywordValue :: Lens' SourceKeyword (Maybe Text) Source #

The value of the keyword that's used when mapping a control data source. For example, this can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call.

If you’re mapping a data source to a rule in Config, the keywordValue that you specify depends on the type of rule:

For managed rules, you can use the rule identifier as the keywordValue. You can find the rule identifier from the list of Config managed rules.
- Managed rule name: s3-bucket-acl-prohibited
  keywordValue: S3_BUCKET_ACL_PROHIBITED
For custom rules, you form the keywordValue by adding the Custom_ prefix to the rule name. This prefix distinguishes the rule from a managed rule.
- Custom rule name: my-custom-config-rule
  keywordValue: Custom_my-custom-config-rule
For service-linked rules, you form the keywordValue by adding the Custom_ prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name.
- Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w
  keywordValue: Custom_CustomRuleForAccount-conformance-pack
- Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba
  keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled