Package software.amazon.awscdk.cfnpropertymixins.services.lightsail

Interface CfnDiskMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDiskMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:01.096Z")
@Stability(Stable)
public interface CfnDiskMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnDiskPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.lightsail.*;
 CfnDiskMixinProps cfnDiskMixinProps = CfnDiskMixinProps.builder()
         .addOns(List.of(AddOnProperty.builder()
                 .addOnType("addOnType")
                 .autoSnapshotAddOnRequest(AutoSnapshotAddOnProperty.builder()
                         .snapshotTimeOfDay("snapshotTimeOfDay")
                         .build())
                 .status("status")
                 .build()))
         .availabilityZone("availabilityZone")
         .diskName("diskName")
         .location(LocationProperty.builder()
                 .availabilityZone("availabilityZone")
                 .regionName("regionName")
                 .build())
         .sizeInGb(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDiskMixinProps.Builder	builder()
default Object	getAddOns()	An array of add-ons for the disk.
default String	getAvailabilityZone()	The AWS Region and Availability Zone location for the disk (for example, us-east-1a ).
default String	getDiskName()	The name of the disk.
default Object	getLocation()	The AWS Region and Availability Zone where the disk is located.
default Number	getSizeInGb()	The size of the disk in GB.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAddOns

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

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDiskPropsMixin.AddOnProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-addons

getAvailabilityZone

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-availabilityzone

getDiskName

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

The name of the disk.

See Also:

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

getLocation

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

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

Returns union: either IResolvable or CfnDiskPropsMixin.LocationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-location

getSizeInGb

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

The size of the disk in GB.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.html#cfn-lightsail-disk-tags

builder

@Stability(Stable)
static CfnDiskMixinProps.Builder builder()

Returns:

a CfnDiskMixinProps.Builder of CfnDiskMixinProps