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

Class: Aws::ElastiCache::Types::DescribeReplicationGroupsMessage

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 DescribeReplicationGroupsMessage data as a hash:

{
  replication_group_id: "String",
  max_records: 1,
  marker: "String",
}

Represents the input of a DescribeReplicationGroups operation.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns:

  • (String) 


2788
2789
2790
2791
2792
2793
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2788

class DescribeReplicationGroupsMessage < Struct.new(
  :replication_group_id,
  :max_records,
  :marker)
  include Aws::Structure
end

#max_records ⇒ Integer

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Returns:

  • (Integer) 


2788
2789
2790
2791
2792
2793
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2788

class DescribeReplicationGroupsMessage < Struct.new(
  :replication_group_id,
  :max_records,
  :marker)
  include Aws::Structure
end

#replication_group_id ⇒ String

The identifier for the replication group to be described. This parameter is not case sensitive.

If you do not specify this parameter, information about all replication groups is returned.

Returns:

  • (String) 


2788
2789
2790
2791
2792
2793
 
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2788

class DescribeReplicationGroupsMessage < Struct.new(
  :replication_group_id,
  :max_records,
  :marker)
  include Aws::Structure
end