Cluster

• Implements: ICluster

This class encapsulates and extends the ROS resource type ALIYUN::ACS::Cluster.

Initializers

import com.aliyun.ros.cdk.acs.Cluster;
Cluster.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .name(java.lang.String)
    .name(IResolvable)
//  .addons(IResolvable)
//  .addons(java.util.List<IResolvable)
//  .addons(AddonsProperty>)
//  .clusterSpec(java.lang.String)
//  .clusterSpec(IResolvable)
//  .computeClass(java.lang.String)
//  .computeClass(IResolvable)
//  .deleteOptions(IResolvable)
//  .deleteOptions(java.util.List<IResolvable)
//  .deleteOptions(DeleteOptionsProperty>)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .endpointPublicAccess(java.lang.Boolean)
//  .endpointPublicAccess(IResolvable)
//  .ipStack(java.lang.String)
//  .ipStack(IResolvable)
//  .isEnterpriseSecurityGroup(java.lang.Boolean)
//  .isEnterpriseSecurityGroup(IResolvable)
//  .kubernetesVersion(java.lang.String)
//  .kubernetesVersion(IResolvable)
//  .loadBalancerSpec(java.lang.String)
//  .loadBalancerSpec(IResolvable)
//  .loggingType(java.lang.String)
//  .loggingType(IResolvable)
//  .maintenanceWindow(IResolvable)
//  .maintenanceWindow(MaintenanceWindowProperty)
//  .podPostpaidSpec(IResolvable)
//  .podPostpaidSpec(PodPostpaidSpecProperty)
//  .podVSwitchIds(IResolvable)
//  .podVSwitchIds(java.util.List<java.lang.String)
//  .podVSwitchIds(IResolvable>)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .serviceCidr(java.lang.String)
//  .serviceCidr(IResolvable)
//  .serviceDiscoveryTypes(IResolvable)
//  .serviceDiscoveryTypes(java.util.List<java.lang.String)
//  .serviceDiscoveryTypes(IResolvable>)
//  .slsProjectName(java.lang.String)
//  .slsProjectName(IResolvable)
//  .snatEntry(java.lang.Boolean)
//  .snatEntry(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .timeZone(java.lang.String)
//  .timeZone(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchIds(IResolvable)
//  .vSwitchIds(java.util.List<java.lang.String)
//  .vSwitchIds(IResolvable>)
//  .zoneIds(IResolvable)
//  .zoneIds(java.util.List<java.lang.String)
//  .zoneIds(IResolvable>)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

name^Required

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

Property name: The name of the cluster.

The cluster name can use uppercase and lowercase letters, Chinese characters, numbers, and dashes.

addons^Optional

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

Property addons: The add-ons to be installed for the cluster.

clusterSpec^Optional

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

Property clusterSpec: The managed cluster spec.

Value: ack.pro.small: Professional hosting cluster, namely: "ACK Pro version cluster". ack.standard: Standard hosting cluster. Default value: ack.pro.small.

computeClass^Optional

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

Property computeClass: The compute class of the cluster.

This parameter is only used as a parameter query for ZoneIds and is not used in the actual creation.

deleteOptions^Optional

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

Property deleteOptions: Delete options, only work for deleting resource.

deletionProtection^Optional

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

Property deletionProtection: Specifies whether to enable deletion protection for the cluster.

After deletion protection is enabled, the cluster cannot be deleted in the ACK console or by calling API operations. Valid values:true: enables deletion protection for the cluster. false: disables deletion protection for the cluster. Default value: false.

endpointPublicAccess^Optional

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

Property endpointPublicAccess: Whether to enable the public network API Server: true: which means that the public network API Server is open.

false: If set to false, the API server on the public network will not be created, only the API server on the private network will be created.Default to false.

ipStack^Optional

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

Property ipStack: The IP stack of the cluster.

isEnterpriseSecurityGroup^Optional

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

Property isEnterpriseSecurityGroup: Specifies whether to create an advanced security group.

This parameter takes effect only if security_group_id is left empty. Note You must specify an advanced security group for a cluster that has Terway installed. true: creates an advanced security group. false: does not create an advanced security group. Default value: false.

kubernetesVersion^Optional

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

Property kubernetesVersion: The version of the Kubernetes cluster.

loadBalancerSpec^Optional

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

Property loadBalancerSpec: The specification of the Server Load Balancer instance.

Allowed value: slb.s1.small|slb.s2.small|slb.s2.medium|slb.s3.small|slb.s3.medium|slb.s3.large

