Skip to content

ClusterProps

Properties for defining a Cluster.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-acs-cluster

Initializer 

import com.aliyun.ros.cdk.acs.ClusterProps;
ClusterProps.builder()
    .name(java.lang.String)
    .name(IResolvable)
//  .addons(IResolvable)
//  .addons(java.util.List<IResolvable)
//  .addons(AddonsProperty>)
//  .clusterSpec(java.lang.String)
//  .clusterSpec(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .endpointPublicAccess(java.lang.Boolean)
//  .endpointPublicAccess(IResolvable)
//  .ipStack(java.lang.String)
//  .ipStack(IResolvable)
//  .kubernetesVersion(java.lang.String)
//  .kubernetesVersion(IResolvable)
//  .loadBalancerSpec(java.lang.String)
//  .loadBalancerSpec(IResolvable)
//  .loggingType(java.lang.String)
//  .loggingType(IResolvable)
//  .maintenanceWindow(IResolvable)
//  .maintenanceWindow(MaintenanceWindowProperty)
//  .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>)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();

Properties

Name Type Description
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: The name of the cluster.
addons com.aliyun.ros.cdk.core.IResolvable OR java.util.ListAddonsProperty> Property addons: The add-ons to be installed for the cluster.
clusterSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property clusterSpec: The managed cluster spec.
deletionProtection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deletionProtection: Specifies whether to enable deletion protection for the cluster.
endpointPublicAccess 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.
ipStack java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ipStack: The IP stack of the cluster.
kubernetesVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property kubernetesVersion: The version of the Kubernetes cluster.
loadBalancerSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property loadBalancerSpec: The specification of the Server Load Balancer instance.
loggingType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property loggingType: The logging type of the cluster.
maintenanceWindow com.aliyun.ros.cdk.core.IResolvable OR MaintenanceWindowProperty Property maintenanceWindow: The maintenance window of the cluster.
podVSwitchIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property podVSwitchIds: The list of pod vSwitches.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of resource group.
serviceCidr 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.
serviceDiscoveryTypes 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.
slsProjectName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property slsProjectName: The SLS project name of the cluster.
snatEntry java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property snatEntry: Whether to configure SNAT for the network.
tags java.util.List<TagsProperty> Property tags: Tag the cluster.
timeZone java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property timeZone: The time zone of the cluster.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: VPC ID.
vSwitchIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property vSwitchIds: The IDs of VSwitches.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The zone ID.

nameRequired 

public java.lang.Object getName();
  • 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.

addonsOptional 

public java.lang.Object getAddons();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListAddonsProperty>

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

clusterSpecOptional 

public java.lang.Object getClusterSpec();
  • 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.

deletionProtectionOptional 

public java.lang.Object getDeletionProtection();
  • 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.

endpointPublicAccessOptional 

public java.lang.Object getEndpointPublicAccess();
  • 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.

ipStackOptional 

public java.lang.Object getIpStack();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property ipStack: The IP stack of the cluster.

kubernetesVersionOptional 

public java.lang.Object getKubernetesVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property kubernetesVersion: The version of the Kubernetes cluster.

loadBalancerSpecOptional 

public java.lang.Object getLoadBalancerSpec();
  • 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

loggingTypeOptional 

public java.lang.Object getLoggingType();
  • 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.

maintenanceWindowOptional 

public java.lang.Object getMaintenanceWindow();

Property maintenanceWindow: The maintenance window of the cluster.

podVSwitchIdsOptional 

public java.lang.Object getPodVSwitchIds();
  • 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.

resourceGroupIdOptional 

public java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of resource group.

serviceCidrOptional 

public java.lang.Object getServiceCidr();
  • 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.

serviceDiscoveryTypesOptional 

public java.lang.Object getServiceDiscoveryTypes();
  • 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

slsProjectNameOptional 

public java.lang.Object getSlsProjectName();
  • 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.

snatEntryOptional 

public java.lang.Object getSnatEntry();
  • 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.

tagsOptional 

public java.util.List<TagsProperty> getTags();

Property tags: Tag the cluster.

timeZoneOptional 

public java.lang.Object getTimeZone();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property timeZone: The time zone of the cluster.

vpcIdOptional 

public java.lang.Object getVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: VPC ID.

vSwitchIdsOptional 

public java.lang.Object getVSwitchIds();
  • 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.

zoneIdOptional 

public java.lang.Object getZoneId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneId: The zone ID.