Skip to content

RDS  >  Operations  >  describe_db_cluster_parameters

describe_db_cluster_parameters

Operation

describe_db_cluster_parameters async

describe_db_cluster_parameters(request: DescribeDBClusterParametersInput | DescribeDBClusterParametersInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDBClusterParametersOutput
describe_db_cluster_parameters(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBClusterParametersInputDict]) -> DescribeDBClusterParametersOutput

Returns the detailed parameter list for a particular DB cluster parameter group.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeDBClusterParametersOutput

An instance of DescribeDBClusterParametersOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeDBClusterParametersInput dataclass

Bases: _SerdeShape

Attributes
db_cluster_parameter_group_name class-attribute instance-attribute
db_cluster_parameter_group_name: str | None = ...

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 class-attribute instance-attribute
filters: list[Filter] | None = ...

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 class-attribute instance-attribute
marker: str | None = ...

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 class-attribute instance-attribute
max_records: int | None = ...

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 class-attribute instance-attribute
source: str | None = ...

A specific source to return parameters for.

Valid Values:

  • engine-default

  • system

  • user

Dictionaries

DescribeDBClusterParametersInputDict

Bases: TypedDict

Dictionary form of DescribeDBClusterParametersInput.

Attributes
db_cluster_parameter_group_name instance-attribute
db_cluster_parameter_group_name: Required[str]

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: Sequence[Filter | FilterDict] | None

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: str | None

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: int | None

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: str | None

A specific source to return parameters for.

Valid Values:

  • engine-default

  • system

  • user

Output

DescribeDBClusterParametersOutput dataclass

Bases: _SerdeShape

Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

Attributes

marker class-attribute instance-attribute
marker: str | None = ...

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.

parameters class-attribute instance-attribute
parameters: list[Parameter] | None = ...

Provides a list of parameters for the DB cluster parameter group.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.