Disk

import type { Disk } from "https://aws-api.deno.dev/v0.3/services/lightsail.ts?docs=full";

Describes a block storage disk.

interface Disk {

addOns?: AddOn[] | null;

arn?: string | null;

attachedTo?: string | null;

attachmentState?: string | null;

createdAt?: Date | number | null;

gbInUse?: number | null;

iops?: number | null;

isAttached?: boolean | null;

isSystemDisk?: boolean | null;

location?: ResourceLocation | null;

name?: string | null;

path?: string | null;

resourceType?: ResourceType | null;

sizeInGb?: number | null;

state?: DiskState | null;

supportCode?: string | null;

tags?: Tag[] | null;

}

§Properties

addOns?: AddOn[] | null

[src]

An array of objects representing the add-ons enabled on the disk.

arn?: string | null

[src]

The Amazon Resource Name (ARN) of the disk.

attachedTo?: string | null

[src]

The resources to which the disk is attached.

attachmentState?: string | null

[src]

(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.

createdAt?: Date | number | null

[src]

The date when the disk was created.

gbInUse?: number | null

[src]

(Deprecated) The number of GB in use by the disk.

Note: In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.

iops?: number | null

[src]

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

isAttached?: boolean | null

[src]

A Boolean value indicating whether the disk is attached.

isSystemDisk?: boolean | null

[src]

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

location?: ResourceLocation | null

[src]

The AWS Region and Availability Zone where the disk is located.

name?: string | null

[src]

The unique name of the disk.

path?: string | null

[src]

The disk path.

resourceType?: ResourceType | null

[src]

The Lightsail resource type (e.g., Disk).

sizeInGb?: number | null

[src]

The size of the disk in GB.

state?: DiskState | null

[src]

Describes the status of the disk.

supportCode?: string | null

[src]

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

tags?: Tag[] | null

[src]

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.