AWS::Lightsail::Disk

Lightsail Disk

Resource Type definition for AWS::Lightsail::Disk

Properties

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

Filter:

Property	Type	Flags
`DiskName`	`string`	RequiredCreate-only
`SizeInGb`	`integer`	RequiredCreate-only
`AddOns`	`Array<AddOn>`
`AvailabilityZone`	`string`	Create-only
`Location`	`Location`
`Tags`	`Array<Tag>`

Return Values

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

Attribute	Type	Description
`AttachedTo`	`string`	Name of the attached Lightsail Instance
`AttachmentState`	`string`	Attachment State of the Lightsail disk
`DiskArn`	`string`	-
`Iops`	`integer`	Iops of the Lightsail disk
`IsAttached`	`boolean`	Check is Disk is attached state
`Path`	`string`	Path of the attached Disk
`ResourceType`	`string`	Resource type of Lightsail instance.
`State`	`string`	State of the Lightsail disk
`SupportCode`	`string`	Support code to help identify any issues

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

Resources:
  MyResource:
    Type: AWS::Lightsail::Disk
    Properties:
      DiskName: "my-diskname"
      SizeInGb: 1
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

lightsail:CreateDisklightsail:EnableAddOnlightsail:DisableAddOnlightsail:GetDisklightsail:GetDiskslightsail:GetRegionslightsail:TagResourcelightsail:UntagResource

read

lightsail:GetDisklightsail:GetDisks

delete

lightsail:GetDisklightsail:GetDiskslightsail:DeleteDisk

list

lightsail:GetDisks

update

lightsail:GetDisklightsail:GetDiskslightsail:EnableAddOnlightsail:DisableAddOnlightsail:TagResourcelightsail:UntagResource

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

Properties15

Required2

TaggingSupported

Primary IDDiskName

Supported Operations

CreateReadDeleteListUpdate

Immutable After Creation

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

DiskNameAvailabilityZoneSizeInGb

Related Resources

External Links

AWS Documentation