1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. privatelink
  5. VpcEndpointServiceUser
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.privatelink.VpcEndpointServiceUser

Explore with Pulumi AI

Provides a Private Link Vpc Endpoint Service User resource.

Endpoint service user whitelist.

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

NOTE: Available since v1.110.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") || "tfexampleuser";
const example = new alicloud.privatelink.VpcEndpointService("example", {
    serviceDescription: name,
    connectBandwidth: 103,
    autoAcceptConnection: false,
});
const exampleUser = new alicloud.ram.User("example", {
    name: name,
    displayName: "user_display_name",
    mobile: "86-18688888888",
    email: "hello.uuu@aaa.com",
    comments: "yoyoyo",
});
const exampleVpcEndpointServiceUser = new alicloud.privatelink.VpcEndpointServiceUser("example", {
    serviceId: example.id,
    userId: exampleUser.id,
});
Copy
import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "tfexampleuser"
example = alicloud.privatelink.VpcEndpointService("example",
    service_description=name,
    connect_bandwidth=103,
    auto_accept_connection=False)
example_user = alicloud.ram.User("example",
    name=name,
    display_name="user_display_name",
    mobile="86-18688888888",
    email="hello.uuu@aaa.com",
    comments="yoyoyo")
example_vpc_endpoint_service_user = alicloud.privatelink.VpcEndpointServiceUser("example",
    service_id=example.id,
    user_id=example_user.id)
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/privatelink"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ram"
	"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 := "tfexampleuser"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		example, err := privatelink.NewVpcEndpointService(ctx, "example", &privatelink.VpcEndpointServiceArgs{
			ServiceDescription:   pulumi.String(name),
			ConnectBandwidth:     pulumi.Int(103),
			AutoAcceptConnection: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		exampleUser, err := ram.NewUser(ctx, "example", &ram.UserArgs{
			Name:        pulumi.String(name),
			DisplayName: pulumi.String("user_display_name"),
			Mobile:      pulumi.String("86-18688888888"),
			Email:       pulumi.String("hello.uuu@aaa.com"),
			Comments:    pulumi.String("yoyoyo"),
		})
		if err != nil {
			return err
		}
		_, err = privatelink.NewVpcEndpointServiceUser(ctx, "example", &privatelink.VpcEndpointServiceUserArgs{
			ServiceId: example.ID(),
			UserId:    exampleUser.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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") ?? "tfexampleuser";
    var example = new AliCloud.PrivateLink.VpcEndpointService("example", new()
    {
        ServiceDescription = name,
        ConnectBandwidth = 103,
        AutoAcceptConnection = false,
    });

    var exampleUser = new AliCloud.Ram.User("example", new()
    {
        Name = name,
        DisplayName = "user_display_name",
        Mobile = "86-18688888888",
        Email = "hello.uuu@aaa.com",
        Comments = "yoyoyo",
    });

    var exampleVpcEndpointServiceUser = new AliCloud.PrivateLink.VpcEndpointServiceUser("example", new()
    {
        ServiceId = example.Id,
        UserId = exampleUser.Id,
    });

});
Copy
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.ram.User;
import com.pulumi.alicloud.ram.UserArgs;
import com.pulumi.alicloud.privatelink.VpcEndpointServiceUser;
import com.pulumi.alicloud.privatelink.VpcEndpointServiceUserArgs;
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("tfexampleuser");
        var example = new VpcEndpointService("example", VpcEndpointServiceArgs.builder()
            .serviceDescription(name)
            .connectBandwidth(103)
            .autoAcceptConnection(false)
            .build());

        var exampleUser = new User("exampleUser", UserArgs.builder()
            .name(name)
            .displayName("user_display_name")
            .mobile("86-18688888888")
            .email("hello.uuu@aaa.com")
            .comments("yoyoyo")
            .build());

        var exampleVpcEndpointServiceUser = new VpcEndpointServiceUser("exampleVpcEndpointServiceUser", VpcEndpointServiceUserArgs.builder()
            .serviceId(example.id())
            .userId(exampleUser.id())
            .build());

    }
}
Copy
configuration:
  name:
    type: string
    default: tfexampleuser
resources:
  example:
    type: alicloud:privatelink:VpcEndpointService
    properties:
      serviceDescription: ${name}
      connectBandwidth: 103
      autoAcceptConnection: false
  exampleUser:
    type: alicloud:ram:User
    name: example
    properties:
      name: ${name}
      displayName: user_display_name
      mobile: 86-18688888888
      email: hello.uuu@aaa.com
      comments: yoyoyo
  exampleVpcEndpointServiceUser:
    type: alicloud:privatelink:VpcEndpointServiceUser
    name: example
    properties:
      serviceId: ${example.id}
      userId: ${exampleUser.id}
Copy

Create VpcEndpointServiceUser Resource

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

Constructor syntax

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

@overload
def VpcEndpointServiceUser(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           service_id: Optional[str] = None,
                           user_id: Optional[str] = None,
                           dry_run: Optional[bool] = None,
                           user_arn: Optional[str] = None)
func NewVpcEndpointServiceUser(ctx *Context, name string, args VpcEndpointServiceUserArgs, opts ...ResourceOption) (*VpcEndpointServiceUser, error)
public VpcEndpointServiceUser(string name, VpcEndpointServiceUserArgs args, CustomResourceOptions? opts = null)
public VpcEndpointServiceUser(String name, VpcEndpointServiceUserArgs args)
public VpcEndpointServiceUser(String name, VpcEndpointServiceUserArgs args, CustomResourceOptions options)
type: alicloud:privatelink:VpcEndpointServiceUser
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VpcEndpointServiceUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VpcEndpointServiceUserArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VpcEndpointServiceUserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VpcEndpointServiceUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VpcEndpointServiceUserArgs
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 vpcEndpointServiceUserResource = new AliCloud.PrivateLink.VpcEndpointServiceUser("vpcEndpointServiceUserResource", new()
{
    ServiceId = "string",
    UserId = "string",
    DryRun = false,
    UserArn = "string",
});
Copy
example, err := privatelink.NewVpcEndpointServiceUser(ctx, "vpcEndpointServiceUserResource", &privatelink.VpcEndpointServiceUserArgs{
	ServiceId: pulumi.String("string"),
	UserId:    pulumi.String("string"),
	DryRun:    pulumi.Bool(false),
	UserArn:   pulumi.String("string"),
})
Copy
var vpcEndpointServiceUserResource = new VpcEndpointServiceUser("vpcEndpointServiceUserResource", VpcEndpointServiceUserArgs.builder()
    .serviceId("string")
    .userId("string")
    .dryRun(false)
    .userArn("string")
    .build());
Copy
vpc_endpoint_service_user_resource = alicloud.privatelink.VpcEndpointServiceUser("vpcEndpointServiceUserResource",
    service_id="string",
    user_id="string",
    dry_run=False,
    user_arn="string")
Copy
const vpcEndpointServiceUserResource = new alicloud.privatelink.VpcEndpointServiceUser("vpcEndpointServiceUserResource", {
    serviceId: "string",
    userId: "string",
    dryRun: false,
    userArn: "string",
});
Copy
type: alicloud:privatelink:VpcEndpointServiceUser
properties:
    dryRun: false
    serviceId: string
    userArn: string
    userId: string
Copy

VpcEndpointServiceUser 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 VpcEndpointServiceUser resource accepts the following input properties:

