Interface CfnAutomationRuleProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAutomationRuleProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
date="2024-05-08T21:35:13.819Z")
@Stability(Stable)
public interface CfnAutomationRuleProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnAutomationRule
.
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; CfnAutomationRuleProps cfnAutomationRuleProps = CfnAutomationRuleProps.builder() .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") .isTerminal(false) .ruleName("ruleName") .ruleOrder(123) .ruleStatus("ruleStatus") .tags(Map.of( "tagsKey", "tags")) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnAutomationRuleProps
static final class
An implementation forCfnAutomationRuleProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
One or more actions to update finding fields if a finding matches the conditions specified inCriteria
.default Object
A set of AWS Security Finding Format (ASFF) finding field attributes and corresponding expected values that Security Hub uses to filter findings.default String
A description of the rule.default Object
Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.default String
The name of the rule.default Number
An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.default String
Whether the rule is active after it is created.getTags()
User-defined tags associated with an automation rule.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getActions
One or more actions to update finding fields if a finding matches the conditions specified inCriteria
.- See Also:
-
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.- See Also:
-
getDescription
A description of the rule.- See Also:
-
getIsTerminal
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.
- See Also:
-
getRuleName
The name of the rule.- See Also:
-
getRuleOrder
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.
- See Also:
-
getRuleStatus
Whether the rule is active after it is created.If this parameter is equal to
ENABLED
, Security Hub applies the rule to findings and finding updates after the rule is created.- See Also:
-
getTags
User-defined tags associated with an automation rule.- See Also:
-
builder
- Returns:
- a
CfnAutomationRuleProps.Builder
ofCfnAutomationRuleProps
-