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.

The location of the source EBS volume determines where you can create the snapshot.

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. For more information, see Amazon EBS encryption in the Amazon EBS 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 Location Amazon.EC2.SnapshotLocationEnum

Gets and sets the property Location.

Only supported for volumes in Local Zones. If the source volume is not in a Local Zone, omit this parameter.

  • To create a local snapshot in the same Local Zone as the source volume, specify local.

  • To create a regional snapshot in the parent Region of the Local Zone, specify regional or omit this parameter.

Default value: regional

Public Property OutpostArn System.String

Gets and sets the property OutpostArn.

Only supported for volumes on Outposts. If the source volume is not on an Outpost, omit this parameter.

  • To create the snapshot on the same Outpost as the source volume, specify the ARN of that Outpost. The snapshot must be created on the same Outpost as the volume.

  • To create the snapshot in the parent Region of the Outpost, omit this parameter.

For more information, see Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.

Public Property TagSpecifications System.Collections.Generic.List<Amazon.EC2.Model.TagSpecification>

Gets and sets the property TagSpecifications.

The tags to apply to the snapshot during creation.

Public Property VolumeId System.String

Gets and sets the property VolumeId.

The ID of the Amazon 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 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:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

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