interface DiskProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.Lightsail.Mixins.CfnInstancePropsMixin.DiskProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awslightsail/mixins#CfnInstancePropsMixin_DiskProperty`
Java	`software.amazon.awscdk.mixins.preview.services.lightsail.mixins.CfnInstancePropsMixin.DiskProperty`
Python	`aws_cdk.mixins_preview.aws_lightsail.mixins.CfnInstancePropsMixin.DiskProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_lightsail` » `mixins` » `CfnInstancePropsMixin` » `DiskProperty`

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as lightsail_mixins } from '@aws-cdk/mixins-preview/aws-lightsail';
const diskProperty: lightsail_mixins.CfnInstancePropsMixin.DiskProperty = {
  attachedTo: 'attachedTo',
  attachmentState: 'attachmentState',
  diskName: 'diskName',
  iops: 123,
  isSystemDisk: false,
  path: 'path',
  sizeInGb: 'sizeInGb',
};

Properties

Name	Type	Description
attachedTo?	`string`	The resources to which the disk is attached.
attachmentState?	`string`	(Deprecated) The attachment state of the disk.
diskName?	`string`	The unique name 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).
path?	`string`	The disk path.
sizeInGb?	`string`	The size of the disk in GB.

attachedTo?

Type: string (optional)

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

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.

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