pulumi-alicloud-kotlin/com.pulumi.alicloud.privatelink.kotlin/VpcEndpoint

VpcEndpoint

class VpcEndpoint : KotlinCustomResource

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&#46;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&#46;id],
    service_id="epsrv-k1apjysze8u1l9t6uyg9",
    protected_enabled=False)

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 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
	})
}

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(GetResourceGroupsArgs.builder()
            .build());
        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: {}

Import

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

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

Properties

addressIpVersion

val addressIpVersion: Output<String>

The IP address version.

bandwidth

val bandwidth: Output<Int>

The bandwidth of the endpoint connection. 1024 to 10240. Unit: Mbit/s.

connectionStatus

val connectionStatus: Output<String>

The state of the endpoint connection.

createTime

val createTime: Output<String>

The time when the endpoint was created.

dryRun

val dryRun: Output<Boolean>?

Specifies whether to perform only a dry run, without performing the actual request. Valid values:

endpointBusinessStatus

val endpointBusinessStatus: Output<String>

The service state of the endpoint.

endpointDescription

val endpointDescription: Output<String>?

The description of the endpoint.

endpointDomain

val endpointDomain: Output<String>

The domain name of the endpoint.

endpointType

val endpointType: Output<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).

val id: Output<String>

policyDocument

val policyDocument: Output<String>

RAM access policies. For more information about policy definitions, see Alibaba Cloud-access control (RAM) official guidance.

protectedEnabled

val protectedEnabled: Output<Boolean>?

Specifies whether to enable user authentication. This parameter is available in Security Token Service (STS) mode. Valid values:

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

regionId

val regionId: Output<String>

(Available since v1.239.0) The region ID of the endpoint.

resourceGroupId

val resourceGroupId: Output<String>

The resource group ID.

securityGroupIds

val securityGroupIds: Output<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

val serviceId: Output<String>

The ID of the endpoint service with which the endpoint is associated.

serviceName

val serviceName: Output<String>

The name of the endpoint service with which the endpoint is associated.

status

val status: Output<String>

The state of the endpoint.