updates

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

Overview

Name	updates
Type	Resource
Id	aws.eks.updates

Fields

The following fields are returned by SELECT queries:

describe_update

Name	Datatype	Description
id	string	A UUID that is used to track the update.
cancellation	object	The latest cancellation information for the update. This field is present only if any cancellation is attempted for the update.
created_at	string (date-time)	The Unix epoch timestamp at object creation.
errors	array	Any errors associated with a Failed update.
params	array	A key-value map that contains the parameters associated with the update.
status	string	The current status of the update. (InProgress, Failed, Cancelled, Successful)
type_	string	The type of the update. (VersionUpdate, EndpointAccessUpdate, LoggingUpdate, ConfigUpdate, AssociateIdentityProviderConfig, DisassociateIdentityProviderConfig, AssociateEncryptionConfig, AddonUpdate, VpcConfigUpdate, AccessConfigUpdate, UpgradePolicyUpdate, ZonalShiftConfigUpdate, AutoModeUpdate, RemoteNetworkConfigUpdate, DeletionProtectionUpdate, CapabilityUpdate, ControlPlaneScalingConfigUpdate, VendedLogsUpdate, ControlPlaneEgressUpdate, VersionRollback, ControlPlaneComponentConfigUpdate, CertificateAuthorityUpdate)

list_updates

Name	Datatype	Description
update_id	string	A list of all the updates for the specified cluster and Region.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_update	select	name, update_id, region	nodegroupName, addonName, capabilityName	Describes an update to an Amazon EKS resource. When the status of the update is Successful, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure.
list_updates	select	name, region	nodegroupName, addonName, capabilityName, nextToken, maxResults	Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.
cancel_update	exec	name, update_id, region		Cancels an in-progress update to an Amazon EKS cluster on a best-effort basis. Cancellation is only performed if the update can be cancelled. Currently, this is supported for VersionRollback update types on EKS Auto Mode clusters when nodes are rolling back. A successful cancellation stops the node rollback. After cancellation, nodes converge to the current cluster version honoring configured disruption controls. If the control plane rollback has already begun, the cancellation request fails.

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 associated with the update.
region	string	AWS region (default: us-east-1)
update_id	string	The ID of the update to cancel.
addonName	string	The names of the installed add-ons that have available updates.
capabilityName	string	The name of the capability for which you want to list updates.
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.
nodegroupName	string	The name of the Amazon EKS managed node group to list updates for.

SELECT examples

describe_update

Describes an update to an Amazon EKS resource. When the status of the update is Successful, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure.

SELECT
id,
cancellation,
created_at,
errors,
params,
status,
type_
FROM aws.eks.updates
WHERE name = '{{ name }}' -- required
AND update_id = '{{ update_id }}' -- required
AND region = '{{ region }}' -- required
AND nodegroupName = '{{ nodegroupName }}'
AND addonName = '{{ addonName }}'
AND capabilityName = '{{ capabilityName }}'
;

list_updates

Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.

SELECT
update_id
FROM aws.eks.updates
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
AND nodegroupName = '{{ nodegroupName }}'
AND addonName = '{{ addonName }}'
AND capabilityName = '{{ capabilityName }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

Lifecycle Methods

cancel_update

Cancels an in-progress update to an Amazon EKS cluster on a best-effort basis. Cancellation is only performed if the update can be cancelled. Currently, this is supported for VersionRollback update types on EKS Auto Mode clusters when nodes are rolling back. A successful cancellation stops the node rollback. After cancellation, nodes converge to the current cluster version honoring configured disruption controls. If the control plane rollback has already begun, the cancellation request fails.

EXEC aws.eks.updates.cancel_update 
@name='{{ name }}' --required, 
@update_id='{{ update_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"clientRequestToken": "{{ clientRequestToken }}"
}'
;