Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. mongodb
  5. Endpoint
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.mongodb.Endpoint

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage mongodb endpoint

    Example Usage

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

const fooZones = volcengine.ecs.getZones({});
const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
});
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.0.0/24",
    zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
    vpcId: fooVpc.id,
});
const fooAddress: volcengine.eip.Address[] = [];
for (const range = {value: 0}; range.value < 2; range.value++) {
    fooAddress.push(new volcengine.eip.Address(`fooAddress-${range.value}`, {
        billingType: "PostPaidByBandwidth",
        bandwidth: 1,
        isp: "ChinaUnicom",
        description: "acc-test",
        projectName: "default",
    }));
}
const replica_set = new volcengine.mongodb.Instance("replica-set", {
    dbEngineVersion: "MongoDB_4_0",
    instanceType: "ReplicaSet",
    superAccountPassword: "@acc-test-123",
    nodeSpec: "mongo.2c4g",
    mongosNodeSpec: "mongo.mongos.2c4g",
    instanceName: "acc-test-mongo-replica",
    chargeType: "PostPaid",
    projectName: "default",
    mongosNodeNumber: 2,
    shardNumber: 3,
    storageSpaceGb: 20,
    subnetId: fooSubnet.id,
    zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
    tags: [{
        key: "k1",
        value: "v1",
    }],
});
const replica_set_public_endpoint = new volcengine.mongodb.Endpoint("replica-set-public-endpoint", {
    instanceId: replica_set.id,
    networkType: "Public",
    eipIds: fooAddress.map(__item => __item.id),
});
const sharded_cluster = new volcengine.mongodb.Instance("sharded-cluster", {
    dbEngineVersion: "MongoDB_4_0",
    instanceType: "ShardedCluster",
    superAccountPassword: "@acc-test-123",
    nodeSpec: "mongo.shard.1c2g",
    mongosNodeSpec: "mongo.mongos.1c2g",
    instanceName: "acc-test-mongo-shard",
    chargeType: "PostPaid",
    projectName: "default",
    mongosNodeNumber: 2,
    shardNumber: 2,
    storageSpaceGb: 20,
    subnetId: fooSubnet.id,
    zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
    tags: [{
        key: "k1",
        value: "v1",
    }],
});
const sharded_cluster_private_endpoint = new volcengine.mongodb.Endpoint("sharded-cluster-private-endpoint", {
    instanceId: sharded_cluster.id,
    networkType: "Private",
    objectId: sharded_cluster.shards.apply(shards => shards[0].shardId),
});

    import pulumi
import pulumi_volcengine as volcengine

foo_zones = volcengine.ecs.get_zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id=foo_zones.zones[0].id,
    vpc_id=foo_vpc.id)
foo_address = []
for range in [{"value": i} for i in range(0, 2)]:
    foo_address.append(volcengine.eip.Address(f"fooAddress-{range['value']}",
        billing_type="PostPaidByBandwidth",
        bandwidth=1,
        isp="ChinaUnicom",
        description="acc-test",
        project_name="default"))
replica_set = volcengine.mongodb.Instance("replica-set",
    db_engine_version="MongoDB_4_0",
    instance_type="ReplicaSet",
    super_account_password="@acc-test-123",
    node_spec="mongo.2c4g",
    mongos_node_spec="mongo.mongos.2c4g",
    instance_name="acc-test-mongo-replica",
    charge_type="PostPaid",
    project_name="default",
    mongos_node_number=2,
    shard_number=3,
    storage_space_gb=20,
    subnet_id=foo_subnet.id,
    zone_id=foo_zones.zones[0].id,
    tags=[volcengine.mongodb.InstanceTagArgs(
        key="k1",
        value="v1",
    )])
replica_set_public_endpoint = volcengine.mongodb.Endpoint("replica-set-public-endpoint",
    instance_id=replica_set.id,
    network_type="Public",
    eip_ids=[__item.id for __item in foo_address])
