Skip to content

AnyCluster

This class encapsulates and extends the ROS resource type ALIYUN::CS::AnyCluster, which is used to create a Container Service for Kubernetes (ACK) cluster of a specific type.

Initializers

import ros_cdk_cs
ros_cdk_cs.AnyCluster(
  scope: Construct,
  id: str,
  cluster_config: typing.Union[IResolvable, typing.Mapping[typing.Any]],
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
cluster_config typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property clusterConfig: Cluster config.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

cluster_configRequired

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property clusterConfig: Cluster config.


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_cs
ros_cdk_cs.AnyCluster.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_api_server_slb_id typing.Union[str, ros_cdk_core.IResolvable] Attribute APIServerSLBId: The id of API server SLB.
attr_cluster_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ClusterId: Cluster instance ID.
attr_default_user_kube_config typing.Union[str, ros_cdk_core.IResolvable] Attribute DefaultUserKubeConfig: Default user kubernetes config which is used for configuring cluster credentials.
attr_ingress_slb_id typing.Union[str, ros_cdk_core.IResolvable] Attribute IngressSLBId: The id of ingress SLB.
attr_nodes typing.Union[str, ros_cdk_core.IResolvable] Attribute Nodes: The list of cluster nodes.
attr_private_user_kub_config typing.Union[str, ros_cdk_core.IResolvable] Attribute PrivateUserKubConfig: Private user kubernetes config which is used for configuring cluster credentials.
attr_scaling_configuration_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ScalingConfigurationId: Scaling configuration id.
attr_scaling_group_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ScalingGroupId: Scaling group id.
attr_scaling_rule_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ScalingRuleId: Scaling rule id.
attr_task_id typing.Union[str, ros_cdk_core.IResolvable] Attribute TaskId: Task ID.
attr_worker_ram_role_name typing.Union[str, ros_cdk_core.IResolvable] Attribute WorkerRamRoleName: Worker ram role name.
props AnyClusterProps 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_api_server_slb_idRequired

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

Attribute APIServerSLBId: The id of API server SLB.


attr_cluster_idRequired

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

Attribute ClusterId: Cluster instance ID.


attr_default_user_kube_configRequired

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

Attribute DefaultUserKubeConfig: Default user kubernetes config which is used for configuring cluster credentials.


attr_ingress_slb_idRequired

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

Attribute IngressSLBId: The id of ingress SLB.


attr_nodesRequired

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

Attribute Nodes: The list of cluster nodes.


attr_private_user_kub_configRequired

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

Attribute PrivateUserKubConfig: Private user kubernetes config which is used for configuring cluster credentials.


attr_scaling_configuration_idRequired

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

Attribute ScalingConfigurationId: Scaling configuration id.


attr_scaling_group_idRequired

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

Attribute ScalingGroupId: Scaling group id.


attr_scaling_rule_idRequired

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

Attribute ScalingRuleId: Scaling rule id.


attr_task_idRequired

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

Attribute TaskId: Task ID.

Automatically assigned by the system, the user queries the task status.


attr_worker_ram_role_nameRequired

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

Attribute WorkerRamRoleName: Worker ram role name.


propsRequired

props: AnyClusterProps