KubernetesCluster

• Implements: AlibabaCloud.SDK.ROS.CDK.Cs.datasource.IKubernetesCluster

This class encapsulates and extends the ROS resource type DATASOURCE::CS::KubernetesCluster.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Cs;
new KubernetesCluster(Construct Scope, string Id, KubernetesClusterProps Props = null, bool EnableResourcePropertyConstraint = null);

Scope^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

Id^Required

• Type: string

Props^Optional

• Type: KubernetesClusterProps

EnableResourcePropertyConstraint^Optional

• Type: bool

Methods

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private 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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.

AddCondition

private void AddCondition(RosCondition Condition)

Condition^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

Count^Required

• Type: object

AddDependency

private void AddDependency(Resource Resource)

Resource^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

AddResourceDesc

private void AddResourceDesc(string Desc)

Desc^Required

• Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

Policy^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

FetchCondition

private RosCondition FetchCondition()

FetchDependency

private string[] FetchDependency()

FetchResourceDesc

private string FetchResourceDesc()

GetAtt

private IResolvable GetAtt(string Name)

Name^Required

• Type: string

SetMetadata

private void SetMetadata(string Key, object Value)

Key^Required

• Type: string

Value^Required

• Type: object

Static Functions

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Cs;
KubernetesCluster.IsConstruct(object X);

Return whether the given object is a Construct.

X^Required

• Type: object

Properties

Node^Required

