Describe Engine Default Parameters

rds_describe_engine_default_parameters

R Documentation

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

Description

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

Usage

rds_describe_engine_default_parameters(DBParameterGroupFamily, Filters,
  MaxRecords, Marker)

Arguments

DBParameterGroupFamily

[required] The name of the DB parameter group family.

Valid Values:

• aurora-mysql5.7

• aurora-mysql8.0

• aurora-postgresql10

• aurora-postgresql11

• aurora-postgresql12

• aurora-postgresql13

• aurora-postgresql14

• custom-oracle-ee-19

• custom-oracle-ee-cdb-19

• db2-ae

• db2-se

• mariadb10.2

• mariadb10.3

• mariadb10.4

• mariadb10.5

• mariadb10.6

• mysql5.7

• mysql8.0

• oracle-ee-19

• oracle-ee-cdb-19

• oracle-ee-cdb-21

• oracle-se2-19

• oracle-se2-cdb-19

• oracle-se2-cdb-21

• postgres10

• postgres11

• postgres12

• postgres13

• postgres14

• sqlserver-ee-11.0

• sqlserver-ee-12.0

• sqlserver-ee-13.0

• sqlserver-ee-14.0

• sqlserver-ee-15.0

• sqlserver-ex-11.0

• sqlserver-ex-12.0

• sqlserver-ex-13.0

• sqlserver-ex-14.0

• sqlserver-ex-15.0

• sqlserver-se-11.0

• sqlserver-se-12.0

• sqlserver-se-13.0

• sqlserver-se-14.0

• sqlserver-se-15.0

• sqlserver-web-11.0

• sqlserver-web-12.0

• sqlserver-web-13.0

• sqlserver-web-14.0

• sqlserver-web-15.0

Filters

A filter that specifies one or more parameters to describe.

The only supported filter is parameter-name. The results list only includes information about the 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_engine_default_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_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 engine.
svc$describe_engine_default_parameters(
  DBParameterGroupFamily = "mysql5.6"
)

## End(Not run)