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

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: The password of the root account.

The password must meet the following requirements: - It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. - Special characters include !@#$%^&*()_+-= - It must be 8 to 32 characters in length.

auditPolicyOptions^Optional

public readonly auditPolicyOptions: IResolvable | AuditPolicyOptionsProperty;

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

Property auditPolicyOptions: Audit policy options.

autoRenew^Optional

public readonly autoRenew: boolean | IResolvable;

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

Property autoRenew: Specifies whether to enable auto-renewal for the instance.

Valid values: - true: Auto-renewal is enabled. - false: Auto-renewal is disabled. You must manually renew the instance. This is the default value.

This parameter is optional and takes effect only when you set the ChargeType parameter to PrePaid.

backupId^Optional

public readonly backupId: string | IResolvable;

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

Property backupId: The backup point ID.

To query the backup point ID, call the DescribeBackups operation.

You must specify this parameter and the SrcDBInstanceId parameter only when you clone an instance based on a backup point.

backupPolicyOptions^Optional

public readonly backupPolicyOptions: IResolvable | BackupPolicyOptionsProperty;

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

Property backupPolicyOptions: Backup policy options.

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.

clusterId^Optional

public readonly clusterId: string | IResolvable;

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

Property clusterId: The dedicated cluster ID.

couponNo^Optional

public readonly couponNo: string | IResolvable;

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

Property couponNo: Specifies whether to use a coupon.

Valid values: - default or null (default): Uses a coupon. - youhuiquan_promotion_option_id_for_blank: Does not use a coupon.

databaseNames^Optional

public readonly databaseNames: string | IResolvable;

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

Property databaseNames: The database name.

When you clone an instance, you can specify this parameter to clone specific databases. If you do not specify this parameter, all databases of the instance are cloned.

dbInstanceDescription^Optional

public readonly dbInstanceDescription: string | IResolvable;

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

Property dbInstanceDescription: The name of the instance.

The name must meet the following requirements: - It must start with a Chinese character or a letter. - It can contain digits, Chinese characters, letters, underscores (_), periods (.), and hyphens (-). - It must be 2 to 256 characters in length.

dbInstanceReleaseProtection^Optional

public readonly dbInstanceReleaseProtection: boolean | IResolvable;

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

Property dbInstanceReleaseProtection: Enables instance release protection.

Values: - true: Enabled. - false: Not enabled.

encrypted^Optional

public readonly encrypted: boolean | IResolvable;

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

Property encrypted: Whether to enable cloud disk encryption.

encryptionKey^Optional

public readonly encryptionKey: string | IResolvable;

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

Property encryptionKey: Custom key ID.

engineVersion^Optional

public readonly engineVersion: string | IResolvable;

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

Property engineVersion: The database version.

Valid values: - 8.0 - 7.0 - 6.0 - 5.0 - 4.4 - 4.2 - 4.0

• When you clone an instance by calling this operation, the value of this parameter must be the same as that of the source instance.

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 duration of the instance.

Unit: month. Valid values: 1 to 9 (integer), 12, 24, 36, and 60.

This parameter is required and takes effect only when you set the ChargeType parameter to PrePaid.

privateConnections^Optional

public readonly privateConnections: IResolvable | PrivateConnectionsProperty;

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

Property privateConnections: Connection configs of private connection.

provisionedIops^Optional

public readonly provisionedIops: number | IResolvable;

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

Property provisionedIops: Provisioned IOPS.

The value range is 0 to 50000.

readonlyReplicas^Optional

public readonly readonlyReplicas: number | IResolvable;

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

Property readonlyReplicas: The number of read-only nodes in the replica set instance.

Valid values are integers from 0 to 5. The default value is 0.

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.

restoreType^Optional

public readonly restoreType: number | IResolvable;

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

Property restoreType: The method to restore an instance from a backup.

0: Restores the instance to a specified backup set. - 1: Restores the instance to a specified point in time. - 2: Restores a released instance to a specified backup set. - 3: Restores the instance to a specified geo-redundant backup set.

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.

Update to this property will cover the current security ips.

srcDbInstanceId^Optional

public readonly srcDbInstanceId: string | IResolvable;

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

Property srcDbInstanceId: The source instance ID.

This parameter is required only when you clone an instance by calling this operation. You must also specify the RestoreTime parameter.

srcRegion^Optional

public readonly srcRegion: string | IResolvable;

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

Property srcRegion: The source instance region.

• When the backup recovery type is 2 or 3, this parameter is required.

sslOptions^Optional

public readonly sslOptions: IResolvable | SSLOptionsProperty;

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

Property sslOptions: SSL options.

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.