Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. privatelink
  5. getVpcEndpoints
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.privatelink.getVpcEndpoints

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-alicloud

    This data source provides the Privatelink Vpc Endpoints of the current Alibaba Cloud user.

    NOTE: Available since v1.109.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const example = alicloud.privatelink.getVpcEndpoints({
    ids: ["example_value"],
    nameRegex: "the_resource_name",
});
export const firstPrivatelinkVpcEndpointId = example.then(example => example.endpoints?.[0]?.id);

    import pulumi
import pulumi_alicloud as alicloud

example = alicloud.privatelink.get_vpc_endpoints(ids=["example_value"],
    name_regex="the_resource_name")
pulumi.export("firstPrivatelinkVpcEndpointId", example.endpoints[0].id)

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/privatelink"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := privatelink.GetVpcEndpoints(ctx, &privatelink.GetVpcEndpointsArgs{
			Ids: []string{
				"example_value",
			},
			NameRegex: pulumi.StringRef("the_resource_name"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("firstPrivatelinkVpcEndpointId", example.Endpoints[0].Id)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var example = AliCloud.PrivateLink.GetVpcEndpoints.Invoke(new()
    {
        Ids = new[]
        {
            "example_value",
        },
        NameRegex = "the_resource_name",
    });

    return new Dictionary<string, object?>
    {
        ["firstPrivatelinkVpcEndpointId"] = example.Apply(getVpcEndpointsResult => getVpcEndpointsResult.Endpoints[0]?.Id),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.privatelink.PrivatelinkFunctions;
import com.pulumi.alicloud.privatelink.inputs.GetVpcEndpointsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = PrivatelinkFunctions.getVpcEndpoints(GetVpcEndpointsArgs.builder()
            .ids("example_value")
            .nameRegex("the_resource_name")
            .build());

        ctx.export("firstPrivatelinkVpcEndpointId", example.applyValue(getVpcEndpointsResult -> getVpcEndpointsResult.endpoints()[0].id()));
    }
}

    variables:
  example:
    fn::invoke:
      function: alicloud:privatelink:getVpcEndpoints
      arguments:
        ids:
          - example_value
        nameRegex: the_resource_name
outputs:
  firstPrivatelinkVpcEndpointId: ${example.endpoints[0].id}

    Using getVpcEndpoints

    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 getVpcEndpoints(args: GetVpcEndpointsArgs, opts?: InvokeOptions): Promise<GetVpcEndpointsResult>
function getVpcEndpointsOutput(args: GetVpcEndpointsOutputArgs, opts?: InvokeOptions): Output<GetVpcEndpointsResult>
    def get_vpc_endpoints(connection_status: Optional[str] = None,
                      enable_details: Optional[bool] = None,
                      ids: Optional[Sequence[str]] = None,
                      name_regex: Optional[str] = None,
                      output_file: Optional[str] = None,
                      service_name: Optional[str] = None,
                      status: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      vpc_endpoint_name: Optional[str] = None,
                      vpc_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetVpcEndpointsResult
def get_vpc_endpoints_output(connection_status: Optional[pulumi.Input[str]] = None,
                      enable_details: Optional[pulumi.Input[bool]] = None,
                      ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                      name_regex: Optional[pulumi.Input[str]] = None,
                      output_file: Optional[pulumi.Input[str]] = None,
                      service_name: Optional[pulumi.Input[str]] = None,
                      status: Optional[pulumi.Input[str]] = None,
                      tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                      vpc_endpoint_name: Optional[pulumi.Input[str]] = None,
                      vpc_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetVpcEndpointsResult]
    func GetVpcEndpoints(ctx *Context, args *GetVpcEndpointsArgs, opts ...InvokeOption) (*GetVpcEndpointsResult, error)
func GetVpcEndpointsOutput(ctx *Context, args *GetVpcEndpointsOutputArgs, opts ...InvokeOption) GetVpcEndpointsResultOutput

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

    public static class GetVpcEndpoints 
{
    public static Task<GetVpcEndpointsResult> InvokeAsync(GetVpcEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetVpcEndpointsResult> Invoke(GetVpcEndpointsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVpcEndpointsResult> getVpcEndpoints(GetVpcEndpointsArgs args, InvokeOptions options)
public static Output<GetVpcEndpointsResult> getVpcEndpoints(GetVpcEndpointsArgs args, InvokeOptions options)

    fn::invoke:
  function: alicloud:privatelink/getVpcEndpoints:getVpcEndpoints
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ConnectionStatus string
    The status of Connection.
    EnableDetails bool
    Default to false. Set it to true can output more details about resource attributes.
    Ids List<string>
    A list of Vpc Endpoint IDs.
    NameRegex string
    A regex string to filter results by Vpc Endpoint name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    ServiceName string
    The name of the terminal node service associated with the terminal node.
    Status string
    The status of Vpc Endpoint.
    Tags Dictionary<string, string>
    Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.
    VpcEndpointName string
    The name of Vpc Endpoint.
    VpcId string
    The private network to which the terminal node belongs..
    ConnectionStatus string
    The status of Connection.
    EnableDetails bool
    Default to false. Set it to true can output more details about resource attributes.
    Ids []string
    A list of Vpc Endpoint IDs.
    NameRegex string
    A regex string to filter results by Vpc Endpoint name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    ServiceName string
    The name of the terminal node service associated with the terminal node.
    Status string
    The status of Vpc Endpoint.
    Tags map[string]string
    Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.
    VpcEndpointName string
    The name of Vpc Endpoint.
    VpcId string
    The private network to which the terminal node belongs..
    connectionStatus String
    The status of Connection.
    enableDetails Boolean
    Default to false. Set it to true can output more details about resource attributes.
    ids List<String>
    A list of Vpc Endpoint IDs.
    nameRegex String
    A regex string to filter results by Vpc Endpoint name.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    serviceName String
    The name of the terminal node service associated with the terminal node.
    status String
    The status of Vpc Endpoint.
    tags Map<String,String>
    Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.
    vpcEndpointName String
    The name of Vpc Endpoint.
    vpcId String
    The private network to which the terminal node belongs..
    connectionStatus string
    The status of Connection.
    enableDetails boolean
    Default to false. Set it to true can output more details about resource attributes.
    ids string[]
    A list of Vpc Endpoint IDs.
    nameRegex string
    A regex string to filter results by Vpc Endpoint name.
    outputFile string
    File name where to save data source results (after running pulumi preview).
    serviceName string
    The name of the terminal node service associated with the terminal node.
    status string
    The status of Vpc Endpoint.
    tags {[key: string]: string}
    Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.
    vpcEndpointName string
    The name of Vpc Endpoint.
    vpcId string
    The private network to which the terminal node belongs..
    connection_status str
    The status of Connection.
    enable_details bool
    Default to false. Set it to true can output more details about resource attributes.
    ids Sequence[str]
    A list of Vpc Endpoint IDs.
    name_regex str
    A regex string to filter results by Vpc Endpoint name.
    output_file str
    File name where to save data source results (after running pulumi preview).
    service_name str
    The name of the terminal node service associated with the terminal node.
    status str
    The status of Vpc Endpoint.
    tags Mapping[str, str]
    Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.
    vpc_endpoint_name str
    The name of Vpc Endpoint.
    vpc_id str
    The private network to which the terminal node belongs..
    connectionStatus String
    The status of Connection.
    enableDetails Boolean
    Default to false. Set it to true can output more details about resource attributes.
    ids List<String>
    A list of Vpc Endpoint IDs.
    nameRegex String
    A regex string to filter results by Vpc Endpoint name.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    serviceName String
    The name of the terminal node service associated with the terminal node.
    status String
    The status of Vpc Endpoint.
    tags Map<String>
    Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.
    vpcEndpointName String
    The name of Vpc Endpoint.
    vpcId String
    The private network to which the terminal node belongs..

    getVpcEndpoints Result

    The following output properties are available:

    Endpoints List<Pulumi.AliCloud.PrivateLink.Outputs.GetVpcEndpointsEndpoint>
    A list of Privatelink Vpc Endpoints. Each element contains the following attributes:
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    Names List<string>
    A list of Vpc Endpoint names.
    ConnectionStatus string
    The status of Connection.
    EnableDetails bool
    NameRegex string
    OutputFile string
    ServiceName string
    The name of the terminal node service associated with the terminal node.
    Status string
    The status of Vpc Endpoint.
    Tags Dictionary<string, string>
    Tag tags of Vpc Endpoint.
    VpcEndpointName string
    The name of Vpc Endpoint.
    VpcId string
    The private network to which the terminal node belongs.
    Endpoints []GetVpcEndpointsEndpoint
    A list of Privatelink Vpc Endpoints. Each element contains the following attributes:
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    Names []string
    A list of Vpc Endpoint names.
    ConnectionStatus string
    The status of Connection.
    EnableDetails bool
    NameRegex string
    OutputFile string
    ServiceName string
    The name of the terminal node service associated with the terminal node.
    Status string
    The status of Vpc Endpoint.
    Tags map[string]string
    Tag tags of Vpc Endpoint.
    VpcEndpointName string
    The name of Vpc Endpoint.
    VpcId string
    The private network to which the terminal node belongs.
    endpoints List<GetVpcEndpointsEndpoint>
    A list of Privatelink Vpc Endpoints. Each element contains the following attributes:
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    names List<String>
    A list of Vpc Endpoint names.
    connectionStatus String
    The status of Connection.
    enableDetails Boolean
    nameRegex String
    outputFile String
    serviceName String
    The name of the terminal node service associated with the terminal node.
    status String
    The status of Vpc Endpoint.
    tags Map<String,String>
    Tag tags of Vpc Endpoint.
    vpcEndpointName String
    The name of Vpc Endpoint.
    vpcId String
    The private network to which the terminal node belongs.
    endpoints GetVpcEndpointsEndpoint[]
    A list of Privatelink Vpc Endpoints. Each element contains the following attributes:
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    names string[]
    A list of Vpc Endpoint names.
    connectionStatus string
    The status of Connection.
    enableDetails boolean
    nameRegex string
    outputFile string
    serviceName string
    The name of the terminal node service associated with the terminal node.
    status string
    The status of Vpc Endpoint.
    tags {[key: string]: string}
    Tag tags of Vpc Endpoint.
    vpcEndpointName string
    The name of Vpc Endpoint.
    vpcId string
    The private network to which the terminal node belongs.
    endpoints Sequence[GetVpcEndpointsEndpoint]
    A list of Privatelink Vpc Endpoints. Each element contains the following attributes:
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    names Sequence[str]
    A list of Vpc Endpoint names.
    connection_status str
    The status of Connection.
    enable_details bool
    name_regex str
    output_file str
    service_name str
    The name of the terminal node service associated with the terminal node.
    status str
    The status of Vpc Endpoint.
    tags Mapping[str, str]
    Tag tags of Vpc Endpoint.
    vpc_endpoint_name str
    The name of Vpc Endpoint.
    vpc_id str
    The private network to which the terminal node belongs.
    endpoints List<Property Map>
    A list of Privatelink Vpc Endpoints. Each element contains the following attributes:
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    names List<String>
    A list of Vpc Endpoint names.
    connectionStatus String
    The status of Connection.
    enableDetails Boolean
    nameRegex String
    outputFile String
    serviceName String
    The name of the terminal node service associated with the terminal node.
    status String
    The status of Vpc Endpoint.
    tags Map<String>
    Tag tags of Vpc Endpoint.
    vpcEndpointName String
    The name of Vpc Endpoint.
    vpcId String
    The private network to which the terminal node belongs.

    Supporting Types

    GetVpcEndpointsEndpoint

    Bandwidth int
    The Bandwidth.
    ConnectionStatus string
    The status of Connection.
    EndpointBusinessStatus string
    The status of Endpoint Business.
    EndpointDescription string
    The description of Vpc Endpoint.
    EndpointDomain string
    The Endpoint Domain.
    EndpointId string
    The ID of the Vpc Endpoint.
    Id string
    The ID of the Vpc Endpoint.
    SecurityGroupIds List<string>
    The security group associated with the terminal node network card.
    ServiceId string
    The terminal node service associated with the terminal node.
    ServiceName string
    The name of the terminal node service associated with the terminal node.
    Status string
    The status of Vpc Endpoint.
    Tags Dictionary<string, string>
    Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.
    VpcEndpointName string
    The name of Vpc Endpoint.
    VpcId string
    The private network to which the terminal node belongs..
    Bandwidth int
    The Bandwidth.
    ConnectionStatus string
    The status of Connection.
    EndpointBusinessStatus string
    The status of Endpoint Business.
    EndpointDescription string
    The description of Vpc Endpoint.
    EndpointDomain string
    The Endpoint Domain.
    EndpointId string
    The ID of the Vpc Endpoint.
    Id string
    The ID of the Vpc Endpoint.
    SecurityGroupIds []string
    The security group associated with the terminal node network card.
    ServiceId string
    The terminal node service associated with the terminal node.
    ServiceName string
    The name of the terminal node service associated with the terminal node.
    Status string
    The status of Vpc Endpoint.
    Tags map[string]string
    Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.
    VpcEndpointName string
    The name of Vpc Endpoint.
    VpcId string
    The private network to which the terminal node belongs..
    bandwidth Integer
    The Bandwidth.
    connectionStatus String
    The status of Connection.
    endpointBusinessStatus String
    The status of Endpoint Business.
    endpointDescription String
    The description of Vpc Endpoint.
    endpointDomain String
    The Endpoint Domain.
    endpointId String
    The ID of the Vpc Endpoint.
    id String
    The ID of the Vpc Endpoint.
    securityGroupIds List<String>
    The security group associated with the terminal node network card.
    serviceId String
    The terminal node service associated with the terminal node.
    serviceName String
    The name of the terminal node service associated with the terminal node.
    status String
    The status of Vpc Endpoint.
    tags Map<String,String>
    Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.
    vpcEndpointName String
    The name of Vpc Endpoint.
    vpcId String
    The private network to which the terminal node belongs..
    bandwidth number
    The Bandwidth.
    connectionStatus string
    The status of Connection.
    endpointBusinessStatus string
    The status of Endpoint Business.
    endpointDescription string
    The description of Vpc Endpoint.
    endpointDomain string
    The Endpoint Domain.
    endpointId string
    The ID of the Vpc Endpoint.
    id string
    The ID of the Vpc Endpoint.
    securityGroupIds string[]
    The security group associated with the terminal node network card.
    serviceId string
    The terminal node service associated with the terminal node.
    serviceName string
    The name of the terminal node service associated with the terminal node.
    status string
    The status of Vpc Endpoint.
    tags {[key: string]: string}
    Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.
    vpcEndpointName string
    The name of Vpc Endpoint.
    vpcId string
    The private network to which the terminal node belongs..
    bandwidth int
    The Bandwidth.
    connection_status str
    The status of Connection.
    endpoint_business_status str
    The status of Endpoint Business.
    endpoint_description str
    The description of Vpc Endpoint.
    endpoint_domain str
    The Endpoint Domain.
    endpoint_id str
    The ID of the Vpc Endpoint.
    id str
    The ID of the Vpc Endpoint.
    security_group_ids Sequence[str]
    The security group associated with the terminal node network card.
    service_id str
    The terminal node service associated with the terminal node.
    service_name str
    The name of the terminal node service associated with the terminal node.
    status str
    The status of Vpc Endpoint.
    tags Mapping[str, str]
    Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.
    vpc_endpoint_name str
    The name of Vpc Endpoint.
    vpc_id str
    The private network to which the terminal node belongs..
    bandwidth Number
    The Bandwidth.
    connectionStatus String
    The status of Connection.
    endpointBusinessStatus String
    The status of Endpoint Business.
    endpointDescription String
    The description of Vpc Endpoint.
    endpointDomain String
    The Endpoint Domain.
    endpointId String
    The ID of the Vpc Endpoint.
    id String
    The ID of the Vpc Endpoint.
    securityGroupIds List<String>
    The security group associated with the terminal node network card.
    serviceId String
    The terminal node service associated with the terminal node.
    serviceName String
    The name of the terminal node service associated with the terminal node.
    status String
    The status of Vpc Endpoint.
    tags Map<String>
    Query the instance bound to the tag. The format of the incoming value is json string, including TagKey and TagValue. TagKey cannot be null, and TagValue can be empty. Format example {"key1":"value1"}.
    vpcEndpointName String
    The name of Vpc Endpoint.
    vpcId String
    The private network to which the terminal node belongs..

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-alicloud