interface CfnDiskProps

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

Properties for defining a CfnDisk.

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 cfnDiskProps: lightsail.CfnDiskProps = {
  diskName: 'diskName',
  sizeInGb: 123,

  // the properties below are optional
  addOns: [{
    addOnType: 'addOnType',

    // the properties below are optional
    autoSnapshotAddOnRequest: {
      snapshotTimeOfDay: 'snapshotTimeOfDay',
    },
    status: 'status',
  }],
  availabilityZone: 'availabilityZone',
  location: {
    availabilityZone: 'availabilityZone',
    regionName: 'regionName',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
diskName	string	The name of the disk.
sizeInGb	number	The size of the disk in GB.
addOns?	IResolvable | IResolvable | AddOnProperty[]	An array of add-ons for the disk.
availabilityZone?	string	The AWS Region and Availability Zone location for the disk (for example, us-east-1a ).
location?	IResolvable | LocationProperty	AWS::Lightsail::Disk.Location.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.

---

diskName

Type: string

The name of the disk.

---

sizeInGb

Type: number

The size of the disk in GB.

---

addOns?

Type: IResolvable | IResolvable | AddOnProperty[] (optional)

An array of add-ons for the disk.

If the disk has an add-on enabled when performing a delete disk request, the add-on is automatically disabled before the disk is deleted.

---

availabilityZone?

Type: string (optional)

The AWS Region and Availability Zone location for the disk (for example, us-east-1a ).

---

location?

Type: IResolvable | LocationProperty (optional)

AWS::Lightsail::Disk.Location.

---

tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this resource.

For more information, see Tag in the AWS CloudFormation User Guide .

The Value of Tags is optional for Lightsail resources.