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

Class: Aws::DocDB::Types::DescribeDBClusterParametersMessage

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

Overview

Note:

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

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

Represents the input to DescribeDBClusterParameters.

Instance Attribute Summary collapse

Instance Attribute Details

#db_cluster_parameter_group_nameString

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

Constraints:

  • If provided, must match the name of an existing DBClusterParameterGroup.

^

Returns:

  • (String)


2269
2270
2271
2272
2273
2274
2275
2276
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2269

class DescribeDBClusterParametersMessage < Struct.new(
  :db_cluster_parameter_group_name,
  :source,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#filtersArray<Types::Filter>

This parameter is not currently supported.

Returns:



2269
2270
2271
2272
2273
2274
2275
2276
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2269

class DescribeDBClusterParametersMessage < Struct.new(
  :db_cluster_parameter_group_name,
  :source,
  :filters,
  :max_records,
  :marker)
  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)


2269
2270
2271
2272
2273
2274
2275
2276
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2269

class DescribeDBClusterParametersMessage < Struct.new(
  :db_cluster_parameter_group_name,
  :source,
  :filters,
  :max_records,
  :marker)
  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)


2269
2270
2271
2272
2273
2274
2275
2276
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2269

class DescribeDBClusterParametersMessage < Struct.new(
  :db_cluster_parameter_group_name,
  :source,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#sourceString

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

Returns:

  • (String)


2269
2270
2271
2272
2273
2274
2275
2276
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2269

class DescribeDBClusterParametersMessage < Struct.new(
  :db_cluster_parameter_group_name,
  :source,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end