update_actions

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

Overview

Name	update_actions
Type	Resource
Id	aws.elasticache.update_actions

Fields

The following fields are returned by SELECT queries:

describe_update_actions

Name	Datatype	Description
cache_cluster_id	string	The ID of the cache cluster
cache_node_update_status	string	The status of the service update on the cache node
engine	string	The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.
estimated_update_time	string	The estimated length of time for the update to complete
node_group_update_status	string	The status of the service update on the node group
nodes_updated	string	The progress of the service update on the replication group
replication_group_id	string	The ID of the replication group
service_update_name	string	The unique ID of the service update
service_update_recommended_apply_by_date	string	The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
service_update_release_date	string	The date the update is first available
service_update_severity	string	The severity of the service update
service_update_status	string	The status of the service update
service_update_type	string	Reflects the nature of the service update
sla_met	string	If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the recommended apply-by date.
update_action_available_date	string	The date that the service update is available to a replication group
update_action_status	string	The status of the update action
update_action_status_modified_date	string	The date when the UpdateActionStatus was last modified

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_update_actions	select	region	ServiceUpdateName, ReplicationGroupIds, CacheClusterIds, Engine, ServiceUpdateStatus, ServiceUpdateTimeRange, UpdateActionStatus, ShowNodeLevelUpdateStatus, MaxRecords, Marker	Returns details of the update actions

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
region	string	AWS region (default: us-east-1)
CacheClusterIds	array	The cache cluster IDs
Engine	string	The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.
Marker	string	An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords	integer	The maximum number of records to include in the response
ReplicationGroupIds	array	The replication group IDs
ServiceUpdateName	string	The unique ID of the service update
ServiceUpdateStatus	array	The status of the service update
ServiceUpdateTimeRange	object	The range of time specified to search for service updates that are in available status
ShowNodeLevelUpdateStatus	boolean	Dictates whether to include node level update status in the response
UpdateActionStatus	array	The status of the update action.

SELECT examples

describe_update_actions

Returns details of the update actions

SELECT
cache_cluster_id,
cache_node_update_status,
engine,
estimated_update_time,
node_group_update_status,
nodes_updated,
replication_group_id,
service_update_name,
service_update_recommended_apply_by_date,
service_update_release_date,
service_update_severity,
service_update_status,
service_update_type,
sla_met,
update_action_available_date,
update_action_status,
update_action_status_modified_date
FROM aws.elasticache.update_actions
WHERE region = '{{ region }}' -- required
AND ServiceUpdateName = '{{ ServiceUpdateName }}'
AND ReplicationGroupIds = '{{ ReplicationGroupIds }}'
AND CacheClusterIds = '{{ CacheClusterIds }}'
AND Engine = '{{ Engine }}'
AND ServiceUpdateStatus = '{{ ServiceUpdateStatus }}'
AND ServiceUpdateTimeRange = '{{ ServiceUpdateTimeRange }}'
AND UpdateActionStatus = '{{ UpdateActionStatus }}'
AND ShowNodeLevelUpdateStatus = '{{ ShowNodeLevelUpdateStatus }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;