Package software.amazon.awscdk.services.securityhub

Class CfnAutomationRule

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:56:05.979Z")
@Stability(Stable)
public class CfnAutomationRule
extends CfnResource
implements IInspectable, ITaggableV2

The AWS::SecurityHub::AutomationRule resource specifies an automation rule based on input parameters.

For more information, see Automation rules in the AWS Security Hub User Guide .

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.*;
 Object id;
 Object updatedBy;
 CfnAutomationRule cfnAutomationRule = CfnAutomationRule.Builder.create(this, "MyCfnAutomationRule")
         .actions(List.of(AutomationRulesActionProperty.builder()
                 .findingFieldsUpdate(AutomationRulesFindingFieldsUpdateProperty.builder()
                         .confidence(123)
                         .criticality(123)
                         .note(NoteUpdateProperty.builder()
                                 .text("text")
                                 .updatedBy(updatedBy)
                                 .build())
                         .relatedFindings(List.of(RelatedFindingProperty.builder()
                                 .id(id)
                                 .productArn("productArn")
                                 .build()))
                         .severity(SeverityUpdateProperty.builder()
                                 .label("label")
                                 .normalized(123)
                                 .product(123)
                                 .build())
                         .types(List.of("types"))
                         .userDefinedFields(Map.of(
                                 "userDefinedFieldsKey", "userDefinedFields"))
                         .verificationState("verificationState")
                         .workflow(WorkflowUpdateProperty.builder()
                                 .status("status")
                                 .build())
                         .build())
                 .type("type")
                 .build()))
         .criteria(AutomationRulesFindingFiltersProperty.builder()
                 .awsAccountId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .companyName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .complianceAssociatedStandardsId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .complianceSecurityControlId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .complianceStatus(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .confidence(List.of(NumberFilterProperty.builder()
                         .eq(123)
                         .gte(123)
                         .lte(123)
                         .build()))
                 .createdAt(List.of(DateFilterProperty.builder()
                         .dateRange(DateRangeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .end("end")
                         .start("start")
                         .build()))
                 .criticality(List.of(NumberFilterProperty.builder()
                         .eq(123)
                         .gte(123)
                         .lte(123)
                         .build()))
                 .description(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .firstObservedAt(List.of(DateFilterProperty.builder()
                         .dateRange(DateRangeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .end("end")
                         .start("start")
                         .build()))
                 .generatorId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .id(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .lastObservedAt(List.of(DateFilterProperty.builder()
                         .dateRange(DateRangeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .end("end")
                         .start("start")
                         .build()))
                 .noteText(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .noteUpdatedAt(List.of(DateFilterProperty.builder()
                         .dateRange(DateRangeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .end("end")
                         .start("start")
                         .build()))
                 .noteUpdatedBy(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .productArn(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .productName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .recordState(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .relatedFindingsId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .relatedFindingsProductArn(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceDetailsOther(List.of(MapFilterProperty.builder()
                         .comparison("comparison")
                         .key("key")
                         .value("value")
                         .build()))
                 .resourceId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourcePartition(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceRegion(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceTags(List.of(MapFilterProperty.builder()
                         .comparison("comparison")
                         .key("key")
                         .value("value")
                         .build()))
                 .resourceType(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .severityLabel(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .sourceUrl(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .title(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .type(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .updatedAt(List.of(DateFilterProperty.builder()
                         .dateRange(DateRangeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .end("end")
                         .start("start")
                         .build()))
                 .userDefinedFields(List.of(MapFilterProperty.builder()
                         .comparison("comparison")
                         .key("key")
                         .value("value")
                         .build()))
                 .verificationState(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .workflowStatus(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .build())
         .description("description")
         .ruleName("ruleName")
         .ruleOrder(123)
         // the properties below are optional
         .isTerminal(false)
         .ruleStatus("ruleStatus")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnAutomationRule.AutomationRulesActionProperty	One or more actions that AWS Security Hub takes when a finding matches the defined criteria of a rule.
static interface	CfnAutomationRule.AutomationRulesFindingFieldsUpdateProperty	Identifies the finding fields that the automation rule action updates when a finding matches the defined criteria.
static interface	CfnAutomationRule.AutomationRulesFindingFiltersProperty	The criteria that determine which findings a rule applies to.
static final class	CfnAutomationRule.Builder	A fluent builder for CfnAutomationRule.
static interface	CfnAutomationRule.DateFilterProperty	A date filter for querying findings.
static interface	CfnAutomationRule.DateRangeProperty	A date range for the date filter.
static interface	CfnAutomationRule.MapFilterProperty	A map filter for filtering AWS Security Hub findings.
static interface	CfnAutomationRule.NoteUpdateProperty	The updated note.
static interface	CfnAutomationRule.NumberFilterProperty	A number filter for querying findings.
static interface	CfnAutomationRule.RelatedFindingProperty	Provides details about a list of findings that the current finding relates to.
static interface	CfnAutomationRule.SeverityUpdateProperty	Updates to the severity information for a finding.
static interface	CfnAutomationRule.StringFilterProperty	A string filter for filtering AWS Security Hub findings.
static interface	CfnAutomationRule.WorkflowUpdateProperty	Used to update information about the investigation into the finding.

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

software.amazon.jsii.JsiiObject.InitializationMode

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	CfnAutomationRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAutomationRule(software.amazon.jsii.JsiiObjectRef objRef)
	CfnAutomationRule(software.constructs.Construct scope, String id, CfnAutomationRuleProps props)

Method Summary

Modifier and Type	Method	Description
Object	getActions()	One or more actions to update finding fields if a finding matches the conditions specified in Criteria .
String	getAttrCreatedAt()	A timestamp that indicates when the rule was created.
String	getAttrCreatedBy()	The principal that created the rule.
String	getAttrRuleArn()	The Amazon Resource Name (ARN) of the automation rule that you create.
String	getAttrUpdatedAt()	A timestamp that indicates when the rule was most recently updated.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
Object	getCriteria()	A set of AWS Security Finding Format (ASFF) finding field attributes and corresponding expected values that Security Hub uses to filter findings.
String	getDescription()	A description of the rule.
Object	getIsTerminal()	Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.
String	getRuleName()	The name of the rule.
Number	getRuleOrder()	An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
String	getRuleStatus()	Whether the rule is active after it is created.
Map<String,String>	getTags()	User-defined tags associated with an automation rule.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActions(List<Object> value)	One or more actions to update finding fields if a finding matches the conditions specified in Criteria .
void	setActions(IResolvable value)	One or more actions to update finding fields if a finding matches the conditions specified in Criteria .
void	setCriteria(IResolvable value)	A set of AWS Security Finding Format (ASFF) finding field attributes and corresponding expected values that Security Hub uses to filter findings.
void	setCriteria(CfnAutomationRule.AutomationRulesFindingFiltersProperty value)	A set of AWS Security Finding Format (ASFF) finding field attributes and corresponding expected values that Security Hub uses to filter findings.
void	setDescription(String value)	A description of the rule.
void	setIsTerminal(Boolean value)	Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.
void	setIsTerminal(IResolvable value)	Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.
void	setRuleName(String value)	The name of the rule.
void	setRuleOrder(Number value)	An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
void	setRuleStatus(String value)	Whether the rule is active after it is created.
void	setTags(Map<String,String> value)	User-defined tags associated with an automation rule.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, 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.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

CfnAutomationRule

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

CfnAutomationRule

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

CfnAutomationRule

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

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

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()

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 .

getAttrCreatedBy

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

The principal that created the rule.

For example, arn:aws:sts::123456789012:assumed-role/Developer-Role/JaneDoe .

getAttrRuleArn

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

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 .

getAttrUpdatedAt

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

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 .

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()

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

setActions

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

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

setActions

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

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

getCriteria

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

A set of AWS Security Finding Format (ASFF) finding field attributes and corresponding expected values that Security Hub uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, Security Hub applies the rule action to the finding.

setCriteria

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

A set of AWS Security Finding Format (ASFF) finding field attributes and corresponding expected values that Security Hub uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, Security Hub applies the rule action to the finding.

setCriteria

@Stability(Stable)
public void setCriteria(@NotNull
 CfnAutomationRule.AutomationRulesFindingFiltersProperty value)

A set of AWS Security Finding Format (ASFF) finding field attributes and corresponding expected values that Security Hub uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, Security Hub applies the rule action to the finding.

getDescription

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

A description of the rule.

setDescription

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

A description of the rule.

getRuleName

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

The name of the rule.

setRuleName

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

The name of the rule.

getRuleOrder

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

An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.

setRuleOrder

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

An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.

getIsTerminal

@Stability(Stable)
@Nullable
public Object getIsTerminal()

Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.

setIsTerminal

@Stability(Stable)
public void setIsTerminal(@Nullable
 Boolean value)

Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.

setIsTerminal

@Stability(Stable)
public void setIsTerminal(@Nullable
 IResolvable value)

Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.

getRuleStatus

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

Whether the rule is active after it is created.

setRuleStatus

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

Whether the rule is active after it is created.

getTags

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

User-defined tags associated with an automation rule.

setTags

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

User-defined tags associated with an automation rule.