AWS Native v0.126.0, Sep 30 24

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.ec2.getVpcEndpoint

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

pulumi/pulumi-aws-native

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?

An endpoint of type GatewayLoadBalancer provides private connectivity between your VPC and virtual appliances from a service provider.

Using getVpcEndpoint

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVpcEndpoint(args: GetVpcEndpointArgs, opts?: InvokeOptions): Promise<GetVpcEndpointResult>
function getVpcEndpointOutput(args: GetVpcEndpointOutputArgs, opts?: InvokeOptions): Output<GetVpcEndpointResult>

def get_vpc_endpoint(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetVpcEndpointResult
def get_vpc_endpoint_output(id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetVpcEndpointResult]

func LookupVpcEndpoint(ctx *Context, args *LookupVpcEndpointArgs, opts ...InvokeOption) (*LookupVpcEndpointResult, error)
func LookupVpcEndpointOutput(ctx *Context, args *LookupVpcEndpointOutputArgs, opts ...InvokeOption) LookupVpcEndpointResultOutput

> Note: This function is named LookupVpcEndpoint in the Go SDK.

public static class GetVpcEndpoint 
{
    public static Task<GetVpcEndpointResult> InvokeAsync(GetVpcEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetVpcEndpointResult> Invoke(GetVpcEndpointInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVpcEndpointResult> getVpcEndpoint(GetVpcEndpointArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:ec2:getVpcEndpoint
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: The ID of the VPC endpoint.

Id string: The ID of the VPC endpoint.

id String: The ID of the VPC endpoint.

id string: The ID of the VPC endpoint.

id str: The ID of the VPC endpoint.

id String: The ID of the VPC endpoint.

getVpcEndpoint Result

The following output properties are available:

CreationTimestamp string

The date and time the VPC endpoint was created. For example: Fri Sep 28 23:34:36 UTC 2018.

DnsEntries List<string>

(Interface endpoints) The DNS entries for the endpoint. Each entry is a combination of the hosted zone ID and the DNS name. The entries are ordered as follows: regional public DNS, zonal public DNS, private DNS, and wildcard DNS. This order is not enforced for AWS Marketplace services.

The following is an example. In the first entry, the hosted zone ID is Z1HUB23UULQXV and the DNS name is vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com.

["Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com", "Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3-us-east-1a.ec2.us-east-1.vpce.amazonaws.com", "Z1C12344VYDITB0:ec2.us-east-1.amazonaws.com"]

If you update the PrivateDnsEnabled or SubnetIds properties, the DNS entries in the list will change.

Id string

The ID of the VPC endpoint.

NetworkInterfaceIds List<string>

(Interface endpoints) The network interface IDs. If you update the PrivateDnsEnabled or SubnetIds properties, the items in this list might change.

PolicyDocument 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. 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.

Search the CloudFormation User Guide for AWS::EC2::VPCEndpoint for more information about the expected schema for this property.

PrivateDnsEnabled bool

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

RouteTableIds List<string>

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

SecurityGroupIds List<string>

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.

SubnetIds List<string>

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.

CreationTimestamp string

The date and time the VPC endpoint was created. For example: Fri Sep 28 23:34:36 UTC 2018.

DnsEntries []string

The following is an example. In the first entry, the hosted zone ID is Z1HUB23UULQXV and the DNS name is vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com.

If you update the PrivateDnsEnabled or SubnetIds properties, the DNS entries in the list will change.

Id string

The ID of the VPC endpoint.

NetworkInterfaceIds []string

(Interface endpoints) The network interface IDs. If you update the PrivateDnsEnabled or SubnetIds properties, the items in this list might change.

PolicyDocument interface{}

Search the CloudFormation User Guide for AWS::EC2::VPCEndpoint for more information about the expected schema for this property.

PrivateDnsEnabled bool

RouteTableIds []string

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

SecurityGroupIds []string

SubnetIds []string

creationTimestamp String

The date and time the VPC endpoint was created. For example: Fri Sep 28 23:34:36 UTC 2018.

dnsEntries List<String>

The following is an example. In the first entry, the hosted zone ID is Z1HUB23UULQXV and the DNS name is vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com.

If you update the PrivateDnsEnabled or SubnetIds properties, the DNS entries in the list will change.

id String

The ID of the VPC endpoint.

networkInterfaceIds List<String>

(Interface endpoints) The network interface IDs. If you update the PrivateDnsEnabled or SubnetIds properties, the items in this list might change.

policyDocument Object

Search the CloudFormation User Guide for AWS::EC2::VPCEndpoint for more information about the expected schema for this property.

privateDnsEnabled Boolean

routeTableIds List<String>

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

securityGroupIds List<String>

subnetIds List<String>

creationTimestamp string

The date and time the VPC endpoint was created. For example: Fri Sep 28 23:34:36 UTC 2018.

dnsEntries string[]

The following is an example. In the first entry, the hosted zone ID is Z1HUB23UULQXV and the DNS name is vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com.

If you update the PrivateDnsEnabled or SubnetIds properties, the DNS entries in the list will change.

id string

The ID of the VPC endpoint.

networkInterfaceIds string[]

(Interface endpoints) The network interface IDs. If you update the PrivateDnsEnabled or SubnetIds properties, the items in this list might change.

policyDocument any

Search the CloudFormation User Guide for AWS::EC2::VPCEndpoint for more information about the expected schema for this property.

privateDnsEnabled boolean

routeTableIds string[]

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

securityGroupIds string[]

subnetIds string[]

creation_timestamp str

The date and time the VPC endpoint was created. For example: Fri Sep 28 23:34:36 UTC 2018.

dns_entries Sequence[str]

The following is an example. In the first entry, the hosted zone ID is Z1HUB23UULQXV and the DNS name is vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com.

If you update the PrivateDnsEnabled or SubnetIds properties, the DNS entries in the list will change.

id str

The ID of the VPC endpoint.

network_interface_ids Sequence[str]

(Interface endpoints) The network interface IDs. If you update the PrivateDnsEnabled or SubnetIds properties, the items in this list might change.

policy_document Any

Search the CloudFormation User Guide for AWS::EC2::VPCEndpoint for more information about the expected schema for this property.

private_dns_enabled bool

route_table_ids Sequence[str]

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

security_group_ids Sequence[str]

subnet_ids Sequence[str]

creationTimestamp String

The date and time the VPC endpoint was created. For example: Fri Sep 28 23:34:36 UTC 2018.

dnsEntries List<String>

The following is an example. In the first entry, the hosted zone ID is Z1HUB23UULQXV and the DNS name is vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com.

If you update the PrivateDnsEnabled or SubnetIds properties, the DNS entries in the list will change.

id String

The ID of the VPC endpoint.

networkInterfaceIds List<String>

(Interface endpoints) The network interface IDs. If you update the PrivateDnsEnabled or SubnetIds properties, the items in this list might change.

policyDocument Any