Package software.amazon.awscdk.services.lightsail

Interface CfnInstance.DiskProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInstance.DiskProperty.Jsii$Proxy

Enclosing class:

CfnInstance

@Stability(Stable)
public static interface CfnInstance.DiskProperty
extends software.amazon.jsii.JsiiSerializable

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 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDiskName

@Stability(Stable)
@NotNull
String getDiskName()

The unique name of the disk.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-diskname

getPath

@Stability(Stable)
@NotNull
String getPath()

The disk path.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-path

getAttachedTo

@Stability(Stable)
@Nullable
default String getAttachedTo()

The resources to which the disk is attached.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-attachedto

getAttachmentState

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-attachmentstate

getIops

@Stability(Stable)
@Nullable
default Number getIops()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-iops

getIsSystemDisk

@Stability(Stable)
@Nullable
default Object getIsSystemDisk()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-issystemdisk

getSizeInGb

@Stability(Stable)
@Nullable
default String getSizeInGb()

The size of the disk in GB.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-disk.html#cfn-lightsail-instance-disk-sizeingb

builder

@Stability(Stable)
static CfnInstance.DiskProperty.Builder builder()

Returns:

a CfnInstance.DiskProperty.Builder of CfnInstance.DiskProperty