1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. mongodb
  5. ShardingInstance
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi

alicloud.mongodb.ShardingInstance

Explore with Pulumi AI

Provides a MongoDB Sharding Instance resource supports replica set instances only. the MongoDB provides stable, reliable, and automatic scalable database services. It offers a full range of database solutions, such as disaster recovery, backup, recovery, monitoring, and alarms. You can see detail product introduction here

NOTE: Available since v1.40.0.

NOTE: The following regions don’t support create Classic network MongoDB Sharding Instance. [cn-zhangjiakou,cn-huhehaote,ap-southeast-3,ap-southeast-5,me-east-1,ap-northeast-1,eu-west-1]

NOTE: Create MongoDB Sharding instance or change instance type and storage would cost 10~20 minutes. Please make full preparation.

Example Usage

Create a Mongodb Sharding instance

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.mongodb.getZones({});
const index = _default.then(_default => _default.zones).length.then(length => length - 1);
const zoneId = _default.then(_default => _default.zones[index].id);
const defaultNetwork = new alicloud.vpc.Network("default", {
    vpcName: name,
    cidrBlock: "172.17.3.0/24",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    vswitchName: name,
    cidrBlock: "172.17.3.0/24",
    vpcId: defaultNetwork.id,
    zoneId: zoneId,
});
const defaultShardingInstance = new alicloud.mongodb.ShardingInstance("default", {
    engineVersion: "4.2",
    vswitchId: defaultSwitch.id,
    zoneId: zoneId,
    name: name,
    mongoLists: [
        {
            nodeClass: "dds.mongos.mid",
        },
        {
            nodeClass: "dds.mongos.mid",
        },
    ],
    shardLists: [
        {
            nodeClass: "dds.shard.mid",
            nodeStorage: 10,
        },
        {
            nodeClass: "dds.shard.standard",
            nodeStorage: 20,
            readonlyReplicas: 1,
        },
    ],
});
Copy
import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
default = alicloud.mongodb.get_zones()
index = len(default.zones) - 1
zone_id = default.zones[index].id
default_network = alicloud.vpc.Network("default",
    vpc_name=name,
    cidr_block="172.17.3.0/24")
default_switch = alicloud.vpc.Switch("default",
    vswitch_name=name,
    cidr_block="172.17.3.0/24",
    vpc_id=default_network.id,
    zone_id=zone_id)
default_sharding_instance = alicloud.mongodb.ShardingInstance("default",
    engine_version="4.2",
    vswitch_id=default_switch.id,
    zone_id=zone_id,
    name=name,
    mongo_lists=[
        {
            "node_class": "dds.mongos.mid",
        },
        {
            "node_class": "dds.mongos.mid",
        },
    ],
    shard_lists=[
        {
            "node_class": "dds.shard.mid",
            "node_storage": 10,
        },
        {
            "node_class": "dds.shard.standard",
            "node_storage": 20,
            "readonly_replicas": 1,
        },
    ])
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/mongodb"
	"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 := mongodb.GetZones(ctx, &mongodb.GetZonesArgs{}, nil)
		if err != nil {
			return err
		}
		index := pulumi.Float64(len(_default.Zones)) - 1
		zoneId := _default.Zones[index].Id
		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String(name),
			CidrBlock: pulumi.String("172.17.3.0/24"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VswitchName: pulumi.String(name),
			CidrBlock:   pulumi.String("172.17.3.0/24"),
			VpcId:       defaultNetwork.ID(),
			ZoneId:      pulumi.String(zoneId),
		})
		if err != nil {
			return err
		}
		_, err = mongodb.NewShardingInstance(ctx, "default", &mongodb.ShardingInstanceArgs{
			EngineVersion: pulumi.String("4.2"),
			VswitchId:     defaultSwitch.ID(),
			ZoneId:        pulumi.String(zoneId),
			Name:          pulumi.String(name),
			MongoLists: mongodb.ShardingInstanceMongoListArray{
				&mongodb.ShardingInstanceMongoListArgs{
					NodeClass: pulumi.String("dds.mongos.mid"),
				},
				&mongodb.ShardingInstanceMongoListArgs{
					NodeClass: pulumi.String("dds.mongos.mid"),
				},
			},
			ShardLists: mongodb.ShardingInstanceShardListArray{
				&mongodb.ShardingInstanceShardListArgs{
					NodeClass:   pulumi.String("dds.shard.mid"),
					NodeStorage: pulumi.Int(10),
				},
				&mongodb.ShardingInstanceShardListArgs{
					NodeClass:        pulumi.String("dds.shard.standard"),
					NodeStorage:      pulumi.Int(20),
					ReadonlyReplicas: pulumi.Int(1),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var @default = AliCloud.MongoDB.GetZones.Invoke();

    var index = @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Zones)).Length.Apply(length => length - 1);

    var zoneId = @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Zones)[index].Id);

    var defaultNetwork = new AliCloud.Vpc.Network("default", new()
    {
        VpcName = name,
        CidrBlock = "172.17.3.0/24",
    });

    var defaultSwitch = new AliCloud.Vpc.Switch("default", new()
    {
        VswitchName = name,
        CidrBlock = "172.17.3.0/24",
        VpcId = defaultNetwork.Id,
        ZoneId = zoneId,
    });

    var defaultShardingInstance = new AliCloud.MongoDB.ShardingInstance("default", new()
    {
        EngineVersion = "4.2",
        VswitchId = defaultSwitch.Id,
        ZoneId = zoneId,
        Name = name,
        MongoLists = new[]
        {
            new AliCloud.MongoDB.Inputs.ShardingInstanceMongoListArgs
            {
                NodeClass = "dds.mongos.mid",
            },
            new AliCloud.MongoDB.Inputs.ShardingInstanceMongoListArgs
            {
                NodeClass = "dds.mongos.mid",
            },
        },
        ShardLists = new[]
        {
            new AliCloud.MongoDB.Inputs.ShardingInstanceShardListArgs
            {
                NodeClass = "dds.shard.mid",
                NodeStorage = 10,
            },
            new AliCloud.MongoDB.Inputs.ShardingInstanceShardListArgs
            {
                NodeClass = "dds.shard.standard",
                NodeStorage = 20,
                ReadonlyReplicas = 1,
            },
        },
    });

});
Copy
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.mongodb.inputs.GetZonesArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.mongodb.ShardingInstance;
import com.pulumi.alicloud.mongodb.ShardingInstanceArgs;
import com.pulumi.alicloud.mongodb.inputs.ShardingInstanceMongoListArgs;
import com.pulumi.alicloud.mongodb.inputs.ShardingInstanceShardListArgs;
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 = MongodbFunctions.getZones();

        final var index = default_.zones().length() - 1;

        final var zoneId = default_.zones()[index].id();

        var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
            .vpcName(name)
            .cidrBlock("172.17.3.0/24")
            .build());

        var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
            .vswitchName(name)
            .cidrBlock("172.17.3.0/24")
            .vpcId(defaultNetwork.id())
            .zoneId(zoneId)
            .build());

        var defaultShardingInstance = new ShardingInstance("defaultShardingInstance", ShardingInstanceArgs.builder()
            .engineVersion("4.2")
            .vswitchId(defaultSwitch.id())
            .zoneId(zoneId)
            .name(name)
            .mongoLists(            
                ShardingInstanceMongoListArgs.builder()
                    .nodeClass("dds.mongos.mid")
                    .build(),
                ShardingInstanceMongoListArgs.builder()
                    .nodeClass("dds.mongos.mid")
                    .build())
            .shardLists(            
                ShardingInstanceShardListArgs.builder()
                    .nodeClass("dds.shard.mid")
                    .nodeStorage("10")
                    .build(),
                ShardingInstanceShardListArgs.builder()
                    .nodeClass("dds.shard.standard")
                    .nodeStorage("20")
                    .readonlyReplicas("1")
                    .build())
            .build());

    }
}
Copy
Coming soon!

