« blib/lib/Paws/AutoScaling/ResumeProcesses.pm
↑ Summary
blib/lib/Paws/AutoScaling/SetDesiredCapacity.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AutoScaling::ScheduledUpdateGroupActionRequest; | ||
| 3 | use Moose; | ||
| 4 | has DesiredCapacity => (is => 'ro', isa => 'Int'); | ||
| 5 | has EndTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has MaxSize => (is => 'ro', isa => 'Int'); | ||
| 7 | has MinSize => (is => 'ro', isa => 'Int'); | ||
| 8 | has Recurrence => (is => 'ro', isa => 'Str'); | ||
| 9 | has ScheduledActionName => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has StartTime => (is => 'ro', isa => 'Str'); | ||
| 11 | has TimeZone => (is => 'ro', isa => 'Str'); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::AutoScaling::ScheduledUpdateGroupActionRequest | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::AutoScaling::ScheduledUpdateGroupActionRequest object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { DesiredCapacity => $value, ..., TimeZone => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::AutoScaling::ScheduledUpdateGroupActionRequest object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->DesiredCapacity | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Describes information used for one or more scheduled scaling action | ||
| 44 | updates in a BatchPutScheduledUpdateGroupAction operation. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 DesiredCapacity => Int | ||
| 50 | |||
| 51 | The desired capacity is the initial capacity of the Auto Scaling group | ||
| 52 | after the scheduled action runs and the capacity it attempts to | ||
| 53 | maintain. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 EndTime => Str | ||
| 57 | |||
| 58 | The date and time for the recurring schedule to end, in UTC. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 MaxSize => Int | ||
| 62 | |||
| 63 | The maximum size of the Auto Scaling group. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 MinSize => Int | ||
| 67 | |||
| 68 | The minimum size of the Auto Scaling group. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 Recurrence => Str | ||
| 72 | |||
| 73 | The recurring schedule for the action, in Unix cron syntax format. This | ||
| 74 | format consists of five fields separated by white spaces: [Minute] | ||
| 75 | [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be | ||
| 76 | in quotes (for example, C<"30 0 1 1,6,12 *">). For more information | ||
| 77 | about this format, see Crontab (http://crontab.org). | ||
| 78 | |||
| 79 | When C<StartTime> and C<EndTime> are specified with C<Recurrence>, they | ||
| 80 | form the boundaries of when the recurring action starts and stops. | ||
| 81 | |||
| 82 | Cron expressions use Universal Coordinated Time (UTC) by default. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> ScheduledActionName => Str | ||
| 86 | |||
| 87 | The name of the scaling action. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 StartTime => Str | ||
| 91 | |||
| 92 | The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ | ||
| 93 | format in UTC/GMT only and in quotes (for example, | ||
| 94 | C<"2019-06-01T00:00:00Z">). | ||
| 95 | |||
| 96 | If you specify C<Recurrence> and C<StartTime>, Amazon EC2 Auto Scaling | ||
| 97 | performs the action at this time, and then performs the action based on | ||
| 98 | the specified recurrence. | ||
| 99 | |||
| 100 | If you try to schedule the action in the past, Amazon EC2 Auto Scaling | ||
| 101 | returns an error message. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 TimeZone => Str | ||
| 105 | |||
| 106 | Specifies the time zone for a cron expression. If a time zone is not | ||
| 107 | provided, UTC is used by default. | ||
| 108 | |||
| 109 | Valid values are the canonical names of the IANA time zones, derived | ||
| 110 | from the IANA Time Zone Database (such as C<Etc/GMT+9> or | ||
| 111 | C<Pacific/Tahiti>). For more information, see | ||
| 112 | https://en.wikipedia.org/wiki/List_of_tz_database_time_zones | ||
| 113 | (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head1 SEE ALSO | ||
| 118 | |||
| 119 | This class forms part of L<Paws>, describing an object used in L<Paws::AutoScaling> | ||
| 120 | |||
| 121 | =head1 BUGS and CONTRIBUTIONS | ||
| 122 | |||
| 123 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 124 | |||
| 125 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 126 | |||
| 127 | =cut | ||
| 128 |