ClusterAddons
- Implements: IClusterAddons
This class encapsulates and extends the ROS resource type ALIYUN::CS::ClusterAddons.
Initializers
import com.aliyun.ros.cdk.cs.ClusterAddons;
ClusterAddons.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.addons(IResolvable)
.addons(java.util.List<IResolvable)
.addons(AddonsProperty>)
.clusterId(java.lang.String)
.clusterId(IResolvable)
// .installedIgnore(java.lang.Boolean)
// .installedIgnore(IResolvable)
// .overrideExisting(java.lang.Boolean)
// .overrideExisting(IResolvable)
// .rolePolicy(java.lang.String)
// .rolePolicy(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. |
addons | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property addons: A combination of addon plugins for Kubernetes clusters. |
clusterId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property clusterId: Cluster ID. |
installedIgnore | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property installedIgnore: Whether to ignore already installed addons when creating. |
overrideExisting | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property overrideExisting: Whether to override configuration of already installed addons when creating. |
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. |
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.List | 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
addonsRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
AddonsProperty>
Property addons: A combination of addon plugins for Kubernetes clusters.
Network plug-in: including Flannel and Terway network plug-ins Log service: Optional. If the log service is not enabled, the cluster audit function cannot be used. Ingress: The installation of the Ingress component is enabled by default.
clusterIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property clusterId: Cluster ID.
installedIgnoreOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property installedIgnore: Whether to ignore already installed addons when creating.
If true, when creating, only install addons that are not yet installed. When deleting, only uninstall addons that are installed during the creation stage. Default false.
overrideExistingOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property overrideExisting: Whether to override configuration of already installed addons when creating.
If true, when creating, addons that already exist will have their configuration overridden, and addons that do not exist will be installed. When deleting, only uninstall addons that are installed during the creation stage. Cannot be used together with InstalledIgnore. Default false.
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.
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 WaitUntil.
waitUntilOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
WaitUntilProperty>
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.cs.ClusterAddons;
ClusterAddons.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ClusterId: The ID of the cluster. |
attrWaitUntilData | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute WaitUntilData: A list of values for each JsonPath in WaitUntil. |
props | ClusterAddonsProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
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 java.lang.Object getAttrClusterId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ClusterId: The ID of the cluster.
attrWaitUntilDataRequired
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.
propsRequired
public ClusterAddonsProps getProps();
- Type: ClusterAddonsProps