RosKubernetesCluster

This class is a base encapsulation around the ROS resource type ALIYUN::CS::KubernetesCluster, which is used to create a Container Service for Kubernetes (ACK) dedicated cluster.

Initializers

import ros_cdk_cs
ros_cdk_cs.RosKubernetesCluster(
  scope: Construct,
  id: str,
  master_instance_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  master_v_switch_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  name: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  worker_v_switch_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  addons: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AddonsProperty]]] = None,
  auto_renew: typing.Union[bool, IResolvable] = None,
  auto_renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  charge_type: typing.Union[str, IResolvable] = None,
  cloud_monitor_flags: typing.Union[bool, IResolvable] = None,
  container_cidr: typing.Union[str, IResolvable] = None,
  cpu_policy: typing.Union[str, IResolvable] = None,
  delete_options: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DeleteOptionsProperty]]] = None,
  deletion_protection: typing.Union[bool, IResolvable] = None,
  disable_rollback: typing.Union[bool, IResolvable] = None,
  endpoint_public_access: typing.Union[bool, IResolvable] = None,
  format_disk: typing.Union[bool, IResolvable] = None,
  is_enterprise_security_group: typing.Union[bool, IResolvable] = None,
  keep_instance_name: typing.Union[bool, IResolvable] = None,
  key_pair: typing.Union[str, IResolvable] = None,
  kubernetes_version: typing.Union[str, IResolvable] = None,
  load_balancer_spec: typing.Union[str, IResolvable] = None,
  login_password: typing.Union[str, IResolvable] = None,
  master_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  master_data_disk: typing.Union[bool, IResolvable] = None,
  master_data_disks: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, MasterDataDisksProperty]]] = None,
  master_system_disk_category: typing.Union[str, IResolvable] = None,
  master_system_disk_performance_level: typing.Union[str, IResolvable] = None,
  master_system_disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  master_system_disk_snapshot_policy_id: typing.Union[str, IResolvable] = None,
  master_zone_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  node_cidr_mask: typing.Union[str, IResolvable] = None,
  node_name_mode: typing.Union[str, IResolvable] = None,
  node_pools: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, NodePoolsProperty]]] = None,
  node_port_range: typing.Union[str, IResolvable] = None,
  num_of_nodes: typing.Union[typing.Union[int, float], IResolvable] = None,
  os_type: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  platform: typing.Union[str, IResolvable] = None,
  pod_vswitch_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  proxy_mode: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  runtime: typing.Union[IResolvable, RuntimeProperty] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  security_hardening_os: typing.Union[bool, IResolvable] = None,
  service_cidr: typing.Union[str, IResolvable] = None,
  snat_entry: typing.Union[bool, IResolvable] = None,
  soc_enabled: typing.Union[bool, IResolvable] = None,
  ssh_flags: typing.Union[bool, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  taint: typing.Union[IResolvable, typing.List[typing.Mapping[typing.Any]]] = None,
  timeout_mins: typing.Union[typing.Union[int, float], IResolvable] = None,
  time_zone: typing.Union[str, IResolvable] = None,
  user_ca: typing.Union[str, IResolvable] = None,
  user_data: typing.Union[str, IResolvable] = None,
  worker_data_disk: typing.Union[bool, IResolvable] = None,
  worker_data_disks: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, WorkerDataDisksProperty]]] = None,
  worker_instance_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  worker_system_disk_category: typing.Union[str, IResolvable] = None,
  worker_system_disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  worker_system_disk_snapshot_policy_id: typing.Union[str, IResolvable] = None,
  worker_zone_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  enable_resource_property_constraint: bool
)

Name	Type	Description
scope	ros_cdk_core.Construct	- scope in which this resource is defined.
id	str	- scoped id of the resource.
master_instance_types	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
master_v_switch_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
name	typing.Union[str, ros_cdk_core.IResolvable]	No description.
vpc_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
worker_v_switch_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
addons	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AddonsProperty]]]	No description.
auto_renew	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
auto_renew_period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
charge_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
cloud_monitor_flags	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
container_cidr	typing.Union[str, ros_cdk_core.IResolvable]	No description.
cpu_policy	typing.Union[str, ros_cdk_core.IResolvable]	No description.
delete_options	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DeleteOptionsProperty]]]	No description.
deletion_protection	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
disable_rollback	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
endpoint_public_access	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
format_disk	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
is_enterprise_security_group	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
keep_instance_name	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
key_pair	typing.Union[str, ros_cdk_core.IResolvable]	No description.
kubernetes_version	typing.Union[str, ros_cdk_core.IResolvable]	No description.
load_balancer_spec	typing.Union[str, ros_cdk_core.IResolvable]	No description.
login_password	typing.Union[str, ros_cdk_core.IResolvable]	No description.
master_count	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
master_data_disk	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
master_data_disks	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, MasterDataDisksProperty]]]	No description.
master_system_disk_category	typing.Union[str, ros_cdk_core.IResolvable]	No description.
master_system_disk_performance_level	typing.Union[str, ros_cdk_core.IResolvable]	No description.
master_system_disk_size	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
master_system_disk_snapshot_policy_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
master_zone_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
node_cidr_mask	typing.Union[str, ros_cdk_core.IResolvable]	No description.
node_name_mode	typing.Union[str, ros_cdk_core.IResolvable]	No description.
node_pools	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, NodePoolsProperty]]]	No description.
node_port_range	typing.Union[str, ros_cdk_core.IResolvable]	No description.
num_of_nodes	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
os_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
period_unit	typing.Union[str, ros_cdk_core.IResolvable]	No description.
platform	typing.Union[str, ros_cdk_core.IResolvable]	No description.
pod_vswitch_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
proxy_mode	typing.Union[str, ros_cdk_core.IResolvable]	No description.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
runtime	typing.Union[ros_cdk_core.IResolvable, RuntimeProperty]	No description.
security_group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
security_hardening_os	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
service_cidr	typing.Union[str, ros_cdk_core.IResolvable]	No description.
snat_entry	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
soc_enabled	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
ssh_flags	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
tags	typing.List[TagsProperty]	No description.
taint	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Mapping[typing.Any]]]	No description.
timeout_mins	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
time_zone	typing.Union[str, ros_cdk_core.IResolvable]	No description.
user_ca	typing.Union[str, ros_cdk_core.IResolvable]	No description.
user_data	typing.Union[str, ros_cdk_core.IResolvable]	No description.
worker_data_disk	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
worker_data_disks	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, WorkerDataDisksProperty]]]	No description.
worker_instance_types	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
worker_system_disk_category	typing.Union[str, ros_cdk_core.IResolvable]	No description.
worker_system_disk_size	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
worker_system_disk_snapshot_policy_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
worker_zone_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

scope in which this resource is defined.

---

id^Required

• Type: str

scoped id of the resource.

---

master_instance_types^Required

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

---

master_v_switch_ids^Required

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

---

name^Required

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

---

vpc_id^Required

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

---

worker_v_switch_ids^Required

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

---

addons^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AddonsProperty]]]

---

auto_renew^Optional

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

---

auto_renew_period^Optional

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

---

charge_type^Optional

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

---

cloud_monitor_flags^Optional

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

---

container_cidr^Optional

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

---

cpu_policy^Optional

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

---

delete_options^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DeleteOptionsProperty]]]

---

deletion_protection^Optional

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

---

disable_rollback^Optional

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

---

endpoint_public_access^Optional

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

---

format_disk^Optional

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

---

is_enterprise_security_group^Optional

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

---

keep_instance_name^Optional

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

---

key_pair^Optional

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

---

kubernetes_version^Optional

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

---

load_balancer_spec^Optional

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

---

login_password^Optional

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

---

master_count^Optional

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

---

master_data_disk^Optional

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

---

master_data_disks^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, MasterDataDisksProperty]]]

---

master_system_disk_category^Optional

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

---

master_system_disk_performance_level^Optional

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

---

master_system_disk_size^Optional

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

---

master_system_disk_snapshot_policy_id^Optional

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

---

master_zone_ids^Optional

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

---

