software.amazon.awscdk.services.networkfirewall

Interface CfnRuleGroup.RulesSourceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroup.RulesSourceProperty.Jsii$Proxy

Enclosing class:

CfnRuleGroup

@Stability(value=Stable)
public static interface CfnRuleGroup.RulesSourceProperty
extends software.amazon.jsii.JsiiSerializable

The stateless or stateful rules definitions for use in a single rule group.

Each rule group requires a single RulesSource . You can use an instance of this for either stateless rules or stateful rules.

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.*;
 RulesSourceProperty rulesSourceProperty = 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnRuleGroup.RulesSourceProperty.Builder	builder()
default Object	getRulesSourceList() Stateful inspection criteria for a domain list rule group.
default String	getRulesString() Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules.
default Object	getStatefulRules() An array of individual stateful rules inspection criteria to be used together in a stateful rule group.
default Object	getStatelessRulesAndCustomActions() Stateless inspection criteria to be used in a stateless rule group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRulesSourceList

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

Stateful inspection criteria for a domain list rule group.

getRulesString

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

Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules.

Suricata is an open-source network IPS that includes a standard rule-based language for network traffic inspection.

These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.

getStatefulRules

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

An array of individual stateful rules inspection criteria to be used together in a stateful rule group.

Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format .

getStatelessRulesAndCustomActions

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

Stateless inspection criteria to be used in a stateless rule group.

builder

@Stability(value=Stable)
static CfnRuleGroup.RulesSourceProperty.Builder builder()

Returns:

a CfnRuleGroup.RulesSourceProperty.Builder of CfnRuleGroup.RulesSourceProperty