Package software.amazon.awscdk.services.networkfirewall

Class CfnFirewall.Builder

java.lang.Object

software.amazon.awscdk.services.networkfirewall.CfnFirewall.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFirewall>

Enclosing class:

CfnFirewall

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

A fluent builder for CfnFirewall.

Method Summary

Modifier and Type	Method	Description
CfnFirewall.Builder	availabilityZoneChangeProtection(Boolean availabilityZoneChangeProtection)	A setting indicating whether the firewall is protected against changes to its Availability Zone configuration.
CfnFirewall.Builder	availabilityZoneChangeProtection(IResolvable availabilityZoneChangeProtection)	A setting indicating whether the firewall is protected against changes to its Availability Zone configuration.
CfnFirewall.Builder	availabilityZoneMappings(List<? extends Object> availabilityZoneMappings)	The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall.
CfnFirewall.Builder	availabilityZoneMappings(IResolvable availabilityZoneMappings)	The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall.
CfnFirewall	build()
static CfnFirewall.Builder	create(software.constructs.Construct scope, String id)
CfnFirewall.Builder	deleteProtection(Boolean deleteProtection)	A flag indicating whether it is possible to delete the firewall.
CfnFirewall.Builder	deleteProtection(IResolvable deleteProtection)	A flag indicating whether it is possible to delete the firewall.
CfnFirewall.Builder	description(String description)	A description of the firewall.
CfnFirewall.Builder	enabledAnalysisTypes(List<String> enabledAnalysisTypes)	An optional setting indicating the specific traffic analysis types to enable on the firewall.
CfnFirewall.Builder	firewallName(String firewallName)	The descriptive name of the firewall.
CfnFirewall.Builder	firewallPolicyArn(String firewallPolicyArn)	The Amazon Resource Name (ARN) of the firewall policy.
CfnFirewall.Builder	firewallPolicyChangeProtection(Boolean firewallPolicyChangeProtection)	A setting indicating whether the firewall is protected against a change to the firewall policy association.
CfnFirewall.Builder	firewallPolicyChangeProtection(IResolvable firewallPolicyChangeProtection)	A setting indicating whether the firewall is protected against a change to the firewall policy association.
CfnFirewall.Builder	subnetChangeProtection(Boolean subnetChangeProtection)	A setting indicating whether the firewall is protected against changes to the subnet associations.
CfnFirewall.Builder	subnetChangeProtection(IResolvable subnetChangeProtection)	A setting indicating whether the firewall is protected against changes to the subnet associations.
CfnFirewall.Builder	subnetMappings(List<? extends Object> subnetMappings)	The primary public subnets that Network Firewall is using for the firewall.
CfnFirewall.Builder	subnetMappings(IResolvable subnetMappings)	The primary public subnets that Network Firewall is using for the firewall.
CfnFirewall.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.
CfnFirewall.Builder	transitGatewayId(String transitGatewayId)	The unique identifier of the transit gateway associated with this firewall.
CfnFirewall.Builder	vpcId(String vpcId)	The unique identifier of the VPC where the firewall is in use.

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 CfnFirewall.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnFirewall.Builder.

firewallName

@Stability(Stable)
public CfnFirewall.Builder firewallName(String firewallName)

The descriptive name of the firewall.

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

Parameters:

firewallName - The descriptive name of the firewall. This parameter is required.

Returns:

this

See Also:

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

firewallPolicyArn

@Stability(Stable)
public CfnFirewall.Builder firewallPolicyArn(String firewallPolicyArn)

The Amazon Resource Name (ARN) of the firewall policy.

The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

Parameters:

firewallPolicyArn - The Amazon Resource Name (ARN) of the firewall policy. This parameter is required.

Returns:

this

See Also:

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

availabilityZoneChangeProtection

@Stability(Stable)
public CfnFirewall.Builder availabilityZoneChangeProtection(Boolean availabilityZoneChangeProtection)

A setting indicating whether the firewall is protected against changes to its Availability Zone configuration.

When set to TRUE , you must first disable this protection before adding or removing Availability Zones.

Parameters:

availabilityZoneChangeProtection - A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. This parameter is required.

Returns:

this

See Also:

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

availabilityZoneChangeProtection

@Stability(Stable)
public CfnFirewall.Builder availabilityZoneChangeProtection(IResolvable availabilityZoneChangeProtection)

A setting indicating whether the firewall is protected against changes to its Availability Zone configuration.

When set to TRUE , you must first disable this protection before adding or removing Availability Zones.

Parameters:

availabilityZoneChangeProtection - A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. This parameter is required.

Returns:

this

See Also:

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

availabilityZoneMappings

@Stability(Stable)
public CfnFirewall.Builder availabilityZoneMappings(IResolvable availabilityZoneMappings)

The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall.

Each mapping specifies an Availability Zone where the firewall processes traffic.

Parameters:

availabilityZoneMappings - The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. This parameter is required.

Returns:

this

See Also:

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

availabilityZoneMappings

@Stability(Stable)
public CfnFirewall.Builder availabilityZoneMappings(List<? extends Object> availabilityZoneMappings)

The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall.

Each mapping specifies an Availability Zone where the firewall processes traffic.

Parameters:

availabilityZoneMappings - The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. This parameter is required.

Returns:

this

See Also:

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

deleteProtection

@Stability(Stable)
public CfnFirewall.Builder deleteProtection(Boolean deleteProtection)

A flag indicating whether it is possible to delete the firewall.

A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE .

Parameters:

deleteProtection - A flag indicating whether it is possible to delete the firewall. This parameter is required.

Returns:

this

See Also:

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

deleteProtection

@Stability(Stable)
public CfnFirewall.Builder deleteProtection(IResolvable deleteProtection)

A flag indicating whether it is possible to delete the firewall.

A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE .

Parameters:

deleteProtection - A flag indicating whether it is possible to delete the firewall. This parameter is required.

Returns:

this

See Also:

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

description

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

A description of the firewall.

Parameters:

description - A description of the firewall. This parameter is required.

Returns:

this

See Also:

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

enabledAnalysisTypes

@Stability(Stable)
public CfnFirewall.Builder enabledAnalysisTypes(List<String> enabledAnalysisTypes)

An optional setting indicating the specific traffic analysis types to enable on the firewall.

Parameters:

enabledAnalysisTypes - An optional setting indicating the specific traffic analysis types to enable on the firewall. This parameter is required.

Returns:

this

See Also:

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

firewallPolicyChangeProtection

@Stability(Stable)
public CfnFirewall.Builder firewallPolicyChangeProtection(Boolean firewallPolicyChangeProtection)

A setting indicating whether the firewall is protected against a change to the firewall policy association.

Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .

Parameters:

firewallPolicyChangeProtection - A setting indicating whether the firewall is protected against a change to the firewall policy association. This parameter is required.

Returns:

this

See Also:

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

firewallPolicyChangeProtection

@Stability(Stable)
public CfnFirewall.Builder firewallPolicyChangeProtection(IResolvable firewallPolicyChangeProtection)

A setting indicating whether the firewall is protected against a change to the firewall policy association.

Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .

Parameters:

firewallPolicyChangeProtection - A setting indicating whether the firewall is protected against a change to the firewall policy association. This parameter is required.

Returns:

this

See Also:

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

subnetChangeProtection

@Stability(Stable)
public CfnFirewall.Builder subnetChangeProtection(Boolean subnetChangeProtection)

A setting indicating whether the firewall is protected against changes to the subnet associations.

Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .

Parameters:

subnetChangeProtection - A setting indicating whether the firewall is protected against changes to the subnet associations. This parameter is required.

Returns:

this

See Also:

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

subnetChangeProtection

@Stability(Stable)
public CfnFirewall.Builder subnetChangeProtection(IResolvable subnetChangeProtection)

A setting indicating whether the firewall is protected against changes to the subnet associations.

Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .

Parameters:

subnetChangeProtection - A setting indicating whether the firewall is protected against changes to the subnet associations. This parameter is required.

Returns:

this

See Also:

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

subnetMappings

@Stability(Stable)
public CfnFirewall.Builder subnetMappings(IResolvable subnetMappings)

The primary public subnets that Network Firewall is using for the firewall.

Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.

These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.

In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.

Parameters:

subnetMappings - The primary public subnets that Network Firewall is using for the firewall. This parameter is required.

Returns:

this

See Also:

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

subnetMappings

@Stability(Stable)
public CfnFirewall.Builder subnetMappings(List<? extends Object> subnetMappings)

The primary public subnets that Network Firewall is using for the firewall.

Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.

These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.

In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.

Parameters:

subnetMappings - The primary public subnets that Network Firewall is using for the firewall. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnFirewall.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-firewall.html#cfn-networkfirewall-firewall-tags

transitGatewayId

@Stability(Stable)
public CfnFirewall.Builder transitGatewayId(String transitGatewayId)

The unique identifier of the transit gateway associated with this firewall.

This field is only present for transit gateway-attached firewalls.

Parameters:

transitGatewayId - The unique identifier of the transit gateway associated with this firewall. This parameter is required.

Returns:

this

See Also:

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

vpcId

@Stability(Stable)
public CfnFirewall.Builder vpcId(String vpcId)

The unique identifier of the VPC where the firewall is in use.

You can't change the VPC of a firewall after you create the firewall.

Parameters:

vpcId - The unique identifier of the VPC where the firewall is in use. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnFirewall build()

Specified by:

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

Returns:

a newly built instance of CfnFirewall.