node_cidr_mask^Optional

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

---

node_name_mode^Optional

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

---

node_pools^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, NodePoolsProperty]]]

---

node_port_range^Optional

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

---

num_of_nodes^Optional

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

---

os_type^Optional

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

---

period^Optional

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

---

period_unit^Optional

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

---

platform^Optional

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

---

pod_vswitch_ids^Optional

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

---

proxy_mode^Optional

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

---

resource_group_id^Optional

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

---

runtime^Optional

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

---

security_group_id^Optional

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

---

security_hardening_os^Optional

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

---

service_cidr^Optional

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

---

snat_entry^Optional

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

---

soc_enabled^Optional

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

---

ssh_flags^Optional

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

---

tags^Optional

• Type: typing.List[TagsProperty]

---

taint^Optional

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

---

timeout_mins^Optional

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

---

time_zone^Optional

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

---

user_ca^Optional

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

---

user_data^Optional

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

---

worker_data_disk^Optional

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

---

worker_data_disks^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, WorkerDataDisksProperty]]]

---

worker_instance_types^Optional

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

---

worker_system_disk_category^Optional

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

---

worker_system_disk_size^Optional

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

---

worker_system_disk_snapshot_policy_id^Optional

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

---

worker_zone_ids^Optional

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

---

enable_resource_property_constraint^Required

• 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.
override_logical_id	Overrides the auto-generated logical ID with a specific ID.
add_condition	No description.
add_count	No description.
add_deletion_override	Syntactic sugar for addOverride(path, undefined).
add_depends_on	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
add_desc	No description.
add_meta_data	No description.
add_override	Adds an override to the synthesized ROS resource.
add_property_deletion_override	Adds an override that deletes the value of a property from the resource definition.
add_property_override	Adds an override to a resource property.
add_ros_dependency	No description.
apply_removal_policy	Sets the deletion policy of the resource based on the removal policy specified.
get_att	Returns a token for an runtime attribute of this resource.

---

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.

---

override_logical_id

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

---

add_condition

def add_condition(
  con: RosCondition
) -> None

con^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_deletion_override

def add_deletion_override(
  path: str
) -> None

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: str

The path of the value to delete.

---

add_depends_on

def add_depends_on(
  target: RosResource
) -> None

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

target^Required

• Type: ros_cdk_core.RosResource

---

add_desc

def add_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

add_meta_data

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

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

add_override

def add_override(
  path: str,
  value: typing.Any
) -> None

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

path^Required

• Type: str

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

---

value^Required

• Type: typing.Any

The value.

Could be primitive or complex.

---

add_property_deletion_override

def add_property_deletion_override(
  property_path: str
) -> None

Adds an override that deletes the value of a property from the resource definition.

property_path^Required

• Type: str

The path to the property.

---

add_property_override

def add_property_override(
  property_path: str,
  value: typing.Any
) -> None

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

property_path^Required

• Type: str

The path of the property.

---

value^Required

• Type: typing.Any

The value.

---

add_ros_dependency

def add_ros_dependency(
  target: str
) -> None

target^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy = None,
  apply_to_update_replace_policy: bool = None,
  default_policy: RemovalPolicy = None
) -> None

Sets the deletion policy of the resource based on the removal policy specified.

policy^Optional

• Type: ros_cdk_core.RemovalPolicy

---

apply_to_update_replace_policy^Optional

• Type: bool

---

default_policy^Optional

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  attribute_name: str
) -> Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attribute_name^Required

• Type: str

The name of the attribute.

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.
is_ros_element	Returns true if a construct is a stack element (i.e. part of the synthesized template).
is_ros_resource	Check whether the given construct is a RosResource.

---

is_construct

import ros_cdk_cs
ros_cdk_cs.RosKubernetesCluster.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

is_ros_element

import ros_cdk_cs
ros_cdk_cs.RosKubernetesCluster.is_ros_element(
  x: typing.Any
)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

x^Required

• Type: typing.Any

---

is_ros_resource

import ros_cdk_cs
ros_cdk_cs.RosKubernetesCluster.is_ros_resource(
  construct: IConstruct
)

