You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::StorageGateway::Types::UpdateSnapshotScheduleInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb

Overview

Note:

When making an API call, you may pass UpdateSnapshotScheduleInput data as a hash:

{
  volume_arn: "VolumeARN", # required
  start_at: 1, # required
  recurrence_in_hours: 1, # required
  description: "Description",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

A JSON object containing one or more of the following fields:

  • UpdateSnapshotScheduleInput$Description

  • UpdateSnapshotScheduleInput$RecurrenceInHours

  • UpdateSnapshotScheduleInput$StartAt

  • UpdateSnapshotScheduleInput$VolumeARN

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

Optional description of the snapshot that overwrites the existing description.

Returns:

  • (String)


5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5831

class UpdateSnapshotScheduleInput < Struct.new(
  :volume_arn,
  :start_at,
  :recurrence_in_hours,
  :description,
  :tags)
  include Aws::Structure
end

#recurrence_in_hoursInteger

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

Returns:

  • (Integer)


5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5831

class UpdateSnapshotScheduleInput < Struct.new(
  :volume_arn,
  :start_at,
  :recurrence_in_hours,
  :description,
  :tags)
  include Aws::Structure
end

#start_atInteger

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.

Returns:

  • (Integer)


5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5831

class UpdateSnapshotScheduleInput < Struct.new(
  :volume_arn,
  :start_at,
  :recurrence_in_hours,
  :description,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

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.

Returns:



5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5831

class UpdateSnapshotScheduleInput < Struct.new(
  :volume_arn,
  :start_at,
  :recurrence_in_hours,
  :description,
  :tags)
  include Aws::Structure
end

#volume_arnString

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

Returns:

  • (String)


5831
5832
5833
5834
5835
5836
5837
5838
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5831

class UpdateSnapshotScheduleInput < Struct.new(
  :volume_arn,
  :start_at,
  :recurrence_in_hours,
  :description,
  :tags)
  include Aws::Structure
end