Get Relational Databases

lightsail_get_relational_databases

R Documentation

Returns information about all of your databases in Amazon Lightsail

Description

Returns information about all of your databases in Amazon Lightsail.

Usage

lightsail_get_relational_databases(pageToken)

Arguments

pageToken

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

To get a page token, perform an initial get_relational_databases 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(
  relationalDatabases = list(
    list(
      name = "string",
      arn = "string",
      supportCode = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      location = list(
        availabilityZone = "string",
        regionName = "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-central-1"|"ca-central-1"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|"eu-north-1"
      ),
      resourceType = "ContainerService"|"Instance"|"StaticIp"|"KeyPair"|"InstanceSnapshot"|"Domain"|"PeeredVpc"|"LoadBalancer"|"LoadBalancerTlsCertificate"|"Disk"|"DiskSnapshot"|"RelationalDatabase"|"RelationalDatabaseSnapshot"|"ExportSnapshotRecord"|"CloudFormationStackRecord"|"Alarm"|"ContactMethod"|"Distribution"|"Certificate"|"Bucket",
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      ),
      relationalDatabaseBlueprintId = "string",
      relationalDatabaseBundleId = "string",
      masterDatabaseName = "string",
      hardware = list(
        cpuCount = 123,
        diskSizeInGb = 123,
        ramSizeInGb = 123.0
      ),
      state = "string",
      secondaryAvailabilityZone = "string",
      backupRetentionEnabled = TRUE|FALSE,
      pendingModifiedValues = list(
        masterUserPassword = "string",
        engineVersion = "string",
        backupRetentionEnabled = TRUE|FALSE
      ),
      engine = "string",
      engineVersion = "string",
      latestRestorableTime = as.POSIXct(
        "2015-01-01"
      ),
      masterUsername = "string",
      parameterApplyStatus = "string",
      preferredBackupWindow = "string",
      preferredMaintenanceWindow = "string",
      publiclyAccessible = TRUE|FALSE,
      masterEndpoint = list(
        port = 123,
        address = "string"
      ),
      pendingMaintenanceActions = list(
        list(
          action = "string",
          description = "string",
          currentApplyDate = as.POSIXct(
            "2015-01-01"
          )
        )
      ),
      caCertificateIdentifier = "string"
    )
  ),
  nextPageToken = "string"
)

Request syntax

svc$get_relational_databases(
  pageToken = "string"
)