public ConstructNode Node { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

Env^Required

public IResourceEnvironment Env { get; }

• Type: AlibabaCloud.SDK.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 string Ref { get; }

• Type: string

Stack^Required

public Stack Stack { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.

Resource^Optional

public RosResource Resource { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrClusterId^Required

public object AttrClusterId { get; }

• Type: object

Attribute ClusterId: Cluster instance ID.

AttrClusterSpec^Required

public object AttrClusterSpec { get; }

• Type: object

Attribute ClusterSpec: The type of the managed Kubernetes cluster.

This parameter is returned for a managed Kubernetes cluster. Valid values:

• ack.pro.small: professional managed Kubernetes cluster.
• ack.standard: standard managed Kubernetes cluster.

AttrClusterType^Required

public object AttrClusterType { get; }

• Type: object

Attribute ClusterType: The type of the cluster.

Valid values:

• Kubernetes: dedicated Kubernetes cluster
• ManagedKubernetes: managed Kubernetes cluster
• Ask: ASK cluster
• ExternalKubernetes: registered external Kubernetes cluster

AttrCreated^Required

public object AttrCreated { get; }

• Type: object

Attribute Created: The time when the cluster was created.

AttrCurrentVersion^Required

public object AttrCurrentVersion { get; }

• Type: object

Attribute CurrentVersion: The current Kubernetes version of the cluster.

For more information about the Kubernetes versions supported by ACK, see Release notes for Kubernetes versions.

AttrDeletionProtection^Required

public object AttrDeletionProtection { get; }

• Type: object

Attribute DeletionProtection: Indicates whether deletion protection is enabled.

If deletion protection is enabled, the cluster cannot be deleted in the ACK console or by calling the API. Valid values:

• true: Deletion protection is enabled. You cannot delete the cluster in the ACK console or by calling the API.
• false: Deletion protection is not enabled. You can delete the cluster in the ACK console or by calling the API.

AttrDockerVersion^Required

public object AttrDockerVersion { get; }

• Type: object

Attribute DockerVersion: The Docker version that is used by the cluster.

AttrExternalLoadbalancerId^Required

public object AttrExternalLoadbalancerId { get; }

• Type: object

Attribute ExternalLoadbalancerId: The ID of the Server Load Balancer (SLB) instance that is used for the Ingress of the cluster.

AttrInitVersion^Required

public object AttrInitVersion { get; }

• Type: object

Attribute InitVersion: The Kubernetes version that is initially used by the cluster.

AttrMaintenanceWindow^Required

public object AttrMaintenanceWindow { get; }

• Type: object

Attribute MaintenanceWindow: The maintenance window of the cluster.

This feature is available in only professional managed Kubernetes clusters.

AttrMasterUrl^Required

public object AttrMasterUrl { get; }

• Type: object

Attribute MasterUrl: The address of the cluster.

It includes an internal endpoint and a public endpoint.

AttrMetaData^Required

public object AttrMetaData { get; }

• Type: object

Attribute MetaData: The metadata of the cluster.

AttrName^Required

public object AttrName { get; }

• Type: object

Attribute Name: The name of the cluster.

The name must be 1 to 63 characters in length, and can contain digits, letters, and hyphens (-). It cannot start with a hyphen (-).

AttrNetworkMode^Required

public object AttrNetworkMode { get; }

• Type: object

Attribute NetworkMode: The network mode of the cluster.

Valid values:

• classic: the classic network
• vpc: virtual private cloud (VPC)
• overlay: overlay network
• calico: network powered by Calico Default value: vpc.

AttrNextVersion^Required

public object AttrNextVersion { get; }

• Type: object

Attribute NextVersion: The Kubernetes version to which the cluster can be upgraded.

AttrParameters^Required

public object AttrParameters { get; }

• Type: object

Attribute Parameters: A collection of cluster ROS parameters.

AttrPrivateZone^Required

public object AttrPrivateZone { get; }

• Type: object

Attribute PrivateZone: Indicates whether Alibaba Cloud DNS PrivateZone is enabled.

• true: indicates that Alibaba Cloud DNS PrivateZone is enabled.- false: indicates that Alibaba Cloud DNS PrivateZone is not enabled.

AttrProfile^Required

public object AttrProfile { get; }

• Type: object

Attribute Profile: Indicates the scenario in which the cluster is used.

Valid values:

• Default: indicates that the cluster is used in non-edge computing scenarios.
• Edge: indicates that the ACK cluster is used in edge computing scenarios.

AttrRegionId^Required

public object AttrRegionId { get; }

• Type: object

Attribute RegionId: The ID of the region where the cluster is deployed.

AttrResourceGroupId^Required

public object AttrResourceGroupId { get; }

• Type: object

Attribute ResourceGroupId: The ID of the resource group to which the cluster belongs.

AttrSecurityGroupId^Required

public object AttrSecurityGroupId { get; }

• Type: object

Attribute SecurityGroupId: The ID of the security group to which the instances of the cluster belong.

AttrServiceCidr^Required

public object AttrServiceCidr { get; }

• Type: object

Attribute ServiceCidr: The cluster service cidr.

AttrSize^Required

public object AttrSize { get; }

• Type: object

Attribute Size: The number of nodes in the cluster.

Master nodes and worker nodes are included.

AttrState^Required

public object AttrState { get; }

• Type: object

Attribute State: The state of the cluster.

Valid values:

• initial: The cluster is being created.
• failed: The cluster failed to be created.
• running: The cluster is running.
• updating: The cluster is being upgraded.
• updating_failed: The cluster failed to be upgraded.
• scaling: The cluster is being scaled.
• waiting: The registered cluster is waiting for connecting.
• disconnected: The registeredcluster is disconnected.
• stopped: The cluster is stopped.
• deleting: The cluster is being deleted.
• deleted: The cluster is deleted.
• delete_failed: The cluster failed to be deleted.

AttrSubnetCidr^Required

public object AttrSubnetCidr { get; }

• Type: object

Attribute SubnetCidr: The pod CIDR block.

It must be a valid and private CIDR block, and must be one of the following CIDR blocks or their subnets:

• 10.0.0.0/8
• 172.16-31.0.0/12-16
• 192.168.0.0/16 The pod CIDR block cannot overlap with that of the VPC or those of the ACK clusters that are deployed in the VPC. For more information about the network segmentation of ACK clusters, see Plan CIDR blocks for ACK clusters in a VPC.

AttrTags^Required

public object AttrTags { get; }

• Type: object

Attribute Tags: The labels of the cluster.

AttrUpdated^Required

public object AttrUpdated { get; }

• Type: object

Attribute Updated: The time when the cluster was updated.

AttrVpcId^Required

public object AttrVpcId { get; }

• Type: object

Attribute VpcId: The ID of the VPC where the cluster is deployed.

This parameter is required when you create an ACK cluster.

AttrVSwitchId^Required

public object AttrVSwitchId { get; }

• Type: object

Attribute VSwitchId: The IDs of the vSwitches.

You can select one to three vSwitches when you create an ACK cluster. vSwitches in different zones are recommended to ensure high availability.

AttrVSwitchIds^Required

public object AttrVSwitchIds { get; }

• Type: object

Attribute VSwitchIds: The list of cluster control plane VSwitch ID.

AttrWorkerRamRoleName^Required

public object AttrWorkerRamRoleName { get; }

• Type: object

Attribute WorkerRamRoleName: The name of the worker RAM role.

The RAM role is assigned to the worker nodes of the cluster and allows the worker nodes to manage Elastic Compute Service (ECS) instances.

AttrZoneId^Required

public object AttrZoneId { get; }

• Type: object

Attribute ZoneId: The ID of the zone where the cluster is deployed.

Props^Required

public KubernetesClusterProps Props { get; }

• Type: KubernetesClusterProps