Skip to content

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.
networkType string | @alicloud/ros-cdk-core.IResolvable Property networkType: The instance network type.
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.
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.

dbInstanceClassRequired 

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.

dbInstanceStorageRequired 

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

accountPasswordOptional 

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.

autoRenewOptional 

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.

backupIdOptional 

public readonly backupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property backupId: Specific backup set Id.

businessInfoOptional 

public readonly businessInfo: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property businessInfo: The business information.

It is an additional parameter.

chargeTypeOptional 

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.

couponNoOptional 

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.

databaseNamesOptional 

public readonly databaseNames: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property databaseNames: The name of the database.

dbInstanceDescriptionOptional 

public readonly dbInstanceDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceDescription: Description of created database instance.

engineVersionOptional 

public readonly engineVersion: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property engineVersion: Database instance version.

hiddenZoneIdOptional 

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.

networkTypeOptional 

public readonly networkType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property networkType: The instance network type.

Support 'CLASSIC' and 'VPC' only, default is 'CLASSIC'.

periodOptional 

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.

readonlyReplicasOptional 

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.

replicationFactorOptional 

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.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group.

restoreTimeOptional 

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.

secondaryZoneIdOptional 

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.

securityGroupIdOptional 

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.

securityIpArrayOptional 

public readonly securityIpArray: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property securityIpArray: Security ips to add or remove.

srcDbInstanceIdOptional 

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.

storageEngineOptional 

public readonly storageEngine: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

storageTypeOptional 

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.

tagsOptional 

public readonly tags: 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.

tdeStatusOptional 

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.

vpcIdOptional 

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpcId: The VPC id to create mongodb instance.

vpcPasswordFreeOptional 

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.

vSwitchIdOptional 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The vSwitch Id to create mongodb instance.

zoneIdOptional 

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.