« blib/lib/Paws/StorageGateway/UpdateSMBSecurityStrategyOutput.pm
↑ Summary
blib/lib/Paws/StorageGateway/UpdateSnapshotScheduleOutput.pm »
| 1 | |||
| 2 | package Paws::StorageGateway::UpdateSnapshotSchedule; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str'); | ||
| 5 | has RecurrenceInHours => (is => 'ro', isa => 'Int', required => 1); | ||
| 6 | has StartAt => (is => 'ro', isa => 'Int', required => 1); | ||
| 7 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::StorageGateway::Tag]'); | ||
| 8 | has VolumeARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateSnapshotSchedule'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::StorageGateway::UpdateSnapshotScheduleOutput'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::StorageGateway::UpdateSnapshotSchedule - Arguments for method UpdateSnapshotSchedule on L<Paws::StorageGateway> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method UpdateSnapshotSchedule on the | ||
| 26 | L<AWS Storage Gateway|Paws::StorageGateway> service. Use the attributes of this class | ||
| 27 | as arguments to method UpdateSnapshotSchedule. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateSnapshotSchedule. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $storagegateway = Paws->service('StorageGateway'); | ||
| 34 | # To update a volume snapshot schedule | ||
| 35 | # Updates a snapshot schedule configured for a gateway volume. | ||
| 36 | my $UpdateSnapshotScheduleOutput = $storagegateway->UpdateSnapshotSchedule( | ||
| 37 | 'Description' => 'Hourly snapshot', | ||
| 38 | 'RecurrenceInHours' => 1, | ||
| 39 | 'StartAt' => 0, | ||
| 40 | 'VolumeARN' => | ||
| 41 | 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB' | ||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $VolumeARN = $UpdateSnapshotScheduleOutput->VolumeARN; | ||
| 46 | |||
| 47 | # Returns a L<Paws::StorageGateway::UpdateSnapshotScheduleOutput> object. | ||
| 48 | |||
| 49 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/storagegateway/UpdateSnapshotSchedule> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Description => Str | ||
| 56 | |||
| 57 | Optional description of the snapshot that overwrites the existing | ||
| 58 | description. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> RecurrenceInHours => Int | ||
| 63 | |||
| 64 | Frequency of snapshots. Specify the number of hours between snapshots. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> StartAt => Int | ||
| 69 | |||
| 70 | The hour of the day at which the snapshot schedule begins represented | ||
| 71 | as I<hh>, where I<hh> is the hour (0 to 23). The hour of the day is in | ||
| 72 | the time zone of the gateway. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 Tags => ArrayRef[L<Paws::StorageGateway::Tag>] | ||
| 77 | |||
| 78 | A list of up to 50 tags that can be assigned to a snapshot. Each tag is | ||
| 79 | a key-value pair. | ||
| 80 | |||
| 81 | Valid characters for key and value are letters, spaces, and numbers | ||
| 82 | representable in UTF-8 format, and the following special characters: + | ||
| 83 | - = . _ : / @. The maximum length of a tag's key is 128 characters, and | ||
| 84 | the maximum length for a tag's value is 256. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> VolumeARN => Str | ||
| 89 | |||
| 90 | The Amazon Resource Name (ARN) of the volume. Use the ListVolumes | ||
| 91 | operation to return a list of gateway volumes. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head1 SEE ALSO | ||
| 97 | |||
| 98 | This class forms part of L<Paws>, documenting arguments for method UpdateSnapshotSchedule in L<Paws::StorageGateway> | ||
| 99 | |||
| 100 | =head1 BUGS and CONTRIBUTIONS | ||
| 101 | |||
| 102 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 103 | |||
| 104 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 105 | |||
| 106 | =cut | ||
| 107 |