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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

RelationalDatabaseSnapshot

Describes a database snapshot.

Contents

arn

The Amazon Resource Name (ARN) of the database snapshot.

Type: String

Pattern: .*\S.*

Required: No

createdAt

The timestamp when the database snapshot was created.

Type: Timestamp

Required: No

engine

The software of the database snapshot (for example, MySQL)

Type: String

Pattern: .*\S.*

Required: No

engineVersion

The database engine version for the database snapshot (for example, 5.7.23).

Type: String

Pattern: .*\S.*

Required: No

fromRelationalDatabaseArn

The Amazon Resource Name (ARN) of the database from which the database snapshot was created.

Type: String

Pattern: .*\S.*

Required: No

fromRelationalDatabaseBlueprintId

The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.

Type: String

Required: No

fromRelationalDatabaseBundleId

The bundle ID of the database from which the database snapshot was created.

Type: String

Required: No

fromRelationalDatabaseName

The name of the source database from which the database snapshot was created.

Type: String

Pattern: .*\S.*

Required: No

location

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

Type: ResourceLocation object

Required: No

name

The name of the database snapshot.

Type: String

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

Required: No

resourceType

The Lightsail resource type.

Type: String

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

Required: No

sizeInGb

The size of the disk in GB (for example, 32) for the database snapshot.

Type: Integer

Required: No

state

The state of the database snapshot.

Type: String

Pattern: .*\S.*

Required: No

supportCode

The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot 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: