Skip to content

DBInstanceProps

Properties for defining a DBInstance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardbx-dbinstance

Initializer

import com.aliyun.ros.cdk.polardbx.DBInstanceProps;
DBInstanceProps.builder()
    .dbNodeClass(java.lang.String)
    .dbNodeClass(IResolvable)
    .dbNodeCount(java.lang.Number)
    .dbNodeCount(IResolvable)
    .engineVersion(java.lang.String)
    .engineVersion(IResolvable)
    .primaryZone(java.lang.String)
    .primaryZone(IResolvable)
    .topologyType(java.lang.String)
    .topologyType(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .dbInstanceDescription(java.lang.String)
//  .dbInstanceDescription(IResolvable)
//  .payType(java.lang.String)
//  .payType(IResolvable)
//  .period(java.lang.String)
//  .period(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .secondaryZone(java.lang.String)
//  .secondaryZone(IResolvable)
//  .securityIpConfig(IResolvable)
//  .securityIpConfig(SecurityIpConfigProperty)
//  .tertiaryZone(java.lang.String)
//  .tertiaryZone(IResolvable)
//  .usedTime(java.lang.Number)
//  .usedTime(IResolvable)
    .build();

Properties

Name Type Description
dbNodeClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbNodeClass: The specification of the nodes in the instance you want to create.
dbNodeCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property dbNodeCount: The number of nodes in the instance you want to create.
engineVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property engineVersion: The version of the database engine.
primaryZone java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property primaryZone: The primary zone.
topologyType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property topologyType: The topology type of the instance.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The ID of the VPC to which the instance belongs.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The ID of the vSwitch.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoRenew: Specifies whether to enable auto-renewal for the instance.
dbInstanceDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceDescription: The description of the instance.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payType: The billing method of the instance.
period java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property period: The unit of the billing cycle for the instance.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of resource group.
secondaryZone java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property secondaryZone: The secondary zone.
securityIpConfig com.aliyun.ros.cdk.core.IResolvable OR SecurityIpConfigProperty Property securityIpConfig: Instance whitelist configuration.
tertiaryZone java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property tertiaryZone: The tertiary zone.
usedTime java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property usedTime: The subscription period of the instance.

dbNodeClassRequired

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

Property dbNodeClass: The specification of the nodes in the instance you want to create.


dbNodeCountRequired

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

Property dbNodeCount: The number of nodes in the instance you want to create.


engineVersionRequired

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

Property engineVersion: The version of the database engine.


primaryZoneRequired

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

Property primaryZone: The primary zone.


topologyTypeRequired

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

Property topologyType: The topology type of the instance.

Valid values: 3azones: The instance is deployed in three zones. 1azone: The instance is deployed in only one zone.


vpcIdRequired

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

Property vpcId: The ID of the VPC to which the instance belongs.


vSwitchIdRequired

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

Property vSwitchId: The ID of the vSwitch.


autoRenewOptional

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

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

Default value: true. true: Enable auto-renewal. false: Disable auto-renewal.


dbInstanceDescriptionOptional

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

Property dbInstanceDescription: The description of the instance.


payTypeOptional

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

Property payType: The billing method of the instance.

Default: POSTPAY.Valid values: PREPAY: subscription POSTPAY: pay-as-you-go


periodOptional

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

Property period: The unit of the billing cycle for the instance.

The valid values vary based on the billing method. If you use the subscription billing method, set the value to Year or Month. If you use the pay-as-you-go billing method, the value is automatically set to Hour.


resourceGroupIdOptional

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

Property resourceGroupId: The ID of resource group.


secondaryZoneOptional

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

Property secondaryZone: The secondary zone.


securityIpConfigOptional

public java.lang.Object getSecurityIpConfig();

Property securityIpConfig: Instance whitelist configuration.


tertiaryZoneOptional

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

Property tertiaryZone: The tertiary zone.


usedTimeOptional

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

Property usedTime: The subscription period of the instance.

Unit: month or year. Note When period is set to year, the supported values of this parameter are 1, 2 and 3.