Skip to content

VCUInstanceProps

Properties for defining a VCUInstance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ots-vcuinstance

Initializer

import { VCUInstanceProps } from '@alicloud/ros-cdk-ots'
const vCUInstanceProps: VCUInstanceProps = { ... }

Properties

Name Type Description
clusterType string | @alicloud/ros-cdk-core.IResolvable Property clusterType: Cluster type (i.e. instance specification). Enumeration values: SSD: High performance. HYBRID: Capacity type.
periodInMonth number | @alicloud/ros-cdk-core.IResolvable Property periodInMonth: Purchase duration.
vcu number | @alicloud/ros-cdk-core.IResolvable Property vcu: Number of VCU units.
aliasName string | @alicloud/ros-cdk-core.IResolvable Property aliasName: Instance alias name.
autoRenewPeriodInMonth number | @alicloud/ros-cdk-core.IResolvable Property autoRenewPeriodInMonth: Automatic renewal cycle.
enableAutoRenew boolean | @alicloud/ros-cdk-core.IResolvable Property enableAutoRenew: Whether to enable automatic renewal.
enableElasticVcu boolean | @alicloud/ros-cdk-core.IResolvable Property enableElasticVcu: Whether to enable instance elasticity.
instanceDescription string | @alicloud/ros-cdk-core.IResolvable Property instanceDescription: Instance description.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource Group ID.
tags TagsProperty[] Property tags: The list of instance tags in the form of key\/value pairs.

clusterTypeRequired

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

Property clusterType: Cluster type (i.e. instance specification). Enumeration values: SSD: High performance. HYBRID: Capacity type.


periodInMonthRequired

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

Property periodInMonth: Purchase duration.

Unit: month. Value range: 1~24.


vcuRequired

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

Property vcu: Number of VCU units.

Value range: 0~2000.


aliasNameOptional

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

Property aliasName: Instance alias name.


autoRenewPeriodInMonthOptional

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

Property autoRenewPeriodInMonth: Automatic renewal cycle.

When automatic renewal is enabled, it is required. Value range: 1~24.


enableAutoRenewOptional

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

Property enableAutoRenew: Whether to enable automatic renewal.


enableElasticVcuOptional

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

Property enableElasticVcu: Whether to enable instance elasticity.

If elasticity is enabled, the peak VCU usage of the instance can exceed the purchased VCU amount, but there will be additional charges.


instanceDescriptionOptional

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

Property instanceDescription: Instance description.


resourceGroupIdOptional

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

Property resourceGroupId: Resource Group ID.


tagsOptional

public readonly tags: TagsProperty[];

Property tags: The list of instance tags in the form of key\/value pairs.

You can define a maximum of 20 tags for instance.