Skip to content

K8sCluster

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

Initializers

import { K8sCluster } from '@alicloud/ros-cdk-edas'
new K8sCluster(scope: Construct, id: string, props: K8sClusterProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props K8sClusterProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: boolean

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct

import { K8sCluster } from '@alicloud/ros-cdk-edas'
K8sCluster.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrClusterId @alicloud/ros-cdk-core.IResolvable Attribute ClusterId: The ID of the cluster.
attrClusterName @alicloud/ros-cdk-core.IResolvable Attribute ClusterName: The name of the cluster.
attrClusterType @alicloud/ros-cdk-core.IResolvable Attribute ClusterType: The type of the cluster: 2: ECS cluster 5: Container Service K8s cluster or Serverless K8s cluster.
attrCsClusterId @alicloud/ros-cdk-core.IResolvable Attribute CsClusterId: The ID of the K8s cluster.
attrNetworkMode @alicloud/ros-cdk-core.IResolvable Attribute NetworkMode: Network node: 1: Classic network 2: VPC.
attrNodeNum @alicloud/ros-cdk-core.IResolvable Attribute NodeNum: Number of nodes.
attrSubNetCidr @alicloud/ros-cdk-core.IResolvable Attribute SubNetCidr: Sub net CIDR.
attrVpcId @alicloud/ros-cdk-core.IResolvable Attribute VpcId: The ID of the cluster.
attrVswitchId @alicloud/ros-cdk-core.IResolvable Attribute VswitchId: The ID of the cluster.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


refRequired

public readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrClusterIdRequired

public readonly attrClusterId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ClusterId: The ID of the cluster.


attrClusterNameRequired

public readonly attrClusterName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ClusterName: The name of the cluster.


attrClusterTypeRequired

public readonly attrClusterType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ClusterType: The type of the cluster: 2: ECS cluster 5: Container Service K8s cluster or Serverless K8s cluster.


attrCsClusterIdRequired

public readonly attrCsClusterId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CsClusterId: The ID of the K8s cluster.


attrNetworkModeRequired

public readonly attrNetworkMode: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute NetworkMode: Network node: 1: Classic network 2: VPC.


attrNodeNumRequired

public readonly attrNodeNum: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute NodeNum: Number of nodes.


attrSubNetCidrRequired

public readonly attrSubNetCidr: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SubNetCidr: Sub net CIDR.


attrVpcIdRequired

public readonly attrVpcId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VpcId: The ID of the cluster.


attrVswitchIdRequired

public readonly attrVswitchId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VswitchId: The ID of the cluster.