clusters

Creates, updates, deletes, gets or lists a clusters resource.

Overview

Name	`clusters`
Type	Resource
Id	`aws.eks.clusters`

Fields

The following fields are returned by SELECT queries:

describe_cluster
list_clusters

Name	Datatype	Description
`id`	`string`	The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.
`name`	`string`	The name of your cluster.
`access_config`	`object`	The access configuration for the cluster.
`arn`	`string`	The Amazon Resource Name (ARN) of the cluster.
`certificate_authority`	`object`	The certificate-authority-data for your cluster.
`client_request_token`	`string`	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`compute_config`	`object`	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 Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide.
`connector_config`	`object`	The configuration used to connect to a cluster for registration.
`control_plane_scaling_config`	`object`	The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.
`created_at`	`string (date-time)`	The Unix epoch timestamp at object creation.
`deletion_protection`	`boolean`	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.
`encryption_config`	`array`	The encryption configuration for the cluster.
`endpoint`	`string`	The endpoint for your Kubernetes API server.
`health`	`object`	An object representing the health of your Amazon EKS cluster.
`identity`	`object`	The identity provider information for the cluster.
`kube_api_server_config`	`object`	The Kubernetes API server configuration for the cluster.
`kube_controller_manager_config`	`object`	The Kubernetes controller manager configuration for the cluster.
`kube_scheduler_config`	`object`	The Kubernetes scheduler configuration for the cluster.
`kubernetes_network_config`	`object`	The Kubernetes network configuration for the cluster.
`logging`	`object`	An object representing the logging configuration for resources in your cluster.
`outpost_config`	`object`	An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
`platform_version`	`string`	The platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see Platform versions in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the Amazon EKS User Guide .
`remote_network_config`	`object`	The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
`resources_vpc_config`	`object`	The VPC configuration 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.
`role_arn`	`string`	The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf.
`status`	`string`	The current status of the cluster. (CREATING, ACTIVE, DELETING, FAILED, UPDATING, PENDING)
`storage_config`	`object`	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 Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide.
`tags`	`object`	Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
`upgrade_policy`	`object`	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.
`version`	`string`	The Kubernetes server version for the cluster.
`zonal_shift_config`	`object`	The configuration for zonal shift for the cluster.

Name	Datatype	Description
`cluster`	`string`	A list of all of the clusters for your account in the specified Amazon Web Services Region .

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`describe_cluster`	`select`	`name`, `region`		Describes an Amazon EKS cluster. The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Creating or updating a kubeconfig file for an Amazon EKS cluster. The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.
`list_clusters`	`select`	`region`	`maxResults`, `nextToken`, `include`	Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.
`create_cluster`	`insert`	`region`, `name`, `roleArn`, `resourcesVpcConfig`		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 Amazon Web Services, 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 Amazon Web Services 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 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.
`register_cluster`	`insert`	`region`, `name`, `connectorConfig`		Connects a Kubernetes cluster to the Amazon EKS control plane. Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes. Cluster connection requires two steps. First, send a RegisterClusterRequest to add it to the Amazon EKS control plane. Second, a Manifest containing the activationID and activationCode must be applied to the Kubernetes cluster through it's native provider to provide visibility. After the manifest is updated and applied, the connected cluster is visible to the Amazon EKS control plane. If the manifest isn't applied within three days, the connected cluster will no longer be visible and must be deregistered using DeregisterCluster.
`update_cluster_config`	`update`	`name`, `region`		Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with DescribeUpdate. You can use this operation to do the following actions: You can use this API operation 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. You can also use this API operation 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 Cluster API server endpoint in the Amazon EKS User Guide . You can also use this API operation to choose different subnets and security groups for the cluster. You must specify at least two subnets that are in different Availability Zones. You can't change which VPC the subnets are from, the subnets must be in the same VPC as the subnets that the cluster was created with. For more information about the VPC requirements, see https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the Amazon EKS User Guide . You can also use this API operation to enable or disable ARC zonal shift. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster. You can also use this API operation to add, change, or remove the configuration in the cluster for EKS Hybrid Nodes. To remove the configuration, use the remoteNetworkConfig key with an object containing both subkeys with empty arrays for each. Here is an inline example: "remoteNetworkConfig": { "remoteNodeNetworks": [], "remotePodNetworks": [] }. Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active.
`delete_cluster`	`delete`	`name`, `region`		Deletes an Amazon EKS cluster control plane. If you have active services and ingress resources in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a cluster in the Amazon EKS User Guide. If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodgroup and DeleteFargateProfile.
`deregister_cluster`	`exec`	`name`, `region`		Deregisters a connected cluster to remove it from the Amazon EKS control plane. A connected cluster is a Kubernetes cluster that you've connected to your control plane using the Amazon EKS Connector.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`name`	`string`	The name of the connected cluster to deregister.
`region`	`string`	AWS region (default: us-east-1)
`include`	`array`	Indicates whether external clusters are included in the returned list. Use 'all' to return https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.htmlconnected clusters, or blank to return only Amazon EKS clusters. 'all' must be in lowercase otherwise an error occurs.
`maxResults`	`integer`	The maximum number of results, returned in paginated output. You receive maxResults in a single page, along with a nextToken response element. You can see the remaining results of the initial request by sending another request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a nextToken value, if applicable, are returned.
`nextToken`	`string`	The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

