Skip to content

Cluster

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

Initializers

import ros_cdk_dashvector
ros_cdk_dashvector.Cluster(
  scope: Construct,
  id: str,
  cluster_name: typing.Union[str, IResolvable],
  cluster_type: typing.Union[str, IResolvable],
  replica_count: typing.Union[typing.Union[int, float], IResolvable],
  ignore_existing: typing.Union[bool, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
cluster_name typing.Union[str, ros_cdk_core.IResolvable] Property clusterName: The name of cluster.
cluster_type typing.Union[str, ros_cdk_core.IResolvable] Property clusterType: The type of cluster.
replica_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property replicaCount: The number of replicas.
ignore_existing typing.Union[bool, 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.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

cluster_nameRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property clusterName: The name of cluster.


cluster_typeRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property clusterType: The type of cluster.


replica_countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property replicaCount: The number of replicas.


ignore_existingOptional

  • Type: typing.Union[bool, 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.


enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct

import ros_cdk_dashvector
ros_cdk_dashvector.Cluster.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_cluster_name ros_cdk_core.IResolvable Attribute ClusterName: The name of the cluster.
attr_endpoint ros_cdk_core.IResolvable Attribute Endpoint: The endpoint of the cluster.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: The ID of the cluster.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


refRequired

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_cluster_nameRequired

attr_cluster_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ClusterName: The name of the cluster.


attr_endpointRequired

attr_endpoint: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Endpoint: The endpoint of the cluster.


attr_instance_idRequired

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: The ID of the cluster.