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 UpdateSnapshotSchedule operation. Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway architectures.

The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.

In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.StorageGateway.AmazonStorageGatewayRequest
      Amazon.StorageGateway.Model.UpdateSnapshotScheduleRequest

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

Syntax

C#
public class UpdateSnapshotScheduleRequest : AmazonStorageGatewayRequest
         IAmazonWebServiceRequest

The UpdateSnapshotScheduleRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property Description System.String

Gets and sets the property Description.

Optional description of the snapshot that overwrites the existing description.

Public Property RecurrenceInHours System.Int32

Gets and sets the property RecurrenceInHours.

Frequency of snapshots. Specify the number of hours between snapshots.

Public Property StartAt System.Int32

Gets and sets the property StartAt.

The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

Public Property VolumeARN System.String

Gets and sets the property VolumeARN.

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Examples

Updates a snapshot schedule configured for a gateway volume.

To update a volume snapshot schedule


var response = client.UpdateSnapshotSchedule(new UpdateSnapshotScheduleRequest 
{
    Description = "Hourly snapshot",
    RecurrenceInHours = 1,
    StartAt = 0,
    VolumeARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
});

string volumeARN = response.VolumeARN;

            

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