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

Inherits:

Struct

• Object
• Struct
• Aws::StorageGateway::Types::UpdateSnapshotScheduleInput

Includes:

Aws::Structure

Defined in:

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  Optional description of the snapshot that overwrites the existing description.

• #recurrence_in_hours ⇒ Integer

  Frequency of snapshots.

• #start_at ⇒ Integer

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

• #tags ⇒ Array<Types::Tag>

  A list of up to 50 tags that can be assigned to a snapshot.

• #volume_arn ⇒ String

  The Amazon Resource Name (ARN) of the volume.

Instance Attribute Details

#description ⇒ String

Optional description of the snapshot that overwrites the existing description.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 7285

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

#recurrence_in_hours ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-storagegateway/types.rb', line 7285

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

#start_at ⇒ Integer

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)

# File 'lib/aws-sdk-storagegateway/types.rb', line 7285

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

#tags ⇒ Array<Types::Tag>

A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

<note markdown=“1”> 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.

</note>

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-storagegateway/types.rb', line 7285

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

#volume_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 7285

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