class VpnGateway (construct)

Language	Type name
.NET	Amazon.CDK.AWS.EC2.VpnGateway
Java	software.amazon.awscdk.services.ec2.VpnGateway
Python	aws_cdk.aws_ec2.VpnGateway
TypeScript (source)	@aws-cdk/aws-ec2 » VpnGateway

Implements IConstruct, IConstruct, IDependable, IResource, IVpnGateway

The VPN Gateway that shall be added to the VPC.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ec2 from '@aws-cdk/aws-ec2';
const vpnGateway = new ec2.VpnGateway(this, 'MyVpnGateway', {
  type: 'type',

  // the properties below are optional
  amazonSideAsn: 123,
});

Initializer

new VpnGateway(scope: Construct, id: string, props: VpnGatewayProps)

Parameters

• scope Construct
• id string
• props VpnGatewayProps

Construct Props

Name	Type	Description
type	string	Default type ipsec.1.
amazonSideAsn?	number	Explicitly specify an Asn or let aws pick an Asn for you.

---

type

Type: string

Default type ipsec.1.

---

amazonSideAsn?

Type: number (optional, default: 65000)

Explicitly specify an Asn or let aws pick an Asn for you.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
gatewayId	string	The virtual private gateway Id.
node	ConstructNode	The construct tree node associated with this construct.
stack	Stack	The stack in which this resource is defined.

---

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.

---

gatewayId

Type: string

The virtual private gateway Id.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

stack

Type: Stack

The stack in which this resource is defined.

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.