« blib/lib/Paws/AutoScaling/TerminateInstanceInAutoScalingGroup.pm
↑ Summary
blib/lib/Paws/AutoScalingPlans/ApplicationSource.pm »
| 1 | |||
| 2 | package Paws::AutoScaling::UpdateAutoScalingGroup; | ||
| 3 | use Moose; | ||
| 4 | has AutoScalingGroupName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has CapacityRebalance => (is => 'ro', isa => 'Bool'); | ||
| 7 | has Context => (is => 'ro', isa => 'Str'); | ||
| 8 | has DefaultCooldown => (is => 'ro', isa => 'Int'); | ||
| 9 | has DesiredCapacity => (is => 'ro', isa => 'Int'); | ||
| 10 | has HealthCheckGracePeriod => (is => 'ro', isa => 'Int'); | ||
| 11 | has HealthCheckType => (is => 'ro', isa => 'Str'); | ||
| 12 | has LaunchConfigurationName => (is => 'ro', isa => 'Str'); | ||
| 13 | has LaunchTemplate => (is => 'ro', isa => 'Paws::AutoScaling::LaunchTemplateSpecification'); | ||
| 14 | has MaxInstanceLifetime => (is => 'ro', isa => 'Int'); | ||
| 15 | has MaxSize => (is => 'ro', isa => 'Int'); | ||
| 16 | has MinSize => (is => 'ro', isa => 'Int'); | ||
| 17 | has MixedInstancesPolicy => (is => 'ro', isa => 'Paws::AutoScaling::MixedInstancesPolicy'); | ||
| 18 | has NewInstancesProtectedFromScaleIn => (is => 'ro', isa => 'Bool'); | ||
| 19 | has PlacementGroup => (is => 'ro', isa => 'Str'); | ||
| 20 | has ServiceLinkedRoleARN => (is => 'ro', isa => 'Str'); | ||
| 21 | has TerminationPolicies => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 22 | has VPCZoneIdentifier => (is => 'ro', isa => 'Str'); | ||
| 23 | |||
| 24 | use MooseX::ClassAttribute; | ||
| 25 | |||
| 26 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateAutoScalingGroup'); | ||
| 27 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 28 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 29 | 1; | ||
| 30 | |||
| 31 | ### main pod documentation begin ### | ||
| 32 | |||
| 33 | =head1 NAME | ||
| 34 | |||
| 35 | Paws::AutoScaling::UpdateAutoScalingGroup - Arguments for method UpdateAutoScalingGroup on L<Paws::AutoScaling> | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | This class represents the parameters used for calling the method UpdateAutoScalingGroup on the | ||
| 40 | L<Auto Scaling|Paws::AutoScaling> service. Use the attributes of this class | ||
| 41 | as arguments to method UpdateAutoScalingGroup. | ||
| 42 | |||
| 43 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateAutoScalingGroup. | ||
| 44 | |||
| 45 | =head1 SYNOPSIS | ||
| 46 | |||
| 47 | my $autoscaling = Paws->service('AutoScaling'); | ||
| 48 | # To update the launch configuration | ||
| 49 | # This example updates the launch configuration of the specified Auto Scaling | ||
| 50 | # group. | ||
| 51 | $autoscaling->UpdateAutoScalingGroup( | ||
| 52 | 'AutoScalingGroupName' => 'my-auto-scaling-group', | ||
| 53 | 'LaunchConfigurationName' => 'new-launch-config' | ||
| 54 | ); | ||
| 55 | |||
| 56 | # To update the minimum and maximum size | ||
| 57 | # This example updates the minimum size and maximum size of the specified Auto | ||
| 58 | # Scaling group. | ||
| 59 | $autoscaling->UpdateAutoScalingGroup( | ||
| 60 | 'AutoScalingGroupName' => 'my-auto-scaling-group', | ||
| 61 | 'MaxSize' => 3, | ||
| 62 | 'MinSize' => 1 | ||
| 63 | ); | ||
| 64 | |||
| 65 | # To enable instance protection | ||
| 66 | # This example enables instance protection for the specified Auto Scaling group. | ||
| 67 | $autoscaling->UpdateAutoScalingGroup( | ||
| 68 | 'AutoScalingGroupName' => 'my-auto-scaling-group', | ||
| 69 | 'NewInstancesProtectedFromScaleIn' => 1 | ||
| 70 | ); | ||
| 71 | |||
| 72 | |||
| 73 | 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. | ||
| 74 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/autoscaling/UpdateAutoScalingGroup> | ||
| 75 | |||
| 76 | =head1 ATTRIBUTES | ||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> AutoScalingGroupName => Str | ||
| 80 | |||
| 81 | The name of the Auto Scaling group. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 AvailabilityZones => ArrayRef[Str|Undef] | ||
| 86 | |||
| 87 | One or more Availability Zones for the group. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 CapacityRebalance => Bool | ||
| 92 | |||
| 93 | Enables or disables Capacity Rebalancing. For more information, see | ||
| 94 | Amazon EC2 Auto Scaling Capacity Rebalancing | ||
| 95 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/capacity-rebalance.html) | ||
| 96 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 Context => Str | ||
| 101 | |||
| 102 | Reserved. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 DefaultCooldown => Int | ||
| 107 | |||
| 108 | The amount of time, in seconds, after a scaling activity completes | ||
| 109 | before another scaling activity can start. The default value is C<300>. | ||
| 110 | This setting applies when using simple scaling policies, but not when | ||
| 111 | using other scaling policies or scheduled scaling. For more | ||
| 112 | information, see Scaling cooldowns for Amazon EC2 Auto Scaling | ||
| 113 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) | ||
| 114 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 DesiredCapacity => Int | ||
| 119 | |||
| 120 | The desired capacity is the initial capacity of the Auto Scaling group | ||
| 121 | after this operation completes and the capacity it attempts to | ||
| 122 | maintain. This number must be greater than or equal to the minimum size | ||
| 123 | of the group and less than or equal to the maximum size of the group. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 HealthCheckGracePeriod => Int | ||
| 128 | |||
| 129 | The amount of time, in seconds, that Amazon EC2 Auto Scaling waits | ||
| 130 | before checking the health status of an EC2 instance that has come into | ||
| 131 | service. The default value is C<0>. For more information, see Health | ||
| 132 | check grace period | ||
| 133 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period) | ||
| 134 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 135 | |||
| 136 | Conditional: Required if you are adding an C<ELB> health check. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head2 HealthCheckType => Str | ||
| 141 | |||
| 142 | The service to use for the health checks. The valid values are C<EC2> | ||
| 143 | and C<ELB>. If you configure an Auto Scaling group to use C<ELB> health | ||
| 144 | checks, it considers the instance unhealthy if it fails either the EC2 | ||
| 145 | status checks or the load balancer health checks. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head2 LaunchConfigurationName => Str | ||
| 150 | |||
| 151 | The name of the launch configuration. If you specify | ||
| 152 | C<LaunchConfigurationName> in your update request, you can't specify | ||
| 153 | C<LaunchTemplate> or C<MixedInstancesPolicy>. | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | =head2 LaunchTemplate => L<Paws::AutoScaling::LaunchTemplateSpecification> | ||
| 158 | |||
| 159 | The launch template and version to use to specify the updates. If you | ||
| 160 | specify C<LaunchTemplate> in your update request, you can't specify | ||
| 161 | C<LaunchConfigurationName> or C<MixedInstancesPolicy>. | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head2 MaxInstanceLifetime => Int | ||
| 166 | |||
| 167 | The maximum amount of time, in seconds, that an instance can be in | ||
| 168 | service. The default is null. If specified, the value must be either 0 | ||
| 169 | or a number equal to or greater than 86,400 seconds (1 day). To clear a | ||
| 170 | previously set value, specify a new value of 0. For more information, | ||
| 171 | see Replacing Auto Scaling instances based on maximum instance lifetime | ||
| 172 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) | ||
| 173 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 174 | |||
| 175 | |||
| 176 | |||
| 177 | =head2 MaxSize => Int | ||
| 178 | |||
| 179 | The maximum size of the Auto Scaling group. | ||
| 180 | |||
| 181 | With a mixed instances policy that uses instance weighting, Amazon EC2 | ||
| 182 | Auto Scaling may need to go above C<MaxSize> to meet your capacity | ||
| 183 | requirements. In this event, Amazon EC2 Auto Scaling will never go | ||
| 184 | above C<MaxSize> by more than your largest instance weight (weights | ||
| 185 | that define how many units each instance contributes to the desired | ||
| 186 | capacity of the group). | ||
| 187 | |||
| 188 | |||
| 189 | |||
| 190 | =head2 MinSize => Int | ||
| 191 | |||
| 192 | The minimum size of the Auto Scaling group. | ||
| 193 | |||
| 194 | |||
| 195 | |||
| 196 | =head2 MixedInstancesPolicy => L<Paws::AutoScaling::MixedInstancesPolicy> | ||
| 197 | |||
| 198 | An embedded object that specifies a mixed instances policy. When you | ||
| 199 | make changes to an existing policy, all optional properties are left | ||
| 200 | unchanged if not specified. For more information, see Auto Scaling | ||
| 201 | groups with multiple instance types and purchase options | ||
| 202 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html) | ||
| 203 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 204 | |||
| 205 | |||
| 206 | |||
| 207 | =head2 NewInstancesProtectedFromScaleIn => Bool | ||
| 208 | |||
| 209 | Indicates whether newly launched instances are protected from | ||
| 210 | termination by Amazon EC2 Auto Scaling when scaling in. For more | ||
| 211 | information about preventing instances from terminating on scale in, | ||
| 212 | see Instance scale-in protection | ||
| 213 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) | ||
| 214 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 215 | |||
| 216 | |||
| 217 | |||
| 218 | =head2 PlacementGroup => Str | ||
| 219 | |||
| 220 | The name of an existing placement group into which to launch your | ||
| 221 | instances, if any. A placement group is a logical grouping of instances | ||
| 222 | within a single Availability Zone. You cannot specify multiple | ||
| 223 | Availability Zones and a placement group. For more information, see | ||
| 224 | Placement Groups | ||
| 225 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) | ||
| 226 | in the I<Amazon EC2 User Guide for Linux Instances>. | ||
| 227 | |||
| 228 | |||
| 229 | |||
| 230 | =head2 ServiceLinkedRoleARN => Str | ||
| 231 | |||
| 232 | The Amazon Resource Name (ARN) of the service-linked role that the Auto | ||
| 233 | Scaling group uses to call other Amazon Web Services on your behalf. | ||
| 234 | For more information, see Service-linked roles | ||
| 235 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) | ||
| 236 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 237 | |||
| 238 | |||
| 239 | |||
| 240 | =head2 TerminationPolicies => ArrayRef[Str|Undef] | ||
| 241 | |||
| 242 | A policy or a list of policies that are used to select the instances to | ||
| 243 | terminate. The policies are executed in the order that you list them. | ||
| 244 | For more information, see Controlling which Auto Scaling instances | ||
| 245 | terminate during scale in | ||
| 246 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html) | ||
| 247 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 248 | |||
| 249 | |||
| 250 | |||
| 251 | =head2 VPCZoneIdentifier => Str | ||
| 252 | |||
| 253 | A comma-separated list of subnet IDs for a virtual private cloud (VPC). | ||
| 254 | If you specify C<VPCZoneIdentifier> with C<AvailabilityZones>, the | ||
| 255 | subnets that you specify for this parameter must reside in those | ||
| 256 | Availability Zones. | ||
| 257 | |||
| 258 | |||
| 259 | |||
| 260 | |||
| 261 | =head1 SEE ALSO | ||
| 262 | |||
| 263 | This class forms part of L<Paws>, documenting arguments for method UpdateAutoScalingGroup in L<Paws::AutoScaling> | ||
| 264 | |||
| 265 | =head1 BUGS and CONTRIBUTIONS | ||
| 266 | |||
| 267 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 268 | |||
| 269 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 270 | |||
| 271 | =cut | ||
| 272 |