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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb

Overview

Note:

When making an API call, you may pass DescribeUpdateActionsMessage data as a 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, scheduling, scheduled, not-applicable
  show_node_level_update_status: false,
  max_records: 1,
  marker: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cache_cluster_idsArray<String>

The cache cluster IDs

Returns:

  • (Array<String>)


4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4139

class DescribeUpdateActionsMessage < Struct.new(
  :service_update_name,
  :replication_group_ids,
  :cache_cluster_ids,
  :engine,
  :service_update_status,
  :service_update_time_range,
  :update_action_status,
  :show_node_level_update_status,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#engineString

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

Returns:

  • (String)


4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4139

class DescribeUpdateActionsMessage < Struct.new(
  :service_update_name,
  :replication_group_ids,
  :cache_cluster_ids,
  :engine,
  :service_update_status,
  :service_update_time_range,
  :update_action_status,
  :show_node_level_update_status,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#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)


4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4139

class DescribeUpdateActionsMessage < Struct.new(
  :service_update_name,
  :replication_group_ids,
  :cache_cluster_ids,
  :engine,
  :service_update_status,
  :service_update_time_range,
  :update_action_status,
  :show_node_level_update_status,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#max_recordsInteger

The maximum number of records to include in the response

Returns:

  • (Integer)


4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4139

class DescribeUpdateActionsMessage < Struct.new(
  :service_update_name,
  :replication_group_ids,
  :cache_cluster_ids,
  :engine,
  :service_update_status,
  :service_update_time_range,
  :update_action_status,
  :show_node_level_update_status,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#replication_group_idsArray<String>

The replication group IDs

Returns:

  • (Array<String>)


4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4139

class DescribeUpdateActionsMessage < Struct.new(
  :service_update_name,
  :replication_group_ids,
  :cache_cluster_ids,
  :engine,
  :service_update_status,
  :service_update_time_range,
  :update_action_status,
  :show_node_level_update_status,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#service_update_nameString

The unique ID of the service update

Returns:

  • (String)


4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4139

class DescribeUpdateActionsMessage < Struct.new(
  :service_update_name,
  :replication_group_ids,
  :cache_cluster_ids,
  :engine,
  :service_update_status,
  :service_update_time_range,
  :update_action_status,
  :show_node_level_update_status,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#service_update_statusArray<String>

The status of the service update

Returns:

  • (Array<String>)


4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4139

class DescribeUpdateActionsMessage < Struct.new(
  :service_update_name,
  :replication_group_ids,
  :cache_cluster_ids,
  :engine,
  :service_update_status,
  :service_update_time_range,
  :update_action_status,
  :show_node_level_update_status,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#service_update_time_rangeTypes::TimeRangeFilter

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



4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4139

class DescribeUpdateActionsMessage < Struct.new(
  :service_update_name,
  :replication_group_ids,
  :cache_cluster_ids,
  :engine,
  :service_update_status,
  :service_update_time_range,
  :update_action_status,
  :show_node_level_update_status,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#show_node_level_update_statusBoolean

Dictates whether to include node level update status in the response

Returns:

  • (Boolean)


4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4139

class DescribeUpdateActionsMessage < Struct.new(
  :service_update_name,
  :replication_group_ids,
  :cache_cluster_ids,
  :engine,
  :service_update_status,
  :service_update_time_range,
  :update_action_status,
  :show_node_level_update_status,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#update_action_statusArray<String>

The status of the update action.

Returns:

  • (Array<String>)


4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4139

class DescribeUpdateActionsMessage < Struct.new(
  :service_update_name,
  :replication_group_ids,
  :cache_cluster_ids,
  :engine,
  :service_update_status,
  :service_update_time_range,
  :update_action_status,
  :show_node_level_update_status,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end