software.amazon.awscdk.services.networkfirewall

Class CfnRuleGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.networkfirewall.CfnRuleGroup

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.622Z")
 @Stability(value=Stable)
public class CfnRuleGroup
extends CfnResource
implements IInspectable

A CloudFormation `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;
 CfnRuleGroup cfnRuleGroup = CfnRuleGroup.Builder.create(this, "MyCfnRuleGroup")
         .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	Class and Description
static interface	CfnRuleGroup.ActionDefinitionProperty Example:
static interface	CfnRuleGroup.AddressProperty Example:
static class	CfnRuleGroup.Builder A fluent builder for CfnRuleGroup.
static interface	CfnRuleGroup.CustomActionProperty Example:
static interface	CfnRuleGroup.DimensionProperty Example:
static interface	CfnRuleGroup.HeaderProperty Example:
static interface	CfnRuleGroup.IPSetProperty
static interface	CfnRuleGroup.MatchAttributesProperty Example:
static interface	CfnRuleGroup.PortRangeProperty Example:
static interface	CfnRuleGroup.PortSetProperty Example:
static interface	CfnRuleGroup.PublishMetricActionProperty Example:
static interface	CfnRuleGroup.RuleDefinitionProperty Example:
static interface	CfnRuleGroup.RuleGroupProperty Example:
static interface	CfnRuleGroup.RuleOptionProperty Example:
static interface	CfnRuleGroup.RulesSourceListProperty Example:
static interface	CfnRuleGroup.RulesSourceProperty Example:
static interface	CfnRuleGroup.RuleVariablesProperty Example:
static interface	CfnRuleGroup.StatefulRuleOptionsProperty Example:
static interface	CfnRuleGroup.StatefulRuleProperty Example:
static interface	CfnRuleGroup.StatelessRuleProperty Example:
static interface	CfnRuleGroup.StatelessRulesAndCustomActionsProperty Example:
static interface	CfnRuleGroup.TCPFlagFieldProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRuleGroup(software.constructs.Construct scope, String id, CfnRuleGroupProps props) Create a new `AWS::NetworkFirewall::RuleGroup`.
protected	CfnRuleGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRuleGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrRuleGroupArn()
String	getAttrRuleGroupId()
Number	getCapacity() `AWS::NetworkFirewall::RuleGroup.Capacity`.
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::NetworkFirewall::RuleGroup.Description`.
Object	getRuleGroup() `AWS::NetworkFirewall::RuleGroup.RuleGroup`.
String	getRuleGroupName() `AWS::NetworkFirewall::RuleGroup.RuleGroupName`.
TagManager	getTags() `AWS::NetworkFirewall::RuleGroup.Tags`.
String	getType() `AWS::NetworkFirewall::RuleGroup.Type`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCapacity(Number value) `AWS::NetworkFirewall::RuleGroup.Capacity`.
void	setDescription(String value) `AWS::NetworkFirewall::RuleGroup.Description`.
void	setRuleGroup(CfnRuleGroup.RuleGroupProperty value) `AWS::NetworkFirewall::RuleGroup.RuleGroup`.
void	setRuleGroup(IResolvable value) `AWS::NetworkFirewall::RuleGroup.RuleGroup`.
void	setRuleGroupName(String value) `AWS::NetworkFirewall::RuleGroup.RuleGroupName`.
void	setType(String value) `AWS::NetworkFirewall::RuleGroup.Type`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnRuleGroup

protected CfnRuleGroup(software.amazon.jsii.JsiiObjectRef objRef)

CfnRuleGroup

protected CfnRuleGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnRuleGroup

@Stability(value=Stable)
public CfnRuleGroup(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             CfnRuleGroupProps props)

Create a new `AWS::NetworkFirewall::RuleGroup`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrRuleGroupArn

@Stability(value=Stable)
 @NotNull
public String getAttrRuleGroupArn()

getAttrRuleGroupId

@Stability(value=Stable)
 @NotNull
public String getAttrRuleGroupId()

getCapacity

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

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

setCapacity

@Stability(value=Stable)
public void setCapacity(@NotNull
                                                 Number value)

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDescription

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

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

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

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

getRuleGroup

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

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

setRuleGroup

@Stability(value=Stable)
public void setRuleGroup(@Nullable
                                                  CfnRuleGroup.RuleGroupProperty value)

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

setRuleGroup

@Stability(value=Stable)
public void setRuleGroup(@Nullable
                                                  IResolvable value)

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

getRuleGroupName

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

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

setRuleGroupName

@Stability(value=Stable)
public void setRuleGroupName(@NotNull
                                                      String value)

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

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getType

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

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

setType

@Stability(value=Stable)
public void setType(@NotNull
                                             String value)

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