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.

mongodb¶

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.

class pulumi_alicloud.mongodb.AwaitableGetInstancesResult(availability_zone=None, id=None, ids=None, instance_class=None, instance_type=None, instances=None, name_regex=None, names=None, output_file=None, tags=None)¶

class pulumi_alicloud.mongodb.AwaitableGetZonesResult(id=None, ids=None, multi=None, output_file=None, zones=None)¶

class pulumi_alicloud.mongodb.GetInstancesResult(availability_zone=None, id=None, ids=None, instance_class=None, instance_type=None, instances=None, name_regex=None, names=None, output_file=None, tags=None)¶

A collection of values returned by getInstances.

availability_zone = None¶: Instance availability zone.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: The ids list of MongoDB instances

instance_class = None¶: Sizing of the MongoDB instance.

instance_type = None¶: Instance type. Optional values sharding or replicate.

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

names = None¶: The names list of MongoDB instances

class pulumi_alicloud.mongodb.GetZonesResult(id=None, ids=None, multi=None, output_file=None, zones=None)¶

A collection of values returned by getZones.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of zone IDs.

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

class pulumi_alicloud.mongodb.Instance(resource_name, opts=None, account_password=None, backup_periods=None, backup_time=None, db_instance_class=None, db_instance_storage=None, engine_version=None, instance_charge_type=None, kms_encrypted_password=None, kms_encryption_context=None, maintain_end_time=None, maintain_start_time=None, name=None, period=None, replication_factor=None, security_group_id=None, security_ip_lists=None, ssl_action=None, storage_engine=None, tags=None, tde_status=None, vswitch_id=None, zone_id=None, __props__=None, __name__=None, __opts__=None)¶

Create a Instance resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] account_password: Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines. :param pulumi.Input[list] backup_periods: 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] :param pulumi.Input[str] backup_time: 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”. :param pulumi.Input[str] db_instance_class: Instance specification. see Instance specifications. :param pulumi.Input[float] db_instance_storage: User-defined DB instance storage space.Unit: GB. Value range:

- Custom storage space; value range: [10,2000]
- 10-GB increments.

Parameters

engine_version (pulumi.Input[str]) – Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
instance_charge_type (pulumi.Input[str]) – Valid values are PrePaid, PostPaid, System default to PostPaid. It can be modified from PostPaid to PrePaid after version 1.63.0.
kms_encrypted_password (pulumi.Input[str]) – An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kms_encryption_context (pulumi.Input[dict]) – 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.
maintain_end_time (pulumi.Input[str]) – The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
maintain_start_time (pulumi.Input[str]) – The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
name (pulumi.Input[str]) – The name of DB instance. It a string of 2 to 256 characters.
period (pulumi.Input[float]) – 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.
replication_factor (pulumi.Input[float]) – Number of replica set nodes. Valid values: [3, 5, 7]
security_group_id (pulumi.Input[str]) – The Security Group ID of ECS.
security_ip_lists (pulumi.Input[list]) – 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]).
ssl_action (pulumi.Input[str]) – Actions performed on SSL functions, Valid values: Open: turn on SSL encryption; Close: turn off SSL encryption; Update: update SSL certificate.
storage_engine (pulumi.Input[str]) – Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
tde_status (pulumi.Input[str]) – The TDE(Transparent Data Encryption) status.
vswitch_id (pulumi.Input[str]) – The virtual switch ID to launch DB instances in one VPC.
zone_id (pulumi.Input[str]) – The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitch_id 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 .getZones.

account_password: pulumi.Output[str] = None¶: Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.

backup_periods: pulumi.Output[list] = None¶: 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: pulumi.Output[str] = None¶: 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”.

db_instance_class: pulumi.Output[str] = None¶: Instance specification. see Instance specifications.

db_instance_storage: pulumi.Output[float] = None¶

User-defined DB instance storage space.Unit: GB. Value range:

Custom storage space; value range: [10,2000]
10-GB increments.

engine_version: pulumi.Output[str] = None¶: Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

instance_charge_type: pulumi.Output[str] = None¶: Valid values are PrePaid, PostPaid, System default to PostPaid. It can be modified from PostPaid to PrePaid after version 1.63.0.

kms_encrypted_password: pulumi.Output[str] = None¶: An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.

kms_encryption_context: pulumi.Output[dict] = None¶: 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.

maintain_end_time: pulumi.Output[str] = None¶: The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

maintain_start_time: pulumi.Output[str] = None¶: The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).

name: pulumi.Output[str] = None¶: The name of DB instance. It a string of 2 to 256 characters.

period: pulumi.Output[float] = None¶: 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.

replica_set_name: pulumi.Output[str] = None¶: The name of the mongo replica set

replication_factor: pulumi.Output[float] = None¶: Number of replica set nodes. Valid values: [3, 5, 7]

retention_period: pulumi.Output[float] = None¶: Instance log backup retention days. Available in 1.42.0+.

security_group_id: pulumi.Output[str] = None¶: The Security Group ID of ECS.

security_ip_lists: pulumi.Output[list] = None¶: 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]).

ssl_action: pulumi.Output[str] = None¶: Actions performed on SSL functions, Valid values: Open: turn on SSL encryption; Close: turn off SSL encryption; Update: update SSL certificate.

ssl_status: pulumi.Output[str] = None¶: Status of the SSL feature. Open: SSL is turned on; Closed: SSL is turned off.

storage_engine: pulumi.Output[str] = None¶: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

tde_status: pulumi.Output[str] = None¶: The TDE(Transparent Data Encryption) status.

vswitch_id: pulumi.Output[str] = None¶: The virtual switch ID to launch DB instances in one VPC.

zone_id: pulumi.Output[str] = None¶: The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitch_id 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 .getZones.

