Class Cluster

(deprecated) A Cluster represents a managed Kubernetes Service (EKS).

Inheritance

System.Object

Construct

Resource

Cluster

Implements

ICluster

IResource

IConstruct

Constructs.IConstruct

IDependable

IConnectable

Inherited Members

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.EKS.Legacy

Assembly: Amazon.CDK.AWS.EKS.Legacy.dll

Syntax (csharp)

public class Cluster : Resource, ICluster, IResource, IConstruct, IConstruct, IDependable, IConnectable

Syntax (vb)

Public Class Cluster
    Inherits Resource
    Implements ICluster, IResource, IConstruct, IConstruct, IDependable, IConnectable

Remarks

This is a fully managed cluster of API Servers (control-plane) The user is still required to create the worker nodes.

Stability: Deprecated

Resource: AWS::EKS::Cluster

Synopsis

Constructors

Cluster(Construct, String, IClusterProps)	(deprecated) Initiates an EKS Cluster with the supplied arguments.
Cluster(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
Cluster(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

AwsAuth	(deprecated) Lazily creates the AwsAuth resource, which manages AWS authentication mapping.
ClusterArn	(deprecated) The AWS generated ARN for the Cluster resource.
ClusterCertificateAuthorityData	(deprecated) The certificate-authority-data for your cluster.
ClusterEndpoint	(deprecated) The endpoint URL for the Cluster.
ClusterName	(deprecated) The Name of the created EKS Cluster.
Connections	(deprecated) Manages connection rules (Security Group Rules) for the cluster.
DefaultCapacity	(deprecated) The auto scaling group that hosts the default capacity for this cluster.
KubectlEnabled	(deprecated) Indicates if kubectl related operations can be performed on this cluster.
Role	(deprecated) IAM role assumed by the EKS Control Plane.
Vpc	(deprecated) The VPC in which this Cluster was created.

Methods

AddAutoScalingGroup(AutoScalingGroup, IAutoScalingGroupOptions)	(deprecated) Add compute capacity to this EKS cluster in the form of an AutoScalingGroup.
AddCapacity(String, ICapacityOptions)	(deprecated) Add nodes to this EKS cluster.
AddChart(String, IHelmChartOptions)	(deprecated) Defines a Helm chart in this cluster.
AddResource(String, Object[])	(deprecated) Defines a Kubernetes resource in this cluster.
FromClusterAttributes(Construct, String, IClusterAttributes)	(deprecated) Import an existing cluster.

Constructors

Cluster(Construct, String, IClusterProps)

(deprecated) Initiates an EKS Cluster with the supplied arguments.

public Cluster(Construct scope, string id, IClusterProps props = null)

Parameters

scope Construct

a Construct, most likely a cdk.Stack created.

id System.String

a Construct, most likely a cdk.Stack created.

props IClusterProps

properties in the IClusterProps interface.

Remarks

Stability: Deprecated

Cluster(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected Cluster(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

Cluster(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected Cluster(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AwsAuth

(deprecated) Lazily creates the AwsAuth resource, which manages AWS authentication mapping.

public virtual AwsAuth AwsAuth { get; }

Property Value

AwsAuth

Remarks

Stability: Deprecated

ClusterArn

(deprecated) The AWS generated ARN for the Cluster resource.

public virtual string ClusterArn { get; }

Property Value

System.String

Remarks

Stability: Deprecated

Examples

// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
arn:aws:eks:us-west-2666666666666;cluster / prod;

ClusterCertificateAuthorityData

(deprecated) The certificate-authority-data for your cluster.

public virtual string ClusterCertificateAuthorityData { get; }

Property Value

System.String

Remarks

Stability: Deprecated

ClusterEndpoint

(deprecated) The endpoint URL for the Cluster.

public virtual string ClusterEndpoint { get; }

Property Value

System.String

Remarks

This is the URL inside the kubeconfig file to use with kubectl

Stability: Deprecated

Examples

// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
https:

ClusterName

(deprecated) The Name of the created EKS Cluster.

public virtual string ClusterName { get; }

Property Value

System.String

Remarks

Stability: Deprecated

Connections

(deprecated) Manages connection rules (Security Group Rules) for the cluster.

public virtual Connections_ Connections { get; }

Property Value

Connections_

Remarks

Stability: Deprecated

Memberof: Cluster

Type: {ec2.Connections}

DefaultCapacity

(deprecated) The auto scaling group that hosts the default capacity for this cluster.

public virtual AutoScalingGroup DefaultCapacity { get; }

Property Value

AutoScalingGroup

Remarks

This will be undefined if the default capacity is set to 0.

Stability: Deprecated

KubectlEnabled

(deprecated) Indicates if kubectl related operations can be performed on this cluster.

public virtual bool KubectlEnabled { get; }

Property Value

System.Boolean

Remarks

Stability: Deprecated

Role

(deprecated) IAM role assumed by the EKS Control Plane.

public virtual IRole Role { get; }

Property Value

IRole

Remarks

Stability: Deprecated

Vpc

(deprecated) The VPC in which this Cluster was created.

public virtual IVpc Vpc { get; }

Property Value

IVpc

Remarks

Stability: Deprecated

Methods

AddAutoScalingGroup(AutoScalingGroup, IAutoScalingGroupOptions)

(deprecated) Add compute capacity to this EKS cluster in the form of an AutoScalingGroup.

public virtual void AddAutoScalingGroup(AutoScalingGroup autoScalingGroup, IAutoScalingGroupOptions options)

Parameters

autoScalingGroup AutoScalingGroup

[disable-awslint:ref-via-interface].

options IAutoScalingGroupOptions

options for adding auto scaling groups, like customizing the bootstrap script.

Remarks

The AutoScalingGroup must be running an EKS-optimized AMI containing the /etc/eks/bootstrap.sh script. This method will configure Security Groups, add the right policies to the instance role, apply the right tags, and add the required user data to the instance's launch configuration.

Spot instances will be labeled lifecycle=Ec2Spot and tainted with PreferNoSchedule. If kubectl is enabled, the spot interrupt handler daemon will be installed on all spot instances to handle EC2 Spot Instance Termination Notices.

Prefer to use addCapacity if possible.

Stability: Deprecated

See: https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html

AddCapacity(String, ICapacityOptions)

(deprecated) Add nodes to this EKS cluster.

public virtual AutoScalingGroup AddCapacity(string id, ICapacityOptions options)

Parameters

id System.String

options ICapacityOptions

Returns

AutoScalingGroup

Remarks

The nodes will automatically be configured with the right VPC and AMI for the instance type and Kubernetes version.

Spot instances will be labeled lifecycle=Ec2Spot and tainted with PreferNoSchedule. If kubectl is enabled, the spot interrupt handler daemon will be installed on all spot instances to handle EC2 Spot Instance Termination Notices.

Stability: Deprecated

AddChart(String, IHelmChartOptions)

(deprecated) Defines a Helm chart in this cluster.

public virtual HelmChart AddChart(string id, IHelmChartOptions options)

Parameters

id System.String

logical id of this chart.

options IHelmChartOptions

options of this chart.

Returns

HelmChart

a HelmChart object

Remarks

Stability: Deprecated

Throws: If kubectlEnabled is false

AddResource(String, Object[])

(deprecated) Defines a Kubernetes resource in this cluster.

public virtual KubernetesResource AddResource(string id, params object[] manifest)

Parameters

id System.String

logical id of this manifest.

manifest System.Object[]

a list of Kubernetes resource specifications.

Returns

KubernetesResource

a KubernetesResource object.

Remarks

The manifest will be applied/deleted using kubectl as needed.

Stability: Deprecated

Throws: If kubectlEnabled is false

FromClusterAttributes(Construct, String, IClusterAttributes)

(deprecated) Import an existing cluster.

public static ICluster FromClusterAttributes(Construct scope, string id, IClusterAttributes attrs)

Parameters

scope Construct

the construct scope, in most cases 'this'.

id System.String

the id or name to import as.

attrs IClusterAttributes

the cluster properties to use for importing information.

Returns

ICluster

Remarks

Stability: Deprecated

Implements

ICluster

IResource

IConstruct

Constructs.IConstruct

IDependable

IConnectable