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

Properties

env networkAclId networkAclName networkAclVpcId node physicalName stack

Methods

_enableCrossEnvironment applyRemovalPolicy getResourceArnAttribute getResourceNameAttribute toString isConstruct isOwnedResource isResource

Properties

Readonlyenv

env: ResourceEnvironment

The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ReadonlynetworkAclId

networkAclId: string

The ID of the NetworkACL

Attribute

ReadonlynetworkAclName

networkAclName: string

The Name of the NetworkACL

Attribute

ReadonlynetworkAclVpcId

networkAclVpcId: string

The VPC ID for this NetworkACL

Attribute

Readonlynode

node: Node

The tree node.

Stability

stable

Protected ReadonlyphysicalName

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.

Readonlystack

stack: Stack

The stack in which this resource is defined.

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

applyRemovalPolicy

  • applyRemovalPolicy(policy): 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

ProtectedgetResourceArnAttribute

  • getResourceArnAttribute(arnAttr, 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

ProtectedgetResourceNameAttribute

  • getResourceNameAttribute(nameAttr): 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

toString

  • toString(): string

  • Returns a string representation of this construct.

    Returns string

    Stability

    stable

StaticisConstruct

  • isConstruct(x): x is Construct

  • (deprecated) Checks if x is a construct.

    Parameters

    • x: any

      Any object.

    Returns x is Construct

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

    Deprecated

    use x instanceof Construct instead

StaticisOwnedResource

  • isOwnedResource(construct): boolean

  • Returns true if the construct was created by CDK, and false otherwise

    Parameters

    • construct: IConstruct

    Returns boolean

StaticisResource

  • isResource(construct): construct is Resource

  • Check whether the given construct is a Resource

    Parameters

    • construct: IConstruct

    Returns construct is Resource

Settings

Member Visibility

On This Page

Properties
Methods