alicloud.mongodb.Instance

Coming soon!

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.

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. NOTE: From version 1.225.0, engine_version can be modified.

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.

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.

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

BackupRetentionPeriod int

The retention period of full backups.

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.

EffectiveTime string

The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.

Encrypted bool

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

EncryptionKey string

The ID of the custom key.

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 must be 2 to 256 characters in length.

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:

• UPGRADE: The specifications are upgraded.
• DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.

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

The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.

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:

• Standard: standard backup.
• Flash : single-digit second backup.

SslAction string

Actions performed on SSL functions. Valid values:

• Open: turn on SSL encryption.
• Close: turn off SSL encryption.
• Update: update SSL certificate.

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. NOTE: From version 1.225.0, engine_version can be modified.

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.

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.

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

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

BackupRetentionPeriod int

The retention period of full backups.

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.

EffectiveTime string

The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.

Encrypted bool

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

EncryptionKey string

The ID of the custom key.

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{}

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 must be 2 to 256 characters in length.

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:

• UPGRADE: The specifications are upgraded.
• DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.

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

The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.

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

• Standard: standard backup.
• Flash : single-digit second backup.

SslAction string

Actions performed on SSL functions. Valid values:

• Open: turn on SSL encryption.
• Close: turn off SSL encryption.
• Update: update SSL certificate.

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

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 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. NOTE: From version 1.225.0, engine_version can be modified.

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.

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.

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

backupRetentionPeriod Integer

The retention period of full backups.

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.

effectiveTime String

The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.

encrypted Boolean

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

encryptionKey String

The ID of the custom key.

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>

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 must be 2 to 256 characters in length.

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:

• UPGRADE: The specifications are upgraded.
• DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.

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

The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.

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:

• Standard: standard backup.
• Flash : single-digit second backup.

sslAction String

Actions performed on SSL functions. Valid values:

• Open: turn on SSL encryption.
• Close: turn off SSL encryption.
• Update: update SSL certificate.

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

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 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. NOTE: From version 1.225.0, engine_version can be modified.

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.

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.

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

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

backupRetentionPeriod number

The retention period of full backups.

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.

effectiveTime string

The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.

encrypted boolean

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

encryptionKey string

The ID of the custom key.

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}

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 must be 2 to 256 characters in length.

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:

• UPGRADE: The specifications are upgraded.
• DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.

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

The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.

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 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:

• Standard: standard backup.
• Flash : single-digit second backup.

sslAction string

Actions performed on SSL functions. Valid values:

• Open: turn on SSL encryption.
• Close: turn off SSL encryption.
• Update: update SSL certificate.

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

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.

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. NOTE: From version 1.225.0, engine_version can be modified.

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_retention_period int

The retention period of full backups.

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

The ID of the encryption key.

effective_time str

The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.

encrypted bool

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

encryption_key str

The ID of the custom key.

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]

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

maintain_end_time 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 must be 2 to 256 characters in length.

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:

• UPGRADE: The specifications are upgraded.
• DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.

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

The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.

secondary_zone_id str

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.

security_group_id str

The Security Group ID of ECS.

security_ip_lists Sequence[str]

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

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

• Standard: standard backup.
• Flash : single-digit second backup.

ssl_action str

Actions performed on SSL functions. Valid values:

• Open: turn on SSL encryption.
• Close: turn off SSL encryption.
• Update: update SSL certificate.

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

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 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. NOTE: From version 1.225.0, engine_version can be modified.

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.

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.

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

backupRetentionPeriod Number

The retention period of full backups.

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.

effectiveTime String

The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.

encrypted Boolean

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

encryptionKey String

The ID of the custom key.

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>

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 must be 2 to 256 characters in length.

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:

• UPGRADE: The specifications are upgraded.
• DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.

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

The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.

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:

• Standard: standard backup.
• Flash : single-digit second backup.

sslAction String

Actions performed on SSL functions. Valid values:

• Open: turn on SSL encryption.
• Close: turn off SSL encryption.
• Update: update SSL certificate.

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

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.

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.

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.