Docs Packages
  1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. mongodb
  5. ShardingInstance
Alibaba Cloud v3.45.0 published on Monday, Nov 27, 2023 by Pulumi
pulumi/pulumi-alicloud

alicloud.mongodb.ShardingInstance

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.45.0 published on Monday, Nov 27, 2023 by Pulumi
pulumi/pulumi-alicloud

    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-2,ap-southeast-3,ap-southeast-5,ap-south-1,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

    Module Support

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

    Example Usage

    Create a Mongodb Sharding instance

    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 defaultZones = AliCloud.MongoDB.GetZones.Invoke();

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

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

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

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

    var defaultShardingInstance = new AliCloud.MongoDB.ShardingInstance("defaultShardingInstance", new()
    {
        ZoneId = zoneId,
        VswitchId = defaultSwitch.Id,
        EngineVersion = "4.2",
        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,
            },
        },
        MongoLists = new[]
        {
            new AliCloud.MongoDB.Inputs.ShardingInstanceMongoListArgs
            {
                NodeClass = "dds.mongos.mid",
            },
            new AliCloud.MongoDB.Inputs.ShardingInstanceMongoListArgs
            {
                NodeClass = "dds.mongos.mid",
            },
        },
    });

});

    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
		}
		defaultZones, err := mongodb.GetZones(ctx, nil, nil)
		if err != nil {
			return err
		}
		index := len(defaultZones.Zones) - 1
		zoneId := defaultZones.Zones[index].Id
		defaultNetwork, err := vpc.NewNetwork(ctx, "defaultNetwork", &vpc.NetworkArgs{
			VpcName:   pulumi.String(name),
			CidrBlock: pulumi.String("172.17.3.0/24"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "defaultSwitch", &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, "defaultShardingInstance", &mongodb.ShardingInstanceArgs{
			ZoneId:        *pulumi.String(zoneId),
			VswitchId:     defaultSwitch.ID(),
			EngineVersion: pulumi.String("4.2"),
			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),
				},
			},
			MongoLists: mongodb.ShardingInstanceMongoListArray{
				&mongodb.ShardingInstanceMongoListArgs{
					NodeClass: pulumi.String("dds.mongos.mid"),
				},
				&mongodb.ShardingInstanceMongoListArgs{
					NodeClass: pulumi.String("dds.mongos.mid"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.mongodb.MongodbFunctions;
import com.pulumi.alicloud.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.ShardingInstanceShardListArgs;
import com.pulumi.alicloud.mongodb.inputs.ShardingInstanceMongoListArgs;
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 defaultZones = MongodbFunctions.getZones();

        final var index = defaultZones.applyValue(getZonesResult -> getZonesResult.zones()).length() - 1;

        final var zoneId = defaultZones.applyValue(getZonesResult -> getZonesResult.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()        
            .zoneId(zoneId)
            .vswitchId(defaultSwitch.id())
            .engineVersion("4.2")
            .shardLists(            
                ShardingInstanceShardListArgs.builder()
                    .nodeClass("dds.shard.mid")
                    .nodeStorage("10")
                    .build(),
                ShardingInstanceShardListArgs.builder()
                    .nodeClass("dds.shard.standard")
                    .nodeStorage("20")
                    .readonlyReplicas("1")
                    .build())
            .mongoLists(            
                ShardingInstanceMongoListArgs.builder()
                    .nodeClass("dds.mongos.mid")
                    .build(),
                ShardingInstanceMongoListArgs.builder()
                    .nodeClass("dds.mongos.mid")
                    .build())
            .build());

    }
}

    import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
default_zones = alicloud.mongodb.get_zones()
index = len(default_zones.zones) - 1
zone_id = default_zones.zones[index].id
default_network = alicloud.vpc.Network("defaultNetwork",
    vpc_name=name,
    cidr_block="172.17.3.0/24")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    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("defaultShardingInstance",
    zone_id=zone_id,
    vswitch_id=default_switch.id,
    engine_version="4.2",
    shard_lists=[
        alicloud.mongodb.ShardingInstanceShardListArgs(
            node_class="dds.shard.mid",
            node_storage=10,
        ),
        alicloud.mongodb.ShardingInstanceShardListArgs(
            node_class="dds.shard.standard",
            node_storage=20,
            readonly_replicas=1,
        ),
    ],
    mongo_lists=[
        alicloud.mongodb.ShardingInstanceMongoListArgs(
            node_class="dds.mongos.mid",
        ),
        alicloud.mongodb.ShardingInstanceMongoListArgs(
            node_class="dds.mongos.mid",
        ),
    ])

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

    Coming soon!

    Create ShardingInstance Resource

    new ShardingInstance(name: string, args: ShardingInstanceArgs, opts?: CustomResourceOptions);
    @overload
def ShardingInstance(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     account_password: Optional[str] = None,
                     auto_renew: Optional[bool] = None,
                     backup_periods: Optional[Sequence[str]] = None,
                     backup_time: Optional[str] = None,
                     engine_version: Optional[str] = None,
                     instance_charge_type: Optional[str] = None,
                     kms_encrypted_password: Optional[str] = None,
                     kms_encryption_context: Optional[Mapping[str, Any]] = 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,
                     resource_group_id: Optional[str] = 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,
                     tags: Optional[Mapping[str, Any]] = None,
                     tde_status: Optional[str] = None,
                     vpc_id: Optional[str] = None,
                     vswitch_id: Optional[str] = None,
                     zone_id: Optional[str] = None)
@overload
def ShardingInstance(resource_name: str,
                     args: ShardingInstanceArgs,
                     opts: Optional[ResourceOptions] = 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.
    name string
    The unique name of the resource.
    args ShardingInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args ShardingInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ShardingInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ShardingInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The ShardingInstance resource accepts the following input properties:

    EngineVersion string

    Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

    MongoLists List<Pulumi.AliCloud.MongoDB.Inputs.ShardingInstanceMongoList>

    The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.

    ShardLists List<Pulumi.AliCloud.MongoDB.Inputs.ShardingInstanceShardList>

    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, true of false. Default is 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]

    BackupTime string

    MongoDB 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".

    InstanceChargeType string

    Valid values are PrePaid, PostPaid,System default to 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, object>

    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 a string of 2 to 256 characters.

    NetworkType string

    The network type of the instance. Valid values:Classic or VPC. Default value: Classic.

    OrderType string

    The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

    • UPGRADE: The specifications are upgraded.
    • DOWNGRADE: The specifications are downgraded. Note: This parameter 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. Valid values: [1~9], 12, 24, 36. System default to 1.

    ProtocolType string

    The type of the access protocol. Valid values: mongodb or dynamodb.

    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 string

    Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.

    Tags Dictionary<string, object>

    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 string

    The ID of the VPC. > NOTE: This parameter is valid only when NetworkType is set to VPC.

    VswitchId string

    The virtual switch ID to launch DB instances in one VPC.

    ZoneId 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 string

    Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

    MongoLists []ShardingInstanceMongoListArgs

    The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.

    ShardLists []ShardingInstanceShardListArgs

    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, true of false. Default is 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]

    BackupTime string

    MongoDB 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".

    InstanceChargeType string

    Valid values are PrePaid, PostPaid,System default to 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]interface{}

    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 a string of 2 to 256 characters.

    NetworkType string

    The network type of the instance. Valid values:Classic or VPC. Default value: Classic.

    OrderType string

    The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

    • UPGRADE: The specifications are upgraded.
    • DOWNGRADE: The specifications are downgraded. Note: This parameter 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. Valid values: [1~9], 12, 24, 36. System default to 1.

    ProtocolType string

    The type of the access protocol. Valid values: mongodb or dynamodb.

    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 string

    Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.

    Tags map[string]interface{}

    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 string

    The ID of the VPC. > NOTE: This parameter is valid only when NetworkType is set to VPC.

    VswitchId string

    The virtual switch ID to launch DB instances in one VPC.

    ZoneId 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 String

    Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

    mongoLists List<ShardingInstanceMongoList>

    The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.

    shardLists List<ShardingInstanceShardList>

    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, true of false. Default is 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]

    backupTime String

    MongoDB 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".

    instanceChargeType String

    Valid values are PrePaid, PostPaid,System default to 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,Object>

    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 a string of 2 to 256 characters.

    networkType String

    The network type of the instance. Valid values:Classic or VPC. Default value: Classic.

    orderType String

    The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

    • UPGRADE: The specifications are upgraded.
    • DOWNGRADE: The specifications are downgraded. Note: This parameter 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. Valid values: [1~9], 12, 24, 36. System default to 1.

    protocolType String

    The type of the access protocol. Valid values: mongodb or dynamodb.

    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 String

    Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.

    tags Map<String,Object>

    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 String

    The ID of the VPC. > NOTE: This parameter is valid only when NetworkType is set to VPC.

    vswitchId String

    The virtual switch ID to launch DB instances in one VPC.

    zoneId 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 string

    Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

    mongoLists ShardingInstanceMongoList[]

    The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.

    shardLists ShardingInstanceShardList[]

    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, true of false. Default is 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]

    backupTime string

    MongoDB 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".

    instanceChargeType string

    Valid values are PrePaid, PostPaid,System default to 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]: any}

    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 a string of 2 to 256 characters.

    networkType string

    The network type of the instance. Valid values:Classic or VPC. Default value: Classic.

    orderType string

    The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

    • UPGRADE: The specifications are upgraded.
    • DOWNGRADE: The specifications are downgraded. Note: This parameter 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. Valid values: [1~9], 12, 24, 36. System default to 1.

    protocolType string

    The type of the access protocol. Valid values: mongodb or dynamodb.

    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 string

    Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.

    tags {[key: string]: any}

    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 string

    The ID of the VPC. > NOTE: This parameter is valid only when NetworkType is set to VPC.

    vswitchId string

    The virtual switch ID to launch DB instances in one VPC.

    zoneId 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 str

    Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

    mongo_lists Sequence[ShardingInstanceMongoListArgs]

    The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.

    shard_lists Sequence[ShardingInstanceShardListArgs]

    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, true of false. Default is 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_time str

    MongoDB 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".

    instance_charge_type str

    Valid values are PrePaid, PostPaid,System default to 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, Any]

    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 a string of 2 to 256 characters.

    network_type str

    The network type of the instance. Valid values:Classic or VPC. Default value: Classic.

    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: This parameter 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. Valid values: [1~9], 12, 24, 36. System default to 1.

    protocol_type str

    The type of the access protocol. Valid values: mongodb or dynamodb.

    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 str

    Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.

    tags Mapping[str, Any]

    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 str

    The ID of the VPC. > NOTE: This parameter is valid only when NetworkType is set to VPC.

    vswitch_id str

    The virtual switch ID to launch DB instances in one VPC.

    zone_id 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 String

    Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

    mongoLists List<Property Map>

    The mongo-node count can be purchased is in range of [2, 32]. See mongo_list below.

    shardLists List<Property Map>

    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, true of false. Default is 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]

    backupTime String

    MongoDB 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".

    instanceChargeType String

    Valid values are PrePaid, PostPaid,System default to 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<Any>

    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 a string of 2 to 256 characters.

    networkType String

    The network type of the instance. Valid values:Classic or VPC. Default value: Classic.

    orderType String

    The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

    • UPGRADE: The specifications are upgraded.
    • DOWNGRADE: The specifications are downgraded. Note: This parameter 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. Valid values: [1~9], 12, 24, 36. System default to 1.

    protocolType String

    The type of the access protocol. Valid values: mongodb or dynamodb.

    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 String

    Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.

    tags Map<Any>

    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 String

    The ID of the VPC. > NOTE: This parameter is valid only when NetworkType is set to VPC.

    vswitchId String

    The virtual switch ID to launch DB instances in one VPC.

    zoneId 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:

    ConfigServerLists List<Pulumi.AliCloud.MongoDB.Outputs.ShardingInstanceConfigServerList>

    The node information list of config server. See config_server_list below.

    Id string

    The provider-assigned unique ID for this managed resource.

    RetentionPeriod int

    Instance data backup retention days. NOTE: Available in 1.42.0+.

    ConfigServerLists []ShardingInstanceConfigServerList

    The node information list of config server. See config_server_list below.

    Id string

    The provider-assigned unique ID for this managed resource.

    RetentionPeriod int

    Instance data backup retention days. NOTE: Available in 1.42.0+.

    configServerLists List<ShardingInstanceConfigServerList>

    The node information list of config server. See config_server_list below.

    id String

    The provider-assigned unique ID for this managed resource.

    retentionPeriod Integer

    Instance data backup retention days. NOTE: Available in 1.42.0+.

    configServerLists ShardingInstanceConfigServerList[]

    The node information list of config server. See config_server_list below.

    id string

    The provider-assigned unique ID for this managed resource.

    retentionPeriod number

    Instance data backup retention days. NOTE: Available in 1.42.0+.

    config_server_lists Sequence[ShardingInstanceConfigServerList]

    The node information list of config server. See config_server_list below.

    id str

    The provider-assigned unique ID for this managed resource.

    retention_period int

    Instance data backup retention days. NOTE: Available in 1.42.0+.

    configServerLists List<Property Map>

    The node information list of config server. See config_server_list below.

    id String

    The provider-assigned unique ID for this managed resource.

    retentionPeriod Number

    Instance data backup retention days. NOTE: Available in 1.42.0+.

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

    BackupTime string

    MongoDB 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 List<Pulumi.AliCloud.MongoDB.Inputs.ShardingInstanceConfigServerList>

    The node information list of config server. See config_server_list below.

    EngineVersion string

    Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

    InstanceChargeType string

    Valid values are PrePaid, PostPaid,System default to 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, object>

    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-node count can be purchased is in range of [2, 32]. See mongo_list below.

    Name string

    The name of DB instance. It a string of 2 to 256 characters.

    NetworkType string

    The network type of the instance. Valid values:Classic or VPC. Default value: Classic.

    OrderType string

    The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

    • UPGRADE: The specifications are upgraded.
    • DOWNGRADE: The specifications are downgraded. Note: This parameter 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. Valid values: [1~9], 12, 24, 36. System default to 1.

    ProtocolType string

    The type of the access protocol. Valid values: mongodb or dynamodb.

    ResourceGroupId string

    The ID of the Resource Group.

    RetentionPeriod int

    Instance data backup retention days. NOTE: Available in 1.42.0+.

    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-node count can be purchased is in range of [2, 32]. See shard_list below.

    StorageEngine string

    Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.

    Tags Dictionary<string, object>

    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 string

    The ID of the VPC. > NOTE: This parameter is valid only when NetworkType is set to VPC.

    VswitchId string

    The virtual switch ID to launch DB instances in one VPC.

    ZoneId 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, true of false. Default is 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]

    BackupTime string

    MongoDB 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 []ShardingInstanceConfigServerListArgs

    The node information list of config server. See config_server_list below.

    EngineVersion string

    Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

    InstanceChargeType string

    Valid values are PrePaid, PostPaid,System default to 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]interface{}

    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-node count can be purchased is in range of [2, 32]. See mongo_list below.

    Name string

    The name of DB instance. It a string of 2 to 256 characters.

    NetworkType string

    The network type of the instance. Valid values:Classic or VPC. Default value: Classic.

    OrderType string

    The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

    • UPGRADE: The specifications are upgraded.
    • DOWNGRADE: The specifications are downgraded. Note: This parameter 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. Valid values: [1~9], 12, 24, 36. System default to 1.

    ProtocolType string

    The type of the access protocol. Valid values: mongodb or dynamodb.

    ResourceGroupId string

    The ID of the Resource Group.

    RetentionPeriod int

    Instance data backup retention days. NOTE: Available in 1.42.0+.

    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-node count can be purchased is in range of [2, 32]. See shard_list below.

    StorageEngine string

    Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.

    Tags map[string]interface{}

    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 string

    The ID of the VPC. > NOTE: This parameter is valid only when NetworkType is set to VPC.

    VswitchId string

    The virtual switch ID to launch DB instances in one VPC.

    ZoneId 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, true of false. Default is 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]

    backupTime String

    MongoDB 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 List<ShardingInstanceConfigServerList>

    The node information list of config server. See config_server_list below.

    engineVersion String

    Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

    instanceChargeType String

    Valid values are PrePaid, PostPaid,System default to 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,Object>

    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-node count can be purchased is in range of [2, 32]. See mongo_list below.

    name String

    The name of DB instance. It a string of 2 to 256 characters.

    networkType String

    The network type of the instance. Valid values:Classic or VPC. Default value: Classic.

    orderType String

    The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

    • UPGRADE: The specifications are upgraded.
    • DOWNGRADE: The specifications are downgraded. Note: This parameter 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. Valid values: [1~9], 12, 24, 36. System default to 1.

    protocolType String

    The type of the access protocol. Valid values: mongodb or dynamodb.

    resourceGroupId String

    The ID of the Resource Group.

    retentionPeriod Integer

    Instance data backup retention days. NOTE: Available in 1.42.0+.

    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-node count can be purchased is in range of [2, 32]. See shard_list below.

    storageEngine String

    Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.

    tags Map<String,Object>

    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 String

    The ID of the VPC. > NOTE: This parameter is valid only when NetworkType is set to VPC.

    vswitchId String

    The virtual switch ID to launch DB instances in one VPC.

    zoneId 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, true of false. Default is 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]

    backupTime string

    MongoDB 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 ShardingInstanceConfigServerList[]

    The node information list of config server. See config_server_list below.

    engineVersion string

    Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

    instanceChargeType string

    Valid values are PrePaid, PostPaid,System default to 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]: any}

    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-node count can be purchased is in range of [2, 32]. See mongo_list below.

    name string

    The name of DB instance. It a string of 2 to 256 characters.

    networkType string

    The network type of the instance. Valid values:Classic or VPC. Default value: Classic.

    orderType string

    The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

    • UPGRADE: The specifications are upgraded.
    • DOWNGRADE: The specifications are downgraded. Note: This parameter 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. Valid values: [1~9], 12, 24, 36. System default to 1.

    protocolType string

    The type of the access protocol. Valid values: mongodb or dynamodb.

    resourceGroupId string

    The ID of the Resource Group.

    retentionPeriod number

    Instance data backup retention days. NOTE: Available in 1.42.0+.

    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-node count can be purchased is in range of [2, 32]. See shard_list below.

    storageEngine string

    Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.

    tags {[key: string]: any}

    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 string

    The ID of the VPC. > NOTE: This parameter is valid only when NetworkType is set to VPC.

    vswitchId string

    The virtual switch ID to launch DB instances in one VPC.

    zoneId 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, true of false. Default is 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_time str

    MongoDB 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 Sequence[ShardingInstanceConfigServerListArgs]

    The node information list of config server. See config_server_list below.

    engine_version str

    Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

    instance_charge_type str

    Valid values are PrePaid, PostPaid,System default to 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, Any]

    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-node count can be purchased is in range of [2, 32]. See mongo_list below.

    name str

    The name of DB instance. It a string of 2 to 256 characters.

    network_type str

    The network type of the instance. Valid values:Classic or VPC. Default value: Classic.

    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: This parameter 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. Valid values: [1~9], 12, 24, 36. System default to 1.

    protocol_type str

    The type of the access protocol. Valid values: mongodb or dynamodb.

    resource_group_id str

    The ID of the Resource Group.

    retention_period int

    Instance data backup retention days. NOTE: Available in 1.42.0+.

    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-node count can be purchased is in range of [2, 32]. See shard_list below.

    storage_engine str

    Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.

    tags Mapping[str, Any]

    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 str

    The ID of the VPC. > NOTE: This parameter is valid only when NetworkType is set to VPC.

    vswitch_id str

    The virtual switch ID to launch DB instances in one VPC.

    zone_id 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, true of false. Default is 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]

    backupTime String

    MongoDB 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 List<Property Map>

    The node information list of config server. See config_server_list below.

    engineVersion String

    Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

    instanceChargeType String

    Valid values are PrePaid, PostPaid,System default to 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<Any>

    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-node count can be purchased is in range of [2, 32]. See mongo_list below.

    name String

    The name of DB instance. It a string of 2 to 256 characters.

    networkType String

    The network type of the instance. Valid values:Classic or VPC. Default value: Classic.

    orderType String

    The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

    • UPGRADE: The specifications are upgraded.
    • DOWNGRADE: The specifications are downgraded. Note: This parameter 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. Valid values: [1~9], 12, 24, 36. System default to 1.

    protocolType String

    The type of the access protocol. Valid values: mongodb or dynamodb.

    resourceGroupId String

    The ID of the Resource Group.

    retentionPeriod Number

    Instance data backup retention days. NOTE: Available in 1.42.0+.

    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-node count can be purchased is in range of [2, 32]. See shard_list below.

    storageEngine String

    Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.

    tags Map<Any>

    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 String

    The ID of the VPC. > NOTE: This parameter is valid only when NetworkType is set to VPC.

    vswitchId String

    The virtual switch ID to launch DB instances in one VPC.

    zoneId 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 string

    The node class of the Config Server node.

    NodeDescription string

    The description of the Config Server node.

    NodeId string

    The ID of the Config Server node.

    NodeStorage int

    The node storage of the Config Server 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 string

    The node class of the Config Server node.

    NodeDescription string

    The description of the Config Server node.

    NodeId string

    The ID of the Config Server node.

    NodeStorage int

    The node storage of the Config Server 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 String

    The node class of the Config Server node.

    nodeDescription String

    The description of the Config Server node.

    nodeId String

    The ID of the Config Server node.

    nodeStorage Integer

    The node storage of the Config Server 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 string

    The node class of the Config Server node.

    nodeDescription string

    The description of the Config Server node.

    nodeId string

    The ID of the Config Server node.

    nodeStorage number

    The node storage of the Config Server 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 str

    The node class of the Config Server node.

    node_description str

    The description of the Config Server node.

    node_id str

    The ID of the Config Server node.

    node_storage int

    The node storage of the Config Server 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 String

    The node class of the Config Server node.

    nodeDescription String

    The description of the Config Server node.

    nodeId String

    The ID of the Config Server node.

    nodeStorage Number

    The node storage of the Config Server node.

    port Number

    The connection port of the Config Server node.

    ShardingInstanceMongoList, ShardingInstanceMongoListArgs

    NodeClass string

    Node specification. see Instance specifications.

    ConnectString string

    Mongo node connection string.

    NodeId string

    The ID of the mongo-node.

    Port int

    Mongo node port.

    NodeClass string

    Node specification. see Instance specifications.

    ConnectString string

    Mongo node connection string.

    NodeId string

    The ID of the mongo-node.

    Port int

    Mongo node port.

    nodeClass String

    Node specification. see Instance specifications.

    connectString String

    Mongo node connection string.

    nodeId String

    The ID of the mongo-node.

    port Integer

    Mongo node port.

    nodeClass string

    Node specification. see Instance specifications.

    connectString string

    Mongo node connection string.

    nodeId string

    The ID of the mongo-node.

    port number

    Mongo node port.

    node_class str

    Node specification. see Instance specifications.

    connect_string str

    Mongo node connection string.

    node_id str

    The ID of the mongo-node.

    port int

    Mongo node port.

    nodeClass String

    Node specification. see Instance specifications.

    connectString String

    Mongo node connection string.

    nodeId String

    The ID of the mongo-node.

    port Number

    Mongo node port.

    ShardingInstanceShardList, ShardingInstanceShardListArgs

    NodeClass string

    Node specification. see Instance specifications.

    NodeStorage int
    • Custom storage space; value range: [10, 1,000]
    • 10-GB increments. Unit: GB.
    NodeId string

    The ID of the shard-node.

    ReadonlyReplicas int

    The number of read-only nodes in shard node. Valid values: 0 to 5. Default value: 0.

    NodeClass string

    Node specification. see Instance specifications.

    NodeStorage int
    • Custom storage space; value range: [10, 1,000]
    • 10-GB increments. Unit: GB.
    NodeId string

    The ID of the shard-node.

    ReadonlyReplicas int

    The number of read-only nodes in shard node. Valid values: 0 to 5. Default value: 0.

    nodeClass String

    Node specification. see Instance specifications.

    nodeStorage Integer
    • Custom storage space; value range: [10, 1,000]
    • 10-GB increments. Unit: GB.
    nodeId String

    The ID of the shard-node.

    readonlyReplicas Integer

    The number of read-only nodes in shard node. Valid values: 0 to 5. Default value: 0.

    nodeClass string

    Node specification. see Instance specifications.

    nodeStorage number
    • Custom storage space; value range: [10, 1,000]
    • 10-GB increments. Unit: GB.
    nodeId string

    The ID of the shard-node.

    readonlyReplicas number

    The number of read-only nodes in shard node. Valid values: 0 to 5. Default value: 0.

    node_class str

    Node specification. see Instance specifications.

    node_storage int
    • Custom storage space; value range: [10, 1,000]
    • 10-GB increments. Unit: GB.
    node_id str

    The ID of the shard-node.

    readonly_replicas int

    The number of read-only nodes in shard node. Valid values: 0 to 5. Default value: 0.

    nodeClass String

    Node specification. see Instance specifications.

    nodeStorage Number
    • Custom storage space; value range: [10, 1,000]
    • 10-GB increments. Unit: GB.
    nodeId String

    The ID of the shard-node.

    readonlyReplicas Number

    The number of read-only nodes in shard node. Valid values: 0 to 5. Default value: 0.

    Import

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

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the alicloud Terraform Provider.

    alicloud logo
    Alibaba Cloud v3.45.0 published on Monday, Nov 27, 2023 by Pulumi
    pulumi/pulumi-alicloud