InstanceProps

Properties for defining a Instance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-mongodb-instance

Initializer

import { InstanceProps } from '@alicloud/ros-cdk-mongodb'
const instanceProps: InstanceProps = { ... }

Properties

Name	Type	Description
dbInstanceClass	string | @alicloud/ros-cdk-core.IResolvable	Property dbInstanceClass: MongoDB instance supported instance type, make sure it should be correct.
dbInstanceStorage	number | @alicloud/ros-cdk-core.IResolvable	Property dbInstanceStorage: Database instance storage size.
accountPassword	string | @alicloud/ros-cdk-core.IResolvable	Property accountPassword: Root account password, can contain the letters, numbers or underscores the composition, length of 6~32 bit.
autoRenew	boolean | @alicloud/ros-cdk-core.IResolvable	Property autoRenew: Indicates whether automatic renewal is enabled for the instance.
backupId	string | @alicloud/ros-cdk-core.IResolvable	Property backupId: Specific backup set Id.
businessInfo	string | @alicloud/ros-cdk-core.IResolvable	Property businessInfo: The business information.
chargeType	string | @alicloud/ros-cdk-core.IResolvable	Property chargeType: The billing method of the instance.values:PostPaid: Pay-As-You-Go.PrePaid: Subscription.Default value: PostPaid.
couponNo	string | @alicloud/ros-cdk-core.IResolvable	Property couponNo: The coupon code.
databaseNames	string | @alicloud/ros-cdk-core.IResolvable	Property databaseNames: The name of the database.
dbInstanceDescription	string | @alicloud/ros-cdk-core.IResolvable	Property dbInstanceDescription: Description of created database instance.
engineVersion	string | @alicloud/ros-cdk-core.IResolvable	Property engineVersion: Database instance version.
hiddenZoneId	string | @alicloud/ros-cdk-core.IResolvable	Property hiddenZoneId: Configure the zone where the hidden node resides to implement multi-availability zone deployment.
period	number | @alicloud/ros-cdk-core.IResolvable	Property period: The subscription period of the instance.Default Unit: Month.Valid values: [1~9], 12, 24, 36. Default to 1.
privateConnections	@alicloud/ros-cdk-core.IResolvable | PrivateConnectionsProperty	Property privateConnections: Connection configs of private connection.
readonlyReplicas	number | @alicloud/ros-cdk-core.IResolvable	Property readonlyReplicas: Number of read-only nodes, in the range of 1-5.
replicationFactor	number | @alicloud/ros-cdk-core.IResolvable	Property replicationFactor: The number of nodes in the replica set.
resourceGroupId	string | @alicloud/ros-cdk-core.IResolvable	Property resourceGroupId: The ID of the resource group.
restoreTime	string | @alicloud/ros-cdk-core.IResolvable	Property restoreTime: The time to restore the cloned instance to.
secondaryZoneId	string | @alicloud/ros-cdk-core.IResolvable	Property secondaryZoneId: Configure the zone where the secondary node resides to implement multi-availability zone deployment.
securityGroupId	string | @alicloud/ros-cdk-core.IResolvable	Property securityGroupId: The ID of the ECS security group.
securityIpArray	string | @alicloud/ros-cdk-core.IResolvable	Property securityIpArray: Security ips to add or remove.
srcDbInstanceId	string | @alicloud/ros-cdk-core.IResolvable	Property srcDbInstanceId: Create an instance of the backup set based on an instance.
storageEngine	string | @alicloud/ros-cdk-core.IResolvable	Property storageEngine: Database storage engine.Support WiredTiger, RocksDB, TerarkDB.
storageType	string | @alicloud/ros-cdk-core.IResolvable	Property storageType: The storage type of the instance.
tags	TagsProperty[]	Property tags: Tags to attach to instance.
tdeStatus	boolean | @alicloud/ros-cdk-core.IResolvable	Property tdeStatus: Specifies whether to enable Transparent Data Encryption (TDE).
vpcId	string | @alicloud/ros-cdk-core.IResolvable	Property vpcId: The VPC id to create mongodb instance.
vpcPasswordFree	boolean | @alicloud/ros-cdk-core.IResolvable	Property vpcPasswordFree: Specifies whether to enable password free for access within the VPC.
vSwitchId	string | @alicloud/ros-cdk-core.IResolvable	Property vSwitchId: The vSwitch Id to create mongodb instance.
zoneId	string | @alicloud/ros-cdk-core.IResolvable	Property zoneId: On which zone to create the instance.

---

dbInstanceClass^Required

public readonly dbInstanceClass: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceClass: MongoDB instance supported instance type, make sure it should be correct.

---

dbInstanceStorage^Required

public readonly dbInstanceStorage: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceStorage: Database instance storage size.

MongoDB is [5,3000], increased every 10 GB, Unit in GB

---

accountPassword^Optional

public readonly accountPassword: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property accountPassword: Root account password, can contain the letters, numbers or underscores the composition, length of 6~32 bit.

---

autoRenew^Optional

public readonly autoRenew: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoRenew: Indicates whether automatic renewal is enabled for the instance.

Valid values:true: Automatic renewal is enabled.false: Automatic renewal is not enabled. You must renew the instance manually.Default value: false.

---

backupId^Optional

public readonly backupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property backupId: Specific backup set Id.

---

businessInfo^Optional

public readonly businessInfo: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property businessInfo: The business information.

It is an additional parameter.

---

chargeType^Optional

public readonly chargeType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property chargeType: The billing method of the instance.values:PostPaid: Pay-As-You-Go.PrePaid: Subscription.Default value: PostPaid.

---

couponNo^Optional

public readonly couponNo: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property couponNo: The coupon code.

Default value:youhuiquan_promotion_option_id_for_blank.

---

databaseNames^Optional

public readonly databaseNames: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property databaseNames: The name of the database.

---

dbInstanceDescription^Optional

public readonly dbInstanceDescription: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceDescription: Description of created database instance.

---

engineVersion^Optional

public readonly engineVersion: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property engineVersion: Database instance version.

---

hiddenZoneId^Optional

public readonly hiddenZoneId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property hiddenZoneId: Configure the zone where the hidden node resides to implement multi-availability zone deployment.

When the value of the EngineVersion is 4.4 and later, this parameter is available and required. The value of this parameter cannot be the same as that of ZoneId and SecondaryZoneId.

---

period^Optional

public readonly period: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property period: The subscription period of the instance.Default Unit: Month.Valid values: [1~9], 12, 24, 36. Default to 1.

---

privateConnections^Optional

public readonly privateConnections: IResolvable | PrivateConnectionsProperty;

• Type: @alicloud/ros-cdk-core.IResolvable | PrivateConnectionsProperty

Property privateConnections: Connection configs of private connection.

---

readonlyReplicas^Optional

public readonly readonlyReplicas: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property readonlyReplicas: Number of read-only nodes, in the range of 1-5.

---

replicationFactor^Optional

public readonly replicationFactor: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property replicationFactor: The number of nodes in the replica set.

Allowed values: [3, 5, 7], default to 3.

---

resourceGroupId^Optional

public readonly resourceGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group.

---

restoreTime^Optional

public readonly restoreTime: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property restoreTime: The time to restore the cloned instance to.

The format is yyyy-MM-ddTHH:mm:ssZ.This parameter can only be specified when this operation is called to clone instances.You must also specify theSrcDBInstanceIdparameter and theBackupIdparameter.You can clone instances to any restore time in the past seven days.

---

secondaryZoneId^Optional

public readonly secondaryZoneId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property secondaryZoneId: Configure the zone where the secondary node resides to implement multi-availability zone deployment.

When the value of the EngineVersion is 4.4 and later, this parameter is available and required.The value of this parameter cannot be the same as that of ZoneId and HiddenZoneId.

---

securityGroupId^Optional

public readonly securityGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property securityGroupId: The ID of the ECS security group.

Each ApsaraDB for MongoDB instance can be added in up to 10 security group. You can call the ECS DescribeSecurityGroup to describe the ID of the security group in the target region.

---

securityIpArray^Optional

public readonly securityIpArray: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property securityIpArray: Security ips to add or remove.

---

srcDbInstanceId^Optional

public readonly srcDbInstanceId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property srcDbInstanceId: Create an instance of the backup set based on an instance.

---

storageEngine^Optional

public readonly storageEngine: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property storageEngine: Database storage engine.Support WiredTiger, RocksDB, TerarkDB.

---

storageType^Optional

public readonly storageType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property storageType: The storage type of the instance.

Instances of MongoDB 4.4 and later only support cloud disks. cloud_essd1 is selected if you leave this parameter empty. Instances of MongoDB 4.2 and earlier support only local disks. local_ssd is selected if you leave this parameter empty.

---

tags^Optional

public readonly tags: TagsProperty[];

• Type: TagsProperty[]

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

---

tdeStatus^Optional

public readonly tdeStatus: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property tdeStatus: Specifies whether to enable Transparent Data Encryption (TDE).

Valid values: true: enable TDE false: disable TDE (default) Note: You cannot disable TDE after it is enabled.

---

vpcId^Optional

public readonly vpcId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpcId: The VPC id to create mongodb instance.

---

vpcPasswordFree^Optional

public readonly vpcPasswordFree: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property vpcPasswordFree: Specifies whether to enable password free for access within the VPC.

If set to: - true: enables password free. - false: disables password free.

---

vSwitchId^Optional

public readonly vSwitchId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The vSwitch Id to create mongodb instance.

---

zoneId^Optional

public readonly zoneId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property zoneId: On which zone to create the instance.

If VpcId and VSwitchId is specified, ZoneId is required and VSwitch should be in same zone.

---