Package software.amazon.awscdk.services.securityhub

Class CfnAutomationRuleV2

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.securityhub.CfnAutomationRuleV2

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IAutomationRuleV2Ref, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:45.460Z")
@Stability(Stable)
public class CfnAutomationRuleV2
extends CfnResource
implements IInspectable, IAutomationRuleV2Ref, ITaggableV2

Creates a V2 automation rule.

This API is in public preview and subject to change.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.securityhub.*;
 CfnAutomationRuleV2 cfnAutomationRuleV2 = CfnAutomationRuleV2.Builder.create(this, "MyCfnAutomationRuleV2")
         .actions(List.of(AutomationRulesActionV2Property.builder()
                 .type("type")
                 // the properties below are optional
                 .externalIntegrationConfiguration(ExternalIntegrationConfigurationProperty.builder()
                         .connectorArn("connectorArn")
                         .build())
                 .findingFieldsUpdate(AutomationRulesFindingFieldsUpdateV2Property.builder()
                         .comment("comment")
                         .severityId(123)
                         .statusId(123)
                         .build())
                 .build()))
         .criteria(CriteriaProperty.builder()
                 .ocsfFindingCriteria(OcsfFindingFiltersProperty.builder()
                         .compositeFilters(List.of(CompositeFilterProperty.builder()
                                 .booleanFilters(List.of(OcsfBooleanFilterProperty.builder()
                                         .fieldName("fieldName")
                                         .filter(BooleanFilterProperty.builder()
                                                 .value(false)
                                                 .build())
                                         .build()))
                                 .dateFilters(List.of(OcsfDateFilterProperty.builder()
                                         .fieldName("fieldName")
                                         .filter(DateFilterProperty.builder()
                                                 .dateRange(DateRangeProperty.builder()
                                                         .unit("unit")
                                                         .value(123)
                                                         .build())
                                                 .end("end")
                                                 .start("start")
                                                 .build())
                                         .build()))
                                 .mapFilters(List.of(OcsfMapFilterProperty.builder()
                                         .fieldName("fieldName")
                                         .filter(MapFilterProperty.builder()
                                                 .comparison("comparison")
                                                 .key("key")
                                                 .value("value")
                                                 .build())
                                         .build()))
                                 .numberFilters(List.of(OcsfNumberFilterProperty.builder()
                                         .fieldName("fieldName")
                                         .filter(NumberFilterProperty.builder()
                                                 .eq(123)
                                                 .gte(123)
                                                 .lte(123)
                                                 .build())
                                         .build()))
                                 .operator("operator")
                                 .stringFilters(List.of(OcsfStringFilterProperty.builder()
                                         .fieldName("fieldName")
                                         .filter(StringFilterProperty.builder()
                                                 .comparison("comparison")
                                                 .value("value")
                                                 .build())
                                         .build()))
                                 .build()))
                         .compositeOperator("compositeOperator")
                         .build())
                 .build())
         .description("description")
         .ruleName("ruleName")
         .ruleOrder(123)
         // the properties below are optional
         .ruleStatus("ruleStatus")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrulev2.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnAutomationRuleV2.AutomationRulesActionV2Property	Allows you to configure automated responses.
static interface	CfnAutomationRuleV2.AutomationRulesFindingFieldsUpdateV2Property	Allows you to define the structure for modifying specific fields in security findings.
static interface	CfnAutomationRuleV2.BooleanFilterProperty	Boolean filter for querying findings.
static final class	CfnAutomationRuleV2.Builder	A fluent builder for CfnAutomationRuleV2.
static interface	CfnAutomationRuleV2.CompositeFilterProperty	Enables the creation of filtering criteria for security findings.
static interface	CfnAutomationRuleV2.CriteriaProperty	The filtering type and configuration of the automation rule.
static interface	CfnAutomationRuleV2.DateFilterProperty	A date filter for querying findings.
static interface	CfnAutomationRuleV2.DateRangeProperty	A date range for the date filter.
static interface	CfnAutomationRuleV2.ExternalIntegrationConfigurationProperty	The settings for integrating automation rule actions with external systems or service.
static interface	CfnAutomationRuleV2.MapFilterProperty	A map filter for filtering Security Hub findings.
static interface	CfnAutomationRuleV2.NumberFilterProperty	A number filter for querying findings.
static interface	CfnAutomationRuleV2.OcsfBooleanFilterProperty	Enables filtering of security findings based on boolean field values in OCSF.
static interface	CfnAutomationRuleV2.OcsfDateFilterProperty	Enables filtering of security findings based on date and timestamp fields in OCSF.
static interface	CfnAutomationRuleV2.OcsfFindingFiltersProperty	Specifies the filtering criteria for security findings using OCSF.
static interface	CfnAutomationRuleV2.OcsfMapFilterProperty	Enables filtering of security findings based on map field values in OCSF.
static interface	CfnAutomationRuleV2.OcsfNumberFilterProperty	Enables filtering of security findings based on numerical field values in OCSF.
static interface	CfnAutomationRuleV2.OcsfStringFilterProperty	Enables filtering of security findings based on string field values in OCSF.
static interface	CfnAutomationRuleV2.StringFilterProperty	A string filter for filtering Security Hub findings.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.securityhub.IAutomationRuleV2Ref

