ClusterApplication

• Implements: IClusterApplication

This class encapsulates and extends the ROS resource type ALIYUN::CS::ClusterApplicationThe , which resource type deploys containerized applications.

Initializers

import ros_cdk_cs
ros_cdk_cs.ClusterApplication(
  scope: Construct,
  id: str,
  cluster_id: typing.Union[str, IResolvable],
  yaml_content: typing.Union[str, IResolvable],
  creation_mode: typing.Union[str, IResolvable] = None,
  default_namespace: typing.Union[str, IResolvable] = None,
  default_namespace_deletion: typing.Union[bool, IResolvable] = None,
  role_policy: typing.Union[str, IResolvable] = None,
  stage: typing.Union[str, IResolvable] = None,
  validation_mode: typing.Union[str, IResolvable] = None,
  wait_until: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, WaitUntilProperty]]] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

cluster_id^Required

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

Property clusterId: The ID of the kubernetes cluster.

yaml_content^Required

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

Property yamlContent: The yaml content of application.

creation_mode^Optional

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

Property creationMode: Creation modes include: - Normal: create new resources, will report error if already exists.

• Apply: similar to kubectl apply, create if not exists, update if exists. During the deletion phase, ROS will delete newly created application, but updated existing application will not be deleted.

default_namespace^Optional

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

Property defaultNamespace: The default namespace for the application, default value is default.

If a namespace is defined in yaml metadata, its priority is higher than DefaultNamespace. If the DefaultNamespace does not exist, ROS will create it automatically and keep it by default during the delete phase.

default_namespace_deletion^Optional

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

Property defaultNamespaceDeletion: Whether to delete the namespace specified by DefaultNamespace.

If DefaultNamespace is in ('default', 'kube-node-lease', 'kube-public', 'kube-system', 'arms-prom'), no matter whether DefaultNamespaceDeletion is true or not, it will not be deleted.

role_policy^Optional

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

Property rolePolicy: Before deploying the application, check the policies associated with the roles of the current user.

Valid values:

• EnsureAdminRoleAndBinding: Automatically create a role named "ros:application-admin:${user-id}" with administrator permissions and bind it to the current user.
• None: Do nothing. The default value is EnsureAdminRoleAndBinding.

stage^Optional

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

Property stage: At what stage to run.

Valid values:

• All: all stages, including create, update, and delete.
• Delete: the delete stage. This means that only in the deletion stage of this resource will apply yaml to the cluster. The default is All.

validation_mode^Optional

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

Property validationMode: Validation modes include: - Basic: basic validation, such as verifying the existence of a cluster.

• Strict: in addition to basic validation, also validate the legality of YamlContent and WaitUntil.

wait_until^Optional

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

Property waitUntil: After starting a creation or update, wait until all conditions are met.

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

import ros_cdk_cs
ros_cdk_cs.ClusterApplication.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: The ID of the cluster.

attr_wait_until_data^Required

attr_wait_until_data: typing.Union[str, IResolvable]

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

Attribute WaitUntilData: A list of values for each JsonPath in WaitUntil.

props^Required

props: ClusterApplicationProps

• Type: ClusterApplicationProps