software.amazon.awscdk.services.ec2

Class NetworkAcl

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.ec2.NetworkAcl

All Implemented Interfaces:

IConstruct, IDependable, IResource, INetworkAcl

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.127Z")
public class NetworkAcl
extends Resource
implements INetworkAcl

Define a new custom network ACL.

By default, will deny all inbound and outbound traffic unless entries are added explicitly allowing it.

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.ec2.*;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Vpc vpc;
 NetworkAcl networkAcl = NetworkAcl.Builder.create(this, "MyNetworkAcl")
         .vpc(vpc)
         // the properties below are optional
         .networkAclName("networkAclName")
         .subnetSelection(SubnetSelection.builder()
                 .availabilityZones(List.of("availabilityZones"))
                 .onePerAz(false)
                 .subnetFilters(List.of(subnetFilter))
                 .subnetGroupName("subnetGroupName")
                 .subnetName("subnetName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.ISOLATED)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkAcl.Builder A fluent builder for NetworkAcl.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.INetworkAcl

INetworkAcl.Jsii$Default, INetworkAcl.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NetworkAcl(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	NetworkAcl(software.amazon.jsii.JsiiObjectRef objRef)
	NetworkAcl(software.constructs.Construct scope, java.lang.String id, NetworkAclProps props)

Method Summary

Modifier and Type	Method and Description
NetworkAclEntry	addEntry(java.lang.String id, CommonNetworkAclEntryOptions options) Add a new entry to the ACL.
void	associateWithSubnet(java.lang.String id, SubnetSelection selection) Associate the ACL with a given set of subnets.
static INetworkAcl	fromNetworkAclId(software.constructs.Construct scope, java.lang.String id, java.lang.String networkAclId) Import an existing NetworkAcl into this app.
java.lang.String	getNetworkAclId() The ID of the NetworkACL.
java.lang.String	getNetworkAclVpcId() The VPC ID for this NetworkACL.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

NetworkAcl

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

NetworkAcl

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

NetworkAcl

public NetworkAcl(software.constructs.Construct scope,
                  java.lang.String id,
                  NetworkAclProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromNetworkAclId

public static INetworkAcl fromNetworkAclId(software.constructs.Construct scope,
                                           java.lang.String id,
                                           java.lang.String networkAclId)

Import an existing NetworkAcl into this app.

Parameters:

scope - This parameter is required.

id - This parameter is required.

networkAclId - This parameter is required.

addEntry

public NetworkAclEntry addEntry(java.lang.String id,
                                CommonNetworkAclEntryOptions options)

Add a new entry to the ACL.

Specified by:

addEntry in interface INetworkAcl

Parameters:

id - This parameter is required.

options - This parameter is required.

associateWithSubnet

public void associateWithSubnet(java.lang.String id,
                                SubnetSelection selection)

Associate the ACL with a given set of subnets.

Parameters:

id - This parameter is required.

selection - This parameter is required.

getNetworkAclId

public java.lang.String getNetworkAclId()

The ID of the NetworkACL.

Specified by:

getNetworkAclId in interface INetworkAcl

getNetworkAclVpcId

public java.lang.String getNetworkAclVpcId()

The VPC ID for this NetworkACL.