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.

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.

You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.

When a snapshot is created, any Amazon Web Services 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 Amazon EBS volume at the time the snapshot command is issued; this might 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.

When you create a snapshot for an EBS volume that serves as a root device, we recommend that you 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.

You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.

For more information, see Amazon EBS and Amazon EBS encryption in the Amazon EBS User Guide.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CreateSnapshotAsync.

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

Syntax

C#
public virtual CreateSnapshotResponse CreateSnapshot(
         CreateSnapshotRequest request
)

Parameters

request
Type: Amazon.EC2.Model.CreateSnapshotRequest

Container for the necessary parameters to execute the CreateSnapshot service method.

Return Value


The response from the CreateSnapshot service method, as returned by EC2.

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 client = new AmazonEC2Client();
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<Tag> tags = response.Tags;
string volumeId = response.VolumeId;
int volumeSize = response.VolumeSize;

            

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also