AWS::Lightsail::Instance Disk - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Lightsail::Instance Disk

Disk is a property of the Hardware property. It describes a disk attached to an instance.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "AttachedTo" : String,
  "AttachmentState" : String,
  "DiskName" : String,
  "IOPS" : Integer,
  "IsSystemDisk" : Boolean,
  "Path" : String,
  "SizeInGb" : String
}

YAML

  AttachedTo: String
  AttachmentState: String
  DiskName: String
  IOPS: Integer
  IsSystemDisk: Boolean
  Path: String
  SizeInGb: String

Properties

AttachedTo

The resources to which the disk is attached.

Required: No

Type: String

Update requires: Updates are not supported.

AttachmentState

(Deprecated) The attachment state of the disk.

Note

In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.

Required: No

Type: String

Update requires: Updates are not supported.

DiskName

The unique name of the disk.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][\w\-.]*[a-zA-Z0-9]$

Minimum: 1

Maximum: 254

Update requires: No interruption

IOPS

The input/output operations per second (IOPS) of the disk.

Required: No

Type: Integer

Update requires: Updates are not supported.

IsSystemDisk

A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

Required: No

Type: Boolean

Update requires: Updates are not supported.

Path

The disk path.

Required: Yes

Type: String

Update requires: Updates are not supported.

SizeInGb

The size of the disk in GB.

Required: No

Type: String

Update requires: Updates are not supported.