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

volcengine.mongodb.Endpoints

Explore with Pulumi AI

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

    Use this data source to query detailed information of mongodb endpoints

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = Volcengine.Mongodb.Endpoints.Invoke(new()
        {
            InstanceId = "mongo-shard-xxx",
        });
    
    });
    
    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.Endpoints(ctx, &mongodb.EndpointsArgs{
    			InstanceId: pulumi.StringRef("mongo-shard-xxx"),
    		}, nil)
    		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.MongodbFunctions;
    import com.pulumi.volcengine.mongodb.inputs.EndpointsArgs;
    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 foo = MongodbFunctions.Endpoints(EndpointsArgs.builder()
                .instanceId("mongo-shard-xxx")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo = volcengine.mongodb.endpoints(instance_id="mongo-shard-xxx")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@pulumi/volcengine";
    
    const foo = volcengine.mongodb.Endpoints({
        instanceId: "mongo-shard-xxx",
    });
    
    variables:
      foo:
        fn::invoke:
          Function: volcengine:mongodb:Endpoints
          Arguments:
            instanceId: mongo-shard-xxx
    

    Using Endpoints

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function endpoints(args: EndpointsArgs, opts?: InvokeOptions): Promise<EndpointsResult>
    function endpointsOutput(args: EndpointsOutputArgs, opts?: InvokeOptions): Output<EndpointsResult>
    def endpoints(instance_id: Optional[str] = None,
                  output_file: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> EndpointsResult
    def endpoints_output(instance_id: Optional[pulumi.Input[str]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[EndpointsResult]
    func Endpoints(ctx *Context, args *EndpointsArgs, opts ...InvokeOption) (*EndpointsResult, error)
    func EndpointsOutput(ctx *Context, args *EndpointsOutputArgs, opts ...InvokeOption) EndpointsResultOutput
    public static class Endpoints 
    {
        public static Task<EndpointsResult> InvokeAsync(EndpointsArgs args, InvokeOptions? opts = null)
        public static Output<EndpointsResult> Invoke(EndpointsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<EndpointsResult> endpoints(EndpointsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: volcengine:mongodb:Endpoints
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceId string

    The instance ID to query.

    OutputFile string

    File name where to save data source results.

    InstanceId string

    The instance ID to query.

    OutputFile string

    File name where to save data source results.

    instanceId String

    The instance ID to query.

    outputFile String

    File name where to save data source results.

    instanceId string

    The instance ID to query.

    outputFile string

    File name where to save data source results.

    instance_id str

    The instance ID to query.

    output_file str

    File name where to save data source results.

    instanceId String

    The instance ID to query.

    outputFile String

    File name where to save data source results.

    Endpoints Result

    The following output properties are available:

    Endpoints List<Volcengine.Pulumi.Volcengine.Mongodb.Outputs.EndpointsEndpoint>

    The collection of mongodb endpoints query.

    Id string

    The provider-assigned unique ID for this managed resource.

    TotalCount int

    The total count of mongodb endpoint query.

    InstanceId string
    OutputFile string
    Endpoints []EndpointsEndpoint

    The collection of mongodb endpoints query.

    Id string

    The provider-assigned unique ID for this managed resource.

    TotalCount int

    The total count of mongodb endpoint query.

    InstanceId string
    OutputFile string
    endpoints List<EndpointsEndpoint>

    The collection of mongodb endpoints query.

    id String

    The provider-assigned unique ID for this managed resource.

    totalCount Integer

    The total count of mongodb endpoint query.

    instanceId String
    outputFile String
    endpoints EndpointsEndpoint[]

    The collection of mongodb endpoints query.

    id string

    The provider-assigned unique ID for this managed resource.

    totalCount number

    The total count of mongodb endpoint query.

    instanceId string
    outputFile string
    endpoints Sequence[EndpointsEndpoint]

    The collection of mongodb endpoints query.

    id str

    The provider-assigned unique ID for this managed resource.

    total_count int

    The total count of mongodb endpoint query.

    instance_id str
    output_file str
    endpoints List<Property Map>

    The collection of mongodb endpoints query.

    id String

    The provider-assigned unique ID for this managed resource.

    totalCount Number

    The total count of mongodb endpoint query.

    instanceId String
    outputFile String

    Supporting Types

    EndpointsEndpoint

    DbAddresses List<Volcengine.Pulumi.Volcengine.Mongodb.Inputs.EndpointsEndpointDbAddress>

    The list of mongodb addresses.

    EndpointId string

    The ID of endpoint.

    EndpointStr string

    The endpoint information.

    EndpointType string

    The node type corresponding to the endpoint.

    NetworkType string

    The network type of endpoint.

    ObjectId string

    The object ID corresponding to the endpoint.

    SubnetId string

    The subnet ID.

    VpcId string

    The VPC ID.

    DbAddresses []EndpointsEndpointDbAddress

    The list of mongodb addresses.

    EndpointId string

    The ID of endpoint.

    EndpointStr string

    The endpoint information.

    EndpointType string

    The node type corresponding to the endpoint.

    NetworkType string

    The network type of endpoint.

    ObjectId string

    The object ID corresponding to the endpoint.

    SubnetId string

    The subnet ID.

    VpcId string

    The VPC ID.

    dbAddresses List<EndpointsEndpointDbAddress>

    The list of mongodb addresses.

    endpointId String

    The ID of endpoint.

    endpointStr String

    The endpoint information.

    endpointType String

    The node type corresponding to the endpoint.

    networkType String

    The network type of endpoint.

    objectId String

    The object ID corresponding to the endpoint.

    subnetId String

    The subnet ID.

    vpcId String

    The VPC ID.

    dbAddresses EndpointsEndpointDbAddress[]

    The list of mongodb addresses.

    endpointId string

    The ID of endpoint.

    endpointStr string

    The endpoint information.

    endpointType string

    The node type corresponding to the endpoint.

    networkType string

    The network type of endpoint.

    objectId string

    The object ID corresponding to the endpoint.

    subnetId string

    The subnet ID.

    vpcId string

    The VPC ID.

    db_addresses Sequence[EndpointsEndpointDbAddress]

    The list of mongodb addresses.

    endpoint_id str

    The ID of endpoint.

    endpoint_str str

    The endpoint information.

    endpoint_type str

    The node type corresponding to the endpoint.

    network_type str

    The network type of endpoint.

    object_id str

    The object ID corresponding to the endpoint.

    subnet_id str

    The subnet ID.

    vpc_id str

    The VPC ID.

    dbAddresses List<Property Map>

    The list of mongodb addresses.

    endpointId String

    The ID of endpoint.

    endpointStr String

    The endpoint information.

    endpointType String

    The node type corresponding to the endpoint.

    networkType String

    The network type of endpoint.

    objectId String

    The object ID corresponding to the endpoint.

    subnetId String

    The subnet ID.

    vpcId String

    The VPC ID.

    EndpointsEndpointDbAddress

    AddressDomain string

    The domain of mongodb connection.

    AddressIp string

    The IP of mongodb connection.

    AddressPort string

    The port of mongodb connection.

    AddressType string

    The connection type of mongodb.

    EipId string

    The EIP ID bound to the instance's public network address.

    NodeId string

    The node ID.

    AddressDomain string

    The domain of mongodb connection.

    AddressIp string

    The IP of mongodb connection.

    AddressPort string

    The port of mongodb connection.

    AddressType string

    The connection type of mongodb.

    EipId string

    The EIP ID bound to the instance's public network address.

    NodeId string

    The node ID.

    addressDomain String

    The domain of mongodb connection.

    addressIp String

    The IP of mongodb connection.

    addressPort String

    The port of mongodb connection.

    addressType String

    The connection type of mongodb.

    eipId String

    The EIP ID bound to the instance's public network address.

    nodeId String

    The node ID.

    addressDomain string

    The domain of mongodb connection.

    addressIp string

    The IP of mongodb connection.

    addressPort string

    The port of mongodb connection.

    addressType string

    The connection type of mongodb.

    eipId string

    The EIP ID bound to the instance's public network address.

    nodeId string

    The node ID.

    address_domain str

    The domain of mongodb connection.

    address_ip str

    The IP of mongodb connection.

    address_port str

    The port of mongodb connection.

    address_type str

    The connection type of mongodb.

    eip_id str

    The EIP ID bound to the instance's public network address.

    node_id str

    The node ID.

    addressDomain String

    The domain of mongodb connection.

    addressIp String

    The IP of mongodb connection.

    addressPort String

    The port of mongodb connection.

    addressType String

    The connection type of mongodb.

    eipId String

    The EIP ID bound to the instance's public network address.

    nodeId String

    The node ID.

    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