Menu
Amazon Relational Database Service
API Reference (API Version 2014-10-31)

DescribeDBClusterParameters

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBClusterParameterGroupName

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

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Type: String

Required: Yes

Filters.Filter.N

This parameter is not currently supported.

Type: array of Filter objects

Required: No

Marker

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.

Type: String

Required: No

MaxRecords

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 that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer

Required: No

Source

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

Type: String

Required: No

Response Elements

The following elements are returned by the service.

Marker

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 .

Type: String

Parameters.Parameter.N

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

Type: array of Parameter objects

Errors

For information about the errors that are common to all actions, see Common Errors.

DBParameterGroupNotFound

DBParameterGroupName does not refer to an existing DB parameter group.

HTTP Status Code: 404

Example

Sample Request

Copy
https://rds.us-west-2.amazonaws.com/ ?Action=DescribeDBClusterParameters &DBClusterParameterGroupName=default.aurora5.6 &SignatureMethod=HmacSHA256 &SignatureVersion=4 &Version=2014-10-31 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20151231/us-west-2/rds/aws4_request &X-Amz-Date=20151231T225813Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=cf8b9ab9c4a36bbb5f5043209b1985784a226d132ed61a5c35163c40506e83f7

Sample Response

Copy
<DescribeDBClusterParametersResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/"> <DescribeDBClusterParametersResult> <Parameters> <Parameter> <ApplyMethod>pending-reboot</ApplyMethod> <DataType>integer</DataType> <Source>engine-default</Source> <IsModifiable>true</IsModifiable> <Description>Intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns</Description> <ApplyType>dynamic</ApplyType> <AllowedValues>1-65535</AllowedValues> <ParameterName>auto_increment_increment</ParameterName> </Parameter> <Parameter> <ApplyMethod>pending-reboot</ApplyMethod> <DataType>integer</DataType> <Source>engine-default</Source> <IsModifiable>true</IsModifiable> <Description>Determines the starting point for the AUTO_INCREMENT column value</Description> <ApplyType>dynamic</ApplyType> <AllowedValues>1-65535</AllowedValues> <ParameterName>auto_increment_offset</ParameterName> </Parameter> <Parameter> <ApplyMethod>pending-reboot</ApplyMethod> <DataType>string</DataType> <Source>engine-default</Source> <IsModifiable>true</IsModifiable> <Description>When enabled, this variable causes the master to write a checksum for each event in the binary log.</Description> <ApplyType>dynamic</ApplyType> <AllowedValues>NONE,CRC32</AllowedValues> <ParameterName>binlog_checksum</ParameterName> </Parameter> <Parameter> <ParameterValue>OFF</ParameterValue> <ApplyMethod>pending-reboot</ApplyMethod> <DataType>string</DataType> <Source>system</Source> <IsModifiable>true</IsModifiable> <Description>Binary logging format for replication</Description> <ApplyType>dynamic</ApplyType> <AllowedValues>ROW,STATEMENT,MIXED,OFF</AllowedValues> <ParameterName>binlog_format</ParameterName> </Parameter> <Parameter> <ApplyMethod>pending-reboot</ApplyMethod> <DataType>string</DataType> <Source>engine-default</Source> <IsModifiable>false</IsModifiable> <Description>Whether the server logs full or minimal rows with row-based replication.</Description> <ApplyType>dynamic</ApplyType> <AllowedValues>full,minimal,noblob</AllowedValues> <ParameterName>binlog_row_image</ParameterName> </Parameter> </Parameters> </DescribeDBClusterParametersResult> <ResponseMetadata> <RequestId>c4e42d91-cb92-11e5-895a-99e063757579</RequestId> </ResponseMetadata> </DescribeDBClusterParametersResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: