GetAutomationRuleResult

data class GetAutomationRuleResult(val actions: List<AutomationRulesAction>? = null, val createdAt: String? = null, val createdBy: String? = null, val criteria: AutomationRulesFindingFilters? = null, val description: String? = null, val isTerminal: Boolean? = null, val ruleArn: String? = null, val ruleName: String? = null, val ruleOrder: Int? = null, val ruleStatus: AutomationRuleRuleStatus? = null, val tags: Map<String, String>? = null, val updatedAt: String? = null)

Constructors

Link copied to clipboard
constructor(actions: List<AutomationRulesAction>? = null, createdAt: String? = null, createdBy: String? = null, criteria: AutomationRulesFindingFilters? = null, description: String? = null, isTerminal: Boolean? = null, ruleArn: String? = null, ruleName: String? = null, ruleOrder: Int? = null, ruleStatus: AutomationRuleRuleStatus? = null, tags: Map<String, String>? = null, updatedAt: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

One or more actions to update finding fields if a finding matches the conditions specified in `Criteria`.

Link copied to clipboard
val createdAt: String? = null

A timestamp that indicates when the rule was created. Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z .

Link copied to clipboard
val createdBy: String? = null

The principal that created the rule. For example, arn:aws:sts::123456789012:assumed-role/Developer-Role/JaneDoe .

Link copied to clipboard

A set of Security Finding Format (ASFF) 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.

Link copied to clipboard
val description: String? = null

A description of the rule.

Link copied to clipboard
val isTerminal: Boolean? = null

Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.

Link copied to clipboard
val ruleArn: String? = null

The Amazon Resource Name (ARN) of the automation rule that you create. For example, arn:aws:securityhub:us-east-1:123456789012:automation-rule/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 .

Link copied to clipboard
val ruleName: String? = null

The name of the rule.

Link copied to clipboard
val ruleOrder: Int? = null

An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.

Link copied to clipboard

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

Link copied to clipboard
val tags: Map<String, String>? = null

User-defined tags associated with an automation rule.

Link copied to clipboard
val updatedAt: String? = null

A timestamp that indicates when the rule was most recently updated. Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z .