Cluster

• Implements: ICluster

This class encapsulates and extends the ROS resource type ALIYUN::FOAS::Cluster.

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();

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

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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

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

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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 java.lang.Object getAttrClusterId();

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

Attribute ClusterId: Cluster ID.

attrEngineVersions^Required

public java.lang.Object getAttrEngineVersions();

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

Attribute EngineVersions: Engine Versions.

attrMasterInstanceInfos^Required

public java.lang.Object getAttrMasterInstanceInfos();

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

Attribute MasterInstanceInfos: Master instance infos.

attrOrderId^Required

public java.lang.Object getAttrOrderId();

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

Attribute OrderId: Order ID.

attrSecurityGroupId^Required

public java.lang.Object getAttrSecurityGroupId();

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

Attribute SecurityGroupId: Security group Id.

attrSlaveInstanceInfos^Required

public java.lang.Object getAttrSlaveInstanceInfos();

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

Attribute SlaveInstanceInfos: Slave instance infos.

attrState^Required

public java.lang.Object getAttrState();

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

Attribute State: Cluster status.

attrVSwitchIds^Required

public java.lang.Object getAttrVSwitchIds();

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

Attribute VSwitchIds: VSwitch Ids.

props^Required

public ClusterProps getProps();

• Type: ClusterProps