« blib/lib/Paws/RedShift/CreateSnapshotCopyGrantResult.pm
↑ Summary
blib/lib/Paws/RedShift/CreateTags.pm »
| 1 | |||
| 2 | package Paws::RedShift::CreateSnapshotSchedule; | ||
| 3 | use Moose; | ||
| 4 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 5 | has NextInvocations => (is => 'ro', isa => 'Int'); | ||
| 6 | has ScheduleDefinitions => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has ScheduleDescription => (is => 'ro', isa => 'Str'); | ||
| 8 | has ScheduleIdentifier => (is => 'ro', isa => 'Str'); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::Tag]'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateSnapshotSchedule'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::SnapshotSchedule'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateSnapshotScheduleResult'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::RedShift::CreateSnapshotSchedule - Arguments for method CreateSnapshotSchedule on L<Paws::RedShift> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateSnapshotSchedule on the | ||
| 27 | L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateSnapshotSchedule. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateSnapshotSchedule. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $redshift = Paws->service('RedShift'); | ||
| 35 | my $SnapshotSchedule = $redshift->CreateSnapshotSchedule( | ||
| 36 | DryRun => 1, # OPTIONAL | ||
| 37 | NextInvocations => 1, # OPTIONAL | ||
| 38 | ScheduleDefinitions => [ | ||
| 39 | 'MyString', ... # max: 2147483647 | ||
| 40 | ], # OPTIONAL | ||
| 41 | ScheduleDescription => 'MyString', # OPTIONAL | ||
| 42 | ScheduleIdentifier => 'MyString', # OPTIONAL | ||
| 43 | Tags => [ | ||
| 44 | { | ||
| 45 | Key => 'MyString', # max: 2147483647 | ||
| 46 | Value => 'MyString', # max: 2147483647 | ||
| 47 | }, | ||
| 48 | ... | ||
| 49 | ], # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $AssociatedClusterCount = $SnapshotSchedule->AssociatedClusterCount; | ||
| 54 | my $AssociatedClusters = $SnapshotSchedule->AssociatedClusters; | ||
| 55 | my $NextInvocations = $SnapshotSchedule->NextInvocations; | ||
| 56 | my $ScheduleDefinitions = $SnapshotSchedule->ScheduleDefinitions; | ||
| 57 | my $ScheduleDescription = $SnapshotSchedule->ScheduleDescription; | ||
| 58 | my $ScheduleIdentifier = $SnapshotSchedule->ScheduleIdentifier; | ||
| 59 | my $Tags = $SnapshotSchedule->Tags; | ||
| 60 | |||
| 61 | # Returns a L<Paws::RedShift::SnapshotSchedule> object. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/CreateSnapshotSchedule> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 DryRun => Bool | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 NextInvocations => Int | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 ScheduleDefinitions => ArrayRef[Str|Undef] | ||
| 82 | |||
| 83 | The definition of the snapshot schedule. The definition is made up of | ||
| 84 | schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)". | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 ScheduleDescription => Str | ||
| 89 | |||
| 90 | The description of the snapshot schedule. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 ScheduleIdentifier => Str | ||
| 95 | |||
| 96 | A unique identifier for a snapshot schedule. Only alphanumeric | ||
| 97 | characters are allowed for the identifier. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 Tags => ArrayRef[L<Paws::RedShift::Tag>] | ||
| 102 | |||
| 103 | An optional set of tags you can use to search for the schedule. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head1 SEE ALSO | ||
| 109 | |||
| 110 | This class forms part of L<Paws>, documenting arguments for method CreateSnapshotSchedule in L<Paws::RedShift> | ||
| 111 | |||
| 112 | =head1 BUGS and CONTRIBUTIONS | ||
| 113 | |||
| 114 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 115 | |||
| 116 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 117 | |||
| 118 | =cut | ||
| 119 |