You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElastiCache::Types::DescribeUpdateActionsMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeUpdateActionsMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  service_update_name: "String",
  replication_group_ids: ["String"],
  cache_cluster_ids: ["String"],
  engine: "String",
  service_update_status: ["available"], # accepts available, cancelled, expired
  service_update_time_range: {
    start_time: Time.now,
    end_time: Time.now,
  },
  update_action_status: ["not-applied"], # accepts not-applied, waiting-to-start, in-progress, stopping, stopped, complete
  show_node_level_update_status: false,
  max_records: 1,
  marker: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#cache_cluster_idsArray<String>

The cache cluster IDs

Returns:

  • (Array<String>)

    The cache cluster IDs.

#engineString

The Elasticache engine to which the update applies. Either Redis or Memcached

Returns:

  • (String)

    The Elasticache engine to which the update applies.

#markerString

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.

Returns:

  • (String)

    An optional marker returned from a prior request.

#max_recordsInteger

The maximum number of records to include in the response

Returns:

  • (Integer)

    The maximum number of records to include in the response.

#replication_group_idsArray<String>

The replication group IDs

Returns:

  • (Array<String>)

    The replication group IDs.

#service_update_nameString

The unique ID of the service update

Returns:

  • (String)

    The unique ID of the service update.

#service_update_statusArray<String>

The status of the service update

Returns:

  • (Array<String>)

    The status of the service update.

#service_update_time_rangeTypes::TimeRangeFilter

The range of time specified to search for service updates that are in available status

Returns:

  • (Types::TimeRangeFilter)

    The range of time specified to search for service updates that are in available status.

#show_node_level_update_statusBoolean

Dictates whether to include node level update status in the response

Returns:

  • (Boolean)

    Dictates whether to include node level update status in the response.

#update_action_statusArray<String>

The status of the update action.

Returns:

  • (Array<String>)

    The status of the update action.