class VpcEndpoint

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

Implements IConstruct, IConstruct, IDependable, IResource, IVpcEndpoint

Extends Resource

Implemented by GatewayVpcEndpoint, InterfaceVpcEndpoint

Initializer

new VpcEndpoint(scope: Construct, id: string, props?: ResourceProps)

Parameters

• scope Construct
• id string
• props ResourceProps

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	ConstructNode	The construct tree node associated with this construct.
stack	Stack	The stack in which this resource is defined.
vpcEndpointId	string	The VPC endpoint identifier.
policyDocument?	PolicyDocument

---

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: ConstructNode

The construct tree node associated with this construct.

---

stack

Type: Stack

The stack in which this resource is defined.

---

vpcEndpointId

Type: string

The VPC endpoint identifier.

---

policyDocument?

Type: PolicyDocument (optional)

Methods

Name	Description
addToPolicy(statement)	Adds a statement to the policy document of the VPC endpoint. The statement must have a Principal.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.

---

addToPolicy(statement)

public addToPolicy(statement: PolicyStatement): void

Parameters

• statement PolicyStatement — the IAM statement to add.

Adds a statement to the policy document of the VPC endpoint. The statement must have a Principal.

Not all interface VPC endpoints support policy. For more information see https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html

---

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.