1. Packages
  2. Volcengine
  3. API Docs
  4. mongodb
  5. Endpoint
Volcengine v0.0.18 published on Wednesday, Sep 13, 2023 by Volcengine

volcengine.mongodb.Endpoint

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.18 published on Wednesday, Sep 13, 2023 by Volcengine

    Provides a resource to manage mongodb endpoint

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Volcengine.Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = new Volcengine.Mongodb.Endpoint("foo", new()
        {
            EipIds = new[]
            {
                "eip-3rfe12dvmz8qo5zsk2h91q05p",
            },
            InstanceId = "mongo-replica-38cf5badeb9e",
            NetworkType = "Public",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/mongodb"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := mongodb.NewEndpoint(ctx, "foo", &mongodb.EndpointArgs{
    			EipIds: pulumi.StringArray{
    				pulumi.String("eip-3rfe12dvmz8qo5zsk2h91q05p"),
    			},
    			InstanceId:  pulumi.String("mongo-replica-38cf5badeb9e"),
    			NetworkType: pulumi.String("Public"),
    		})
    		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.volcengine.mongodb.Endpoint;
    import com.pulumi.volcengine.mongodb.EndpointArgs;
    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) {
            var foo = new Endpoint("foo", EndpointArgs.builder()        
                .eipIds("eip-3rfe12dvmz8qo5zsk2h91q05p")
                .instanceId("mongo-replica-38cf5badeb9e")
                .networkType("Public")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo = volcengine.mongodb.Endpoint("foo",
        eip_ids=["eip-3rfe12dvmz8qo5zsk2h91q05p"],
        instance_id="mongo-replica-38cf5badeb9e",
        network_type="Public")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@volcengine/pulumi";
    
    const foo = new volcengine.mongodb.Endpoint("foo", {
        eipIds: ["eip-3rfe12dvmz8qo5zsk2h91q05p"],
        instanceId: "mongo-replica-38cf5badeb9e",
        networkType: "Public",
    });
    
    resources:
      foo:
        type: volcengine:mongodb:Endpoint
        properties:
          eipIds:
            - eip-3rfe12dvmz8qo5zsk2h91q05p
          instanceId: mongo-replica-38cf5badeb9e
          # object_id="mongo-shard-8ad9f45e173e"
          networkType: Public
    

    Create Endpoint Resource

    new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);
    @overload
    def Endpoint(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 eip_ids: Optional[Sequence[str]] = None,
                 instance_id: Optional[str] = None,
                 mongos_node_ids: Optional[Sequence[str]] = None,
                 network_type: Optional[str] = None,
                 object_id: Optional[str] = None)
    @overload
    def Endpoint(resource_name: str,
                 args: EndpointArgs,
                 opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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

    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.

    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.

    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.

    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.

    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.

    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.

    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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    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.

    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.

    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.

    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.

    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.

    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.

    objectId String

    The object ID corresponding to the endpoint.

    Import

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

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

    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.18 published on Wednesday, Sep 13, 2023 by Volcengine