Module Support

You can use to the existing mongodb-sharding module to create a MongoDB Sharding Instance resource one-click.

Create ShardingInstance Resource

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

Constructor syntax

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

@overload
def ShardingInstance(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     engine_version: Optional[str] = None,
                     shard_lists: Optional[Sequence[ShardingInstanceShardListArgs]] = None,
                     mongo_lists: Optional[Sequence[ShardingInstanceMongoListArgs]] = None,
                     period: Optional[int] = None,
                     provisioned_iops: Optional[int] = None,
                     config_server_lists: Optional[Sequence[ShardingInstanceConfigServerListArgs]] = None,
                     backup_retention_policy_on_cluster_deletion: Optional[int] = None,
                     instance_charge_type: Optional[str] = None,
                     kms_encrypted_password: Optional[str] = None,
                     kms_encryption_context: Optional[Mapping[str, str]] = None,
                     backup_periods: Optional[Sequence[str]] = None,
                     name: Optional[str] = None,
                     network_type: Optional[str] = None,
                     order_type: Optional[str] = None,
                     account_password: Optional[str] = None,
                     protocol_type: Optional[str] = None,
                     backup_time: Optional[str] = None,
                     resource_group_id: Optional[str] = None,
                     security_group_id: Optional[str] = None,
                     security_ip_lists: Optional[Sequence[str]] = None,
                     auto_renew: Optional[bool] = None,
                     storage_engine: Optional[str] = None,
                     storage_type: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     tde_status: Optional[str] = None,
                     vpc_id: Optional[str] = None,
                     vswitch_id: Optional[str] = None,
                     zone_id: Optional[str] = None)
func NewShardingInstance(ctx *Context, name string, args ShardingInstanceArgs, opts ...ResourceOption) (*ShardingInstance, error)
public ShardingInstance(string name, ShardingInstanceArgs args, CustomResourceOptions? opts = null)
public ShardingInstance(String name, ShardingInstanceArgs args)
public ShardingInstance(String name, ShardingInstanceArgs args, CustomResourceOptions options)
type: alicloud:mongodb:ShardingInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ShardingInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ShardingInstanceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ShardingInstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ShardingInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ShardingInstanceArgs
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 shardingInstanceResource = new AliCloud.MongoDB.ShardingInstance("shardingInstanceResource", new()
{
    EngineVersion = "string",
    ShardLists = new[]
    {
        new AliCloud.MongoDB.Inputs.ShardingInstanceShardListArgs
        {
            NodeClass = "string",
            NodeStorage = 0,
            NodeId = "string",
            ReadonlyReplicas = 0,
        },
    },
    MongoLists = new[]
    {
        new AliCloud.MongoDB.Inputs.ShardingInstanceMongoListArgs
        {
            NodeClass = "string",
            ConnectString = "string",
            NodeId = "string",
            Port = 0,
        },
    },
    Period = 0,
    ProvisionedIops = 0,
    ConfigServerLists = new[]
    {
        new AliCloud.MongoDB.Inputs.ShardingInstanceConfigServerListArgs
        {
            ConnectString = "string",
            MaxConnections = 0,
            MaxIops = 0,
            NodeClass = "string",
            NodeDescription = "string",
            NodeId = "string",
            NodeStorage = 0,
            Port = 0,
        },
    },
    BackupRetentionPolicyOnClusterDeletion = 0,
    InstanceChargeType = "string",
    KmsEncryptedPassword = "string",
    KmsEncryptionContext = 
    {
        { "string", "string" },
    },
    BackupPeriods = new[]
    {
        "string",
    },
    Name = "string",
    NetworkType = "string",
    OrderType = "string",
    AccountPassword = "string",
    ProtocolType = "string",
    BackupTime = "string",
    ResourceGroupId = "string",
    SecurityGroupId = "string",
    SecurityIpLists = new[]
    {
        "string",
    },
    AutoRenew = false,
    StorageEngine = "string",
    StorageType = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TdeStatus = "string",
    VpcId = "string",
    VswitchId = "string",
    ZoneId = "string",
});
Copy
example, err := mongodb.NewShardingInstance(ctx, "shardingInstanceResource", &mongodb.ShardingInstanceArgs{
	EngineVersion: pulumi.String("string"),
	ShardLists: mongodb.ShardingInstanceShardListArray{
		&mongodb.ShardingInstanceShardListArgs{
			NodeClass:        pulumi.String("string"),
			NodeStorage:      pulumi.Int(0),
			NodeId:           pulumi.String("string"),
			ReadonlyReplicas: pulumi.Int(0),
		},
	},
	MongoLists: mongodb.ShardingInstanceMongoListArray{
		&mongodb.ShardingInstanceMongoListArgs{
			NodeClass:     pulumi.String("string"),
			ConnectString: pulumi.String("string"),
			NodeId:        pulumi.String("string"),
			Port:          pulumi.Int(0),
		},
	},
	Period:          pulumi.Int(0),
	ProvisionedIops: pulumi.Int(0),
	ConfigServerLists: mongodb.ShardingInstanceConfigServerListArray{
		&mongodb.ShardingInstanceConfigServerListArgs{
			ConnectString:   pulumi.String("string"),
			MaxConnections:  pulumi.Int(0),
			MaxIops:         pulumi.Int(0),
			NodeClass:       pulumi.String("string"),
			NodeDescription: pulumi.String("string"),
			NodeId:          pulumi.String("string"),
			NodeStorage:     pulumi.Int(0),
			Port:            pulumi.Int(0),
		},
	},
	BackupRetentionPolicyOnClusterDeletion: pulumi.Int(0),
	InstanceChargeType:                     pulumi.String("string"),
	KmsEncryptedPassword:                   pulumi.String("string"),
	KmsEncryptionContext: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	BackupPeriods: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:            pulumi.String("string"),
	NetworkType:     pulumi.String("string"),
	OrderType:       pulumi.String("string"),
	AccountPassword: pulumi.String("string"),
	ProtocolType:    pulumi.String("string"),
	BackupTime:      pulumi.String("string"),
	ResourceGroupId: pulumi.String("string"),
	SecurityGroupId: pulumi.String("string"),
	SecurityIpLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	AutoRenew:     pulumi.Bool(false),
	StorageEngine: pulumi.String("string"),
	StorageType:   pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TdeStatus: pulumi.String("string"),
	VpcId:     pulumi.String("string"),
	VswitchId: pulumi.String("string"),
	ZoneId:    pulumi.String("string"),
})
Copy
var shardingInstanceResource = new ShardingInstance("shardingInstanceResource", ShardingInstanceArgs.builder()
    .engineVersion("string")
    .shardLists(ShardingInstanceShardListArgs.builder()
        .nodeClass("string")
        .nodeStorage(0)
        .nodeId("string")
        .readonlyReplicas(0)
        .build())
    .mongoLists(ShardingInstanceMongoListArgs.builder()
        .nodeClass("string")
        .connectString("string")
        .nodeId("string")
        .port(0)
        .build())
    .period(0)
    .provisionedIops(0)
    .configServerLists(ShardingInstanceConfigServerListArgs.builder()
        .connectString("string")
        .maxConnections(0)
        .maxIops(0)
        .nodeClass("string")
        .nodeDescription("string")
        .nodeId("string")
        .nodeStorage(0)
        .port(0)
        .build())
    .backupRetentionPolicyOnClusterDeletion(0)
    .instanceChargeType("string")
    .kmsEncryptedPassword("string")
    .kmsEncryptionContext(Map.of("string", "string"))
    .backupPeriods("string")
    .name("string")
    .networkType("string")
    .orderType("string")
    .accountPassword("string")
    .protocolType("string")
    .backupTime("string")
    .resourceGroupId("string")
    .securityGroupId("string")
    .securityIpLists("string")
    .autoRenew(false)
    .storageEngine("string")
    .storageType("string")
    .tags(Map.of("string", "string"))
    .tdeStatus("string")
    .vpcId("string")
    .vswitchId("string")
    .zoneId("string")
    .build());
Copy
sharding_instance_resource = alicloud.mongodb.ShardingInstance("shardingInstanceResource",
    engine_version="string",
    shard_lists=[{
        "node_class": "string",
        "node_storage": 0,
        "node_id": "string",
        "readonly_replicas": 0,
    }],
    mongo_lists=[{
        "node_class": "string",
        "connect_string": "string",
        "node_id": "string",
        "port": 0,
    }],
    period=0,
    provisioned_iops=0,
    config_server_lists=[{
        "connect_string": "string",
        "max_connections": 0,
        "max_iops": 0,
        "node_class": "string",
        "node_description": "string",
        "node_id": "string",
        "node_storage": 0,
        "port": 0,
    }],
    backup_retention_policy_on_cluster_deletion=0,
    instance_charge_type="string",
    kms_encrypted_password="string",
    kms_encryption_context={
        "string": "string",
    },
    backup_periods=["string"],
    name="string",
    network_type="string",
    order_type="string",
    account_password="string",
    protocol_type="string",
    backup_time="string",
    resource_group_id="string",
    security_group_id="string",
    security_ip_lists=["string"],
    auto_renew=False,
    storage_engine="string",
    storage_type="string",
    tags={
        "string": "string",
    },
    tde_status="string",
    vpc_id="string",
    vswitch_id="string",
    zone_id="string")
Copy
const shardingInstanceResource = new alicloud.mongodb.ShardingInstance("shardingInstanceResource", {
    engineVersion: "string",
    shardLists: [{
        nodeClass: "string",
        nodeStorage: 0,
        nodeId: "string",
        readonlyReplicas: 0,
    }],
    mongoLists: [{
        nodeClass: "string",
        connectString: "string",
        nodeId: "string",
        port: 0,
    }],
    period: 0,
    provisionedIops: 0,
    configServerLists: [{
        connectString: "string",
        maxConnections: 0,
        maxIops: 0,
        nodeClass: "string",
        nodeDescription: "string",
        nodeId: "string",
        nodeStorage: 0,
        port: 0,
    }],
    backupRetentionPolicyOnClusterDeletion: 0,
    instanceChargeType: "string",
    kmsEncryptedPassword: "string",
    kmsEncryptionContext: {
        string: "string",
    },
    backupPeriods: ["string"],
    name: "string",
    networkType: "string",
    orderType: "string",
    accountPassword: "string",
    protocolType: "string",
    backupTime: "string",
    resourceGroupId: "string",
    securityGroupId: "string",
    securityIpLists: ["string"],
    autoRenew: false,
    storageEngine: "string",
    storageType: "string",
    tags: {
        string: "string",
    },
    tdeStatus: "string",
    vpcId: "string",
    vswitchId: "string",
    zoneId: "string",
});
Copy
type: alicloud:mongodb:ShardingInstance
properties:
    accountPassword: string
    autoRenew: false
    backupPeriods:
        - string
    backupRetentionPolicyOnClusterDeletion: 0
    backupTime: string
    configServerLists:
        - connectString: string
          maxConnections: 0
          maxIops: 0
          nodeClass: string
          nodeDescription: string
          nodeId: string
          nodeStorage: 0
          port: 0
    engineVersion: string
    instanceChargeType: string
    kmsEncryptedPassword: string
    kmsEncryptionContext:
        string: string
    mongoLists:
        - connectString: string
          nodeClass: string
          nodeId: string
          port: 0
    name: string
    networkType: string
    orderType: string
    period: 0
    protocolType: string
    provisionedIops: 0
    resourceGroupId: string
    securityGroupId: string
    securityIpLists:
        - string
    shardLists:
        - nodeClass: string
          nodeId: string
          nodeStorage: 0
          readonlyReplicas: 0
    storageEngine: string
    storageType: string
    tags:
        string: string
    tdeStatus: string
    vpcId: string
    vswitchId: string
    zoneId: string
Copy

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

EngineVersion This property is required. string
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.1, engine_version can be modified.
MongoLists This property is required. List<Pulumi.AliCloud.MongoDB.Inputs.ShardingInstanceMongoList>
The Mongo nodes of the instance. The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.
ShardLists This property is required. List<Pulumi.AliCloud.MongoDB.Inputs.ShardingInstanceShardList>
The Shard nodes of the instance. The shard-node count can be purchased is in range of [2, 32]. See shard_list below.
AccountPassword string
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
AutoRenew bool
Auto renew for prepaid. Default value: false. Valid values: true, false.
BackupPeriods List<string>
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
BackupRetentionPolicyOnClusterDeletion int
The backup retention policy configured for the instance. Valid values:
BackupTime string
Sharding Instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
ConfigServerLists Changes to this property will trigger replacement. List<Pulumi.AliCloud.MongoDB.Inputs.ShardingInstanceConfigServerList>
The ConfigServer nodes of the instance. See config_server_list below.
InstanceChargeType string
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version v1.141.0.
KmsEncryptedPassword string
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
KmsEncryptionContext Dictionary<string, string>
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
Name string
The name of DB instance. It must be 2 to 256 characters in length.
NetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values:Classic or VPC.
OrderType string
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
Period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
ProtocolType Changes to this property will trigger replacement. string
The type of the access protocol. Valid values: mongodb or dynamodb.
ProvisionedIops int
The provisioned IOPS. Valid values: 0 to 50000.
ResourceGroupId string
The ID of the Resource Group.
SecurityGroupId string
The Security Group ID of ECS.
SecurityIpLists List<string>
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
StorageEngine Changes to this property will trigger replacement. string
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
StorageType string
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
TdeStatus string
The TDE(Transparent Data Encryption) status. It can be updated from version 1.160.0.
VpcId Changes to this property will trigger replacement. string
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
VswitchId Changes to this property will trigger replacement. string
The virtual switch ID to launch DB instances in one VPC.
ZoneId Changes to this property will trigger replacement. string
The Zone to launch the DB instance. MongoDB Sharding Instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.
EngineVersion This property is required. string
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.1, engine_version can be modified.
MongoLists This property is required. []ShardingInstanceMongoListArgs
The Mongo nodes of the instance. The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.
ShardLists This property is required. []ShardingInstanceShardListArgs
The Shard nodes of the instance. The shard-node count can be purchased is in range of [2, 32]. See shard_list below.
AccountPassword string
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
AutoRenew bool
Auto renew for prepaid. Default value: false. Valid values: true, false.
BackupPeriods []string
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
BackupRetentionPolicyOnClusterDeletion int
The backup retention policy configured for the instance. Valid values:
BackupTime string
Sharding Instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
ConfigServerLists Changes to this property will trigger replacement. []ShardingInstanceConfigServerListArgs
The ConfigServer nodes of the instance. See config_server_list below.
InstanceChargeType string
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version v1.141.0.
KmsEncryptedPassword string
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
KmsEncryptionContext map[string]string
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
Name string
The name of DB instance. It must be 2 to 256 characters in length.
NetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values:Classic or VPC.
OrderType string
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
Period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
ProtocolType Changes to this property will trigger replacement. string
The type of the access protocol. Valid values: mongodb or dynamodb.
ProvisionedIops int
The provisioned IOPS. Valid values: 0 to 50000.
ResourceGroupId string
The ID of the Resource Group.
SecurityGroupId string
The Security Group ID of ECS.
SecurityIpLists []string
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
StorageEngine Changes to this property will trigger replacement. string
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
StorageType string
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
Tags map[string]string
A mapping of tags to assign to the resource.
TdeStatus string
The TDE(Transparent Data Encryption) status. It can be updated from version 1.160.0.
VpcId Changes to this property will trigger replacement. string
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
VswitchId Changes to this property will trigger replacement. string
The virtual switch ID to launch DB instances in one VPC.
ZoneId Changes to this property will trigger replacement. string
The Zone to launch the DB instance. MongoDB Sharding Instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.
engineVersion This property is required. String
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.1, engine_version can be modified.
mongoLists This property is required. List<ShardingInstanceMongoList>
The Mongo nodes of the instance. The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.
shardLists This property is required. List<ShardingInstanceShardList>
The Shard nodes of the instance. The shard-node count can be purchased is in range of [2, 32]. See shard_list below.
accountPassword String
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
autoRenew Boolean
Auto renew for prepaid. Default value: false. Valid values: true, false.
backupPeriods List<String>
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
backupRetentionPolicyOnClusterDeletion Integer
The backup retention policy configured for the instance. Valid values:
backupTime String
Sharding Instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
configServerLists Changes to this property will trigger replacement. List<ShardingInstanceConfigServerList>
The ConfigServer nodes of the instance. See config_server_list below.
instanceChargeType String
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version v1.141.0.
kmsEncryptedPassword String
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kmsEncryptionContext Map<String,String>
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
name String
The name of DB instance. It must be 2 to 256 characters in length.
networkType Changes to this property will trigger replacement. String
The network type of the instance. Valid values:Classic or VPC.
orderType String
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
period Integer
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
protocolType Changes to this property will trigger replacement. String
The type of the access protocol. Valid values: mongodb or dynamodb.
provisionedIops Integer
The provisioned IOPS. Valid values: 0 to 50000.
resourceGroupId String
The ID of the Resource Group.
securityGroupId String
The Security Group ID of ECS.
securityIpLists List<String>
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
storageEngine Changes to this property will trigger replacement. String
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
storageType String
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
tags Map<String,String>
A mapping of tags to assign to the resource.
tdeStatus String
The TDE(Transparent Data Encryption) status. It can be updated from version 1.160.0.
vpcId Changes to this property will trigger replacement. String
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId Changes to this property will trigger replacement. String
The virtual switch ID to launch DB instances in one VPC.
zoneId Changes to this property will trigger replacement. String
The Zone to launch the DB instance. MongoDB Sharding Instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.
engineVersion This property is required. string
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.1, engine_version can be modified.
mongoLists This property is required. ShardingInstanceMongoList[]
The Mongo nodes of the instance. The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.
shardLists This property is required. ShardingInstanceShardList[]
The Shard nodes of the instance. The shard-node count can be purchased is in range of [2, 32]. See shard_list below.
accountPassword string
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
autoRenew boolean
Auto renew for prepaid. Default value: false. Valid values: true, false.
backupPeriods string[]
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
backupRetentionPolicyOnClusterDeletion number
The backup retention policy configured for the instance. Valid values:
backupTime string
Sharding Instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
configServerLists Changes to this property will trigger replacement. ShardingInstanceConfigServerList[]
The ConfigServer nodes of the instance. See config_server_list below.
instanceChargeType string
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version v1.141.0.
kmsEncryptedPassword string
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kmsEncryptionContext {[key: string]: string}
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
name string
The name of DB instance. It must be 2 to 256 characters in length.
networkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values:Classic or VPC.
orderType string
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
period number
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
protocolType Changes to this property will trigger replacement. string
The type of the access protocol. Valid values: mongodb or dynamodb.
provisionedIops number
The provisioned IOPS. Valid values: 0 to 50000.
resourceGroupId string
The ID of the Resource Group.
securityGroupId string
The Security Group ID of ECS.
securityIpLists string[]
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
storageEngine Changes to this property will trigger replacement. string
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
storageType string
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
tdeStatus string
The TDE(Transparent Data Encryption) status. It can be updated from version 1.160.0.
vpcId Changes to this property will trigger replacement. string
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId Changes to this property will trigger replacement. string
The virtual switch ID to launch DB instances in one VPC.
zoneId Changes to this property will trigger replacement. string
The Zone to launch the DB instance. MongoDB Sharding Instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.
engine_version This property is required. str
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.1, engine_version can be modified.
mongo_lists This property is required. Sequence[ShardingInstanceMongoListArgs]
The Mongo nodes of the instance. The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.
shard_lists This property is required. Sequence[ShardingInstanceShardListArgs]
The Shard nodes of the instance. The shard-node count can be purchased is in range of [2, 32]. See shard_list below.
account_password str
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
auto_renew bool
Auto renew for prepaid. Default value: false. Valid values: true, false.
backup_periods Sequence[str]
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
backup_retention_policy_on_cluster_deletion int
The backup retention policy configured for the instance. Valid values:
backup_time str
Sharding Instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
config_server_lists Changes to this property will trigger replacement. Sequence[ShardingInstanceConfigServerListArgs]
The ConfigServer nodes of the instance. See config_server_list below.
instance_charge_type str
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version v1.141.0.
kms_encrypted_password str
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kms_encryption_context Mapping[str, str]
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
name str
The name of DB instance. It must be 2 to 256 characters in length.
network_type Changes to this property will trigger replacement. str
The network type of the instance. Valid values:Classic or VPC.
order_type str
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
protocol_type Changes to this property will trigger replacement. str
The type of the access protocol. Valid values: mongodb or dynamodb.
provisioned_iops int
The provisioned IOPS. Valid values: 0 to 50000.
resource_group_id str
The ID of the Resource Group.
security_group_id str
The Security Group ID of ECS.
security_ip_lists Sequence[str]
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
storage_engine Changes to this property will trigger replacement. str
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
storage_type str
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
tde_status str
The TDE(Transparent Data Encryption) status. It can be updated from version 1.160.0.
vpc_id Changes to this property will trigger replacement. str
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitch_id Changes to this property will trigger replacement. str
The virtual switch ID to launch DB instances in one VPC.
zone_id Changes to this property will trigger replacement. str
The Zone to launch the DB instance. MongoDB Sharding Instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.
engineVersion This property is required. String
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.1, engine_version can be modified.
mongoLists This property is required. List<Property Map>
The Mongo nodes of the instance. The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.
shardLists This property is required. List<Property Map>
The Shard nodes of the instance. The shard-node count can be purchased is in range of [2, 32]. See shard_list below.
accountPassword String
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
autoRenew Boolean
Auto renew for prepaid. Default value: false. Valid values: true, false.
backupPeriods List<String>
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
backupRetentionPolicyOnClusterDeletion Number
The backup retention policy configured for the instance. Valid values:
backupTime String
Sharding Instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
configServerLists Changes to this property will trigger replacement. List<Property Map>
The ConfigServer nodes of the instance. See config_server_list below.
instanceChargeType String
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version v1.141.0.
kmsEncryptedPassword String
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kmsEncryptionContext Map<String>
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
name String
The name of DB instance. It must be 2 to 256 characters in length.
networkType Changes to this property will trigger replacement. String
The network type of the instance. Valid values:Classic or VPC.
orderType String
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
period Number
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
protocolType Changes to this property will trigger replacement. String
The type of the access protocol. Valid values: mongodb or dynamodb.
provisionedIops Number
The provisioned IOPS. Valid values: 0 to 50000.
resourceGroupId String
The ID of the Resource Group.
securityGroupId String
The Security Group ID of ECS.
securityIpLists List<String>
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
storageEngine Changes to this property will trigger replacement. String
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
storageType String
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
tags Map<String>
A mapping of tags to assign to the resource.
tdeStatus String
The TDE(Transparent Data Encryption) status. It can be updated from version 1.160.0.
vpcId Changes to this property will trigger replacement. String
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId Changes to this property will trigger replacement. String
The virtual switch ID to launch DB instances in one VPC.
zoneId Changes to this property will trigger replacement. String
The Zone to launch the DB instance. MongoDB Sharding Instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
RetentionPeriod int
(Available since v1.42.0) Instance data backup retention days.
Id string
The provider-assigned unique ID for this managed resource.
RetentionPeriod int
(Available since v1.42.0) Instance data backup retention days.
id String
The provider-assigned unique ID for this managed resource.
retentionPeriod Integer
(Available since v1.42.0) Instance data backup retention days.
id string
The provider-assigned unique ID for this managed resource.
retentionPeriod number
(Available since v1.42.0) Instance data backup retention days.
id str
The provider-assigned unique ID for this managed resource.
retention_period int
(Available since v1.42.0) Instance data backup retention days.
id String
The provider-assigned unique ID for this managed resource.
retentionPeriod Number
(Available since v1.42.0) Instance data backup retention days.

Look up Existing ShardingInstance Resource

Get an existing ShardingInstance 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?: ShardingInstanceState, opts?: CustomResourceOptions): ShardingInstance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_password: Optional[str] = None,
        auto_renew: Optional[bool] = None,
        backup_periods: Optional[Sequence[str]] = None,
        backup_retention_policy_on_cluster_deletion: Optional[int] = None,
        backup_time: Optional[str] = None,
        config_server_lists: Optional[Sequence[ShardingInstanceConfigServerListArgs]] = None,
        engine_version: Optional[str] = None,
        instance_charge_type: Optional[str] = None,
        kms_encrypted_password: Optional[str] = None,
        kms_encryption_context: Optional[Mapping[str, str]] = None,
        mongo_lists: Optional[Sequence[ShardingInstanceMongoListArgs]] = None,
        name: Optional[str] = None,
        network_type: Optional[str] = None,
        order_type: Optional[str] = None,
        period: Optional[int] = None,
        protocol_type: Optional[str] = None,
        provisioned_iops: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        retention_period: Optional[int] = None,
        security_group_id: Optional[str] = None,
        security_ip_lists: Optional[Sequence[str]] = None,
        shard_lists: Optional[Sequence[ShardingInstanceShardListArgs]] = None,
        storage_engine: Optional[str] = None,
        storage_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tde_status: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        zone_id: Optional[str] = None) -> ShardingInstance
func GetShardingInstance(ctx *Context, name string, id IDInput, state *ShardingInstanceState, opts ...ResourceOption) (*ShardingInstance, error)
public static ShardingInstance Get(string name, Input<string> id, ShardingInstanceState? state, CustomResourceOptions? opts = null)
public static ShardingInstance get(String name, Output<String> id, ShardingInstanceState state, CustomResourceOptions options)
resources:  _:    type: alicloud:mongodb:ShardingInstance    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AccountPassword string
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
AutoRenew bool
Auto renew for prepaid. Default value: false. Valid values: true, false.
BackupPeriods List<string>
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
BackupRetentionPolicyOnClusterDeletion int
The backup retention policy configured for the instance. Valid values:
BackupTime string
Sharding Instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
ConfigServerLists Changes to this property will trigger replacement. List<Pulumi.AliCloud.MongoDB.Inputs.ShardingInstanceConfigServerList>
The ConfigServer nodes of the instance. See config_server_list below.
EngineVersion string
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.1, engine_version can be modified.
InstanceChargeType string
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version v1.141.0.
KmsEncryptedPassword string
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
KmsEncryptionContext Dictionary<string, string>
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
MongoLists List<Pulumi.AliCloud.MongoDB.Inputs.ShardingInstanceMongoList>
The Mongo nodes of the instance. The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.
Name string
The name of DB instance. It must be 2 to 256 characters in length.
NetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values:Classic or VPC.
OrderType string
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
Period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
ProtocolType Changes to this property will trigger replacement. string
The type of the access protocol. Valid values: mongodb or dynamodb.
ProvisionedIops int
The provisioned IOPS. Valid values: 0 to 50000.
ResourceGroupId string
The ID of the Resource Group.
RetentionPeriod int
(Available since v1.42.0) Instance data backup retention days.
SecurityGroupId string
The Security Group ID of ECS.
SecurityIpLists List<string>
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
ShardLists List<Pulumi.AliCloud.MongoDB.Inputs.ShardingInstanceShardList>
The Shard nodes of the instance. The shard-node count can be purchased is in range of [2, 32]. See shard_list below.
StorageEngine Changes to this property will trigger replacement. string
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
StorageType string
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
TdeStatus string
The TDE(Transparent Data Encryption) status. It can be updated from version 1.160.0.
VpcId Changes to this property will trigger replacement. string
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
VswitchId Changes to this property will trigger replacement. string
The virtual switch ID to launch DB instances in one VPC.
ZoneId Changes to this property will trigger replacement. string
The Zone to launch the DB instance. MongoDB Sharding Instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.
AccountPassword string
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
AutoRenew bool
Auto renew for prepaid. Default value: false. Valid values: true, false.
BackupPeriods []string
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
BackupRetentionPolicyOnClusterDeletion int
The backup retention policy configured for the instance. Valid values:
BackupTime string
Sharding Instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
ConfigServerLists Changes to this property will trigger replacement. []ShardingInstanceConfigServerListArgs
The ConfigServer nodes of the instance. See config_server_list below.
EngineVersion string
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.1, engine_version can be modified.
InstanceChargeType string
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version v1.141.0.
KmsEncryptedPassword string
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
KmsEncryptionContext map[string]string
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
MongoLists []ShardingInstanceMongoListArgs
The Mongo nodes of the instance. The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.
Name string
The name of DB instance. It must be 2 to 256 characters in length.
NetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values:Classic or VPC.
OrderType string
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
Period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
ProtocolType Changes to this property will trigger replacement. string
The type of the access protocol. Valid values: mongodb or dynamodb.
ProvisionedIops int
The provisioned IOPS. Valid values: 0 to 50000.
ResourceGroupId string
The ID of the Resource Group.
RetentionPeriod int
(Available since v1.42.0) Instance data backup retention days.
SecurityGroupId string
The Security Group ID of ECS.
SecurityIpLists []string
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
ShardLists []ShardingInstanceShardListArgs
The Shard nodes of the instance. The shard-node count can be purchased is in range of [2, 32]. See shard_list below.
StorageEngine Changes to this property will trigger replacement. string
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
StorageType string
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
Tags map[string]string
A mapping of tags to assign to the resource.
TdeStatus string
The TDE(Transparent Data Encryption) status. It can be updated from version 1.160.0.
VpcId Changes to this property will trigger replacement. string
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
VswitchId Changes to this property will trigger replacement. string
The virtual switch ID to launch DB instances in one VPC.
ZoneId Changes to this property will trigger replacement. string
The Zone to launch the DB instance. MongoDB Sharding Instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.
accountPassword String
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
autoRenew Boolean
Auto renew for prepaid. Default value: false. Valid values: true, false.
backupPeriods List<String>
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
backupRetentionPolicyOnClusterDeletion Integer
The backup retention policy configured for the instance. Valid values:
backupTime String
Sharding Instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
configServerLists Changes to this property will trigger replacement. List<ShardingInstanceConfigServerList>
The ConfigServer nodes of the instance. See config_server_list below.
engineVersion String
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.1, engine_version can be modified.
instanceChargeType String
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version v1.141.0.
kmsEncryptedPassword String
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kmsEncryptionContext Map<String,String>
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
mongoLists List<ShardingInstanceMongoList>
The Mongo nodes of the instance. The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.
name String
The name of DB instance. It must be 2 to 256 characters in length.
networkType Changes to this property will trigger replacement. String
The network type of the instance. Valid values:Classic or VPC.
orderType String
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
period Integer
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
protocolType Changes to this property will trigger replacement. String
The type of the access protocol. Valid values: mongodb or dynamodb.
provisionedIops Integer
The provisioned IOPS. Valid values: 0 to 50000.
resourceGroupId String
The ID of the Resource Group.
retentionPeriod Integer
(Available since v1.42.0) Instance data backup retention days.
securityGroupId String
The Security Group ID of ECS.
securityIpLists List<String>
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
shardLists List<ShardingInstanceShardList>
The Shard nodes of the instance. The shard-node count can be purchased is in range of [2, 32]. See shard_list below.
storageEngine Changes to this property will trigger replacement. String
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
storageType String
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
tags Map<String,String>
A mapping of tags to assign to the resource.
tdeStatus String
The TDE(Transparent Data Encryption) status. It can be updated from version 1.160.0.
vpcId Changes to this property will trigger replacement. String
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId Changes to this property will trigger replacement. String
The virtual switch ID to launch DB instances in one VPC.
zoneId Changes to this property will trigger replacement. String
The Zone to launch the DB instance. MongoDB Sharding Instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.
accountPassword string
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
autoRenew boolean
Auto renew for prepaid. Default value: false. Valid values: true, false.
backupPeriods string[]
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
backupRetentionPolicyOnClusterDeletion number
The backup retention policy configured for the instance. Valid values:
backupTime string
Sharding Instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
configServerLists Changes to this property will trigger replacement. ShardingInstanceConfigServerList[]
The ConfigServer nodes of the instance. See config_server_list below.
engineVersion string
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.1, engine_version can be modified.
instanceChargeType string
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version v1.141.0.
kmsEncryptedPassword string
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kmsEncryptionContext {[key: string]: string}
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
mongoLists ShardingInstanceMongoList[]
The Mongo nodes of the instance. The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.
name string
The name of DB instance. It must be 2 to 256 characters in length.
networkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values:Classic or VPC.
orderType string
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
period number
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
protocolType Changes to this property will trigger replacement. string
The type of the access protocol. Valid values: mongodb or dynamodb.
provisionedIops number
The provisioned IOPS. Valid values: 0 to 50000.
resourceGroupId string
The ID of the Resource Group.
retentionPeriod number
(Available since v1.42.0) Instance data backup retention days.
securityGroupId string
The Security Group ID of ECS.
securityIpLists string[]
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
shardLists ShardingInstanceShardList[]
The Shard nodes of the instance. The shard-node count can be purchased is in range of [2, 32]. See shard_list below.
storageEngine Changes to this property will trigger replacement. string
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
storageType string
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
tdeStatus string
The TDE(Transparent Data Encryption) status. It can be updated from version 1.160.0.
vpcId Changes to this property will trigger replacement. string
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId Changes to this property will trigger replacement. string
The virtual switch ID to launch DB instances in one VPC.
zoneId Changes to this property will trigger replacement. string
The Zone to launch the DB instance. MongoDB Sharding Instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.
account_password str
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
auto_renew bool
Auto renew for prepaid. Default value: false. Valid values: true, false.
backup_periods Sequence[str]
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
backup_retention_policy_on_cluster_deletion int
The backup retention policy configured for the instance. Valid values:
backup_time str
Sharding Instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
config_server_lists Changes to this property will trigger replacement. Sequence[ShardingInstanceConfigServerListArgs]
The ConfigServer nodes of the instance. See config_server_list below.
engine_version str
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.1, engine_version can be modified.
instance_charge_type str
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version v1.141.0.
kms_encrypted_password str
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kms_encryption_context Mapping[str, str]
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
mongo_lists Sequence[ShardingInstanceMongoListArgs]
The Mongo nodes of the instance. The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.
name str
The name of DB instance. It must be 2 to 256 characters in length.
network_type Changes to this property will trigger replacement. str
The network type of the instance. Valid values:Classic or VPC.
order_type str
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
protocol_type Changes to this property will trigger replacement. str
The type of the access protocol. Valid values: mongodb or dynamodb.
provisioned_iops int
The provisioned IOPS. Valid values: 0 to 50000.
resource_group_id str
The ID of the Resource Group.
retention_period int
(Available since v1.42.0) Instance data backup retention days.
security_group_id str
The Security Group ID of ECS.
security_ip_lists Sequence[str]
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
shard_lists Sequence[ShardingInstanceShardListArgs]
The Shard nodes of the instance. The shard-node count can be purchased is in range of [2, 32]. See shard_list below.
storage_engine Changes to this property will trigger replacement. str
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
storage_type str
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
tde_status str
The TDE(Transparent Data Encryption) status. It can be updated from version 1.160.0.
vpc_id Changes to this property will trigger replacement. str
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitch_id Changes to this property will trigger replacement. str
The virtual switch ID to launch DB instances in one VPC.
zone_id Changes to this property will trigger replacement. str
The Zone to launch the DB instance. MongoDB Sharding Instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.
accountPassword String
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
autoRenew Boolean
Auto renew for prepaid. Default value: false. Valid values: true, false.
backupPeriods List<String>
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
backupRetentionPolicyOnClusterDeletion Number
The backup retention policy configured for the instance. Valid values:
backupTime String
Sharding Instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
configServerLists Changes to this property will trigger replacement. List<Property Map>
The ConfigServer nodes of the instance. See config_server_list below.
engineVersion String
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.1, engine_version can be modified.
instanceChargeType String
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version v1.141.0.
kmsEncryptedPassword String
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kmsEncryptionContext Map<String>
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
mongoLists List<Property Map>
The Mongo nodes of the instance. The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.
name String
The name of DB instance. It must be 2 to 256 characters in length.
networkType Changes to this property will trigger replacement. String
The network type of the instance. Valid values:Classic or VPC.
orderType String
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
period Number
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
protocolType Changes to this property will trigger replacement. String
The type of the access protocol. Valid values: mongodb or dynamodb.
provisionedIops Number
The provisioned IOPS. Valid values: 0 to 50000.
resourceGroupId String
The ID of the Resource Group.
retentionPeriod Number
(Available since v1.42.0) Instance data backup retention days.
securityGroupId String
The Security Group ID of ECS.
securityIpLists List<String>
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
shardLists List<Property Map>
The Shard nodes of the instance. The shard-node count can be purchased is in range of [2, 32]. See shard_list below.
storageEngine Changes to this property will trigger replacement. String
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
storageType String
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
tags Map<String>
A mapping of tags to assign to the resource.
tdeStatus String
The TDE(Transparent Data Encryption) status. It can be updated from version 1.160.0.
vpcId Changes to this property will trigger replacement. String
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId Changes to this property will trigger replacement. String
The virtual switch ID to launch DB instances in one VPC.
zoneId Changes to this property will trigger replacement. String
The Zone to launch the DB instance. MongoDB Sharding Instance does not support multiple-zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them.

Supporting Types

ShardingInstanceConfigServerList
, ShardingInstanceConfigServerListArgs

ConnectString string
The connection address of the Config Server node.
MaxConnections int
The max connections of the Config Server node.
MaxIops int
The maximum IOPS of the Config Server node.
NodeClass Changes to this property will trigger replacement. string
The instance type of the ConfigServer node. Valid values: mdb.shard.2x.xlarge.d, dds.cs.mid.
NodeDescription string
The description of the Config Server node.
NodeId string
The ID of the Config Server node.
NodeStorage Changes to this property will trigger replacement. int
The storage space of the ConfigServer node.
Port int
The connection port of the Config Server node.
ConnectString string
The connection address of the Config Server node.
MaxConnections int
The max connections of the Config Server node.
MaxIops int
The maximum IOPS of the Config Server node.
NodeClass Changes to this property will trigger replacement. string
The instance type of the ConfigServer node. Valid values: mdb.shard.2x.xlarge.d, dds.cs.mid.
NodeDescription string
The description of the Config Server node.
NodeId string
The ID of the Config Server node.
NodeStorage Changes to this property will trigger replacement. int
The storage space of the ConfigServer node.
Port int
The connection port of the Config Server node.
connectString String
The connection address of the Config Server node.
maxConnections Integer
The max connections of the Config Server node.
maxIops Integer
The maximum IOPS of the Config Server node.
nodeClass Changes to this property will trigger replacement. String
The instance type of the ConfigServer node. Valid values: mdb.shard.2x.xlarge.d, dds.cs.mid.
nodeDescription String
The description of the Config Server node.
nodeId String
The ID of the Config Server node.
nodeStorage Changes to this property will trigger replacement. Integer
The storage space of the ConfigServer node.
port Integer
The connection port of the Config Server node.
connectString string
The connection address of the Config Server node.
maxConnections number
The max connections of the Config Server node.
maxIops number
The maximum IOPS of the Config Server node.
nodeClass Changes to this property will trigger replacement. string
The instance type of the ConfigServer node. Valid values: mdb.shard.2x.xlarge.d, dds.cs.mid.
nodeDescription string
The description of the Config Server node.
nodeId string
The ID of the Config Server node.
nodeStorage Changes to this property will trigger replacement. number
The storage space of the ConfigServer node.
port number
The connection port of the Config Server node.
connect_string str
The connection address of the Config Server node.
max_connections int
The max connections of the Config Server node.
max_iops int
The maximum IOPS of the Config Server node.
node_class Changes to this property will trigger replacement. str
The instance type of the ConfigServer node. Valid values: mdb.shard.2x.xlarge.d, dds.cs.mid.
node_description str
The description of the Config Server node.
node_id str
The ID of the Config Server node.
node_storage Changes to this property will trigger replacement. int
The storage space of the ConfigServer node.
port int
The connection port of the Config Server node.
connectString String
The connection address of the Config Server node.
maxConnections Number
The max connections of the Config Server node.
maxIops Number
The maximum IOPS of the Config Server node.
nodeClass Changes to this property will trigger replacement. String
The instance type of the ConfigServer node. Valid values: mdb.shard.2x.xlarge.d, dds.cs.mid.
nodeDescription String
The description of the Config Server node.
nodeId String
The ID of the Config Server node.
nodeStorage Changes to this property will trigger replacement. Number
The storage space of the ConfigServer node.
port Number
The connection port of the Config Server node.

