Class: Aws::ElastiCache::Types::DescribeUsersMessage

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

{
  engine: "EngineType",
  user_id: "UserId",
  filters: [
    {
      name: "FilterName", # required
      values: ["FilterValue"], # required
    },
  ],
  max_records: 1,
  marker: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#engineString

The Redis engine.

Returns:

  • (String)


4620
4621
4622
4623
4624
4625
4626
4627
4628
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4620

class DescribeUsersMessage < Struct.new(
  :engine,
  :user_id,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::Filter>

Filter to determine the list of User IDs to return.

Returns:



4620
4621
4622
4623
4624
4625
4626
4627
4628
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4620

class DescribeUsersMessage < Struct.new(
  :engine,
  :user_id,
  :filters,
  :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)


4620
4621
4622
4623
4624
4625
4626
4627
4628
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4620

class DescribeUsersMessage < Struct.new(
  :engine,
  :user_id,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#max_recordsInteger

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.

Returns:

  • (Integer)


4620
4621
4622
4623
4624
4625
4626
4627
4628
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4620

class DescribeUsersMessage < Struct.new(
  :engine,
  :user_id,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#user_idString

The ID of the user.

Returns:

  • (String)


4620
4621
4622
4623
4624
4625
4626
4627
4628
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4620

class DescribeUsersMessage < Struct.new(
  :engine,
  :user_id,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end