ClusterHelmApplication

This class encapsulates and extends the ROS resource type ALIYUN::CS::ClusterHelmApplication, which is used to deploy an application by using Helm.

Initializers

import ros_cdk_cs
ros_cdk_cs.ClusterHelmApplication(
  scope: Construct,
  id: str,
  chart_url: typing.Union[str, IResolvable],
  cluster_id: typing.Union[str, IResolvable],
  name: typing.Union[str, IResolvable],
  chart_values: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  credential: typing.Union[IResolvable, CredentialProperty] = None,
  namespace: typing.Union[str, IResolvable] = None,
  role_policy: 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
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
chart_url	typing.Union[str, ros_cdk_core.IResolvable]	Property chartUrl: The URL of chart.
cluster_id	typing.Union[str, ros_cdk_core.IResolvable]	Property clusterId: The ID of the kubernetes cluster.
name	typing.Union[str, ros_cdk_core.IResolvable]	Property name: The name for helm release.
chart_values	typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]	Property chartValues: Chart custom values.
credential	typing.Union[ros_cdk_core.IResolvable, CredentialProperty]	Property credential: The credential of ACR repo.
namespace	typing.Union[str, ros_cdk_core.IResolvable]	Property namespace: Namespace to use with helm.
role_policy	typing.Union[str, ros_cdk_core.IResolvable]	Property rolePolicy: Before deploying the application, check the policies associated with the roles of the current user.
validation_mode	typing.Union[str, ros_cdk_core.IResolvable]	Property validationMode: Validation modes include: - Basic: basic validation, such as verifying the existence of a cluster.
wait_until	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	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

chart_url^Required

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

Property chartUrl: The URL of chart.

Supports HTTP or HTTPS.

---

cluster_id^Required

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

Property clusterId: The ID of the kubernetes cluster.

---

name^Required

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

Property name: The name for helm release.

---

chart_values^Optional

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

Property chartValues: Chart custom values.

---

credential^Optional

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

Property credential: The credential of ACR repo.

Only take effects when ChartUrl is the address of ACR repo.

---

namespace^Optional

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

Property namespace: Namespace to use with helm.

Default is default. If the Namespace does not exist, ROS will automatically create it and delete it during the deletion phase.

---

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.

---

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 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

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.
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.

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

---

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

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
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	ros_cdk_core.IResolvable	Attribute ClusterId: The ID of the cluster.
attr_wait_until_data	ros_cdk_core.IResolvable	Attribute WaitUntilData: A list of values for each JsonPath in WaitUntil.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ClusterId: The ID of the cluster.

---

attr_wait_until_data^Required

attr_wait_until_data: IResolvable

• Type: ros_cdk_core.IResolvable

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

---