AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes a snapshot.

Inheritance Hierarchy

System.Object
  Amazon.EC2.Model.Snapshot

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public class Snapshot

The Snapshot type exposes the following members

Constructors

NameDescription
Public Method Snapshot()

Properties

NameTypeDescription
Public Property DataEncryptionKeyId System.String

Gets and sets the property DataEncryptionKeyId.

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

Public Property Description System.String

Gets and sets the property Description.

The description for the snapshot.

Public Property Encrypted System.Boolean

Gets and sets the property Encrypted.

Indicates whether the snapshot is encrypted.

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

Public Property OwnerAlias System.String

Gets and sets the property OwnerAlias.

Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

Public Property OwnerId System.String

Gets and sets the property OwnerId.

The AWS account ID of the EBS snapshot owner.

Public Property Progress System.String

Gets and sets the property Progress.

The progress of the snapshot, as a percentage.

Public Property SnapshotId System.String

Gets and sets the property SnapshotId.

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

Public Property StartTime System.DateTime

Gets and sets the property StartTime.

The time stamp when the snapshot was initiated.

Public Property State Amazon.EC2.SnapshotState

Gets and sets the property State.

The snapshot state.

Public Property StateMessage System.String

Gets and sets the property StateMessage.

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

Public Property Tags System.Collections.Generic.List<Amazon.EC2.Model.Tag>

Gets and sets the property Tags.

Any tags assigned to the snapshot.

Public Property VolumeId System.String

Gets and sets the property VolumeId.

The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

Public Property VolumeSize System.Int32

Gets and sets the property VolumeSize.

The size of the volume, in GiB.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms