Instance

Create a Instance Resource

new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);

def Instance(resource_name, opts=None, account_password=None, backup_periods=None, backup_time=None, db_instance_class=None, db_instance_storage=None, engine_version=None, instance_charge_type=None, kms_encrypted_password=None, kms_encryption_context=None, maintain_end_time=None, maintain_start_time=None, name=None, period=None, replication_factor=None, security_group_id=None, security_ip_lists=None, ssl_action=None, storage_engine=None, tags=None, tde_status=None, vswitch_id=None, zone_id=None, __props__=None);

func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)

public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Instance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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; value range: [10,2000] - 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.
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”.
InstanceChargeType string: Valid values are PrePaid, PostPaid, System default to PostPaid. 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.
Period int: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.
ReplicationFactor int: Number of replica set nodes. Valid values: [3, 5, 7]
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]).
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: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
Tags Dictionary<string, object>: A mapping of tags to assign to the resource.
TdeStatus string: The TDE(Transparent Data Encryption) status.
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; value range: [10,2000] - 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.
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]
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”.
InstanceChargeType string: Valid values are PrePaid, PostPaid, System default to PostPaid. 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 a string of 2 to 256 characters.
Period int: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.
ReplicationFactor int: Number of replica set nodes. Valid values: [3, 5, 7]
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]).
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: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
Tags map[string]interface{}: A mapping of tags to assign to the resource.
TdeStatus string: The TDE(Transparent Data Encryption) status.
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; value range: [10,2000] - 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.
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]
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”.
instanceChargeType string: Valid values are PrePaid, PostPaid, System default to PostPaid. 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 a string of 2 to 256 characters.
period number: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.
replicationFactor number: Number of replica set nodes. Valid values: [3, 5, 7]
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]).
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: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
tags {[key: string]: any}: A mapping of tags to assign to the resource.
tdeStatus string: The TDE(Transparent Data Encryption) status.
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 float: User-defined DB instance storage space.Unit: GB. Value range: - Custom storage space; value range: [10,2000] - 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.
backup_periods List[str]: MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
backup_time str: MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like “23:00Z-24:00Z”.
instance_charge_type str: Valid values are PrePaid, PostPaid, System default to PostPaid. It can be modified from PostPaid to PrePaid after version 1.63.0.
kms_encrypted_password str: An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kms_encryption_context Dict[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 a string of 2 to 256 characters.
period float: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.
replication_factor float: Number of replica set nodes. Valid values: [3, 5, 7]
security_group_id str: The Security Group ID of ECS.
security_ip_lists List[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]).
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: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
tags Dict[str, Any]: A mapping of tags to assign to the resource.
tde_status str: The TDE(Transparent Data Encryption) status.
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.

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
RetentionPeriod int: Instance log backup retention days. Available in 1.42.0+.
SslStatus string: Status of the SSL feature. Open: SSL is turned on; Closed: SSL is turned off.

Id string: The provider-assigned unique ID for this managed resource.
ReplicaSetName string: The name of the mongo replica set
RetentionPeriod int: Instance log backup retention days. Available in 1.42.0+.
SslStatus string: Status of the SSL feature. Open: SSL is turned on; Closed: SSL is turned off.

id string: The provider-assigned unique ID for this managed resource.
replicaSetName string: The name of the mongo replica set
retentionPeriod number: Instance log backup retention days. Available in 1.42.0+.
sslStatus string: Status of the SSL feature. Open: SSL is turned on; Closed: SSL is turned off.

id str: The provider-assigned unique ID for this managed resource.
replica_set_name str: The name of the mongo replica set
retention_period float: Instance log backup retention days. Available in 1.42.0+.
ssl_status str: Status of the SSL feature. Open: SSL is turned on; Closed: SSL is turned off.

