CfnAutomationRuleV2Props Struct
Properties for defining a CfnAutomationRuleV2.
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_securityhub as securityhub } from 'aws-cdk-lib';
const cfnAutomationRuleV2Props: securityhub.CfnAutomationRuleV2Props = {
actions: [{
type: 'type',
// the properties below are optional
externalIntegrationConfiguration: {
connectorArn: 'connectorArn',
},
findingFieldsUpdate: {
comment: 'comment',
severityId: 123,
statusId: 123,
},
}],
criteria: {
ocsfFindingCriteria: {
compositeFilters: [{
booleanFilters: [{
fieldName: 'fieldName',
filter: {
value: false,
},
}],
dateFilters: [{
fieldName: 'fieldName',
filter: {
dateRange: {
unit: 'unit',
value: 123,
},
end: 'end',
start: 'start',
},
}],
mapFilters: [{
fieldName: 'fieldName',
filter: {
comparison: 'comparison',
key: 'key',
value: 'value',
},
}],
numberFilters: [{
fieldName: 'fieldName',
filter: {
eq: 123,
gte: 123,
lte: 123,
},
}],
operator: 'operator',
stringFilters: [{
fieldName: 'fieldName',
filter: {
comparison: 'comparison',
value: 'value',
},
}],
}],
compositeOperator: 'compositeOperator',
},
},
description: 'description',
ruleName: 'ruleName',
ruleOrder: 123,
// the properties below are optional
ruleStatus: 'ruleStatus',
tags: {
tagsKey: 'tags',
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_securityhub as securityhub
cfn_automation_rule_v2_props = securityhub.CfnAutomationRuleV2Props(
actions=[securityhub.CfnAutomationRuleV2.AutomationRulesActionV2Property(
type="type",
# the properties below are optional
external_integration_configuration=securityhub.CfnAutomationRuleV2.ExternalIntegrationConfigurationProperty(
connector_arn="connectorArn"
),
finding_fields_update=securityhub.CfnAutomationRuleV2.AutomationRulesFindingFieldsUpdateV2Property(
comment="comment",
severity_id=123,
status_id=123
)
)],
criteria=securityhub.CfnAutomationRuleV2.CriteriaProperty(
ocsf_finding_criteria=securityhub.CfnAutomationRuleV2.OcsfFindingFiltersProperty(
composite_filters=[securityhub.CfnAutomationRuleV2.CompositeFilterProperty(
boolean_filters=[securityhub.CfnAutomationRuleV2.OcsfBooleanFilterProperty(
field_name="fieldName",
filter=securityhub.CfnAutomationRuleV2.BooleanFilterProperty(
value=False
)
)],
date_filters=[securityhub.CfnAutomationRuleV2.OcsfDateFilterProperty(
field_name="fieldName",
filter=securityhub.CfnAutomationRuleV2.DateFilterProperty(
date_range=securityhub.CfnAutomationRuleV2.DateRangeProperty(
unit="unit",
value=123
),
end="end",
start="start"
)
)],
map_filters=[securityhub.CfnAutomationRuleV2.OcsfMapFilterProperty(
field_name="fieldName",
filter=securityhub.CfnAutomationRuleV2.MapFilterProperty(
comparison="comparison",
key="key",
value="value"
)
)],
number_filters=[securityhub.CfnAutomationRuleV2.OcsfNumberFilterProperty(
field_name="fieldName",
filter=securityhub.CfnAutomationRuleV2.NumberFilterProperty(
eq=123,
gte=123,
lte=123
)
)],
operator="operator",
string_filters=[securityhub.CfnAutomationRuleV2.OcsfStringFilterProperty(
field_name="fieldName",
filter=securityhub.CfnAutomationRuleV2.StringFilterProperty(
comparison="comparison",
value="value"
)
)]
)],
composite_operator="compositeOperator"
)
),
description="description",
rule_name="ruleName",
rule_order=123,
# the properties below are optional
rule_status="ruleStatus",
tags={
"tags_key": "tags"
}
)
java
// 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.*;
CfnAutomationRuleV2Props cfnAutomationRuleV2Props = CfnAutomationRuleV2Props.builder()
.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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SecurityHub;
var cfnAutomationRuleV2Props = new CfnAutomationRuleV2Props {
Actions = new [] { new AutomationRulesActionV2Property {
Type = "type",
// the properties below are optional
ExternalIntegrationConfiguration = new ExternalIntegrationConfigurationProperty {
ConnectorArn = "connectorArn"
},
FindingFieldsUpdate = new AutomationRulesFindingFieldsUpdateV2Property {
Comment = "comment",
SeverityId = 123,
StatusId = 123
}
} },
Criteria = new CriteriaProperty {
OcsfFindingCriteria = new OcsfFindingFiltersProperty {
CompositeFilters = new [] { new CompositeFilterProperty {
BooleanFilters = new [] { new OcsfBooleanFilterProperty {
FieldName = "fieldName",
Filter = new BooleanFilterProperty {
Value = false
}
} },
DateFilters = new [] { new OcsfDateFilterProperty {
FieldName = "fieldName",
Filter = new DateFilterProperty {
DateRange = new DateRangeProperty {
Unit = "unit",
Value = 123
},
End = "end",
Start = "start"
}
} },
MapFilters = new [] { new OcsfMapFilterProperty {
FieldName = "fieldName",
Filter = new MapFilterProperty {
Comparison = "comparison",
Key = "key",
Value = "value"
}
} },
NumberFilters = new [] { new OcsfNumberFilterProperty {
FieldName = "fieldName",
Filter = new NumberFilterProperty {
Eq = 123,
Gte = 123,
Lte = 123
}
} },
Operator = "operator",
StringFilters = new [] { new OcsfStringFilterProperty {
FieldName = "fieldName",
Filter = new StringFilterProperty {
Comparison = "comparison",
Value = "value"
}
} }
} },
CompositeOperator = "compositeOperator"
}
},
Description = "description",
RuleName = "ruleName",
RuleOrder = 123,
// the properties below are optional
RuleStatus = "ruleStatus",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnAutomationRuleV2Props := &CfnAutomationRuleV2Props{
Actions: []interface{}{
&AutomationRulesActionV2Property{
Type: jsii.String("type"),
// the properties below are optional
ExternalIntegrationConfiguration: &ExternalIntegrationConfigurationProperty{
ConnectorArn: jsii.String("connectorArn"),
},
FindingFieldsUpdate: &AutomationRulesFindingFieldsUpdateV2Property{
Comment: jsii.String("comment"),
SeverityId: jsii.Number(123),
StatusId: jsii.Number(123),
},
},
},
Criteria: &CriteriaProperty{
OcsfFindingCriteria: &OcsfFindingFiltersProperty{
CompositeFilters: []interface{}{
&CompositeFilterProperty{
BooleanFilters: []interface{}{
&OcsfBooleanFilterProperty{
FieldName: jsii.String("fieldName"),
Filter: &BooleanFilterProperty{
Value: jsii.Boolean(false),
},
},
},
DateFilters: []interface{}{
&OcsfDateFilterProperty{
FieldName: jsii.String("fieldName"),
Filter: &DateFilterProperty{
DateRange: &DateRangeProperty{
Unit: jsii.String("unit"),
Value: jsii.Number(123),
},
End: jsii.String("end"),
Start: jsii.String("start"),
},
},
},
MapFilters: []interface{}{
&OcsfMapFilterProperty{
FieldName: jsii.String("fieldName"),
Filter: &MapFilterProperty{
Comparison: jsii.String("comparison"),
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
NumberFilters: []interface{}{
&OcsfNumberFilterProperty{
FieldName: jsii.String("fieldName"),
Filter: &NumberFilterProperty{
Eq: jsii.Number(123),
Gte: jsii.Number(123),
Lte: jsii.Number(123),
},
},
},
Operator: jsii.String("operator"),
StringFilters: []interface{}{
&OcsfStringFilterProperty{
FieldName: jsii.String("fieldName"),
Filter: &StringFilterProperty{
Comparison: jsii.String("comparison"),
Value: jsii.String("value"),
},
},
},
},
},
CompositeOperator: jsii.String("compositeOperator"),
},
},
Description: jsii.String("description"),
RuleName: jsii.String("ruleName"),
RuleOrder: jsii.Number(123),
// the properties below are optional
RuleStatus: jsii.String("ruleStatus"),
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
Properties
actionsIResolvable | IResolvable | CfnAutomationRuleV2.actionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AutomationRulesActionV2Property]]]actionsIResolvableActionsIResolvableActionsinterface{} required #A list of actions to be performed when the rule criteria is met.
criteriaIResolvable | CfnAutomationRuleV2.criteriatyping.Union[IResolvable, CriteriaProperty]criteriaIResolvableCriteriaIResolvableCriteriainterface{} required #The filtering type and configuration of the automation rule.
A description of the V2 automation rule.
The name of the V2 automation rule.
The value for the rule priority.
ruleStatusoptionalstringrule_statusoptionalstrruleStatusoptionalStringRuleStatusoptionalstringRuleStatusoptional*string #The status of the V2 automation rule.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string #A list of key-value pairs associated with the V2 automation rule.