AWS::Lightsail::Database

Lightsail Database

Resource Type definition for AWS::Lightsail::Database

Properties

15 configurable properties. 5 required. Click a row to see details.

Filter:

Property	Type	Flags
`MasterDatabaseName`	`string`	RequiredCreate-only
`MasterUsername`	`string`	RequiredCreate-only
`RelationalDatabaseBlueprintId`	`string`	RequiredCreate-only
`RelationalDatabaseBundleId`	`string`	RequiredCreate-only
`RelationalDatabaseName`	`string`	RequiredCreate-only
`AvailabilityZone`	`string`	Create-only
`BackupRetention`	`boolean`
`CaCertificateIdentifier`	`string`
`MasterUserPassword`	`string`	Write-only
`PreferredBackupWindow`	`string`
`PreferredMaintenanceWindow`	`string`
`PubliclyAccessible`	`boolean`
`RelationalDatabaseParameters`	`Array<RelationalDatabaseParameter>`	Write-only
`RotateMasterUserPassword`	`boolean`	Write-only
`Tags`	`Array<Tag>`

Return Values

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

Attribute	Type	Description
`DatabaseArn`	`string`	-

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::Database

Resources:
  MyResource:
    Type: AWS::Lightsail::Database
    Properties:
      RelationalDatabaseName: "my-relationaldatabasename"
      RelationalDatabaseBlueprintId: "my-relationaldatabaseblueprintid"
      RelationalDatabaseBundleId: "my-relationaldatabasebundleid"
      MasterDatabaseName: "my-masterdatabasename"
      MasterUsername: "my-masterusername"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

lightsail:CreateRelationalDatabaselightsail:GetRelationalDatabaselightsail:GetRelationalDatabaseslightsail:GetRegionslightsail:TagResourcelightsail:UntagResourcelightsail:UpdateRelationalDatabaselightsail:UpdateRelationalDatabaseParameters

read

lightsail:GetRelationalDatabaselightsail:GetRelationalDatabases

update

lightsail:GetRelationalDatabaselightsail:GetRelationalDatabaseslightsail:TagResourcelightsail:UntagResourcelightsail:UpdateRelationalDatabaselightsail:UpdateRelationalDatabaseParameters

delete

lightsail:DeleteRelationalDatabaselightsail:GetRelationalDatabaselightsail:GetRelationalDatabases

list

lightsail:GetRelationalDatabases

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

Properties16

Required5

TaggingSupported

Primary IDRelationalDatabaseName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

RelationalDatabaseNameAvailabilityZoneRelationalDatabaseBlueprintIdRelationalDatabaseBundleIdMasterDatabaseNameMasterUsername

Related Resources

External Links

AWS Documentation