service_updates

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

Overview

Name	service_updates
Type	Resource
Id	aws.elasticache.service_updates

Fields

The following fields are returned by SELECT queries:

describe_service_updates

Name	Datatype	Description
auto_update_after_recommended_apply_by_date	boolean	Indicates whether the service update will be automatically applied once the recommended apply-by date has expired.
engine	string	The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.
engine_version	string	The Elasticache engine version to which the update applies. Either Valkey, Redis OSS or Memcached engine version.
estimated_update_time	string	The estimated length of time the service update will take
service_update_description	string	Provides details of the service update
service_update_end_date	string	The date after which the service update is no longer available
service_update_name	string	The unique ID of the service update
service_update_recommended_apply_by_date	string	The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
service_update_release_date	string	The date when the service update is initially 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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_service_updates	select	region	ServiceUpdateName, ServiceUpdateStatus, MaxRecords, Marker	Returns details of the service updates
batch_apply_update_action	exec	ServiceUpdateName, region	ReplicationGroupIds, CacheClusterIds	Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
batch_stop_update_action	exec	ServiceUpdateName, region	ReplicationGroupIds, CacheClusterIds	Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.

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
ServiceUpdateName	string	The unique ID of the service update
region	string	AWS region (default: us-east-1)
CacheClusterIds	array	The cache cluster IDs
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

SELECT examples

describe_service_updates

Returns details of the service updates

SELECT
auto_update_after_recommended_apply_by_date,
engine,
engine_version,
estimated_update_time,
service_update_description,
service_update_end_date,
service_update_name,
service_update_recommended_apply_by_date,
service_update_release_date,
service_update_severity,
service_update_status,
service_update_type
FROM aws.elasticache.service_updates
WHERE region = '{{ region }}' -- required
AND ServiceUpdateName = '{{ ServiceUpdateName }}'
AND ServiceUpdateStatus = '{{ ServiceUpdateStatus }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;

Lifecycle Methods

batch_apply_update_action

Apply the service update. For more information on service updates and applying them, see Applying Service Updates.

EXEC aws.elasticache.service_updates.batch_apply_update_action 
@ServiceUpdateName='{{ ServiceUpdateName }}' --required, 
@region='{{ region }}' --required, 
@ReplicationGroupIds='{{ ReplicationGroupIds }}', 
@CacheClusterIds='{{ CacheClusterIds }}'
;

batch_stop_update_action

Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.

EXEC aws.elasticache.service_updates.batch_stop_update_action 
@ServiceUpdateName='{{ ServiceUpdateName }}' --required, 
@region='{{ region }}' --required, 
@ReplicationGroupIds='{{ ReplicationGroupIds }}', 
@CacheClusterIds='{{ CacheClusterIds }}'
;