software.amazon.awscdk.services.networkfirewall

Interface CfnFirewallProps

All Known Implementing Classes:

CfnFirewallProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:38.890Z")
public interface CfnFirewallProps

Properties for defining a `CfnFirewall`.

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.*;
 CfnFirewallProps cfnFirewallProps = CfnFirewallProps.builder()
         .firewallName("firewallName")
         .firewallPolicyArn("firewallPolicyArn")
         .subnetMappings(List.of(SubnetMappingProperty.builder()
                 .subnetId("subnetId")
                 // the properties below are optional
                 .ipAddressType("ipAddressType")
                 .build()))
         .vpcId("vpcId")
         // the properties below are optional
         .deleteProtection(false)
         .description("description")
         .firewallPolicyChangeProtection(false)
         .subnetChangeProtection(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnFirewallProps.Builder	builder()
default java.lang.Object	getDeleteProtection() A flag indicating whether it is possible to delete the firewall.
default java.lang.String	getDescription() A description of the firewall.
java.lang.String	getFirewallName() The descriptive name of the firewall.
java.lang.String	getFirewallPolicyArn() The Amazon Resource Name (ARN) of the firewall policy.
default java.lang.Object	getFirewallPolicyChangeProtection() A setting indicating whether the firewall is protected against a change to the firewall policy association.
default java.lang.Object	getSubnetChangeProtection() A setting indicating whether the firewall is protected against changes to the subnet associations.
java.lang.Object	getSubnetMappings() The public subnets that Network Firewall is using for the firewall.
default java.util.List<CfnTag>	getTags() An array of key-value pairs to apply to this resource.
java.lang.String	getVpcId() The unique identifier of the VPC where the firewall is in use.

Method Detail

getFirewallName

java.lang.String getFirewallName()

The descriptive name of the firewall.

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

getFirewallPolicyArn

java.lang.String getFirewallPolicyArn()

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.

getSubnetMappings

java.lang.Object getSubnetMappings()

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

Each subnet must belong to a different Availability Zone.

getVpcId

java.lang.String getVpcId()

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.

getDeleteProtection

default java.lang.Object getDeleteProtection()

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 .

getDescription

default java.lang.String getDescription()

A description of the firewall.

getFirewallPolicyChangeProtection

default java.lang.Object getFirewallPolicyChangeProtection()

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 .

getSubnetChangeProtection

default java.lang.Object getSubnetChangeProtection()

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 .

getTags

default java.util.List<CfnTag> getTags()

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

For more information, see Tag .

builder

static CfnFirewallProps.Builder builder()

Returns:

a CfnFirewallProps.Builder of CfnFirewallProps