UpdateSnapshotScheduleRequest Class

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 types.

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

public class UpdateSnapshotScheduleRequest : AmazonStorageGatewayRequest
         IAmazonWebServiceRequest

The UpdateSnapshotScheduleRequest type exposes the following members

Constructors

	Name	Description
	UpdateSnapshotScheduleRequest()

Properties

Name	Type	Description
Description	System.String	Gets and sets the property Description. Optional description of the snapshot that overwrites the existing description.
RecurrenceInHours	System.Int32	Gets and sets the property RecurrenceInHours. Frequency of snapshots. Specify the number of hours between snapshots.
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.
Tags	System.Collections.Generic.List<Amazon.StorageGateway.Model.Tag>	Gets and sets the property Tags. A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
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 client = new AmazonStorageGatewayClient();
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:
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