alicloud.mongodb.Instance
Explore with Pulumi AI
Provides a MongoDB 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.37.0.
NOTE: The following regions don’t support create Classic network MongoDB 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 instance or change instance type and storage would cost 5~10 minutes. Please make full preparation
Module Support
You can use to the existing mongodb module to create a MongoDB instance resource one-click.
Example Usage
Create a Mongodb 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 defaultInstance = new AliCloud.MongoDB.Instance("defaultInstance", new()
{
EngineVersion = "4.2",
DbInstanceClass = "dds.mongo.mid",
DbInstanceStorage = 10,
VswitchId = defaultSwitch.Id,
SecurityIpLists = new[]
{
"10.168.1.12",
"100.69.7.112",
},
Tags =
{
{ "Created", "TF" },
{ "For", "example" },
},
});
});
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.NewInstance(ctx, "defaultInstance", &mongodb.InstanceArgs{
EngineVersion: pulumi.String("4.2"),
DbInstanceClass: pulumi.String("dds.mongo.mid"),
DbInstanceStorage: pulumi.Int(10),
VswitchId: defaultSwitch.ID(),
SecurityIpLists: pulumi.StringArray{
pulumi.String("10.168.1.12"),
pulumi.String("100.69.7.112"),
},
Tags: pulumi.Map{
"Created": pulumi.Any("TF"),
"For": pulumi.Any("example"),
},
})
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.Instance;
import com.pulumi.alicloud.mongodb.InstanceArgs;
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 defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
.engineVersion("4.2")
.dbInstanceClass("dds.mongo.mid")
.dbInstanceStorage(10)
.vswitchId(defaultSwitch.id())
.securityIpLists(
"10.168.1.12",
"100.69.7.112")
.tags(Map.ofEntries(
Map.entry("Created", "TF"),
Map.entry("For", "example")
))
.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_instance = alicloud.mongodb.Instance("defaultInstance",
engine_version="4.2",
db_instance_class="dds.mongo.mid",
db_instance_storage=10,
vswitch_id=default_switch.id,
security_ip_lists=[
"10.168.1.12",
"100.69.7.112",
],
tags={
"Created": "TF",
"For": "example",
})
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 defaultInstance = new alicloud.mongodb.Instance("defaultInstance", {
engineVersion: "4.2",
dbInstanceClass: "dds.mongo.mid",
dbInstanceStorage: 10,
vswitchId: defaultSwitch.id,
securityIpLists: [
"10.168.1.12",
"100.69.7.112",
],
tags: {
Created: "TF",
For: "example",
},
});
Coming soon!
Create Instance Resource
new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
@overload
def Instance(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_password: Optional[str] = None,
auto_renew: Optional[bool] = None,
backup_interval: Optional[str] = None,
backup_periods: Optional[Sequence[str]] = None,
backup_time: Optional[str] = None,
cloud_disk_encryption_key: Optional[str] = None,
db_instance_class: Optional[str] = None,
db_instance_storage: Optional[int] = None,
encrypted: Optional[bool] = None,
encryption_key: Optional[str] = None,
encryptor_name: Optional[str] = None,
engine_version: Optional[str] = None,
hidden_zone_id: Optional[str] = None,
instance_charge_type: Optional[str] = None,
kms_encrypted_password: Optional[str] = None,
kms_encryption_context: Optional[Mapping[str, Any]] = None,
maintain_end_time: Optional[str] = None,
maintain_start_time: Optional[str] = None,
name: Optional[str] = None,
network_type: Optional[str] = None,
order_type: Optional[str] = None,
parameters: Optional[Sequence[InstanceParameterArgs]] = None,
period: Optional[int] = None,
readonly_replicas: Optional[int] = None,
replication_factor: Optional[int] = None,
resource_group_id: Optional[str] = None,
role_arn: Optional[str] = None,
secondary_zone_id: Optional[str] = None,
security_group_id: Optional[str] = None,
security_ip_lists: Optional[Sequence[str]] = None,
snapshot_backup_type: Optional[str] = None,
ssl_action: Optional[str] = None,
storage_engine: Optional[str] = None,
storage_type: 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 Instance(resource_name: str,
args: InstanceArgs,
opts: Optional[ResourceOptions] = None)
func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)
type: alicloud:mongodb:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstanceArgs
- 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 InstanceArgs
- 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 InstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Instance 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 Instance resource accepts the following input properties:
- Db
Instance stringClass Instance specification. see Instance specifications.
- Db
Instance intStorage User-defined DB instance storage space.Unit: GB. Value range:
- Custom storage space.
- 10-GB increments.
- Engine
Version string Database version. Value options can refer to the latest docs CreateDBInstance
EngineVersion
.- Account
Password string Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
- Auto
Renew bool Auto renew for prepaid. Default value:
false
. Valid values:true
,false
.NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.
- Backup
Interval string The frequency at which high-frequency backups are created. Valid values:
-1
,15
,30
,60
,120
,180
,240
,360
,480
,720
.- Backup
Periods 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]- Backup
Time 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".- Cloud
Disk stringEncryption Key The ID of the encryption key.
- Encrypted bool
Whether to enable cloud disk encryption. Default value:
false
. Valid values:true
,false
.- Encryption
Key string - Encryptor
Name string The encryption method. NOTE:
encryptor_name
is valid only whentde_status
is set toenabled
.- string
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as
zone_id
andsecondary_zone_id
parameter values.- Instance
Charge stringType The billing method of the instance. Default value:
PostPaid
. Valid values:PrePaid
,PostPaid
. NOTE: It can be modified fromPostPaid
toPrePaid
after version 1.63.0.- Kms
Encrypted stringPassword An KMS encrypts password used to a instance. If the
account_password
is filled in, this field will be ignored.- Kms
Encryption Dictionary<string, object>Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- Maintain
End stringTime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- Maintain
Start stringTime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- Name string
The name of DB instance. It a string of 2 to 256 characters.
- Network
Type string The network type of the instance. Valid values:
Classic
,VPC
.- Order
Type string The type of configuration changes performed. Default value:
DOWNGRADE
. Valid values:- Parameters
List<Pulumi.
Ali Cloud. Mongo DB. Inputs. Instance Parameter> Set of parameters needs to be set after mongodb instance was launched. See
parameters
below.- Period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid
. Default value:1
. Valid values: [1~9], 12, 24, 36.- Readonly
Replicas int The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
- Replication
Factor int Number of replica set nodes. Valid values:
1
,3
,5
,7
.- Resource
Group stringId The ID of the Resource Group.
- Role
Arn string - Secondary
Zone stringId Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as
zone_id
andhidden_zone_id
parameter values.- Security
Group stringId The Security Group ID of ECS.
- Security
Ip List<string>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]).
- Snapshot
Backup stringType The snapshot backup type. Default value:
Standard
. Valid values:- Ssl
Action string Actions performed on SSL functions. Valid values:
- Storage
Engine string The storage engine of the instance. Default value:
WiredTiger
. Valid values:WiredTiger
,RocksDB
.- Storage
Type string The storage type of the instance. Valid values:
cloud_essd1
,cloud_essd2
,cloud_essd3
,local_ssd
.- Dictionary<string, object>
A mapping of tags to assign to the resource.
- Tde
Status string The TDE(Transparent Data Encryption) status. Valid values:
enabled
.- Vpc
Id string The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- Vswitch
Id string The virtual switch ID to launch DB instances in one VPC.
- Zone
Id string 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 settingmulti
to "true" in the data sourcealicloud.getZones
.
- Db
Instance stringClass Instance specification. see Instance specifications.
- Db
Instance intStorage User-defined DB instance storage space.Unit: GB. Value range:
- Custom storage space.
- 10-GB increments.
- Engine
Version string Database version. Value options can refer to the latest docs CreateDBInstance
EngineVersion
.- Account
Password string Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
- Auto
Renew bool Auto renew for prepaid. Default value:
false
. Valid values:true
,false
.NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.
- Backup
Interval string The frequency at which high-frequency backups are created. Valid values:
-1
,15
,30
,60
,120
,180
,240
,360
,480
,720
.- Backup
Periods []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]- Backup
Time 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".- Cloud
Disk stringEncryption Key The ID of the encryption key.
- Encrypted bool
Whether to enable cloud disk encryption. Default value:
false
. Valid values:true
,false
.- Encryption
Key string - Encryptor
Name string The encryption method. NOTE:
encryptor_name
is valid only whentde_status
is set toenabled
.- string
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as
zone_id
andsecondary_zone_id
parameter values.- Instance
Charge stringType The billing method of the instance. Default value:
PostPaid
. Valid values:PrePaid
,PostPaid
. NOTE: It can be modified fromPostPaid
toPrePaid
after version 1.63.0.- Kms
Encrypted stringPassword An KMS encrypts password used to a instance. If the
account_password
is filled in, this field will be ignored.- Kms
Encryption map[string]interface{}Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- Maintain
End stringTime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- Maintain
Start stringTime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- Name string
The name of DB instance. It a string of 2 to 256 characters.
- Network
Type string The network type of the instance. Valid values:
Classic
,VPC
.- Order
Type string The type of configuration changes performed. Default value:
DOWNGRADE
. Valid values:- Parameters
[]Instance
Parameter Args Set of parameters needs to be set after mongodb instance was launched. See
parameters
below.- Period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid
. Default value:1
. Valid values: [1~9], 12, 24, 36.- Readonly
Replicas int The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
- Replication
Factor int Number of replica set nodes. Valid values:
1
,3
,5
,7
.- Resource
Group stringId The ID of the Resource Group.
- Role
Arn string - Secondary
Zone stringId Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as
zone_id
andhidden_zone_id
parameter values.- Security
Group stringId The Security Group ID of ECS.
- Security
Ip []stringLists 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]).
- Snapshot
Backup stringType The snapshot backup type. Default value:
Standard
. Valid values:- Ssl
Action string Actions performed on SSL functions. Valid values:
- Storage
Engine string The storage engine of the instance. Default value:
WiredTiger
. Valid values:WiredTiger
,RocksDB
.- Storage
Type string The storage type of the instance. Valid values:
cloud_essd1
,cloud_essd2
,cloud_essd3
,local_ssd
.- map[string]interface{}
A mapping of tags to assign to the resource.
- Tde
Status string The TDE(Transparent Data Encryption) status. Valid values:
enabled
.- Vpc
Id string The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- Vswitch
Id string The virtual switch ID to launch DB instances in one VPC.
- Zone
Id string 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 settingmulti
to "true" in the data sourcealicloud.getZones
.
- db
Instance StringClass Instance specification. see Instance specifications.
- db
Instance IntegerStorage User-defined DB instance storage space.Unit: GB. Value range:
- Custom storage space.
- 10-GB increments.
- engine
Version String Database version. Value options can refer to the latest docs CreateDBInstance
EngineVersion
.- account
Password String Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
- auto
Renew Boolean Auto renew for prepaid. Default value:
false
. Valid values:true
,false
.NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.
- backup
Interval String The frequency at which high-frequency backups are created. Valid values:
-1
,15
,30
,60
,120
,180
,240
,360
,480
,720
.- backup
Periods 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]- backup
Time 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".- cloud
Disk StringEncryption Key The ID of the encryption key.
- encrypted Boolean
Whether to enable cloud disk encryption. Default value:
false
. Valid values:true
,false
.- encryption
Key String - encryptor
Name String The encryption method. NOTE:
encryptor_name
is valid only whentde_status
is set toenabled
.- String
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as
zone_id
andsecondary_zone_id
parameter values.- instance
Charge StringType The billing method of the instance. Default value:
PostPaid
. Valid values:PrePaid
,PostPaid
. NOTE: It can be modified fromPostPaid
toPrePaid
after version 1.63.0.- kms
Encrypted StringPassword An KMS encrypts password used to a instance. If the
account_password
is filled in, this field will be ignored.- kms
Encryption Map<String,Object>Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- maintain
End StringTime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- maintain
Start StringTime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- name String
The name of DB instance. It a string of 2 to 256 characters.
- network
Type String The network type of the instance. Valid values:
Classic
,VPC
.- order
Type String The type of configuration changes performed. Default value:
DOWNGRADE
. Valid values:- parameters
List<Instance
Parameter> Set of parameters needs to be set after mongodb instance was launched. See
parameters
below.- period Integer
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid
. Default value:1
. Valid values: [1~9], 12, 24, 36.- readonly
Replicas Integer The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
- replication
Factor Integer Number of replica set nodes. Valid values:
1
,3
,5
,7
.- resource
Group StringId The ID of the Resource Group.
- role
Arn String - secondary
Zone StringId Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as
zone_id
andhidden_zone_id
parameter values.- security
Group StringId The Security Group ID of ECS.
- security
Ip List<String>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]).
- snapshot
Backup StringType The snapshot backup type. Default value:
Standard
. Valid values:- ssl
Action String Actions performed on SSL functions. Valid values:
- storage
Engine String The storage engine of the instance. Default value:
WiredTiger
. Valid values:WiredTiger
,RocksDB
.- storage
Type String The storage type of the instance. Valid values:
cloud_essd1
,cloud_essd2
,cloud_essd3
,local_ssd
.- Map<String,Object>
A mapping of tags to assign to the resource.
- tde
Status String The TDE(Transparent Data Encryption) status. Valid values:
enabled
.- vpc
Id String The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- vswitch
Id String The virtual switch ID to launch DB instances in one VPC.
- zone
Id String 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 settingmulti
to "true" in the data sourcealicloud.getZones
.
- db
Instance stringClass Instance specification. see Instance specifications.
- db
Instance numberStorage User-defined DB instance storage space.Unit: GB. Value range:
- Custom storage space.
- 10-GB increments.
- engine
Version string Database version. Value options can refer to the latest docs CreateDBInstance
EngineVersion
.- account
Password string Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
- auto
Renew boolean Auto renew for prepaid. Default value:
false
. Valid values:true
,false
.NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.
- backup
Interval string The frequency at which high-frequency backups are created. Valid values:
-1
,15
,30
,60
,120
,180
,240
,360
,480
,720
.- backup
Periods 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]- backup
Time 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".- cloud
Disk stringEncryption Key The ID of the encryption key.
- encrypted boolean
Whether to enable cloud disk encryption. Default value:
false
. Valid values:true
,false
.- encryption
Key string - encryptor
Name string The encryption method. NOTE:
encryptor_name
is valid only whentde_status
is set toenabled
.- string
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as
zone_id
andsecondary_zone_id
parameter values.- instance
Charge stringType The billing method of the instance. Default value:
PostPaid
. Valid values:PrePaid
,PostPaid
. NOTE: It can be modified fromPostPaid
toPrePaid
after version 1.63.0.- kms
Encrypted stringPassword An KMS encrypts password used to a instance. If the
account_password
is filled in, this field will be ignored.- kms
Encryption {[key: string]: any}Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- maintain
End stringTime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- maintain
Start stringTime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- name string
The name of DB instance. It a string of 2 to 256 characters.
- network
Type string The network type of the instance. Valid values:
Classic
,VPC
.- order
Type string The type of configuration changes performed. Default value:
DOWNGRADE
. Valid values:- parameters
Instance
Parameter[] Set of parameters needs to be set after mongodb instance was launched. See
parameters
below.- period number
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid
. Default value:1
. Valid values: [1~9], 12, 24, 36.- readonly
Replicas number The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
- replication
Factor number Number of replica set nodes. Valid values:
1
,3
,5
,7
.- resource
Group stringId The ID of the Resource Group.
- role
Arn string - secondary
Zone stringId Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as
zone_id
andhidden_zone_id
parameter values.- security
Group stringId The Security Group ID of ECS.
- security
Ip string[]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]).
- snapshot
Backup stringType The snapshot backup type. Default value:
Standard
. Valid values:- ssl
Action string Actions performed on SSL functions. Valid values:
- storage
Engine string The storage engine of the instance. Default value:
WiredTiger
. Valid values:WiredTiger
,RocksDB
.- storage
Type string The storage type of the instance. Valid values:
cloud_essd1
,cloud_essd2
,cloud_essd3
,local_ssd
.- {[key: string]: any}
A mapping of tags to assign to the resource.
- tde
Status string The TDE(Transparent Data Encryption) status. Valid values:
enabled
.- vpc
Id string The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- vswitch
Id string The virtual switch ID to launch DB instances in one VPC.
- zone
Id string 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 settingmulti
to "true" in the data sourcealicloud.getZones
.
- db_
instance_ strclass Instance specification. see Instance specifications.
- db_
instance_ intstorage User-defined DB instance storage space.Unit: GB. Value range:
- Custom storage space.
- 10-GB increments.
- engine_
version str Database version. Value options can refer to the latest docs CreateDBInstance
EngineVersion
.- account_
password str Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
- auto_
renew bool Auto renew for prepaid. Default value:
false
. Valid values:true
,false
.NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.
- backup_
interval str The frequency at which high-frequency backups are created. Valid values:
-1
,15
,30
,60
,120
,180
,240
,360
,480
,720
.- 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".- cloud_
disk_ strencryption_ key The ID of the encryption key.
- encrypted bool
Whether to enable cloud disk encryption. Default value:
false
. Valid values:true
,false
.- encryption_
key str - encryptor_
name str The encryption method. NOTE:
encryptor_name
is valid only whentde_status
is set toenabled
.- str
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as
zone_id
andsecondary_zone_id
parameter values.- instance_
charge_ strtype The billing method of the instance. Default value:
PostPaid
. Valid values:PrePaid
,PostPaid
. NOTE: It can be modified fromPostPaid
toPrePaid
after version 1.63.0.- kms_
encrypted_ strpassword An KMS encrypts password used to a instance. If the
account_password
is filled in, this field will be ignored.- kms_
encryption_ Mapping[str, Any]context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- maintain_
end_ strtime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- maintain_
start_ strtime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- 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
,VPC
.- order_
type str The type of configuration changes performed. Default value:
DOWNGRADE
. Valid values:- parameters
Sequence[Instance
Parameter Args] Set of parameters needs to be set after mongodb instance was launched. See
parameters
below.- period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid
. Default value:1
. Valid values: [1~9], 12, 24, 36.- readonly_
replicas int The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
- replication_
factor int Number of replica set nodes. Valid values:
1
,3
,5
,7
.- resource_
group_ strid The ID of the Resource Group.
- role_
arn str - secondary_
zone_ strid Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as
zone_id
andhidden_zone_id
parameter values.- security_
group_ strid The Security Group ID of ECS.
- security_
ip_ Sequence[str]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]).
- snapshot_
backup_ strtype The snapshot backup type. Default value:
Standard
. Valid values:- ssl_
action str Actions performed on SSL functions. Valid values:
- storage_
engine str The storage engine of the instance. Default value:
WiredTiger
. Valid values:WiredTiger
,RocksDB
.- storage_
type str The storage type of the instance. Valid values:
cloud_essd1
,cloud_essd2
,cloud_essd3
,local_ssd
.- Mapping[str, Any]
A mapping of tags to assign to the resource.
- tde_
status str The TDE(Transparent Data Encryption) status. Valid values:
enabled
.- vpc_
id str The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- vswitch_
id str The virtual switch ID to launch DB instances in one VPC.
- zone_
id 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 settingmulti
to "true" in the data sourcealicloud.getZones
.
- db
Instance StringClass Instance specification. see Instance specifications.
- db
Instance NumberStorage User-defined DB instance storage space.Unit: GB. Value range:
- Custom storage space.
- 10-GB increments.
- engine
Version String Database version. Value options can refer to the latest docs CreateDBInstance
EngineVersion
.- account
Password String Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
- auto
Renew Boolean Auto renew for prepaid. Default value:
false
. Valid values:true
,false
.NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.
- backup
Interval String The frequency at which high-frequency backups are created. Valid values:
-1
,15
,30
,60
,120
,180
,240
,360
,480
,720
.- backup
Periods 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]- backup
Time 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".- cloud
Disk StringEncryption Key The ID of the encryption key.
- encrypted Boolean
Whether to enable cloud disk encryption. Default value:
false
. Valid values:true
,false
.- encryption
Key String - encryptor
Name String The encryption method. NOTE:
encryptor_name
is valid only whentde_status
is set toenabled
.- String
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as
zone_id
andsecondary_zone_id
parameter values.- instance
Charge StringType The billing method of the instance. Default value:
PostPaid
. Valid values:PrePaid
,PostPaid
. NOTE: It can be modified fromPostPaid
toPrePaid
after version 1.63.0.- kms
Encrypted StringPassword An KMS encrypts password used to a instance. If the
account_password
is filled in, this field will be ignored.- kms
Encryption Map<Any>Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- maintain
End StringTime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- maintain
Start StringTime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- name String
The name of DB instance. It a string of 2 to 256 characters.
- network
Type String The network type of the instance. Valid values:
Classic
,VPC
.- order
Type String The type of configuration changes performed. Default value:
DOWNGRADE
. Valid values:- parameters List<Property Map>
Set of parameters needs to be set after mongodb instance was launched. See
parameters
below.- period Number
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid
. Default value:1
. Valid values: [1~9], 12, 24, 36.- readonly
Replicas Number The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
- replication
Factor Number Number of replica set nodes. Valid values:
1
,3
,5
,7
.- resource
Group StringId The ID of the Resource Group.
- role
Arn String - secondary
Zone StringId Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as
zone_id
andhidden_zone_id
parameter values.- security
Group StringId The Security Group ID of ECS.
- security
Ip List<String>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]).
- snapshot
Backup StringType The snapshot backup type. Default value:
Standard
. Valid values:- ssl
Action String Actions performed on SSL functions. Valid values:
- storage
Engine String The storage engine of the instance. Default value:
WiredTiger
. Valid values:WiredTiger
,RocksDB
.- storage
Type String The storage type of the instance. Valid values:
cloud_essd1
,cloud_essd2
,cloud_essd3
,local_ssd
.- Map<Any>
A mapping of tags to assign to the resource.
- tde
Status String The TDE(Transparent Data Encryption) status. Valid values:
enabled
.- vpc
Id String The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- vswitch
Id String The virtual switch ID to launch DB instances in one VPC.
- zone
Id String 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 settingmulti
to "true" in the data sourcealicloud.getZones
.
Outputs
All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Replica
Set stringName The name of the mongo replica set.
- Replica
Sets List<Pulumi.Ali Cloud. Mongo DB. Outputs. Instance Replica Set> Replica set instance information.
- Retention
Period int Instance data backup retention days. Available since v1.42.0.
- Ssl
Status string Status of the SSL feature.
- Id string
The provider-assigned unique ID for this managed resource.
- Replica
Set stringName The name of the mongo replica set.
- Replica
Sets []InstanceReplica Set Replica set instance information.
- Retention
Period int Instance data backup retention days. Available since v1.42.0.
- Ssl
Status string Status of the SSL feature.
- id String
The provider-assigned unique ID for this managed resource.
- replica
Set StringName The name of the mongo replica set.
- replica
Sets List<InstanceReplica Set> Replica set instance information.
- retention
Period Integer Instance data backup retention days. Available since v1.42.0.
- ssl
Status String Status of the SSL feature.
- id string
The provider-assigned unique ID for this managed resource.
- replica
Set stringName The name of the mongo replica set.
- replica
Sets InstanceReplica Set[] Replica set instance information.
- retention
Period number Instance data backup retention days. Available since v1.42.0.
- ssl
Status string Status of the SSL feature.
- id str
The provider-assigned unique ID for this managed resource.
- replica_
set_ strname The name of the mongo replica set.
- replica_
sets Sequence[InstanceReplica Set] Replica set instance information.
- retention_
period int Instance data backup retention days. Available since v1.42.0.
- ssl_
status str Status of the SSL feature.
- id String
The provider-assigned unique ID for this managed resource.
- replica
Set StringName The name of the mongo replica set.
- replica
Sets List<Property Map> Replica set instance information.
- retention
Period Number Instance data backup retention days. Available since v1.42.0.
- ssl
Status String Status of the SSL feature.
Look up Existing Instance Resource
Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_password: Optional[str] = None,
auto_renew: Optional[bool] = None,
backup_interval: Optional[str] = None,
backup_periods: Optional[Sequence[str]] = None,
backup_time: Optional[str] = None,
cloud_disk_encryption_key: Optional[str] = None,
db_instance_class: Optional[str] = None,
db_instance_storage: Optional[int] = None,
encrypted: Optional[bool] = None,
encryption_key: Optional[str] = None,
encryptor_name: Optional[str] = None,
engine_version: Optional[str] = None,
hidden_zone_id: Optional[str] = None,
instance_charge_type: Optional[str] = None,
kms_encrypted_password: Optional[str] = None,
kms_encryption_context: Optional[Mapping[str, Any]] = None,
maintain_end_time: Optional[str] = None,
maintain_start_time: Optional[str] = None,
name: Optional[str] = None,
network_type: Optional[str] = None,
order_type: Optional[str] = None,
parameters: Optional[Sequence[InstanceParameterArgs]] = None,
period: Optional[int] = None,
readonly_replicas: Optional[int] = None,
replica_set_name: Optional[str] = None,
replica_sets: Optional[Sequence[InstanceReplicaSetArgs]] = None,
replication_factor: Optional[int] = None,
resource_group_id: Optional[str] = None,
retention_period: Optional[int] = None,
role_arn: Optional[str] = None,
secondary_zone_id: Optional[str] = None,
security_group_id: Optional[str] = None,
security_ip_lists: Optional[Sequence[str]] = None,
snapshot_backup_type: Optional[str] = None,
ssl_action: Optional[str] = None,
ssl_status: Optional[str] = None,
storage_engine: Optional[str] = None,
storage_type: 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) -> Instance
func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
public static Instance get(String name, Output<String> id, InstanceState 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.
- Account
Password string Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
- Auto
Renew bool Auto renew for prepaid. Default value:
false
. Valid values:true
,false
.NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.
- Backup
Interval string The frequency at which high-frequency backups are created. Valid values:
-1
,15
,30
,60
,120
,180
,240
,360
,480
,720
.- Backup
Periods 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]- Backup
Time 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".- Cloud
Disk stringEncryption Key The ID of the encryption key.
- Db
Instance stringClass Instance specification. see Instance specifications.
- Db
Instance intStorage User-defined DB instance storage space.Unit: GB. Value range:
- Custom storage space.
- 10-GB increments.
- Encrypted bool
Whether to enable cloud disk encryption. Default value:
false
. Valid values:true
,false
.- Encryption
Key string - Encryptor
Name string The encryption method. NOTE:
encryptor_name
is valid only whentde_status
is set toenabled
.- Engine
Version string Database version. Value options can refer to the latest docs CreateDBInstance
EngineVersion
.- string
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as
zone_id
andsecondary_zone_id
parameter values.- Instance
Charge stringType The billing method of the instance. Default value:
PostPaid
. Valid values:PrePaid
,PostPaid
. NOTE: It can be modified fromPostPaid
toPrePaid
after version 1.63.0.- Kms
Encrypted stringPassword An KMS encrypts password used to a instance. If the
account_password
is filled in, this field will be ignored.- Kms
Encryption Dictionary<string, object>Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- Maintain
End stringTime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- Maintain
Start stringTime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- Name string
The name of DB instance. It a string of 2 to 256 characters.
- Network
Type string The network type of the instance. Valid values:
Classic
,VPC
.- Order
Type string The type of configuration changes performed. Default value:
DOWNGRADE
. Valid values:- Parameters
List<Pulumi.
Ali Cloud. Mongo DB. Inputs. Instance Parameter> Set of parameters needs to be set after mongodb instance was launched. See
parameters
below.- Period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid
. Default value:1
. Valid values: [1~9], 12, 24, 36.- Readonly
Replicas int The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
- Replica
Set stringName The name of the mongo replica set.
- Replica
Sets List<Pulumi.Ali Cloud. Mongo DB. Inputs. Instance Replica Set> Replica set instance information.
- Replication
Factor int Number of replica set nodes. Valid values:
1
,3
,5
,7
.- Resource
Group stringId The ID of the Resource Group.
- Retention
Period int Instance data backup retention days. Available since v1.42.0.
- Role
Arn string - Secondary
Zone stringId Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as
zone_id
andhidden_zone_id
parameter values.- Security
Group stringId The Security Group ID of ECS.
- Security
Ip List<string>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]).
- Snapshot
Backup stringType The snapshot backup type. Default value:
Standard
. Valid values:- Ssl
Action string Actions performed on SSL functions. Valid values:
- Ssl
Status string Status of the SSL feature.
- Storage
Engine string The storage engine of the instance. Default value:
WiredTiger
. Valid values:WiredTiger
,RocksDB
.- Storage
Type string The storage type of the instance. Valid values:
cloud_essd1
,cloud_essd2
,cloud_essd3
,local_ssd
.- Dictionary<string, object>
A mapping of tags to assign to the resource.
- Tde
Status string The TDE(Transparent Data Encryption) status. Valid values:
enabled
.- Vpc
Id string The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- Vswitch
Id string The virtual switch ID to launch DB instances in one VPC.
- Zone
Id string 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 settingmulti
to "true" in the data sourcealicloud.getZones
.
- Account
Password string Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
- Auto
Renew bool Auto renew for prepaid. Default value:
false
. Valid values:true
,false
.NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.
- Backup
Interval string The frequency at which high-frequency backups are created. Valid values:
-1
,15
,30
,60
,120
,180
,240
,360
,480
,720
.- Backup
Periods []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]- Backup
Time 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".- Cloud
Disk stringEncryption Key The ID of the encryption key.
- Db
Instance stringClass Instance specification. see Instance specifications.
- Db
Instance intStorage User-defined DB instance storage space.Unit: GB. Value range:
- Custom storage space.
- 10-GB increments.
- Encrypted bool
Whether to enable cloud disk encryption. Default value:
false
. Valid values:true
,false
.- Encryption
Key string - Encryptor
Name string The encryption method. NOTE:
encryptor_name
is valid only whentde_status
is set toenabled
.- Engine
Version string Database version. Value options can refer to the latest docs CreateDBInstance
EngineVersion
.- string
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as
zone_id
andsecondary_zone_id
parameter values.- Instance
Charge stringType The billing method of the instance. Default value:
PostPaid
. Valid values:PrePaid
,PostPaid
. NOTE: It can be modified fromPostPaid
toPrePaid
after version 1.63.0.- Kms
Encrypted stringPassword An KMS encrypts password used to a instance. If the
account_password
is filled in, this field will be ignored.- Kms
Encryption map[string]interface{}Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- Maintain
End stringTime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- Maintain
Start stringTime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- Name string
The name of DB instance. It a string of 2 to 256 characters.
- Network
Type string The network type of the instance. Valid values:
Classic
,VPC
.- Order
Type string The type of configuration changes performed. Default value:
DOWNGRADE
. Valid values:- Parameters
[]Instance
Parameter Args Set of parameters needs to be set after mongodb instance was launched. See
parameters
below.- Period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid
. Default value:1
. Valid values: [1~9], 12, 24, 36.- Readonly
Replicas int The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
- Replica
Set stringName The name of the mongo replica set.
- Replica
Sets []InstanceReplica Set Args Replica set instance information.
- Replication
Factor int Number of replica set nodes. Valid values:
1
,3
,5
,7
.- Resource
Group stringId The ID of the Resource Group.
- Retention
Period int Instance data backup retention days. Available since v1.42.0.
- Role
Arn string - Secondary
Zone stringId Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as
zone_id
andhidden_zone_id
parameter values.- Security
Group stringId The Security Group ID of ECS.
- Security
Ip []stringLists 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]).
- Snapshot
Backup stringType The snapshot backup type. Default value:
Standard
. Valid values:- Ssl
Action string Actions performed on SSL functions. Valid values:
- Ssl
Status string Status of the SSL feature.
- Storage
Engine string The storage engine of the instance. Default value:
WiredTiger
. Valid values:WiredTiger
,RocksDB
.- Storage
Type string The storage type of the instance. Valid values:
cloud_essd1
,cloud_essd2
,cloud_essd3
,local_ssd
.- map[string]interface{}
A mapping of tags to assign to the resource.
- Tde
Status string The TDE(Transparent Data Encryption) status. Valid values:
enabled
.- Vpc
Id string The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- Vswitch
Id string The virtual switch ID to launch DB instances in one VPC.
- Zone
Id string 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 settingmulti
to "true" in the data sourcealicloud.getZones
.
- account
Password String Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
- auto
Renew Boolean Auto renew for prepaid. Default value:
false
. Valid values:true
,false
.NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.
- backup
Interval String The frequency at which high-frequency backups are created. Valid values:
-1
,15
,30
,60
,120
,180
,240
,360
,480
,720
.- backup
Periods 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]- backup
Time 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".- cloud
Disk StringEncryption Key The ID of the encryption key.
- db
Instance StringClass Instance specification. see Instance specifications.
- db
Instance IntegerStorage User-defined DB instance storage space.Unit: GB. Value range:
- Custom storage space.
- 10-GB increments.
- encrypted Boolean
Whether to enable cloud disk encryption. Default value:
false
. Valid values:true
,false
.- encryption
Key String - encryptor
Name String The encryption method. NOTE:
encryptor_name
is valid only whentde_status
is set toenabled
.- engine
Version String Database version. Value options can refer to the latest docs CreateDBInstance
EngineVersion
.- String
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as
zone_id
andsecondary_zone_id
parameter values.- instance
Charge StringType The billing method of the instance. Default value:
PostPaid
. Valid values:PrePaid
,PostPaid
. NOTE: It can be modified fromPostPaid
toPrePaid
after version 1.63.0.- kms
Encrypted StringPassword An KMS encrypts password used to a instance. If the
account_password
is filled in, this field will be ignored.- kms
Encryption Map<String,Object>Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- maintain
End StringTime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- maintain
Start StringTime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- name String
The name of DB instance. It a string of 2 to 256 characters.
- network
Type String The network type of the instance. Valid values:
Classic
,VPC
.- order
Type String The type of configuration changes performed. Default value:
DOWNGRADE
. Valid values:- parameters
List<Instance
Parameter> Set of parameters needs to be set after mongodb instance was launched. See
parameters
below.- period Integer
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid
. Default value:1
. Valid values: [1~9], 12, 24, 36.- readonly
Replicas Integer The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
- replica
Set StringName The name of the mongo replica set.
- replica
Sets List<InstanceReplica Set> Replica set instance information.
- replication
Factor Integer Number of replica set nodes. Valid values:
1
,3
,5
,7
.- resource
Group StringId The ID of the Resource Group.
- retention
Period Integer Instance data backup retention days. Available since v1.42.0.
- role
Arn String - secondary
Zone StringId Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as
zone_id
andhidden_zone_id
parameter values.- security
Group StringId The Security Group ID of ECS.
- security
Ip List<String>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]).
- snapshot
Backup StringType The snapshot backup type. Default value:
Standard
. Valid values:- ssl
Action String Actions performed on SSL functions. Valid values:
- ssl
Status String Status of the SSL feature.
- storage
Engine String The storage engine of the instance. Default value:
WiredTiger
. Valid values:WiredTiger
,RocksDB
.- storage
Type String The storage type of the instance. Valid values:
cloud_essd1
,cloud_essd2
,cloud_essd3
,local_ssd
.- Map<String,Object>
A mapping of tags to assign to the resource.
- tde
Status String The TDE(Transparent Data Encryption) status. Valid values:
enabled
.- vpc
Id String The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- vswitch
Id String The virtual switch ID to launch DB instances in one VPC.
- zone
Id String 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 settingmulti
to "true" in the data sourcealicloud.getZones
.
- account
Password string Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
- auto
Renew boolean Auto renew for prepaid. Default value:
false
. Valid values:true
,false
.NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.
- backup
Interval string The frequency at which high-frequency backups are created. Valid values:
-1
,15
,30
,60
,120
,180
,240
,360
,480
,720
.- backup
Periods 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]- backup
Time 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".- cloud
Disk stringEncryption Key The ID of the encryption key.
- db
Instance stringClass Instance specification. see Instance specifications.
- db
Instance numberStorage User-defined DB instance storage space.Unit: GB. Value range:
- Custom storage space.
- 10-GB increments.
- encrypted boolean
Whether to enable cloud disk encryption. Default value:
false
. Valid values:true
,false
.- encryption
Key string - encryptor
Name string The encryption method. NOTE:
encryptor_name
is valid only whentde_status
is set toenabled
.- engine
Version string Database version. Value options can refer to the latest docs CreateDBInstance
EngineVersion
.- string
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as
zone_id
andsecondary_zone_id
parameter values.- instance
Charge stringType The billing method of the instance. Default value:
PostPaid
. Valid values:PrePaid
,PostPaid
. NOTE: It can be modified fromPostPaid
toPrePaid
after version 1.63.0.- kms
Encrypted stringPassword An KMS encrypts password used to a instance. If the
account_password
is filled in, this field will be ignored.- kms
Encryption {[key: string]: any}Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- maintain
End stringTime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- maintain
Start stringTime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- name string
The name of DB instance. It a string of 2 to 256 characters.
- network
Type string The network type of the instance. Valid values:
Classic
,VPC
.- order
Type string The type of configuration changes performed. Default value:
DOWNGRADE
. Valid values:- parameters
Instance
Parameter[] Set of parameters needs to be set after mongodb instance was launched. See
parameters
below.- period number
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid
. Default value:1
. Valid values: [1~9], 12, 24, 36.- readonly
Replicas number The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
- replica
Set stringName The name of the mongo replica set.
- replica
Sets InstanceReplica Set[] Replica set instance information.
- replication
Factor number Number of replica set nodes. Valid values:
1
,3
,5
,7
.- resource
Group stringId The ID of the Resource Group.
- retention
Period number Instance data backup retention days. Available since v1.42.0.
- role
Arn string - secondary
Zone stringId Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as
zone_id
andhidden_zone_id
parameter values.- security
Group stringId The Security Group ID of ECS.
- security
Ip string[]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]).
- snapshot
Backup stringType The snapshot backup type. Default value:
Standard
. Valid values:- ssl
Action string Actions performed on SSL functions. Valid values:
- ssl
Status string Status of the SSL feature.
- storage
Engine string The storage engine of the instance. Default value:
WiredTiger
. Valid values:WiredTiger
,RocksDB
.- storage
Type string The storage type of the instance. Valid values:
cloud_essd1
,cloud_essd2
,cloud_essd3
,local_ssd
.- {[key: string]: any}
A mapping of tags to assign to the resource.
- tde
Status string The TDE(Transparent Data Encryption) status. Valid values:
enabled
.- vpc
Id string The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- vswitch
Id string The virtual switch ID to launch DB instances in one VPC.
- zone
Id string 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 settingmulti
to "true" in the data sourcealicloud.getZones
.
- account_
password str Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
- auto_
renew bool Auto renew for prepaid. Default value:
false
. Valid values:true
,false
.NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.
- backup_
interval str The frequency at which high-frequency backups are created. Valid values:
-1
,15
,30
,60
,120
,180
,240
,360
,480
,720
.- 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".- cloud_
disk_ strencryption_ key The ID of the encryption key.
- db_
instance_ strclass Instance specification. see Instance specifications.
- db_
instance_ intstorage User-defined DB instance storage space.Unit: GB. Value range:
- Custom storage space.
- 10-GB increments.
- encrypted bool
Whether to enable cloud disk encryption. Default value:
false
. Valid values:true
,false
.- encryption_
key str - encryptor_
name str The encryption method. NOTE:
encryptor_name
is valid only whentde_status
is set toenabled
.- engine_
version str Database version. Value options can refer to the latest docs CreateDBInstance
EngineVersion
.- str
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as
zone_id
andsecondary_zone_id
parameter values.- instance_
charge_ strtype The billing method of the instance. Default value:
PostPaid
. Valid values:PrePaid
,PostPaid
. NOTE: It can be modified fromPostPaid
toPrePaid
after version 1.63.0.- kms_
encrypted_ strpassword An KMS encrypts password used to a instance. If the
account_password
is filled in, this field will be ignored.- kms_
encryption_ Mapping[str, Any]context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- maintain_
end_ strtime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- maintain_
start_ strtime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- 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
,VPC
.- order_
type str The type of configuration changes performed. Default value:
DOWNGRADE
. Valid values:- parameters
Sequence[Instance
Parameter Args] Set of parameters needs to be set after mongodb instance was launched. See
parameters
below.- period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid
. Default value:1
. Valid values: [1~9], 12, 24, 36.- readonly_
replicas int The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
- replica_
set_ strname The name of the mongo replica set.
- replica_
sets Sequence[InstanceReplica Set Args] Replica set instance information.
- replication_
factor int Number of replica set nodes. Valid values:
1
,3
,5
,7
.- resource_
group_ strid The ID of the Resource Group.
- retention_
period int Instance data backup retention days. Available since v1.42.0.
- role_
arn str - secondary_
zone_ strid Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as
zone_id
andhidden_zone_id
parameter values.- security_
group_ strid The Security Group ID of ECS.
- security_
ip_ Sequence[str]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]).
- snapshot_
backup_ strtype The snapshot backup type. Default value:
Standard
. Valid values:- ssl_
action str Actions performed on SSL functions. Valid values:
- ssl_
status str Status of the SSL feature.
- storage_
engine str The storage engine of the instance. Default value:
WiredTiger
. Valid values:WiredTiger
,RocksDB
.- storage_
type str The storage type of the instance. Valid values:
cloud_essd1
,cloud_essd2
,cloud_essd3
,local_ssd
.- Mapping[str, Any]
A mapping of tags to assign to the resource.
- tde_
status str The TDE(Transparent Data Encryption) status. Valid values:
enabled
.- vpc_
id str The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- vswitch_
id str The virtual switch ID to launch DB instances in one VPC.
- zone_
id 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 settingmulti
to "true" in the data sourcealicloud.getZones
.
- account
Password String Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
- auto
Renew Boolean Auto renew for prepaid. Default value:
false
. Valid values:true
,false
.NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.
- backup
Interval String The frequency at which high-frequency backups are created. Valid values:
-1
,15
,30
,60
,120
,180
,240
,360
,480
,720
.- backup
Periods 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]- backup
Time 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".- cloud
Disk StringEncryption Key The ID of the encryption key.
- db
Instance StringClass Instance specification. see Instance specifications.
- db
Instance NumberStorage User-defined DB instance storage space.Unit: GB. Value range:
- Custom storage space.
- 10-GB increments.
- encrypted Boolean
Whether to enable cloud disk encryption. Default value:
false
. Valid values:true
,false
.- encryption
Key String - encryptor
Name String The encryption method. NOTE:
encryptor_name
is valid only whentde_status
is set toenabled
.- engine
Version String Database version. Value options can refer to the latest docs CreateDBInstance
EngineVersion
.- String
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as
zone_id
andsecondary_zone_id
parameter values.- instance
Charge StringType The billing method of the instance. Default value:
PostPaid
. Valid values:PrePaid
,PostPaid
. NOTE: It can be modified fromPostPaid
toPrePaid
after version 1.63.0.- kms
Encrypted StringPassword An KMS encrypts password used to a instance. If the
account_password
is filled in, this field will be ignored.- kms
Encryption Map<Any>Context An KMS encryption context used to decrypt
kms_encrypted_password
before creating or updating instance withkms_encrypted_password
. See Encryption Context. It is valid whenkms_encrypted_password
is set.- maintain
End StringTime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- maintain
Start StringTime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- name String
The name of DB instance. It a string of 2 to 256 characters.
- network
Type String The network type of the instance. Valid values:
Classic
,VPC
.- order
Type String The type of configuration changes performed. Default value:
DOWNGRADE
. Valid values:- parameters List<Property Map>
Set of parameters needs to be set after mongodb instance was launched. See
parameters
below.- period Number
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid
. Default value:1
. Valid values: [1~9], 12, 24, 36.- readonly
Replicas Number The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
- replica
Set StringName The name of the mongo replica set.
- replica
Sets List<Property Map> Replica set instance information.
- replication
Factor Number Number of replica set nodes. Valid values:
1
,3
,5
,7
.- resource
Group StringId The ID of the Resource Group.
- retention
Period Number Instance data backup retention days. Available since v1.42.0.
- role
Arn String - secondary
Zone StringId Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as
zone_id
andhidden_zone_id
parameter values.- security
Group StringId The Security Group ID of ECS.
- security
Ip List<String>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]).
- snapshot
Backup StringType The snapshot backup type. Default value:
Standard
. Valid values:- ssl
Action String Actions performed on SSL functions. Valid values:
- ssl
Status String Status of the SSL feature.
- storage
Engine String The storage engine of the instance. Default value:
WiredTiger
. Valid values:WiredTiger
,RocksDB
.- storage
Type String The storage type of the instance. Valid values:
cloud_essd1
,cloud_essd2
,cloud_essd3
,local_ssd
.- Map<Any>
A mapping of tags to assign to the resource.
- tde
Status String The TDE(Transparent Data Encryption) status. Valid values:
enabled
.- vpc
Id String The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- vswitch
Id String The virtual switch ID to launch DB instances in one VPC.
- zone
Id String 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 settingmulti
to "true" in the data sourcealicloud.getZones
.
Supporting Types
InstanceParameter, InstanceParameterArgs
InstanceReplicaSet, InstanceReplicaSetArgs
- Connection
Domain string The connection address of the node.
- Connection
Port string The connection port of the node.
- Network
Type string The network type of the instance. Valid values:
Classic
,VPC
.- Replica
Set stringRole The role of the node.
- Vpc
Cloud stringInstance Id VPC instance ID.
- Vpc
Id string The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- Vswitch
Id string The virtual switch ID to launch DB instances in one VPC.
- Connection
Domain string The connection address of the node.
- Connection
Port string The connection port of the node.
- Network
Type string The network type of the instance. Valid values:
Classic
,VPC
.- Replica
Set stringRole The role of the node.
- Vpc
Cloud stringInstance Id VPC instance ID.
- Vpc
Id string The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- Vswitch
Id string The virtual switch ID to launch DB instances in one VPC.
- connection
Domain String The connection address of the node.
- connection
Port String The connection port of the node.
- network
Type String The network type of the instance. Valid values:
Classic
,VPC
.- replica
Set StringRole The role of the node.
- vpc
Cloud StringInstance Id VPC instance ID.
- vpc
Id String The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- vswitch
Id String The virtual switch ID to launch DB instances in one VPC.
- connection
Domain string The connection address of the node.
- connection
Port string The connection port of the node.
- network
Type string The network type of the instance. Valid values:
Classic
,VPC
.- replica
Set stringRole The role of the node.
- vpc
Cloud stringInstance Id VPC instance ID.
- vpc
Id string The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- vswitch
Id string The virtual switch ID to launch DB instances in one VPC.
- connection_
domain str The connection address of the node.
- connection_
port str The connection port of the node.
- network_
type str The network type of the instance. Valid values:
Classic
,VPC
.- replica_
set_ strrole The role of the node.
- vpc_
cloud_ strinstance_ id VPC instance ID.
- vpc_
id str The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- vswitch_
id str The virtual switch ID to launch DB instances in one VPC.
- connection
Domain String The connection address of the node.
- connection
Port String The connection port of the node.
- network
Type String The network type of the instance. Valid values:
Classic
,VPC
.- replica
Set StringRole The role of the node.
- vpc
Cloud StringInstance Id VPC instance ID.
- vpc
Id String The ID of the VPC. > NOTE:
vpc_id
is valid only whennetwork_type
is set toVPC
.- vswitch
Id String The virtual switch ID to launch DB instances in one VPC.
Import
MongoDB can be imported using the id, e.g.
$ pulumi import alicloud:mongodb/instance:Instance example dds-bp1291daeda44194
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
alicloud
Terraform Provider.