Skip to main content
Version: v1.9

Alibaba Cloud MONGODB


Alibaba Cloud MongoDB.


account_passwordPassword of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.stringtrue
backup_periodMongoDB 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].list(string)true
backup_timeMongoDB 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. Default to a random time, like '23:00Z-24:00Z'.stringfalse
createWhether to use an existing MongoDB. If false, you can use a existing Mongodb instance by setting existing_instance_id.boolfalse
db_instance_classThe specification of the instance. For more information about the value, see
db_instance_storageThe storage space of the instance. Valid values: 10 to 3000. Unit: GB. You can only specify this value in 10 GB increments.numberfalse
engine_versionThe version number of the database. Valid value: 3.4, 4.0, 4.2, 4.4, 5.0.stringtrue
existing_instance_idThe Id of an existing Mongodb instance. If set, the create will be ignored.stringfalse
instance_charge_typeThe billing method of the instance. Valid values are Prepaid, PostPaid, Default to PostPaid.stringfalse
instance_id(Deprecated) It has been deprecated from version 1.2.0 and use existing_instance_id instead.stringfalse
nameThe name of DB instance. It a string of 2 to 256 characters.stringtrue
periodThe 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. Default to 1.false
profile(Deprecated from version 1.4.0) The profile name as set in the shared credentials file. If not set, it will be sourced from the ALICLOUD_PROFILE environment variable.stringfalse
region(Deprecated from version 1.4.0) The region used to launch this module resources.stringfalse
replication_factorThe number of nodes in the replica set instance. Valid values: 3, 5, 7. Default value: 3.numberfalse
security_ip_listList 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, (IP), and (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]).list(string)false
shared_credentials_file(Deprecated from version 1.4.0) This is the path to the shared credentials file. If this is not set and a profile is specified, $HOME/.aliyun/config.json will be used.stringfalse
skip_region_validation(Deprecated from version 1.4.0) Skip static validation of region ID. Used by users of alternative AlibabaCloud-like APIs or users w/ access to regions that are not public (yet).boolfalse
storage_engineThe MongoDB storage engine, WiredTiger or RocksDB. Default value: WiredTiger.stringfalse
tagsA mapping of tags to assign to the mongodb instance
vswitch_idThe virtual switch ID to launch DB instances in one VPC.stringfalse
writeConnectionSecretToRefThe secret which the cloud resource connection will be written to.writeConnectionSecretToReffalse
zone_idThe ID of the zone. You can refer to


nameThe secret name which the cloud resource connection will be written to.stringtrue
namespaceThe secret namespace which the cloud resource connection will be written to.stringfalse