Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer 

import com.aliyun.ros.cdk.mongodb.InstanceProps;
InstanceProps.builder()
    .dbInstanceClass(java.lang.String)
    .dbInstanceClass(IResolvable)
    .dbInstanceStorage(java.lang.Number)
    .dbInstanceStorage(IResolvable)
//  .accountPassword(java.lang.String)
//  .accountPassword(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .backupId(java.lang.String)
//  .backupId(IResolvable)
//  .businessInfo(java.lang.String)
//  .businessInfo(IResolvable)
//  .chargeType(java.lang.String)
//  .chargeType(IResolvable)
//  .couponNo(java.lang.String)
//  .couponNo(IResolvable)
//  .databaseNames(java.lang.String)
//  .databaseNames(IResolvable)
//  .dbInstanceDescription(java.lang.String)
//  .dbInstanceDescription(IResolvable)
//  .engineVersion(java.lang.String)
//  .engineVersion(IResolvable)
//  .hiddenZoneId(java.lang.String)
//  .hiddenZoneId(IResolvable)
//  .networkType(java.lang.String)
//  .networkType(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .readonlyReplicas(java.lang.Number)
//  .readonlyReplicas(IResolvable)
//  .replicationFactor(java.lang.Number)
//  .replicationFactor(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .restoreTime(java.lang.String)
//  .restoreTime(IResolvable)
//  .secondaryZoneId(java.lang.String)
//  .secondaryZoneId(IResolvable)
//  .securityGroupId(java.lang.String)
//  .securityGroupId(IResolvable)
//  .securityIpArray(java.lang.String)
//  .securityIpArray(IResolvable)
//  .srcDbInstanceId(java.lang.String)
//  .srcDbInstanceId(IResolvable)
//  .storageEngine(java.lang.String)
//  .storageEngine(IResolvable)
//  .storageType(java.lang.String)
//  .storageType(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .tdeStatus(java.lang.Boolean)
//  .tdeStatus(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vpcPasswordFree(java.lang.Boolean)
//  .vpcPasswordFree(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();

Properties

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

dbInstanceClassRequired 

public java.lang.Object getDbInstanceClass();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

dbInstanceStorageRequired 

public java.lang.Object getDbInstanceStorage();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceStorage: Database instance storage size.

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

accountPasswordOptional 

public java.lang.Object getAccountPassword();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getAutoRenew();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getBackupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property backupId: Specific backup set Id.

businessInfoOptional 

public java.lang.Object getBusinessInfo();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property businessInfo: The business information.

It is an additional parameter.

chargeTypeOptional 

public java.lang.Object getChargeType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getCouponNo();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property couponNo: The coupon code.

Default value:youhuiquan_promotion_option_id_for_blank.

databaseNamesOptional 

public java.lang.Object getDatabaseNames();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property databaseNames: The name of the database.

dbInstanceDescriptionOptional 

public java.lang.Object getDbInstanceDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceDescription: Description of created database instance.

engineVersionOptional 

public java.lang.Object getEngineVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property engineVersion: Database instance version.

hiddenZoneIdOptional 

public java.lang.Object getHiddenZoneId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getNetworkType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property networkType: The instance network type.

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

periodOptional 

public java.lang.Object getPeriod();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getReadonlyReplicas();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

replicationFactorOptional 

public java.lang.Object getReplicationFactor();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

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

resourceGroupIdOptional 

public java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

restoreTimeOptional 

public java.lang.Object getRestoreTime();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSecondaryZoneId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSecurityGroupId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSecurityIpArray();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property securityIpArray: Security ips to add or remove.

srcDbInstanceIdOptional 

public java.lang.Object getSrcDbInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

storageEngineOptional 

public java.lang.Object getStorageEngine();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

storageTypeOptional 

public java.lang.Object getStorageType();
  • Type: java.lang.String OR com.aliyun.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 java.util.List<TagsProperty> getTags();

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 java.lang.Object getTdeStatus();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: The VPC id to create mongodb instance.

vpcPasswordFreeOptional 

public java.lang.Object getVpcPasswordFree();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The vSwitch Id to create mongodb instance.

zoneIdOptional 

public java.lang.Object getZoneId();
  • Type: java.lang.String OR com.aliyun.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.