AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::EC2::VPCEndpoint

CfnVPCEndpoint

Specifies a VPC endpoint. A VPC endpoint provides a private connection between your VPC and an endpoint service. You can use an endpoint service provided by AWS , an AWS Marketplace Partner, or another AWS accounts in your organization. For more information, see the [AWS PrivateLink User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/) . An endpoint of type `Interface` establishes connections between the subnets in your VPC and an AWS service , your own service, or a service hosted by another AWS account . With an interface VPC endpoint, you specify the subnets in which to create the endpoint and the security groups to associate with the endpoint network interfaces. An endpoint of type `gateway` serves as a target for a route in your route table for traffic destined for Amazon S3 or DynamoDB . You can specify an endpoint policy for the endpoint, which controls access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. For more information about connectivity to Amazon S3 , see [Why can't I connect to an S3 bucket using a gateway VPC endpoint?](https://docs.aws.amazon.com/premiumsupport/knowledge-center/connect-s3-vpc-endpoint) An endpoint of type `GatewayLoadBalancer` provides private connectivity between your VPC and virtual appliances from a service provider.

Import

import { CfnVPCEndpoint } from 'aws-cdk-lib/aws-ec2';

Or use the module namespace:

import * as ec2 from 'aws-cdk-lib/aws-ec2';
// ec2.CfnVPCEndpoint

Properties

Configuration passed to the constructor as CfnVPCEndpointProps.

vpcIdRequired
string | IVPCRef

The ID of the VPC.

dnsOptionsOptional
IResolvable | DnsOptionsSpecificationProperty

Describes the DNS options for an endpoint.

ipAddressTypeOptional
string

The supported IP address types.

policyDocumentOptional
any

An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints. For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. For example, if you have a JSON policy, you can convert it to YAML before including it in the YAML template, and AWS CloudFormation converts the policy to JSON format before calling the API actions for AWS PrivateLink . Alternatively, you can include the JSON directly in the YAML, as shown in the following `Properties` section: `Properties: VpcEndpointType: 'Interface' ServiceName: !Sub 'com.amazonaws.${AWS::Region}.logs' PolicyDocument: '{ "Version":"2012-10-17", "Statement": [{ "Effect":"Allow", "Principal":"*", "Action":["logs:Describe*","logs:Get*","logs:List*","logs:FilterLogEvents"], "Resource":"*" }] }'`

privateDnsEnabledOptional
boolean | IResolvable

Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, `kinesis.us-east-1.amazonaws.com` ), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service. To use a private hosted zone, you must set the following VPC attributes to `true` : `enableDnsHostnames` and `enableDnsSupport` . This property is supported only for interface endpoints. Default: `false`

resourceConfigurationArnOptional
string

The Amazon Resource Name (ARN) of the resource configuration.

routeTableIdsOptional
string | IRouteTableRef[]

The IDs of the route tables. Routing is supported only for gateway endpoints.

securityGroupIdsOptional
string | ISecurityGroupRef[]

The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.

serviceNameOptional
string

The name of the endpoint service.

serviceNetworkArnOptional
string

The Amazon Resource Name (ARN) of the service network.

serviceRegionOptional
string

Describes a Region.

subnetIdsOptional
string | ISubnetRef[]

The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.

tagsOptional
CfnTag[]

The tags to associate with the endpoint.

vpcEndpointTypeOptional
string

The type of endpoint. Default: Gateway

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::EC2::VPCEndpointView in CloudFormation Explorer

Get the Amazon EC2 Cheat Sheet

Everything you need to know about Amazon EC2 on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-ec2
CFN TypeAWS::EC2::VPCEndpoint
Properties14

Related Constructs

Explore This Service

External Links