Check whether the given construct is a RosResource.

construct^Required

• Type: ros_cdk_core.IConstruct

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
creation_stack	typing.List[str]	No description.
logical_id	str	The logical ID for this stack element.
stack	ros_cdk_core.Stack	The stack in which this element is defined.
ref	str	Return a string that will be resolved to a RosTemplate { Ref } for this element.
ros_options	ros_cdk_core.IRosResourceOptions	Options for this resource, such as condition, update policy etc.
ros_resource_type	str	ROS resource type.
attr_api_server_slb_id	ros_cdk_core.IResolvable	No description.
attr_cluster_id	ros_cdk_core.IResolvable	No description.
attr_default_user_kube_config	ros_cdk_core.IResolvable	No description.
attr_ingress_slb_id	ros_cdk_core.IResolvable	No description.
attr_nodes	ros_cdk_core.IResolvable	No description.
attr_private_user_kub_config	ros_cdk_core.IResolvable	No description.
attr_scaling_configuration_id	ros_cdk_core.IResolvable	No description.
attr_scaling_group_id	ros_cdk_core.IResolvable	No description.
attr_scaling_rule_id	ros_cdk_core.IResolvable	No description.
attr_task_id	ros_cdk_core.IResolvable	No description.
attr_worker_ram_role_name	ros_cdk_core.IResolvable	No description.
enable_resource_property_constraint	bool	No description.
master_instance_types	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
master_v_switch_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
name	typing.Union[str, ros_cdk_core.IResolvable]	No description.
vpc_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
worker_v_switch_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
addons	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AddonsProperty]]]	No description.
auto_renew	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
auto_renew_period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
charge_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
cloud_monitor_flags	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
container_cidr	typing.Union[str, ros_cdk_core.IResolvable]	No description.
cpu_policy	typing.Union[str, ros_cdk_core.IResolvable]	No description.
delete_options	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DeleteOptionsProperty]]]	No description.
deletion_protection	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
disable_rollback	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
endpoint_public_access	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
format_disk	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
is_enterprise_security_group	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
keep_instance_name	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
key_pair	typing.Union[str, ros_cdk_core.IResolvable]	No description.
kubernetes_version	typing.Union[str, ros_cdk_core.IResolvable]	No description.
load_balancer_spec	typing.Union[str, ros_cdk_core.IResolvable]	No description.
login_password	typing.Union[str, ros_cdk_core.IResolvable]	No description.
master_count	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
master_data_disk	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
master_data_disks	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, MasterDataDisksProperty]]]	No description.
master_system_disk_category	typing.Union[str, ros_cdk_core.IResolvable]	No description.
master_system_disk_performance_level	typing.Union[str, ros_cdk_core.IResolvable]	No description.
master_system_disk_size	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
master_system_disk_snapshot_policy_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
master_zone_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
node_cidr_mask	typing.Union[str, ros_cdk_core.IResolvable]	No description.
node_name_mode	typing.Union[str, ros_cdk_core.IResolvable]	No description.
node_pools	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, NodePoolsProperty]]]	No description.
node_port_range	typing.Union[str, ros_cdk_core.IResolvable]	No description.
num_of_nodes	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
os_type	typing.Union[str, ros_cdk_core.IResolvable]	No description.
period	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
period_unit	typing.Union[str, ros_cdk_core.IResolvable]	No description.
platform	typing.Union[str, ros_cdk_core.IResolvable]	No description.
pod_vswitch_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
proxy_mode	typing.Union[str, ros_cdk_core.IResolvable]	No description.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
runtime	typing.Union[ros_cdk_core.IResolvable, RuntimeProperty]	No description.
security_group_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
security_hardening_os	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
service_cidr	typing.Union[str, ros_cdk_core.IResolvable]	No description.
snat_entry	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
soc_enabled	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
ssh_flags	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
tags	typing.List[TagsProperty]	No description.
taint	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Mapping[typing.Any]]]	No description.
timeout_mins	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
time_zone	typing.Union[str, ros_cdk_core.IResolvable]	No description.
user_ca	typing.Union[str, ros_cdk_core.IResolvable]	No description.
user_data	typing.Union[str, ros_cdk_core.IResolvable]	No description.
worker_data_disk	typing.Union[bool, ros_cdk_core.IResolvable]	No description.
worker_data_disks	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, WorkerDataDisksProperty]]]	No description.
worker_instance_types	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.
worker_system_disk_category	typing.Union[str, ros_cdk_core.IResolvable]	No description.
worker_system_disk_size	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	No description.
worker_system_disk_snapshot_policy_id	typing.Union[str, ros_cdk_core.IResolvable]	No description.
worker_zone_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	No description.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

