class CfnCluster (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.EKS.CfnCluster`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awseks#CfnCluster`
Java	`software.amazon.awscdk.services.eks.CfnCluster`
Python	`aws_cdk.aws_eks.CfnCluster`
TypeScript	`aws-cdk-lib` » `aws_eks` » `CfnCluster`

Implements IConstruct, IDependable, IInspectable, ITaggable

Creates an Amazon EKS control plane.

The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as etcd and the API server. The control plane runs in an account managed by AWS , and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of Amazon EC2 instances.

The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the nodes (for example, to support kubectl exec , logs , and proxy data flows).

Amazon EKS nodes run in your AWS account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster.

You can use the endpointPublicAccess and endpointPrivateAccess parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

You can use the logging parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing .

In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see Allowing users to access your cluster and Launching Amazon EKS nodes in the Amazon EKS User Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eks as eks } from 'aws-cdk-lib';
const cfnCluster = new eks.CfnCluster(this, 'MyCfnCluster', {
  resourcesVpcConfig: {
    subnetIds: ['subnetIds'],

    // the properties below are optional
    endpointPrivateAccess: false,
    endpointPublicAccess: false,
    publicAccessCidrs: ['publicAccessCidrs'],
    securityGroupIds: ['securityGroupIds'],
  },
  roleArn: 'roleArn',

  // the properties below are optional
  accessConfig: {
    authenticationMode: 'authenticationMode',
    bootstrapClusterCreatorAdminPermissions: false,
  },
  bootstrapSelfManagedAddons: false,
  encryptionConfig: [{
    provider: {
      keyArn: 'keyArn',
    },
    resources: ['resources'],
  }],
  kubernetesNetworkConfig: {
    ipFamily: 'ipFamily',
    serviceIpv4Cidr: 'serviceIpv4Cidr',
    serviceIpv6Cidr: 'serviceIpv6Cidr',
  },
  logging: {
    clusterLogging: {
      enabledTypes: [{
        type: 'type',
      }],
    },
  },
  name: 'name',
  outpostConfig: {
    controlPlaneInstanceType: 'controlPlaneInstanceType',
    outpostArns: ['outpostArns'],

    // the properties below are optional
    controlPlanePlacement: {
      groupName: 'groupName',
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  upgradePolicy: {
    supportType: 'supportType',
  },
  version: 'version',
  zonalShiftConfig: {
    enabled: false,
  },
});

Initializer

new CfnCluster(scope: Construct, id: string, props: CfnClusterProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnClusterProps — Resource properties.

Construct Props

Name	Type	Description
resourcesVpcConfig	`IResolvable` `\|` `ResourcesVpcConfigProperty`	The VPC configuration that's used by the cluster control plane.
roleArn	`string`	The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
accessConfig?	`IResolvable` `\|` `AccessConfigProperty`	The access configuration for the cluster.
bootstrapSelfManagedAddons?	`boolean \|` `IResolvable`	If you set this value to `False` when creating a cluster, the default networking add-ons will not be installed.
encryptionConfig?	`IResolvable` `\|` `IResolvable` `\|` `EncryptionConfigProperty[]`	The encryption configuration for the cluster.
kubernetesNetworkConfig?	`IResolvable` `\|` `KubernetesNetworkConfigProperty`	The Kubernetes network configuration for the cluster.
logging?	`IResolvable` `\|` `LoggingProperty`	The logging configuration for your cluster.
name?	`string`	The unique name to give to your cluster.
outpostConfig?	`IResolvable` `\|` `OutpostConfigProperty`	An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost.
tags?	`CfnTag[]`	The metadata that you apply to the cluster to assist with categorization and organization.
upgradePolicy?	`IResolvable` `\|` `UpgradePolicyProperty`	This value indicates if extended support is enabled or disabled for the cluster.
version?	`string`	The desired Kubernetes version for your cluster.
zonalShiftConfig?	`IResolvable` `\|` `ZonalShiftConfigProperty`	The configuration for zonal shift for the cluster.

resourcesVpcConfig

Type: IResolvable | ResourcesVpcConfigProperty

The VPC configuration that's used by the cluster control plane.

Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide . You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.

roleArn

Type: string

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .

accessConfig?

Type: IResolvable | AccessConfigProperty (optional)

The access configuration for the cluster.

bootstrapSelfManagedAddons?

Type: boolean | IResolvable (optional)

If you set this value to False when creating a cluster, the default networking add-ons will not be installed.

The default networking addons include vpc-cni, coredns, and kube-proxy.

Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.

encryptionConfig?

Type: IResolvable | IResolvable | EncryptionConfigProperty[] (optional)

The encryption configuration for the cluster.

kubernetesNetworkConfig?

Type: IResolvable | KubernetesNetworkConfigProperty (optional)

The Kubernetes network configuration for the cluster.

logging?

Type: IResolvable | LoggingProperty (optional)

The logging configuration for your cluster.

name?

Type: string (optional)

The unique name to give to your cluster.

The name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphanumeric character and can't be longer than 100 characters. The name must be unique within the AWS Region and AWS account that you're creating the cluster in. Note that underscores can't be used in AWS CloudFormation .

outpostConfig?

Type: IResolvable | OutpostConfigProperty (optional)

An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost.

This object isn't available for clusters on the AWS cloud.

tags?

Type: CfnTag[] (optional)

The metadata that you apply to the cluster to assist with categorization and organization.

Each tag consists of a key and an optional value, both of which you define. Cluster tags don't propagate to any other resources associated with the cluster.

You must have the eks:TagResource and eks:UntagResource permissions for your IAM principal to manage the AWS CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.

upgradePolicy?

Type: IResolvable | UpgradePolicyProperty (optional)

This value indicates if extended support is enabled or disabled for the cluster.

Learn more about EKS Extended Support in the EKS User Guide.

version?

Type: string (optional)

The desired Kubernetes version for your cluster.

If you don't specify a value here, the default version available in Amazon EKS is used.

The default version might not be the latest version available.

zonalShiftConfig?

Type: IResolvable | ZonalShiftConfigProperty (optional)

The configuration for zonal shift for the cluster.

Properties

Name	Type	Description
attrArn	`string`	The ARN of the cluster, such as `arn:aws:eks:us-west-2:666666666666:cluster/prod` .
attrCertificateAuthorityData	`string`	The `certificate-authority-data` for your cluster.
attrClusterSecurityGroupId	`string`	The cluster security group that was created by Amazon EKS for the cluster.
attrEncryptionConfigKeyArn	`string`	Amazon Resource Name (ARN) or alias of the customer master key (CMK).
attrEndpoint	`string`	The endpoint for your Kubernetes API server, such as `https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com` .
attrId	`string`	The ID of your local Amazon EKS cluster on an AWS Outpost.
attrKubernetesNetworkConfigServiceIpv6Cidr	`string`	The CIDR block that Kubernetes Service IP addresses are assigned from if you created a `1.21` or later cluster with version `>1.10.1` or later of the Amazon VPC CNI add-on and specified `ipv6` for ipFamily when you created the cluster. Kubernetes assigns Service addresses from the unique local address range ( `fc00::/7` ) because you can't specify a custom `IPv6` CIDR block when you create the cluster.
attrOpenIdConnectIssuerUrl	`string`	The issuer URL for the OIDC identity provider of the cluster, such as `https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E` . If you need to remove `https://` from this output value, you can include the following code in your template.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
resourcesVpcConfig	`IResolvable` `\|` `ResourcesVpcConfigProperty`	The VPC configuration that's used by the cluster control plane.
roleArn	`string`	The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
accessConfig?	`IResolvable` `\|` `AccessConfigProperty`	The access configuration for the cluster.
bootstrapSelfManagedAddons?	`boolean \|` `IResolvable`	If you set this value to `False` when creating a cluster, the default networking add-ons will not be installed.
encryptionConfig?	`IResolvable` `\|` `IResolvable` `\|` `EncryptionConfigProperty[]`	The encryption configuration for the cluster.
kubernetesNetworkConfig?	`IResolvable` `\|` `KubernetesNetworkConfigProperty`	The Kubernetes network configuration for the cluster.
logging?	`IResolvable` `\|` `LoggingProperty`	The logging configuration for your cluster.
name?	`string`	The unique name to give to your cluster.
outpostConfig?	`IResolvable` `\|` `OutpostConfigProperty`	An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost.
tagsRaw?	`CfnTag[]`	The metadata that you apply to the cluster to assist with categorization and organization.
upgradePolicy?	`IResolvable` `\|` `UpgradePolicyProperty`	This value indicates if extended support is enabled or disabled for the cluster.
version?	`string`	The desired Kubernetes version for your cluster.
zonalShiftConfig?	`IResolvable` `\|` `ZonalShiftConfigProperty`	The configuration for zonal shift for the cluster.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrArn

Type: string

The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod .

attrCertificateAuthorityData

Type: string

The certificate-authority-data for your cluster.

attrClusterSecurityGroupId

Type: string

The cluster security group that was created by Amazon EKS for the cluster.

Managed node groups use this security group for control plane to data plane communication.

This parameter is only returned by Amazon EKS clusters that support managed node groups. For more information, see Managed node groups in the Amazon EKS User Guide .

attrEncryptionConfigKeyArn

Type: string

Amazon Resource Name (ARN) or alias of the customer master key (CMK).

attrEndpoint

Type: string

The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com .

attrId

Type: string

The ID of your local Amazon EKS cluster on an AWS Outpost.

This property isn't available for an Amazon EKS cluster on the AWS cloud.

attrKubernetesNetworkConfigServiceIpv6Cidr

Type: string

The CIDR block that Kubernetes Service IP addresses are assigned from if you created a 1.21 or later cluster with version >1.10.1 or later of the Amazon VPC CNI add-on and specified ipv6 for ipFamily when you created the cluster. Kubernetes assigns Service addresses from the unique local address range ( fc00::/7 ) because you can't specify a custom IPv6 CIDR block when you create the cluster.

attrOpenIdConnectIssuerUrl

Type: string

The issuer URL for the OIDC identity provider of the cluster, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E . If you need to remove https:// from this output value, you can include the following code in your template.

!Select [1, !Split ["//", !GetAtt EKSCluster.OpenIdConnectIssuerUrl]]

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

resourcesVpcConfig

Type: IResolvable | ResourcesVpcConfigProperty

The VPC configuration that's used by the cluster control plane.

roleArn

Type: string

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

accessConfig?

Type: IResolvable | AccessConfigProperty (optional)

The access configuration for the cluster.

bootstrapSelfManagedAddons?

Type: boolean | IResolvable (optional)

If you set this value to False when creating a cluster, the default networking add-ons will not be installed.

encryptionConfig?

Type: IResolvable | IResolvable | EncryptionConfigProperty[] (optional)

The encryption configuration for the cluster.

kubernetesNetworkConfig?

Type: IResolvable | KubernetesNetworkConfigProperty (optional)

The Kubernetes network configuration for the cluster.

logging?

Type: IResolvable | LoggingProperty (optional)

The logging configuration for your cluster.

name?

Type: string (optional)

The unique name to give to your cluster.

outpostConfig?

Type: IResolvable | OutpostConfigProperty (optional)

An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost.

tagsRaw?

Type: CfnTag[] (optional)

The metadata that you apply to the cluster to assist with categorization and organization.

upgradePolicy?

Type: IResolvable | UpgradePolicyProperty (optional)

This value indicates if extended support is enabled or disabled for the cluster.

version?

Type: string (optional)

The desired Kubernetes version for your cluster.

zonalShiftConfig?

Type: IResolvable | ZonalShiftConfigProperty (optional)

The configuration for zonal shift for the cluster.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

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

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }