Class CfnDiskSnapshot

Describes a block storage disk snapshot.

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

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

CloudformationResource: AWS::Lightsail::DiskSnapshot

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 cfnDiskSnapshot = new CfnDiskSnapshot(this, "MyCfnDiskSnapshot", new CfnDiskSnapshotProps {
                 DiskName = "diskName",
                 DiskSnapshotName = "diskSnapshotName",

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

Synopsis

Constructors

CfnDiskSnapshot(Construct, string, ICfnDiskSnapshotProps)

Create a new AWS::Lightsail::DiskSnapshot.

Properties

AttrCreatedAt

The date when the disk snapshot was created.
AttrDiskSnapshotArn

The Amazon Resource Name (ARN) of the disk snapshot.
AttrFromDiskName

The unique name of the source disk from which the disk snapshot was created.
AttrIsFromAutoSnapshot

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

The AWS Region and Availability Zone where the disk snapshot was created.
AttrProgress

The progress of the snapshot.
AttrResourceType

The Lightsail resource type ( DiskSnapshot ).
AttrSizeInGb

The size of the disk in GB.
AttrState

The status of the disk snapshot operation.
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 a block storage disk snapshot.
CfnPropertyNames

Describes a block storage disk snapshot.
DiskName

The unique name of the disk.
DiskSnapshotName

The name of the disk snapshot ( my-disk-snapshot ).
DiskSnapshotRef

A reference to a DiskSnapshot resource.
Tags

The tag keys and optional values for the resource.

Methods

ArnForDiskSnapshot(IDiskSnapshotRef)

Describes a block storage disk snapshot.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnDiskSnapshot(object)

Checks whether the given object is a CfnDiskSnapshot.
RenderProperties(IDictionary<string, object>)

Describes a block storage disk snapshot.

Constructors

CfnDiskSnapshot(Construct, string, ICfnDiskSnapshotProps)

Create a new AWS::Lightsail::DiskSnapshot.

public CfnDiskSnapshot(Construct scope, string id, ICfnDiskSnapshotProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

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

props ICfnDiskSnapshotProps

Resource properties.

Remarks

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

CloudformationResource: AWS::Lightsail::DiskSnapshot

ExampleMetadata: fixture=_generated

Properties

AttrCreatedAt

The date when the disk snapshot was created.

public virtual string AttrCreatedAt { get; }
Property Value

string

Remarks

CloudformationAttribute: CreatedAt

AttrDiskSnapshotArn

The Amazon Resource Name (ARN) of the disk snapshot.

public virtual string AttrDiskSnapshotArn { get; }
Property Value

string

Remarks

CloudformationAttribute: DiskSnapshotArn

AttrFromDiskName

The unique name of the source disk from which the disk snapshot was created.

public virtual string AttrFromDiskName { get; }
Property Value

string

Remarks

CloudformationAttribute: FromDiskName

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 AWS Region and Availability Zone where the disk snapshot was created.

public virtual IResolvable AttrLocation { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: Location

AttrProgress

The progress of the snapshot.

public virtual string AttrProgress { get; }
Property Value

string

Remarks

CloudformationAttribute: Progress

AttrResourceType

The Lightsail resource type ( DiskSnapshot ).

public virtual string AttrResourceType { get; }
Property Value

string

Remarks

CloudformationAttribute: ResourceType

AttrSizeInGb

The size of the disk in GB.

public virtual double AttrSizeInGb { get; }
Property Value

double

Remarks

CloudformationAttribute: SizeInGb

AttrState

The status of the disk snapshot operation.

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-disksnapshot.html

CloudformationResource: AWS::Lightsail::DiskSnapshot

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-disksnapshot.html

CloudformationResource: AWS::Lightsail::DiskSnapshot

ExampleMetadata: fixture=_generated

CfnProperties

Describes a block storage disk 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-disksnapshot.html

CloudformationResource: AWS::Lightsail::DiskSnapshot

ExampleMetadata: fixture=_generated

CfnPropertyNames

Describes a block storage disk snapshot.

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

IDictionary<string, string>

Overrides
Remarks

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

CloudformationResource: AWS::Lightsail::DiskSnapshot

ExampleMetadata: fixture=_generated

DiskName

The unique name of the disk.

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

string

Remarks

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

CloudformationResource: AWS::Lightsail::DiskSnapshot

ExampleMetadata: fixture=_generated

DiskSnapshotName

The name of the disk snapshot ( my-disk-snapshot ).

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

string

Remarks

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

CloudformationResource: AWS::Lightsail::DiskSnapshot

ExampleMetadata: fixture=_generated

DiskSnapshotRef

A reference to a DiskSnapshot resource.

public virtual IDiskSnapshotReference DiskSnapshotRef { get; }
Property Value

IDiskSnapshotReference

Remarks

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

CloudformationResource: AWS::Lightsail::DiskSnapshot

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-disksnapshot.html

CloudformationResource: AWS::Lightsail::DiskSnapshot

ExampleMetadata: fixture=_generated

Methods

ArnForDiskSnapshot(IDiskSnapshotRef)

Describes a block storage disk snapshot.

public static string ArnForDiskSnapshot(IDiskSnapshotRef resource)
Parameters
resource IDiskSnapshotRef
Returns

string

Remarks

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

CloudformationResource: AWS::Lightsail::DiskSnapshot

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 cfnDiskSnapshot = new CfnDiskSnapshot(this, "MyCfnDiskSnapshot", new CfnDiskSnapshotProps {
                 DiskName = "diskName",
                 DiskSnapshotName = "diskSnapshotName",

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

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-disksnapshot.html

CloudformationResource: AWS::Lightsail::DiskSnapshot

ExampleMetadata: fixture=_generated

IsCfnDiskSnapshot(object)

Checks whether the given object is a CfnDiskSnapshot.

public static bool IsCfnDiskSnapshot(object x)
Parameters
x object
Returns

bool

Remarks

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

CloudformationResource: AWS::Lightsail::DiskSnapshot

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Describes a block storage disk 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-disksnapshot.html

CloudformationResource: AWS::Lightsail::DiskSnapshot

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable