1. Docs
  2. Reference
  3. API
  4. @pulumi/alicloud
  5. mongodb

Module mongodb

This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

Resources

Functions

Others

Resources

Resource Instance

class Instance extends CustomResource

constructor

new Instance(name: string, args: InstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a Instance resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance

Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Instance

Returns true if the given object is an instance of Instance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accountPassword

public accountPassword: pulumi.Output<string | undefined>;

Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.

property backupPeriods

public backupPeriods: pulumi.Output<string[]>;

MongoDB Instance backup period. It is required when backupTime was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]

property backupTime

public backupTime: pulumi.Output<string>;

MongoDB instance backup time. It is required when backupPeriod 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”.

property dbInstanceClass

public dbInstanceClass: pulumi.Output<string>;

Instance specification. see Instance specifications.

property dbInstanceStorage

public dbInstanceStorage: pulumi.Output<number>;

User-defined DB instance storage space.Unit: GB. Value range: - Custom storage space; value range: [10,2000] - 10-GB increments.

property engineVersion

public engineVersion: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceChargeType

public instanceChargeType: pulumi.Output<string | undefined>;

Valid values are PrePaid, PostPaid, System default to PostPaid. It can be modified from PostPaid to PrePaid after version 1.63.0.

property kmsEncryptedPassword

public kmsEncryptedPassword: pulumi.Output<string | undefined>;

An KMS encrypts password used to a instance. If the accountPassword is filled in, this field will be ignored.

property kmsEncryptionContext

public kmsEncryptionContext: pulumi.Output<{[key: string]: any} | undefined>;

An KMS encryption context used to decrypt kmsEncryptedPassword before creating or updating instance with kmsEncryptedPassword. See Encryption Context. It is valid when kmsEncryptedPassword is set.

property maintainEndTime

public maintainEndTime: pulumi.Output<string>;

The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

property maintainStartTime

public maintainStartTime: pulumi.Output<string>;

The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

property name

public name: pulumi.Output<string>;

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

property period

public period: pulumi.Output<number>;

The duration that you will buy DB instance (in month). It is valid when instanceChargeType is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.

property replicaSetName

public replicaSetName: pulumi.Output<string>;

The name of the mongo replica set

property replicationFactor

public replicationFactor: pulumi.Output<number>;

Number of replica set nodes. Valid values: [3, 5, 7]

property retentionPeriod

public retentionPeriod: pulumi.Output<number>;

Instance log backup retention days. Available in 1.42.0+.

property securityGroupId

public securityGroupId: pulumi.Output<string>;

The Security Group ID of ECS.

property securityIpLists

public securityIpLists: pulumi.Output<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]).

property sslAction

public sslAction: pulumi.Output<string>;

Actions performed on SSL functions, Valid values: Open: turn on SSL encryption; Close: turn off SSL encryption; Update: update SSL certificate.

property sslStatus

public sslStatus: pulumi.Output<string>;

Status of the SSL feature. Open: SSL is turned on; Closed: SSL is turned off.

property storageEngine

public storageEngine: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A mapping of tags to assign to the resource.

property tdeStatus

public tdeStatus: pulumi.Output<string | undefined>;

The TDE(Transparent Data Encryption) status.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vswitchId

public vswitchId: pulumi.Output<string>;

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

property zoneId

public zoneId: pulumi.Output<string>;

The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitchId is specified, the vswitch must in one of them. The multiple zone ID can be retrieved by setting multi to “true” in the data source alicloud..getZones.

Resource ShardingInstance

class ShardingInstance extends CustomResource

constructor

new ShardingInstance(name: string, args: ShardingInstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a ShardingInstance resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ShardingInstanceState, opts?: pulumi.CustomResourceOptions): ShardingInstance

Get an existing ShardingInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ShardingInstance

Returns true if the given object is an instance of ShardingInstance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accountPassword

public accountPassword: pulumi.Output<string | undefined>;

Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.

property backupPeriods

public backupPeriods: pulumi.Output<string[]>;

MongoDB Instance backup period. It is required when backupTime was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]

property backupTime

public backupTime: pulumi.Output<string>;

MongoDB instance backup time. It is required when backupPeriod 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”.

property engineVersion

public engineVersion: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceChargeType

public instanceChargeType: pulumi.Output<string>;

Valid values are PrePaid, PostPaid,System default to PostPaid.

property kmsEncryptedPassword

public kmsEncryptedPassword: pulumi.Output<string | undefined>;

An KMS encrypts password used to a instance. If the accountPassword is filled in, this field will be ignored.

property kmsEncryptionContext

public kmsEncryptionContext: pulumi.Output<{[key: string]: any} | undefined>;

An KMS encryption context used to decrypt kmsEncryptedPassword before creating or updating instance with kmsEncryptedPassword. See Encryption Context. It is valid when kmsEncryptedPassword is set.

property mongoLists

public mongoLists: pulumi.Output<ShardingInstanceMongoList[]>;

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

property name

public name: pulumi.Output<string>;

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

property period

public period: pulumi.Output<number>;

The duration that you will buy DB instance (in month). It is valid when instanceChargeType is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.

property retentionPeriod

public retentionPeriod: pulumi.Output<number>;

Instance log backup retention days. Available in 1.42.0+.

property securityGroupId

public securityGroupId: pulumi.Output<string>;

The Security Group ID of ECS.

property securityIpLists

public securityIpLists: pulumi.Output<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"].

property shardLists

public shardLists: pulumi.Output<ShardingInstanceShardList[]>;

the shard-node count can be purchased is in range of [2, 32].

property storageEngine

public storageEngine: pulumi.Output<string>;

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

property tdeStatus

public tdeStatus: pulumi.Output<string | undefined>;

The TDE(Transparent Data Encryption) status.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vswitchId

public vswitchId: pulumi.Output<string | undefined>;

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

property zoneId

public zoneId: pulumi.Output<string | undefined>;

The Zone to launch the DB instance. MongoDB sharding instance does not support multiple-zone. If it is a multi-zone and vswitchId is specified, the vswitch must in one of them.

Functions

Function getInstances

getInstances(args?: GetInstancesArgs, opts?: pulumi.InvokeOptions): Promise<GetInstancesResult>

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

Example Usage

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

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

Function getZones

getZones(args?: GetZonesArgs, opts?: pulumi.InvokeOptions): Promise<GetZonesResult>

This data source provides availability zones for mongoDB that can be accessed by an Alibaba Cloud account within the region configured in the provider.

NOTE: Available in v1.73.0+.

Example Usage

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

const zonesIds = alicloud.mongodb.getZones({});
// Create an mongoDB instance with the first matched zone
const mongodb = new alicloud.mongodb.Instance("mongodb", {zoneId: zonesIds.then(zonesIds => zonesIds.zones[0].id)});
// Other properties...

Others

interface GetInstancesArgs

interface GetInstancesArgs

A collection of arguments for invoking getInstances.

property availabilityZone

availabilityZone?: undefined | string;

Instance availability zone.

property ids

ids?: string[];

The ids list of MongoDB instances

property instanceClass

instanceClass?: undefined | string;

Sizing of the instance to be queried.

property instanceType

instanceType?: undefined | string;

Type of the instance to be queried. If it is set to sharding, the sharded cluster instances are listed. If it is set to replicate, replica set instances are listed. Default value replicate.

property nameRegex

nameRegex?: undefined | string;

A regex string to apply to the instance name.

property outputFile

outputFile?: undefined | string;

property tags

tags?: undefined | {[key: string]: any};

A mapping of tags to assign to the resource.

interface GetInstancesResult

interface GetInstancesResult

A collection of values returned by getInstances.

property availabilityZone

availabilityZone?: undefined | string;

Instance availability zone.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

The ids list of MongoDB instances

property instanceClass

instanceClass?: undefined | string;

Sizing of the MongoDB instance.

property instanceType

instanceType?: undefined | string;

Instance type. Optional values sharding or replicate.

property instances

instances: GetInstancesInstance[];

A list of MongoDB instances. Its every element contains the following attributes:

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

The names list of MongoDB instances

property outputFile

outputFile?: undefined | string;

property tags

tags?: undefined | {[key: string]: any};

interface GetZonesArgs

interface GetZonesArgs

A collection of arguments for invoking getZones.

property multi

multi?: undefined | false | true;

Indicate whether the zones can be used in a multi AZ configuration. Default to false. Multi AZ is usually used to launch MongoDB instances.

property outputFile

outputFile?: undefined | string;

interface GetZonesResult

interface GetZonesResult

A collection of values returned by getZones.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of zone IDs.

property multi

multi?: undefined | false | true;

property outputFile

outputFile?: undefined | string;

property zones

zones: GetZonesZone[];

A list of availability zones. Each element contains the following attributes:

interface InstanceArgs

interface InstanceArgs

The set of arguments for constructing a Instance resource.

property accountPassword

accountPassword?: pulumi.Input<string>;

Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.

property backupPeriods

backupPeriods?: pulumi.Input<pulumi.Input<string>[]>;

MongoDB Instance backup period. It is required when backupTime was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]

property backupTime

backupTime?: pulumi.Input<string>;

MongoDB instance backup time. It is required when backupPeriod 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”.

property dbInstanceClass

dbInstanceClass: pulumi.Input<string>;

Instance specification. see Instance specifications.

property dbInstanceStorage

dbInstanceStorage: pulumi.Input<number>;

User-defined DB instance storage space.Unit: GB. Value range: - Custom storage space; value range: [10,2000] - 10-GB increments.

property engineVersion

engineVersion: pulumi.Input<string>;

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

property instanceChargeType

instanceChargeType?: pulumi.Input<string>;

Valid values are PrePaid, PostPaid, System default to PostPaid. It can be modified from PostPaid to PrePaid after version 1.63.0.

property kmsEncryptedPassword

kmsEncryptedPassword?: pulumi.Input<string>;

An KMS encrypts password used to a instance. If the accountPassword is filled in, this field will be ignored.

property kmsEncryptionContext

kmsEncryptionContext?: pulumi.Input<{[key: string]: any}>;

An KMS encryption context used to decrypt kmsEncryptedPassword before creating or updating instance with kmsEncryptedPassword. See Encryption Context. It is valid when kmsEncryptedPassword is set.

property maintainEndTime

maintainEndTime?: pulumi.Input<string>;

The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

property maintainStartTime

maintainStartTime?: pulumi.Input<string>;

The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

property name

name?: pulumi.Input<string>;

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

property period

period?: pulumi.Input<number>;

The duration that you will buy DB instance (in month). It is valid when instanceChargeType is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.

property replicationFactor

replicationFactor?: pulumi.Input<number>;

Number of replica set nodes. Valid values: [3, 5, 7]

property securityGroupId

securityGroupId?: pulumi.Input<string>;

The Security Group ID of ECS.

property securityIpLists

securityIpLists?: pulumi.Input<pulumi.Input<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]).

property sslAction

sslAction?: pulumi.Input<string>;

Actions performed on SSL functions, Valid values: Open: turn on SSL encryption; Close: turn off SSL encryption; Update: update SSL certificate.

property storageEngine

storageEngine?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property tdeStatus

tdeStatus?: pulumi.Input<string>;

The TDE(Transparent Data Encryption) status.

property vswitchId

vswitchId?: pulumi.Input<string>;

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

property zoneId

zoneId?: pulumi.Input<string>;

The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitchId is specified, the vswitch must in one of them. The multiple zone ID can be retrieved by setting multi to “true” in the data source alicloud..getZones.

interface InstanceState

interface InstanceState

Input properties used for looking up and filtering Instance resources.

property accountPassword

accountPassword?: pulumi.Input<string>;

Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.

property backupPeriods

backupPeriods?: pulumi.Input<pulumi.Input<string>[]>;

MongoDB Instance backup period. It is required when backupTime was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]

property backupTime

backupTime?: pulumi.Input<string>;

MongoDB instance backup time. It is required when backupPeriod 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”.

property dbInstanceClass

dbInstanceClass?: pulumi.Input<string>;

Instance specification. see Instance specifications.

property dbInstanceStorage

dbInstanceStorage?: pulumi.Input<number>;

User-defined DB instance storage space.Unit: GB. Value range: - Custom storage space; value range: [10,2000] - 10-GB increments.

property engineVersion

engineVersion?: pulumi.Input<string>;

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

property instanceChargeType

instanceChargeType?: pulumi.Input<string>;

Valid values are PrePaid, PostPaid, System default to PostPaid. It can be modified from PostPaid to PrePaid after version 1.63.0.

property kmsEncryptedPassword

kmsEncryptedPassword?: pulumi.Input<string>;

An KMS encrypts password used to a instance. If the accountPassword is filled in, this field will be ignored.

property kmsEncryptionContext

kmsEncryptionContext?: pulumi.Input<{[key: string]: any}>;

An KMS encryption context used to decrypt kmsEncryptedPassword before creating or updating instance with kmsEncryptedPassword. See Encryption Context. It is valid when kmsEncryptedPassword is set.

property maintainEndTime

maintainEndTime?: pulumi.Input<string>;

The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

property maintainStartTime

maintainStartTime?: pulumi.Input<string>;

The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

property name

name?: pulumi.Input<string>;

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

property period

period?: pulumi.Input<number>;

The duration that you will buy DB instance (in month). It is valid when instanceChargeType is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.

property replicaSetName

replicaSetName?: pulumi.Input<string>;

The name of the mongo replica set

property replicationFactor

replicationFactor?: pulumi.Input<number>;

Number of replica set nodes. Valid values: [3, 5, 7]

property retentionPeriod

retentionPeriod?: pulumi.Input<number>;

Instance log backup retention days. Available in 1.42.0+.

property securityGroupId

securityGroupId?: pulumi.Input<string>;

The Security Group ID of ECS.

property securityIpLists

securityIpLists?: pulumi.Input<pulumi.Input<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]).

property sslAction

sslAction?: pulumi.Input<string>;

Actions performed on SSL functions, Valid values: Open: turn on SSL encryption; Close: turn off SSL encryption; Update: update SSL certificate.

property sslStatus

sslStatus?: pulumi.Input<string>;

Status of the SSL feature. Open: SSL is turned on; Closed: SSL is turned off.

property storageEngine

storageEngine?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property tdeStatus

tdeStatus?: pulumi.Input<string>;

The TDE(Transparent Data Encryption) status.

property vswitchId

vswitchId?: pulumi.Input<string>;

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

property zoneId

zoneId?: pulumi.Input<string>;

The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitchId is specified, the vswitch must in one of them. The multiple zone ID can be retrieved by setting multi to “true” in the data source alicloud..getZones.

interface ShardingInstanceArgs

interface ShardingInstanceArgs

The set of arguments for constructing a ShardingInstance resource.

property accountPassword

accountPassword?: pulumi.Input<string>;

Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.

property backupPeriods

backupPeriods?: pulumi.Input<pulumi.Input<string>[]>;

MongoDB Instance backup period. It is required when backupTime was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]

property backupTime

backupTime?: pulumi.Input<string>;

MongoDB instance backup time. It is required when backupPeriod 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”.

property engineVersion

engineVersion: pulumi.Input<string>;

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

property instanceChargeType

instanceChargeType?: pulumi.Input<string>;

Valid values are PrePaid, PostPaid,System default to PostPaid.

property kmsEncryptedPassword

kmsEncryptedPassword?: pulumi.Input<string>;

An KMS encrypts password used to a instance. If the accountPassword is filled in, this field will be ignored.

property kmsEncryptionContext

kmsEncryptionContext?: pulumi.Input<{[key: string]: any}>;

An KMS encryption context used to decrypt kmsEncryptedPassword before creating or updating instance with kmsEncryptedPassword. See Encryption Context. It is valid when kmsEncryptedPassword is set.

property mongoLists

mongoLists: pulumi.Input<pulumi.Input<ShardingInstanceMongoList>[]>;

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

property name

name?: pulumi.Input<string>;

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

property period

period?: pulumi.Input<number>;

The duration that you will buy DB instance (in month). It is valid when instanceChargeType is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.

property securityGroupId

securityGroupId?: pulumi.Input<string>;

The Security Group ID of ECS.

property securityIpLists

securityIpLists?: pulumi.Input<pulumi.Input<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"].

property shardLists

shardLists: pulumi.Input<pulumi.Input<ShardingInstanceShardList>[]>;

the shard-node count can be purchased is in range of [2, 32].

property storageEngine

storageEngine?: pulumi.Input<string>;

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

property tdeStatus

tdeStatus?: pulumi.Input<string>;

The TDE(Transparent Data Encryption) status.

property vswitchId

vswitchId?: pulumi.Input<string>;

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

property zoneId

zoneId?: pulumi.Input<string>;

The Zone to launch the DB instance. MongoDB sharding instance does not support multiple-zone. If it is a multi-zone and vswitchId is specified, the vswitch must in one of them.

interface ShardingInstanceState

interface ShardingInstanceState

Input properties used for looking up and filtering ShardingInstance resources.

property accountPassword

accountPassword?: pulumi.Input<string>;

Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.

property backupPeriods

backupPeriods?: pulumi.Input<pulumi.Input<string>[]>;

MongoDB Instance backup period. It is required when backupTime was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]

property backupTime

backupTime?: pulumi.Input<string>;

MongoDB instance backup time. It is required when backupPeriod 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”.

property engineVersion

engineVersion?: pulumi.Input<string>;

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

property instanceChargeType

instanceChargeType?: pulumi.Input<string>;

Valid values are PrePaid, PostPaid,System default to PostPaid.

property kmsEncryptedPassword

kmsEncryptedPassword?: pulumi.Input<string>;

An KMS encrypts password used to a instance. If the accountPassword is filled in, this field will be ignored.

property kmsEncryptionContext

kmsEncryptionContext?: pulumi.Input<{[key: string]: any}>;

An KMS encryption context used to decrypt kmsEncryptedPassword before creating or updating instance with kmsEncryptedPassword. See Encryption Context. It is valid when kmsEncryptedPassword is set.

property mongoLists

mongoLists?: pulumi.Input<pulumi.Input<ShardingInstanceMongoList>[]>;

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

property name

name?: pulumi.Input<string>;

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

property period

period?: pulumi.Input<number>;

The duration that you will buy DB instance (in month). It is valid when instanceChargeType is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.

property retentionPeriod

retentionPeriod?: pulumi.Input<number>;

Instance log backup retention days. Available in 1.42.0+.

property securityGroupId

securityGroupId?: pulumi.Input<string>;

The Security Group ID of ECS.

property securityIpLists

securityIpLists?: pulumi.Input<pulumi.Input<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"].

property shardLists

shardLists?: pulumi.Input<pulumi.Input<ShardingInstanceShardList>[]>;

the shard-node count can be purchased is in range of [2, 32].

property storageEngine

storageEngine?: pulumi.Input<string>;

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

property tdeStatus

tdeStatus?: pulumi.Input<string>;

The TDE(Transparent Data Encryption) status.

property vswitchId

vswitchId?: pulumi.Input<string>;

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

property zoneId

zoneId?: pulumi.Input<string>;

The Zone to launch the DB instance. MongoDB sharding instance does not support multiple-zone. If it is a multi-zone and vswitchId is specified, the vswitch must in one of them.