AWS::SecurityHub::AutomationRuleV2

Creates a V2 automation rule. This API is in public preview and subject to change.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SecurityHub::AutomationRuleV2",
  "Properties" : {
      "Actions" : [ AutomationRulesActionV2, ... ],
      "Criteria" : Criteria,
      "Description" : String,
      "RuleName" : String,
      "RuleOrder" : Number,
      "RuleStatus" : String,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::SecurityHub::AutomationRuleV2
Properties:
  Actions: 
    - AutomationRulesActionV2
  Criteria: 
    Criteria
  Description: String
  RuleName: String
  RuleOrder: Number
  RuleStatus: String
  Tags: 
    Key: Value

Properties

Actions

A list of actions to be performed when the rule criteria is met.

Required: Yes

Type: Array of AutomationRulesActionV2

Minimum: 1

Maximum: 1

Update requires: No interruption

Criteria

The filtering type and configuration of the automation rule.

Required: Yes

Type: Criteria

Update requires: No interruption

Description

A description of the V2 automation rule.

Required: Yes

Type: String

Pattern: .*\S.*

Minimum: 1

Maximum: 256

Update requires: No interruption

RuleName

The name of the V2 automation rule.

Required: Yes

Type: String

Pattern: .*\S.*

Minimum: 1

Maximum: 256

Update requires: No interruption

RuleOrder

The value for the rule priority.

Required: Yes

Type: Number

Minimum: 1

Maximum: 1000

Update requires: No interruption

RuleStatus

The status of the V2 automation rule.

Required: No

Type: String

Allowed values: ENABLED | DISABLED

Update requires: No interruption

Tags

A list of key-value pairs associated with the V2 automation rule.

Required: No

Type: Object of String

Pattern: ^(?!aws:)[a-zA-Z+-=._:/]{1,128}$

Minimum: 0

Maximum: 256

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the AutomationRuleV2Arn for the AutomationRuleV2Arn resource created: arn:aws:securityhub:region:123456789012:automationrulev2/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The timestamp when the V2 automation rule was created.

RuleArn

The ARN of the V2 automation rule.

RuleId

The ID of the V2 automation rule.

UpdatedAt

The timestamp when the V2 automation rule was updated.