Class: Aws::Redshift::Types::DescribeClusterParametersMessage

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-redshift/types.rb

Overview

Note:

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

{
  parameter_group_name: "String", # required
  source: "String",
  max_records: 1,
  marker: "String",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#marker ⇒ String

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in ‘MaxRecords`, AWS returns a value in the `Marker` field of the response. You can retrieve the next set of response records by providing the returned marker value in the `Marker` parameter and retrying the request.

Returns:

  • (String) 


3014
3015
3016
3017
3018
3019
3020
 
# File 'lib/aws-sdk-redshift/types.rb', line 3014

class DescribeClusterParametersMessage < Struct.new(
  :parameter_group_name,
  :source,
  :max_records,
  :marker)
  include Aws::Structure
end

#max_records ⇒ Integer

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified ‘MaxRecords` value, a value is returned in a `marker` field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: ‘100`

Constraints: minimum 20, maximum 100.

Returns:

  • (Integer) 


3014
3015
3016
3017
3018
3019
3020
 
# File 'lib/aws-sdk-redshift/types.rb', line 3014

class DescribeClusterParametersMessage < Struct.new(
  :parameter_group_name,
  :source,
  :max_records,
  :marker)
  include Aws::Structure
end

#parameter_group_name ⇒ String

The name of a cluster parameter group for which to return details.

Returns:

  • (String) 


3014
3015
3016
3017
3018
3019
3020
 
# File 'lib/aws-sdk-redshift/types.rb', line 3014

class DescribeClusterParametersMessage < Struct.new(
  :parameter_group_name,
  :source,
  :max_records,
  :marker)
  include Aws::Structure
end

#source ⇒ String

The parameter types to return. Specify ‘user` to show parameters that are different form the default. Similarly, specify `engine-default` to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: ‘user` | `engine-default`

Returns:

  • (String) 


3014
3015
3016
3017
3018
3019
3020
 
# File 'lib/aws-sdk-redshift/types.rb', line 3014

class DescribeClusterParametersMessage < Struct.new(
  :parameter_group_name,
  :source,
  :max_records,
  :marker)
  include Aws::Structure
end