interface DiskProperty

Language	Type name
.NET	Amazon.CDK.AWS.Lightsail.CfnInstance.DiskProperty
Java	software.amazon.awscdk.services.lightsail.CfnInstance.DiskProperty
Python	aws_cdk.aws_lightsail.CfnInstance.DiskProperty
TypeScript	@aws-cdk/aws-lightsail » CfnInstance » DiskProperty

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as lightsail from '@aws-cdk/aws-lightsail';
const diskProperty: lightsail.CfnInstance.DiskProperty = {
  diskName: 'diskName',
  path: 'path',

  // the properties below are optional
  attachedTo: 'attachedTo',
  attachmentState: 'attachmentState',
  iops: 123,
  isSystemDisk: false,
  sizeInGb: 'sizeInGb',
};

Properties

Name	Type	Description
diskName	string	The unique name of the disk.
path	string	The disk path.
attachedTo?	string	The resources to which the disk is attached.
attachmentState?	string	(Deprecated) The attachment state of the disk.
iops?	number	The input/output operations per second (IOPS) of the disk.
isSystemDisk?	boolean | IResolvable	A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
sizeInGb?	string	The size of the disk in GB.

---

diskName

Type: string

The unique name of the disk.

---

path

Type: string

The disk path.

---

attachedTo?

Type: string (optional)

The resources to which the disk is attached.

---

attachmentState?

Type: string (optional)

(Deprecated) The attachment state of the disk.

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.

---

iops?

Type: number (optional)

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

---

isSystemDisk?

Type: boolean | IResolvable (optional)

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

---

sizeInGb?

Type: string (optional)

The size of the disk in GB.