---

logical_id^Required

logical_id: str

• Type: str

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

---

ref^Required

ref: str

• Type: str

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

ros_options^Required

ros_options: IRosResourceOptions

• Type: ros_cdk_core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.

---

ros_resource_type^Required

ros_resource_type: str

• Type: str

ROS resource type.

---

attr_api_server_slb_id^Required

attr_api_server_slb_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_cluster_id^Required

attr_cluster_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_default_user_kube_config^Required

attr_default_user_kube_config: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_ingress_slb_id^Required

attr_ingress_slb_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_nodes^Required

attr_nodes: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_private_user_kub_config^Required

attr_private_user_kub_config: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_scaling_configuration_id^Required

attr_scaling_configuration_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_scaling_group_id^Required

attr_scaling_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_scaling_rule_id^Required

attr_scaling_rule_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_task_id^Required

attr_task_id: IResolvable

• Type: ros_cdk_core.IResolvable

---

attr_worker_ram_role_name^Required

attr_worker_ram_role_name: IResolvable

• Type: ros_cdk_core.IResolvable

---

enable_resource_property_constraint^Required

enable_resource_property_constraint: bool

• Type: bool

---

master_instance_types^Required

master_instance_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]

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

---

master_v_switch_ids^Required

master_v_switch_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]

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

---

name^Required

name: typing.Union[str, IResolvable]

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

---

vpc_id^Required

vpc_id: typing.Union[str, IResolvable]

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

---

worker_v_switch_ids^Required

worker_v_switch_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]

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

---

addons^Optional

addons: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AddonsProperty]]]

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AddonsProperty]]]

---

auto_renew^Optional

auto_renew: typing.Union[bool, IResolvable]

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

---

auto_renew_period^Optional

auto_renew_period: typing.Union[typing.Union[int, float], IResolvable]

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

---

charge_type^Optional

charge_type: typing.Union[str, IResolvable]

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

---

cloud_monitor_flags^Optional

cloud_monitor_flags: typing.Union[bool, IResolvable]

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

---

container_cidr^Optional

container_cidr: typing.Union[str, IResolvable]

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

---

cpu_policy^Optional

cpu_policy: typing.Union[str, IResolvable]

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

---

delete_options^Optional

delete_options: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DeleteOptionsProperty]]]

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DeleteOptionsProperty]]]

---

deletion_protection^Optional

deletion_protection: typing.Union[bool, IResolvable]

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

---

disable_rollback^Optional

disable_rollback: typing.Union[bool, IResolvable]

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

---

endpoint_public_access^Optional

endpoint_public_access: typing.Union[bool, IResolvable]

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

---

format_disk^Optional

format_disk: typing.Union[bool, IResolvable]

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

---

is_enterprise_security_group^Optional

is_enterprise_security_group: typing.Union[bool, IResolvable]

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

---

keep_instance_name^Optional

keep_instance_name: typing.Union[bool, IResolvable]

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

---

key_pair^Optional

key_pair: typing.Union[str, IResolvable]

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

---

kubernetes_version^Optional

kubernetes_version: typing.Union[str, IResolvable]

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

---

load_balancer_spec^Optional

load_balancer_spec: typing.Union[str, IResolvable]

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

---

login_password^Optional

login_password: typing.Union[str, IResolvable]

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

---

master_count^Optional

master_count: typing.Union[typing.Union[int, float], IResolvable]

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

---

master_data_disk^Optional

master_data_disk: typing.Union[bool, IResolvable]

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

