Alibaba Cloud

v3.28.0 published on Tuesday, Aug 16, 2022 by Pulumi

getInstances

The alicloud.mongodb.getInstances data source provides a collection of MongoDB instances available in Alicloud account. Filters support regular expression for the instance name, engine or instance type.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var mongo = Output.Create(AliCloud.MongoDB.GetInstances.InvokeAsync(new AliCloud.MongoDB.GetInstancesArgs
        {
            AvailabilityZone = "eu-central-1a",
            InstanceClass = "dds.mongo.mid",
            InstanceType = "replicate",
            NameRegex = "dds-.+\\d+",
        }));
    }

}

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/mongodb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodb.GetInstances(ctx, &mongodb.GetInstancesArgs{
			AvailabilityZone: pulumi.StringRef("eu-central-1a"),
			InstanceClass:    pulumi.StringRef("dds.mongo.mid"),
			InstanceType:     pulumi.StringRef("replicate"),
			NameRegex:        pulumi.StringRef("dds-.+\\d+"),
		}, 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.alicloud.mongodb.MongodbFunctions;
import com.pulumi.alicloud.actiontrail.inputs.GetInstancesArgs;
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 mongo = MongodbFunctions.getInstances(GetInstancesArgs.builder()
            .availabilityZone("eu-central-1a")
            .instanceClass("dds.mongo.mid")
            .instanceType("replicate")
            .nameRegex("dds-.+\\d+")
            .build());

    }
}

import pulumi
import pulumi_alicloud as alicloud

mongo = alicloud.mongodb.get_instances(availability_zone="eu-central-1a",
    instance_class="dds.mongo.mid",
    instance_type="replicate",
    name_regex="dds-.+\\d+")

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

const mongo = pulumi.output(alicloud.mongodb.getInstances({
    availabilityZone: "eu-central-1a",
    instanceClass: "dds.mongo.mid",
    instanceType: "replicate",
    nameRegex: "dds-.+\\d+",
}));

variables:
  mongo:
    Fn::Invoke:
      Function: alicloud:mongodb:getInstances
      Arguments:
        availabilityZone: eu-central-1a
        instanceClass: dds.mongo.mid
        instanceType: replicate
        nameRegex: dds-.+\d+

Using getInstances

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 getInstances(args: GetInstancesArgs, opts?: InvokeOptions): Promise<GetInstancesResult>
function getInstancesOutput(args: GetInstancesOutputArgs, opts?: InvokeOptions): Output<GetInstancesResult>

def get_instances(availability_zone: Optional[str] = None,
                  ids: Optional[Sequence[str]] = None,
                  instance_class: Optional[str] = None,
                  instance_type: Optional[str] = None,
                  name_regex: Optional[str] = None,
                  output_file: Optional[str] = None,
                  tags: Optional[Mapping[str, Any]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetInstancesResult
def get_instances_output(availability_zone: Optional[pulumi.Input[str]] = None,
                  ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  instance_class: Optional[pulumi.Input[str]] = None,
                  instance_type: Optional[pulumi.Input[str]] = None,
                  name_regex: Optional[pulumi.Input[str]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetInstancesResult]

func GetInstances(ctx *Context, args *GetInstancesArgs, opts ...InvokeOption) (*GetInstancesResult, error)
func GetInstancesOutput(ctx *Context, args *GetInstancesOutputArgs, opts ...InvokeOption) GetInstancesResultOutput

> Note: This function is named GetInstances in the Go SDK.

public static class GetInstances 
{
    public static Task<GetInstancesResult> InvokeAsync(GetInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetInstancesResult> Invoke(GetInstancesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: alicloud:mongodb/getInstances:getInstances
  arguments:
    # arguments dictionary

The following arguments are supported:

AvailabilityZone string: Instance availability zone.
Ids List<string>: The ids list of MongoDB instances
InstanceClass string: Sizing of the instance to be queried.
InstanceType string: Type of the instance to be queried. If it is set to sharding, the sharded cluster instances are listed. If it is set to replicate, replica set instances are listed. Default value replicate.
NameRegex string: A regex string to apply to the instance name.
OutputFile string
Tags Dictionary<string, object>: A mapping of tags to assign to the resource.

AvailabilityZone string: Instance availability zone.
Ids []string: The ids list of MongoDB instances
InstanceClass string: Sizing of the instance to be queried.
InstanceType string: Type of the instance to be queried. If it is set to sharding, the sharded cluster instances are listed. If it is set to replicate, replica set instances are listed. Default value replicate.
NameRegex string: A regex string to apply to the instance name.
OutputFile string
Tags map[string]interface{}: A mapping of tags to assign to the resource.

availabilityZone String: Instance availability zone.
ids List<String>: The ids list of MongoDB instances
instanceClass String: Sizing of the instance to be queried.
instanceType String: Type of the instance to be queried. If it is set to sharding, the sharded cluster instances are listed. If it is set to replicate, replica set instances are listed. Default value replicate.
nameRegex String: A regex string to apply to the instance name.
outputFile String
tags Map<String,Object>: A mapping of tags to assign to the resource.

availabilityZone string: Instance availability zone.
ids string[]: The ids list of MongoDB instances
instanceClass string: Sizing of the instance to be queried.
instanceType string: Type of the instance to be queried. If it is set to sharding, the sharded cluster instances are listed. If it is set to replicate, replica set instances are listed. Default value replicate.
nameRegex string: A regex string to apply to the instance name.
outputFile string
tags {[key: string]: any}: A mapping of tags to assign to the resource.

availability_zone str: Instance availability zone.
ids Sequence[str]: The ids list of MongoDB instances
instance_class str: Sizing of the instance to be queried.
instance_type str: Type of the instance to be queried. If it is set to sharding, the sharded cluster instances are listed. If it is set to replicate, replica set instances are listed. Default value replicate.
name_regex str: A regex string to apply to the instance name.
output_file str
tags Mapping[str, Any]: A mapping of tags to assign to the resource.

availabilityZone String: Instance availability zone.
ids List<String>: The ids list of MongoDB instances
instanceClass String: Sizing of the instance to be queried.
instanceType String: Type of the instance to be queried. If it is set to sharding, the sharded cluster instances are listed. If it is set to replicate, replica set instances are listed. Default value replicate.
nameRegex String: A regex string to apply to the instance name.
outputFile String
tags Map<Any>: A mapping of tags to assign to the resource.

getInstances Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Ids List<string>: The ids list of MongoDB instances
Instances List<Pulumi.AliCloud.MongoDB.Outputs.GetInstancesInstance>: A list of MongoDB instances. Its every element contains the following attributes:
Names List<string>: The names list of MongoDB instances
AvailabilityZone string: Instance availability zone.
InstanceClass string: Sizing of the MongoDB instance.
InstanceType string: Instance type. Optional values sharding or replicate.
NameRegex string
OutputFile string
Tags Dictionary<string, object>

Id string: The provider-assigned unique ID for this managed resource.
Ids []string: The ids list of MongoDB instances
Instances []GetInstancesInstance: A list of MongoDB instances. Its every element contains the following attributes:
Names []string: The names list of MongoDB instances
AvailabilityZone string: Instance availability zone.
InstanceClass string: Sizing of the MongoDB instance.
InstanceType string: Instance type. Optional values sharding or replicate.
NameRegex string
OutputFile string
Tags map[string]interface{}

id String: The provider-assigned unique ID for this managed resource.
ids List<String>: The ids list of MongoDB instances
instances List<GetInstancesInstance>: A list of MongoDB instances. Its every element contains the following attributes:
names List<String>: The names list of MongoDB instances
availabilityZone String: Instance availability zone.
instanceClass String: Sizing of the MongoDB instance.
instanceType String: Instance type. Optional values sharding or replicate.
nameRegex String
outputFile String
tags Map<String,Object>

id string: The provider-assigned unique ID for this managed resource.
ids string[]: The ids list of MongoDB instances
instances GetInstancesInstance[]: A list of MongoDB instances. Its every element contains the following attributes:
names string[]: The names list of MongoDB instances
availabilityZone string: Instance availability zone.
instanceClass string: Sizing of the MongoDB instance.
instanceType string: Instance type. Optional values sharding or replicate.
nameRegex string
outputFile string
tags {[key: string]: any}

id str: The provider-assigned unique ID for this managed resource.
ids Sequence[str]: The ids list of MongoDB instances
instances Sequence[GetInstancesInstance]: A list of MongoDB instances. Its every element contains the following attributes:
names Sequence[str]: The names list of MongoDB instances
availability_zone str: Instance availability zone.
instance_class str: Sizing of the MongoDB instance.
instance_type str: Instance type. Optional values sharding or replicate.
name_regex str
output_file str
tags Mapping[str, Any]

id String: The provider-assigned unique ID for this managed resource.
ids List<String>: The ids list of MongoDB instances
instances List<Property Map>: A list of MongoDB instances. Its every element contains the following attributes:
names List<String>: The names list of MongoDB instances
availabilityZone String: Instance availability zone.
instanceClass String: Sizing of the MongoDB instance.
instanceType String: Instance type. Optional values sharding or replicate.
nameRegex String
outputFile String
tags Map<Any>

Supporting Types

GetInstancesInstance

AvailabilityZone string: Instance availability zone.
ChargeType string: Billing method. Value options are PostPaid for Pay-As-You-Go and PrePaid for yearly or monthly subscription.
CreationTime string: Creation time of the instance in RFC3339 format.
Engine string: Database engine type. Supported option is MongoDB.
EngineVersion string: Database engine version.
ExpirationTime string: Expiration time in RFC3339 format. Pay-As-You-Go instances are never expire.
Id string: The ID of the MongoDB instance.
InstanceClass string: Sizing of the instance to be queried.
InstanceType string: Type of the instance to be queried. If it is set to sharding, the sharded cluster instances are listed. If it is set to replicate, replica set instances are listed. Default value replicate.
LockMode string: Lock status of the instance.
Mongos List<Pulumi.AliCloud.MongoDB.Inputs.GetInstancesInstanceMongo>: Array composed of Mongos.
Name string: The name of the MongoDB instance.
NetworkType string: Classic network or VPC.
RegionId string: Region ID the instance belongs to.
Replication string: Replication factor corresponds to number of nodes. Optional values are 1 for single node and 3 for three nodes replica set.
Shards List<Pulumi.AliCloud.MongoDB.Inputs.GetInstancesInstanceShard>: Array composed of shards.
Status string: Status of the instance.
Storage int: Shard disk.
Tags Dictionary<string, object>: A mapping of tags to assign to the resource.

AvailabilityZone string: Instance availability zone.
ChargeType string: Billing method. Value options are PostPaid for Pay-As-You-Go and PrePaid for yearly or monthly subscription.
CreationTime string: Creation time of the instance in RFC3339 format.
Engine string: Database engine type. Supported option is MongoDB.
EngineVersion string: Database engine version.
ExpirationTime string: Expiration time in RFC3339 format. Pay-As-You-Go instances are never expire.
Id string: The ID of the MongoDB instance.
InstanceClass string: Sizing of the instance to be queried.
InstanceType string: Type of the instance to be queried. If it is set to sharding, the sharded cluster instances are listed. If it is set to replicate, replica set instances are listed. Default value replicate.
LockMode string: Lock status of the instance.
Mongos []GetInstancesInstanceMongo: Array composed of Mongos.
Name string: The name of the MongoDB instance.
NetworkType string: Classic network or VPC.
RegionId string: Region ID the instance belongs to.
Replication string: Replication factor corresponds to number of nodes. Optional values are 1 for single node and 3 for three nodes replica set.
Shards []GetInstancesInstanceShard: Array composed of shards.
Status string: Status of the instance.
Storage int: Shard disk.
Tags map[string]interface{}: A mapping of tags to assign to the resource.

availabilityZone String: Instance availability zone.
chargeType String: Billing method. Value options are PostPaid for Pay-As-You-Go and PrePaid for yearly or monthly subscription.
creationTime String: Creation time of the instance in RFC3339 format.
engine String: Database engine type. Supported option is MongoDB.
engineVersion String: Database engine version.
expirationTime String: Expiration time in RFC3339 format. Pay-As-You-Go instances are never expire.
id String: The ID of the MongoDB instance.
instanceClass String: Sizing of the instance to be queried.
instanceType String: Type of the instance to be queried. If it is set to sharding, the sharded cluster instances are listed. If it is set to replicate, replica set instances are listed. Default value replicate.
lockMode String: Lock status of the instance.
mongos List<GetInstancesInstanceMongo>: Array composed of Mongos.
name String: The name of the MongoDB instance.
networkType String: Classic network or VPC.
regionId String: Region ID the instance belongs to.
replication String: Replication factor corresponds to number of nodes. Optional values are 1 for single node and 3 for three nodes replica set.
shards List<GetInstancesInstanceShard>: Array composed of shards.
status String: Status of the instance.
storage Integer: Shard disk.
tags Map<String,Object>: A mapping of tags to assign to the resource.

availabilityZone string: Instance availability zone.
chargeType string: Billing method. Value options are PostPaid for Pay-As-You-Go and PrePaid for yearly or monthly subscription.
creationTime string: Creation time of the instance in RFC3339 format.
engine string: Database engine type. Supported option is MongoDB.
engineVersion string: Database engine version.
expirationTime string: Expiration time in RFC3339 format. Pay-As-You-Go instances are never expire.
id string: The ID of the MongoDB instance.
instanceClass string: Sizing of the instance to be queried.
instanceType string: Type of the instance to be queried. If it is set to sharding, the sharded cluster instances are listed. If it is set to replicate, replica set instances are listed. Default value replicate.
lockMode string: Lock status of the instance.
mongos GetInstancesInstanceMongo[]: Array composed of Mongos.
name string: The name of the MongoDB instance.
networkType string: Classic network or VPC.
regionId string: Region ID the instance belongs to.
replication string: Replication factor corresponds to number of nodes. Optional values are 1 for single node and 3 for three nodes replica set.
shards GetInstancesInstanceShard[]: Array composed of shards.
status string: Status of the instance.
storage number: Shard disk.
tags {[key: string]: any}: A mapping of tags to assign to the resource.

availability_zone str: Instance availability zone.
charge_type str: Billing method. Value options are PostPaid for Pay-As-You-Go and PrePaid for yearly or monthly subscription.
creation_time str: Creation time of the instance in RFC3339 format.
engine str: Database engine type. Supported option is MongoDB.
engine_version str: Database engine version.
expiration_time str: Expiration time in RFC3339 format. Pay-As-You-Go instances are never expire.
id str: The ID of the MongoDB instance.
instance_class str: Sizing of the instance to be queried.
instance_type str: Type of the instance to be queried. If it is set to sharding, the sharded cluster instances are listed. If it is set to replicate, replica set instances are listed. Default value replicate.
lock_mode str: Lock status of the instance.
mongos Sequence[GetInstancesInstanceMongo]: Array composed of Mongos.
name str: The name of the MongoDB instance.
network_type str: Classic network or VPC.
region_id str: Region ID the instance belongs to.
replication str: Replication factor corresponds to number of nodes. Optional values are 1 for single node and 3 for three nodes replica set.
shards Sequence[GetInstancesInstanceShard]: Array composed of shards.
status str: Status of the instance.
storage int: Shard disk.
tags Mapping[str, Any]: A mapping of tags to assign to the resource.

availabilityZone String: Instance availability zone.
chargeType String: Billing method. Value options are PostPaid for Pay-As-You-Go and PrePaid for yearly or monthly subscription.
creationTime String: Creation time of the instance in RFC3339 format.
engine String: Database engine type. Supported option is MongoDB.
engineVersion String: Database engine version.
expirationTime String: Expiration time in RFC3339 format. Pay-As-You-Go instances are never expire.
id String: The ID of the MongoDB instance.
instanceClass String: Sizing of the instance to be queried.
instanceType String: Type of the instance to be queried. If it is set to sharding, the sharded cluster instances are listed. If it is set to replicate, replica set instances are listed. Default value replicate.
lockMode String: Lock status of the instance.
mongos List<Property Map>: Array composed of Mongos.
name String: The name of the MongoDB instance.
networkType String: Classic network or VPC.
regionId String: Region ID the instance belongs to.
replication String: Replication factor corresponds to number of nodes. Optional values are 1 for single node and 3 for three nodes replica set.
shards List<Property Map>: Array composed of shards.
status String: Status of the instance.
storage Number: Shard disk.
tags Map<Any>: A mapping of tags to assign to the resource.

GetInstancesInstanceMongo

Class string: Shard instance specification.
Description string: Shard instance description.
NodeId string: Shard instance ID.

Class string: Shard instance specification.
Description string: Shard instance description.
NodeId string: Shard instance ID.

class_ String: Shard instance specification.
description String: Shard instance description.
nodeId String: Shard instance ID.

class string: Shard instance specification.
description string: Shard instance description.
nodeId string: Shard instance ID.

class_ str: Shard instance specification.
description str: Shard instance description.
node_id str: Shard instance ID.

class String: Shard instance specification.
description String: Shard instance description.
nodeId String: Shard instance ID.

GetInstancesInstanceShard

Class string: Shard instance specification.
Description string: Shard instance description.
NodeId string: Shard instance ID.
Storage int: Shard disk.

Class string: Shard instance specification.
Description string: Shard instance description.
NodeId string: Shard instance ID.
Storage int: Shard disk.

class_ String: Shard instance specification.
description String: Shard instance description.
nodeId String: Shard instance ID.
storage Integer: Shard disk.

class string: Shard instance specification.
description string: Shard instance description.
nodeId string: Shard instance ID.
storage number: Shard disk.

class_ str: Shard instance specification.
description str: Shard instance description.
node_id str: Shard instance ID.
storage int: Shard disk.

class String: Shard instance specification.
description String: Shard instance description.
nodeId String: Shard instance ID.
storage Number: Shard disk.

Package Details

Repository: https://github.com/pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.