interface GatewayVpcEndpointProps

Language	Type name
.NET	Amazon.CDK.AWS.EC2.GatewayVpcEndpointProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsec2#GatewayVpcEndpointProps
Java	software.amazon.awscdk.services.ec2.GatewayVpcEndpointProps
Python	aws_cdk.aws_ec2.GatewayVpcEndpointProps
TypeScript (source)	aws-cdk-lib » aws_ec2 » GatewayVpcEndpointProps

Construction properties for a GatewayVpcEndpoint.

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 });

const dynamoEndpoint = new ec2.GatewayVpcEndpoint(this, 'DynamoEndpoint', {
  service: ec2.GatewayVpcEndpointAwsService.DYNAMODB,
  vpc: myVpc,
  subnets: [subnet],
});
new Route(this, 'DynamoDBRoute', {
  routeTable,
  destination: '0.0.0.0/0',
  target: { endpoint: dynamoEndpoint },
});

Properties

Name	Type	Description
service	IGatewayVpcEndpointService	The service to use for this gateway VPC endpoint.
vpc	IVpc	The VPC network in which the gateway endpoint will be used.
subnets?	SubnetSelection[]	Where to add endpoint routing.

---

service

Type: IGatewayVpcEndpointService

The service to use for this gateway VPC endpoint.

---

vpc

Type: IVpc

The VPC network in which the gateway endpoint will be used.

---

subnets?

Type: SubnetSelection[] (optional, default: All subnets in the VPC)

Where to add endpoint routing.

By default, this endpoint will be routable from all subnets in the VPC. Specify a list of subnet selection objects here to be more specific. Example

declare const vpc: ec2.Vpc;

vpc.addGatewayEndpoint('DynamoDbEndpoint', {
  service: ec2.GatewayVpcEndpointAwsService.DYNAMODB,
  // Add only to ISOLATED subnets
  subnets: [
    { subnetType: ec2.SubnetType.PRIVATE_ISOLATED }
  ]
});