Amazon ElastiCache for Redis
ElastiCache for Redis User Guide (API Version 2015-02-02)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Applying the Self-Service Updates

You can start applying the service updates to your Redis fleet from the time that the updates have an available status until they have an expired status. Service updates of the type security are cumulative. In other words, any nonexpired updates that you haven't applied yet are included with your latest update.

Note

You can apply only those service updates that have an available status, even if the recommended apply by date is past due.

For more information about reviewing your Redis fleet and applying any service-specific updates to applicable Redis clusters, see Applying the Service Updates Using the Console for Redis.

When a new service update is available for one or more Redis clusters in your fleet, you can use the ElastiCache console, API, or AWS CLI to apply the update. The following sections explain the options that you can use to apply updates.

Applying the Service Updates Using the Console

You can apply the service updates using one of the following console options. ElastiCache provides you two different perspectives to help you decide how and when to apply the updates:

Applying the Service Updates Using the Console for Redis

Choose this to review the Update Status of individual Redis clusters, and then choose Apply, View, or Stop for the service updates. If a service update is available, the console displays a banner at the top of the Redis page, as shown following:

  • If you choose Apply Now, you can choose to apply the service update to all or a subset of the applicable clusters in this workflow, as shown following:

    Note

    If you choose Dismiss, the console stops displaying the banner for that console session. However, the banner reappears the next time that you refresh your session.

    Be aware of the following about the Apply Updates Now page:

    • Auto-Update after Due Date: If you choose not to apply the self-service update before it expires, any clusters or individual nodes that aren't updated remain out of compliance until the next cumulative update is available. ElastiCache doesn't automatically apply the service update on your behalf.

    • The ratio of Nodes Updated on your Redis cluster and the Estimated Update Time allow you to plan your maintenance schedule. If service updates exceed the estimated time constraints for your business flows, you have the option to stop them and re-apply them at a later date. For more information, see Stopping the Self-Service Updates.

    • If you choose to apply the service updates to any or all available Redis clusters, choose Confirm. If you choose this, you can then view the Service Updates page, where you can monitor the status of your service update.

    • If you choose Cancel, you can explore further options, as explained following:

You can inspect your Redis clusters on an individual basis to determine their Update Status. The following lets you know the compliance status of your clusters with regard to available service updates.

Update Status displays one of the following:

  • update available: An update is available to apply to this cluster.

  • in-progress: The update is being applied to this cluster, rendering it unavailable for business flows.

  • stopping: An in-progress update has been interrupted before completion.

  • stopped: The update has been terminated.

    Note

    If you stop an in-progress update on a Redis cluster, some nodes might be updated while others are not. The stopping process doesn't roll back any changes to already updated nodes. You can re-apply the update to those nodes that still have an available status at your convenience, as long as the update doesn't have an Expired status.

  • up to date: The update has been applied and your cluster is compliant. For more information about compliance, see Self-Service Security Updates for Compliance.

Applying the Service Updates Using the Service Updates List

To review the list of individual service updates and their status, along with other relevant information, choose the Service Updates List tab.

When viewing the Service Updates List, note the following:

  • Service Update Name: A unique identifier for the service update.

  • Status: The status of the update, which will be one of the following:

    • available: The update is available for requisite Redis clusters.

    • complete: The update has been applied and all Redis clusters are compliant. (For more information, see Self-Service Security Updates for Compliance).

    • cancelled: The update has been cancelled and is no longer necessary.

    • expired: The update is no longer available to apply.

  • Severity: The priority of applying the update:

    • critical: Recommended to apply immediately (within 14 days or less).

    • important: Recommended to apply as soon as your business flow allows (within 30 days or less).

    • medium: Recommended to apply as soon as possible as your business flow allows (within 60 days or less).

    • low: Recommended to apply as soon as possible as your business flow allows (within 90 days or less).

  • Update Type: For this version, only security updates are supported.

  • Release Date: When the update is released and available to apply on your Redis fleet.

  • Recommended Apply By Date: ElastiCache guidance date to apply the updates by.

Choosing an individual update provides additional details, including the following:

  • Update Description: Provides details on the service update.

  • Update Expiration Date: The date when the service update expires and no longer is available. Any updates that aren't applied before their expiration date are cumulatively rolled into the next update.

Important

We strongly recommend that you apply updates of type security as soon as your business flows allow. This ensures that your Redis clusters are always up-to-date with the latest security patches and are compliant. For more information, see Self-Service Security Updates for Compliance.

To review the list of individual service updates in relation to the applicable Redis clusters, choose the Service Update Status tab.

When viewing the Service Updates Status list, note the following:

  • Service Update Name: Provides detailed information about the service update.

  • Cluster Name: The list of your Redis clusters that are eligible for the update.

  • Nodes Updated: The ratio of individual nodes within a specific cluster that were updated or remain available for the specific service update.

  • Update Severity: The priority of applying the update:

    • critical: Recommended to apply immediately (within 14 days or less).

    • important: Recommended to apply as soon as your business flow allows (within 30 days or less).

    • medium: Recommended to apply as soon as possible as your business flow allows (within 60 days or less).

    • low: Recommended to apply as soon as possible as your business flow allows (within 90 days or less).

  • Update Type: For this version, only security updates are supported.

  • Service Update Status: The status of the update, which will be one of the following:

    • available: The update is available for requisite Redis clusters.

    • complete: The update has been applied and all Redis clusters are Compliant.

    • canceled: The update has been canceled and is no longer necessary.

    • expired: The update is no longer available to apply.

  • Service Update SLA Met: This reflects whether your cluster is compliant.

    • yes: All available updates have been applied to this cluster and available nodes.

    • no: The service update might have been applied successfully to one or more nodes, but other nodes within the cluster still have an available status. This typically happens when a service update is applied and then stopped.

      Note

      If you stop the progress of a service update on a cluster, any nodes that are already updated have a complete status. Any nodes that have an In Progress or Stopping status revert to a Stopped status, and the Service Update SLA Met status changes to no.

  • Cluster Status Modified Date: The latest date that the cluster was modified with a service update.

Note

The Show Previous Updates check box, if selected, displays a list of previous updates that are no longer available.

Applying the Service Updates Using the AWS CLI

After you receive notification that service updates are available, you can inspect and apply them using the AWS CLI:

  • To retrieve a description of the service updates that are available:

    aws elasticache describe-service-updates --service-update-status available

    For more information, see DescribeServiceUpdates.

  • To review update actions that have a not-applied or stopped status:

    aws describe-update-actions --service-update-name sample-service-update --update-action-status not-applied stopped

    For more information, see DescribeUpdateActions.

  • To apply a service update on a list of replication groups:

    aws elasticache batch-apply-update-action --service-update-name sample-service-update --replication-group-ids my-replication-group-1 my-replication-group-2

    For more information, see BatchApplyUpdateAction.