Skip to content

DescribeDBClusterParametersMessage

Source code in docs_src/capo_rds/types/describe_db_cluster_parameters_message.py 
15
16
17
18
19
20
21
22
23
24
25
class DescribeDBClusterParametersMessage(TypedDict, closed=True):
    db_cluster_parameter_group_name: NotRequired["capo_rds.types.string.String"]
    """<p>The name of a specific DB cluster parameter group to return parameter details for.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DBClusterParameterGroup.</p> </li> </ul>"""
    source: NotRequired["capo_rds.types.string.String"]
    """<p>A specific source to return parameters for.</p> <p>Valid Values:</p> <ul> <li> <p> <code>engine-default</code> </p> </li> <li> <p> <code>system</code> </p> </li> <li> <p> <code>user</code> </p> </li> </ul>"""
    filters: NotRequired["capo_rds.types.filter_list.FilterList"]
    """<p>A filter that specifies one or more DB cluster parameters to describe.</p> <p>The only supported filter is <code>parameter-name</code>. The results list only includes information about the DB cluster parameters with these names.</p>"""
    max_records: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"""
    marker: NotRequired["capo_rds.types.string.String"]
    """<p>An optional pagination token provided by a previous <code>DescribeDBClusterParameters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"""

db_cluster_parameter_group_name instance-attribute 

db_cluster_parameter_group_name: NotRequired[String]

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

Constraints:

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

filters instance-attribute 

filters: NotRequired[FilterList]

A filter that specifies one or more DB cluster parameters to describe.

The only supported filter is parameter-name. The results list only includes information about the DB cluster parameters with these names.

marker instance-attribute 

marker: NotRequired[String]

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

max_records instance-attribute 

max_records: NotRequired[IntegerOptional]

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

source instance-attribute 

source: NotRequired[String]

A specific source to return parameters for.

Valid Values:

  • engine-default

  • system

  • user