Describe Engine Default Cluster Parameters

rds_describe_engine_default_cluster_parameters

R Documentation

Returns the default engine and system parameter information for the cluster database engine

Description

Returns the default engine and system parameter information for the cluster database engine.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

Usage

rds_describe_engine_default_cluster_parameters(DBParameterGroupFamily,
  Filters, MaxRecords, Marker)

Arguments

DBParameterGroupFamily	[required] The name of the DB cluster parameter group family to return engine parameter information for.
Filters	This parameter isn't currently supported.
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_engine_default_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(
  EngineDefaults = list(
    DBParameterGroupFamily = "string",
    Marker = "string",
    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"
        )
      )
    )
  )
)

Request syntax

svc$describe_engine_default_cluster_parameters(
  DBParameterGroupFamily = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)

Examples

## Not run: 
# This example lists default parameters for the specified DB cluster
# engine.
svc$describe_engine_default_cluster_parameters(
  DBParameterGroupFamily = "aurora5.6"
)

## End(Not run)