aws-sdk-autoscaling 1.110.0 → 1.112.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -55,8 +55,8 @@ module Aws::AutoScaling
55
55
 
56
56
  # The name of the key pair.
57
57
  #
58
- # For more information, see [Amazon EC2 Key Pairs][1] in the *Amazon EC2
59
- # User Guide for Linux Instances*.
58
+ # For more information, see [Amazon EC2 key pairs and Amazon EC2
59
+ # instances][1] in the *Amazon EC2 User Guide for Linux Instances*.
60
60
  #
61
61
  #
62
62
  #
@@ -67,12 +67,13 @@ module Aws::AutoScaling
67
67
  end
68
68
 
69
69
  # A list that contains the security groups to assign to the instances in
70
- # the Auto Scaling group. For more information, see [Security Groups for
71
- # Your VPC][1] in the *Amazon Virtual Private Cloud User Guide*.
70
+ # the Auto Scaling group. For more information, see [Control traffic to
71
+ # your Amazon Web Services resources using security groups][1] in the
72
+ # *Amazon Virtual Private Cloud User Guide*.
72
73
  #
73
74
  #
74
75
  #
75
- # [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html
76
+ # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-security-groups.html
76
77
  # @return [Array<String>]
77
78
  def security_groups
78
79
  data[:security_groups]
@@ -133,7 +134,7 @@ module Aws::AutoScaling
133
134
  # The block device mapping entries that define the block devices to
134
135
  # attach to the instances at launch. By default, the block devices
135
136
  # specified in the block device mapping for the AMI are used. For more
136
- # information, see [Block Device Mapping][1] in the *Amazon EC2 User
137
+ # information, see [Block device mappings][1] in the *Amazon EC2 User
137
138
  # Guide for Linux Instances*.
138
139
  #
139
140
  #
@@ -147,8 +148,8 @@ module Aws::AutoScaling
147
148
  # Controls whether instances in this group are launched with detailed
148
149
  # (`true`) or basic (`false`) monitoring.
149
150
  #
150
- # For more information, see [Configure Monitoring for Auto Scaling
151
- # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
151
+ # For more information, see [Configure monitoring for Auto Scaling
152
+ # instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
152
153
  #
153
154
  #
154
155
  #
@@ -161,12 +162,12 @@ module Aws::AutoScaling
161
162
  # The maximum hourly price to be paid for any Spot Instance launched to
162
163
  # fulfill the request. Spot Instances are launched when the price you
163
164
  # specify exceeds the current Spot price. For more information, see
164
- # [Requesting Spot Instances][1] in the *Amazon EC2 Auto Scaling User
165
- # Guide*.
165
+ # [Requesting Spot Instances for fault-tolerant and flexible
166
+ # applications][1] in the *Amazon EC2 Auto Scaling User Guide*.
166
167
  #
167
168
  #
168
169
  #
169
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html
170
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-template-spot-instances.html
170
171
  # @return [String]
171
172
  def spot_price
172
173
  data[:spot_price]
@@ -194,12 +195,12 @@ module Aws::AutoScaling
194
195
 
195
196
  # Specifies whether the launch configuration is optimized for EBS I/O
196
197
  # (`true`) or not (`false`). For more information, see [Amazon
197
- # EBS-Optimized Instances][1] in the *Amazon EC2 User Guide for Linux
198
+ # EBS-optimized instances][1] in the *Amazon EC2 User Guide for Linux
198
199
  # Instances*.
199
200
  #
200
201
  #
201
202
  #
202
- # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html
203
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html
203
204
  # @return [Boolean]
204
205
  def ebs_optimized
205
206
  data[:ebs_optimized]
@@ -211,9 +212,9 @@ module Aws::AutoScaling
211
212
  # option to assign a public IPv4 address on the subnet. If the instance
212
213
  # is launched into a nondefault subnet, the default is not to assign a
213
214
  # public IPv4 address, unless you enabled the option to assign a public
214
- # IPv4 address on the subnet. For more information, see [Launching Auto
215
- # Scaling instances in a VPC][1] in the *Amazon EC2 Auto Scaling User
216
- # Guide*.
215
+ # IPv4 address on the subnet. For more information, see [Provide network
216
+ # connectivity for your Auto Scaling instances using Amazon VPC][1] in
217
+ # the *Amazon EC2 Auto Scaling User Guide*.
217
218
  #
218
219
  #
219
220
  #
@@ -226,20 +227,13 @@ module Aws::AutoScaling
226
227
  # The tenancy of the instance, either `default` or `dedicated`. An
227
228
  # instance with `dedicated` tenancy runs on isolated, single-tenant
228
229
  # hardware and can only be launched into a VPC.
229
- #
230
- # For more information, see [Configuring instance tenancy with Amazon
231
- # EC2 Auto Scaling][1] in the *Amazon EC2 Auto Scaling User Guide*.
232
- #
233
- #
234
- #
235
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html
236
230
  # @return [String]
237
231
  def placement_tenancy
238
232
  data[:placement_tenancy]
239
233
  end
240
234
 
241
235
  # The metadata options for the instances. For more information, see
242
- # [Configuring the Instance Metadata Options][1] in the *Amazon EC2 Auto
236
+ # [Configure the instance metadata options][1] in the *Amazon EC2 Auto
243
237
  # Scaling User Guide*.
244
238
  #
245
239
  #
@@ -203,7 +203,7 @@ module Aws::AutoScaling
203
203
  # (`LaunchConfigurationName` or `InstanceId`).
204
204
  #
205
205
  # <note markdown="1"> The launch template that is specified must be configured for use with
206
- # an Auto Scaling group. For more information, see [Creating a launch
206
+ # an Auto Scaling group. For more information, see [Create a launch
207
207
  # template for an Auto Scaling group][1] in the *Amazon EC2 Auto Scaling
208
208
  # User Guide*.
209
209
  #
@@ -225,8 +225,9 @@ module Aws::AutoScaling
225
225
  # specified, Amazon EC2 Auto Scaling uses the configuration values from
226
226
  # the specified instance to create a new launch configuration. To get
227
227
  # the instance ID, use the Amazon EC2 [DescribeInstances][1] API
228
- # operation. For more information, see [Creating an Auto Scaling group
229
- # using an EC2 instance][2] in the *Amazon EC2 Auto Scaling User Guide*.
228
+ # operation. For more information, see [Create an Auto Scaling group
229
+ # using parameters from an existing instance][2] in the *Amazon EC2 Auto
230
+ # Scaling User Guide*.
230
231
  #
231
232
  #
232
233
  #
@@ -265,7 +266,7 @@ module Aws::AutoScaling
265
266
  #
266
267
  #
267
268
  #
268
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
269
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html
269
270
  # @option options [Array<String>] :availability_zones
270
271
  # A list of Availability Zones where instances in the Auto Scaling group
271
272
  # can be created. Used for launching into the default VPC subnet in each
@@ -294,14 +295,14 @@ module Aws::AutoScaling
294
295
  #
295
296
  # The valid values are `EC2`, `ELB`, and `VPC_LATTICE`. `EC2` is the
296
297
  # default health check and cannot be disabled. For more information, see
297
- # [Health checks for Auto Scaling instances][1] in the *Amazon EC2 Auto
298
- # Scaling User Guide*.
298
+ # [Health checks for instances in an Auto Scaling group][1] in the
299
+ # *Amazon EC2 Auto Scaling User Guide*.
299
300
  #
300
301
  # Only specify `EC2` if you must clear a value that was previously set.
301
302
  #
302
303
  #
303
304
  #
304
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
305
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html
305
306
  # @option options [Integer] :health_check_grace_period
306
307
  # The amount of time, in seconds, that Amazon EC2 Auto Scaling waits
307
308
  # before checking the health status of an EC2 instance that has come
@@ -338,8 +339,9 @@ module Aws::AutoScaling
338
339
  # @option options [Array<String>] :termination_policies
339
340
  # A policy or a list of policies that are used to select the instance to
340
341
  # terminate. These policies are executed in the order that you list
