Request Parameters Response Elements Errors Examples See Also

DescribeDBClusterParameters

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.

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:

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

Type: String

Required: Yes

Filters.Filter.N

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.

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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer

Required: No

Source

A specific source to return parameters for.

Valid Values:

engine-default
system
user

Type: String

Required: No

Response Elements

The following elements are returned by the service.

Marker

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 Error Types.

DBParameterGroupNotFound

DBParameterGroupName doesn't refer to an existing DB parameter group.

HTTP Status Code: 404

Examples

Example

This example illustrates one usage of DescribeDBClusterParameters.

Sample Request



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




  
    
      
        pending-reboot
        integer
        engine-default
        true
        Intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns
        dynamic
        1-65535
        auto_increment_increment
      
      
        pending-reboot
        integer
        engine-default
        true
        Determines the starting point for the AUTO_INCREMENT column value
        dynamic
        1-65535
        auto_increment_offset
      
      
        pending-reboot
        string
        engine-default
        true
        When enabled, this variable causes the master to write a checksum for each event in the binary log.
        dynamic
        NONE,CRC32
        binlog_checksum
      
      
        OFF
        pending-reboot
        string
        system
        true
        Binary logging format for replication
        dynamic
        ROW,STATEMENT,MIXED,OFF
        binlog_format
      
      
        pending-reboot
        string
        engine-default
        false
        Whether the server logs full or minimal rows with row-based replication.
        dynamic
        full,minimal,noblob
        binlog_row_image
      
    
  
  
    c4e42d91-cb92-11e5-895a-99e063757579