static get(resource_name, id, opts=None, account_password=None, backup_periods=None, backup_time=None, db_instance_class=None, db_instance_storage=None, engine_version=None, instance_charge_type=None, kms_encrypted_password=None, kms_encryption_context=None, maintain_end_time=None, maintain_start_time=None, name=None, period=None, replica_set_name=None, replication_factor=None, retention_period=None, security_group_id=None, security_ip_lists=None, ssl_action=None, ssl_status=None, storage_engine=None, tags=None, tde_status=None, vswitch_id=None, zone_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
account_password (pulumi.Input[str]) – Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
backup_periods (pulumi.Input[list]) – 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 (pulumi.Input[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”.
db_instance_class (pulumi.Input[str]) –
Instance specification. see Instance specifications.
db_instance_storage (pulumi.Input[float]) – User-defined DB instance storage space.Unit: GB. Value range:

- Custom storage space; value range: [10,2000]
- 10-GB increments.

Parameters

engine_version (pulumi.Input[str]) –
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
instance_charge_type (pulumi.Input[str]) – Valid values are PrePaid, PostPaid, System default to PostPaid. It can be modified from PostPaid to PrePaid after version 1.63.0.
kms_encrypted_password (pulumi.Input[str]) – An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kms_encryption_context (pulumi.Input[dict]) –
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.
maintain_end_time (pulumi.Input[str]) – The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
maintain_start_time (pulumi.Input[str]) – The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
name (pulumi.Input[str]) – The name of DB instance. It a string of 2 to 256 characters.
period (pulumi.Input[float]) – 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.
replica_set_name (pulumi.Input[str]) – The name of the mongo replica set
replication_factor (pulumi.Input[float]) – Number of replica set nodes. Valid values: [3, 5, 7]
retention_period (pulumi.Input[float]) – Instance log backup retention days. Available in 1.42.0+.
security_group_id (pulumi.Input[str]) – The Security Group ID of ECS.
security_ip_lists (pulumi.Input[list]) – 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]).
ssl_action (pulumi.Input[str]) – Actions performed on SSL functions, Valid values: Open: turn on SSL encryption; Close: turn off SSL encryption; Update: update SSL certificate.
ssl_status (pulumi.Input[str]) – Status of the SSL feature. Open: SSL is turned on; Closed: SSL is turned off.
storage_engine (pulumi.Input[str]) – Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
tde_status (pulumi.Input[str]) – The TDE(Transparent Data Encryption) status.
vswitch_id (pulumi.Input[str]) – The virtual switch ID to launch DB instances in one VPC.
zone_id (pulumi.Input[str]) – The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitch_id 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 .getZones.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.mongodb.ShardingInstance(resource_name, opts=None, account_password=None, backup_periods=None, backup_time=None, engine_version=None, instance_charge_type=None, kms_encrypted_password=None, kms_encryption_context=None, mongo_lists=None, name=None, period=None, security_group_id=None, security_ip_lists=None, shard_lists=None, storage_engine=None, tde_status=None, vswitch_id=None, zone_id=None, __props__=None, __name__=None, __opts__=None)¶

Create a ShardingInstance resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] account_password: Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines. :param pulumi.Input[list] backup_periods: 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] :param pulumi.Input[str] backup_time: 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”. :param pulumi.Input[str] engine_version: Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. :param pulumi.Input[str] instance_charge_type: Valid values are PrePaid, PostPaid,System default to PostPaid. :param pulumi.Input[str] kms_encrypted_password: An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored. :param pulumi.Input[dict] kms_encryption_context: 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. :param pulumi.Input[list] mongo_lists: The mongo-node count can be purchased is in range of [2, 32]. :param pulumi.Input[str] name: The name of DB instance. It a string of 2 to 256 characters. :param pulumi.Input[float] period: 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. :param pulumi.Input[str] security_group_id: The Security Group ID of ECS. :param pulumi.Input[list] security_ip_lists: 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"]. :param pulumi.Input[list] shard_lists: the shard-node count can be purchased is in range of [2, 32]. :param pulumi.Input[str] storage_engine: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger. :param pulumi.Input[str] tde_status: The TDE(Transparent Data Encryption) status. :param pulumi.Input[str] vswitch_id: The virtual switch ID to launch DB instances in one VPC. :param pulumi.Input[str] zone_id: 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.

The mongo_lists object supports the following:

connectString (pulumi.Input[str]) - Mongo node connection string
nodeClass (pulumi.Input[str]) - -(Required) Node specification. see Instance specifications.
nodeId (pulumi.Input[str]) - The ID of the shard-node.
port (pulumi.Input[float]) - Mongo node port
- shard_list

The shard_lists object supports the following:

nodeClass (pulumi.Input[str]) - -(Required) Node specification. see Instance specifications.
nodeId (pulumi.Input[str]) - The ID of the shard-node.
nodeStorage (pulumi.Input[float]) -
- Custom storage space; value range: [10, 1,000]
- 10-GB increments. Unit: GB.

account_password: pulumi.Output[str] = None¶: Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.

backup_periods: pulumi.Output[list] = None¶: 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: pulumi.Output[str] = None¶: 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”.

engine_version: pulumi.Output[str] = None¶: Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.

instance_charge_type: pulumi.Output[str] = None¶: Valid values are PrePaid, PostPaid,System default to PostPaid.

kms_encrypted_password: pulumi.Output[str] = None¶: An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.

kms_encryption_context: pulumi.Output[dict] = None¶: 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: pulumi.Output[list] = None¶

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

connectString (str) - Mongo node connection string
nodeClass (str) - -(Required) Node specification. see Instance specifications.
nodeId (str) - The ID of the shard-node.
port (float) - Mongo node port
- shard_list

name: pulumi.Output[str] = None¶: The name of DB instance. It a string of 2 to 256 characters.

period: pulumi.Output[float] = None¶: 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.

retention_period: pulumi.Output[float] = None¶: Instance log backup retention days. Available in 1.42.0+.

