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.

Container for the parameters to the CreateSnapshot operation. Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.CreateSnapshotRequest

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

Syntax

C#
public class CreateSnapshotRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The CreateSnapshotRequest type exposes the following members

Constructors

NameDescription
Public Method CreateSnapshotRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method CreateSnapshotRequest(string, string)

Instantiates CreateSnapshotRequest with the parameterized properties

Properties

NameTypeDescription
Public Property Description System.String

Gets and sets the property Description.

A description for the snapshot.

Public Property VolumeId System.String

Gets and sets the property VolumeId.

The ID of the EBS volume.

Examples

This example creates a snapshot of the volume with a volume ID of ``vol-1234567890abcdef0`` and a short description to identify the snapshot.

To create a snapshot


var response = client.CreateSnapshot(new CreateSnapshotRequest 
{
    Description = "This is my root volume snapshot.",
    VolumeId = "vol-1234567890abcdef0"
});

string description = response.Description;
string ownerId = response.OwnerId;
string snapshotId = response.SnapshotId;
DateTime startTime = response.StartTime;
string state = response.State;
List tags = response.Tags;
string volumeId = response.VolumeId;
integer volumeSize = response.VolumeSize;

            

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