---

master_data_disks^Optional

master_data_disks: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, MasterDataDisksProperty]]]

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, MasterDataDisksProperty]]]

---

master_system_disk_category^Optional

master_system_disk_category: typing.Union[str, IResolvable]

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

---

master_system_disk_performance_level^Optional

master_system_disk_performance_level: typing.Union[str, IResolvable]

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

---

master_system_disk_size^Optional

master_system_disk_size: typing.Union[typing.Union[int, float], IResolvable]

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

---

master_system_disk_snapshot_policy_id^Optional

master_system_disk_snapshot_policy_id: typing.Union[str, IResolvable]

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

---

master_zone_ids^Optional

master_zone_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]

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

---

node_cidr_mask^Optional

node_cidr_mask: typing.Union[str, IResolvable]

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

---

node_name_mode^Optional

node_name_mode: typing.Union[str, IResolvable]

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

---

node_pools^Optional

node_pools: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, NodePoolsProperty]]]

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, NodePoolsProperty]]]

---

node_port_range^Optional

node_port_range: typing.Union[str, IResolvable]

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

---

num_of_nodes^Optional

num_of_nodes: typing.Union[typing.Union[int, float], IResolvable]

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

---

os_type^Optional

os_type: typing.Union[str, IResolvable]

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

---

period^Optional

period: typing.Union[typing.Union[int, float], IResolvable]

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

---

period_unit^Optional

period_unit: typing.Union[str, IResolvable]

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

---

platform^Optional

platform: typing.Union[str, IResolvable]

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

---

pod_vswitch_ids^Optional

pod_vswitch_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]

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

---

proxy_mode^Optional

proxy_mode: typing.Union[str, IResolvable]

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

---

resource_group_id^Optional

resource_group_id: typing.Union[str, IResolvable]

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

---

runtime^Optional

runtime: typing.Union[IResolvable, RuntimeProperty]

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

---

security_group_id^Optional

security_group_id: typing.Union[str, IResolvable]

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

---

security_hardening_os^Optional

security_hardening_os: typing.Union[bool, IResolvable]

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

---

service_cidr^Optional

service_cidr: typing.Union[str, IResolvable]

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

---

snat_entry^Optional

snat_entry: typing.Union[bool, IResolvable]

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

---

soc_enabled^Optional

soc_enabled: typing.Union[bool, IResolvable]

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

---

ssh_flags^Optional

ssh_flags: typing.Union[bool, IResolvable]

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

---

tags^Optional

tags: typing.List[TagsProperty]

• Type: typing.List[TagsProperty]

---

taint^Optional

taint: typing.Union[IResolvable, typing.List[typing.Mapping[typing.Any]]]

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

---

timeout_mins^Optional

timeout_mins: typing.Union[typing.Union[int, float], IResolvable]

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

---

time_zone^Optional

time_zone: typing.Union[str, IResolvable]

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

---

user_ca^Optional

user_ca: typing.Union[str, IResolvable]

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

---

user_data^Optional

user_data: typing.Union[str, IResolvable]

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

---

worker_data_disk^Optional

worker_data_disk: typing.Union[bool, IResolvable]

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

---

worker_data_disks^Optional

worker_data_disks: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, WorkerDataDisksProperty]]]

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, WorkerDataDisksProperty]]]

---

worker_instance_types^Optional

worker_instance_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]

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

---

worker_system_disk_category^Optional

worker_system_disk_category: typing.Union[str, IResolvable]

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

---

worker_system_disk_size^Optional

worker_system_disk_size: typing.Union[typing.Union[int, float], IResolvable]

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

---

worker_system_disk_snapshot_policy_id^Optional

worker_system_disk_snapshot_policy_id: typing.Union[str, IResolvable]

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

---

worker_zone_ids^Optional

worker_zone_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]

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

---

Constants

Name	Type	Description
ROS_RESOURCE_TYPE_NAME	str	The resource type name for this resource class.

---

ROS_RESOURCE_TYPE_NAME^Required

ROS_RESOURCE_TYPE_NAME: str

• Type: str

The resource type name for this resource class.

---