341
- # them. For more information, see [Work with Amazon EC2 Auto Scaling
342
- # termination policies][1] in the *Amazon EC2 Auto Scaling User Guide*.
342
+ # them. For more information, see [Configure termination policies for
343
+ # Amazon EC2 Auto Scaling][1] in the *Amazon EC2 Auto Scaling User
344
+ # Guide*.
343
345
  #
344
346
  # Valid values: `Default` \| `AllocationStrategy` \|
345
347
  # `ClosestToNextInstanceHour` \| `NewestInstance` \| `OldestInstance` \|
@@ -353,7 +355,7 @@ module Aws::AutoScaling
353
355
  # Indicates whether newly launched instances are protected from
354
356
  # termination by Amazon EC2 Auto Scaling when scaling in. For more
355
357
  # information about preventing instances from terminating on scale in,
356
- # see [Using instance scale-in protection][1] in the *Amazon EC2 Auto
358
+ # see [Use instance scale-in protection][1] in the *Amazon EC2 Auto
357
359
  # Scaling User Guide*.
358
360
  #
359
361
  #
@@ -404,7 +406,7 @@ module Aws::AutoScaling
404
406
  # The maximum amount of time, in seconds, that an instance can be in
405
407
  # service. The default is null. If specified, the value must be either 0
406
408
  # or a number equal to or greater than 86,400 seconds (1 day). For more
407
- # information, see [Replacing Auto Scaling instances based on maximum
409
+ # information, see [Replace Auto Scaling instances based on maximum
408
410
  # instance lifetime][1] in the *Amazon EC2 Auto Scaling User Guide*.
409
411
  #
410
412
  #
@@ -416,7 +418,7 @@ module Aws::AutoScaling
416
418
  # The unit of measurement for the value specified for desired capacity.
417
419
  # Amazon EC2 Auto Scaling supports `DesiredCapacityType` for
418
420
  # attribute-based instance type selection only. For more information,
419
- # see [Creating an Auto Scaling group using attribute-based instance
421
+ # see [Create a mixed instances group using attribute-based instance
420
422
  # type selection][1] in the *Amazon EC2 Auto Scaling User Guide*.
421
423
  #
422
424
  # By default, Amazon EC2 Auto Scaling specifies `units`, which
@@ -426,7 +428,7 @@ module Aws::AutoScaling
426
428
  #
427
429
  #
428
430
  #
429
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html
431
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html
430
432
  # @option options [Integer] :default_instance_warmup
431
433
  # The amount of time, in seconds, until a new instance is considered to
432
434
  # have finished initializing and resource consumption to become stable
@@ -527,8 +529,8 @@ module Aws::AutoScaling
527
529
  # Region per account.
528
530
  # @option options [String] :image_id
529
531
  # The ID of the Amazon Machine Image (AMI) that was assigned during
530
- # registration. For more information, see [Finding a Linux AMI][1] in
531
- # the *Amazon EC2 User Guide for Linux Instances*.
532
+ # registration. For more information, see [Find a Linux AMI][1] in the
533
+ # *Amazon EC2 User Guide for Linux Instances*.
532
534
  #
533
535
  # If you specify `InstanceId`, an `ImageId` is not required.
534
536
  #
@@ -537,8 +539,8 @@ module Aws::AutoScaling
537
539
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html
538
540
  # @option options [String] :key_name
539
541
  # The name of the key pair. For more information, see [Amazon EC2 key
540
- # pairs and Linux instances][1] in the *Amazon EC2 User Guide for Linux
541
- # Instances*.
542
+ # pairs and Amazon EC2 instances][1] in the *Amazon EC2 User Guide for
543
+ # Linux Instances*.
542
544
  #
543
545
  #
544
546
  #
@@ -546,12 +548,12 @@ module Aws::AutoScaling
546
548
  # @option options [Array<String>] :security_groups
547
549
  # A list that contains the security group IDs to assign to the instances
548
550
  # in the Auto Scaling group. For more information, see [Control traffic
549
- # to resources using security groups][1] in the *Amazon Virtual Private
550
- # Cloud User Guide*.
551
+ # to your Amazon Web Services resources using security groups][1] in the
552
+ # *Amazon Virtual Private Cloud User Guide*.
551
553
  #
