K8sCluster
- Implements: IK8sCluster
This class encapsulates and extends the ROS resource type ALIYUN::EDAS::K8sCluster.
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
- Type: K8sClusterProps
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- 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.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
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 | string | @alicloud/ros-cdk-core.IResolvable | Attribute ClusterId: The ID of the cluster. |
attrClusterName | string | @alicloud/ros-cdk-core.IResolvable | Attribute ClusterName: The name of the cluster. |
attrClusterType | string | @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 | string | @alicloud/ros-cdk-core.IResolvable | Attribute CsClusterId: The ID of the K8s cluster. |
attrNetworkMode | string | @alicloud/ros-cdk-core.IResolvable | Attribute NetworkMode: Network node: 1: Classic network 2: VPC. |
attrNodeNum | string | @alicloud/ros-cdk-core.IResolvable | Attribute NodeNum: Number of nodes. |
attrSubNetCidr | string | @alicloud/ros-cdk-core.IResolvable | Attribute SubNetCidr: Sub net CIDR. |
attrVpcId | string | @alicloud/ros-cdk-core.IResolvable | Attribute VpcId: The ID of the cluster. |
attrVswitchId | string | @alicloud/ros-cdk-core.IResolvable | Attribute VswitchId: The ID of the cluster. |
props | K8sClusterProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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.
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: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ClusterId: The ID of the cluster.
attrClusterNameRequired
public readonly attrClusterName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ClusterName: The name of the cluster.
attrClusterTypeRequired
public readonly attrClusterType: string | IResolvable;
- Type: string | @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: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CsClusterId: The ID of the K8s cluster.
attrNetworkModeRequired
public readonly attrNetworkMode: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute NetworkMode: Network node: 1: Classic network 2: VPC.
attrNodeNumRequired
public readonly attrNodeNum: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute NodeNum: Number of nodes.
attrSubNetCidrRequired
public readonly attrSubNetCidr: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SubNetCidr: Sub net CIDR.
attrVpcIdRequired
public readonly attrVpcId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute VpcId: The ID of the cluster.
attrVswitchIdRequired
public readonly attrVswitchId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute VswitchId: The ID of the cluster.
propsRequired
public readonly props: K8sClusterProps;
- Type: K8sClusterProps