Docs Home
Alibaba Cloud v3.73.0 published on Wednesday, Jan 15, 2025 by Pulumi
alicloud.privatelink.VpcEndpoint
Explore with Pulumi AI
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") || "terraform-example";
const default = alicloud.resourcemanager.getResourceGroups({});
const defaultbFzA4a = new alicloud.vpc.Network("defaultbFzA4a", {
description: "example-terraform",
cidrBlock: "172.16.0.0/12",
vpcName: name,
});
const default1FTFrP = new alicloud.ecs.SecurityGroup("default1FTFrP", {
name: name,
vpcId: defaultbFzA4a.id,
});
const defaultjljY5S = new alicloud.ecs.SecurityGroup("defaultjljY5S", {
name: name,
vpcId: defaultbFzA4a.id,
});
const defaultVpcEndpoint = new alicloud.privatelink.VpcEndpoint("default", {
endpointDescription: name,
vpcEndpointName: name,
resourceGroupId: _default.then(_default => _default.ids?.[0]),
endpointType: "Interface",
vpcId: defaultbFzA4a.id,
serviceName: "com.aliyuncs.privatelink.ap-southeast-5.oss",
dryRun: false,
zonePrivateIpAddressCount: 1,
policyDocument: JSON.stringify({
Version: "1",
Statement: [{
Effect: "Allow",
Action: ["*"],
Resource: ["*"],
Principal: "*",
}],
}),
securityGroupIds: [default1FTFrP.id],
serviceId: "epsrv-k1apjysze8u1l9t6uyg9",
protectedEnabled: false,
});
import pulumi
import json
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "terraform-example"
default = alicloud.resourcemanager.get_resource_groups()
defaultb_fz_a4a = alicloud.vpc.Network("defaultbFzA4a",
description="example-terraform",
cidr_block="172.16.0.0/12",
vpc_name=name)
default1_ft_fr_p = alicloud.ecs.SecurityGroup("default1FTFrP",
name=name,
vpc_id=defaultb_fz_a4a.id)
defaultjlj_y5_s = alicloud.ecs.SecurityGroup("defaultjljY5S",
name=name,
vpc_id=defaultb_fz_a4a.id)
default_vpc_endpoint = alicloud.privatelink.VpcEndpoint("default",
endpoint_description=name,
vpc_endpoint_name=name,
resource_group_id=default.ids[0],
endpoint_type="Interface",
vpc_id=defaultb_fz_a4a.id,
service_name="com.aliyuncs.privatelink.ap-southeast-5.oss",
dry_run=False,
zone_private_ip_address_count=1,
policy_document=json.dumps({
"Version": "1",
"Statement": [{
"Effect": "Allow",
"Action": ["*"],
"Resource": ["*"],
"Principal": "*",
}],
}),
security_group_ids=[default1_ft_fr_p.id],
service_id="epsrv-k1apjysze8u1l9t6uyg9",
protected_enabled=False)
package main
import (
"encoding/json"
"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/resourcemanager"
"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 := "terraform-example"
if param := cfg.Get("name"); param != "" {
name = param
}
_default, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{}, nil)
if err != nil {
return err
}
defaultbFzA4a, err := vpc.NewNetwork(ctx, "defaultbFzA4a", &vpc.NetworkArgs{
Description: pulumi.String("example-terraform"),
CidrBlock: pulumi.String("172.16.0.0/12"),
VpcName: pulumi.String(name),
})
if err != nil {
return err
}
default1FTFrP, err := ecs.NewSecurityGroup(ctx, "default1FTFrP", &ecs.SecurityGroupArgs{
Name: pulumi.String(name),
VpcId: defaultbFzA4a.ID(),
})
if err != nil {
return err
}
_, err = ecs.NewSecurityGroup(ctx, "defaultjljY5S", &ecs.SecurityGroupArgs{
Name: pulumi.String(name),
VpcId: defaultbFzA4a.ID(),
})
if err != nil {
return err
}
tmpJSON0, err := json.Marshal(map[string]interface{}{
"Version": "1",
"Statement": []map[string]interface{}{
map[string]interface{}{
"Effect": "Allow",
"Action": []string{
"*",
},
"Resource": []string{
"*",
},
"Principal": "*",
},
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = privatelink.NewVpcEndpoint(ctx, "default", &privatelink.VpcEndpointArgs{
EndpointDescription: pulumi.String(name),
VpcEndpointName: pulumi.String(name),
ResourceGroupId: pulumi.String(_default.Ids[0]),
EndpointType: pulumi.String("Interface"),
VpcId: defaultbFzA4a.ID(),
ServiceName: pulumi.String("com.aliyuncs.privatelink.ap-southeast-5.oss"),
DryRun: pulumi.Bool(false),
ZonePrivateIpAddressCount: pulumi.Int(1),
PolicyDocument: pulumi.String(json0),
SecurityGroupIds: pulumi.StringArray{
default1FTFrP.ID(),
},
ServiceId: pulumi.String("epsrv-k1apjysze8u1l9t6uyg9"),
ProtectedEnabled: pulumi.Bool(false),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var name = config.Get("name") ?? "terraform-example";
var @default = AliCloud.ResourceManager.GetResourceGroups.Invoke();
var defaultbFzA4a = new AliCloud.Vpc.Network("defaultbFzA4a", new()
{
Description = "example-terraform",
CidrBlock = "172.16.0.0/12",
VpcName = name,
});
var default1FTFrP = new AliCloud.Ecs.SecurityGroup("default1FTFrP", new()
{
Name = name,
VpcId = defaultbFzA4a.Id,
});
var defaultjljY5S = new AliCloud.Ecs.SecurityGroup("defaultjljY5S", new()
{
Name = name,
VpcId = defaultbFzA4a.Id,
});
var defaultVpcEndpoint = new AliCloud.PrivateLink.VpcEndpoint("default", new()
{
EndpointDescription = name,
VpcEndpointName = name,
ResourceGroupId = @default.Apply(@default => @default.Apply(getResourceGroupsResult => getResourceGroupsResult.Ids[0])),
EndpointType = "Interface",
VpcId = defaultbFzA4a.Id,
ServiceName = "com.aliyuncs.privatelink.ap-southeast-5.oss",
DryRun = false,
ZonePrivateIpAddressCount = 1,
PolicyDocument = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["Version"] = "1",
["Statement"] = new[]
{
new Dictionary<string, object?>
{
["Effect"] = "Allow",
["Action"] = new[]
{
"*",
},
["Resource"] = new[]
{
"*",
},
["Principal"] = "*",
},
},
}),
SecurityGroupIds = new[]
{
default1FTFrP.Id,
},
ServiceId = "epsrv-k1apjysze8u1l9t6uyg9",
ProtectedEnabled = false,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
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 static com.pulumi.codegen.internal.Serialization.*;
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("terraform-example");
final var default = ResourcemanagerFunctions.getResourceGroups();
var defaultbFzA4a = new Network("defaultbFzA4a", NetworkArgs.builder()
.description("example-terraform")
.cidrBlock("172.16.0.0/12")
.vpcName(name)
.build());
var default1FTFrP = new SecurityGroup("default1FTFrP", SecurityGroupArgs.builder()
.name(name)
.vpcId(defaultbFzA4a.id())
.build());
var defaultjljY5S = new SecurityGroup("defaultjljY5S", SecurityGroupArgs.builder()
.name(name)
.vpcId(defaultbFzA4a.id())
.build());
var defaultVpcEndpoint = new VpcEndpoint("defaultVpcEndpoint", VpcEndpointArgs.builder()
.endpointDescription(name)
.vpcEndpointName(name)
.resourceGroupId(default_.ids()[0])
.endpointType("Interface")
.vpcId(defaultbFzA4a.id())
.serviceName("com.aliyuncs.privatelink.ap-southeast-5.oss")
.dryRun("false")
.zonePrivateIpAddressCount("1")
.policyDocument(serializeJson(
jsonObject(
jsonProperty("Version", "1"),
jsonProperty("Statement", jsonArray(jsonObject(
jsonProperty("Effect", "Allow"),
jsonProperty("Action", jsonArray("*")),
jsonProperty("Resource", jsonArray("*")),
jsonProperty("Principal", "*")
)))
)))
.securityGroupIds(default1FTFrP.id())
.serviceId("epsrv-k1apjysze8u1l9t6uyg9")
.protectedEnabled("false")
.build());
}
}
configuration:
name:
type: string
default: terraform-example
resources:
defaultbFzA4a:
type: alicloud:vpc:Network
properties:
description: example-terraform
cidrBlock: 172.16.0.0/12
vpcName: ${name}
default1FTFrP:
type: alicloud:ecs:SecurityGroup
properties:
name: ${name}
vpcId: ${defaultbFzA4a.id}
defaultjljY5S:
type: alicloud:ecs:SecurityGroup
properties:
name: ${name}
vpcId: ${defaultbFzA4a.id}
defaultVpcEndpoint:
type: alicloud:privatelink:VpcEndpoint
name: default
properties:
endpointDescription: ${name}
vpcEndpointName: ${name}
resourceGroupId: ${default.ids[0]}
endpointType: Interface
vpcId: ${defaultbFzA4a.id}
serviceName: com.aliyuncs.privatelink.ap-southeast-5.oss
dryRun: 'false'
zonePrivateIpAddressCount: '1'
policyDocument:
fn::toJSON:
Version: '1'
Statement:
- Effect: Allow
Action:
- '*'
Resource:
- '*'
Principal: '*'
securityGroupIds:
- ${default1FTFrP.id}
serviceId: epsrv-k1apjysze8u1l9t6uyg9
protectedEnabled: 'false'
variables:
default:
fn::invoke:
function: alicloud:resourcemanager:getResourceGroups
arguments: {}
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,
vpc_id: Optional[str] = None,
resource_group_id: Optional[str] = None,
endpoint_description: Optional[str] = None,
endpoint_type: Optional[str] = None,
policy_document: Optional[str] = None,
protected_enabled: Optional[bool] = None,
address_ip_version: Optional[str] = None,
security_group_ids: Optional[Sequence[str]] = None,
service_id: Optional[str] = None,
service_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
vpc_endpoint_name: Optional[str] = None,
dry_run: Optional[bool] = 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var vpcEndpointResource = new AliCloud.PrivateLink.VpcEndpoint("vpcEndpointResource", new()
{
VpcId = "string",
ResourceGroupId = "string",
EndpointDescription = "string",
EndpointType = "string",
PolicyDocument = "string",
ProtectedEnabled = false,
AddressIpVersion = "string",
SecurityGroupIds = new[]
{
"string",
},
ServiceId = "string",
ServiceName = "string",
Tags =
{
{ "string", "string" },
},
VpcEndpointName = "string",
DryRun = false,
ZonePrivateIpAddressCount = 0,
});
example, err := privatelink.NewVpcEndpoint(ctx, "vpcEndpointResource", &privatelink.VpcEndpointArgs{
VpcId: pulumi.String("string"),
ResourceGroupId: pulumi.String("string"),
EndpointDescription: pulumi.String("string"),
EndpointType: pulumi.String("string"),
PolicyDocument: pulumi.String("string"),
ProtectedEnabled: pulumi.Bool(false),
AddressIpVersion: pulumi.String("string"),
SecurityGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
ServiceId: pulumi.String("string"),
ServiceName: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
VpcEndpointName: pulumi.String("string"),
DryRun: pulumi.Bool(false),
ZonePrivateIpAddressCount: pulumi.Int(0),
})
var vpcEndpointResource = new VpcEndpoint("vpcEndpointResource", VpcEndpointArgs.builder()
.vpcId("string")
.resourceGroupId("string")
.endpointDescription("string")
.endpointType("string")
.policyDocument("string")
.protectedEnabled(false)
.addressIpVersion("string")
.securityGroupIds("string")
.serviceId("string")
.serviceName("string")
.tags(Map.of("string", "string"))
.vpcEndpointName("string")
.dryRun(false)
.zonePrivateIpAddressCount(0)
.build());
vpc_endpoint_resource = alicloud.privatelink.VpcEndpoint("vpcEndpointResource",
vpc_id="string",
resource_group_id="string",
endpoint_description="string",
endpoint_type="string",
policy_document="string",
protected_enabled=False,
address_ip_version="string",
security_group_ids=["string"],
service_id="string",
service_name="string",
tags={
"string": "string",
},
vpc_endpoint_name="string",
dry_run=False,
zone_private_ip_address_count=0)
const vpcEndpointResource = new alicloud.privatelink.VpcEndpoint("vpcEndpointResource", {
vpcId: "string",
resourceGroupId: "string",
endpointDescription: "string",
endpointType: "string",
policyDocument: "string",
protectedEnabled: false,
addressIpVersion: "string",
securityGroupIds: ["string"],
serviceId: "string",
serviceName: "string",
tags: {
string: "string",
},
vpcEndpointName: "string",
dryRun: false,
zonePrivateIpAddressCount: 0,
});
type: alicloud:privatelink:VpcEndpoint
properties:
addressIpVersion: string
dryRun: false
endpointDescription: string
endpointType: string
policyDocument: string
protectedEnabled: false
resourceGroupId: string
securityGroupIds:
- string
serviceId: string
serviceName: string
tags:
string: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The VpcEndpoint resource accepts the following input properties:
- Vpc
Id string - The ID of the VPC to which the endpoint belongs.
- Address
Ip stringVersion - The IP address version.
- Dry
Run bool - Specifies whether to perform only a dry run, without performing the actual request. Valid values:
- Endpoint
Description string - The description of the endpoint.
- Endpoint
Type 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).
- Policy
Document string - RAM access policies. For more information about policy definitions, see Alibaba Cloud-access control (RAM) official guidance.
- Protected
Enabled bool - Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:
- Resource
Group stringId - The resource group ID.
- Security
Group List<string>Ids 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 string - The ID of the endpoint service with which the endpoint is associated.
- Service
Name string - The name of the endpoint service with which the endpoint is associated.
- Dictionary<string, string>
- The list of tags.
- Vpc
Endpoint stringName - The name of the endpoint.
- Zone
Private intIp Address Count - The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
- Vpc
Id string - The ID of the VPC to which the endpoint belongs.
- Address
Ip stringVersion - The IP address version.
- Dry
Run bool - Specifies whether to perform only a dry run, without performing the actual request. Valid values:
- Endpoint
Description string - The description of the endpoint.
- Endpoint
Type 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).
- Policy
Document string - RAM access policies. For more information about policy definitions, see Alibaba Cloud-access control (RAM) official guidance.
- Protected
Enabled bool - Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:
- Resource
Group stringId - The resource group ID.
- Security
Group []stringIds 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 string - The ID of the endpoint service with which the endpoint is associated.
- Service
Name string - The name of the endpoint service with which the endpoint is associated.
- map[string]string
- The list of tags.
- Vpc
Endpoint stringName - The name of the endpoint.
- Zone
Private intIp Address Count - The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
- vpc
Id String - The ID of the VPC to which the endpoint belongs.
- address
Ip StringVersion - The IP address version.
- dry
Run Boolean - Specifies whether to perform only a dry run, without performing the actual request. Valid values:
- endpoint
Description String - The description of the endpoint.
- endpoint
Type 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).
- policy
Document String - RAM access policies. For more information about policy definitions, see Alibaba Cloud-access control (RAM) official guidance.
- protected
Enabled Boolean - Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:
- resource
Group StringId - The resource group ID.
- security
Group List<String>Ids 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 String - The ID of the endpoint service with which the endpoint is associated.
- service
Name String - The name of the endpoint service with which the endpoint is associated.
- Map<String,String>
- The list of tags.
- vpc
Endpoint StringName - The name of the endpoint.
- zone
Private IntegerIp Address Count - The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
- vpc
Id string - The ID of the VPC to which the endpoint belongs.
- address
Ip stringVersion - The IP address version.
- dry
Run boolean - Specifies whether to perform only a dry run, without performing the actual request. Valid values:
- endpoint
Description string - The description of the endpoint.
- endpoint
Type 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).
- policy
Document string - RAM access policies. For more information about policy definitions, see Alibaba Cloud-access control (RAM) official guidance.
- protected
Enabled boolean - Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:
- resource
Group stringId - The resource group ID.
- security
Group string[]Ids 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 string - The ID of the endpoint service with which the endpoint is associated.
- service
Name string - The name of the endpoint service with which the endpoint is associated.
- {[key: string]: string}
- The list of tags.
- vpc
Endpoint stringName - The name of the endpoint.
- zone
Private numberIp Address Count - The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
- vpc_
id str - The ID of the VPC to which the endpoint belongs.
- address_
ip_ strversion - The IP address version.
- dry_
run bool - Specifies whether to perform only a dry run, without performing the actual request. Valid values:
- 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).
- policy_
document str - RAM access policies. For more information about policy definitions, see Alibaba Cloud-access control (RAM) official guidance.
- protected_
enabled bool - Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:
- resource_
group_ strid - The resource group ID.
- security_
group_ Sequence[str]ids 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.
- Mapping[str, str]
- The list of tags.
- vpc_
endpoint_ strname - The name of the endpoint.
- zone_
private_ intip_ address_ count - The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
- vpc
Id String - The ID of the VPC to which the endpoint belongs.
- address
Ip StringVersion - The IP address version.
- dry
Run Boolean - Specifies whether to perform only a dry run, without performing the actual request. Valid values:
- endpoint
Description String - The description of the endpoint.
- endpoint
Type 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).
- policy
Document String - RAM access policies. For more information about policy definitions, see Alibaba Cloud-access control (RAM) official guidance.
- protected
Enabled Boolean - Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:
- resource
Group StringId - The resource group ID.
- security
Group List<String>Ids 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 String - The ID of the endpoint service with which the endpoint is associated.
- service
Name String - The name of the endpoint service with which the endpoint is associated.
- Map<String>
- The list of tags.
- vpc
Endpoint StringName - The name of the endpoint.
- zone
Private NumberIp Address Count - 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.
- Connection
Status string - The state of the endpoint connection.
- Create
Time string - The time when the endpoint was created.
- Endpoint
Business stringStatus - The service state of the endpoint.
- Endpoint
Domain string - The domain name of the endpoint.
- Id string
- The provider-assigned unique ID for this managed resource.
- Region
Id string - (Available since v1.239.0) The region ID of the endpoint.
- Status string
- The state of the endpoint.
- Bandwidth int
- The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.
- Connection
Status string - The state of the endpoint connection.
- Create
Time string - The time when the endpoint was created.
- Endpoint
Business stringStatus - The service state of the endpoint.
- Endpoint
Domain string - The domain name of the endpoint.
- Id string
- The provider-assigned unique ID for this managed resource.
- Region
Id string - (Available since v1.239.0) The region ID of the endpoint.
- Status string
- The state of the endpoint.
- bandwidth Integer
- The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.
- connection
Status String - The state of the endpoint connection.
- create
Time String - The time when the endpoint was created.
- endpoint
Business StringStatus - The service state of the endpoint.
- endpoint
Domain String - The domain name of the endpoint.
- id String
- The provider-assigned unique ID for this managed resource.
- region
Id String - (Available since v1.239.0) The region ID of the endpoint.
- status String
- The state of the endpoint.
- bandwidth number
- The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.
- connection
Status string - The state of the endpoint connection.
- create
Time string - The time when the endpoint was created.
- endpoint
Business stringStatus - The service state of the endpoint.
- endpoint
Domain string - The domain name of the endpoint.
- id string
- The provider-assigned unique ID for this managed resource.
- region
Id string - (Available since v1.239.0) The region ID of the endpoint.
- status string
- The state of the endpoint.
- bandwidth int
- The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.
- connection_
status str - The state of the endpoint connection.
- create_
time str - The time when the endpoint was created.
- endpoint_
business_ strstatus - 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.
- region_
id str - (Available since v1.239.0) The region ID of the endpoint.
- status str
- The state of the endpoint.
- bandwidth Number
- The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.
- connection
Status String - The state of the endpoint connection.
- create
Time String - The time when the endpoint was created.
- endpoint
Business StringStatus - The service state of the endpoint.
- endpoint
Domain String - The domain name of the endpoint.
- id String
- The provider-assigned unique ID for this managed resource.
- region
Id String - (Available since v1.239.0) The region ID of the endpoint.
- 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,
address_ip_version: Optional[str] = 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,
policy_document: Optional[str] = None,
protected_enabled: Optional[bool] = None,
region_id: Optional[str] = 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, str]] = None,
vpc_endpoint_name: Optional[str] = None,
vpc_id: Optional[str] = None,
zone_private_ip_address_count: Optional[int] = None) -> VpcEndpointfunc 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)resources: _: type: alicloud:privatelink:VpcEndpoint get: id: ${id}- 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.
- Address
Ip stringVersion - The IP address version.
- Bandwidth int
- The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.
- Connection
Status string - The state of the endpoint connection.
- Create
Time string - 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:
- Endpoint
Business stringStatus - The service state of the endpoint.
- Endpoint
Description string - The description of the endpoint.
- Endpoint
Domain string - The domain name of the endpoint.
- Endpoint
Type 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).
- Policy
Document string - RAM access policies. For more information about policy definitions, see Alibaba Cloud-access control (RAM) official guidance.
- Protected
Enabled bool - Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:
- Region
Id string - (Available since v1.239.0) The region ID of the endpoint.
- Resource
Group stringId - The resource group ID.
- Security
Group List<string>Ids 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 string - The ID of the endpoint service with which the endpoint is associated.
- Service
Name string - The name of the endpoint service with which the endpoint is associated.
- Status string
- The state of the endpoint.
- Dictionary<string, string>
- The list of tags.
- Vpc
Endpoint stringName - The name of the endpoint.
- Vpc
Id string - The ID of the VPC to which the endpoint belongs.
- Zone
Private intIp Address Count - The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
- Address
Ip stringVersion - The IP address version.
- Bandwidth int
- The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.
- Connection
Status string - The state of the endpoint connection.
- Create
Time string - 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:
- Endpoint
Business stringStatus - The service state of the endpoint.
- Endpoint
Description string - The description of the endpoint.
- Endpoint
Domain string - The domain name of the endpoint.
- Endpoint
Type 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).
- Policy
Document string - RAM access policies. For more information about policy definitions, see Alibaba Cloud-access control (RAM) official guidance.
- Protected
Enabled bool - Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:
- Region
Id string - (Available since v1.239.0) The region ID of the endpoint.
- Resource
Group stringId - The resource group ID.
- Security
Group []stringIds 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 string - The ID of the endpoint service with which the endpoint is associated.
- Service
Name string - The name of the endpoint service with which the endpoint is associated.
- Status string
- The state of the endpoint.
- map[string]string
- The list of tags.
- Vpc
Endpoint stringName - The name of the endpoint.
- Vpc
Id string - The ID of the VPC to which the endpoint belongs.
- Zone
Private intIp Address Count - The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
- address
Ip StringVersion - The IP address version.
- bandwidth Integer
- The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.
- connection
Status String - The state of the endpoint connection.
- create
Time String - The time when the endpoint was created.
- dry
Run Boolean - Specifies whether to perform only a dry run, without performing the actual request. Valid values:
- endpoint
Business StringStatus - The service state of the endpoint.
- endpoint
Description String - The description of the endpoint.
- endpoint
Domain String - The domain name of the endpoint.
- endpoint
Type 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).
- policy
Document String - RAM access policies. For more information about policy definitions, see Alibaba Cloud-access control (RAM) official guidance.
- protected
Enabled Boolean - Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:
- region
Id String - (Available since v1.239.0) The region ID of the endpoint.
- resource
Group StringId - The resource group ID.
- security
Group List<String>Ids 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 String - The ID of the endpoint service with which the endpoint is associated.
- service
Name String - The name of the endpoint service with which the endpoint is associated.
- status String
- The state of the endpoint.
- Map<String,String>
- The list of tags.
- vpc
Endpoint StringName - The name of the endpoint.
- vpc
Id String - The ID of the VPC to which the endpoint belongs.
- zone
Private IntegerIp Address Count - The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
- address
Ip stringVersion - The IP address version.
- bandwidth number
- The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.
- connection
Status string - The state of the endpoint connection.
- create
Time string - The time when the endpoint was created.
- dry
Run boolean - Specifies whether to perform only a dry run, without performing the actual request. Valid values:
- endpoint
Business stringStatus - The service state of the endpoint.
- endpoint
Description string - The description of the endpoint.
- endpoint
Domain string - The domain name of the endpoint.
- endpoint
Type 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).
- policy
Document string - RAM access policies. For more information about policy definitions, see Alibaba Cloud-access control (RAM) official guidance.
- protected
Enabled boolean - Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:
- region
Id string - (Available since v1.239.0) The region ID of the endpoint.
- resource
Group stringId - The resource group ID.
- security
Group string[]Ids 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 string - The ID of the endpoint service with which the endpoint is associated.
- service
Name string - The name of the endpoint service with which the endpoint is associated.
- status string
- The state of the endpoint.
- {[key: string]: string}
- The list of tags.
- vpc
Endpoint stringName - The name of the endpoint.
- vpc
Id string - The ID of the VPC to which the endpoint belongs.
- zone
Private numberIp Address Count - The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
- address_
ip_ strversion - The IP address version.
- bandwidth int
- The bandwidth of the endpoint connection. 1024 to 10240. Unit: 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:
- endpoint_
business_ strstatus - 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).
- policy_
document str - RAM access policies. For more information about policy definitions, see Alibaba Cloud-access control (RAM) official guidance.
- protected_
enabled bool - Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:
- region_
id str - (Available since v1.239.0) The region ID of the endpoint.
- resource_
group_ strid - The resource group ID.
- security_
group_ Sequence[str]ids 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.
- Mapping[str, str]
- The list of tags.
- vpc_
endpoint_ strname - The name of the endpoint.
- vpc_
id str - The ID of the VPC to which the endpoint belongs.
- zone_
private_ intip_ address_ count - The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.
- address
Ip StringVersion - The IP address version.
- bandwidth Number
- The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.
- connection
Status String - The state of the endpoint connection.
- create
Time String - The time when the endpoint was created.
- dry
Run Boolean - Specifies whether to perform only a dry run, without performing the actual request. Valid values:
- endpoint
Business StringStatus - The service state of the endpoint.
- endpoint
Description String - The description of the endpoint.
- endpoint
Domain String - The domain name of the endpoint.
- endpoint
Type 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).
- policy
Document String - RAM access policies. For more information about policy definitions, see Alibaba Cloud-access control (RAM) official guidance.
- protected
Enabled Boolean - Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:
- region
Id String - (Available since v1.239.0) The region ID of the endpoint.
- resource
Group StringId - The resource group ID.
- security
Group List<String>Ids 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 String - The ID of the endpoint service with which the endpoint is associated.
- service
Name String - The name of the endpoint service with which the endpoint is associated.
- status String
- The state of the endpoint.
- Map<String>
- The list of tags.
- vpc
Endpoint StringName - The name of the endpoint.
- vpc
Id String - The ID of the VPC to which the endpoint belongs.
- zone
Private NumberIp Address Count - 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
alicloudTerraform Provider.