Skip to content

ManagedEdgeKubernetesCluster

This class encapsulates and extends the ROS resource type ALIYUN::CS::ManagedEdgeKubernetesCluster, which is used to create a Container Service for Kubernetes (ACK) edge cluster.

Initializers 

import com.aliyun.ros.cdk.cs.ManagedEdgeKubernetesCluster;
ManagedEdgeKubernetesCluster.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>)
//  .cloudMonitorFlags(java.lang.Boolean)
//  .cloudMonitorFlags(IResolvable)
//  .clusterSpec(java.lang.String)
//  .clusterSpec(IResolvable)
//  .containerCidr(java.lang.String)
//  .containerCidr(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .endpointPublicAccess(java.lang.Boolean)
//  .endpointPublicAccess(IResolvable)
//  .isEnterpriseSecurityGroup(java.lang.Boolean)
//  .isEnterpriseSecurityGroup(IResolvable)
//  .keyPair(java.lang.String)
//  .keyPair(IResolvable)
//  .loginPassword(java.lang.String)
//  .loginPassword(IResolvable)
//  .nodeCidrMask(java.lang.String)
//  .nodeCidrMask(IResolvable)
//  .profile(java.lang.String)
//  .profile(IResolvable)
//  .proxyMode(java.lang.String)
//  .proxyMode(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .serviceCidr(java.lang.String)
//  .serviceCidr(IResolvable)
//  .snatEntry(java.lang.Boolean)
//  .snatEntry(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .timeoutMins(java.lang.Number)
//  .timeoutMins(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .zoneIds(IResolvable)
//  .zoneIds(java.util.List<java.lang.String)
//  .zoneIds(IResolvable>)
    .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.
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.
cloudMonitorFlags java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property cloudMonitorFlags: Whether to install the cloud monitoring plugin: true: indicates installation false: Do not install Default to false.
clusterSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property clusterSpec: The edge managed cluster spec.
containerCidr java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property containerCidr: The container network segment cannot conflict with the VPC network segment.
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.
isEnterpriseSecurityGroup java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property isEnterpriseSecurityGroup: Specifies whether to create an advanced security group.
keyPair java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property keyPair: Key pair name.
loginPassword java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property loginPassword: SSH login password.
nodeCidrMask java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property nodeCidrMask: The maximum number of IP addresses that can be assigned to nodes.
profile java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property profile: Edge cluster ID.
proxyMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property proxyMode: kube-proxy proxy mode, supports both iptables and ipvs modes.
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.
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.
timeoutMins java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property timeoutMins: Cluster resource stack creation timeout, in minutes.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: VPC ID.
zoneIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property zoneIds: Zone ids of worker node virtual switches belongs to.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

nameRequired

  • 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

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

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

cloudMonitorFlagsOptional

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

Property cloudMonitorFlags: Whether to install the cloud monitoring plugin: true: indicates installation false: Do not install Default to false.

clusterSpecOptional

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

Property clusterSpec: The edge managed cluster spec.

Value: ack.pro.small: Professional hosting cluster, namely: "ACK Pro version cluster". ack.standard: Standard hosting cluster. Default value: ack.standard. The value can be empty. When it is empty, a standard managed cluster will be created.

containerCidrOptional

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

Property containerCidr: The container network segment cannot conflict with the VPC network segment.

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

deletionProtectionOptional

  • 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

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

isEnterpriseSecurityGroupOptional

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

keyPairOptional

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

Property keyPair: Key pair name.

Specify one of KeyPair or LoginPassword.

loginPasswordOptional

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

Property loginPassword: SSH login password.

Password rules are 8-30 characters and contain three items (upper and lower case letters, numbers, and special symbols). Specify one of KeyPair or LoginPassword.

nodeCidrMaskOptional

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

Property nodeCidrMask: The maximum number of IP addresses that can be assigned to nodes.

This number is determined by the specified pod CIDR block. This parameter takes effect only if the cluster uses the Flannel plug-in.Default value: 25.

profileOptional

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

Property profile: Edge cluster ID.

The default value is Edge.

proxyModeOptional

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

Property proxyMode: kube-proxy proxy mode, supports both iptables and ipvs modes.

The default is iptables.

resourceGroupIdOptional

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

Property resourceGroupId: The ID of resource group.

serviceCidrOptional

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

snatEntryOptional

  • 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

Property tags: Tag the cluster.

timeoutMinsOptional

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

Property timeoutMins: Cluster resource stack creation timeout, in minutes.

The default value is 60.

vpcIdOptional

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

Property vpcId: VPC ID.

If not set, the system will automatically create a VPC, and the VPC network segment created by the system is 192.168.0.0/16. VpcId and VSwitchId can only be empty at the same time or set the corresponding values at the same time.

zoneIdsOptional

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

Property zoneIds: Zone ids of worker node virtual switches belongs to.

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.ManagedEdgeKubernetesCluster;
ManagedEdgeKubernetesCluster.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.
attrApiServerSlbId com.aliyun.ros.cdk.core.IResolvable Attribute APIServerSLBId: The id of API server SLB.
attrClusterId com.aliyun.ros.cdk.core.IResolvable Attribute ClusterId: Cluster instance ID.
attrDefaultUserKubeConfig com.aliyun.ros.cdk.core.IResolvable Attribute DefaultUserKubeConfig: Default user kubernetes config which is used for configuring cluster credentials.
attrIngressSlbId com.aliyun.ros.cdk.core.IResolvable Attribute IngressSLBId: The id of ingress SLB.
attrNodes com.aliyun.ros.cdk.core.IResolvable Attribute Nodes: The list of cluster nodes.
attrPrivateUserKubConfig com.aliyun.ros.cdk.core.IResolvable Attribute PrivateUserKubConfig: Private user kubernetes config which is used for configuring cluster credentials.
attrScalingConfigurationId com.aliyun.ros.cdk.core.IResolvable Attribute ScalingConfigurationId: Scaling configuration id.
attrScalingGroupId com.aliyun.ros.cdk.core.IResolvable Attribute ScalingGroupId: Scaling group id.
attrScalingRuleId com.aliyun.ros.cdk.core.IResolvable Attribute ScalingRuleId: Scaling rule id.
attrTaskId com.aliyun.ros.cdk.core.IResolvable Attribute TaskId: Task ID.
attrWorkerRamRoleName com.aliyun.ros.cdk.core.IResolvable Attribute WorkerRamRoleName: Worker ram role name.

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

attrApiServerSlbIdRequired 

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

Attribute APIServerSLBId: The id of API server SLB.

attrClusterIdRequired 

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

Attribute ClusterId: Cluster instance ID.

attrDefaultUserKubeConfigRequired 

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

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

attrIngressSlbIdRequired 

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

Attribute IngressSLBId: The id of ingress SLB.

attrNodesRequired 

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

Attribute Nodes: The list of cluster nodes.

attrPrivateUserKubConfigRequired 

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

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

attrScalingConfigurationIdRequired 

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

Attribute ScalingConfigurationId: Scaling configuration id.

attrScalingGroupIdRequired 

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

Attribute ScalingGroupId: Scaling group id.

attrScalingRuleIdRequired 

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

Attribute ScalingRuleId: Scaling rule id.

attrTaskIdRequired 

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

Attribute TaskId: Task ID.

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

attrWorkerRamRoleNameRequired 

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

Attribute WorkerRamRoleName: Worker ram role name.