security_group_id: pulumi.Output[str] = None¶: The Security Group ID of ECS.

security_ip_lists: pulumi.Output[list] = None¶: 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: pulumi.Output[list] = None¶

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

nodeClass (str) - -(Required) Node specification. see Instance specifications.
nodeId (str) - The ID of the shard-node.
nodeStorage (float) -
- Custom storage space; value range: [10, 1,000]
- 10-GB increments. Unit: GB.

storage_engine: pulumi.Output[str] = None¶: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.

tde_status: pulumi.Output[str] = None¶: The TDE(Transparent Data Encryption) status.

vswitch_id: pulumi.Output[str] = None¶: The virtual switch ID to launch DB instances in one VPC.

zone_id: pulumi.Output[str] = None¶: 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.

static get(resource_name, id, opts=None, account_password=None, backup_periods=None, backup_time=None, engine_version=None, instance_charge_type=None, kms_encrypted_password=None, kms_encryption_context=None, mongo_lists=None, name=None, period=None, retention_period=None, security_group_id=None, security_ip_lists=None, shard_lists=None, storage_engine=None, tde_status=None, vswitch_id=None, zone_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
account_password (pulumi.Input[str]) – Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
backup_periods (pulumi.Input[list]) – 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 (pulumi.Input[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”.
engine_version (pulumi.Input[str]) –
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
instance_charge_type (pulumi.Input[str]) – Valid values are PrePaid, PostPaid,System default to PostPaid.
kms_encrypted_password (pulumi.Input[str]) – An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kms_encryption_context (pulumi.Input[dict]) –
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 (pulumi.Input[list]) – The mongo-node count can be purchased is in range of [2, 32].
name (pulumi.Input[str]) – The name of DB instance. It a string of 2 to 256 characters.
period (pulumi.Input[float]) – 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.
retention_period (pulumi.Input[float]) – Instance log backup retention days. Available in 1.42.0+.
security_group_id (pulumi.Input[str]) – The Security Group ID of ECS.
security_ip_lists (pulumi.Input[list]) – 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 (pulumi.Input[list]) – the shard-node count can be purchased is in range of [2, 32].
storage_engine (pulumi.Input[str]) – Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
tde_status (pulumi.Input[str]) – The TDE(Transparent Data Encryption) status.
vswitch_id (pulumi.Input[str]) – The virtual switch ID to launch DB instances in one VPC.
zone_id (pulumi.Input[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.

The mongo_lists object supports the following:

connectString (pulumi.Input[str]) - Mongo node connection string
nodeClass (pulumi.Input[str]) - -(Required) Node specification. see Instance specifications.
nodeId (pulumi.Input[str]) - The ID of the shard-node.
port (pulumi.Input[float]) - Mongo node port
- shard_list

The shard_lists object supports the following:

nodeClass (pulumi.Input[str]) - -(Required) Node specification. see Instance specifications.
nodeId (pulumi.Input[str]) - The ID of the shard-node.
nodeStorage (pulumi.Input[float]) -
- Custom storage space; value range: [10, 1,000]
- 10-GB increments. Unit: GB.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_alicloud.mongodb.get_instances(availability_zone=None, ids=None, instance_class=None, instance_type=None, name_regex=None, output_file=None, tags=None, opts=None)¶

The 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.

import pulumi
import pulumi_alicloud as alicloud

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

Parameters

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

pulumi_alicloud.mongodb.get_zones(multi=None, output_file=None, opts=None)¶

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+.

import pulumi
import pulumi_alicloud as alicloud

zones_ids = alicloud.mongodb.get_zones()
# Create an mongoDB instance with the first matched zone
mongodb = alicloud.mongodb.Instance("mongodb", zone_id=zones_ids.zones[0]["id"])
# Other properties...

Parameters: multi (bool) – Indicate whether the zones can be used in a multi AZ configuration. Default to false. Multi AZ is usually used to launch MongoDB instances.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

mongodb¶

On This Page