Package software.amazon.awscdk.services.lightsail

Class CfnDiskSnapshot

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.CfnDiskSnapshot
All Implemented Interfaces:
IInspectable, ITaggableV2, IDiskSnapshotRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-10-14T12:28:15.086Z") @Stability(Stable) public class CfnDiskSnapshot extends CfnResource implements IInspectable, IDiskSnapshotRef, ITaggableV2
Describes a block storage disk snapshot.

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.*;
 CfnDiskSnapshot cfnDiskSnapshot = CfnDiskSnapshot.Builder.create(this, "MyCfnDiskSnapshot")
         .diskName("diskName")
         .diskSnapshotName("diskSnapshotName")
         // the properties below are optional
         .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

    • CfnDiskSnapshot

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

    • CfnDiskSnapshot

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

    • CfnDiskSnapshot

      @Stability(Stable) public CfnDiskSnapshot(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDiskSnapshotProps props)
      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

    • 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.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The date when the disk snapshot was created.

    • getAttrDiskSnapshotArn

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

    • getAttrFromDiskName

      @Stability(Stable) @NotNull public String getAttrFromDiskName()
      The unique name of the source disk from which the disk snapshot was created.

    • getAttrIsFromAutoSnapshot

      @Stability(Stable) @NotNull public IResolvable getAttrIsFromAutoSnapshot()
      A Boolean value indicating whether the snapshot was created from an automatic snapshot.

    • getAttrLocation

      @Stability(Stable) @NotNull public IResolvable getAttrLocation()
      The AWS Region and Availability Zone where the disk snapshot was created.

    • getAttrProgress

      @Stability(Stable) @NotNull public String getAttrProgress()
      The progress of the snapshot.

    • getAttrResourceType

      @Stability(Stable) @NotNull public String getAttrResourceType()
      The Lightsail resource type ( DiskSnapshot ).

    • getAttrSizeInGb

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

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The status of the disk snapshot operation.

    • getAttrSupportCode

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

      Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

    • getCdkTagManager

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

    • getCfnProperties

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

    • getDiskSnapshotRef

      @Stability(Stable) @NotNull public DiskSnapshotReference getDiskSnapshotRef()
      A reference to a DiskSnapshot resource.
      Specified by:
      getDiskSnapshotRef in interface IDiskSnapshotRef

    • getDiskName

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

    • setDiskName

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

    • getDiskSnapshotName

      @Stability(Stable) @NotNull public String getDiskSnapshotName()
      The name of the disk snapshot ( my-disk-snapshot ).

    • setDiskSnapshotName

      @Stability(Stable) public void setDiskSnapshotName(@NotNull String value)
      The name of the disk snapshot ( my-disk-snapshot ).

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tag keys and optional values for the resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tag keys and optional values for the resource.