software.amazon.awscdk.services.networkfirewall

Interface CfnRuleGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.627Z")
 @Stability(value=Stable)
public interface CfnRuleGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::NetworkFirewall::RuleGroup`.

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.*;
 IPSetProperty pSetProperty;
 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
                 .ruleVariables(RuleVariablesProperty.builder()
                         .ipSets(Map.of(
                                 "ipSetsKey", pSetProperty))
                         .portSets(Map.of(
                                 "portSetsKey", PortSetProperty.builder()
                                         .definition(List.of("definition"))
                                         .build()))
                         .build())
                 .statefulRuleOptions(StatefulRuleOptionsProperty.builder()
                         .ruleOrder("ruleOrder")
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnRuleGroupProps.Builder A builder for CfnRuleGroupProps
static class	CfnRuleGroupProps.Jsii$Proxy An implementation for CfnRuleGroupProps

Method Summary

Modifier and Type	Method and Description
static CfnRuleGroupProps.Builder	builder()
Number	getCapacity() `AWS::NetworkFirewall::RuleGroup.Capacity`.
default String	getDescription() `AWS::NetworkFirewall::RuleGroup.Description`.
default Object	getRuleGroup() `AWS::NetworkFirewall::RuleGroup.RuleGroup`.
String	getRuleGroupName() `AWS::NetworkFirewall::RuleGroup.RuleGroupName`.
default List<CfnTag>	getTags() `AWS::NetworkFirewall::RuleGroup.Tags`.
String	getType() `AWS::NetworkFirewall::RuleGroup.Type`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCapacity

@Stability(value=Stable)
 @NotNull
Number getCapacity()

`AWS::NetworkFirewall::RuleGroup.Capacity`.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::NetworkFirewall::RuleGroup.Description`.

getRuleGroup

@Stability(value=Stable)
 @Nullable
default Object getRuleGroup()

`AWS::NetworkFirewall::RuleGroup.RuleGroup`.

getRuleGroupName

@Stability(value=Stable)
 @NotNull
String getRuleGroupName()

`AWS::NetworkFirewall::RuleGroup.RuleGroupName`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::NetworkFirewall::RuleGroup.Tags`.

getType

@Stability(value=Stable)
 @NotNull
String getType()

`AWS::NetworkFirewall::RuleGroup.Type`.

builder

@Stability(value=Stable)
static CfnRuleGroupProps.Builder builder()

Returns:

a CfnRuleGroupProps.Builder of CfnRuleGroupProps