Class NetworkAcl

Define a new custom network ACL

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

Hierarchy

NetworkAclBase
- NetworkAcl

Index

Constructors

constructor

new NetworkAcl(scope: Construct, id: string, props: NetworkAclProps): NetworkAcl
Parameters
- scope: Construct
- id: string
- props: NetworkAclProps
Returns NetworkAcl

Overrides NetworkAclBase.constructor

Properties

`Readonly` env

env: ResourceEnvironment

`Readonly` networkAclId

networkAclId: string

The ID of the NetworkACL

Attribute

`Readonly` networkAclName

networkAclName: string

The Name of the NetworkACL

Attribute

`Readonly` networkAclVpcId

networkAclVpcId: string

The VPC ID for this NetworkACL

Attribute

`Readonly` node

node: Node

The tree node.

Stability

stable

`Protected` `Readonly` physicalName

physicalName: string

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

a concrete value (e.g. "my-awesome-bucket")
undefined, when a name should be generated by CloudFormation
a concrete name generated automatically during synthesis, in cross-environment scenarios.

`Readonly` stack

stack: Stack

Methods

_enableCrossEnvironment

_enableCrossEnvironment(): void
Internal
Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.

Returns void

Inherited from NetworkAclBase._enableCrossEnvironment

addEntry

addEntry(id: string, props: {
    cidrBlock?: string;
    egress: boolean;
    icmp?: {
        code?: number;
        type?: number;
    };
    ipv6CidrBlock?: string;
    portRange?: {
        from: number;
        to: number;
    };
    protocol: number;
    ruleAction: "allow" | "deny";
    ruleNumber: number;
}): void
Parameters
- id: string
- props: {
      cidrBlock?: string;
      egress: boolean;
      icmp?: {
          code?: number;
          type?: number;
      };
      ipv6CidrBlock?: string;
      portRange?: {
          from: number;
          to: number;
      };
      protocol: number;
      ruleAction: "allow" | "deny";
      ruleNumber: number;
  }
  - Optional cidrBlock?: string
  - egress: boolean
  - Optional icmp?: {
    code?: number;
    type?: number;
    }
    - Optional code?: number
    - Optional type?: number
  - Optional ipv6CidrBlock?: string
  - Optional portRange?: {
    from: number;
    to: number;
    }
    - from: number
    - to: number
  - protocol: number
  - ruleAction: "allow" | "deny"
  - ruleNumber: number
Returns void

applyRemovalPolicy

applyRemovalPolicy(policy: RemovalPolicy): void
Apply the given removal policy to this resource

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
Parameters
- policy: RemovalPolicy
Returns void

Inherited from NetworkAclBase.applyRemovalPolicy

associateSubnet

associateSubnet(id: string, props: {
subnet: ISubnet;
}): void
Parameters
- id: string
- props: {
  subnet: ISubnet;
  }
  - subnet: ISubnet
Returns void

`Protected` generatePhysicalName

generatePhysicalName(): string
Returns string

Inherited from NetworkAclBase.generatePhysicalName

`Protected` getResourceArnAttribute

getResourceArnAttribute(arnAttr: string, arnComponents: ArnComponents): string
Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arnComponents.
Parameters
- arnAttr: string
  
  The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes it's the CFN resource's ref.
- arnComponents: ArnComponents
  
  The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.
Returns string

Inherited from NetworkAclBase.getResourceArnAttribute

`Protected` getResourceNameAttribute

getResourceNameAttribute(nameAttr: string): string
Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.
Parameters
- nameAttr: string
  
  The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref.
Returns string

Inherited from NetworkAclBase.getResourceNameAttribute

toString

toString(): string
Returns a string representation of this construct.

Stability
stable

Returns string

Inherited from NetworkAclBase.toString

`Static` isConstruct

isConstruct(x: any): x is Construct
(deprecated) Checks if x is a construct.

Returns
true if x is an object created from a class which extends Construct.

Deprecated
use x instanceof Construct instead
Parameters
- x: any
  
  Any object.
Returns x is Construct

Inherited from NetworkAclBase.isConstruct

`Static` isOwnedResource

isOwnedResource(construct: IConstruct): boolean
Returns true if the construct was created by CDK, and false otherwise
Parameters
- construct: IConstruct
Returns boolean

Inherited from NetworkAclBase.isOwnedResource

`Static` isResource

isResource(construct: IConstruct): construct is Resource
Check whether the given construct is a Resource
Parameters
- construct: IConstruct
Returns construct is Resource

Inherited from NetworkAclBase.isResource

Class NetworkAcl

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

scope: Construct

id: string

props: NetworkAclProps

Returns NetworkAcl

Properties

Readonly env

Readonly networkAclId

Attribute

Readonly networkAclName

Attribute

Readonly networkAclVpcId

Attribute

Readonly node

Stability

Protected Readonly physicalName

Readonly stack

Methods

_enableCrossEnvironment

Returns void

addEntry

Parameters

id: string

props: { cidrBlock?: string; egress: boolean; icmp?: { code?: number; type?: number; }; ipv6CidrBlock?: string; portRange?: { from: number; to: number; }; protocol: number; ruleAction: "allow" | "deny"; ruleNumber: number; }

Optional cidrBlock?: string

egress: boolean

Optional icmp?: { code?: number; type?: number; }

Optional code?: number

Optional type?: number

Optional ipv6CidrBlock?: string

Optional portRange?: { from: number; to: number; }

from: number

to: number

protocol: number

ruleAction: "allow" | "deny"

ruleNumber: number

Returns void

applyRemovalPolicy

Parameters

policy: RemovalPolicy

Returns void

associateSubnet

Parameters

id: string

props: { subnet: ISubnet; }

subnet: ISubnet

Returns void

Protected generatePhysicalName

Returns string

Protected getResourceArnAttribute

Parameters

arnAttr: string

arnComponents: ArnComponents

Returns string

Protected getResourceNameAttribute

Parameters

nameAttr: string

Returns string

toString

Stability

Returns string

Static isConstruct

Returns

Deprecated

Parameters

x: any

Returns x is Construct

Static isOwnedResource

Parameters

construct: IConstruct

Returns boolean

Static isResource

`Readonly` env

`Readonly` networkAclId

`Readonly` networkAclName

`Readonly` networkAclVpcId

`Readonly` node

`Protected` `Readonly` physicalName

`Readonly` stack

props: {
cidrBlock?: string;
egress: boolean;
icmp?: {
code?: number;
type?: number;
};
ipv6CidrBlock?: string;
portRange?: {
from: number;
to: number;
};
protocol: number;
ruleAction: "allow" | "deny";
ruleNumber: number;
}

`Optional` cidrBlock?: string

`Optional` icmp?: {
code?: number;
type?: number;
}

`Optional` code?: number

`Optional` type?: number

`Optional` ipv6CidrBlock?: string

`Optional` portRange?: {
from: number;
to: number;
}

props: {
subnet: ISubnet;
}

`Protected` generatePhysicalName

`Protected` getResourceArnAttribute

`Protected` getResourceNameAttribute

`Static` isConstruct

`Static` isOwnedResource

`Static` isResource