Look up an 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

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

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)

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.

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.
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”.
DbInstanceClass string: Instance specification. see Instance specifications.
DbInstanceStorage int: User-defined DB instance storage space.Unit: GB. Value range: - Custom storage space; value range: [10,2000] - 10-GB increments.
EngineVersion string: Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
InstanceChargeType string: Valid values are PrePaid, PostPaid, System default to PostPaid. 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.
Period int: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.
ReplicaSetName string: The name of the mongo replica set
ReplicationFactor int: Number of replica set nodes. Valid values: [3, 5, 7]
RetentionPeriod int: Instance log backup retention days. Available in 1.42.0+.
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]).
SslAction string: Actions performed on SSL functions, Valid values: Open: turn on SSL encryption; Close: turn off SSL encryption; Update: update SSL certificate.
SslStatus string: Status of the SSL feature. Open: SSL is turned on; Closed: SSL is turned off.
StorageEngine string: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
Tags Dictionary<string, object>: A mapping of tags to assign to the resource.
TdeStatus string: The TDE(Transparent Data Encryption) status.
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.

AccountPassword string: Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
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]
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”.
DbInstanceClass string: Instance specification. see Instance specifications.
DbInstanceStorage int: User-defined DB instance storage space.Unit: GB. Value range: - Custom storage space; value range: [10,2000] - 10-GB increments.
EngineVersion string: Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
InstanceChargeType string: Valid values are PrePaid, PostPaid, System default to PostPaid. 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 a string of 2 to 256 characters.
Period int: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.
ReplicaSetName string: The name of the mongo replica set
ReplicationFactor int: Number of replica set nodes. Valid values: [3, 5, 7]
RetentionPeriod int: Instance log backup retention days. Available in 1.42.0+.
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]).
SslAction string: Actions performed on SSL functions, Valid values: Open: turn on SSL encryption; Close: turn off SSL encryption; Update: update SSL certificate.
SslStatus string: Status of the SSL feature. Open: SSL is turned on; Closed: SSL is turned off.
StorageEngine string: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
Tags map[string]interface{}: A mapping of tags to assign to the resource.
TdeStatus string: The TDE(Transparent Data Encryption) status.
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.

accountPassword string: Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
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]
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”.
dbInstanceClass string: Instance specification. see Instance specifications.
dbInstanceStorage number: User-defined DB instance storage space.Unit: GB. Value range: - Custom storage space; value range: [10,2000] - 10-GB increments.
engineVersion string: Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
instanceChargeType string: Valid values are PrePaid, PostPaid, System default to PostPaid. 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 a string of 2 to 256 characters.
period number: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.
replicaSetName string: The name of the mongo replica set
replicationFactor number: Number of replica set nodes. Valid values: [3, 5, 7]
retentionPeriod number: Instance log backup retention days. Available in 1.42.0+.
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]).
sslAction string: Actions performed on SSL functions, Valid values: Open: turn on SSL encryption; Close: turn off SSL encryption; Update: update SSL certificate.
sslStatus string: Status of the SSL feature. Open: SSL is turned on; Closed: SSL is turned off.
storageEngine string: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
tags {[key: string]: any}: A mapping of tags to assign to the resource.
tdeStatus string: The TDE(Transparent Data Encryption) status.
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.

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.
backup_periods List[str]: MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
backup_time str: MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like “23:00Z-24:00Z”.
db_instance_class str: Instance specification. see Instance specifications.
db_instance_storage float: User-defined DB instance storage space.Unit: GB. Value range: - Custom storage space; value range: [10,2000] - 10-GB increments.
engine_version str: Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion.
instance_charge_type str: Valid values are PrePaid, PostPaid, System default to PostPaid. It can be modified from PostPaid to PrePaid after version 1.63.0.
kms_encrypted_password str: An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kms_encryption_context Dict[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 a string of 2 to 256 characters.
period float: The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. System default to 1.
replica_set_name str: The name of the mongo replica set
replication_factor float: Number of replica set nodes. Valid values: [3, 5, 7]
retention_period float: Instance log backup retention days. Available in 1.42.0+.
security_group_id str: The Security Group ID of ECS.
security_ip_lists List[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]).
ssl_action str: Actions performed on SSL functions, Valid values: Open: turn on SSL encryption; Close: turn off SSL encryption; Update: update SSL certificate.
ssl_status str: Status of the SSL feature. Open: SSL is turned on; Closed: SSL is turned off.
storage_engine str: Storage engine: WiredTiger or RocksDB. System Default value: WiredTiger.
tags Dict[str, Any]: A mapping of tags to assign to the resource.
tde_status str: The TDE(Transparent Data Encryption) status.
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.

Package Details

Repository: https://github.com/pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud