ClusterApplication

• Implements: IClusterApplication

This class encapsulates and extends the ROS resource type ALIYUN::CS::ClusterApplication.

Initializers

import com.aliyun.ros.cdk.cs.ClusterApplication;
ClusterApplication.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .clusterId(java.lang.String)
    .clusterId(IResolvable)
    .yamlContent(java.lang.String)
    .yamlContent(IResolvable)
//  .creationMode(java.lang.String)
//  .creationMode(IResolvable)
//  .defaultNamespace(java.lang.String)
//  .defaultNamespace(IResolvable)
//  .defaultNamespaceDeletion(java.lang.Boolean)
//  .defaultNamespaceDeletion(IResolvable)
//  .rolePolicy(java.lang.String)
//  .rolePolicy(IResolvable)
//  .stage(java.lang.String)
//  .stage(IResolvable)
//  .validationMode(java.lang.String)
//  .validationMode(IResolvable)
//  .waitUntil(IResolvable)
//  .waitUntil(java.util.List<IResolvable)
//  .waitUntil(WaitUntilProperty>)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

clusterId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property clusterId: The ID of the kubernetes cluster.

yamlContent^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property yamlContent: The yaml content of application.

creationMode^Optional

• Type: java.lang.String OR com.aliyun.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.

defaultNamespace^Optional

• Type: java.lang.String OR com.aliyun.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.

defaultNamespaceDeletion^Optional

• Type: java.lang.Boolean OR com.aliyun.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.

rolePolicy^Optional

• Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.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.

validationMode^Optional

• Type: java.lang.String OR com.aliyun.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.

waitUntil^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListWaitUntilProperty>

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

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.cs.ClusterApplication;
ClusterApplication.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrClusterId^Required

public java.lang.Object getAttrClusterId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ClusterId: The ID of the cluster.

attrWaitUntilData^Required

public java.lang.Object getAttrWaitUntilData();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

props^Required

public ClusterApplicationProps getProps();

• Type: ClusterApplicationProps