GatewayVpcEndpointProps

class aws_cdk.aws_ec2.GatewayVpcEndpointProps(*, service, dns_record_ip_type=None, ip_address_type=None, subnets=None, vpc)

Bases: GatewayVpcEndpointOptions

Construction properties for a GatewayVpcEndpoint.

Parameters:

service (IGatewayVpcEndpointService) – The service to use for this gateway VPC endpoint.
dns_record_ip_type (Optional[VpcEndpointDnsRecordIpType]) – Type of DNS records created for the VPC endpoint. Default: not specified
ip_address_type (Optional[VpcEndpointIpAddressType]) – The IP address type for the endpoint. Default: not specified
subnets (Optional[Sequence[Union[SubnetSelection, Dict[str, Any]]]]) – 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. Default: - All subnets in the VPC
vpc (IVpc) – The VPC network in which the gateway endpoint will be used.

ExampleMetadata:

infused

Example:

stack = Stack()
my_vpc = VpcV2(self, "Vpc")
route_table = RouteTable(self, "RouteTable",
    vpc=my_vpc
)
subnet = SubnetV2(self, "Subnet",
    vpc=my_vpc,
    availability_zone="eu-west-2a",
    ipv4_cidr_block=IpCidr("10.0.0.0/24"),
    subnet_type=SubnetType.PRIVATE
)

dynamo_endpoint = ec2.GatewayVpcEndpoint(self, "DynamoEndpoint",
    service=ec2.GatewayVpcEndpointAwsService.DYNAMODB,
    vpc=my_vpc,
    subnets=[subnet]
)
Route(self, "DynamoDBRoute",
    route_table=route_table,
    destination="0.0.0.0/0",
    target={"endpoint": dynamo_endpoint}
)

Attributes

dns_record_ip_type

Type of DNS records created for the VPC endpoint.

Default:: not specified

ip_address_type

The IP address type for the endpoint.

Default:: not specified

service: The service to use for this gateway VPC endpoint.

subnets

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.

Default:

All subnets in the VPC

Example:

# vpc: ec2.Vpc


vpc.add_gateway_endpoint("DynamoDbEndpoint",
    service=ec2.GatewayVpcEndpointAwsService.DYNAMODB,
    # Add only to ISOLATED subnets
    subnets=[ec2.SubnetSelection(subnet_type=ec2.SubnetType.PRIVATE_ISOLATED)
    ]
)

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