Skip to content

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 

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkcs/datasource"
datasource.NewKubernetesCluster(scope Construct, id *string, props KubernetesClusterProps, enableResourcePropertyConstraint *bool) KubernetesCluster
Name Type Description
scope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct No description.
id *string No description.
props KubernetesClusterProps No description.
enableResourcePropertyConstraint *bool No description.

scopeRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct

idRequired

  • Type: *string

propsOptional

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 

func ToString() *string

Returns a string representation of this construct.

Synthesize 

func Synthesize(session ISynthesisSession)

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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession

The synthesis session.

AddCondition 

func AddCondition(condition RosCondition)

conditionRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition

AddCount 

func AddCount(count interface{})

countRequired

  • Type: interface{}

AddDependency 

func AddDependency(resource Resource)

resourceRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Resource

AddResourceDesc 

func AddResourceDesc(desc *string)

descRequired

  • Type: *string

ApplyRemovalPolicy 

func ApplyRemovalPolicy(policy RemovalPolicy)

policyRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy

GetAtt 

func GetAtt(name *string) IResolvable

nameRequired

  • Type: *string

SetMetadata 

func SetMetadata(key *string, value interface{})

keyRequired

  • Type: *string

valueRequired

  • Type: interface{}

Static Functions

Name Description
IsConstruct Return whether the given object is a Construct.

IsConstruct 

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkcs/datasource"
datasource.KubernetesCluster_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

xRequired

  • Type: interface{}

Properties

Name Type Description
Node github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode The construct tree node associated with this construct.
Ref *string No description.
Stack github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack The stack in which this resource is defined.
Resource github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource No description.
AttrClusterId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute ClusterId: Cluster instance ID.
AttrClusterSpec github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute ClusterSpec: The type of the managed Kubernetes cluster.
AttrClusterType github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute ClusterType: The type of the cluster.
AttrCreated github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute Created: The time when the cluster was created.
AttrCurrentVersion github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute CurrentVersion: The current Kubernetes version of the cluster.
AttrDeletionProtection github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute DeletionProtection: Indicates whether deletion protection is enabled.
AttrDockerVersion github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute DockerVersion: The Docker version that is used by the cluster.
AttrExternalLoadbalancerId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute ExternalLoadbalancerId: The ID of the Server Load Balancer (SLB) instance that is used for the Ingress of the cluster.
AttrInitVersion github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute InitVersion: The Kubernetes version that is initially used by the cluster.
AttrMaintenanceWindow github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute MaintenanceWindow: The maintenance window of the cluster.
AttrMasterUrl github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute MasterUrl: The address of the cluster.
AttrMetaData github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute MetaData: The metadata of the cluster.
AttrName github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute Name: The name of the cluster.
AttrNetworkMode github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute NetworkMode: The network mode of the cluster.
AttrNextVersion github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute NextVersion: The Kubernetes version to which the cluster can be upgraded.
AttrParameters github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute Parameters: A collection of cluster ROS parameters.
AttrPrivateZone github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute PrivateZone: Indicates whether Alibaba Cloud DNS PrivateZone is enabled.
AttrProfile github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute Profile: Indicates the scenario in which the cluster is used.
AttrRegionId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute RegionId: The ID of the region where the cluster is deployed.
AttrResourceGroupId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute ResourceGroupId: The ID of the resource group to which the cluster belongs.
AttrSecurityGroupId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute SecurityGroupId: The ID of the security group to which the instances of the cluster belong.
AttrSize github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute Size: The number of nodes in the cluster.
AttrState github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute State: The state of the cluster.
AttrSubnetCidr github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute SubnetCidr: The pod CIDR block.
AttrTags github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute Tags: The labels of the cluster.
AttrUpdated github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute Updated: The time when the cluster was updated.
AttrVpcId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute VpcId: The ID of the VPC where the cluster is deployed.
AttrVSwitchId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute VSwitchId: The IDs of the vSwitches.
AttrWorkerRamRoleName github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute WorkerRamRoleName: The name of the worker RAM role.
AttrZoneId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute ZoneId: The ID of the zone where the cluster is deployed.

NodeRequired 

func Node() ConstructNode
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.

RefRequired 

func Ref() *string
  • Type: *string

StackRequired 

func Stack() Stack
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack

The stack in which this resource is defined.

ResourceOptional 

func Resource() RosResource
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource

AttrClusterIdRequired 

func AttrClusterId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute ClusterId: Cluster instance ID.

AttrClusterSpecRequired 

func AttrClusterSpec() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 

func AttrClusterType() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 

func AttrCreated() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute Created: The time when the cluster was created.

AttrCurrentVersionRequired 

func AttrCurrentVersion() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 

func AttrDeletionProtection() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 

func AttrDockerVersion() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

AttrExternalLoadbalancerIdRequired 

func AttrExternalLoadbalancerId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

AttrInitVersionRequired 

func AttrInitVersion() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

AttrMaintenanceWindowRequired 

func AttrMaintenanceWindow() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute MaintenanceWindow: The maintenance window of the cluster.

This feature is available in only professional managed Kubernetes clusters.

AttrMasterUrlRequired 

func AttrMasterUrl() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute MasterUrl: The address of the cluster.

It includes an internal endpoint and a public endpoint.

AttrMetaDataRequired 

func AttrMetaData() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute MetaData: The metadata of the cluster.

AttrNameRequired 

func AttrName() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 

func AttrNetworkMode() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 

func AttrNextVersion() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

AttrParametersRequired 

func AttrParameters() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute Parameters: A collection of cluster ROS parameters.

AttrPrivateZoneRequired 

func AttrPrivateZone() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 

func AttrProfile() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 

func AttrRegionId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

AttrResourceGroupIdRequired 

func AttrResourceGroupId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

AttrSecurityGroupIdRequired 

func AttrSecurityGroupId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

AttrSizeRequired 

func AttrSize() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute Size: The number of nodes in the cluster.

Master nodes and worker nodes are included.

AttrStateRequired 

func AttrState() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 

func AttrSubnetCidr() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 

func AttrTags() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute Tags: The labels of the cluster.

AttrUpdatedRequired 

func AttrUpdated() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute Updated: The time when the cluster was updated.

AttrVpcIdRequired 

func AttrVpcId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

This parameter is required when you create an ACK cluster.

AttrVSwitchIdRequired 

func AttrVSwitchId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 

func AttrWorkerRamRoleName() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 

func AttrZoneId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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