ServiceId
This property is required.
Changes to this property will trigger replacement.
string
The endpoint service ID.
UserId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Alibaba Cloud account in the whitelist of the endpoint service.
DryRun bool
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
UserArn string
The whitelist in the format of ARN.
ServiceId
This property is required.
Changes to this property will trigger replacement.
string
The endpoint service ID.
UserId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Alibaba Cloud account in the whitelist of the endpoint service.
DryRun bool
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
UserArn string
The whitelist in the format of ARN.
serviceId
This property is required.
Changes to this property will trigger replacement.
String
The endpoint service ID.
userId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Alibaba Cloud account in the whitelist of the endpoint service.
dryRun Boolean
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
userArn String
The whitelist in the format of ARN.
serviceId
This property is required.
Changes to this property will trigger replacement.
string
The endpoint service ID.
userId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Alibaba Cloud account in the whitelist of the endpoint service.
dryRun boolean
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
userArn string
The whitelist in the format of ARN.
service_id
This property is required.
Changes to this property will trigger replacement.
str
The endpoint service ID.
user_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Alibaba Cloud account in the whitelist of the endpoint service.
dry_run bool
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
user_arn str
The whitelist in the format of ARN.
serviceId
This property is required.
Changes to this property will trigger replacement.
String
The endpoint service ID.
userId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Alibaba Cloud account in the whitelist of the endpoint service.
dryRun Boolean
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
userArn String
The whitelist in the format of ARN.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing VpcEndpointServiceUser Resource

Get an existing VpcEndpointServiceUser 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?: VpcEndpointServiceUserState, opts?: CustomResourceOptions): VpcEndpointServiceUser
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dry_run: Optional[bool] = None,
        service_id: Optional[str] = None,
        user_arn: Optional[str] = None,
        user_id: Optional[str] = None) -> VpcEndpointServiceUser
func GetVpcEndpointServiceUser(ctx *Context, name string, id IDInput, state *VpcEndpointServiceUserState, opts ...ResourceOption) (*VpcEndpointServiceUser, error)
public static VpcEndpointServiceUser Get(string name, Input<string> id, VpcEndpointServiceUserState? state, CustomResourceOptions? opts = null)
public static VpcEndpointServiceUser get(String name, Output<String> id, VpcEndpointServiceUserState state, CustomResourceOptions options)
resources:  _:    type: alicloud:privatelink:VpcEndpointServiceUser    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
DryRun bool
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
ServiceId Changes to this property will trigger replacement. string
The endpoint service ID.
UserArn string
The whitelist in the format of ARN.
UserId Changes to this property will trigger replacement. string
The ID of the Alibaba Cloud account in the whitelist of the endpoint service.
DryRun bool
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
ServiceId Changes to this property will trigger replacement. string
The endpoint service ID.
UserArn string
The whitelist in the format of ARN.
UserId Changes to this property will trigger replacement. string
The ID of the Alibaba Cloud account in the whitelist of the endpoint service.
dryRun Boolean
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
serviceId Changes to this property will trigger replacement. String
The endpoint service ID.
userArn String
The whitelist in the format of ARN.
userId Changes to this property will trigger replacement. String
The ID of the Alibaba Cloud account in the whitelist of the endpoint service.
dryRun boolean
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
serviceId Changes to this property will trigger replacement. string
The endpoint service ID.
userArn string
The whitelist in the format of ARN.
userId Changes to this property will trigger replacement. string
The ID of the Alibaba Cloud account in the whitelist of the endpoint service.
dry_run bool
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
service_id Changes to this property will trigger replacement. str
The endpoint service ID.
user_arn str
The whitelist in the format of ARN.
user_id Changes to this property will trigger replacement. str
The ID of the Alibaba Cloud account in the whitelist of the endpoint service.
dryRun Boolean
Specifies whether to perform only a dry run, without performing the actual request. Valid values:
serviceId Changes to this property will trigger replacement. String
The endpoint service ID.
userArn String
The whitelist in the format of ARN.
userId Changes to this property will trigger replacement. String
The ID of the Alibaba Cloud account in the whitelist of the endpoint service.

Import

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

$ pulumi import alicloud:privatelink/vpcEndpointServiceUser:VpcEndpointServiceUser example <service_id>:<user_id>
Copy

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.