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 a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.

You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk 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 disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.

You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.

The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

Note:

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

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

Syntax

C#
public virtual CreateDiskSnapshotResponse CreateDiskSnapshot(
         CreateDiskSnapshotRequest request
)

Parameters

request
Type: Amazon.Lightsail.Model.CreateDiskSnapshotRequest

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

Return Value


The response from the CreateDiskSnapshot service method, as returned by Lightsail.

Exceptions

ExceptionCondition
AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state.
InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field. Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException Lightsail throws this exception when it cannot find a resource.
OperationFailureException Lightsail throws this exception when an operation fails to execute.
ServiceException A general service exception.
UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.

Version Information

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

See Also