sharded_cluster = volcengine.mongodb.Instance("sharded-cluster",
    db_engine_version="MongoDB_4_0",
    instance_type="ShardedCluster",
    super_account_password="@acc-test-123",
    node_spec="mongo.shard.1c2g",
    mongos_node_spec="mongo.mongos.1c2g",
    instance_name="acc-test-mongo-shard",
    charge_type="PostPaid",
    project_name="default",
    mongos_node_number=2,
    shard_number=2,
    storage_space_gb=20,
    subnet_id=foo_subnet.id,
    zone_id=foo_zones.zones[0].id,
    tags=[volcengine.mongodb.InstanceTagArgs(
        key="k1",
        value="v1",
    )])
sharded_cluster_private_endpoint = volcengine.mongodb.Endpoint("sharded-cluster-private-endpoint",
    instance_id=sharded_cluster.id,
    network_type="Private",
    object_id=sharded_cluster.shards[0].shard_id)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/eip"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/mongodb"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooZones, err := ecs.GetZones(ctx, nil, nil)
		if err != nil {
			return err
		}
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String(fooZones.Zones[0].Id),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		var fooAddress []*eip.Address
		for index := 0; index < 2; index++ {
			key0 := index
			_ := index
			__res, err := eip.NewAddress(ctx, fmt.Sprintf("fooAddress-%v", key0), &eip.AddressArgs{
				BillingType: pulumi.String("PostPaidByBandwidth"),
				Bandwidth:   pulumi.Int(1),
				Isp:         pulumi.String("ChinaUnicom"),
				Description: pulumi.String("acc-test"),
				ProjectName: pulumi.String("default"),
			})
			if err != nil {
				return err
			}
			fooAddress = append(fooAddress, __res)
		}
		_, err = mongodb.NewInstance(ctx, "replica-set", &mongodb.InstanceArgs{
			DbEngineVersion:      pulumi.String("MongoDB_4_0"),
			InstanceType:         pulumi.String("ReplicaSet"),
			SuperAccountPassword: pulumi.String("@acc-test-123"),
			NodeSpec:             pulumi.String("mongo.2c4g"),
			MongosNodeSpec:       pulumi.String("mongo.mongos.2c4g"),
			InstanceName:         pulumi.String("acc-test-mongo-replica"),
			ChargeType:           pulumi.String("PostPaid"),
			ProjectName:          pulumi.String("default"),
			MongosNodeNumber:     pulumi.Int(2),
			ShardNumber:          pulumi.Int(3),
			StorageSpaceGb:       pulumi.Int(20),
			SubnetId:             fooSubnet.ID(),
			ZoneId:               pulumi.String(fooZones.Zones[0].Id),
			Tags: mongodb.InstanceTagArray{
				&mongodb.InstanceTagArgs{
					Key:   pulumi.String("k1"),
					Value: pulumi.String("v1"),
				},
			},
		})
		if err != nil {
			return err
		}
		var splat0 pulumi.StringArray
		for _, val0 := range fooAddress {
			splat0 = append(splat0, val0.ID())
		}
		_, err = mongodb.NewEndpoint(ctx, "replica-set-public-endpoint", &mongodb.EndpointArgs{
			InstanceId:  replica_set.ID(),
			NetworkType: pulumi.String("Public"),
			EipIds:      splat0,
		})
		if err != nil {
			return err
		}
		_, err = mongodb.NewInstance(ctx, "sharded-cluster", &mongodb.InstanceArgs{
			DbEngineVersion:      pulumi.String("MongoDB_4_0"),
			InstanceType:         pulumi.String("ShardedCluster"),
			SuperAccountPassword: pulumi.String("@acc-test-123"),
			NodeSpec:             pulumi.String("mongo.shard.1c2g"),
			MongosNodeSpec:       pulumi.String("mongo.mongos.1c2g"),
			InstanceName:         pulumi.String("acc-test-mongo-shard"),
			ChargeType:           pulumi.String("PostPaid"),
			ProjectName:          pulumi.String("default"),
			MongosNodeNumber:     pulumi.Int(2),
			ShardNumber:          pulumi.Int(2),
			StorageSpaceGb:       pulumi.Int(20),
			SubnetId:             fooSubnet.ID(),
			ZoneId:               pulumi.String(fooZones.Zones[0].Id),
			Tags: mongodb.InstanceTagArray{
				&mongodb.InstanceTagArgs{
					Key:   pulumi.String("k1"),
					Value: pulumi.String("v1"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = mongodb.NewEndpoint(ctx, "sharded-cluster-private-endpoint", &mongodb.EndpointArgs{
			InstanceId:  sharded_cluster.ID(),
			NetworkType: pulumi.String("Private"),
			ObjectId: sharded_cluster.Shards.ApplyT(func(shards []mongodb.InstanceShard) (*string, error) {
				return &shards[0].ShardId, nil
			}).(pulumi.StringPtrOutput),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var fooZones = Volcengine.Ecs.GetZones.Invoke();

    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = fooZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        VpcId = fooVpc.Id,
    });

    var fooAddress = new List<Volcengine.Eip.Address>();
    for (var rangeIndex = 0; rangeIndex < 2; rangeIndex++)
    {
        var range = new { Value = rangeIndex };
        fooAddress.Add(new Volcengine.Eip.Address($"fooAddress-{range.Value}", new()
        {
            BillingType = "PostPaidByBandwidth",
            Bandwidth = 1,
            Isp = "ChinaUnicom",
            Description = "acc-test",
            ProjectName = "default",
        }));
    }
    var replica_set = new Volcengine.Mongodb.Instance("replica-set", new()
    {
        DbEngineVersion = "MongoDB_4_0",
        InstanceType = "ReplicaSet",
        SuperAccountPassword = "@acc-test-123",
        NodeSpec = "mongo.2c4g",
        MongosNodeSpec = "mongo.mongos.2c4g",
        InstanceName = "acc-test-mongo-replica",
        ChargeType = "PostPaid",
        ProjectName = "default",
        MongosNodeNumber = 2,
        ShardNumber = 3,
        StorageSpaceGb = 20,
        SubnetId = fooSubnet.Id,
        ZoneId = fooZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        Tags = new[]
        {
            new Volcengine.Mongodb.Inputs.InstanceTagArgs
            {
                Key = "k1",
                Value = "v1",
            },
        },
    });

    var replica_set_public_endpoint = new Volcengine.Mongodb.Endpoint("replica-set-public-endpoint", new()
    {
        InstanceId = replica_set.Id,
        NetworkType = "Public",
        EipIds = fooAddress.Select(__item => __item.Id).ToList(),
    });

    var sharded_cluster = new Volcengine.Mongodb.Instance("sharded-cluster", new()
    {
        DbEngineVersion = "MongoDB_4_0",
        InstanceType = "ShardedCluster",
        SuperAccountPassword = "@acc-test-123",
        NodeSpec = "mongo.shard.1c2g",
        MongosNodeSpec = "mongo.mongos.1c2g",
        InstanceName = "acc-test-mongo-shard",
        ChargeType = "PostPaid",
        ProjectName = "default",
        MongosNodeNumber = 2,
        ShardNumber = 2,
        StorageSpaceGb = 20,
        SubnetId = fooSubnet.Id,
        ZoneId = fooZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        Tags = new[]
        {
            new Volcengine.Mongodb.Inputs.InstanceTagArgs
            {
                Key = "k1",
                Value = "v1",
            },
        },
    });

    var sharded_cluster_private_endpoint = new Volcengine.Mongodb.Endpoint("sharded-cluster-private-endpoint", new()
    {
        InstanceId = sharded_cluster.Id,
        NetworkType = "Private",
        ObjectId = sharded_cluster.Shards.Apply(shards => shards[0].ShardId),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.GetZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.eip.Address;
import com.pulumi.volcengine.eip.AddressArgs;
import com.pulumi.volcengine.mongodb.Instance;
import com.pulumi.volcengine.mongodb.InstanceArgs;
import com.pulumi.volcengine.mongodb.inputs.InstanceTagArgs;
import com.pulumi.volcengine.mongodb.Endpoint;
import com.pulumi.volcengine.mongodb.EndpointArgs;
import com.pulumi.codegen.internal.KeyedValue;
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 fooZones = EcsFunctions.getZones();

        var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .vpcId(fooVpc.id())
            .build());

        for (var i = 0; i < 2; i++) {
            new Address("fooAddress-" + i, AddressArgs.builder()            
                .billingType("PostPaidByBandwidth")
                .bandwidth(1)
                .isp("ChinaUnicom")
                .description("acc-test")
                .projectName("default")
                .build());

        
}
        var replica_set = new Instance("replica-set", InstanceArgs.builder()        
            .dbEngineVersion("MongoDB_4_0")
            .instanceType("ReplicaSet")
            .superAccountPassword("@acc-test-123")
            .nodeSpec("mongo.2c4g")
            .mongosNodeSpec("mongo.mongos.2c4g")
            .instanceName("acc-test-mongo-replica")
            .chargeType("PostPaid")
            .projectName("default")
            .mongosNodeNumber(2)
            .shardNumber(3)
            .storageSpaceGb(20)
            .subnetId(fooSubnet.id())
            .zoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .tags(InstanceTagArgs.builder()
                .key("k1")
                .value("v1")
                .build())
            .build());

        var replica_set_public_endpoint = new Endpoint("replica-set-public-endpoint", EndpointArgs.builder()        
            .instanceId(replica_set.id())
            .networkType("Public")
            .eipIds(fooAddress.stream().map(element -> element.id()).collect(toList()))
            .build());

        var sharded_cluster = new Instance("sharded-cluster", InstanceArgs.builder()        
            .dbEngineVersion("MongoDB_4_0")
            .instanceType("ShardedCluster")
            .superAccountPassword("@acc-test-123")
            .nodeSpec("mongo.shard.1c2g")
            .mongosNodeSpec("mongo.mongos.1c2g")
            .instanceName("acc-test-mongo-shard")
            .chargeType("PostPaid")
            .projectName("default")
            .mongosNodeNumber(2)
            .shardNumber(2)
            .storageSpaceGb(20)
            .subnetId(fooSubnet.id())
            .zoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .tags(InstanceTagArgs.builder()
                .key("k1")
                .value("v1")
                .build())
            .build());

        var sharded_cluster_private_endpoint = new Endpoint("sharded-cluster-private-endpoint", EndpointArgs.builder()        
            .instanceId(sharded_cluster.id())
            .networkType("Private")
            .objectId(sharded_cluster.shards().applyValue(shards -> shards[0].shardId()))
            .build());

    }
}

    Coming soon!

    Create Endpoint Resource

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

    Constructor syntax

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

@overload
def Endpoint(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             instance_id: Optional[str] = None,
             eip_ids: Optional[Sequence[str]] = None,
             mongos_node_ids: Optional[Sequence[str]] = None,
             network_type: Optional[str] = None,
             object_id: Optional[str] = None)
    func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)
    public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)
    public Endpoint(String name, EndpointArgs args)
public Endpoint(String name, EndpointArgs args, CustomResourceOptions options)

    type: volcengine:mongodb:Endpoint
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 EndpointArgs
    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 EndpointArgs
    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 EndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EndpointArgs
    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 volcengineEndpointResource = new Volcengine.Mongodb.Endpoint("volcengineEndpointResource", new()
{
    InstanceId = "string",
    EipIds = new[]
    {
        "string",
    },
    MongosNodeIds = new[]
    {
        "string",
    },
    NetworkType = "string",
    ObjectId = "string",
});

    example, err := mongodb.NewEndpoint(ctx, "volcengineEndpointResource", &mongodb.EndpointArgs{
	InstanceId: pulumi.String("string"),
	EipIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	MongosNodeIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	NetworkType: pulumi.String("string"),
	ObjectId:    pulumi.String("string"),
})

    var volcengineEndpointResource = new com.pulumi.volcengine.mongodb.Endpoint("volcengineEndpointResource", com.pulumi.volcengine.mongodb.EndpointArgs.builder()
    .instanceId("string")
    .eipIds("string")
    .mongosNodeIds("string")
    .networkType("string")
    .objectId("string")
    .build());

    volcengine_endpoint_resource = volcengine.mongodb.Endpoint("volcengineEndpointResource",
    instance_id="string",
    eip_ids=["string"],
    mongos_node_ids=["string"],
    network_type="string",
    object_id="string")

    const volcengineEndpointResource = new volcengine.mongodb.Endpoint("volcengineEndpointResource", {
    instanceId: "string",
    eipIds: ["string"],
    mongosNodeIds: ["string"],
    networkType: "string",
    objectId: "string",
});

    type: volcengine:mongodb:Endpoint
properties:
    eipIds:
        - string
    instanceId: string
    mongosNodeIds:
        - string
    networkType: string
    objectId: string

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

    InstanceId string
    The instance where the endpoint resides.
    EipIds List<string>
    A list of EIP IDs that need to be bound when applying for endpoint.
    MongosNodeIds List<string>
    A list of the Mongos node that needs to apply for the endpoint.
    NetworkType string
    The network type of endpoint. Valid values: Private, Public. Default is Private.
    ObjectId string
    The object ID corresponding to the endpoint.
    InstanceId string
    The instance where the endpoint resides.
    EipIds []string
    A list of EIP IDs that need to be bound when applying for endpoint.
    MongosNodeIds []string
    A list of the Mongos node that needs to apply for the endpoint.
    NetworkType string
    The network type of endpoint. Valid values: Private, Public. Default is Private.
    ObjectId string
    The object ID corresponding to the endpoint.
    instanceId String
    The instance where the endpoint resides.
    eipIds List<String>
    A list of EIP IDs that need to be bound when applying for endpoint.
    mongosNodeIds List<String>
    A list of the Mongos node that needs to apply for the endpoint.
    networkType String
    The network type of endpoint. Valid values: Private, Public. Default is Private.
    objectId String
    The object ID corresponding to the endpoint.
    instanceId string
    The instance where the endpoint resides.
    eipIds string[]
    A list of EIP IDs that need to be bound when applying for endpoint.
    mongosNodeIds string[]
    A list of the Mongos node that needs to apply for the endpoint.
    networkType string
    The network type of endpoint. Valid values: Private, Public. Default is Private.
    objectId string
    The object ID corresponding to the endpoint.
    instance_id str
    The instance where the endpoint resides.
    eip_ids Sequence[str]
    A list of EIP IDs that need to be bound when applying for endpoint.
    mongos_node_ids Sequence[str]
    A list of the Mongos node that needs to apply for the endpoint.
    network_type str
    The network type of endpoint. Valid values: Private, Public. Default is Private.
    object_id str
    The object ID corresponding to the endpoint.
    instanceId String
    The instance where the endpoint resides.
    eipIds List<String>
    A list of EIP IDs that need to be bound when applying for endpoint.
    mongosNodeIds List<String>
    A list of the Mongos node that needs to apply for the endpoint.
    networkType String
    The network type of endpoint. Valid values: Private, Public. Default is Private.
    objectId String
    The object ID corresponding to the endpoint.

    Outputs

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

    EndpointId string
    The id of endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    EndpointId string
    The id of endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    endpointId String
    The id of endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    endpointId string
    The id of endpoint.
    id string
    The provider-assigned unique ID for this managed resource.
    endpoint_id str
    The id of endpoint.
    id str
    The provider-assigned unique ID for this managed resource.
    endpointId String
    The id of endpoint.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Endpoint Resource

    Get an existing Endpoint 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?: EndpointState, opts?: CustomResourceOptions): Endpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        eip_ids: Optional[Sequence[str]] = None,
        endpoint_id: Optional[str] = None,
        instance_id: Optional[str] = None,
        mongos_node_ids: Optional[Sequence[str]] = None,
        network_type: Optional[str] = None,
        object_id: Optional[str] = None) -> Endpoint
    func GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)
    public static Endpoint Get(string name, Input<string> id, EndpointState? state, CustomResourceOptions? opts = null)
    public static Endpoint get(String name, Output<String> id, EndpointState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:mongodb:Endpoint    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.
    The following state arguments are supported:
    EipIds List<string>
    A list of EIP IDs that need to be bound when applying for endpoint.
    EndpointId string
    The id of endpoint.
    InstanceId string
    The instance where the endpoint resides.
    MongosNodeIds List<string>
    A list of the Mongos node that needs to apply for the endpoint.
    NetworkType string
    The network type of endpoint. Valid values: Private, Public. Default is Private.
    ObjectId string
    The object ID corresponding to the endpoint.
    EipIds []string
    A list of EIP IDs that need to be bound when applying for endpoint.
    EndpointId string
    The id of endpoint.
    InstanceId string
    The instance where the endpoint resides.
    MongosNodeIds []string
    A list of the Mongos node that needs to apply for the endpoint.
    NetworkType string
    The network type of endpoint. Valid values: Private, Public. Default is Private.
    ObjectId string
    The object ID corresponding to the endpoint.
    eipIds List<String>
    A list of EIP IDs that need to be bound when applying for endpoint.
    endpointId String
    The id of endpoint.
    instanceId String
    The instance where the endpoint resides.
    mongosNodeIds List<String>
    A list of the Mongos node that needs to apply for the endpoint.
    networkType String
    The network type of endpoint. Valid values: Private, Public. Default is Private.
    objectId String
    The object ID corresponding to the endpoint.
    eipIds string[]
    A list of EIP IDs that need to be bound when applying for endpoint.
    endpointId string
    The id of endpoint.
    instanceId string
    The instance where the endpoint resides.
    mongosNodeIds string[]
    A list of the Mongos node that needs to apply for the endpoint.
    networkType string
    The network type of endpoint. Valid values: Private, Public. Default is Private.
    objectId string
    The object ID corresponding to the endpoint.
    eip_ids Sequence[str]
    A list of EIP IDs that need to be bound when applying for endpoint.
    endpoint_id str
    The id of endpoint.
    instance_id str
    The instance where the endpoint resides.
    mongos_node_ids Sequence[str]
    A list of the Mongos node that needs to apply for the endpoint.
    network_type str
    The network type of endpoint. Valid values: Private, Public. Default is Private.
    object_id str
    The object ID corresponding to the endpoint.
    eipIds List<String>
    A list of EIP IDs that need to be bound when applying for endpoint.
    endpointId String
    The id of endpoint.
    instanceId String
    The instance where the endpoint resides.
    mongosNodeIds List<String>
    A list of the Mongos node that needs to apply for the endpoint.
    networkType String
    The network type of endpoint. Valid values: Private, Public. Default is Private.
    objectId String
    The object ID corresponding to the endpoint.

    Import

    mongodb endpoint can be imported using the instanceId:endpointId instanceId: represents the instance that endpoint related to. endpointId: the id of endpoint. e.g.

    $ pulumi import volcengine:mongodb/endpoint:Endpoint default mongo-replica-e405f8e2****:BRhFA0pDAk0XXkxCZQ

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
    volcengine/pulumi-volcengine