Package software.amazon.awscdk.services.lightsail

Class CfnInstanceSnapshot

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.CfnInstanceSnapshot
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)", date="2025-07-24T11:33:17.133Z") @Stability(Stable) public class CfnInstanceSnapshot extends CfnResource implements IInspectable, ITaggableV2
Describes an instance 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.*;
 CfnInstanceSnapshot cfnInstanceSnapshot = CfnInstanceSnapshot.Builder.create(this, "MyCfnInstanceSnapshot")
         .instanceName("instanceName")
         .instanceSnapshotName("instanceSnapshotName")
         // 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

    • CfnInstanceSnapshot

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

    • CfnInstanceSnapshot

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

    • CfnInstanceSnapshot

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

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the snapshot ( arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE ).

    • getAttrFromInstanceArn

      @Stability(Stable) @NotNull public String getAttrFromInstanceArn()
      The Amazon Resource Name (ARN) of the instance from which the snapshot was created ( arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE ).

    • getAttrFromInstanceName

      @Stability(Stable) @NotNull public String getAttrFromInstanceName()
      The instance from which the 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 region name and Availability Zone where you created the snapshot.

    • getAttrResourceType

      @Stability(Stable) @NotNull public String getAttrResourceType()
      The type of resource (usually InstanceSnapshot ).

    • getAttrSizeInGb

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

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The state the snapshot is in.

    • 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

    • getInstanceName

      @Stability(Stable) @NotNull public String getInstanceName()
      The name the user gave the instance ( Amazon_Linux_2023-1 ).

    • setInstanceName

      @Stability(Stable) public void setInstanceName(@NotNull String value)
      The name the user gave the instance ( Amazon_Linux_2023-1 ).

    • getInstanceSnapshotName

      @Stability(Stable) @NotNull public String getInstanceSnapshotName()
      The name of the snapshot.

    • setInstanceSnapshotName

      @Stability(Stable) public void setInstanceSnapshotName(@NotNull String value)
      The name of the 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.