`SELECT` examples

describe_cluster
list_clusters

Describes an Amazon EKS cluster. The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Creating or updating a kubeconfig file for an Amazon EKS cluster. The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.

SELECT
id,
name,
access_config,
arn,
certificate_authority,
client_request_token,
compute_config,
connector_config,
control_plane_scaling_config,
created_at,
deletion_protection,
encryption_config,
endpoint,
health,
identity,
kube_api_server_config,
kube_controller_manager_config,
kube_scheduler_config,
kubernetes_network_config,
logging,
outpost_config,
platform_version,
remote_network_config,
resources_vpc_config,
role_arn,
status,
storage_config,
tags,
upgrade_policy,
version,
zonal_shift_config
FROM aws.eks.clusters
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.

SELECT
cluster
FROM aws.eks.clusters
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND include = '{{ include }}'
;

`INSERT` examples

create_cluster
register_cluster
Manifest

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 Amazon Web Services, 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 Amazon Web Services 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 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.

INSERT INTO aws.eks.clusters (
name,
version,
roleArn,
resourcesVpcConfig,
kubernetesNetworkConfig,
logging,
clientRequestToken,
tags,
encryptionConfig,
outpostConfig,
accessConfig,
bootstrapSelfManagedAddons,
upgradePolicy,
zonalShiftConfig,
remoteNetworkConfig,
computeConfig,
storageConfig,
deletionProtection,
controlPlaneScalingConfig,
kubeApiServerConfig,
kubeSchedulerConfig,
kubeControllerManagerConfig,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ version }}',
'{{ roleArn }}' /* required */,
'{{ resourcesVpcConfig }}' /* required */,
'{{ kubernetesNetworkConfig }}',
'{{ logging }}',
'{{ clientRequestToken }}',
'{{ tags }}',
'{{ encryptionConfig }}',
'{{ outpostConfig }}',
'{{ accessConfig }}',
{{ bootstrapSelfManagedAddons }},
'{{ upgradePolicy }}',
'{{ zonalShiftConfig }}',
'{{ remoteNetworkConfig }}',
'{{ computeConfig }}',
'{{ storageConfig }}',
{{ deletionProtection }},
'{{ controlPlaneScalingConfig }}',
'{{ kubeApiServerConfig }}',
'{{ kubeSchedulerConfig }}',
'{{ kubeControllerManagerConfig }}',
'{{ region }}'
RETURNING
cluster
;

Connects a Kubernetes cluster to the Amazon EKS control plane. Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes. Cluster connection requires two steps. First, send a RegisterClusterRequest to add it to the Amazon EKS control plane. Second, a Manifest containing the activationID and activationCode must be applied to the Kubernetes cluster through it's native provider to provide visibility. After the manifest is updated and applied, the connected cluster is visible to the Amazon EKS control plane. If the manifest isn't applied within three days, the connected cluster will no longer be visible and must be deregistered using DeregisterCluster.

