vpc_endpoint
Gets an individual vpc_endpoint
resource
Overview
Name | vpc_endpoint |
Type | Resource |
Description | vpc_endpoint |
Id | awscc.ec2.vpc_endpoint |
Fields
Name | Datatype | Description |
---|---|---|
id | string | |
creation_timestamp | string | |
dns_entries | array | |
network_interface_ids | array | |
policy_document | object | 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.<br/> For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint. |
private_dns_enabled | boolean | 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.<br/> To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``.<br/> This property is supported only for interface endpoints.<br/> Default: ``false`` |
route_table_ids | array | The IDs of the route tables. Routing is supported only for gateway endpoints. |
security_group_ids | array | 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. |
service_name | string | The name of the endpoint service. |
subnet_ids | array | 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. |
vpc_endpoint_type | string | The type of endpoint.<br/> Default: Gateway |
vpc_id | string | The ID of the VPC. |
region | string | AWS region. |
Methods
Currently only SELECT
is supported for this resource resource.
Example
SELECT
region,
id,
creation_timestamp,
dns_entries,
network_interface_ids,
policy_document,
private_dns_enabled,
route_table_ids,
security_group_ids,
service_name,
subnet_ids,
vpc_endpoint_type,
vpc_id
FROM awscc.ec2.vpc_endpoint
WHERE data__Identifier = '<Id>';
Permissions
To operate on the vpc_endpoint
resource, the following permissions are required:
Read
ec2:DescribeVpcEndpoints
Update
ec2:ModifyVpcEndpoint,
ec2:DescribeVpcEndpoints
Delete
ec2:DeleteVpcEndpoints,
ec2:DescribeVpcEndpoints