Class: Aws::AuditManager::Types::SourceKeyword

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-auditmanager/types.rb

Overview

Note:

When making an API call, you may pass SourceKeyword data as a hash:

{
  keyword_input_type: "SELECT_FROM_LIST", # accepts SELECT_FROM_LIST
  keyword_value: "KeywordValue",
}

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*:

  • Config rules supported by Audit Manager][1
  • Security Hub controls supported by Audit Manager][2
  • API calls supported by Audit Manager][3
  • CloudTrail event names supported by Audit Manager][4

[1]: docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html [2]: docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html [3]: docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html [4]: docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-cloudtrail.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#keyword_input_type ⇒ String

The input method for the keyword.

Returns:

  • (String) 


4593
4594
4595
4596
4597
4598
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 4593

class SourceKeyword < Struct.new(
  :keyword_input_type,
  :keyword_value)
  SENSITIVE = []
  include Aws::Structure
end

#keyword_value ⇒ String

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

  • 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`

[1]: docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html [2]: docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html [3]: docs.aws.amazon.com/config/latest/developerguide/s3-bucket-acl-prohibited.html [4]: docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html [5]: docs.aws.amazon.com/config/latest/developerguide/service-linked-awsconfig-rules.html

Returns:

  • (String) 


4593
4594
4595
4596
4597
4598
 
# File 'lib/aws-sdk-auditmanager/types.rb', line 4593

class SourceKeyword < Struct.new(
  :keyword_input_type,
  :keyword_value)
  SENSITIVE = []
  include Aws::Structure
end