class InternetGateway (construct) 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.ec2.Alpha.InternetGateway`
Go	`github.com/aws/aws-cdk-go/awsec2alpha/v2#InternetGateway`
Java	`software.amazon.awscdk.services.ec2.alpha.InternetGateway`
Python	`aws_cdk.aws_ec2_alpha.InternetGateway`
TypeScript (source)	`@aws-cdk/aws-ec2-alpha` » `InternetGateway`

Implements IConstruct, IDependable, IResource, IRouteTarget

Creates an internet gateway.

Example

const stack = new Stack();
const myVpc = new VpcV2(this, 'Vpc');
const routeTable = new RouteTable(this, 'RouteTable', {
  vpc: myVpc,
});
const subnet = new SubnetV2(this, 'Subnet', {
  vpc: myVpc,
  availabilityZone: 'eu-west-2a',
  ipv4CidrBlock: new IpCidr('10.0.0.0/24'),
  subnetType: SubnetType.PRIVATE_ISOLATED });

const igw = new InternetGateway(this, 'IGW', {
  vpc: myVpc,
});
new Route(this, 'IgwRoute', {
  routeTable,
  destination: '0.0.0.0/0',
  target:  { gateway: igw },
});

Initializer

new InternetGateway(scope: Construct, id: string, props: InternetGatewayProps)

Parameters

scope Construct
id string
props InternetGatewayProps

Construct Props

Name	Type	Description
vpc🔹	`IVpcV2`	The ID of the VPC for which to create the internet gateway.
internetGatewayName?🔹	`string`	The resource name of the internet gateway.

vpc🔹

Type: IVpcV2

The ID of the VPC for which to create the internet gateway.

internetGatewayName?🔹

Type: string (optional, default: provisioned without a resource name)

The resource name of the internet gateway.

Properties

Name	Type	Description
env🔹	`ResourceEnvironment`	The environment this resource belongs to.
node🔹	`Node`	The tree node.
resource🔹	`CfnInternetGateway`	The internet gateway CFN resource.
routerTargetId🔹	`string`	The ID of the route target.
routerType🔹	`RouterType`	The type of router used in the route.
stack🔹	`Stack`	The stack in which this resource is defined.
vpcId🔹	`string`	The ID of the VPC for which to create the internet gateway.

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.

node🔹

Type: Node

The tree node.

resource🔹

Type: CfnInternetGateway

The internet gateway CFN resource.

routerTargetId🔹

Type: string

The ID of the route target.

routerType🔹

Type: RouterType

The type of router used in the route.

stack🔹

Type: Stack

The stack in which this resource is defined.

vpcId🔹

Type: string

The ID of the VPC for which to create the internet gateway.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.

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

toString()🔹

public toString(): string

Returns

string

Returns a string representation of this construct.