Skip to content

Cluster

This class encapsulates and extends the ROS resource type ALIYUN::EDAS::Cluster, which is used to create a cluster.

Initializers

import ros_cdk_edas
ros_cdk_edas.Cluster(
  scope: Construct,
  id: str,
  cluster_name: typing.Union[str, IResolvable],
  cluster_type: typing.Union[typing.Union[int, float], IResolvable],
  network_mode: typing.Union[typing.Union[int, float], IResolvable],
  logical_region_id: typing.Union[str, IResolvable] = None,
  oversold_factor: typing.Union[typing.Union[int, float], IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  vpc_id: typing.Union[str, 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: Cluster name.
cluster_type typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property clusterType: Cluster type.
network_mode typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property networkMode: Network Type.
logical_region_id typing.Union[str, ros_cdk_core.IResolvable] Property logicalRegionId: Custom namespace RegionId (format: Physical Region: custom namespace identifier).
oversold_factor typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property oversoldFactor: Docker CPU cluster oversold.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group id.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: VPC network ID.
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: Cluster name.


cluster_typeRequired

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

Property clusterType: Cluster type.

1-Swarm cluster, 2-ECS cluster, 3-Kubernetes Cluster


network_modeRequired

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

Property networkMode: Network Type.

1- classic network, 2-VPC


logical_region_idOptional

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

Property logicalRegionId: Custom namespace RegionId (format: Physical Region: custom namespace identifier).


oversold_factorOptional

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

Property oversoldFactor: Docker CPU cluster oversold.

Support 2 (1: 2 ratio) / 4 (1: 4) / 8 (1: 8 ratio)


resource_group_idOptional

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

Property resourceGroupId: Resource group id.


vpc_idOptional

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

Property vpcId: VPC network ID.

If network selection VPC, this parameter Required


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.
fetch_condition No description.
fetch_dependency No description.
fetch_resource_desc 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

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

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_edas
ros_cdk_edas.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.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
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_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ClusterId: Cluster ID.
attr_cluster_name typing.Union[str, ros_cdk_core.IResolvable] Attribute ClusterName: Cluster name.
attr_cluster_type typing.Union[str, ros_cdk_core.IResolvable] Attribute ClusterType: Cluster type.
attr_iaas_provider typing.Union[str, ros_cdk_core.IResolvable] Attribute IaasProvider: Provider.
props ClusterProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


envRequired

env: IResourceEnvironment
  • Type: 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

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_idRequired

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

Attribute ClusterId: Cluster ID.


attr_cluster_nameRequired

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

Attribute ClusterName: Cluster name.


attr_cluster_typeRequired

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

Attribute ClusterType: Cluster type.


attr_iaas_providerRequired

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

Attribute IaasProvider: Provider.


propsRequired

props: ClusterProps