Skip to content

DBInstanceProps

Properties for defining a DBInstance.

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

Initializer 

import { DBInstanceProps } from '@alicloud/ros-cdk-polardbx'
const dBInstanceProps: DBInstanceProps = { ... }

Properties

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

dbNodeClassRequired 

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

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

dbNodeCountRequired 

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

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

engineVersionRequired 

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

Property engineVersion: The version of the database engine.

primaryZoneRequired 

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

Property primaryZone: The primary zone.

topologyTypeRequired 

public readonly topologyType: string | IResolvable;
  • Type: string | @alicloud/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 readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

vSwitchIdRequired 

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

Property vSwitchId: The ID of the vSwitch.

autoRenewOptional 

public readonly autoRenew: boolean | IResolvable;
  • Type: boolean | @alicloud/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 readonly dbInstanceDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceDescription: The description of the instance.

payTypeOptional 

public readonly payType: string | IResolvable;
  • Type: string | @alicloud/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 readonly period: string | IResolvable;
  • Type: string | @alicloud/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 readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of resource group.

secondaryZoneOptional 

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

Property secondaryZone: The secondary zone.

securityIpConfigOptional 

public readonly securityIpConfig: IResolvable | SecurityIpConfigProperty;

Property securityIpConfig: Instance whitelist configuration.

tertiaryZoneOptional 

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

Property tertiaryZone: The tertiary zone.

usedTimeOptional 

public readonly usedTime: number | IResolvable;
  • Type: number | @alicloud/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.