Skip to content

ClusterProps

Properties for defining a Cluster.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-foas-cluster

Initializer 

import { ClusterProps } from '@alicloud/ros-cdk-foas'
const clusterProps: ClusterProps = { ... }

Properties

Name Type Description
clusterName string | @alicloud/ros-cdk-core.IResolvable Property clusterName: Cluster name.
description string | @alicloud/ros-cdk-core.IResolvable Property description: Cluster description.
ossBucket string | @alicloud/ros-cdk-core.IResolvable Property ossBucket: Bucket name in your OSS.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: VSwitch ID.
order @alicloud/ros-cdk-core.IResolvable | OrderProperty Property order: Order detail.
orderId string | @alicloud/ros-cdk-core.IResolvable Property orderId: Order Id.

clusterNameRequired 

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

Property clusterName: Cluster name.

It begins with a letter, and contains only lowercase English letters, numbers, underscores (_), and is limited to 3-64 characters.

descriptionRequired 

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

Property description: Cluster description.

ossBucketRequired 

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

Property ossBucket: Bucket name in your OSS.

vSwitchIdRequired 

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

Property vSwitchId: VSwitch ID.

orderOptional 

public readonly order: IResolvable | OrderProperty;

Property order: Order detail.

Only one of property Order or OrderId can be specified. Order is not suggested. Policy AliyunBSSFullAccess must be granted to StreamDefaultRole in RAM console. The order can not be cancelled.

orderIdOptional 

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

Property orderId: Order Id.

Only one of property Order or OrderId can be specified. OrderId is suggested.