Cluster
- Implements: ICluster
This class encapsulates and extends the ROS resource type ALIYUN::DashVector::Cluster.
Initializers
import com.aliyun.ros.cdk.dashvector.Cluster;
Cluster.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.clusterName(java.lang.String)
.clusterName(IResolvable)
.clusterType(java.lang.String)
.clusterType(IResolvable)
.replicaCount(java.lang.Number)
.replicaCount(IResolvable)
// .ignoreExisting(java.lang.Boolean)
// .ignoreExisting(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: The name of cluster. |
clusterType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property clusterType: The type of cluster. |
replicaCount | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property replicaCount: The number of replicas. |
ignoreExisting | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property ignoreExisting: Whether to ignore existing dash vector cluster False: ROS will perform a uniqueness check.If the dash vector cluster exists, an error will be reported when creating it. True: ROS will not check the uniqueness.If the dash vector cluster exists, the creation process will be ignored. If the dash vector cluster is not created by ROS, it will be ignored during update and delete stage. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
clusterNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property clusterName: The name of cluster.
clusterTypeRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property clusterType: The type of cluster.
replicaCountRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property replicaCount: The number of replicas.
ignoreExistingOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property ignoreExisting: Whether to ignore existing dash vector cluster False: ROS will perform a uniqueness check.If the dash vector cluster exists, an error will be reported when creating it. True: ROS will not check the uniqueness.If the dash vector cluster exists, the creation process will be ignored. If the dash vector cluster is not created by ROS, it will be ignored during update and delete stage.
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.dashvector.Cluster;
Cluster.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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. |
attrClusterName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ClusterName: The name of the cluster. |
attrEndpoint | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Endpoint: The endpoint of the cluster. |
attrInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceId: The ID of the cluster. |
props | ClusterProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrClusterNameRequired
public java.lang.Object getAttrClusterName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ClusterName: The name of the cluster.
attrEndpointRequired
public java.lang.Object getAttrEndpoint();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Endpoint: The endpoint of the cluster.
attrInstanceIdRequired
public java.lang.Object getAttrInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceId: The ID of the cluster.
propsRequired
public ClusterProps getProps();
- Type: ClusterProps