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

Class: Aws::DAX::Types::DescribeParametersRequest

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

Overview

Note:

When making an API call, you may pass DescribeParametersRequest data as a hash:

{
  parameter_group_name: "String", # required
  source: "String",
  max_results: 1,
  next_token: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

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

The value for MaxResults must be between 20 and 100.

Returns:

  • (Integer)


769
770
771
772
773
774
775
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 769

class DescribeParametersRequest < Struct.new(
  :parameter_group_name,
  :source,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Returns:

  • (String)


769
770
771
772
773
774
775
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 769

class DescribeParametersRequest < Struct.new(
  :parameter_group_name,
  :source,
  :max_results,
  :next_token)
  include Aws::Structure
end

#parameter_group_nameString

The name of the parameter group.

Returns:

  • (String)


769
770
771
772
773
774
775
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 769

class DescribeParametersRequest < Struct.new(
  :parameter_group_name,
  :source,
  :max_results,
  :next_token)
  include Aws::Structure
end

#sourceString

How the parameter is defined. For example, system denotes a system-defined parameter.

Returns:

  • (String)


769
770
771
772
773
774
775
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 769

class DescribeParametersRequest < Struct.new(
  :parameter_group_name,
  :source,
  :max_results,
  :next_token)
  include Aws::Structure
end