552
554
  #
553
555
  #
554
- # [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html
556
+ # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-security-groups.html
555
557
  # @option options [String] :classic_link_vpc_id
556
558
  # Available for backward compatibility.
557
559
  # @option options [Array<String>] :classic_link_vpc_security_groups
@@ -577,12 +579,12 @@ module Aws::AutoScaling
577
579
  # override any other instance attributes, specify them as part of the
578
580
  # same request.
579
581
  #
580
- # For more information, see [Creating a launch configuration using an
581
- # EC2 instance][1] in the *Amazon EC2 Auto Scaling User Guide*.
582
+ # For more information, see [Create a launch configuration][1] in the
583
+ # *Amazon EC2 Auto Scaling User Guide*.
582
584
  #
583
585
  #
584
586
  #
585
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html
587
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html
586
588
  # @option options [String] :instance_type
587
589
  # Specifies the instance type of the EC2 instance. For information about
588
590
  # available instance types, see [Available instance types][1] in the
@@ -636,8 +638,8 @@ module Aws::AutoScaling
636
638
  # When detailed monitoring is enabled, Amazon CloudWatch generates
637
639
  # metrics every minute and your account is charged a fee. When you
638
640
  # disable detailed monitoring, CloudWatch generates metrics every 5
639
- # minutes. For more information, see [Configure Monitoring for Auto
640
- # Scaling Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
641
+ # minutes. For more information, see [Configure monitoring for Auto
642
+ # Scaling instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
641
643
  #
642
644
  #
643
645
  #
@@ -685,7 +687,7 @@ module Aws::AutoScaling
685
687
  #
686
688
  #
687
689
  #
688
- # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html
690
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html
689
691
  # @option options [Boolean] :associate_public_ip_address
690
692
  # Specifies whether to assign a public IPv4 address to the group's
691
693
  # instances. If the instance is launched into a default subnet, the
@@ -697,8 +699,8 @@ module Aws::AutoScaling
697
699
  #
698
700
  # If you specify `true`, each instance in the Auto Scaling group
699
701
  # receives a unique public IPv4 address. For more information, see
700
- # [Launching Auto Scaling instances in a VPC][1] in the *Amazon EC2 Auto
701
- # Scaling User Guide*.
702
+ # [Provide network connectivity for your Auto Scaling instances using
703
+ # Amazon VPC][1] in the *Amazon EC2 Auto Scaling User Guide*.
702
704
  #
703
705
  # If you specify this property, you must specify at least one subnet for
704
706
  # `VPCZoneIdentifier` when you create your group.
@@ -712,21 +714,15 @@ module Aws::AutoScaling
712
714
  # hardware and can only be launched into a VPC. To launch dedicated
713
715
  # instances into a shared tenancy VPC (a VPC with the instance placement
714
716
  # tenancy attribute set to `default`), you must set the value of this
715
- # property to `dedicated`. For more information, see [Configuring
716
- # instance tenancy with Amazon EC2 Auto Scaling][1] in the *Amazon EC2
717
- # Auto Scaling User Guide*.
717
+ # property to `dedicated`.
718
718
  #
719
719
  # If you specify `PlacementTenancy`, you must specify at least one
720
720
  # subnet for `VPCZoneIdentifier` when you create your group.
721
721
  #
722
722
  # Valid values: `default` \| `dedicated`
723
- #
724
- #
725
- #
726
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html
727
723
  # @option options [Types::InstanceMetadataOptions] :metadata_options
728
724
  # The metadata options for the instances. For more information, see
729
- # [Configuring the Instance Metadata Options][1] in the *Amazon EC2 Auto
725
+ # [Configure the instance metadata options][1] in the *Amazon EC2 Auto
730
726
  # Scaling User Guide*.
731
727
  #
732
728
  #
@@ -328,7 +328,7 @@ module Aws::AutoScaling
328
328
  #
329
329
  #
330
330
  #
331
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
331
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html
332
332
  # @option options [Float] :metric_value
333
333
  # The metric value to compare to `BreachThreshold`. This enables you to
334
334
  # execute a policy of type `StepScaling` and determine which step