Skip to content

Get Relational Database Parameters

lightsail_get_relational_database_parameters R Documentation

Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail

Description

Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.

In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.

Usage

lightsail_get_relational_database_parameters(relationalDatabaseName,
  pageToken)

Arguments

relationalDatabaseName

[required] The name of your database for which to get parameters.

pageToken

The token to advance to the next page of results from your request.

To get a page token, perform an initial get_relational_database_parameters request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Value

A list with the following syntax: 

list(
  parameters = list(
    list(
      allowedValues = "string",
      applyMethod = "string",
      applyType = "string",
      dataType = "string",
      description = "string",
      isModifiable = TRUE|FALSE,
      parameterName = "string",
      parameterValue = "string"
    )
  ),
  nextPageToken = "string"
)

Request syntax

svc$get_relational_database_parameters(
  relationalDatabaseName = "string",
  pageToken = "string"
)