Skip to content

Describe Db Cluster Parameters

rds_describe_db_cluster_parameters R Documentation

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

Description

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.

Usage

rds_describe_db_cluster_parameters(DBClusterParameterGroupName, Source,
  Filters, MaxRecords, Marker)

Arguments

DBClusterParameterGroupName

[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

A specific source to return parameters for.

Valid Values:

  • engine-default

  • system

  • user
Filters

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.
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.
Marker

An optional pagination token provided by a previous describe_db_cluster_parameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Value

A list with the following syntax:

list(
  Parameters = list(
    list(
      ParameterName = "string",
      ParameterValue = "string",
      Description = "string",
      Source = "string",
      ApplyType = "string",
      DataType = "string",
      AllowedValues = "string",
      IsModifiable = TRUE|FALSE,
      MinimumEngineVersion = "string",
      ApplyMethod = "immediate"|"pending-reboot",
      SupportedEngineModes = list(
        "string"
      )
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_db_cluster_parameters(
  DBClusterParameterGroupName = "string",
  Source = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)

Examples

## Not run: 
# This example lists system parameters for the specified DB cluster
# parameter group.
svc$describe_db_cluster_parameters(
  DBClusterParameterGroupName = "mydbclusterparametergroup",
  Source = "system"
)

## End(Not run)