KubernetesCluster
This class encapsulates and extends the ROS resource type DATASOURCE::CS::KubernetesCluster, which is used to query the information about a Container Service for Kubernetes (ACK) cluster.
Initializers
using AlibabaCloud.SDK.ROS.CDK.Cs;
new KubernetesCluster(Construct Scope, string Id, KubernetesClusterProps Props = null, bool EnableResourcePropertyConstraint = null);
| Name | Type | Description |
|---|---|---|
Scope |
AlibabaCloud.SDK.ROS.CDK.Core.Construct |
No description. |
Id |
string |
No description. |
Props |
KubernetesClusterProps |
No description. |
EnableResourcePropertyConstraint |
bool |
No description. |
ScopeRequired
- Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct
IdRequired
- Type: string
PropsOptional
- Type: KubernetesClusterProps
EnableResourcePropertyConstraintOptional
- Type: bool
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
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.
- Type: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession
The synthesis session.
AddCondition
private void AddCondition(RosCondition Condition)
- Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition
AddCount
private void AddCount(object Count)
- Type: object
AddDependency
private void AddDependency(Resource Resource)
- Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource
AddResourceDesc
private void AddResourceDesc(string Desc)
- Type: string
ApplyRemovalPolicy
private void ApplyRemovalPolicy(RemovalPolicy Policy)
- Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy
GetAtt
private IResolvable GetAtt(string Name)
- Type: string
SetMetadata
private void SetMetadata(string Key, object Value)
- Type: string
- Type: object
Static Functions
| Name | Description |
|---|---|
IsConstruct |
Return whether the given object is a Construct. |
IsConstruct
using AlibabaCloud.SDK.ROS.CDK.Cs;
KubernetesCluster.IsConstruct(object X);
Return whether the given object is a Construct.
- Type: object
Properties
| Name | Type | Description |
|---|---|---|
Node |
AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode |
The construct tree node associated with this construct. |
Ref |
string |
No description. |
Stack |
AlibabaCloud.SDK.ROS.CDK.Core.Stack |
The stack in which this resource is defined. |
Resource |
AlibabaCloud.SDK.ROS.CDK.Core.RosResource |
No description. |
AttrClusterId |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute ClusterId: Cluster instance ID. |
AttrClusterSpec |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute ClusterSpec: The type of the managed Kubernetes cluster. |
AttrClusterType |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute ClusterType: The type of the cluster. |
AttrCreated |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute Created: The time when the cluster was created. |
AttrCurrentVersion |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute CurrentVersion: The current Kubernetes version of the cluster. |
AttrDeletionProtection |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute DeletionProtection: Indicates whether deletion protection is enabled. |
AttrDockerVersion |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute DockerVersion: The Docker version that is used by the cluster. |
AttrExternalLoadbalancerId |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute ExternalLoadbalancerId: The ID of the Server Load Balancer (SLB) instance that is used for the Ingress of the cluster. |
AttrInitVersion |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute InitVersion: The Kubernetes version that is initially used by the cluster. |
AttrMaintenanceWindow |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute MaintenanceWindow: The maintenance window of the cluster. |
AttrMasterUrl |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute MasterUrl: The address of the cluster. |
AttrMetaData |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute MetaData: The metadata of the cluster. |
AttrName |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute Name: The name of the cluster. |
AttrNetworkMode |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute NetworkMode: The network mode of the cluster. |
AttrNextVersion |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute NextVersion: The Kubernetes version to which the cluster can be upgraded. |
AttrParameters |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute Parameters: A collection of cluster ROS parameters. |
AttrPrivateZone |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute PrivateZone: Indicates whether Alibaba Cloud DNS PrivateZone is enabled. |
AttrProfile |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute Profile: Indicates the scenario in which the cluster is used. |
AttrRegionId |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute RegionId: The ID of the region where the cluster is deployed. |
AttrResourceGroupId |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute ResourceGroupId: The ID of the resource group to which the cluster belongs. |
AttrSecurityGroupId |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute SecurityGroupId: The ID of the security group to which the instances of the cluster belong. |
AttrSize |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute Size: The number of nodes in the cluster. |
AttrState |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute State: The state of the cluster. |
AttrSubnetCidr |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute SubnetCidr: The pod CIDR block. |
AttrTags |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute Tags: The labels of the cluster. |
AttrUpdated |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute Updated: The time when the cluster was updated. |
AttrVpcId |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute VpcId: The ID of the VPC where the cluster is deployed. |
AttrVSwitchId |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute VSwitchId: The IDs of the vSwitches. |
AttrWorkerRamRoleName |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute WorkerRamRoleName: The name of the worker RAM role. |
AttrZoneId |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
Attribute ZoneId: The ID of the zone where the cluster is deployed. |
NodeRequired
public ConstructNode Node { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode
The construct tree node associated with this construct.
RefRequired
public string Ref { get; }
- Type: string
StackRequired
public Stack Stack { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack
The stack in which this resource is defined.
ResourceOptional
public RosResource Resource { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource
AttrClusterIdRequired
public IResolvable AttrClusterId { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute ClusterId: Cluster instance ID.
AttrClusterSpecRequired
public IResolvable AttrClusterSpec { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
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.
AttrClusterTypeRequired
public IResolvable AttrClusterType { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
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
AttrCreatedRequired
public IResolvable AttrCreated { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute Created: The time when the cluster was created.
AttrCurrentVersionRequired
public IResolvable AttrCurrentVersion { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
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.
AttrDeletionProtectionRequired
public IResolvable AttrDeletionProtection { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
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.
AttrDockerVersionRequired
public IResolvable AttrDockerVersion { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute DockerVersion: The Docker version that is used by the cluster.
AttrExternalLoadbalancerIdRequired
public IResolvable AttrExternalLoadbalancerId { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute ExternalLoadbalancerId: The ID of the Server Load Balancer (SLB) instance that is used for the Ingress of the cluster.
AttrInitVersionRequired
public IResolvable AttrInitVersion { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute InitVersion: The Kubernetes version that is initially used by the cluster.
AttrMaintenanceWindowRequired
public IResolvable AttrMaintenanceWindow { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute MaintenanceWindow: The maintenance window of the cluster.
This feature is available in only professional managed Kubernetes clusters.
AttrMasterUrlRequired
public IResolvable AttrMasterUrl { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute MasterUrl: The address of the cluster.
It includes an internal endpoint and a public endpoint.
AttrMetaDataRequired
public IResolvable AttrMetaData { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute MetaData: The metadata of the cluster.
AttrNameRequired
public IResolvable AttrName { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
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 (-).
AttrNetworkModeRequired
public IResolvable AttrNetworkMode { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
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.
AttrNextVersionRequired
public IResolvable AttrNextVersion { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute NextVersion: The Kubernetes version to which the cluster can be upgraded.
AttrParametersRequired
public IResolvable AttrParameters { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute Parameters: A collection of cluster ROS parameters.
AttrPrivateZoneRequired
public IResolvable AttrPrivateZone { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
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.
AttrProfileRequired
public IResolvable AttrProfile { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
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.
AttrRegionIdRequired
public IResolvable AttrRegionId { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute RegionId: The ID of the region where the cluster is deployed.
AttrResourceGroupIdRequired
public IResolvable AttrResourceGroupId { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute ResourceGroupId: The ID of the resource group to which the cluster belongs.
AttrSecurityGroupIdRequired
public IResolvable AttrSecurityGroupId { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute SecurityGroupId: The ID of the security group to which the instances of the cluster belong.
AttrSizeRequired
public IResolvable AttrSize { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute Size: The number of nodes in the cluster.
Master nodes and worker nodes are included.
AttrStateRequired
public IResolvable AttrState { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
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.
AttrSubnetCidrRequired
public IResolvable AttrSubnetCidr { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
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.
AttrTagsRequired
public IResolvable AttrTags { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute Tags: The labels of the cluster.
AttrUpdatedRequired
public IResolvable AttrUpdated { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute Updated: The time when the cluster was updated.
AttrVpcIdRequired
public IResolvable AttrVpcId { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute VpcId: The ID of the VPC where the cluster is deployed.
This parameter is required when you create an ACK cluster.
AttrVSwitchIdRequired
public IResolvable AttrVSwitchId { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
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.
AttrWorkerRamRoleNameRequired
public IResolvable AttrWorkerRamRoleName { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
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.
AttrZoneIdRequired
public IResolvable AttrZoneId { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
Attribute ZoneId: The ID of the zone where the cluster is deployed.