Alibaba Cloud v3.45.0, Nov 27 23

Alibaba Cloud v3.45.0 published on Monday, Nov 27, 2023 by Pulumi

alicloud.mongodb.Instance

Explore with Pulumi AI

Alibaba Cloud v3.45.0 published on Monday, Nov 27, 2023 by Pulumi

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

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:

DbInstanceClass string

Instance specification. see Instance specifications.

DbInstanceStorage int

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

Custom storage space.
10-GB increments.

EngineVersion string

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

AccountPassword string

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

AutoRenew bool

Auto renew for prepaid. Default value: false. Valid values: true, false.

BackupInterval string

The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.

BackupPeriods List<string>

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

BackupTime string

MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".

CloudDiskEncryptionKey string

The ID of the encryption key.

Encrypted bool

Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.

EncryptionKey string

EncryptorName string

The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.

HiddenZoneId 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 and secondary_zone_id parameter values.

InstanceChargeType string

The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.

KmsEncryptedPassword string

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

KmsEncryptionContext Dictionary<string, object>

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

MaintainEndTime string

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

MaintainStartTime string

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.

NetworkType string

The network type of the instance. Valid values:Classic, VPC.

OrderType string

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

Parameters List<Pulumi.AliCloud.MongoDB.Inputs.InstanceParameter>

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.

ReadonlyReplicas int

The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.

ReplicationFactor int

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

ResourceGroupId string

The ID of the Resource Group.

RoleArn string

SecondaryZoneId string

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 and hidden_zone_id parameter values.

SecurityGroupId string

The Security Group ID of ECS.

SecurityIpLists List<string>

List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).

SnapshotBackupType string

The snapshot backup type. Default value: Standard. Valid values:

SslAction string

Actions performed on SSL functions. Valid values:

StorageEngine string

The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.

StorageType string

The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, local_ssd.

Tags Dictionary<string, object>

A mapping of tags to assign to the resource.

TdeStatus string

The TDE(Transparent Data Encryption) status. Valid values: enabled.

VpcId string

The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.

VswitchId string

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

ZoneId string

The Zone to launch the DB instance. 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 alicloud.getZones.

DbInstanceClass string

Instance specification. see Instance specifications.

DbInstanceStorage int

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

Custom storage space.
10-GB increments.

EngineVersion string

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

AccountPassword string

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

AutoRenew bool

Auto renew for prepaid. Default value: false. Valid values: true, false.

BackupInterval string

The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.

BackupPeriods []string

BackupTime string

CloudDiskEncryptionKey string

The ID of the encryption key.

Encrypted bool

Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.

EncryptionKey string

EncryptorName string

The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.

HiddenZoneId 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 and secondary_zone_id parameter values.

InstanceChargeType string

The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.

KmsEncryptedPassword string

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

KmsEncryptionContext map[string]interface{}

MaintainEndTime string

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

MaintainStartTime string

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.

NetworkType string

The network type of the instance. Valid values:Classic, VPC.

OrderType string

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

Parameters []InstanceParameterArgs

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.

ReadonlyReplicas int

The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.

ReplicationFactor int

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

ResourceGroupId string

The ID of the Resource Group.

RoleArn string

SecondaryZoneId string

SecurityGroupId string

The Security Group ID of ECS.

SecurityIpLists []string

SnapshotBackupType string

The snapshot backup type. Default value: Standard. Valid values:

SslAction string

Actions performed on SSL functions. Valid values:

StorageEngine string

The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.

StorageType string

The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, local_ssd.

Tags map[string]interface{}

A mapping of tags to assign to the resource.

TdeStatus string

The TDE(Transparent Data Encryption) status. Valid values: enabled.

VpcId string

The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.

VswitchId string

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

ZoneId string

dbInstanceClass String

Instance specification. see Instance specifications.

dbInstanceStorage Integer

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

Custom storage space.
10-GB increments.

engineVersion String

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

accountPassword String

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

autoRenew Boolean

Auto renew for prepaid. Default value: false. Valid values: true, false.

backupInterval String

The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.

backupPeriods List<String>

backupTime String

cloudDiskEncryptionKey String

The ID of the encryption key.

encrypted Boolean

Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.

encryptionKey String

encryptorName String

The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.

hiddenZoneId 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 and secondary_zone_id parameter values.

instanceChargeType String

The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.

kmsEncryptedPassword String

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

kmsEncryptionContext Map<String,Object>

maintainEndTime String

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

maintainStartTime String

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.

networkType String

The network type of the instance. Valid values:Classic, VPC.

orderType String

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

parameters List<InstanceParameter>

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.

readonlyReplicas Integer

