KubernetesCluster

• Implements: ros_cdk_cs.datasource.IKubernetesCluster

This class encapsulates and extends the ROS resource type DATASOURCE::CS::KubernetesCluster, which is used to query the information about a Container Service for Kubernetes (ACK) cluster.

Initializers

from ros_cdk_cs import datasource
datasource.KubernetesCluster(
  scope: Construct,
  id: str,
  cluster_id: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

cluster_id^Optional

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

Property clusterId: Cluster instance ID.

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• 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

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

from ros_cdk_cs import datasource
datasource.KubernetesCluster.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_cluster_id^Required

attr_cluster_id: typing.Union[str, IResolvable]

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

Attribute ClusterId: Cluster instance ID.

attr_cluster_spec^Required

attr_cluster_spec: typing.Union[str, IResolvable]

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

Attribute ClusterSpec: The type of the managed Kubernetes cluster.

This parameter is returned for a managed Kubernetes cluster. Valid values:

• ack.pro.small: professional managed Kubernetes cluster.
• ack.standard: standard managed Kubernetes cluster.

attr_cluster_type^Required

attr_cluster_type: typing.Union[str, IResolvable]

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

Attribute ClusterType: The type of the cluster.

Valid values:

• Kubernetes: dedicated Kubernetes cluster
• ManagedKubernetes: managed Kubernetes cluster
• Ask: ASK cluster
• ExternalKubernetes: registered external Kubernetes cluster

attr_created^Required

attr_created: typing.Union[str, IResolvable]

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

Attribute Created: The time when the cluster was created.

attr_current_version^Required

attr_current_version: typing.Union[str, IResolvable]

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

Attribute CurrentVersion: The current Kubernetes version of the cluster.

For more information about the Kubernetes versions supported by ACK, see Release notes for Kubernetes versions.

attr_deletion_protection^Required

attr_deletion_protection: typing.Union[str, IResolvable]

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

Attribute DeletionProtection: Indicates whether deletion protection is enabled.

If deletion protection is enabled, the cluster cannot be deleted in the ACK console or by calling the API. Valid values:

• true: Deletion protection is enabled. You cannot delete the cluster in the ACK console or by calling the API.
• false: Deletion protection is not enabled. You can delete the cluster in the ACK console or by calling the API.

attr_docker_version^Required

attr_docker_version: typing.Union[str, IResolvable]

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

Attribute DockerVersion: The Docker version that is used by the cluster.

attr_external_loadbalancer_id^Required

attr_external_loadbalancer_id: typing.Union[str, IResolvable]

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

Attribute ExternalLoadbalancerId: The ID of the Server Load Balancer (SLB) instance that is used for the Ingress of the cluster.

attr_init_version^Required

attr_init_version: typing.Union[str, IResolvable]

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

Attribute InitVersion: The Kubernetes version that is initially used by the cluster.

attr_maintenance_window^Required

attr_maintenance_window: typing.Union[str, IResolvable]

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

Attribute MaintenanceWindow: The maintenance window of the cluster.

This feature is available in only professional managed Kubernetes clusters.

attr_master_url^Required

attr_master_url: typing.Union[str, IResolvable]

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

Attribute MasterUrl: The address of the cluster.

It includes an internal endpoint and a public endpoint.

attr_meta_data^Required

attr_meta_data: typing.Union[str, IResolvable]

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

Attribute MetaData: The metadata of the cluster.

attr_name^Required

attr_name: typing.Union[str, IResolvable]

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

Attribute Name: The name of the cluster.

The name must be 1 to 63 characters in length, and can contain digits, letters, and hyphens (-). It cannot start with a hyphen (-).

attr_network_mode^Required

attr_network_mode: typing.Union[str, IResolvable]

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

Attribute NetworkMode: The network mode of the cluster.

Valid values:

• classic: the classic network
• vpc: virtual private cloud (VPC)
• overlay: overlay network
• calico: network powered by Calico Default value: vpc.

attr_next_version^Required

attr_next_version: typing.Union[str, IResolvable]

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

Attribute NextVersion: The Kubernetes version to which the cluster can be upgraded.

attr_parameters^Required

attr_parameters: typing.Union[str, IResolvable]

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

Attribute Parameters: A collection of cluster ROS parameters.

attr_private_zone^Required

attr_private_zone: typing.Union[str, IResolvable]

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

Attribute PrivateZone: Indicates whether Alibaba Cloud DNS PrivateZone is enabled.

• true: indicates that Alibaba Cloud DNS PrivateZone is enabled.- false: indicates that Alibaba Cloud DNS PrivateZone is not enabled.

attr_profile^Required

attr_profile: typing.Union[str, IResolvable]

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

Attribute Profile: Indicates the scenario in which the cluster is used.

Valid values:

• Default: indicates that the cluster is used in non-edge computing scenarios.
• Edge: indicates that the ACK cluster is used in edge computing scenarios.

attr_region_id^Required

attr_region_id: typing.Union[str, IResolvable]

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

Attribute RegionId: The ID of the region where the cluster is deployed.

attr_resource_group_id^Required

attr_resource_group_id: typing.Union[str, IResolvable]

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

Attribute ResourceGroupId: The ID of the resource group to which the cluster belongs.

attr_security_group_id^Required

attr_security_group_id: typing.Union[str, IResolvable]

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

Attribute SecurityGroupId: The ID of the security group to which the instances of the cluster belong.

attr_service_cidr^Required

attr_service_cidr: typing.Union[str, IResolvable]

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

Attribute ServiceCidr: The cluster service cidr.

attr_size^Required

attr_size: typing.Union[str, IResolvable]

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

Attribute Size: The number of nodes in the cluster.

Master nodes and worker nodes are included.

attr_state^Required

attr_state: typing.Union[str, IResolvable]

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

Attribute State: The state of the cluster.

Valid values:

• initial: The cluster is being created.
• failed: The cluster failed to be created.
• running: The cluster is running.
• updating: The cluster is being upgraded.
• updating_failed: The cluster failed to be upgraded.
• scaling: The cluster is being scaled.
• waiting: The registered cluster is waiting for connecting.
• disconnected: The registeredcluster is disconnected.
• stopped: The cluster is stopped.
• deleting: The cluster is being deleted.
• deleted: The cluster is deleted.
• delete_failed: The cluster failed to be deleted.

attr_subnet_cidr^Required

attr_subnet_cidr: typing.Union[str, IResolvable]

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

Attribute SubnetCidr: The pod CIDR block.

It must be a valid and private CIDR block, and must be one of the following CIDR blocks or their subnets:

• 10.0.0.0/8
• 172.16-31.0.0/12-16
• 192.168.0.0/16 The pod CIDR block cannot overlap with that of the VPC or those of the ACK clusters that are deployed in the VPC. For more information about the network segmentation of ACK clusters, see Plan CIDR blocks for ACK clusters in a VPC.

attr_tags^Required

attr_tags: typing.Union[str, IResolvable]

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

Attribute Tags: The labels of the cluster.

attr_updated^Required

attr_updated: typing.Union[str, IResolvable]

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

Attribute Updated: The time when the cluster was updated.

attr_vpc_id^Required

attr_vpc_id: typing.Union[str, IResolvable]

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

Attribute VpcId: The ID of the VPC where the cluster is deployed.

This parameter is required when you create an ACK cluster.

attr_v_switch_id^Required

attr_v_switch_id: typing.Union[str, IResolvable]

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

Attribute VSwitchId: The IDs of the vSwitches.

You can select one to three vSwitches when you create an ACK cluster. vSwitches in different zones are recommended to ensure high availability.

attr_v_switch_ids^Required

attr_v_switch_ids: typing.Union[str, IResolvable]

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

Attribute VSwitchIds: The list of cluster control plane VSwitch ID.

attr_worker_ram_role_name^Required

attr_worker_ram_role_name: typing.Union[str, IResolvable]

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

Attribute WorkerRamRoleName: The name of the worker RAM role.

The RAM role is assigned to the worker nodes of the cluster and allows the worker nodes to manage Elastic Compute Service (ECS) instances.

attr_zone_id^Required

attr_zone_id: typing.Union[str, IResolvable]

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

Attribute ZoneId: The ID of the zone where the cluster is deployed.

props^Required

props: KubernetesClusterProps

• Type: KubernetesClusterProps