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-16T11:43:17.208Z")
@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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnInstanceSnapshot
.static interface
The region name and Availability Zone where you created the snapshot.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnInstanceSnapshot
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnInstanceSnapshot
(software.amazon.jsii.JsiiObjectRef objRef) CfnInstanceSnapshot
(software.constructs.Construct scope, String id, CfnInstanceSnapshotProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the snapshot (arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE
).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
).The instance from which the snapshot was created.A Boolean value indicating whether the snapshot was created from an automatic snapshot.The region name and Availability Zone where you created the snapshot.The type of resource (usuallyInstanceSnapshot
).The size in GB of the SSD.The state the snapshot is in.The support code.Tag Manager which manages the tags for this resource.The name the user gave the instance (Amazon_Linux_2023-1
).The name of the snapshot.getTags()
The tag keys and optional values for the resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setInstanceName
(String value) The name the user gave the instance (Amazon_Linux_2023-1
).void
setInstanceSnapshotName
(String value) The name of the snapshot.void
The tag keys and optional values for the resource.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the snapshot (arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE
). -
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
The instance from which the snapshot was created. -
getAttrIsFromAutoSnapshot
A Boolean value indicating whether the snapshot was created from an automatic snapshot. -
getAttrLocation
The region name and Availability Zone where you created the snapshot. -
getAttrResourceType
The type of resource (usuallyInstanceSnapshot
). -
getAttrSizeInGb
The size in GB of the SSD. -
getAttrState
The state the snapshot is in. -
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
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getInstanceName
The name the user gave the instance (Amazon_Linux_2023-1
). -
setInstanceName
The name the user gave the instance (Amazon_Linux_2023-1
). -
getInstanceSnapshotName
The name of the snapshot. -
setInstanceSnapshotName
The name of the snapshot. -
getTags
The tag keys and optional values for the resource. -
setTags
The tag keys and optional values for the resource.
-