IAutomationRuleV2Ref.Jsii$Default, IAutomationRuleV2Ref.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnAutomationRuleV2(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAutomationRuleV2(software.amazon.jsii.JsiiObjectRef objRef)
	CfnAutomationRuleV2(software.constructs.Construct scope, String id, CfnAutomationRuleV2Props props)	Create a new AWS::SecurityHub::AutomationRuleV2.

Method Summary

Modifier and Type	Method	Description
Object	getActions()	A list of actions to be performed when the rule criteria is met.
String	getAttrCreatedAt()	The timestamp when the V2 automation rule was created.
String	getAttrRuleArn()	The ARN of the V2 automation rule.
String	getAttrRuleId()	The ID of the V2 automation rule.
String	getAttrUpdatedAt()	The timestamp when the V2 automation rule was updated.
AutomationRuleV2Reference	getAutomationRuleV2Ref()	A reference to a AutomationRuleV2 resource.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
Object	getCriteria()	The filtering type and configuration of the automation rule.
String	getDescription()	A description of the V2 automation rule.
String	getRuleName()	The name of the V2 automation rule.
Number	getRuleOrder()	The value for the rule priority.
String	getRuleStatus()	The status of the V2 automation rule.
Map<String,String>	getTags()	A list of key-value pairs associated with the V2 automation rule.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnAutomationRuleV2(Object x)	Checks whether the given object is a CfnAutomationRuleV2.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActions(List<Object> value)	A list of actions to be performed when the rule criteria is met.
void	setActions(IResolvable value)	A list of actions to be performed when the rule criteria is met.
void	setCriteria(IResolvable value)	The filtering type and configuration of the automation rule.
void	setCriteria(CfnAutomationRuleV2.CriteriaProperty value)	The filtering type and configuration of the automation rule.
void	setDescription(String value)	A description of the V2 automation rule.
void	setRuleName(String value)	The name of the V2 automation rule.
void	setRuleOrder(Number value)	The value for the rule priority.
void	setRuleStatus(String value)	The status of the V2 automation rule.
void	setTags(Map<String,String> value)	A list of key-value pairs associated with the V2 automation rule.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnAutomationRuleV2

protected CfnAutomationRuleV2(software.amazon.jsii.JsiiObjectRef objRef)

CfnAutomationRuleV2

protected CfnAutomationRuleV2(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAutomationRuleV2

@Stability(Stable)
public CfnAutomationRuleV2(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnAutomationRuleV2Props props)

Create a new AWS::SecurityHub::AutomationRuleV2.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

isCfnAutomationRuleV2

@Stability(Stable)
@NotNull
public static Boolean isCfnAutomationRuleV2(@NotNull
 Object x)

Checks whether the given object is a CfnAutomationRuleV2.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

The timestamp when the V2 automation rule was created.

getAttrRuleArn

@Stability(Stable)
@NotNull
public String getAttrRuleArn()

The ARN of the V2 automation rule.

getAttrRuleId

@Stability(Stable)
@NotNull
public String getAttrRuleId()

The ID of the V2 automation rule.

getAttrUpdatedAt

@Stability(Stable)
@NotNull
public String getAttrUpdatedAt()

The timestamp when the V2 automation rule was updated.

getAutomationRuleV2Ref

@Stability(Stable)
@NotNull
public AutomationRuleV2Reference getAutomationRuleV2Ref()

A reference to a AutomationRuleV2 resource.

Specified by:

getAutomationRuleV2Ref in interface IAutomationRuleV2Ref

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getActions

@Stability(Stable)
@NotNull
public Object getActions()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAutomationRuleV2.AutomationRulesActionV2Property>

setActions

@Stability(Stable)
public void setActions(@NotNull
 IResolvable value)

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

setActions

@Stability(Stable)
public void setActions(@NotNull
 List<Object> value)

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

getCriteria

@Stability(Stable)
@NotNull
public Object getCriteria()

The filtering type and configuration of the automation rule.

Returns union: either IResolvable or CfnAutomationRuleV2.CriteriaProperty

setCriteria

@Stability(Stable)
public void setCriteria(@NotNull
 IResolvable value)

The filtering type and configuration of the automation rule.

setCriteria

@Stability(Stable)
public void setCriteria(@NotNull
 CfnAutomationRuleV2.CriteriaProperty value)

The filtering type and configuration of the automation rule.

getDescription

@Stability(Stable)
@NotNull
public String getDescription()

A description of the V2 automation rule.

setDescription

@Stability(Stable)
public void setDescription(@NotNull
 String value)

A description of the V2 automation rule.

getRuleName

@Stability(Stable)
@NotNull
public String getRuleName()

The name of the V2 automation rule.

setRuleName

@Stability(Stable)
public void setRuleName(@NotNull
 String value)

The name of the V2 automation rule.

getRuleOrder

@Stability(Stable)
@NotNull
public Number getRuleOrder()

The value for the rule priority.

setRuleOrder

@Stability(Stable)
public void setRuleOrder(@NotNull
 Number value)

The value for the rule priority.

getRuleStatus

@Stability(Stable)
@Nullable
public String getRuleStatus()

The status of the V2 automation rule.

setRuleStatus

@Stability(Stable)
public void setRuleStatus(@Nullable
 String value)

The status of the V2 automation rule.

getTags

@Stability(Stable)
@Nullable
public Map<String,String> getTags()

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

setTags

@Stability(Stable)
public void setTags(@Nullable
 Map<String,String> value)

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