cluster_versions

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

Overview

Name	cluster_versions
Type	Resource
Id	aws.eks.cluster_versions

Fields

The following fields are returned by SELECT queries:

describe_cluster_versions

Name	Datatype	Description
cluster_type	string	The type of cluster this version is for.
cluster_version	string	The Kubernetes version for the cluster.
control_plane_component_config	object	The default control plane component configuration and constraints for this Kubernetes version.
control_plane_scaling_tiers	array	The available provisioned control plane scaling tiers and their capabilities for this Kubernetes version.
default_platform_version	string	Default platform version for this Kubernetes version.
default_version	boolean	Indicates if this is a default version.
end_of_extended_support_date	string (date-time)	Date when extended support ends for this version.
end_of_standard_support_date	string (date-time)	Date when standard support ends for this version.
kubernetes_patch_version	string	The patch version of Kubernetes for this cluster version.
release_date	string (date-time)	The release date of this cluster version.
status	string	This field is deprecated. Use versionStatus instead, as that field matches for input and output of this action. Current status of this cluster version. (unsupported, standard-support, extended-support)
version_status	string	Current status of this cluster version. (UNSUPPORTED, STANDARD_SUPPORT, EXTENDED_SUPPORT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_cluster_versions	select	region	clusterType, maxResults, nextToken, defaultOnly, includeAll, clusterVersions, status, versionStatus	Lists available Kubernetes versions for Amazon EKS clusters.
update_cluster_version	update	name, region, version		Updates an Amazon EKS cluster to the specified Kubernetes version. 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 the DescribeUpdate API operation. 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. If your cluster has managed node groups attached to it, all of your node groups' Kubernetes versions must match the cluster's Kubernetes version in order to update the cluster to a new Kubernetes version.

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 Amazon EKS cluster to update.
region	string	AWS region (default: us-east-1)
clusterType	string	The type of cluster to filter versions by.
clusterVersions	array	List of specific cluster versions to describe.
defaultOnly	boolean	Filter to show only default versions.
includeAll	boolean	Include all available versions in the response.
maxResults	integer	Maximum number of results to return.
nextToken	string	Pagination token for the next set of results.
status	string	This field is deprecated. Use versionStatus instead, as that field matches for input and output of this action. Filter versions by their current status.
versionStatus	string	Filter versions by their current status.

SELECT examples

describe_cluster_versions

Lists available Kubernetes versions for Amazon EKS clusters.

SELECT
cluster_type,
cluster_version,
control_plane_component_config,
control_plane_scaling_tiers,
default_platform_version,
default_version,
end_of_extended_support_date,
end_of_standard_support_date,
kubernetes_patch_version,
release_date,
status,
version_status
FROM aws.eks.cluster_versions
WHERE region = '{{ region }}' -- required
AND clusterType = '{{ clusterType }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND defaultOnly = '{{ defaultOnly }}'
AND includeAll = '{{ includeAll }}'
AND clusterVersions = '{{ clusterVersions }}'
AND status = '{{ status }}'
AND versionStatus = '{{ versionStatus }}'
;

UPDATE examples

update_cluster_version

Updates an Amazon EKS cluster to the specified Kubernetes version. 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 the DescribeUpdate API operation. 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. If your cluster has managed node groups attached to it, all of your node groups' Kubernetes versions must match the cluster's Kubernetes version in order to update the cluster to a new Kubernetes version.

UPDATE aws.eks.cluster_versions
SET 
version = '{{ version }}',
clientRequestToken = '{{ clientRequestToken }}',
force = {{ force }},
rollbackConfig = '{{ rollbackConfig }}'
WHERE 
name = '{{ name }}' --required
AND region = '{{ region }}' --required
AND version = '{{ version }}' --required
RETURNING
update;