Class CfnInstanceSnapshot

Describes an instance snapshot.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnInstanceSnapshot
Inherited Members
Namespace: Amazon.CDK.AWS.Lightsail
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnInstanceSnapshot : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnInstanceSnapshot Inherits CfnResource Implements IInspectable, ITaggableV2
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html

CloudformationResource: AWS::Lightsail::InstanceSnapshot

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Lightsail;

             var cfnInstanceSnapshot = new CfnInstanceSnapshot(this, "MyCfnInstanceSnapshot", new CfnInstanceSnapshotProps {
                 InstanceName = "instanceName",
                 InstanceSnapshotName = "instanceSnapshotName",

                 // the properties below are optional
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnInstanceSnapshot(Construct, string, ICfnInstanceSnapshotProps)

Describes an instance snapshot.

Properties

AttrArn

The Amazon Resource Name (ARN) of the snapshot ( arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE ).
AttrFromInstanceArn

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 ).
AttrFromInstanceName

The instance from which the snapshot was created.
AttrIsFromAutoSnapshot

A Boolean value indicating whether the snapshot was created from an automatic snapshot.
AttrLocation

The region name and Availability Zone where you created the snapshot.
AttrResourceType

The type of resource (usually InstanceSnapshot ).
AttrSizeInGb

The size in GB of the SSD.
AttrState

The state the snapshot is in.
AttrSupportCode

The support code.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

Describes an instance snapshot.
InstanceName

The name the user gave the instance ( Amazon_Linux_2023-1 ).
InstanceSnapshotName

The name of the snapshot.
Tags

The tag keys and optional values for the resource.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

Describes an instance snapshot.

Constructors

CfnInstanceSnapshot(Construct, string, ICfnInstanceSnapshotProps)

Describes an instance snapshot.

public CfnInstanceSnapshot(Construct scope, string id, ICfnInstanceSnapshotProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnInstanceSnapshotProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html

CloudformationResource: AWS::Lightsail::InstanceSnapshot

ExampleMetadata: fixture=_generated

Properties

AttrArn

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

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

AttrFromInstanceArn

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

public virtual string AttrFromInstanceArn { get; }
Property Value

string

Remarks

CloudformationAttribute: FromInstanceArn

AttrFromInstanceName

The instance from which the snapshot was created.

public virtual string AttrFromInstanceName { get; }
Property Value

string

Remarks

CloudformationAttribute: FromInstanceName

AttrIsFromAutoSnapshot

A Boolean value indicating whether the snapshot was created from an automatic snapshot.

public virtual IResolvable AttrIsFromAutoSnapshot { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: IsFromAutoSnapshot

AttrLocation

The region name and Availability Zone where you created the snapshot.

public virtual IResolvable AttrLocation { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: Location

AttrResourceType

The type of resource (usually InstanceSnapshot ).

public virtual string AttrResourceType { get; }
Property Value

string

Remarks

CloudformationAttribute: ResourceType

AttrSizeInGb

The size in GB of the SSD.

public virtual double AttrSizeInGb { get; }
Property Value

double

Remarks

CloudformationAttribute: SizeInGb

AttrState

The state the snapshot is in.

public virtual string AttrState { get; }
Property Value

string

Remarks

CloudformationAttribute: State

AttrSupportCode

The support code.

public virtual string AttrSupportCode { get; }
Property Value

string

Remarks

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.

CloudformationAttribute: SupportCode

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html

CloudformationResource: AWS::Lightsail::InstanceSnapshot

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html

CloudformationResource: AWS::Lightsail::InstanceSnapshot

ExampleMetadata: fixture=_generated

CfnProperties

Describes an instance snapshot.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html

CloudformationResource: AWS::Lightsail::InstanceSnapshot

ExampleMetadata: fixture=_generated

InstanceName

The name the user gave the instance ( Amazon_Linux_2023-1 ).

public virtual string InstanceName { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html

CloudformationResource: AWS::Lightsail::InstanceSnapshot

ExampleMetadata: fixture=_generated

InstanceSnapshotName

The name of the snapshot.

public virtual string InstanceSnapshotName { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html

CloudformationResource: AWS::Lightsail::InstanceSnapshot

ExampleMetadata: fixture=_generated

Tags

The tag keys and optional values for the resource.

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html

CloudformationResource: AWS::Lightsail::InstanceSnapshot

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html

CloudformationResource: AWS::Lightsail::InstanceSnapshot

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Describes an instance snapshot.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-instancesnapshot.html

CloudformationResource: AWS::Lightsail::InstanceSnapshot

ExampleMetadata: fixture=_generated

Implements