Docs Packages
  1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. privatelink
  5. VpcEndpoint
Alibaba Cloud v3.53.0 published on Wednesday, Apr 17, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.privatelink.VpcEndpoint

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.53.0 published on Wednesday, Apr 17, 2024 by Pulumi
pulumi/pulumi-alicloud

    Provides a Private Link Vpc Endpoint resource.

    For information about Private Link Vpc Endpoint and how to use it, see What is Vpc Endpoint.

    NOTE: Available since v1.109.0.

    Example Usage

    Basic Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "tf-example";
const exampleVpcEndpointService = new alicloud.privatelink.VpcEndpointService("exampleVpcEndpointService", {
    serviceDescription: name,
    connectBandwidth: 103,
    autoAcceptConnection: false,
});
const exampleNetwork = new alicloud.vpc.Network("exampleNetwork", {
    vpcName: name,
    cidrBlock: "10.0.0.0/8",
});
const exampleSecurityGroup = new alicloud.ecs.SecurityGroup("exampleSecurityGroup", {vpcId: exampleNetwork.id});
const exampleVpcEndpoint = new alicloud.privatelink.VpcEndpoint("exampleVpcEndpoint", {
    serviceId: exampleVpcEndpointService.id,
    securityGroupIds: [exampleSecurityGroup.id],
    vpcId: exampleNetwork.id,
    vpcEndpointName: name,
});

    import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "tf-example"
example_vpc_endpoint_service = alicloud.privatelink.VpcEndpointService("exampleVpcEndpointService",
    service_description=name,
    connect_bandwidth=103,
    auto_accept_connection=False)
example_network = alicloud.vpc.Network("exampleNetwork",
    vpc_name=name,
    cidr_block="10.0.0.0/8")
example_security_group = alicloud.ecs.SecurityGroup("exampleSecurityGroup", vpc_id=example_network.id)
example_vpc_endpoint = alicloud.privatelink.VpcEndpoint("exampleVpcEndpoint",
    service_id=example_vpc_endpoint_service.id,
    security_group_ids=[example_security_group.id],
    vpc_id=example_network.id,
    vpc_endpoint_name=name)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "tf-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		exampleVpcEndpointService, err := privatelink.NewVpcEndpointService(ctx, "exampleVpcEndpointService", &privatelink.VpcEndpointServiceArgs{
			ServiceDescription:   pulumi.String(name),
			ConnectBandwidth:     pulumi.Int(103),
			AutoAcceptConnection: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		exampleNetwork, err := vpc.NewNetwork(ctx, "exampleNetwork", &vpc.NetworkArgs{
			VpcName:   pulumi.String(name),
			CidrBlock: pulumi.String("10.0.0.0/8"),
		})
		if err != nil {
			return err
		}
		exampleSecurityGroup, err := ecs.NewSecurityGroup(ctx, "exampleSecurityGroup", &ecs.SecurityGroupArgs{
			VpcId: exampleNetwork.ID(),
		})
		if err != nil {
			return err
		}
		_, err = privatelink.NewVpcEndpoint(ctx, "exampleVpcEndpoint", &privatelink.VpcEndpointArgs{
			ServiceId: exampleVpcEndpointService.ID(),
			SecurityGroupIds: pulumi.StringArray{
				exampleSecurityGroup.ID(),
			},
			VpcId:           exampleNetwork.ID(),
			VpcEndpointName: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "tf-example";
    var exampleVpcEndpointService = new AliCloud.PrivateLink.VpcEndpointService("exampleVpcEndpointService", new()
    {
        ServiceDescription = name,
        ConnectBandwidth = 103,
        AutoAcceptConnection = false,
    });

    var exampleNetwork = new AliCloud.Vpc.Network("exampleNetwork", new()
    {
        VpcName = name,
        CidrBlock = "10.0.0.0/8",
    });

    var exampleSecurityGroup = new AliCloud.Ecs.SecurityGroup("exampleSecurityGroup", new()
    {
        VpcId = exampleNetwork.Id,
    });

    var exampleVpcEndpoint = new AliCloud.PrivateLink.VpcEndpoint("exampleVpcEndpoint", new()
    {
        ServiceId = exampleVpcEndpointService.Id,
        SecurityGroupIds = new[]
        {
            exampleSecurityGroup.Id,
        },
        VpcId = exampleNetwork.Id,
        VpcEndpointName = name,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.privatelink.VpcEndpointService;
import com.pulumi.alicloud.privatelink.VpcEndpointServiceArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.ecs.SecurityGroup;
import com.pulumi.alicloud.ecs.SecurityGroupArgs;
import com.pulumi.alicloud.privatelink.VpcEndpoint;
import com.pulumi.alicloud.privatelink.VpcEndpointArgs;
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 config = ctx.config();
        final var name = config.get("name").orElse("tf-example");
        var exampleVpcEndpointService = new VpcEndpointService("exampleVpcEndpointService", VpcEndpointServiceArgs.builder()        
            .serviceDescription(name)
            .connectBandwidth(103)
            .autoAcceptConnection(false)
            .build());

        var exampleNetwork = new Network("exampleNetwork", NetworkArgs.builder()        
            .vpcName(name)
            .cidrBlock("10.0.0.0/8")
            .build());

        var exampleSecurityGroup = new SecurityGroup("exampleSecurityGroup", SecurityGroupArgs.builder()        
            .vpcId(exampleNetwork.id())
            .build());

        var exampleVpcEndpoint = new VpcEndpoint("exampleVpcEndpoint", VpcEndpointArgs.builder()        
            .serviceId(exampleVpcEndpointService.id())
            .securityGroupIds(exampleSecurityGroup.id())
            .vpcId(exampleNetwork.id())
            .vpcEndpointName(name)
            .build());

    }
}

    configuration:
  name:
    type: string
    default: tf-example
resources:
  exampleVpcEndpointService:
    type: alicloud:privatelink:VpcEndpointService
    properties:
      serviceDescription: ${name}
      connectBandwidth: 103
      autoAcceptConnection: false
  exampleNetwork:
    type: alicloud:vpc:Network
    properties:
      vpcName: ${name}
      cidrBlock: 10.0.0.0/8
  exampleSecurityGroup:
    type: alicloud:ecs:SecurityGroup
    properties:
      vpcId: ${exampleNetwork.id}
  exampleVpcEndpoint:
    type: alicloud:privatelink:VpcEndpoint
    properties:
      serviceId: ${exampleVpcEndpointService.id}
      securityGroupIds:
        - ${exampleSecurityGroup.id}
      vpcId: ${exampleNetwork.id}
      vpcEndpointName: ${name}

    Create VpcEndpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VpcEndpoint(name: string, args: VpcEndpointArgs, opts?: CustomResourceOptions);
    @overload
def VpcEndpoint(resource_name: str,
                args: VpcEndpointArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def VpcEndpoint(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                security_group_ids: Optional[Sequence[str]] = None,
                vpc_id: Optional[str] = None,
                dry_run: Optional[bool] = None,
                endpoint_description: Optional[str] = None,
                endpoint_type: Optional[str] = None,
                protected_enabled: Optional[bool] = None,
                resource_group_id: Optional[str] = None,
                service_id: Optional[str] = None,
                service_name: Optional[str] = None,
                tags: Optional[Mapping[str, Any]] = None,
                vpc_endpoint_name: Optional[str] = None,
                zone_private_ip_address_count: Optional[int] = None)
    func NewVpcEndpoint(ctx *Context, name string, args VpcEndpointArgs, opts ...ResourceOption) (*VpcEndpoint, error)
    public VpcEndpoint(string name, VpcEndpointArgs args, CustomResourceOptions? opts = null)
    public VpcEndpoint(String name, VpcEndpointArgs args)
public VpcEndpoint(String name, VpcEndpointArgs args, CustomResourceOptions options)

    type: alicloud:privatelink:VpcEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VpcEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VpcEndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VpcEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var vpcEndpointResource = new AliCloud.PrivateLink.VpcEndpoint("vpcEndpointResource", new()
{
    SecurityGroupIds = new[]
    {
        "string",
    },
    VpcId = "string",
    DryRun = false,
    EndpointDescription = "string",
    EndpointType = "string",
    ProtectedEnabled = false,
    ResourceGroupId = "string",
    ServiceId = "string",
    ServiceName = "string",
    Tags = 
    {
        { "string", "any" },
    },
    VpcEndpointName = "string",
    ZonePrivateIpAddressCount = 0,
});

    example, err := privatelink.NewVpcEndpoint(ctx, "vpcEndpointResource", &privatelink.VpcEndpointArgs{
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	VpcId:               pulumi.String("string"),
	DryRun:              pulumi.Bool(false),
	EndpointDescription: pulumi.String("string"),
	EndpointType:        pulumi.String("string"),
	ProtectedEnabled:    pulumi.Bool(false),
	ResourceGroupId:     pulumi.String("string"),
	ServiceId:           pulumi.String("string"),
	ServiceName:         pulumi.String("string"),
	Tags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	VpcEndpointName:           pulumi.String("string"),
	ZonePrivateIpAddressCount: pulumi.Int(0),
})

    var vpcEndpointResource = new VpcEndpoint("vpcEndpointResource", VpcEndpointArgs.builder()        
    .securityGroupIds("string")
    .vpcId("string")
    .dryRun(false)
    .endpointDescription("string")
    .endpointType("string")
    .protectedEnabled(false)
    .resourceGroupId("string")
    .serviceId("string")
    .serviceName("string")
    .tags(Map.of("string", "any"))
    .vpcEndpointName("string")
    .zonePrivateIpAddressCount(0)
    .build());

    vpc_endpoint_resource = alicloud.privatelink.VpcEndpoint("vpcEndpointResource",
    security_group_ids=["string"],
    vpc_id="string",
    dry_run=False,
    endpoint_description="string",
    endpoint_type="string",
    protected_enabled=False,
    resource_group_id="string",
    service_id="string",
    service_name="string",
    tags={
        "string": "any",
    },
    vpc_endpoint_name="string",
    zone_private_ip_address_count=0)

    const vpcEndpointResource = new alicloud.privatelink.VpcEndpoint("vpcEndpointResource", {
    securityGroupIds: ["string"],
    vpcId: "string",
    dryRun: false,
    endpointDescription: "string",
    endpointType: "string",
    protectedEnabled: false,
    resourceGroupId: "string",
    serviceId: "string",
    serviceName: "string",
    tags: {
        string: "any",
    },
    vpcEndpointName: "string",
    zonePrivateIpAddressCount: 0,
});

    type: alicloud:privatelink:VpcEndpoint
properties:
    dryRun: false
    endpointDescription: string
    endpointType: string
    protectedEnabled: false
    resourceGroupId: string
    securityGroupIds:
        - string
    serviceId: string
    serviceName: string
    tags:
        string: any
    vpcEndpointName: string
    vpcId: string
    zonePrivateIpAddressCount: 0

    VpcEndpoint Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The VpcEndpoint resource accepts the following input properties:

    SecurityGroupIds List<string>
    The ID of the security group that is associated with the endpoint ENI. The security group can be used to control data transfer between the VPC and the endpoint ENI.The endpoint can be associated with up to 10 security groups.
    VpcId string
    The ID of the VPC to which the endpoint belongs.
    DryRun bool
    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    EndpointDescription string
    The description of the endpoint.
    EndpointType string
    The endpoint type.Only the value: Interface, indicating the Interface endpoint. You can add the service resource types of Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB).
    ProtectedEnabled bool
    Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:

    • true: enables user authentication. After user authentication is enabled, only the user who creates the endpoint can modify or delete the endpoint in STS mode.
    • false (default): disables user authentication.
    ResourceGroupId string
    The resource group ID.
    ServiceId string
    The ID of the endpoint service with which the endpoint is associated.
    ServiceName string
    The name of the endpoint service with which the endpoint is associated.
    Tags Dictionary<string, object>
    The list of tags.
    VpcEndpointName string
    The name of the endpoint.
    ZonePrivateIpAddressCount int
    The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
    SecurityGroupIds []string
    The ID of the security group that is associated with the endpoint ENI. The security group can be used to control data transfer between the VPC and the endpoint ENI.The endpoint can be associated with up to 10 security groups.
    VpcId string
    The ID of the VPC to which the endpoint belongs.
    DryRun bool
    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    EndpointDescription string
    The description of the endpoint.
    EndpointType string
    The endpoint type.Only the value: Interface, indicating the Interface endpoint. You can add the service resource types of Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB).
    ProtectedEnabled bool
    Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:

    • true: enables user authentication. After user authentication is enabled, only the user who creates the endpoint can modify or delete the endpoint in STS mode.
    • false (default): disables user authentication.
    ResourceGroupId string
    The resource group ID.
    ServiceId string
    The ID of the endpoint service with which the endpoint is associated.
    ServiceName string
    The name of the endpoint service with which the endpoint is associated.
    Tags map[string]interface{}
    The list of tags.
    VpcEndpointName string
    The name of the endpoint.
    ZonePrivateIpAddressCount int
    The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
    securityGroupIds List<String>
    The ID of the security group that is associated with the endpoint ENI. The security group can be used to control data transfer between the VPC and the endpoint ENI.The endpoint can be associated with up to 10 security groups.
    vpcId String
    The ID of the VPC to which the endpoint belongs.
    dryRun Boolean
    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    endpointDescription String
    The description of the endpoint.
    endpointType String
    The endpoint type.Only the value: Interface, indicating the Interface endpoint. You can add the service resource types of Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB).
    protectedEnabled Boolean
    Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:

    • true: enables user authentication. After user authentication is enabled, only the user who creates the endpoint can modify or delete the endpoint in STS mode.
    • false (default): disables user authentication.
    resourceGroupId String
    The resource group ID.
    serviceId String
    The ID of the endpoint service with which the endpoint is associated.
    serviceName String
    The name of the endpoint service with which the endpoint is associated.
    tags Map<String,Object>
    The list of tags.
    vpcEndpointName String
    The name of the endpoint.
    zonePrivateIpAddressCount Integer
    The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
    securityGroupIds string[]
    The ID of the security group that is associated with the endpoint ENI. The security group can be used to control data transfer between the VPC and the endpoint ENI.The endpoint can be associated with up to 10 security groups.
    vpcId string
    The ID of the VPC to which the endpoint belongs.
    dryRun boolean
    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    endpointDescription string
    The description of the endpoint.
    endpointType string
    The endpoint type.Only the value: Interface, indicating the Interface endpoint. You can add the service resource types of Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB).
    protectedEnabled boolean
    Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:

    • true: enables user authentication. After user authentication is enabled, only the user who creates the endpoint can modify or delete the endpoint in STS mode.
    • false (default): disables user authentication.
    resourceGroupId string
    The resource group ID.
    serviceId string
    The ID of the endpoint service with which the endpoint is associated.
    serviceName string
    The name of the endpoint service with which the endpoint is associated.
    tags {[key: string]: any}
    The list of tags.
    vpcEndpointName string
    The name of the endpoint.
    zonePrivateIpAddressCount number
    The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
    security_group_ids Sequence[str]
    The ID of the security group that is associated with the endpoint ENI. The security group can be used to control data transfer between the VPC and the endpoint ENI.The endpoint can be associated with up to 10 security groups.
    vpc_id str
    The ID of the VPC to which the endpoint belongs.
    dry_run bool
    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    endpoint_description str
    The description of the endpoint.
    endpoint_type str
    The endpoint type.Only the value: Interface, indicating the Interface endpoint. You can add the service resource types of Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB).
    protected_enabled bool
    Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:

    • true: enables user authentication. After user authentication is enabled, only the user who creates the endpoint can modify or delete the endpoint in STS mode.
    • false (default): disables user authentication.
    resource_group_id str
    The resource group ID.
    service_id str
    The ID of the endpoint service with which the endpoint is associated.
    service_name str
    The name of the endpoint service with which the endpoint is associated.
    tags Mapping[str, Any]
    The list of tags.
    vpc_endpoint_name str
    The name of the endpoint.
    zone_private_ip_address_count int
    The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
    securityGroupIds List<String>
    The ID of the security group that is associated with the endpoint ENI. The security group can be used to control data transfer between the VPC and the endpoint ENI.The endpoint can be associated with up to 10 security groups.
    vpcId String
    The ID of the VPC to which the endpoint belongs.
    dryRun Boolean
    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    endpointDescription String
    The description of the endpoint.
    endpointType String
    The endpoint type.Only the value: Interface, indicating the Interface endpoint. You can add the service resource types of Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB).
    protectedEnabled Boolean
    Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:

    • true: enables user authentication. After user authentication is enabled, only the user who creates the endpoint can modify or delete the endpoint in STS mode.
    • false (default): disables user authentication.
    resourceGroupId String
    The resource group ID.
    serviceId String
    The ID of the endpoint service with which the endpoint is associated.
    serviceName String
    The name of the endpoint service with which the endpoint is associated.
    tags Map<Any>
    The list of tags.
    vpcEndpointName String
    The name of the endpoint.
    zonePrivateIpAddressCount Number
    The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VpcEndpoint resource produces the following output properties:

    Bandwidth int
    The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.Note: The bandwidth of an endpoint connection is in the range of 100 to 10,240 Mbit/s. The default bandwidth is 1,024 Mbit/s. When the endpoint is connected to the endpoint service, the default bandwidth is the minimum bandwidth. In this case, the connection bandwidth range is 1,024 to 10,240 Mbit/s.
    ConnectionStatus string
    The state of the endpoint connection.
    CreateTime string
    The time when the endpoint was created.
    EndpointBusinessStatus string
    The service state of the endpoint.
    EndpointDomain string
    The domain name of the endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The state of the endpoint.
    Bandwidth int
    The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.Note: The bandwidth of an endpoint connection is in the range of 100 to 10,240 Mbit/s. The default bandwidth is 1,024 Mbit/s. When the endpoint is connected to the endpoint service, the default bandwidth is the minimum bandwidth. In this case, the connection bandwidth range is 1,024 to 10,240 Mbit/s.
    ConnectionStatus string
    The state of the endpoint connection.
    CreateTime string
    The time when the endpoint was created.
    EndpointBusinessStatus string
    The service state of the endpoint.
    EndpointDomain string
    The domain name of the endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The state of the endpoint.
    bandwidth Integer
    The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.Note: The bandwidth of an endpoint connection is in the range of 100 to 10,240 Mbit/s. The default bandwidth is 1,024 Mbit/s. When the endpoint is connected to the endpoint service, the default bandwidth is the minimum bandwidth. In this case, the connection bandwidth range is 1,024 to 10,240 Mbit/s.
    connectionStatus String
    The state of the endpoint connection.
    createTime String
    The time when the endpoint was created.
    endpointBusinessStatus String
    The service state of the endpoint.
    endpointDomain String
    The domain name of the endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The state of the endpoint.
    bandwidth number
    The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.Note: The bandwidth of an endpoint connection is in the range of 100 to 10,240 Mbit/s. The default bandwidth is 1,024 Mbit/s. When the endpoint is connected to the endpoint service, the default bandwidth is the minimum bandwidth. In this case, the connection bandwidth range is 1,024 to 10,240 Mbit/s.
    connectionStatus string
    The state of the endpoint connection.
    createTime string
    The time when the endpoint was created.
    endpointBusinessStatus string
    The service state of the endpoint.
    endpointDomain string
    The domain name of the endpoint.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The state of the endpoint.
    bandwidth int
    The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.Note: The bandwidth of an endpoint connection is in the range of 100 to 10,240 Mbit/s. The default bandwidth is 1,024 Mbit/s. When the endpoint is connected to the endpoint service, the default bandwidth is the minimum bandwidth. In this case, the connection bandwidth range is 1,024 to 10,240 Mbit/s.
    connection_status str
    The state of the endpoint connection.
    create_time str
    The time when the endpoint was created.
    endpoint_business_status str
    The service state of the endpoint.
    endpoint_domain str
    The domain name of the endpoint.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The state of the endpoint.
    bandwidth Number
    The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.Note: The bandwidth of an endpoint connection is in the range of 100 to 10,240 Mbit/s. The default bandwidth is 1,024 Mbit/s. When the endpoint is connected to the endpoint service, the default bandwidth is the minimum bandwidth. In this case, the connection bandwidth range is 1,024 to 10,240 Mbit/s.
    connectionStatus String
    The state of the endpoint connection.
    createTime String
    The time when the endpoint was created.
    endpointBusinessStatus String
    The service state of the endpoint.
    endpointDomain String
    The domain name of the endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The state of the endpoint.

    Look up Existing VpcEndpoint Resource

    Get an existing VpcEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VpcEndpointState, opts?: CustomResourceOptions): VpcEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bandwidth: Optional[int] = None,
        connection_status: Optional[str] = None,
        create_time: Optional[str] = None,
        dry_run: Optional[bool] = None,
        endpoint_business_status: Optional[str] = None,
        endpoint_description: Optional[str] = None,
        endpoint_domain: Optional[str] = None,
        endpoint_type: Optional[str] = None,
        protected_enabled: Optional[bool] = None,
        resource_group_id: Optional[str] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        service_id: Optional[str] = None,
        service_name: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, Any]] = None,
        vpc_endpoint_name: Optional[str] = None,
        vpc_id: Optional[str] = None,
        zone_private_ip_address_count: Optional[int] = None) -> VpcEndpoint
    func GetVpcEndpoint(ctx *Context, name string, id IDInput, state *VpcEndpointState, opts ...ResourceOption) (*VpcEndpoint, error)
    public static VpcEndpoint Get(string name, Input<string> id, VpcEndpointState? state, CustomResourceOptions? opts = null)
    public static VpcEndpoint get(String name, Output<String> id, VpcEndpointState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Bandwidth int
    The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.Note: The bandwidth of an endpoint connection is in the range of 100 to 10,240 Mbit/s. The default bandwidth is 1,024 Mbit/s. When the endpoint is connected to the endpoint service, the default bandwidth is the minimum bandwidth. In this case, the connection bandwidth range is 1,024 to 10,240 Mbit/s.
    ConnectionStatus string
    The state of the endpoint connection.
    CreateTime string
    The time when the endpoint was created.
    DryRun bool
    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    EndpointBusinessStatus string
    The service state of the endpoint.
    EndpointDescription string
    The description of the endpoint.
    EndpointDomain string
    The domain name of the endpoint.
    EndpointType string
    The endpoint type.Only the value: Interface, indicating the Interface endpoint. You can add the service resource types of Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB).
    ProtectedEnabled bool
    Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:

    • true: enables user authentication. After user authentication is enabled, only the user who creates the endpoint can modify or delete the endpoint in STS mode.
    • false (default): disables user authentication.
    ResourceGroupId string
    The resource group ID.
    SecurityGroupIds List<string>
    The ID of the security group that is associated with the endpoint ENI. The security group can be used to control data transfer between the VPC and the endpoint ENI.The endpoint can be associated with up to 10 security groups.
    ServiceId string
    The ID of the endpoint service with which the endpoint is associated.
    ServiceName string
    The name of the endpoint service with which the endpoint is associated.
    Status string
    The state of the endpoint.
    Tags Dictionary<string, object>
    The list of tags.
    VpcEndpointName string
    The name of the endpoint.
    VpcId string
    The ID of the VPC to which the endpoint belongs.
    ZonePrivateIpAddressCount int
    The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
    Bandwidth int
    The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.Note: The bandwidth of an endpoint connection is in the range of 100 to 10,240 Mbit/s. The default bandwidth is 1,024 Mbit/s. When the endpoint is connected to the endpoint service, the default bandwidth is the minimum bandwidth. In this case, the connection bandwidth range is 1,024 to 10,240 Mbit/s.
    ConnectionStatus string
    The state of the endpoint connection.
    CreateTime string
    The time when the endpoint was created.
    DryRun bool
    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    EndpointBusinessStatus string
    The service state of the endpoint.
    EndpointDescription string
    The description of the endpoint.
    EndpointDomain string
    The domain name of the endpoint.
    EndpointType string
    The endpoint type.Only the value: Interface, indicating the Interface endpoint. You can add the service resource types of Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB).
    ProtectedEnabled bool
    Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:

    • true: enables user authentication. After user authentication is enabled, only the user who creates the endpoint can modify or delete the endpoint in STS mode.
    • false (default): disables user authentication.
    ResourceGroupId string
    The resource group ID.
    SecurityGroupIds []string
    The ID of the security group that is associated with the endpoint ENI. The security group can be used to control data transfer between the VPC and the endpoint ENI.The endpoint can be associated with up to 10 security groups.
    ServiceId string
    The ID of the endpoint service with which the endpoint is associated.
    ServiceName string
    The name of the endpoint service with which the endpoint is associated.
    Status string
    The state of the endpoint.
    Tags map[string]interface{}
    The list of tags.
    VpcEndpointName string
    The name of the endpoint.
    VpcId string
    The ID of the VPC to which the endpoint belongs.
    ZonePrivateIpAddressCount int
    The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
    bandwidth Integer
    The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.Note: The bandwidth of an endpoint connection is in the range of 100 to 10,240 Mbit/s. The default bandwidth is 1,024 Mbit/s. When the endpoint is connected to the endpoint service, the default bandwidth is the minimum bandwidth. In this case, the connection bandwidth range is 1,024 to 10,240 Mbit/s.
    connectionStatus String
    The state of the endpoint connection.
    createTime String
    The time when the endpoint was created.
    dryRun Boolean
    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    endpointBusinessStatus String
    The service state of the endpoint.
    endpointDescription String
    The description of the endpoint.
    endpointDomain String
    The domain name of the endpoint.
    endpointType String
    The endpoint type.Only the value: Interface, indicating the Interface endpoint. You can add the service resource types of Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB).
    protectedEnabled Boolean
    Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:

    • true: enables user authentication. After user authentication is enabled, only the user who creates the endpoint can modify or delete the endpoint in STS mode.
    • false (default): disables user authentication.
    resourceGroupId String
    The resource group ID.
    securityGroupIds List<String>
    The ID of the security group that is associated with the endpoint ENI. The security group can be used to control data transfer between the VPC and the endpoint ENI.The endpoint can be associated with up to 10 security groups.
    serviceId String
    The ID of the endpoint service with which the endpoint is associated.
    serviceName String
    The name of the endpoint service with which the endpoint is associated.
    status String
    The state of the endpoint.
    tags Map<String,Object>
    The list of tags.
    vpcEndpointName String
    The name of the endpoint.
    vpcId String
    The ID of the VPC to which the endpoint belongs.
    zonePrivateIpAddressCount Integer
    The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
    bandwidth number
    The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.Note: The bandwidth of an endpoint connection is in the range of 100 to 10,240 Mbit/s. The default bandwidth is 1,024 Mbit/s. When the endpoint is connected to the endpoint service, the default bandwidth is the minimum bandwidth. In this case, the connection bandwidth range is 1,024 to 10,240 Mbit/s.
    connectionStatus string
    The state of the endpoint connection.
    createTime string
    The time when the endpoint was created.
    dryRun boolean
    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    endpointBusinessStatus string
    The service state of the endpoint.
    endpointDescription string
    The description of the endpoint.
    endpointDomain string
    The domain name of the endpoint.
    endpointType string
    The endpoint type.Only the value: Interface, indicating the Interface endpoint. You can add the service resource types of Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB).
    protectedEnabled boolean
    Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:

    • true: enables user authentication. After user authentication is enabled, only the user who creates the endpoint can modify or delete the endpoint in STS mode.
    • false (default): disables user authentication.
    resourceGroupId string
    The resource group ID.
    securityGroupIds string[]
    The ID of the security group that is associated with the endpoint ENI. The security group can be used to control data transfer between the VPC and the endpoint ENI.The endpoint can be associated with up to 10 security groups.
    serviceId string
    The ID of the endpoint service with which the endpoint is associated.
    serviceName string
    The name of the endpoint service with which the endpoint is associated.
    status string
    The state of the endpoint.
    tags {[key: string]: any}
    The list of tags.
    vpcEndpointName string
    The name of the endpoint.
    vpcId string
    The ID of the VPC to which the endpoint belongs.
    zonePrivateIpAddressCount number
    The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
    bandwidth int
    The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.Note: The bandwidth of an endpoint connection is in the range of 100 to 10,240 Mbit/s. The default bandwidth is 1,024 Mbit/s. When the endpoint is connected to the endpoint service, the default bandwidth is the minimum bandwidth. In this case, the connection bandwidth range is 1,024 to 10,240 Mbit/s.
    connection_status str
    The state of the endpoint connection.
    create_time str
    The time when the endpoint was created.
    dry_run bool
    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    endpoint_business_status str
    The service state of the endpoint.
    endpoint_description str
    The description of the endpoint.
    endpoint_domain str
    The domain name of the endpoint.
    endpoint_type str
    The endpoint type.Only the value: Interface, indicating the Interface endpoint. You can add the service resource types of Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB).
    protected_enabled bool
    Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:

    • true: enables user authentication. After user authentication is enabled, only the user who creates the endpoint can modify or delete the endpoint in STS mode.
    • false (default): disables user authentication.
    resource_group_id str
    The resource group ID.
    security_group_ids Sequence[str]
    The ID of the security group that is associated with the endpoint ENI. The security group can be used to control data transfer between the VPC and the endpoint ENI.The endpoint can be associated with up to 10 security groups.
    service_id str
    The ID of the endpoint service with which the endpoint is associated.
    service_name str
    The name of the endpoint service with which the endpoint is associated.
    status str
    The state of the endpoint.
    tags Mapping[str, Any]
    The list of tags.
    vpc_endpoint_name str
    The name of the endpoint.
    vpc_id str
    The ID of the VPC to which the endpoint belongs.
    zone_private_ip_address_count int
    The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
    bandwidth Number
    The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.Note: The bandwidth of an endpoint connection is in the range of 100 to 10,240 Mbit/s. The default bandwidth is 1,024 Mbit/s. When the endpoint is connected to the endpoint service, the default bandwidth is the minimum bandwidth. In this case, the connection bandwidth range is 1,024 to 10,240 Mbit/s.
    connectionStatus String
    The state of the endpoint connection.
    createTime String
    The time when the endpoint was created.
    dryRun Boolean
    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    endpointBusinessStatus String
    The service state of the endpoint.
    endpointDescription String
    The description of the endpoint.
    endpointDomain String
    The domain name of the endpoint.
    endpointType String
    The endpoint type.Only the value: Interface, indicating the Interface endpoint. You can add the service resource types of Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB).
    protectedEnabled Boolean
    Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:

    • true: enables user authentication. After user authentication is enabled, only the user who creates the endpoint can modify or delete the endpoint in STS mode.
    • false (default): disables user authentication.
    resourceGroupId String
    The resource group ID.
    securityGroupIds List<String>
    The ID of the security group that is associated with the endpoint ENI. The security group can be used to control data transfer between the VPC and the endpoint ENI.The endpoint can be associated with up to 10 security groups.
    serviceId String
    The ID of the endpoint service with which the endpoint is associated.
    serviceName String
    The name of the endpoint service with which the endpoint is associated.
    status String
    The state of the endpoint.
    tags Map<Any>
    The list of tags.
    vpcEndpointName String
    The name of the endpoint.
    vpcId String
    The ID of the VPC to which the endpoint belongs.
    zonePrivateIpAddressCount Number
    The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.

    Import

    Private Link Vpc Endpoint can be imported using the id, e.g.

    $ pulumi import alicloud:privatelink/vpcEndpoint:VpcEndpoint example <id>

    To learn more about importing existing cloud resources, see Importing resources.

    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.53.0 published on Wednesday, Apr 17, 2024 by Pulumi
    pulumi/pulumi-alicloud