aws-cdk-lib.aws_ec2.ISubnet

interface ISubnet

LanguageType name
.NETAmazon.CDK.AWS.EC2.ISubnet
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#ISubnet
Javasoftware.amazon.awscdk.services.ec2.ISubnet
Pythonaws_cdk.aws_ec2.ISubnet
TypeScript (source)aws-cdk-lib » aws_ec2 » ISubnet

Implemented by PrivateSubnet, PublicSubnet, Subnet

Obtainable from Subnet.fromSubnetAttributes(), Subnet.fromSubnetId()

Properties

NameTypeDescription
availabilityZonestringThe Availability Zone the subnet is located in.
envResourceEnvironmentThe environment this resource belongs to.
internetConnectivityEstablishedIDependableDependable that can be depended upon to force internet connectivity established on the VPC.
ipv4CidrBlockstringThe IPv4 CIDR block for this subnet.
nodeNodeThe tree node.
routeTableIRouteTableThe route table for this subnet.
stackStackThe stack in which this resource is defined.
subnetIdstringThe subnetId for this particular subnet.

availabilityZone

Type: string

The Availability Zone the subnet is located in.


env

Type: 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.


internetConnectivityEstablished

Type: IDependable

Dependable that can be depended upon to force internet connectivity established on the VPC.


ipv4CidrBlock

Type: string

The IPv4 CIDR block for this subnet.


node

Type: Node

The tree node.


routeTable

Type: IRouteTable

The route table for this subnet.


stack

Type: Stack

The stack in which this resource is defined.


subnetId

Type: string

The subnetId for this particular subnet.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
associateNetworkAcl(id, acl)Associate a Network ACL with this subnet.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

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).


associateNetworkAcl(id, acl)

public associateNetworkAcl(id: string, acl: INetworkAcl): void

Parameters

  • id string
  • acl INetworkAcl — The Network ACL to associate.

Associate a Network ACL with this subnet.