Interface CfnRuleGroupProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnRuleGroupProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
date="2025-12-18T18:20:13.922Z")
@Stability(Stable)
public interface CfnRuleGroupProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnRuleGroup.
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.networkfirewall.*;
CfnRuleGroupProps cfnRuleGroupProps = CfnRuleGroupProps.builder()
.capacity(123)
.ruleGroupName("ruleGroupName")
.type("type")
// the properties below are optional
.description("description")
.ruleGroup(RuleGroupProperty.builder()
.rulesSource(RulesSourceProperty.builder()
.rulesSourceList(RulesSourceListProperty.builder()
.generatedRulesType("generatedRulesType")
.targets(List.of("targets"))
.targetTypes(List.of("targetTypes"))
.build())
.rulesString("rulesString")
.statefulRules(List.of(StatefulRuleProperty.builder()
.action("action")
.header(HeaderProperty.builder()
.destination("destination")
.destinationPort("destinationPort")
.direction("direction")
.protocol("protocol")
.source("source")
.sourcePort("sourcePort")
.build())
.ruleOptions(List.of(RuleOptionProperty.builder()
.keyword("keyword")
// the properties below are optional
.settings(List.of("settings"))
.build()))
.build()))
.statelessRulesAndCustomActions(StatelessRulesAndCustomActionsProperty.builder()
.statelessRules(List.of(StatelessRuleProperty.builder()
.priority(123)
.ruleDefinition(RuleDefinitionProperty.builder()
.actions(List.of("actions"))
.matchAttributes(MatchAttributesProperty.builder()
.destinationPorts(List.of(PortRangeProperty.builder()
.fromPort(123)
.toPort(123)
.build()))
.destinations(List.of(AddressProperty.builder()
.addressDefinition("addressDefinition")
.build()))
.protocols(List.of(123))
.sourcePorts(List.of(PortRangeProperty.builder()
.fromPort(123)
.toPort(123)
.build()))
.sources(List.of(AddressProperty.builder()
.addressDefinition("addressDefinition")
.build()))
.tcpFlags(List.of(TCPFlagFieldProperty.builder()
.flags(List.of("flags"))
// the properties below are optional
.masks(List.of("masks"))
.build()))
.build())
.build())
.build()))
// the properties below are optional
.customActions(List.of(CustomActionProperty.builder()
.actionDefinition(ActionDefinitionProperty.builder()
.publishMetricAction(PublishMetricActionProperty.builder()
.dimensions(List.of(DimensionProperty.builder()
.value("value")
.build()))
.build())
.build())
.actionName("actionName")
.build()))
.build())
.build())
// the properties below are optional
.referenceSets(ReferenceSetsProperty.builder()
.ipSetReferences(Map.of(
"ipSetReferencesKey", Map.of(
"referenceArn", "referenceArn")))
.build())
.ruleVariables(RuleVariablesProperty.builder()
.ipSets(Map.of(
"ipSetsKey", Map.of(
"definition", List.of("definition"))))
.portSets(Map.of(
"portSetsKey", PortSetProperty.builder()
.definition(List.of("definition"))
.build()))
.build())
.statefulRuleOptions(StatefulRuleOptionsProperty.builder()
.ruleOrder("ruleOrder")
.build())
.build())
.summaryConfiguration(SummaryConfigurationProperty.builder()
.ruleOptions(List.of("ruleOptions"))
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnRuleGroupPropsstatic final classAn implementation forCfnRuleGroupProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnRuleGroupProps.Builderbuilder()The maximum operating resources that this rule group can use.default StringA description of the rule group.default ObjectAn object that defines the rule group rules.The descriptive name of the rule group.default ObjectA complex type containing the currently selected rule option fields that will be displayed for rule summarization returned byDescribeRuleGroupSummary.getTags()An array of key-value pairs to apply to this resource.getType()Indicates whether the rule group is stateless or stateful.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCapacity
The maximum operating resources that this rule group can use.You can't change a rule group's capacity setting after you create the rule group. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.
- See Also:
-
getRuleGroupName
The descriptive name of the rule group.You can't change the name of a rule group after you create it.
- See Also:
-
getType
Indicates whether the rule group is stateless or stateful.If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
- See Also:
-
getDescription
A description of the rule group.- See Also:
-
getRuleGroup
An object that defines the rule group rules.Returns union: either
IResolvableorCfnRuleGroup.RuleGroupProperty- See Also:
-
getSummaryConfiguration
A complex type containing the currently selected rule option fields that will be displayed for rule summarization returned byDescribeRuleGroupSummary.- The
RuleOptionsspecified inSummaryConfiguration - Rule metadata organization preferences
Returns union: either
IResolvableorCfnRuleGroup.SummaryConfigurationProperty- See Also:
- The
-
getTags
An array of key-value pairs to apply to this resource.For more information, see Tag .
- See Also:
-
builder
- Returns:
- a
CfnRuleGroupProps.BuilderofCfnRuleGroupProps
-