Package software.amazon.awscdk.cfnpropertymixins.services.networkfirewall

Class CfnRuleGroupPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.networkfirewall.CfnRuleGroupPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRuleGroupPropsMixin>

Enclosing class:

CfnRuleGroupPropsMixin

@Stability(Stable)
public static final class CfnRuleGroupPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnRuleGroupPropsMixin>

A fluent builder for CfnRuleGroupPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnRuleGroupPropsMixin	build()
CfnRuleGroupPropsMixin.Builder	capacity(Number capacity)	The maximum operating resources that this rule group can use.
static CfnRuleGroupPropsMixin.Builder	create()
static CfnRuleGroupPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnRuleGroupPropsMixin.Builder	description(String description)	A description of the rule group.
CfnRuleGroupPropsMixin.Builder	ruleGroup(CfnRuleGroupPropsMixin.RuleGroupProperty ruleGroup)	An object that defines the rule group rules.
CfnRuleGroupPropsMixin.Builder	ruleGroup(IResolvable ruleGroup)	An object that defines the rule group rules.
CfnRuleGroupPropsMixin.Builder	ruleGroupName(String ruleGroupName)	The descriptive name of the rule group.
CfnRuleGroupPropsMixin.Builder	summaryConfiguration(CfnRuleGroupPropsMixin.SummaryConfigurationProperty summaryConfiguration)	A complex type containing the currently selected rule option fields that will be displayed for rule summarization returned by DescribeRuleGroupSummary .
CfnRuleGroupPropsMixin.Builder	summaryConfiguration(IResolvable summaryConfiguration)	A complex type containing the currently selected rule option fields that will be displayed for rule summarization returned by DescribeRuleGroupSummary .
CfnRuleGroupPropsMixin.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.
CfnRuleGroupPropsMixin.Builder	type(String type)	Indicates whether the rule group is stateless or stateful.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnRuleGroupPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnRuleGroupPropsMixin.Builder.

create

@Stability(Stable)
public static CfnRuleGroupPropsMixin.Builder create()

Returns:

a new instance of CfnRuleGroupPropsMixin.Builder.

capacity

@Stability(Stable)
public CfnRuleGroupPropsMixin.Builder capacity(Number capacity)

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.

Parameters:

capacity - The maximum operating resources that this rule group can use. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-capacity

description

@Stability(Stable)
public CfnRuleGroupPropsMixin.Builder description(String description)

A description of the rule group.

Parameters:

description - A description of the rule group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-description

ruleGroup

@Stability(Stable)
public CfnRuleGroupPropsMixin.Builder ruleGroup(IResolvable ruleGroup)

An object that defines the rule group rules.

Parameters:

ruleGroup - An object that defines the rule group rules. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup

ruleGroup

@Stability(Stable)
public CfnRuleGroupPropsMixin.Builder ruleGroup(CfnRuleGroupPropsMixin.RuleGroupProperty ruleGroup)

An object that defines the rule group rules.

Parameters:

ruleGroup - An object that defines the rule group rules. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup

ruleGroupName

@Stability(Stable)
public CfnRuleGroupPropsMixin.Builder ruleGroupName(String ruleGroupName)

The descriptive name of the rule group.

You can't change the name of a rule group after you create it.

Parameters:

ruleGroupName - The descriptive name of the rule group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroupname

summaryConfiguration

@Stability(Stable)
public CfnRuleGroupPropsMixin.Builder summaryConfiguration(IResolvable summaryConfiguration)

A complex type containing the currently selected rule option fields that will be displayed for rule summarization returned by DescribeRuleGroupSummary .

• The RuleOptions specified in SummaryConfiguration
• Rule metadata organization preferences

Parameters:

summaryConfiguration - A complex type containing the currently selected rule option fields that will be displayed for rule summarization returned by DescribeRuleGroupSummary . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-summaryconfiguration

summaryConfiguration

@Stability(Stable)
public CfnRuleGroupPropsMixin.Builder summaryConfiguration(CfnRuleGroupPropsMixin.SummaryConfigurationProperty summaryConfiguration)

A complex type containing the currently selected rule option fields that will be displayed for rule summarization returned by DescribeRuleGroupSummary .

• The RuleOptions specified in SummaryConfiguration
• Rule metadata organization preferences

Parameters:

summaryConfiguration - A complex type containing the currently selected rule option fields that will be displayed for rule summarization returned by DescribeRuleGroupSummary . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-summaryconfiguration

tags

@Stability(Stable)
public CfnRuleGroupPropsMixin.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-tags

type

@Stability(Stable)
public CfnRuleGroupPropsMixin.Builder type(String type)

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.

Parameters:

type - Indicates whether the rule group is stateless or stateful. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-type

build

@Stability(Stable)
public CfnRuleGroupPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnRuleGroupPropsMixin>

Returns:

a newly built instance of CfnRuleGroupPropsMixin.