Cluster

This class encapsulates and extends the ROS resource type ALIYUN::FOAS::Cluster, which is used to create a cluster for an order in exclusive mode.

Initializers

import com.aliyun.ros.cdk.foas.Cluster;
Cluster.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .clusterName(java.lang.String)
    .clusterName(IResolvable)
    .description(java.lang.String)
    .description(IResolvable)
    .ossBucket(java.lang.String)
    .ossBucket(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
//  .order(IResolvable)
//  .order(OrderProperty)
//  .orderId(java.lang.String)
//  .orderId(IResolvable)
    .build();

Name	Type	Description
`scope`	`com.aliyun.ros.cdk.core.Construct`	No description.
`id`	`java.lang.String`	No description.
`enableResourcePropertyConstraint`	`java.lang.Boolean`	No description.
`clusterName`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property clusterName: Cluster name.
`description`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property description: Cluster description.
`ossBucket`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property ossBucket: Bucket name in your OSS.
`vSwitchId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property vSwitchId: VSwitch ID.
`order`	`com.aliyun.ros.cdk.core.IResolvable OR OrderProperty`	Property order: Order detail.
`orderId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property orderId: Order Id.

`scope`^Required

Type: com.aliyun.ros.cdk.core.Construct

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`clusterName`^Required

Type: java.lang.String OR com.aliyun.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.

`description`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: Cluster description.

`ossBucket`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property ossBucket: Bucket name in your OSS.

`vSwitchId`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: VSwitch ID.

`order`^Optional

Type: com.aliyun.ros.cdk.core.IResolvable OR 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.

`orderId`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property orderId: Order Id.

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

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`synthesize`	Allows this construct to emit artifacts into the cloud assembly during synthesis.
`addCondition`	No description.
`addCount`	No description.
`addDependency`	No description.
`addResourceDesc`	No description.
`applyRemovalPolicy`	No description.
`getAtt`	No description.
`setMetadata`	No description.

`toString`

public java.lang.String toString()

Returns a string representation of this construct.

`synthesize`

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

`addCondition`

public void addCondition(RosCondition condition)

condition^Required

Type: com.aliyun.ros.cdk.core.RosCondition

`addCount`

public void addCount(java.lang.Number OR IResolvable count)

count^Required

Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

`addDependency`

public void addDependency(Resource resource)

resource^Required

Type: com.aliyun.ros.cdk.core.Resource

`addResourceDesc`

public void addResourceDesc(java.lang.String desc)

desc^Required

Type: java.lang.String

`applyRemovalPolicy`

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

Type: com.aliyun.ros.cdk.core.RemovalPolicy

`getAtt`

public IResolvable getAtt(java.lang.String name)

name^Required

Type: java.lang.String

`setMetadata`

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

Type: java.lang.String

value^Required

Type: java.lang.Object

Static Functions

Name	Description
`isConstruct`	Return whether the given object is a Construct.

`isConstruct`

import com.aliyun.ros.cdk.foas.Cluster;
Cluster.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

Type: java.lang.Object

Properties

Name	Type	Description
`node`	`com.aliyun.ros.cdk.core.ConstructNode`	The construct tree node associated with this construct.
`ref`	`java.lang.String`	No description.
`stack`	`com.aliyun.ros.cdk.core.Stack`	The stack in which this resource is defined.
`resource`	`com.aliyun.ros.cdk.core.RosResource`	No description.
`attrClusterId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ClusterId: Cluster ID.
`attrEngineVersions`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute EngineVersions: Engine Versions.
`attrMasterInstanceInfos`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute MasterInstanceInfos: Master instance infos.
`attrOrderId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute OrderId: Order ID.
`attrSecurityGroupId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute SecurityGroupId: Security group Id.
`attrSlaveInstanceInfos`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute SlaveInstanceInfos: Slave instance infos.
`attrState`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute State: Cluster status.
`attrVSwitchIds`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute VSwitchIds: VSwitch Ids.

`node`^Required

public ConstructNode getNode();

Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

`ref`^Required

public java.lang.String getRef();

Type: java.lang.String

`stack`^Required

public Stack getStack();

Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

`resource`^Optional

public RosResource getResource();

Type: com.aliyun.ros.cdk.core.RosResource

`attrClusterId`^Required

public IResolvable getAttrClusterId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ClusterId: Cluster ID.

`attrEngineVersions`^Required

public IResolvable getAttrEngineVersions();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EngineVersions: Engine Versions.

`attrMasterInstanceInfos`^Required

public IResolvable getAttrMasterInstanceInfos();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute MasterInstanceInfos: Master instance infos.

`attrOrderId`^Required

public IResolvable getAttrOrderId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute OrderId: Order ID.

`attrSecurityGroupId`^Required

public IResolvable getAttrSecurityGroupId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SecurityGroupId: Security group Id.

`attrSlaveInstanceInfos`^Required

public IResolvable getAttrSlaveInstanceInfos();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SlaveInstanceInfos: Slave instance infos.

`attrState`^Required

public IResolvable getAttrState();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute State: Cluster status.

`attrVSwitchIds`^Required

public IResolvable getAttrVSwitchIds();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VSwitchIds: VSwitch Ids.

Cluster

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

clusterNameRequired

descriptionRequired

ossBucketRequired

vSwitchIdRequired

orderOptional

orderIdOptional

Methods

toString

synthesize

addCondition

addCount

addDependency

addResourceDesc

applyRemovalPolicy

getAtt

setMetadata