The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.

replicationFactor Integer

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

resourceGroupId String

The ID of the Resource Group.

roleArn String

secondaryZoneId String

securityGroupId String

The Security Group ID of ECS.

securityIpLists List<String>

snapshotBackupType String

The snapshot backup type. Default value: Standard. Valid values:

sslAction String

Actions performed on SSL functions. Valid values:

storageEngine String

The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.

storageType String

The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, local_ssd.

tags Map<String,Object>

A mapping of tags to assign to the resource.

tdeStatus String

The TDE(Transparent Data Encryption) status. Valid values: enabled.

vpcId String

The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.

vswitchId String

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

zoneId String

dbInstanceClass string

Instance specification. see Instance specifications.

dbInstanceStorage number

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

Custom storage space.
10-GB increments.

engineVersion string

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

accountPassword string

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

autoRenew boolean

Auto renew for prepaid. Default value: false. Valid values: true, false.

backupInterval string

The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.

backupPeriods string[]

backupTime string

cloudDiskEncryptionKey string

The ID of the encryption key.

encrypted boolean

Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.

encryptionKey string

encryptorName string

The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.

hiddenZoneId 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 and secondary_zone_id parameter values.

instanceChargeType string

The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.

kmsEncryptedPassword string

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

kmsEncryptionContext {[key: string]: any}

maintainEndTime string

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

maintainStartTime string

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.

networkType string

The network type of the instance. Valid values:Classic, VPC.

orderType string

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

parameters InstanceParameter[]

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.

readonlyReplicas number

The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.

replicationFactor number

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

resourceGroupId string

The ID of the Resource Group.

roleArn string

secondaryZoneId string

securityGroupId string

The Security Group ID of ECS.

securityIpLists string[]

snapshotBackupType string

The snapshot backup type. Default value: Standard. Valid values:

sslAction string

Actions performed on SSL functions. Valid values:

storageEngine string

The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.

storageType string

The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, local_ssd.

tags {[key: string]: any}

A mapping of tags to assign to the resource.

tdeStatus string

The TDE(Transparent Data Encryption) status. Valid values: enabled.

vpcId string

The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.

vswitchId string

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

zoneId string

db_instance_class str

Instance specification. see Instance specifications.

db_instance_storage int

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.

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]

backup_time str

cloud_disk_encryption_key str

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 when tde_status is set to enabled.

hidden_zone_id 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 and secondary_zone_id parameter values.

instance_charge_type str

The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.

kms_encrypted_password str

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

kms_encryption_context Mapping[str, Any]

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

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[InstanceParameterArgs]

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

The ID of the Resource Group.

role_arn str

secondary_zone_id str

security_group_id str

The Security Group ID of ECS.

security_ip_lists Sequence[str]

snapshot_backup_type str

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.

tags 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 when network_type is set to VPC.

vswitch_id str

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

zone_id str

dbInstanceClass String

Instance specification. see Instance specifications.

dbInstanceStorage Number

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

Custom storage space.
10-GB increments.

engineVersion String

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

accountPassword String

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

autoRenew Boolean

Auto renew for prepaid. Default value: false. Valid values: true, false.

backupInterval String

The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.

backupPeriods List<String>

backupTime String

cloudDiskEncryptionKey String

The ID of the encryption key.

encrypted Boolean

Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.

encryptionKey String

encryptorName String

The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.

hiddenZoneId 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 and secondary_zone_id parameter values.

instanceChargeType String

The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.

kmsEncryptedPassword String

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

kmsEncryptionContext Map<Any>

maintainEndTime String

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

maintainStartTime String

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.

networkType String

The network type of the instance. Valid values:Classic, VPC.

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

readonlyReplicas Number

The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.

replicationFactor Number

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

resourceGroupId String

The ID of the Resource Group.

roleArn String

secondaryZoneId String

securityGroupId String

The Security Group ID of ECS.

securityIpLists List<String>

snapshotBackupType String

The snapshot backup type. Default value: Standard. Valid values:

sslAction String

Actions performed on SSL functions. Valid values:

storageEngine String

The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.

storageType String

The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, local_ssd.

tags Map<Any>

A mapping of tags to assign to the resource.

tdeStatus String

The TDE(Transparent Data Encryption) status. Valid values: enabled.

vpcId String

The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.

vswitchId String

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

zoneId String

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.
ReplicaSetName string: The name of the mongo replica set.
ReplicaSets List<Pulumi.AliCloud.MongoDB.Outputs.InstanceReplicaSet>: Replica set instance information.
RetentionPeriod int: Instance data backup retention days. Available since v1.42.0.
SslStatus string: Status of the SSL feature.

Id string: The provider-assigned unique ID for this managed resource.
ReplicaSetName string: The name of the mongo replica set.
ReplicaSets []InstanceReplicaSet: Replica set instance information.
RetentionPeriod int: Instance data backup retention days. Available since v1.42.0.
SslStatus string: Status of the SSL feature.

id String: The provider-assigned unique ID for this managed resource.
replicaSetName String: The name of the mongo replica set.
replicaSets List<InstanceReplicaSet>: Replica set instance information.
retentionPeriod Integer: Instance data backup retention days. Available since v1.42.0.
sslStatus String: Status of the SSL feature.

id string: The provider-assigned unique ID for this managed resource.
replicaSetName string: The name of the mongo replica set.
replicaSets InstanceReplicaSet[]: Replica set instance information.
retentionPeriod number: Instance data backup retention days. Available since v1.42.0.
sslStatus string: Status of the SSL feature.

id str: The provider-assigned unique ID for this managed resource.
replica_set_name str: The name of the mongo replica set.
replica_sets Sequence[InstanceReplicaSet]: 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.
replicaSetName String: The name of the mongo replica set.
replicaSets List<Property Map>: Replica set instance information.
retentionPeriod Number: Instance data backup retention days. Available since v1.42.0.
sslStatus 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.

The following state arguments are supported:

AccountPassword string

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

AutoRenew bool

Auto renew for prepaid. Default value: false. Valid values: true, false.

BackupInterval string

The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.

BackupPeriods List<string>

BackupTime string

CloudDiskEncryptionKey string

The ID of the encryption key.

DbInstanceClass string

Instance specification. see Instance specifications.

DbInstanceStorage int

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.

EncryptionKey string

EncryptorName string

The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.

EngineVersion string

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

HiddenZoneId 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 and secondary_zone_id parameter values.

InstanceChargeType string

The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.

KmsEncryptedPassword string

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

KmsEncryptionContext Dictionary<string, object>

MaintainEndTime string

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

MaintainStartTime string

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.

NetworkType string

The network type of the instance. Valid values:Classic, VPC.

OrderType string

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

Parameters List<Pulumi.AliCloud.MongoDB.Inputs.InstanceParameter>

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.

ReadonlyReplicas int

The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.

ReplicaSetName string

The name of the mongo replica set.

ReplicaSets List<Pulumi.AliCloud.MongoDB.Inputs.InstanceReplicaSet>

Replica set instance information.

ReplicationFactor int

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

ResourceGroupId string

The ID of the Resource Group.

RetentionPeriod int

Instance data backup retention days. Available since v1.42.0.

RoleArn string

SecondaryZoneId string

SecurityGroupId string

The Security Group ID of ECS.

SecurityIpLists List<string>

SnapshotBackupType string

The snapshot backup type. Default value: Standard. Valid values:

SslAction string

Actions performed on SSL functions. Valid values:

SslStatus string

Status of the SSL feature.

StorageEngine string

The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.

StorageType string

The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, local_ssd.

Tags Dictionary<string, object>

A mapping of tags to assign to the resource.

TdeStatus string

The TDE(Transparent Data Encryption) status. Valid values: enabled.

VpcId string

The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.

VswitchId string

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

ZoneId string

AccountPassword string

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

AutoRenew bool

Auto renew for prepaid. Default value: false. Valid values: true, false.

BackupInterval string

The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.

BackupPeriods []string

BackupTime string

CloudDiskEncryptionKey string

The ID of the encryption key.

DbInstanceClass string

Instance specification. see Instance specifications.

DbInstanceStorage int

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.

EncryptionKey string

EncryptorName string

The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.

EngineVersion string

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

HiddenZoneId 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 and secondary_zone_id parameter values.

InstanceChargeType string

The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.

KmsEncryptedPassword string

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

KmsEncryptionContext map[string]interface{}

MaintainEndTime string

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

MaintainStartTime string

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.

NetworkType string

The network type of the instance. Valid values:Classic, VPC.

OrderType string

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

Parameters []InstanceParameterArgs

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.

ReadonlyReplicas int

The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.

ReplicaSetName string

The name of the mongo replica set.

ReplicaSets []InstanceReplicaSetArgs

Replica set instance information.

ReplicationFactor int

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

ResourceGroupId string

The ID of the Resource Group.

RetentionPeriod int

Instance data backup retention days. Available since v1.42.0.

RoleArn string

SecondaryZoneId string

SecurityGroupId string

The Security Group ID of ECS.

SecurityIpLists []string

SnapshotBackupType string

The snapshot backup type. Default value: Standard. Valid values:

