« blib/lib/Paws/AutoScaling/PutScalingPolicy.pm
↑ Summary
blib/lib/Paws/AutoScaling/PutWarmPool.pm »
| 1 | |||
| 2 | package Paws::AutoScaling::PutScheduledUpdateGroupAction; | ||
| 3 | use Moose; | ||
| 4 | has AutoScalingGroupName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DesiredCapacity => (is => 'ro', isa => 'Int'); | ||
| 6 | has EndTime => (is => 'ro', isa => 'Str'); | ||
| 7 | has MaxSize => (is => 'ro', isa => 'Int'); | ||
| 8 | has MinSize => (is => 'ro', isa => 'Int'); | ||
| 9 | has Recurrence => (is => 'ro', isa => 'Str'); | ||
| 10 | has ScheduledActionName => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has StartTime => (is => 'ro', isa => 'Str'); | ||
| 12 | has Time => (is => 'ro', isa => 'Str'); | ||
| 13 | has TimeZone => (is => 'ro', isa => 'Str'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutScheduledUpdateGroupAction'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 19 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::AutoScaling::PutScheduledUpdateGroupAction - Arguments for method PutScheduledUpdateGroupAction on L<Paws::AutoScaling> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method PutScheduledUpdateGroupAction on the | ||
| 31 | L<Auto Scaling|Paws::AutoScaling> service. Use the attributes of this class | ||
| 32 | as arguments to method PutScheduledUpdateGroupAction. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutScheduledUpdateGroupAction. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $autoscaling = Paws->service('AutoScaling'); | ||
| 39 | # To add a scheduled action to an Auto Scaling group | ||
| 40 | # This example adds the specified scheduled action to the specified Auto Scaling | ||
| 41 | # group. | ||
| 42 | $autoscaling->PutScheduledUpdateGroupAction( | ||
| 43 | 'AutoScalingGroupName' => 'my-auto-scaling-group', | ||
| 44 | 'DesiredCapacity' => 4, | ||
| 45 | 'EndTime' => '2014-05-12T08:00:00Z', | ||
| 46 | 'MaxSize' => 6, | ||
| 47 | 'MinSize' => 2, | ||
| 48 | 'ScheduledActionName' => 'my-scheduled-action', | ||
| 49 | 'StartTime' => '2014-05-12T08:00:00Z' | ||
| 50 | ); | ||
| 51 | |||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/autoscaling/PutScheduledUpdateGroupAction> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> AutoScalingGroupName => Str | ||
| 60 | |||
| 61 | The name of the Auto Scaling group. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 DesiredCapacity => Int | ||
| 66 | |||
| 67 | The desired capacity is the initial capacity of the Auto Scaling group | ||
| 68 | after the scheduled action runs and the capacity it attempts to | ||
| 69 | maintain. It can scale beyond this capacity if you add more scaling | ||
| 70 | conditions. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 EndTime => Str | ||
| 75 | |||
| 76 | The date and time for the recurring schedule to end, in UTC. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 MaxSize => Int | ||
| 81 | |||
| 82 | The maximum size of the Auto Scaling group. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 MinSize => Int | ||
| 87 | |||
| 88 | The minimum size of the Auto Scaling group. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 Recurrence => Str | ||
| 93 | |||
| 94 | The recurring schedule for this action. This format consists of five | ||
| 95 | fields separated by white spaces: [Minute] [Hour] [Day_of_Month] | ||
| 96 | [Month_of_Year] [Day_of_Week]. The value must be in quotes (for | ||
| 97 | example, C<"30 0 1 1,6,12 *">). For more information about this format, | ||
| 98 | see Crontab (http://crontab.org). | ||
| 99 | |||
| 100 | When C<StartTime> and C<EndTime> are specified with C<Recurrence>, they | ||
| 101 | form the boundaries of when the recurring action starts and stops. | ||
| 102 | |||
| 103 | Cron expressions use Universal Coordinated Time (UTC) by default. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> ScheduledActionName => Str | ||
| 108 | |||
| 109 | The name of this scaling action. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 StartTime => Str | ||
| 114 | |||
| 115 | The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ | ||
| 116 | format in UTC/GMT only and in quotes (for example, | ||
| 117 | C<"2019-06-01T00:00:00Z">). | ||
| 118 | |||
| 119 | If you specify C<Recurrence> and C<StartTime>, Amazon EC2 Auto Scaling | ||
| 120 | performs the action at this time, and then performs the action based on | ||
| 121 | the specified recurrence. | ||
| 122 | |||
| 123 | If you try to schedule your action in the past, Amazon EC2 Auto Scaling | ||
| 124 | returns an error message. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 Time => Str | ||
| 129 | |||
| 130 | This parameter is no longer used. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head2 TimeZone => Str | ||
| 135 | |||
| 136 | Specifies the time zone for a cron expression. If a time zone is not | ||
| 137 | provided, UTC is used by default. | ||
| 138 | |||
| 139 | Valid values are the canonical names of the IANA time zones, derived | ||
| 140 | from the IANA Time Zone Database (such as C<Etc/GMT+9> or | ||
| 141 | C<Pacific/Tahiti>). For more information, see | ||
| 142 | https://en.wikipedia.org/wiki/List_of_tz_database_time_zones | ||
| 143 | (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head1 SEE ALSO | ||
| 149 | |||
| 150 | This class forms part of L<Paws>, documenting arguments for method PutScheduledUpdateGroupAction in L<Paws::AutoScaling> | ||
| 151 | |||
| 152 | =head1 BUGS and CONTRIBUTIONS | ||
| 153 | |||
| 154 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 155 | |||
| 156 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 157 | |||
| 158 | =cut | ||
| 159 |