ShardingInstanceMongoList
, ShardingInstanceMongoListArgs

NodeClass This property is required. string
The instance type of the mongo node. see Instance specifications.
ConnectString string
The connection address of the Config Server node.
NodeId string
The ID of the Config Server node.
Port int
The connection port of the Config Server node.
NodeClass This property is required. string
The instance type of the mongo node. see Instance specifications.
ConnectString string
The connection address of the Config Server node.
NodeId string
The ID of the Config Server node.
Port int
The connection port of the Config Server node.
nodeClass This property is required. String
The instance type of the mongo node. see Instance specifications.
connectString String
The connection address of the Config Server node.
nodeId String
The ID of the Config Server node.
port Integer
The connection port of the Config Server node.
nodeClass This property is required. string
The instance type of the mongo node. see Instance specifications.
connectString string
The connection address of the Config Server node.
nodeId string
The ID of the Config Server node.
port number
The connection port of the Config Server node.
node_class This property is required. str
The instance type of the mongo node. see Instance specifications.
connect_string str
The connection address of the Config Server node.
node_id str
The ID of the Config Server node.
port int
The connection port of the Config Server node.
nodeClass This property is required. String
The instance type of the mongo node. see Instance specifications.
connectString String
The connection address of the Config Server node.
nodeId String
The ID of the Config Server node.
port Number
The connection port of the Config Server node.

ShardingInstanceShardList
, ShardingInstanceShardListArgs

NodeClass This property is required. string
The instance type of the shard node. see Instance specifications.
NodeStorage This property is required. int
The storage space of the shard node.

  • Custom storage space; value range: [10, 1,000]
  • 10-GB increments. Unit: GB.
NodeId string
The ID of the Config Server node.
ReadonlyReplicas int
The number of read-only nodes in shard node Default value: 0. Valid values: 0 to 5.
NodeClass This property is required. string
The instance type of the shard node. see Instance specifications.
NodeStorage This property is required. int
The storage space of the shard node.

  • Custom storage space; value range: [10, 1,000]
  • 10-GB increments. Unit: GB.
NodeId string
The ID of the Config Server node.
ReadonlyReplicas int
The number of read-only nodes in shard node Default value: 0. Valid values: 0 to 5.
nodeClass This property is required. String
The instance type of the shard node. see Instance specifications.
nodeStorage This property is required. Integer
The storage space of the shard node.

  • Custom storage space; value range: [10, 1,000]
  • 10-GB increments. Unit: GB.
nodeId String
The ID of the Config Server node.
readonlyReplicas Integer
The number of read-only nodes in shard node Default value: 0. Valid values: 0 to 5.
nodeClass This property is required. string
The instance type of the shard node. see Instance specifications.
nodeStorage This property is required. number
The storage space of the shard node.

  • Custom storage space; value range: [10, 1,000]
  • 10-GB increments. Unit: GB.
nodeId string
The ID of the Config Server node.
readonlyReplicas number
The number of read-only nodes in shard node Default value: 0. Valid values: 0 to 5.
node_class This property is required. str
The instance type of the shard node. see Instance specifications.
node_storage This property is required. int
The storage space of the shard node.

  • Custom storage space; value range: [10, 1,000]
  • 10-GB increments. Unit: GB.
node_id str
The ID of the Config Server node.
readonly_replicas int
The number of read-only nodes in shard node Default value: 0. Valid values: 0 to 5.
nodeClass This property is required. String
The instance type of the shard node. see Instance specifications.
nodeStorage This property is required. Number
The storage space of the shard node.

  • Custom storage space; value range: [10, 1,000]
  • 10-GB increments. Unit: GB.
nodeId String
The ID of the Config Server node.
readonlyReplicas Number
The number of read-only nodes in shard node Default value: 0. Valid values: 0 to 5.

Import

MongoDB Sharding Instance can be imported using the id, e.g.

$ pulumi import alicloud:mongodb/shardingInstance:ShardingInstance example dds-bp1291daeda44195
Copy

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

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.