Skip to main content

vpc_endpoints

Creates, updates, deletes or gets a vpc_endpoint resource or lists vpc_endpoints in a region

Overview​

Namevpc_endpoints
TypeResource
DescriptionSpecifies 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 MKT Partner, or another AWS accounts in your organization. For more information, see the [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 S3 or DDB. 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 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.
Idawscc.ec2.vpc_endpoints

Fields​

NameDatatypeDescription
private_dns_enabledbooleanIndicate 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, &#96;&#96;kinesis.us-east-1.amazonaws.com&#96;&#96;), 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.<br />To use a private hosted zone, you must set the following VPC attributes to &#96;&#96;true&#96;&#96;: &#96;&#96;enableDnsHostnames&#96;&#96; and &#96;&#96;enableDnsSupport&#96;&#96;.<br />This property is supported only for interface endpoints.<br />Default: &#96;&#96;false&#96;&#96;
ip_address_typestringThe supported IP address types.
service_regionstringDescribes a Region.
creation_timestampstring
▶dns_optionsobjectDescribes the DNS options for an endpoint.
network_interface_idsarray
dns_entriesarray
resource_configuration_arnstringThe Amazon Resource Name (ARN) of the resource configuration.
security_group_idsarrayThe 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.
subnet_idsarrayThe 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.
service_network_arnstringThe Amazon Resource Name (ARN) of the service network.
vpc_idstringThe ID of the VPC.
route_table_idsarrayThe IDs of the route tables. Routing is supported only for gateway endpoints.
service_namestringThe name of the endpoint service.
policy_documentobjectAn 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.<br />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 CFNlong converts the policy to JSON format before calling the API actions for privatelink. Alternatively, you can include the JSON directly in the YAML, as shown in the following &#96;&#96;Properties&#96;&#96; section:<br />&#96;&#96;Properties: VpcEndpointType: 'Interface' ServiceName: !Sub 'com.amazonaws.$&#123;AWS::Region&#125;.logs' PolicyDocument: '&#123; "Version":"2012-10-17", "Statement": &#91;&#123; "Effect":"Allow", "Principal":"&#42;", "Action":&#91;"logs:Describe&#42;","logs:Get&#42;","logs:List&#42;","logs:FilterLogEvents"&#93;, "Resource":"&#42;" &#125;&#93; &#125;'&#96;&#96;
vpc_endpoint_typestringThe type of endpoint.<br />Default: Gateway
idstring
▶tagsarrayThe tags to associate with the endpoint.
regionstringAWS region.

For more information, see AWS::EC2::VPCEndpoint.

Methods​

NameResourceAccessible byRequired Params
create_resourcevpc_endpointsINSERTVpcId, region
delete_resourcevpc_endpointsDELETEIdentifier, region
update_resourcevpc_endpointsUPDATEIdentifier, PatchDocument, region
list_resourcesvpc_endpoints_list_onlySELECTregion
get_resourcevpc_endpointsSELECTIdentifier, region

SELECT examples​

Gets all properties from an individual vpc_endpoint.

SELECT
  region,
  private_dns_enabled,
  ip_address_type,
  service_region,
  creation_timestamp,
  dns_options,
  network_interface_ids,
  dns_entries,
  resource_configuration_arn,
  security_group_ids,
  subnet_ids,
  service_network_arn,
  vpc_id,
  route_table_ids,
  service_name,
  policy_document,
  vpc_endpoint_type,
  id,
  tags
FROM awscc.ec2.vpc_endpoints
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

INSERT example​

Use the following StackQL query and manifest file to create a new vpc_endpoint resource, using stack-deploy.

/*+ create */
INSERT INTO awscc.ec2.vpc_endpoints (
  VpcId,
  region
)
SELECT
  '{{ vpc_id }}',
  '{{ region }}';

UPDATE example​

Use the following StackQL query and manifest file to update a vpc_endpoint resource, using stack-deploy.

/*+ update */
UPDATE awscc.ec2.vpc_endpoints
SET PatchDocument = string('{{ {
    "PrivateDnsEnabled": private_dns_enabled,
    "IpAddressType": ip_address_type,
    "DnsOptions": dns_options,
    "SecurityGroupIds": security_group_ids,
    "SubnetIds": subnet_ids,
    "RouteTableIds": route_table_ids,
    "PolicyDocument": policy_document,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example​

/*+ delete */
DELETE FROM awscc.ec2.vpc_endpoints
WHERE
  Identifier = '{{ id }}' AND
  region = 'us-east-1';

Permissions​

To operate on the vpc_endpoints resource, the following permissions are required:

ec2:DescribeVpcEndpoints,
ec2:DescribeSubnets,
ec2:DescribeSecurityGroups,
vpc-lattice:DescribeServiceNetworkVpcEndpointAssociation,
ec2:DescribeVpcs