RDS / Client / describe_db_cluster_parameters
describe_db_cluster_parameters#
- RDS.Client.describe_db_cluster_parameters(**kwargs)#
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.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_cluster_parameters( DBClusterParameterGroupName='string', Source='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string' )
- Parameters:
DBClusterParameterGroupName (string) –
[REQUIRED]
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.
Source (string) –
A specific source to return parameters for.
Valid Values:
customer
engine
service
Filters (list) –
This parameter isn’t currently supported.
(dict) –
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribeDBRecommendations
DescribePendingMaintenanceActions
Name (string) – [REQUIRED]
The name of the filter. Filter names are case-sensitive.
Values (list) – [REQUIRED]
One or more filter values. Filter values are case-sensitive.
(string) –
MaxRecords (integer) –
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 (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 byMaxRecords
.
- Return type:
dict
- Returns:
Response Syntax
{ 'Parameters': [ { 'ParameterName': 'string', 'ParameterValue': 'string', 'Description': 'string', 'Source': 'string', 'ApplyType': 'string', 'DataType': 'string', 'AllowedValues': 'string', 'IsModifiable': True|False, 'MinimumEngineVersion': 'string', 'ApplyMethod': 'immediate'|'pending-reboot', 'SupportedEngineModes': [ 'string', ] }, ], 'Marker': 'string' }
Response Structure
(dict) –
Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.
Parameters (list) –
Provides a list of parameters for the DB cluster parameter group.
(dict) –
This data type is used as a request parameter in the
ModifyDBParameterGroup
andResetDBParameterGroup
actions.This data type is used as a response element in the
DescribeEngineDefaultParameters
andDescribeDBParameters
actions.ParameterName (string) –
The name of the parameter.
ParameterValue (string) –
The value of the parameter.
Description (string) –
Provides a description of the parameter.
Source (string) –
The source of the parameter value.
ApplyType (string) –
Specifies the engine specific parameters type.
DataType (string) –
Specifies the valid data type for the parameter.
AllowedValues (string) –
Specifies the valid range of values for the parameter.
IsModifiable (boolean) –
Indicates whether (
true
) or not (false
) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.MinimumEngineVersion (string) –
The earliest engine version to which the parameter can apply.
ApplyMethod (string) –
Indicates when to apply parameter updates.
SupportedEngineModes (list) –
The valid DB engine modes.
(string) –
Marker (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 byMaxRecords
.
Exceptions
RDS.Client.exceptions.DBParameterGroupNotFoundFault
Examples
This example lists system parameters for the specified DB cluster parameter group.
response = client.describe_db_cluster_parameters( DBClusterParameterGroupName='mydbclusterparametergroup', Source='system', ) print(response)
Expected Output:
{ 'ResponseMetadata': { '...': '...', }, }