InstanceProps

Properties for defining a Instance.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkmongodb"
&alicloudroscdkmongodb.InstanceProps {
    DbInstanceClass: interface{},
    DbInstanceStorage: interface{},
    AccountPassword: interface{},
    AutoRenew: interface{},
    BackupId: interface{},
    BusinessInfo: interface{},
    ChargeType: interface{},
    CouponNo: interface{},
    DatabaseNames: interface{},
    DbInstanceDescription: interface{},
    EngineVersion: interface{},
    HiddenZoneId: interface{},
    Period: interface{},
    PrivateConnections: interface{},
    ReadonlyReplicas: interface{},
    ReplicationFactor: interface{},
    ResourceGroupId: interface{},
    RestoreTime: interface{},
    SecondaryZoneId: interface{},
    SecurityGroupId: interface{},
    SecurityIpArray: interface{},
    SrcDbInstanceId: interface{},
    StorageEngine: interface{},
    StorageType: interface{},
    Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkmongodb.RosInstance.TagsProperty,
    TdeStatus: interface{},
    VpcId: interface{},
    VpcPasswordFree: interface{},
    VSwitchId: interface{},
    ZoneId: interface{},
}

Properties

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

---

DbInstanceClass^Required

DbInstanceClass interface{}

• Type: interface{}

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

---

DbInstanceStorage^Required

DbInstanceStorage interface{}

• Type: interface{}

Property dbInstanceStorage: Database instance storage size.

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

---

AccountPassword^Optional

AccountPassword interface{}

• Type: interface{}

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

---

AutoRenew^Optional

AutoRenew interface{}

• Type: interface{}

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

BackupId interface{}

• Type: interface{}

Property backupId: Specific backup set Id.

---

BusinessInfo^Optional

BusinessInfo interface{}

• Type: interface{}

Property businessInfo: The business information.

It is an additional parameter.

---

ChargeType^Optional

ChargeType interface{}

• Type: interface{}

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

---

CouponNo^Optional

CouponNo interface{}

• Type: interface{}

Property couponNo: The coupon code.

Default value:youhuiquan_promotion_option_id_for_blank.

---

DatabaseNames^Optional

DatabaseNames interface{}

• Type: interface{}

Property databaseNames: The name of the database.

---

DbInstanceDescription^Optional

DbInstanceDescription interface{}

• Type: interface{}

Property dbInstanceDescription: Description of created database instance.

---

EngineVersion^Optional

EngineVersion interface{}

• Type: interface{}

Property engineVersion: Database instance version.

---

HiddenZoneId^Optional

HiddenZoneId interface{}

• Type: interface{}

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

Period interface{}

• Type: interface{}

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

---

PrivateConnections^Optional

PrivateConnections interface{}

• Type: interface{}

Property privateConnections: Connection configs of private connection.

---

ReadonlyReplicas^Optional

ReadonlyReplicas interface{}

• Type: interface{}

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

---

ReplicationFactor^Optional

ReplicationFactor interface{}

• Type: interface{}

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

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

---

ResourceGroupId^Optional

ResourceGroupId interface{}

• Type: interface{}

Property resourceGroupId: The ID of the resource group.

---

RestoreTime^Optional

RestoreTime interface{}

• Type: interface{}

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

SecondaryZoneId interface{}

• Type: interface{}

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

SecurityGroupId interface{}

• Type: interface{}

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

SecurityIpArray interface{}

• Type: interface{}

Property securityIpArray: Security ips to add or remove.

---

SrcDbInstanceId^Optional

SrcDbInstanceId interface{}

• Type: interface{}

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

---

StorageEngine^Optional

StorageEngine interface{}

• Type: interface{}

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

---

StorageType^Optional

StorageType interface{}

• Type: interface{}

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

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

TdeStatus interface{}

• Type: interface{}

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

VpcId interface{}

• Type: interface{}

Property vpcId: The VPC id to create mongodb instance.

---

VpcPasswordFree^Optional

VpcPasswordFree interface{}

• Type: interface{}

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

VSwitchId interface{}

• Type: interface{}

Property vSwitchId: The vSwitch Id to create mongodb instance.

---

ZoneId^Optional

ZoneId interface{}

• Type: interface{}

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.

---