Class: Aws::DocDB::Types::DescribeEngineDefaultClusterParametersMessage

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

Overview

Note:

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

{
  db_parameter_group_family: "String", # required
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
}

Represents the input to DescribeEngineDefaultClusterParameters.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#db_parameter_group_familyString

The name of the cluster parameter group family to return the engine parameter information for.

Returns:

  • (String)


3356
3357
3358
3359
3360
3361
3362
3363
# File 'lib/aws-sdk-docdb/types.rb', line 3356

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

#filtersArray<Types::Filter>

This parameter is not currently supported.

Returns:



3356
3357
3358
3359
3360
3361
3362
3363
# File 'lib/aws-sdk-docdb/types.rb', line 3356

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

#markerString

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.

Returns:

  • (String)


3356
3357
3358
3359
3360
3361
3362
3363
# File 'lib/aws-sdk-docdb/types.rb', line 3356

class DescribeEngineDefaultClusterParametersMessage < Struct.new(
  :db_parameter_group_family,
  :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 pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer)


3356
3357
3358
3359
3360
3361
3362
3363
# File 'lib/aws-sdk-docdb/types.rb', line 3356

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