AWS::Lightsail::DatabaseSnapshot

Lightsail DatabaseSnapshot

Resource Type definition for AWS::Lightsail::DatabaseSnapshot

Properties

3 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`RelationalDatabaseName`	`string`	RequiredCreate-only
`RelationalDatabaseSnapshotName`	`string`	RequiredCreate-only
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	The Amazon Resource Name (ARN) of the database snapshot.
`CreatedAt`	`string`	The timestamp when the database snapshot was created.
`Engine`	`string`	The software of the database snapshot (for example, MySQL).
`EngineVersion`	`string`	The database engine version for the database snapshot (for example, 5.7.23).
`FromRelationalDatabaseArn`	`string`	The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
`FromRelationalDatabaseBlueprintId`	`string`	The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
`FromRelationalDatabaseBundleId`	`string`	The bundle ID of the database from which the database snapshot was created.
`FromRelationalDatabaseName`	`string`	The name of the source database from which the database snapshot was created.
`Location`	`object`	The Region name and Availability Zone where the database snapshot is located.
`Name`	`string`	The name of the database snapshot.
`ResourceType`	`string`	The Lightsail resource type.
`SizeInGb`	`integer`	The size of the disk in GB (for example, 32) for the database snapshot.
`State`	`string`	The state of the database snapshot.
`SupportCode`	`string`	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.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Lightsail::DatabaseSnapshot

Resources:
  MyResource:
    Type: AWS::Lightsail::DatabaseSnapshot
    Properties:
      RelationalDatabaseSnapshotName: "my-relationaldatabasesnapshotname"
      RelationalDatabaseName: "my-relationaldatabasename"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

lightsail:CreateRelationalDatabaseSnapshotlightsail:GetRelationalDatabaseSnapshotlightsail:TagResource

read

lightsail:GetRelationalDatabaseSnapshot

update

lightsail:GetRelationalDatabaseSnapshotlightsail:TagResourcelightsail:UntagResource

delete

lightsail:DeleteRelationalDatabaseSnapshotlightsail:GetRelationalDatabaseSnapshot

list

lightsail:GetRelationalDatabaseSnapshots

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceLightsail

Properties17

Required2

TaggingSupported

Primary IDRelationalDatabaseSnapshotName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

RelationalDatabaseSnapshotNameRelationalDatabaseName

Related Resources

External Links

AWS Documentation