INSERT INTO aws.eks.clusters (
name,
connectorConfig,
clientRequestToken,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ connectorConfig }}' /* required */,
'{{ clientRequestToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
cluster
;

# Description fields are for documentation purposes
- name: clusters
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the clusters resource.
  - name: name
    value: "{{ name }}"
  - name: version
    value: "{{ version }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: resourcesVpcConfig
    description: |
      An object representing the VPC configuration to use for an Amazon EKS cluster.
    value:
      subnetIds:
        - "{{ subnetIds }}"
      securityGroupIds:
        - "{{ securityGroupIds }}"
      endpointPublicAccess: {{ endpointPublicAccess }}
      endpointPrivateAccess: {{ endpointPrivateAccess }}
      publicAccessCidrs:
        - "{{ publicAccessCidrs }}"
      controlPlaneEgressMode: "{{ controlPlaneEgressMode }}"
  - name: kubernetesNetworkConfig
    description: |
      The Kubernetes network configuration for the cluster.
    value:
      serviceIpv4Cidr: "{{ serviceIpv4Cidr }}"
      ipFamily: "{{ ipFamily }}"
      elasticLoadBalancing:
        enabled: {{ enabled }}
  - name: logging
    description: |
      An object representing the logging configuration for resources in your cluster.
    value:
      clusterLogging:
        - types: "{{ types }}"
          enabled: {{ enabled }}
  - name: clientRequestToken
    value: "{{ clientRequestToken }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them. The following basic restrictions apply to tags: Maximum number of tags per resource – 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length – 128 Unicode characters in UTF-8 Maximum value length – 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
  - name: encryptionConfig
    value:
      - resources: "{{ resources }}"
        provider:
          keyArn: "{{ keyArn }}"
  - name: outpostConfig
    description: |
      The configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. Before creating a cluster on an Outpost, review Creating a local cluster on an Outpost in the Amazon EKS User Guide. This API isn't available for Amazon EKS clusters on the Amazon Web Services cloud.
    value:
      outpostArns:
        - "{{ outpostArns }}"
      controlPlaneInstanceType: "{{ controlPlaneInstanceType }}"
      controlPlanePlacement:
        groupName: "{{ groupName }}"
        spreadLevel: "{{ spreadLevel }}"
      etcdInstanceType: "{{ etcdInstanceType }}"
      etcdPlacement:
        spreadLevel: "{{ spreadLevel }}"
  - name: accessConfig
    description: |
      The access configuration information for the cluster.
    value:
      bootstrapClusterCreatorAdminPermissions: {{ bootstrapClusterCreatorAdminPermissions }}
      authenticationMode: "{{ authenticationMode }}"
  - name: bootstrapSelfManagedAddons
    value: {{ bootstrapSelfManagedAddons }}
  - name: upgradePolicy
    description: |
      The support policy to use for the cluster. Extended support allows you to remain on specific Kubernetes versions for longer. Clusters in extended support have higher costs. The default value is EXTENDED. Use STANDARD to disable extended support. Learn more about EKS Extended Support in the Amazon EKS User Guide.
    value:
      supportType: "{{ supportType }}"
  - name: zonalShiftConfig
    description: |
      The configuration for zonal shift for the cluster.
    value:
      enabled: {{ enabled }}
  - name: remoteNetworkConfig
    description: |
      The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
    value:
      remoteNodeNetworks:
        - cidrs: "{{ cidrs }}"
      remotePodNetworks:
        - cidrs: "{{ cidrs }}"
  - name: computeConfig
    description: |
      Request to update the configuration of the compute capability of your EKS Auto Mode cluster. For example, enable the capability. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide.
    value:
      enabled: {{ enabled }}
      nodePools:
        - "{{ nodePools }}"
      nodeRoleArn: "{{ nodeRoleArn }}"
  - name: storageConfig
    description: |
      Request to update the configuration of the storage capability of your EKS Auto Mode cluster. For example, enable the capability. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide.
    value:
      blockStorage:
        enabled: {{ enabled }}
  - name: deletionProtection
    value: {{ deletionProtection }}
  - name: controlPlaneScalingConfig
    description: |
      The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.
    value:
      tier: "{{ tier }}"
  - name: kubeApiServerConfig
    description: |
      The configuration for the Kubernetes API server on an Amazon EKS cluster.
    value:
      eventTtl: "{{ eventTtl }}"
      serviceNodePortRange:
        minPort: {{ minPort }}
        maxPort: {{ maxPort }}
  - name: kubeSchedulerConfig
    description: |
      The configuration for the Kubernetes scheduler on an Amazon EKS cluster.
    value:
      nodeResourcesFit:
        scoringStrategy:
          type_: "{{ type_ }}"
          resources:
            - name: "{{ name }}"
              weight: {{ weight }}
  - name: kubeControllerManagerConfig
    description: |
      The configuration for the Kubernetes controller manager on an Amazon EKS cluster.
    value:
      horizontalPodAutoscalerControllerConfig:
        horizontalPodAutoscalerSyncPeriod: "{{ horizontalPodAutoscalerSyncPeriod }}"
  - name: connectorConfig
    description: |
      The configuration sent to a cluster for configuration.
    value:
      roleArn: "{{ roleArn }}"
      provider: "{{ provider }}"

`UPDATE` examples

update_cluster_config

Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with DescribeUpdate. You can use this operation to do the following actions: You can use this API operation 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. You can also use this API operation 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 Cluster API server endpoint in the Amazon EKS User Guide . You can also use this API operation to choose different subnets and security groups for the cluster. You must specify at least two subnets that are in different Availability Zones. You can't change which VPC the subnets are from, the subnets must be in the same VPC as the subnets that the cluster was created with. For more information about the VPC requirements, see https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the Amazon EKS User Guide . You can also use this API operation to enable or disable ARC zonal shift. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster. You can also use this API operation to add, change, or remove the configuration in the cluster for EKS Hybrid Nodes. To remove the configuration, use the remoteNetworkConfig key with an object containing both subkeys with empty arrays for each. Here is an inline example: "remoteNetworkConfig": { "remoteNodeNetworks": [], "remotePodNetworks": [] }. Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active.

UPDATE aws.eks.clusters
SET 
resourcesVpcConfig = '{{ resourcesVpcConfig }}',
logging = '{{ logging }}',
clientRequestToken = '{{ clientRequestToken }}',
accessConfig = '{{ accessConfig }}',
upgradePolicy = '{{ upgradePolicy }}',
zonalShiftConfig = '{{ zonalShiftConfig }}',
computeConfig = '{{ computeConfig }}',
kubernetesNetworkConfig = '{{ kubernetesNetworkConfig }}',
storageConfig = '{{ storageConfig }}',
remoteNetworkConfig = '{{ remoteNetworkConfig }}',
deletionProtection = {{ deletionProtection }},
controlPlaneScalingConfig = '{{ controlPlaneScalingConfig }}',
kubeApiServerConfig = '{{ kubeApiServerConfig }}',
kubeSchedulerConfig = '{{ kubeSchedulerConfig }}',
kubeControllerManagerConfig = '{{ kubeControllerManagerConfig }}'
WHERE 
name = '{{ name }}' --required
AND region = '{{ region }}' --required
RETURNING
update;

`DELETE` examples

delete_cluster

Deletes an Amazon EKS cluster control plane. If you have active services and ingress resources in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a cluster in the Amazon EKS User Guide. If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodgroup and DeleteFargateProfile.

DELETE FROM aws.eks.clusters
WHERE name = '{{ name }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

deregister_cluster

Deregisters a connected cluster to remove it from the Amazon EKS control plane. A connected cluster is a Kubernetes cluster that you've connected to your control plane using the Amazon EKS Connector.

EXEC aws.eks.clusters.deregister_cluster 
@name='{{ name }}' --required, 
@region='{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​