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:
-
db_cluster_parameter_group_name
(Optional[String], default:
None
)
–
The name of a specific DB cluster parameter group to return parameter details for.
Constraints:
-
source
(Optional[String], default:
None
)
–
A specific source to return parameters for.
Valid Values:
-
engine-default
-
system
-
user
-
filters
(Optional[FilterList], default:
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.
-
max_records
(Optional[IntegerOptional], default:
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.
-
marker
(Optional[String], default:
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.
Raises:
Examples:
To describe the parameters in a DB cluster parameter group
The following example retrieves details about the parameters in a DB cluster parameter group.
>>> client.describe_db_cluster_parameters(db_cluster_parameter_group_name='mydbclusterpg')
Source code in docs_src/capo_rds/_services/rds.py
| def describe_db_cluster_parameters(
self,
*,
config_overrides: Optional[RDSClientConfig] = None,
db_cluster_parameter_group_name: Optional[
"capo_rds.types.string.String"
] = None,
source: Optional["capo_rds.types.string.String"] = None,
filters: Optional["capo_rds.types.filter_list.FilterList"] = None,
max_records: Optional["capo_rds.types.integer_optional.IntegerOptional"] = None,
marker: Optional["capo_rds.types.string.String"] = None,
) -> "capo_rds.types.db_cluster_parameter_group_details.DBClusterParameterGroupDetails":
"""<p>Returns the detailed parameter list for a particular DB cluster parameter group.</p> <p>For more information on Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB cluster deployments</a> in the <i>Amazon RDS User Guide</i>.</p>
Args:
db_cluster_parameter_group_name: <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: <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: <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: <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: <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>
Raises:
capo_rds.errors.db_parameter_group_not_found_fault.DBParameterGroupNotFoundFault: <p> <code>DBParameterGroupName</code> doesn't refer to an existing DB parameter group.</p>
capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
To describe the parameters in a DB cluster parameter group
The following example retrieves details about the parameters in a DB cluster parameter group.
>>> client.describe_db_cluster_parameters(db_cluster_parameter_group_name='mydbclusterpg')
"""
def _handler(
req: "OperationRequest[capo_rds.types.describe_db_cluster_parameters_message.DescribeDBClusterParametersMessage]",
) -> OperationResponse[
"capo_rds.types.db_cluster_parameter_group_details.DBClusterParameterGroupDetails"
]:
import capo_rds._operations.amazon_rd_sv19.describe_db_cluster_parameters
output, http_response = (
capo_rds._operations.amazon_rd_sv19.describe_db_cluster_parameters.describe_db_cluster_parameters(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeDBClusterParameters")
)
input_: capo_rds.types.describe_db_cluster_parameters_message.DescribeDBClusterParametersMessage = {}
if db_cluster_parameter_group_name is not None:
input_["db_cluster_parameter_group_name"] = db_cluster_parameter_group_name
if source is not None:
input_["source"] = source
if filters is not None:
input_["filters"] = filters
if max_records is not None:
input_["max_records"] = max_records
if marker is not None:
input_["marker"] = marker
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|