Skip to main content

automation_rule_tags

Expands all tag keys and values for automation_rules in a region

Overview

Nameautomation_rule_tags
TypeResource
DescriptionThe AWS::SecurityHub::AutomationRule resource specifies an automation rule based on input parameters. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*.
Idaws.securityhub.automation_rule_tags

Fields

NameDatatypeDescription
rule_arnstring
rule_statusstringWhether the rule is active after it is created. If this parameter is equal to ENABLED, ASH applies the rule to findings and finding updates after the rule is created.
rule_orderinteger
descriptionstring
rule_namestring
created_atstringThe date and time, in UTC and ISO 8601 format.
updated_atstringThe date and time, in UTC and ISO 8601 format.
created_bystring
is_terminalboolean
actionsarray
criteriaobjectA set of [Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that ASH uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, ASH applies the rule action to the finding.
tag_keystringTag key.
tag_valuestringTag value.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Expands tags for all automation_rules in a region.

SELECT
region,
rule_arn,
rule_status,
rule_order,
description,
rule_name,
created_at,
updated_at,
created_by,
is_terminal,
actions,
criteria,
tag_key,
tag_value
FROM aws.securityhub.automation_rule_tags
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the automation_rule_tags resource, see automation_rules