# CfnCluster 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 ELB 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. The endpoint domain name and IP address family depends on the value of the `ipFamily` for the cluster. For more information, see [Amazon EKS Cluster Endpoint Access Control](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) 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](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) 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](https://docs.aws.amazon.com/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](https://docs.aws.amazon.com/eks/latest/userguide/cluster-auth.html) and [Launching Amazon EKS nodes](https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html) in the *Amazon EKS User Guide* . Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnCluster Implements: IInspectable, ITaggable, IEnvironmentAware, IClusterRef, IConstruct, IDependable - CloudFormation: [`AWS::EKS::Cluster`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-eks-cluster.html) - Source: Generated code - Type last changed: v2.268.0 · 2 Sep 2026 ## Example ```ts // 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 controlPlaneEgressMode: 'controlPlaneEgressMode', endpointPrivateAccess: false, endpointPublicAccess: false, publicAccessCidrs: ['publicAccessCidrs'], securityGroupIds: ['securityGroupIds'], }, roleArn: 'roleArn', // the properties below are optional accessConfig: { authenticationMode: 'authenticationMode', bootstrapClusterCreatorAdminPermissions: false, }, activeCertificateAuthorityId: 'activeCertificateAuthorityId', bootstrapSelfManagedAddons: false, certificateAuthority: { active: { activatedBy: 'activatedBy', id: 'id', }, data: 'data', }, computeConfig: { enabled: false, nodePools: ['nodePools'], nodeRoleArn: 'nodeRoleArn', }, controlPlaneScalingConfig: { tier: 'tier', }, deletionProtection: false, encryptionConfig: [{ provider: { keyArn: 'keyArn', }, resources: ['resources'], }], force: false, kubeApiServerConfig: { eventTtl: 'eventTtl', serviceNodePortRange: { maxPort: 123, minPort: 123, }, }, kubeControllerManagerConfig: { horizontalPodAutoscalerControllerConfig: { horizontalPodAutoscalerSyncPeriod: 'horizontalPodAutoscalerSyncPeriod', }, podGcControllerConfig: { terminatedPodGcThreshold: 123, }, }, kubernetesNetworkConfig: { elasticLoadBalancing: { enabled: false, }, ipFamily: 'ipFamily', serviceIpv4Cidr: 'serviceIpv4Cidr', serviceIpv6Cidr: 'serviceIpv6Cidr', }, kubeSchedulerConfig: { nodeResourcesFit: { scoringStrategy: { resources: [{ name: 'name', weight: 123, }], type: 'type', }, }, }, logging: { clusterLogging: { enabledTypes: [{ type: 'type', }], }, }, name: 'name', outpostConfig: { controlPlaneInstanceType: 'controlPlaneInstanceType', outpostArns: ['outpostArns'], // the properties below are optional controlPlanePlacement: { groupName: 'groupName', spreadLevel: 'spreadLevel', }, etcdInstanceType: 'etcdInstanceType', etcdPlacement: { spreadLevel: 'spreadLevel', }, }, remoteNetworkConfig: { remoteNodeNetworks: [{ cidrs: ['cidrs'], }], remotePodNetworks: [{ cidrs: ['cidrs'], }], }, rollbackConfig: { timeoutMinutes: 123, }, storageConfig: { blockStorage: { enabled: false, }, }, tags: [{ key: 'key', value: 'value', }], upgradePolicy: { supportType: 'supportType', }, version: 'version', zonalShiftConfig: { enabled: false, }, }); ``` ## Initializer ```ts new CfnCluster(scope: Construct, id: string, props: CfnClusterProps) ``` ## Construct Props - `accessConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.AccessConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.AccessConfigProperty.html) — The access configuration for the cluster. - `activeCertificateAuthorityId`: string — The ID of the certificate authority to activate as the cluster's signing CA. Setting or changing this value activates the specified CA (the previously active CA becomes trusted). - `bootstrapSelfManagedAddons`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — If you set this value to `False` when creating a cluster, the default networking add-ons will not be installed. The default networking add-ons 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. - `certificateAuthority`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.CertificateAuthorityProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.CertificateAuthorityProperty.html) — The certificate authority information for the cluster, including the trust bundle and the currently active signing certificate authority. - `computeConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.ComputeConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.ComputeConfigProperty.html) — Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your AWS account. For more information, see EKS Auto Mode compute capability in the *Amazon EKS User Guide* . - `controlPlaneScalingConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.ControlPlaneScalingConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.ControlPlaneScalingConfigProperty.html) — The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide. - `deletionProtection`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — The current deletion protection setting for the cluster. When `true` , deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When `false` , the cluster can be deleted normally. This setting only applies to clusters in an active state. - `encryptionConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.EncryptionConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.EncryptionConfigProperty.html)[] — The encryption configuration for the cluster. - `force`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) = false — Set this value to `true` to override upgrade-blocking readiness checks when updating a cluster. - `kubeApiServerConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.KubeApiServerConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.KubeApiServerConfigProperty.html) — The configuration for the Kubernetes API server on an Amazon EKS cluster. - `kubeControllerManagerConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.KubeControllerManagerConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.KubeControllerManagerConfigProperty.html) — The configuration for the Kubernetes controller manager on an Amazon EKS cluster. - `kubernetesNetworkConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.KubernetesNetworkConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.KubernetesNetworkConfigProperty.html) — The Kubernetes network configuration for the cluster. - `kubeSchedulerConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.KubeSchedulerConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.KubeSchedulerConfigProperty.html) — The configuration for the Kubernetes scheduler on an Amazon EKS cluster. - `logging`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.LoggingProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.LoggingProperty.html) — The logging configuration for your cluster. - `name`: string — 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 CloudFormation . - `outpostConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.OutpostConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.OutpostConfigProperty.html) — 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. - `remoteNetworkConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.RemoteNetworkConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.RemoteNetworkConfigProperty.html) — The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created. - `resourcesVpcConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.ResourcesVpcConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.ResourcesVpcConfigProperty.html) (required) — 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](https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) and [Cluster Security Group Considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) 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`: string | [IRoleRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_iam.IRoleRef.html) (required) — 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](https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html) in the **Amazon EKS User Guide** . - `rollbackConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.RollbackConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.RollbackConfigProperty.html) — The rollback configuration to use for the cluster version rollback. - `storageConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.StorageConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.StorageConfigProperty.html) — Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your AWS account. For more information, see EKS Auto Mode block storage capability in the *Amazon EKS User Guide* . - `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — 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](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) to manage the 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`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.UpgradePolicyProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.UpgradePolicyProperty.html) — This value indicates if extended support is enabled or disabled for the cluster. [Learn more about EKS Extended Support in the *Amazon EKS User Guide* .](https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html) - `version`: string — 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`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.ZonalShiftConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.ZonalShiftConfigProperty.html) — The configuration for zonal shift for the cluster. ## Properties - `accessConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.AccessConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.AccessConfigProperty.html) — The access configuration for the cluster. - `activeCertificateAuthorityId`: string — The ID of the certificate authority to activate as the cluster's signing CA. - `attrArn`: string — The ARN of the cluster, such as `arn:aws:eks:us-west-2:666666666666:cluster/prod` . - `attrCertificateAuthorityActiveActivatedBy`: string — Indicates whether the active certificate authority was activated by EKS or by the customer. - `attrCertificateAuthorityActiveId`: string — The ID of the active (signing) certificate authority. - `attrCertificateAuthorityCertificateData`: string — The base64-encoded certificate-authority trust bundle for the cluster (all trusted CAs). - `attrCertificateAuthorityData`: string — The `certificate-authority-data` for your cluster. - `attrClusterSecurityGroupId`: 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](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) in the *Amazon EKS User Guide* . - `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. This property isn't available for an Amazon EKS cluster on the AWS cloud. - `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. `!Select [1, !Split ["//", !GetAtt EKSCluster.OpenIdConnectIssuerUrl]]` - `bootstrapSelfManagedAddons`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — If you set this value to `False` when creating a cluster, the default networking add-ons will not be installed. - `certificateAuthority`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.CertificateAuthorityProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.CertificateAuthorityProperty.html) — The certificate authority information for the cluster, including the trust bundle and the currently active signing certificate authority. - `CFN_RESOURCE_TYPE_NAME`: string (static) — The CloudFormation resource type name for this resource class. - `cfnOptions`: [ICfnResourceOptions](/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) — Options for this resource, such as condition, update policy etc. - `cfnResourceType`: string — AWS resource type. - `clusterRef`: [ClusterReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_eks.ClusterReference.html) — A reference to a Cluster resource. - `computeConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.ComputeConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.ComputeConfigProperty.html) — Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. - `controlPlaneScalingConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.ControlPlaneScalingConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.ControlPlaneScalingConfigProperty.html) — The control plane scaling tier configuration. - `creationStack`: string[] - `deletionProtection`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — The current deletion protection setting for the cluster. - `encryptionConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.EncryptionConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.EncryptionConfigProperty.html)[] — The encryption configuration for the cluster. - `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) - `force`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Set this value to `true` to override upgrade-blocking readiness checks when updating a cluster. - `kubeApiServerConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.KubeApiServerConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.KubeApiServerConfigProperty.html) — The configuration for the Kubernetes API server on an Amazon EKS cluster. - `kubeControllerManagerConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.KubeControllerManagerConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.KubeControllerManagerConfigProperty.html) — The configuration for the Kubernetes controller manager on an Amazon EKS cluster. - `kubernetesNetworkConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.KubernetesNetworkConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.KubernetesNetworkConfigProperty.html) — The Kubernetes network configuration for the cluster. - `kubeSchedulerConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.KubeSchedulerConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.KubeSchedulerConfigProperty.html) — The configuration for the Kubernetes scheduler on an Amazon EKS cluster. - `logging`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.LoggingProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.LoggingProperty.html) — The logging configuration for your cluster. - `logicalId`: 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)`. - `name`: string — The unique name to give to your cluster. - `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node. - `outpostConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.OutpostConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.OutpostConfigProperty.html) — An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost. - `ref`: 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 })`. - `remoteNetworkConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.RemoteNetworkConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.RemoteNetworkConfigProperty.html) — The configuration in the cluster for EKS Hybrid Nodes. - `resourcesVpcConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.ResourcesVpcConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.ResourcesVpcConfigProperty.html) — 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. - `rollbackConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.RollbackConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.RollbackConfigProperty.html) — The rollback configuration to use for the cluster version rollback. - `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). - `storageConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.StorageConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.StorageConfigProperty.html) — Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. - `tags`: [TagManager](/cdk/api/v2/docs/aws-cdk-lib.TagManager.html) — Tag Manager which manages the tags for this resource. - `tagsRaw`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — The metadata that you apply to the cluster to assist with categorization and organization. - `upgradePolicy`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.UpgradePolicyProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.UpgradePolicyProperty.html) — This value indicates if extended support is enabled or disabled for the cluster. - `version`: string — The desired Kubernetes version for your cluster. - `zonalShiftConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.ZonalShiftConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnCluster.ZonalShiftConfigProperty.html) — The configuration for zonal shift for the cluster. ## Methods - `addDeletionOverride(path: string): void` — Syntactic sugar for `addOverride(path, undefined)`. **Parameters** - `path` — The path of the value to delete. - `addDependency(target: CfnResource): void` — Use `addResourceDependency` instead. This method has been renamed to `addResourceDependency` to more clearly set it apart from `construct.node.addDependency`. See the documentation of that function for more details. - `addDependsOn(target: CfnResource): void` — Use `addResourceDependency` instead. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. This method has been renamed to `addResourceDependency`, which makes it more clear that this method operates at a different level from the construct-level `construct.node.addDependency()` mechanism. - `addMetadata(key: string, value: any): void` — Add a value to the CloudFormation Resource Metadata. - `addOverride(path: string, value: any): void` — 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, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "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. **Parameters** - `path` — - The path of the property, you can use dot notation to override values in complex types. - `value` — - The value. - `addPropertyDeletionOverride(propertyPath: string): void` — Adds an override that deletes the value of a property from the resource definition. **Parameters** - `propertyPath` — The path to the property. - `addPropertyOverride(propertyPath: string, value: any): void` — Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. **Parameters** - `propertyPath` — The path of the property. - `value` — The value. - `addResourceDependency(target: CfnResource, reason?: string): void` — 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. This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use `construct.node.addDependency` instead. - `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Sets the cross-stack reference strength for this resource. When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context. **Parameters** - `strength` — - The reference strength to use for this resource. - `applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void` — 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: - `arnForCluster(resource: IClusterRef): string` (static) - `cfnPropertyName(cdkPropertyName: string): string` - `fromClusterArn(scope: Construct, id: string, arn: string): IClusterRef` (static) — Creates a new IClusterRef from an ARN. - `fromClusterName(scope: Construct, id: string, clusterName: string): IClusterRef` (static) — Creates a new IClusterRef from a clusterName. - `getAtt(attributeName: string, typeHint?: ResolutionTypeHint): 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. **Parameters** - `attributeName` — The name of the attribute. - `getMetadata(key: string): any` — Retrieve a value value from the CloudFormation Resource Metadata. - `inspect(inspector: TreeInspector): void` — Examines the CloudFormation resource and discloses attributes. **Parameters** - `inspector` — tree inspector to collect and process attributes. - `isCfnCluster(x: any): boolean` (static) — Checks whether the given object is a CfnCluster. - `isCfnElement(x: any): boolean` (static) — Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. **Returns:** The construct as a stack element or undefined if it is not a stack element. - `isCfnResource(x: any): boolean` (static) — Check whether the given object is a CfnResource. - `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. **Parameters** - `x` — Any object. **Returns:** true if `x` is an object created from a class which extends `Construct`. - `obtainDependencies(): Stack | CfnResource[]` — Retrieves an array of resources and stacks this resource depends on. For resources depended on directly, returns the `CfnResource` object. For dependencies on other stacks, returns the `Stack` object. The order of the array is not guaranteed. - `overrideLogicalId(newLogicalId: string): void` — Overrides the auto-generated logical ID with a specific ID. **Parameters** - `newLogicalId` — The new logical ID to use for this stack element. - `removeDependency(target: CfnResource): void` — Use `removeResourceDependency` instead This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. - `removeResourceDependency(target: CfnResource): void` — 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: CfnResource, newTarget: CfnResource): void` — Replaces one dependency with another. **Parameters** - `target` — The dependency to replace. - `newTarget` — The new dependency to add. - `toString(): string` — Returns a string representation of this construct. **Returns:** a string representation of this resource - `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs.