aws-native.ec2.getVpcEndpoint

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

pulumi/pulumi-aws-native

Specifies 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. 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 [W

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

Id string

id String

id string

id str

id String

getVpcEndpoint Result

The following output properties are available:

CreationTimestamp string

DnsEntries List<string>

Id string

NetworkInterfaceIds List<string>

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.