SslAction string

Actions performed on SSL functions. Valid values:

SslStatus string

Status of the SSL feature.

StorageEngine string

The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.

StorageType string

The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, local_ssd.

Tags map[string]interface{}

A mapping of tags to assign to the resource.

TdeStatus string

The TDE(Transparent Data Encryption) status. Valid values: enabled.

VpcId string

The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.

VswitchId string

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

ZoneId string

accountPassword String

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

autoRenew Boolean

Auto renew for prepaid. Default value: false. Valid values: true, false.

backupInterval String

The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.

backupPeriods List<String>

backupTime String

cloudDiskEncryptionKey String

The ID of the encryption key.

dbInstanceClass String

Instance specification. see Instance specifications.

dbInstanceStorage Integer

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.

encryptionKey String

encryptorName String

The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.

engineVersion String

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

hiddenZoneId 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 and secondary_zone_id parameter values.

instanceChargeType String

The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.

kmsEncryptedPassword String

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

kmsEncryptionContext Map<String,Object>

maintainEndTime String

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

maintainStartTime String

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.

networkType String

The network type of the instance. Valid values:Classic, VPC.

orderType String

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

parameters List<InstanceParameter>

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.

readonlyReplicas Integer

The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.

replicaSetName String

The name of the mongo replica set.

replicaSets List<InstanceReplicaSet>

Replica set instance information.

replicationFactor Integer

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

resourceGroupId String

The ID of the Resource Group.

retentionPeriod Integer

Instance data backup retention days. Available since v1.42.0.

roleArn String

secondaryZoneId String

securityGroupId String

The Security Group ID of ECS.

securityIpLists List<String>

snapshotBackupType String

The snapshot backup type. Default value: Standard. Valid values:

sslAction String

Actions performed on SSL functions. Valid values:

sslStatus String

Status of the SSL feature.

storageEngine String

The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.

storageType String

The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, local_ssd.

tags Map<String,Object>

A mapping of tags to assign to the resource.

tdeStatus String

The TDE(Transparent Data Encryption) status. Valid values: enabled.

vpcId String

The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.

vswitchId String

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

zoneId String

accountPassword string

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

autoRenew boolean

Auto renew for prepaid. Default value: false. Valid values: true, false.

backupInterval string

The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.

backupPeriods string[]

backupTime string

cloudDiskEncryptionKey string

The ID of the encryption key.

dbInstanceClass string

Instance specification. see Instance specifications.

dbInstanceStorage number

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.

encryptionKey string

encryptorName string

The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.

engineVersion string

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

hiddenZoneId 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 and secondary_zone_id parameter values.

instanceChargeType string

The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.

kmsEncryptedPassword string

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

kmsEncryptionContext {[key: string]: any}

maintainEndTime string

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

maintainStartTime string

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.

networkType string

The network type of the instance. Valid values:Classic, VPC.

orderType string

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

parameters InstanceParameter[]

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.

readonlyReplicas number

The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.

replicaSetName string

The name of the mongo replica set.

replicaSets InstanceReplicaSet[]

Replica set instance information.

replicationFactor number

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

resourceGroupId string

The ID of the Resource Group.

retentionPeriod number

Instance data backup retention days. Available since v1.42.0.

roleArn string

secondaryZoneId string

securityGroupId string

The Security Group ID of ECS.

securityIpLists string[]

snapshotBackupType string

The snapshot backup type. Default value: Standard. Valid values:

sslAction string

Actions performed on SSL functions. Valid values:

sslStatus string

Status of the SSL feature.

storageEngine string

The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.

storageType string

The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, local_ssd.

tags {[key: string]: any}

A mapping of tags to assign to the resource.

tdeStatus string

The TDE(Transparent Data Encryption) status. Valid values: enabled.

vpcId string

The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.

vswitchId string

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

zoneId string

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.

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]

backup_time str

cloud_disk_encryption_key str

The ID of the encryption key.

db_instance_class str

Instance specification. see Instance specifications.

db_instance_storage int

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 when tde_status is set to enabled.

engine_version str

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

hidden_zone_id 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 and secondary_zone_id parameter values.

instance_charge_type str

The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.

kms_encrypted_password str

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

kms_encryption_context Mapping[str, Any]

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

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[InstanceParameterArgs]

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

The name of the mongo replica set.

replica_sets Sequence[InstanceReplicaSetArgs]

Replica set instance information.

replication_factor int

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

resource_group_id str

The ID of the Resource Group.

retention_period int

Instance data backup retention days. Available since v1.42.0.

role_arn str

secondary_zone_id str

security_group_id str

The Security Group ID of ECS.

security_ip_lists Sequence[str]

snapshot_backup_type str

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.

tags 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 when network_type is set to VPC.

vswitch_id str

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

zone_id str

accountPassword String

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

autoRenew Boolean

Auto renew for prepaid. Default value: false. Valid values: true, false.

backupInterval String

The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.

backupPeriods List<String>

backupTime String

cloudDiskEncryptionKey String

The ID of the encryption key.

dbInstanceClass String

Instance specification. see Instance specifications.

dbInstanceStorage Number

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.

encryptionKey String

encryptorName String

The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.

engineVersion String

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

hiddenZoneId 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 and secondary_zone_id parameter values.

instanceChargeType String

The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.

kmsEncryptedPassword String

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

kmsEncryptionContext Map<Any>

maintainEndTime String

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

maintainStartTime String

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.

networkType String

The network type of the instance. Valid values:Classic, VPC.

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

readonlyReplicas Number

The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.

replicaSetName String

The name of the mongo replica set.

replicaSets List<Property Map>

Replica set instance information.

replicationFactor Number

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

resourceGroupId String

The ID of the Resource Group.

retentionPeriod Number

Instance data backup retention days. Available since v1.42.0.

roleArn String

secondaryZoneId String

securityGroupId String

The Security Group ID of ECS.

securityIpLists List<String>

snapshotBackupType String

The snapshot backup type. Default value: Standard. Valid values:

sslAction String

Actions performed on SSL functions. Valid values:

sslStatus String

Status of the SSL feature.

storageEngine String

The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.

storageType String

The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, local_ssd.

tags Map<Any>

A mapping of tags to assign to the resource.

tdeStatus String

The TDE(Transparent Data Encryption) status. Valid values: enabled.

vpcId String

The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.

vswitchId String

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

zoneId String

Supporting Types

InstanceParameter, InstanceParameterArgs

Name string: The name of the parameter.
Value string: The value of the parameter.

Name string: The name of the parameter.
Value string: The value of the parameter.

name String: The name of the parameter.
value String: The value of the parameter.

name string: The name of the parameter.
value string: The value of the parameter.

name str: The name of the parameter.
value str: The value of the parameter.

name String: The name of the parameter.
value String: The value of the parameter.

InstanceReplicaSet, InstanceReplicaSetArgs

ConnectionDomain string: The connection address of the node.
ConnectionPort string: The connection port of the node.
NetworkType string: The network type of the instance. Valid values:Classic, VPC.
ReplicaSetRole string: The role of the node.
VpcCloudInstanceId string: VPC instance ID.
VpcId string: The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
VswitchId string: The virtual switch ID to launch DB instances in one VPC.

ConnectionDomain string: The connection address of the node.
ConnectionPort string: The connection port of the node.
NetworkType string: The network type of the instance. Valid values:Classic, VPC.
ReplicaSetRole string: The role of the node.
VpcCloudInstanceId string: VPC instance ID.
VpcId string: The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
VswitchId string: The virtual switch ID to launch DB instances in one VPC.

connectionDomain String: The connection address of the node.
connectionPort String: The connection port of the node.
networkType String: The network type of the instance. Valid values:Classic, VPC.
replicaSetRole String: The role of the node.
vpcCloudInstanceId String: VPC instance ID.
vpcId String: The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId String: The virtual switch ID to launch DB instances in one VPC.

connectionDomain string: The connection address of the node.
connectionPort string: The connection port of the node.
networkType string: The network type of the instance. Valid values:Classic, VPC.
replicaSetRole string: The role of the node.
vpcCloudInstanceId string: VPC instance ID.
vpcId string: The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId 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_role str: The role of the node.
vpc_cloud_instance_id str: VPC instance ID.
vpc_id str: The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitch_id str: The virtual switch ID to launch DB instances in one VPC.

connectionDomain String: The connection address of the node.
connectionPort String: The connection port of the node.
networkType String: The network type of the instance. Valid values:Classic, VPC.
replicaSetRole String: The role of the node.
vpcCloudInstanceId String: VPC instance ID.
vpcId String: The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId 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.

Alibaba Cloud v3.45.0 published on Monday, Nov 27, 2023 by Pulumi

pulumi/pulumi-alicloud

alicloud.mongodb.Instance

On this page

On this page

Module Support

Example Usage

Create a Mongodb instance

Create Instance Resource

Instance Resource Properties

Inputs

Outputs

Look up Existing Instance Resource

Supporting Types

InstanceParameter, InstanceParameterArgs

InstanceReplicaSet, InstanceReplicaSetArgs

Import

Package Details

On this page

On this page