Package software.amazon.awscdk.services.lightsail

Class CfnDisk

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.lightsail.CfnDisk
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IDiskRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:39.712Z") @Stability(Stable) public class CfnDisk extends CfnResource implements IInspectable, IDiskRef, ITaggable
The AWS::Lightsail::Disk resource specifies a disk that can be attached to an Amazon Lightsail instance that is in the same AWS Region and Availability Zone.

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.*;
 CfnDisk cfnDisk = CfnDisk.Builder.create(this, "MyCfnDisk")
         .diskName("diskName")
         .sizeInGb(123)
         // the properties below are optional
         .addOns(List.of(AddOnProperty.builder()
                 .addOnType("addOnType")
                 // the properties below are optional
                 .autoSnapshotAddOnRequest(AutoSnapshotAddOnProperty.builder()
                         .snapshotTimeOfDay("snapshotTimeOfDay")
                         .build())
                 .status("status")
                 .build()))
         .availabilityZone("availabilityZone")
         .location(LocationProperty.builder()
                 .availabilityZone("availabilityZone")
                 .regionName("regionName")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDisk

      protected CfnDisk(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDisk

      protected CfnDisk(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDisk

      @Stability(Stable) public CfnDisk(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDiskProps props)
      Create a new AWS::Lightsail::Disk.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForDisk

      @Stability(Stable) @NotNull public static String arnForDisk(@NotNull IDiskRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnDisk

      @Stability(Stable) @NotNull public static Boolean isCfnDisk(@NotNull Object x)
      Checks whether the given object is a CfnDisk.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAttachedTo

      @Stability(Stable) @NotNull public String getAttrAttachedTo()
      The resources to which the disk is attached.

    • getAttrAttachmentState

      @Stability(Stable) @NotNull public String getAttrAttachmentState()
      (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.

    • getAttrDiskArn

      @Stability(Stable) @NotNull public String getAttrDiskArn()
      The Amazon Resource Name (ARN) of the disk.

    • getAttrIops

      @Stability(Stable) @NotNull public Number getAttrIops()
      The input/output operations per second (IOPS) of the disk.

    • getAttrIsAttached

      @Stability(Stable) @NotNull public IResolvable getAttrIsAttached()
      A Boolean value indicating whether the disk is attached.

    • getAttrLocationAvailabilityZone

      @Stability(Stable) @NotNull public String getAttrLocationAvailabilityZone()
      The Availability Zone where the disk is located.

    • getAttrLocationRegionName

      @Stability(Stable) @NotNull public String getAttrLocationRegionName()
      The AWS Region where the disk is located.

    • getAttrPath

      @Stability(Stable) @NotNull public String getAttrPath()
      The disk path.

    • getAttrResourceType

      @Stability(Stable) @NotNull public String getAttrResourceType()
      The resource type of the disk (for example, Disk ).

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The state of the disk (for example, in-use ).

    • getAttrSupportCode

      @Stability(Stable) @NotNull public String getAttrSupportCode()
      The support code of the disk.

      Include this code in your email to support when you have questions about a disk or another resource in Lightsail . This code helps our support team to look up your Lightsail information.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDiskRef

      @Stability(Stable) @NotNull public DiskReference getDiskRef()
      A reference to a Disk resource.
      Specified by:
      getDiskRef in interface IDiskRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDiskName

      @Stability(Stable) @NotNull public String getDiskName()
      The name of the disk.

    • setDiskName

      @Stability(Stable) public void setDiskName(@NotNull String value)
      The name of the disk.

    • getSizeInGb

      @Stability(Stable) @NotNull public Number getSizeInGb()
      The size of the disk in GB.

    • setSizeInGb

      @Stability(Stable) public void setSizeInGb(@NotNull Number value)
      The size of the disk in GB.

    • getAddOns

      @Stability(Stable) @Nullable public Object getAddOns()
      An array of add-ons for the disk.

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

    • setAddOns

      @Stability(Stable) public void setAddOns(@Nullable IResolvable value)
      An array of add-ons for the disk.

    • setAddOns

      @Stability(Stable) public void setAddOns(@Nullable List<Object> value)
      An array of add-ons for the disk.

    • getAvailabilityZone

      @Stability(Stable) @Nullable public String getAvailabilityZone()
      The AWS Region and Availability Zone location for the disk (for example, us-east-1a ).

    • setAvailabilityZone

      @Stability(Stable) public void setAvailabilityZone(@Nullable String value)
      The AWS Region and Availability Zone location for the disk (for example, us-east-1a ).

    • getLocation

      @Stability(Stable) @Nullable public Object getLocation()
      The AWS Region and Availability Zone where the disk is located.

      Returns union: either IResolvable or CfnDisk.LocationProperty

    • setLocation

      @Stability(Stable) public void setLocation(@Nullable IResolvable value)
      The AWS Region and Availability Zone where the disk is located.

    • setLocation

      @Stability(Stable) public void setLocation(@Nullable CfnDisk.LocationProperty value)
      The AWS Region and Availability Zone where the disk is located.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.