Skip to content

ClusterApplication

This class encapsulates and extends the ROS resource type ALIYUN::CS::ClusterApplication, which is used to deploy an application in a Container Service for Kubernetes (ACK) cluster.

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)
//  .defaultNamespace(java.lang.String)
//  .defaultNamespace(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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
clusterId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property clusterId: The ID of the kubernetes cluster.
yamlContent java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property yamlContent: The yaml content of application.
defaultNamespace java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property defaultNamespace: The default namespace for the application, default value is default.
rolePolicy 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.
stage java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property stage: At what stage to run.
validationMode 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.
waitUntil com.aliyun.ros.cdk.core.IResolvable OR java.util.ListWaitUntilProperty> Property waitUntil: After starting a creation or update, wait until all conditions are met.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

clusterIdRequired

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

Property clusterId: The ID of the kubernetes cluster.

yamlContentRequired

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

Property yamlContent: The yaml content of application.

defaultNamespaceOptional

  • 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 automatically create it and delete it during the deletion phase.

rolePolicyOptional

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

stageOptional

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

validationModeOptional

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

waitUntilOptional

  • 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

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrClusterId com.aliyun.ros.cdk.core.IResolvable Attribute ClusterId: The ID of the cluster.
attrWaitUntilData com.aliyun.ros.cdk.core.IResolvable Attribute WaitUntilData: A list of values for each JsonPath in WaitUntil.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrClusterIdRequired 

public IResolvable getAttrClusterId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ClusterId: The ID of the cluster.

attrWaitUntilDataRequired 

public IResolvable getAttrWaitUntilData();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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