software.amazon.awscdk.services.lightsail

Interface CfnInstance.DiskProperty

All Known Implementing Classes:

CfnInstance.DiskProperty.Jsii$Proxy

Enclosing class:

CfnInstance

public static interface CfnInstance.DiskProperty

`Disk` is a property of the [Hardware](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-hardware.html) 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 software.amazon.awscdk.services.lightsail.*;
 DiskProperty diskProperty = DiskProperty.builder()
         .diskName("diskName")
         .path("path")
         // the properties below are optional
         .attachedTo("attachedTo")
         .attachmentState("attachmentState")
         .iops(123)
         .isSystemDisk(false)
         .sizeInGb("sizeInGb")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnInstance.DiskProperty.Builder A builder for CfnInstance.DiskProperty
static class	CfnInstance.DiskProperty.Jsii$Proxy An implementation for CfnInstance.DiskProperty

Method Summary

Modifier and Type	Method and Description
static CfnInstance.DiskProperty.Builder	builder()
default java.lang.String	getAttachedTo() The resources to which the disk is attached.
default java.lang.String	getAttachmentState() (Deprecated) The attachment state of the disk.
java.lang.String	getDiskName() The unique name of the disk.
default java.lang.Number	getIops() The input/output operations per second (IOPS) of the disk.
default java.lang.Object	getIsSystemDisk() A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
java.lang.String	getPath() The disk path.
default java.lang.String	getSizeInGb() The size of the disk in GB.

Method Detail

getDiskName

java.lang.String getDiskName()

The unique name of the disk.

getPath

java.lang.String getPath()

The disk path.

getAttachedTo

default java.lang.String getAttachedTo()

The resources to which the disk is attached.

getAttachmentState

default java.lang.String getAttachmentState()

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

getIops

default java.lang.Number getIops()

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

getIsSystemDisk

default java.lang.Object getIsSystemDisk()

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

getSizeInGb

default java.lang.String getSizeInGb()

The size of the disk in GB.

builder

static CfnInstance.DiskProperty.Builder builder()

Returns:

a CfnInstance.DiskProperty.Builder of CfnInstance.DiskProperty