InstanceProps

Properties for defining a Instance.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Mongodb;
new InstanceProps {
    object DbInstanceClass,
    object DbInstanceStorage,
    object AccountPassword = null,
    object AutoRenew = null,
    object BackupId = null,
    object BusinessInfo = null,
    object ChargeType = null,
    object CouponNo = null,
    object DatabaseNames = null,
    object DbInstanceDescription = null,
    object EngineVersion = null,
    object HiddenZoneId = null,
    object Period = null,
    object PrivateConnections = null,
    object ReadonlyReplicas = null,
    object ReplicationFactor = null,
    object ResourceGroupId = null,
    object RestoreTime = null,
    object SecondaryZoneId = null,
    object SecurityGroupId = null,
    object SecurityIpArray = null,
    object SrcDbInstanceId = null,
    object StorageEngine = null,
    object StorageType = null,
    TagsProperty[] Tags = null,
    object TdeStatus = null,
    object VpcId = null,
    object VpcPasswordFree = null,
    object VSwitchId = null,
    object ZoneId = null
};

Properties

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

---

DbInstanceClass^Required

public object DbInstanceClass { get; set; }

• Type: object

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

---

DbInstanceStorage^Required

public object DbInstanceStorage { get; set; }

• Type: object

Property dbInstanceStorage: Database instance storage size.

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

---

AccountPassword^Optional

public object AccountPassword { get; set; }

• Type: object

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

---

AutoRenew^Optional

public object AutoRenew { get; set; }

• Type: object

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 object BackupId { get; set; }

• Type: object

Property backupId: Specific backup set Id.

---

BusinessInfo^Optional

public object BusinessInfo { get; set; }

• Type: object

Property businessInfo: The business information.

It is an additional parameter.

---

ChargeType^Optional

public object ChargeType { get; set; }

• Type: object

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

---

CouponNo^Optional

public object CouponNo { get; set; }

• Type: object

Property couponNo: The coupon code.

Default value:youhuiquan_promotion_option_id_for_blank.

---

DatabaseNames^Optional

public object DatabaseNames { get; set; }

• Type: object

Property databaseNames: The name of the database.

---

DbInstanceDescription^Optional

public object DbInstanceDescription { get; set; }

• Type: object

Property dbInstanceDescription: Description of created database instance.

---

EngineVersion^Optional

public object EngineVersion { get; set; }

• Type: object

Property engineVersion: Database instance version.

---

HiddenZoneId^Optional

public object HiddenZoneId { get; set; }

• Type: object

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 object Period { get; set; }

• Type: object

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

---

PrivateConnections^Optional

public object PrivateConnections { get; set; }

• Type: object

Property privateConnections: Connection configs of private connection.

---

ReadonlyReplicas^Optional

public object ReadonlyReplicas { get; set; }

• Type: object

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

---

ReplicationFactor^Optional

public object ReplicationFactor { get; set; }

• Type: object

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

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

---

ResourceGroupId^Optional

public object ResourceGroupId { get; set; }

• Type: object

Property resourceGroupId: The ID of the resource group.

---

RestoreTime^Optional

public object RestoreTime { get; set; }

• Type: object

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 object SecondaryZoneId { get; set; }

• Type: object

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 object SecurityGroupId { get; set; }

• Type: object

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 object SecurityIpArray { get; set; }

• Type: object

Property securityIpArray: Security ips to add or remove.

---

SrcDbInstanceId^Optional

public object SrcDbInstanceId { get; set; }

• Type: object

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

---

StorageEngine^Optional

public object StorageEngine { get; set; }

• Type: object

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

---

StorageType^Optional

public object StorageType { get; set; }

• Type: object

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 TagsProperty[] Tags { get; set; }

• 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 object TdeStatus { get; set; }

• Type: object

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 object VpcId { get; set; }

• Type: object

Property vpcId: The VPC id to create mongodb instance.

---

VpcPasswordFree^Optional

public object VpcPasswordFree { get; set; }

• Type: object

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 object VSwitchId { get; set; }

• Type: object

Property vSwitchId: The vSwitch Id to create mongodb instance.

---

ZoneId^Optional

public object ZoneId { get; set; }

• Type: object

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.

---