loggingType^Optional

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

Property loggingType: The logging type of the cluster.

By default, no logging service is used.

maintenanceWindow^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR MaintenanceWindowProperty

Property maintenanceWindow: The maintenance window of the cluster.

podPostpaidSpec^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR PodPostpaidSpecProperty

Property podPostpaidSpec: Postpaid pod spec for inquiry.

podVSwitchIds^Optional

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

Property podVSwitchIds: The list of pod vSwitches.

For each vSwitch that is allocated to nodes, you must specify at least one pod vSwitch in the same zone. The pod vSwitches cannot be the same as the node vSwitches. We recommend that you set the mask length of the CIDR block to a value no greater than 19 for the pod vSwitches. The pod_vswitch_ids parameter is required when the Terway network plug-in is selected for the cluster.

resourceGroupId^Optional

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

Property resourceGroupId: The ID of resource group.

serviceCidr^Optional

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

Property serviceCidr: The service network segment cannot conflict with the VPC network segment and the container network segment.

When the system is selected to automatically create a VPC, the network segment 172.19.0.0/20 is used by default.

serviceDiscoveryTypes^Optional

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

Property serviceDiscoveryTypes: Intra-cluster service discovery type, used to specify the service discovery method in the ASK cluster.

CoreDNS: To use Kubernetes native standard service discovery component CoreDNS, a set of containers needs to be deployed in the cluster for DNS resolution. By default, two ECI instances with a size of 0.25 Core and 512 MiB are used. PrivateZone: To use Alibaba Cloud PrivateZone products to provide service discovery capabilities, the PrivateZone service needs to be enabled. Default value: off

slsProjectName^Optional

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

Property slsProjectName: The SLS project name of the cluster.

If LoggingType is set to SLS and SlsProjectName is empty, a new Project is created.

snatEntry^Optional

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

Property snatEntry: Whether to configure SNAT for the network.

When a VPC can access the public network environment, set it to false. When an existing VPC cannot access the public network environment: When set to True, SNAT is configured and the public network environment can be accessed at this time. If set to false, it means that SNAT is not configured and the public network environment cannot be accessed at this time. Default to true.

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags: Tag the cluster.

timeZone^Optional

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

Property timeZone: The time zone of the cluster.

vpcId^Optional

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

Property vpcId: VPC ID.

vSwitchIds^Optional

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

Property vSwitchIds: The IDs of VSwitches.

If you leave this property empty, the system automatically creates a VSwitch. Note You must specify both the VpcId and VSwitchIds or leave both of them empty.

zoneIds^Optional

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

Property zoneIds: The zone IDs of the cluster.

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.acs.Cluster;
Cluster.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

attrApiServerSlbId^Required

public java.lang.Object getAttrApiServerSlbId();

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

Attribute APIServerSLBId: The id of API server SLB.

attrClusterId^Required

public java.lang.Object getAttrClusterId();

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

Attribute ClusterId: Cluster instance ID.

attrDefaultUserKubeConfig^Required

public java.lang.Object getAttrDefaultUserKubeConfig();

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

Attribute DefaultUserKubeConfig: Default user kubernetes config which is used for configuring cluster credentials.

attrIngressSlbId^Required

public java.lang.Object getAttrIngressSlbId();

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

Attribute IngressSLBId: The id of ingress SLB.

attrNodes^Required

public java.lang.Object getAttrNodes();

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

Attribute Nodes: The list of cluster nodes.

attrPrivateUserKubConfig^Required

public java.lang.Object getAttrPrivateUserKubConfig();

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

Attribute PrivateUserKubConfig: Private user kubernetes config which is used for configuring cluster credentials.

attrScalingConfigurationId^Required

public java.lang.Object getAttrScalingConfigurationId();

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

Attribute ScalingConfigurationId: Scaling configuration id.

attrScalingGroupId^Required

public java.lang.Object getAttrScalingGroupId();

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

Attribute ScalingGroupId: Scaling group id.

attrScalingRuleId^Required

public java.lang.Object getAttrScalingRuleId();

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

Attribute ScalingRuleId: Scaling rule id.

attrTaskId^Required

public java.lang.Object getAttrTaskId();

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

Attribute TaskId: Task ID.

Automatically assigned by the system, the user queries the task status.

attrWorkerRamRoleName^Required

public java.lang.Object getAttrWorkerRamRoleName();

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

Attribute WorkerRamRoleName: Worker ram role name.

props^Required

public ClusterProps getProps();

• Type: ClusterProps