Amazon Lightsail
API Reference (API Version 2016-11-28)

RelationalDatabase

Describes a database.

Contents

arn

The Amazon Resource Name (ARN) of the database.

Type: String

Pattern: .*\S.*

Required: No

backupRetentionEnabled

A Boolean value indicating whether automated backup retention is enabled for the database.

Type: Boolean

Required: No

createdAt

The timestamp when the database was created. Formatted in Unix time.

Type: Timestamp

Required: No

engine

The database software (for example, MySQL).

Type: String

Pattern: .*\S.*

Required: No

engineVersion

The database engine version (for example, 5.7.23).

Type: String

Pattern: .*\S.*

Required: No

hardware

Describes the hardware of the database.

Type: RelationalDatabaseHardware object

Required: No

latestRestorableTime

The latest point in time to which the database can be restored. Formatted in Unix time.

Type: Timestamp

Required: No

location

The Region name and Availability Zone where the database is located.

Type: ResourceLocation object

Required: No

masterDatabaseName

The name of the master database created when the Lightsail database resource is created.

Type: String

Required: No

masterEndpoint

The master endpoint for the database.

Type: RelationalDatabaseEndpoint object

Required: No

masterUsername

The master user name of the database.

Type: String

Pattern: .*\S.*

Required: No

name

The unique name of the database resource in Lightsail.

Type: String

Pattern: \w[\w\-]*\w

Required: No

parameterApplyStatus

The status of parameter updates for the database.

Type: String

Pattern: .*\S.*

Required: No

pendingMaintenanceActions

Describes the pending maintenance actions for the database.

Type: Array of PendingMaintenanceAction objects

Required: No

pendingModifiedValues

Describes pending database value modifications.

Type: PendingModifiedRelationalDatabaseValues object

Required: No

preferredBackupWindow

The daily time range during which automated backups are created for the database (for example, 16:00-16:30).

Type: String

Pattern: .*\S.*

Required: No

preferredMaintenanceWindow

The weekly time range during which system maintenance can occur on the database.

In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30.

Type: String

Pattern: .*\S.*

Required: No

publiclyAccessible

A Boolean value indicating whether the database is publicly accessible.

Type: Boolean

Required: No

relationalDatabaseBlueprintId

The blueprint ID for the database. A blueprint describes the major engine version of a database.

Type: String

Pattern: .*\S.*

Required: No

relationalDatabaseBundleId

The bundle ID for the database. A bundle describes the performance specifications for your database.

Type: String

Pattern: .*\S.*

Required: No

resourceType

The Lightsail resource type for the database (for example, RelationalDatabase).

Type: String

Valid Values: Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord

Required: No

secondaryAvailabilityZone

Describes the secondary Availability Zone of a high availability database.

The secondary database is used for failover support of a high availability database.

Type: String

Required: No

state

Describes the current state of the database.

Type: String

Pattern: .*\S.*

Required: No

supportCode

The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.

Type: String

Required: No

tags

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

Type: Array of Tag objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: