aws-sdk-autoscaling 1.75.0 → 1.99.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +123 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-autoscaling/activity.rb +6 -2
- data/lib/aws-sdk-autoscaling/auto_scaling_group.rb +256 -130
- data/lib/aws-sdk-autoscaling/client.rb +1167 -433
- data/lib/aws-sdk-autoscaling/client_api.rb +201 -6
- data/lib/aws-sdk-autoscaling/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-autoscaling/endpoint_provider.rb +57 -0
- data/lib/aws-sdk-autoscaling/endpoints.rb +926 -0
- data/lib/aws-sdk-autoscaling/errors.rb +16 -0
- data/lib/aws-sdk-autoscaling/instance.rb +41 -17
- data/lib/aws-sdk-autoscaling/launch_configuration.rb +29 -35
- data/lib/aws-sdk-autoscaling/lifecycle_hook.rb +54 -46
- data/lib/aws-sdk-autoscaling/load_balancer.rb +15 -5
- data/lib/aws-sdk-autoscaling/notification_configuration.rb +12 -4
- data/lib/aws-sdk-autoscaling/plugins/endpoints.rb +198 -0
- data/lib/aws-sdk-autoscaling/resource.rb +223 -162
- data/lib/aws-sdk-autoscaling/scaling_policy.rb +12 -4
- data/lib/aws-sdk-autoscaling/scheduled_action.rb +10 -4
- data/lib/aws-sdk-autoscaling/tag.rb +18 -6
- data/lib/aws-sdk-autoscaling/types.rb +1479 -2513
- data/lib/aws-sdk-autoscaling.rb +5 -1
- metadata +8 -4
@@ -107,6 +107,11 @@ module Aws::AutoScaling
|
|
107
107
|
# min: 1,
|
108
108
|
# max: 1,
|
109
109
|
# },
|
110
|
+
# network_bandwidth_gbps: {
|
111
|
+
# min: 1.0,
|
112
|
+
# max: 1.0,
|
113
|
+
# },
|
114
|
+
# allowed_instance_types: ["AllowedInstanceType"],
|
110
115
|
# },
|
111
116
|
# },
|
112
117
|
# ],
|
@@ -139,7 +144,7 @@ module Aws::AutoScaling
|
|
139
144
|
# {
|
140
145
|
# lifecycle_hook_name: "AsciiStringMaxLen255", # required
|
141
146
|
# lifecycle_transition: "LifecycleTransition", # required
|
142
|
-
# notification_metadata: "
|
147
|
+
# notification_metadata: "AnyPrintableAsciiStringMaxLen4000",
|
143
148
|
# heartbeat_timeout: 1,
|
144
149
|
# default_result: "LifecycleActionResult",
|
145
150
|
# notification_target_arn: "NotificationTargetResourceName",
|
@@ -159,11 +164,25 @@ module Aws::AutoScaling
|
|
159
164
|
# max_instance_lifetime: 1,
|
160
165
|
# context: "Context",
|
161
166
|
# desired_capacity_type: "XmlStringMaxLen255",
|
167
|
+
# default_instance_warmup: 1,
|
168
|
+
# traffic_sources: [
|
169
|
+
# {
|
170
|
+
# identifier: "XmlStringMaxLen511", # required
|
171
|
+
# type: "XmlStringMaxLen511",
|
172
|
+
# },
|
173
|
+
# ],
|
162
174
|
# })
|
163
175
|
# @param [Hash] options ({})
|
164
176
|
# @option options [required, String] :auto_scaling_group_name
|
165
177
|
# The name of the Auto Scaling group. This name must be unique per
|
166
178
|
# Region per account.
|
179
|
+
#
|
180
|
+
# The name can contain any ASCII character 33 to 126 including most
|
181
|
+
# punctuation characters, digits, and upper and lowercased letters.
|
182
|
+
#
|
183
|
+
# <note markdown="1"> You cannot use a colon (:) in the name.
|
184
|
+
#
|
185
|
+
# </note>
|
167
186
|
# @option options [String] :launch_configuration_name
|
168
187
|
# The name of the launch configuration to use to launch instances.
|
169
188
|
#
|
@@ -171,7 +190,7 @@ module Aws::AutoScaling
|
|
171
190
|
# (`LaunchTemplate` or `MixedInstancesPolicy`) or a launch configuration
|
172
191
|
# (`LaunchConfigurationName` or `InstanceId`).
|
173
192
|
# @option options [Types::LaunchTemplateSpecification] :launch_template
|
174
|
-
#
|
193
|
+
# Information used to specify the launch template and version to use to
|
175
194
|
# launch instances.
|
176
195
|
#
|
177
196
|
# Conditional: You must specify either a launch template
|
@@ -189,11 +208,9 @@ module Aws::AutoScaling
|
|
189
208
|
#
|
190
209
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html
|
191
210
|
# @option options [Types::MixedInstancesPolicy] :mixed_instances_policy
|
192
|
-
#
|
193
|
-
#
|
194
|
-
#
|
195
|
-
# types and purchase options][1] in the *Amazon EC2 Auto Scaling User
|
196
|
-
# Guide*.
|
211
|
+
# The mixed instances policy. For more information, see [Auto Scaling
|
212
|
+
# groups with multiple instance types and purchase options][1] in the
|
213
|
+
# *Amazon EC2 Auto Scaling User Guide*.
|
197
214
|
#
|
198
215
|
#
|
199
216
|
#
|
@@ -232,45 +249,50 @@ module Aws::AutoScaling
|
|
232
249
|
# specify a desired capacity, the default is the minimum size of the
|
233
250
|
# group.
|
234
251
|
# @option options [Integer] :default_cooldown
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
252
|
+
# *Only needed if you use simple scaling policies.*
|
253
|
+
#
|
254
|
+
# The amount of time, in seconds, between one scaling activity ending
|
255
|
+
# and another one starting due to simple scaling policies. For more
|
239
256
|
# information, see [Scaling cooldowns for Amazon EC2 Auto Scaling][1] in
|
240
257
|
# the *Amazon EC2 Auto Scaling User Guide*.
|
241
258
|
#
|
259
|
+
# Default: `300` seconds
|
260
|
+
#
|
242
261
|
#
|
243
262
|
#
|
244
263
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
|
245
264
|
# @option options [Array<String>] :availability_zones
|
246
265
|
# A list of Availability Zones where instances in the Auto Scaling group
|
247
|
-
# can be created.
|
248
|
-
#
|
249
|
-
#
|
250
|
-
#
|
251
|
-
# parameter is required to launch instances into EC2-Classic.
|
266
|
+
# can be created. Used for launching into the default VPC subnet in each
|
267
|
+
# Availability Zone when not using the `VPCZoneIdentifier` property, or
|
268
|
+
# for attaching a network interface when an existing network interface
|
269
|
+
# ID is specified in a launch template.
|
252
270
|
# @option options [Array<String>] :load_balancer_names
|
253
271
|
# A list of Classic Load Balancers associated with this Auto Scaling
|
254
272
|
# group. For Application Load Balancers, Network Load Balancers, and
|
255
273
|
# Gateway Load Balancers, specify the `TargetGroupARNs` property
|
256
274
|
# instead.
|
257
275
|
# @option options [Array<String>] :target_group_arns
|
258
|
-
# The Amazon Resource Names (ARN) of the
|
259
|
-
# the Auto Scaling group. Instances are
|
260
|
-
#
|
261
|
-
#
|
262
|
-
#
|
276
|
+
# The Amazon Resource Names (ARN) of the Elastic Load Balancing target
|
277
|
+
# groups to associate with the Auto Scaling group. Instances are
|
278
|
+
# registered as targets with the target groups. The target groups
|
279
|
+
# receive incoming traffic and route requests to one or more registered
|
280
|
+
# targets. For more information, see [Use Elastic Load Balancing to
|
281
|
+
# distribute traffic across the instances in your Auto Scaling group][1]
|
282
|
+
# in the *Amazon EC2 Auto Scaling User Guide*.
|
263
283
|
#
|
264
284
|
#
|
265
285
|
#
|
266
286
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html
|
267
287
|
# @option options [String] :health_check_type
|
268
|
-
#
|
269
|
-
#
|
270
|
-
#
|
271
|
-
#
|
272
|
-
# checks
|
273
|
-
#
|
288
|
+
# A comma-separated value string of one or more health check types.
|
289
|
+
#
|
290
|
+
# The valid values are `EC2`, `ELB`, and `VPC_LATTICE`. `EC2` is the
|
291
|
+
# default health check and cannot be disabled. For more information, see
|
292
|
+
# [Health checks for Auto Scaling instances][1] in the *Amazon EC2 Auto
|
293
|
+
# Scaling User Guide*.
|
294
|
+
#
|
295
|
+
# Only specify `EC2` if you must clear a value that was previously set.
|
274
296
|
#
|
275
297
|
#
|
276
298
|
#
|
@@ -279,21 +301,26 @@ module Aws::AutoScaling
|
|
279
301
|
# The amount of time, in seconds, that Amazon EC2 Auto Scaling waits
|
280
302
|
# before checking the health status of an EC2 instance that has come
|
281
303
|
# into service and marking it unhealthy due to a failed health check.
|
282
|
-
#
|
283
|
-
#
|
304
|
+
# This is useful if your instances do not immediately pass their health
|
305
|
+
# checks after they enter the `InService` state. For more information,
|
306
|
+
# see [Set the health check grace period for an Auto Scaling group][1]
|
307
|
+
# in the *Amazon EC2 Auto Scaling User Guide*.
|
284
308
|
#
|
285
|
-
#
|
309
|
+
# Default: `0` seconds
|
286
310
|
#
|
287
311
|
#
|
288
312
|
#
|
289
|
-
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/
|
313
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html
|
290
314
|
# @option options [String] :placement_group
|
291
|
-
# The name of
|
292
|
-
#
|
293
|
-
#
|
294
|
-
#
|
295
|
-
#
|
296
|
-
#
|
315
|
+
# The name of the placement group into which to launch your instances.
|
316
|
+
# For more information, see [Placement groups][1] in the *Amazon EC2
|
317
|
+
# User Guide for Linux Instances*.
|
318
|
+
#
|
319
|
+
# <note markdown="1"> A *cluster* placement group is a logical grouping of instances within
|
320
|
+
# a single Availability Zone. You cannot specify multiple Availability
|
321
|
+
# Zones and a cluster placement group.
|
322
|
+
#
|
323
|
+
# </note>
|
297
324
|
#
|
298
325
|
#
|
299
326
|
#
|
@@ -302,21 +329,21 @@ module Aws::AutoScaling
|
|
302
329
|
# A comma-separated list of subnet IDs for a virtual private cloud (VPC)
|
303
330
|
# where instances in the Auto Scaling group can be created. If you
|
304
331
|
# specify `VPCZoneIdentifier` with `AvailabilityZones`, the subnets that
|
305
|
-
# you specify
|
306
|
-
# Zones.
|
307
|
-
#
|
308
|
-
# Conditional: If your account supports EC2-Classic and VPC, this
|
309
|
-
# parameter is required to launch instances into a VPC.
|
332
|
+
# you specify must reside in those Availability Zones.
|
310
333
|
# @option options [Array<String>] :termination_policies
|
311
334
|
# A policy or a list of policies that are used to select the instance to
|
312
335
|
# terminate. These policies are executed in the order that you list
|
313
|
-
# them. For more information, see [
|
314
|
-
#
|
315
|
-
#
|
336
|
+
# them. For more information, see [Work with Amazon EC2 Auto Scaling
|
337
|
+
# termination policies][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
338
|
+
#
|
339
|
+
# Valid values: `Default` \| `AllocationStrategy` \|
|
340
|
+
# `ClosestToNextInstanceHour` \| `NewestInstance` \| `OldestInstance` \|
|
341
|
+
# `OldestLaunchConfiguration` \| `OldestLaunchTemplate` \|
|
342
|
+
# `arn:aws:lambda:region:account-id:function:my-function:my-alias`
|
316
343
|
#
|
317
344
|
#
|
318
345
|
#
|
319
|
-
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/
|
346
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html
|
320
347
|
# @option options [Boolean] :new_instances_protected_from_scale_in
|
321
348
|
# Indicates whether newly launched instances are protected from
|
322
349
|
# termination by Amazon EC2 Auto Scaling when scaling in. For more
|
@@ -333,15 +360,16 @@ module Aws::AutoScaling
|
|
333
360
|
# EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon
|
334
361
|
# EC2 notifies that a Spot Instance is at an elevated risk of
|
335
362
|
# interruption. After launching a new instance, it then terminates an
|
336
|
-
# old instance. For more information, see [
|
337
|
-
#
|
363
|
+
# old instance. For more information, see [Use Capacity Rebalancing to
|
364
|
+
# handle Amazon EC2 Spot Interruptions][1] in the in the *Amazon EC2
|
365
|
+
# Auto Scaling User Guide*.
|
338
366
|
#
|
339
367
|
#
|
340
368
|
#
|
341
369
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html
|
342
370
|
# @option options [Array<Types::LifecycleHookSpecification>] :lifecycle_hook_specification_list
|
343
|
-
# One or more lifecycle hooks
|
344
|
-
#
|
371
|
+
# One or more lifecycle hooks to add to the Auto Scaling group before
|
372
|
+
# instances are launched.
|
345
373
|
# @option options [Array<Types::Tag>] :tags
|
346
374
|
# One or more tags. You can tag your Auto Scaling group and propagate
|
347
375
|
# the tags to the Amazon EC2 instances it launches. Tags are not
|
@@ -350,18 +378,18 @@ module Aws::AutoScaling
|
|
350
378
|
# template specifies an instance tag with a key that is also specified
|
351
379
|
# for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the
|
352
380
|
# value of that instance tag with the value specified by the Auto
|
353
|
-
# Scaling group. For more information, see [
|
354
|
-
#
|
381
|
+
# Scaling group. For more information, see [Tag Auto Scaling groups and
|
382
|
+
# instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
355
383
|
#
|
356
384
|
#
|
357
385
|
#
|
358
|
-
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/
|
386
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html
|
359
387
|
# @option options [String] :service_linked_role_arn
|
360
388
|
# The Amazon Resource Name (ARN) of the service-linked role that the
|
361
|
-
# Auto Scaling group uses to call other Amazon Web Services on
|
362
|
-
# behalf. By default, Amazon EC2 Auto Scaling uses a service-linked
|
363
|
-
# named `AWSServiceRoleForAutoScaling`, which it creates if it does
|
364
|
-
# exist. For more information, see [Service-linked roles][1] in the
|
389
|
+
# Auto Scaling group uses to call other Amazon Web Services service on
|
390
|
+
# your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked
|
391
|
+
# role named `AWSServiceRoleForAutoScaling`, which it creates if it does
|
392
|
+
# not exist. For more information, see [Service-linked roles][1] in the
|
365
393
|
# *Amazon EC2 Auto Scaling User Guide*.
|
366
394
|
#
|
367
395
|
#
|
@@ -394,9 +422,42 @@ module Aws::AutoScaling
|
|
394
422
|
#
|
395
423
|
#
|
396
424
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html
|
425
|
+
# @option options [Integer] :default_instance_warmup
|
426
|
+
# The amount of time, in seconds, until a new instance is considered to
|
427
|
+
# have finished initializing and resource consumption to become stable
|
428
|
+
# after it enters the `InService` state.
|
429
|
+
#
|
430
|
+
# During an instance refresh, Amazon EC2 Auto Scaling waits for the
|
431
|
+
# warm-up period after it replaces an instance before it moves on to
|
432
|
+
# replacing the next instance. Amazon EC2 Auto Scaling also waits for
|
433
|
+
# the warm-up period before aggregating the metrics for new instances
|
434
|
+
# with existing instances in the Amazon CloudWatch metrics that are used
|
435
|
+
# for scaling, resulting in more reliable usage data. For more
|
436
|
+
# information, see [Set the default instance warmup for an Auto Scaling
|
437
|
+
# group][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
438
|
+
#
|
439
|
+
# To manage various warm-up settings at the group level, we recommend
|
440
|
+
# that you set the default instance warmup, *even if it is set to 0
|
441
|
+
# seconds*. To remove a value that you previously set, include the
|
442
|
+
# property but specify `-1` for the value. However, we strongly
|
443
|
+
# recommend keeping the default instance warmup enabled by specifying a
|
444
|
+
# value of `0` or other nominal value.
|
445
|
+
#
|
446
|
+
# Default: None
|
447
|
+
#
|
448
|
+
#
|
449
|
+
#
|
450
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html
|
451
|
+
# @option options [Array<Types::TrafficSourceIdentifier>] :traffic_sources
|
452
|
+
# The list of traffic sources to attach to this Auto Scaling group. You
|
453
|
+
# can use any of the following as traffic sources for an Auto Scaling
|
454
|
+
# group: Classic Load Balancer, Application Load Balancer, Gateway Load
|
455
|
+
# Balancer, Network Load Balancer, and VPC Lattice.
|
397
456
|
# @return [AutoScalingGroup]
|
398
457
|
def create_group(options = {})
|
399
|
-
|
458
|
+
Aws::Plugins::UserAgent.feature('resource') do
|
459
|
+
@client.create_auto_scaling_group(options)
|
460
|
+
end
|
400
461
|
AutoScalingGroup.new(
|
401
462
|
name: options[:auto_scaling_group_name],
|
402
463
|
client: @client
|
@@ -453,64 +514,35 @@ module Aws::AutoScaling
|
|
453
514
|
# Region per account.
|
454
515
|
# @option options [String] :image_id
|
455
516
|
# The ID of the Amazon Machine Image (AMI) that was assigned during
|
456
|
-
# registration. For more information, see [Finding
|
457
|
-
# *Amazon EC2 User Guide for Linux Instances*.
|
517
|
+
# registration. For more information, see [Finding a Linux AMI][1] in
|
518
|
+
# the *Amazon EC2 User Guide for Linux Instances*.
|
458
519
|
#
|
459
|
-
# If you
|
520
|
+
# If you specify `InstanceId`, an `ImageId` is not required.
|
460
521
|
#
|
461
522
|
#
|
462
523
|
#
|
463
524
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html
|
464
525
|
# @option options [String] :key_name
|
465
|
-
# The name of the key pair. For more information, see [Amazon EC2
|
466
|
-
#
|
526
|
+
# The name of the key pair. For more information, see [Amazon EC2 key
|
527
|
+
# pairs and Linux instances][1] in the *Amazon EC2 User Guide for Linux
|
528
|
+
# Instances*.
|
467
529
|
#
|
468
530
|
#
|
469
531
|
#
|
470
532
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
|
471
533
|
# @option options [Array<String>] :security_groups
|
472
|
-
# A list that contains the security
|
473
|
-
# the Auto Scaling group.
|
474
|
-
#
|
475
|
-
#
|
476
|
-
# [Security Groups for Your VPC][1] in the *Amazon Virtual Private Cloud
|
477
|
-
# User Guide*.
|
478
|
-
#
|
479
|
-
# \[EC2-Classic\] Specify either the security group names or the
|
480
|
-
# security group IDs. For more information, see [Amazon EC2 Security
|
481
|
-
# Groups][2] in the *Amazon EC2 User Guide for Linux Instances*.
|
534
|
+
# A list that contains the security group IDs to assign to the instances
|
535
|
+
# in the Auto Scaling group. For more information, see [Control traffic
|
536
|
+
# to resources using security groups][1] in the *Amazon Virtual Private
|
537
|
+
# Cloud User Guide*.
|
482
538
|
#
|
483
539
|
#
|
484
540
|
#
|
485
541
|
# [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html
|
486
|
-
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html
|
487
542
|
# @option options [String] :classic_link_vpc_id
|
488
|
-
#
|
489
|
-
# to. For more information, see [ClassicLink][1] in the *Amazon EC2 User
|
490
|
-
# Guide for Linux Instances* and [Linking EC2-Classic instances to a
|
491
|
-
# VPC][2] in the *Amazon EC2 Auto Scaling User Guide*.
|
492
|
-
#
|
493
|
-
# This parameter can only be used if you are launching EC2-Classic
|
494
|
-
# instances.
|
495
|
-
#
|
496
|
-
#
|
497
|
-
#
|
498
|
-
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
|
499
|
-
# [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink
|
543
|
+
# Available for backward compatibility.
|
500
544
|
# @option options [Array<String>] :classic_link_vpc_security_groups
|
501
|
-
#
|
502
|
-
# ClassicLink-enabled VPC. For more information, see [ClassicLink][1] in
|
503
|
-
# the *Amazon EC2 User Guide for Linux Instances* and [Linking
|
504
|
-
# EC2-Classic instances to a VPC][2] in the *Amazon EC2 Auto Scaling
|
505
|
-
# User Guide*.
|
506
|
-
#
|
507
|
-
# If you specify the `ClassicLinkVPCId` parameter, you must specify this
|
508
|
-
# parameter.
|
509
|
-
#
|
510
|
-
#
|
511
|
-
#
|
512
|
-
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
|
513
|
-
# [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink
|
545
|
+
# Available for backward compatibility.
|
514
546
|
# @option options [String] :user_data
|
515
547
|
# The user data to make available to the launched EC2 instances. For
|
516
548
|
# more information, see [Instance metadata and user data][1] (Linux) and
|
@@ -535,31 +567,48 @@ module Aws::AutoScaling
|
|
535
567
|
# For more information, see [Creating a launch configuration using an
|
536
568
|
# EC2 instance][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
537
569
|
#
|
538
|
-
# If you do not specify `InstanceId`, you must specify both `ImageId`
|
539
|
-
# and `InstanceType`.
|
540
|
-
#
|
541
570
|
#
|
542
571
|
#
|
543
572
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html
|
544
573
|
# @option options [String] :instance_type
|
545
|
-
# Specifies the instance type of the EC2 instance.
|
546
|
-
#
|
547
|
-
#
|
548
|
-
# Instance Types][1] in the *Amazon EC2 User Guide for Linux Instances*.
|
574
|
+
# Specifies the instance type of the EC2 instance. For information about
|
575
|
+
# available instance types, see [Available instance types][1] in the
|
576
|
+
# *Amazon EC2 User Guide for Linux Instances*.
|
549
577
|
#
|
550
|
-
# If you
|
578
|
+
# If you specify `InstanceId`, an `InstanceType` is not required.
|
551
579
|
#
|
552
580
|
#
|
553
581
|
#
|
554
582
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes
|
555
583
|
# @option options [String] :kernel_id
|
556
584
|
# The ID of the kernel associated with the AMI.
|
585
|
+
#
|
586
|
+
# <note markdown="1"> We recommend that you use PV-GRUB instead of kernels and RAM disks.
|
587
|
+
# For more information, see [User provided kernels][1] in the *Amazon
|
588
|
+
# EC2 User Guide for Linux Instances*.
|
589
|
+
#
|
590
|
+
# </note>
|
591
|
+
#
|
592
|
+
#
|
593
|
+
#
|
594
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html
|
557
595
|
# @option options [String] :ramdisk_id
|
558
596
|
# The ID of the RAM disk to select.
|
597
|
+
#
|
598
|
+
# <note markdown="1"> We recommend that you use PV-GRUB instead of kernels and RAM disks.
|
599
|
+
# For more information, see [User provided kernels][1] in the *Amazon
|
600
|
+
# EC2 User Guide for Linux Instances*.
|
601
|
+
#
|
602
|
+
# </note>
|
603
|
+
#
|
604
|
+
#
|
605
|
+
#
|
606
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html
|
559
607
|
# @option options [Array<Types::BlockDeviceMapping>] :block_device_mappings
|
560
|
-
#
|
561
|
-
#
|
562
|
-
#
|
608
|
+
# The block device mapping entries that define the block devices to
|
609
|
+
# attach to the instances at launch. By default, the block devices
|
610
|
+
# specified in the block device mapping for the AMI are used. For more
|
611
|
+
# information, see [Block device mappings][1] in the *Amazon EC2 User
|
563
612
|
# Guide for Linux Instances*.
|
564
613
|
#
|
565
614
|
#
|
@@ -584,8 +633,10 @@ module Aws::AutoScaling
|
|
584
633
|
# The maximum hourly price to be paid for any Spot Instance launched to
|
585
634
|
# fulfill the request. Spot Instances are launched when the price you
|
586
635
|
# specify exceeds the current Spot price. For more information, see
|
587
|
-
# [
|
588
|
-
# Guide*.
|
636
|
+
# [Request Spot Instances for fault-tolerant and flexible
|
637
|
+
# applications][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
638
|
+
#
|
639
|
+
# Valid Range: Minimum value of 0.001
|
589
640
|
#
|
590
641
|
# <note markdown="1"> When you change your maximum price by creating a new launch
|
591
642
|
# configuration, running instances will continue to run as long as the
|
@@ -596,14 +647,13 @@ module Aws::AutoScaling
|
|
596
647
|
#
|
597
648
|
#
|
598
649
|
#
|
599
|
-
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/
|
650
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-template-spot-instances.html
|
600
651
|
# @option options [String] :iam_instance_profile
|
601
652
|
# The name or the Amazon Resource Name (ARN) of the instance profile
|
602
653
|
# associated with the IAM role for the instance. The instance profile
|
603
|
-
# contains the IAM role.
|
604
|
-
#
|
605
|
-
#
|
606
|
-
# Amazon EC2 instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
654
|
+
# contains the IAM role. For more information, see [IAM role for
|
655
|
+
# applications that run on Amazon EC2 instances][1] in the *Amazon EC2
|
656
|
+
# Auto Scaling User Guide*.
|
607
657
|
#
|
608
658
|
#
|
609
659
|
#
|
@@ -624,44 +674,39 @@ module Aws::AutoScaling
|
|
624
674
|
#
|
625
675
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html
|
626
676
|
# @option options [Boolean] :associate_public_ip_address
|
627
|
-
#
|
628
|
-
#
|
629
|
-
#
|
630
|
-
#
|
677
|
+
# Specifies whether to assign a public IPv4 address to the group's
|
678
|
+
# instances. If the instance is launched into a default subnet, the
|
679
|
+
# default is to assign a public IPv4 address, unless you disabled the
|
680
|
+
# option to assign a public IPv4 address on the subnet. If the instance
|
681
|
+
# is launched into a nondefault subnet, the default is not to assign a
|
682
|
+
# public IPv4 address, unless you enabled the option to assign a public
|
683
|
+
# IPv4 address on the subnet.
|
684
|
+
#
|
685
|
+
# If you specify `true`, each instance in the Auto Scaling group
|
686
|
+
# receives a unique public IPv4 address. For more information, see
|
631
687
|
# [Launching Auto Scaling instances in a VPC][1] in the *Amazon EC2 Auto
|
632
688
|
# Scaling User Guide*.
|
633
689
|
#
|
634
|
-
# If you specify this
|
635
|
-
#
|
636
|
-
#
|
637
|
-
# <note markdown="1"> If the instance is launched into a default subnet, the default is to
|
638
|
-
# assign a public IP address, unless you disabled the option to assign a
|
639
|
-
# public IP address on the subnet. If the instance is launched into a
|
640
|
-
# nondefault subnet, the default is not to assign a public IP address,
|
641
|
-
# unless you enabled the option to assign a public IP address on the
|
642
|
-
# subnet.
|
643
|
-
#
|
644
|
-
# </note>
|
690
|
+
# If you specify this property, you must specify at least one subnet for
|
691
|
+
# `VPCZoneIdentifier` when you create your group.
|
645
692
|
#
|
646
693
|
#
|
647
694
|
#
|
648
695
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
|
649
696
|
# @option options [String] :placement_tenancy
|
650
|
-
# The tenancy of the instance
|
651
|
-
# on isolated, single-tenant
|
652
|
-
# VPC.
|
653
|
-
#
|
654
|
-
#
|
655
|
-
#
|
656
|
-
#
|
697
|
+
# The tenancy of the instance, either `default` or `dedicated`. An
|
698
|
+
# instance with `dedicated` tenancy runs on isolated, single-tenant
|
699
|
+
# hardware and can only be launched into a VPC. To launch dedicated
|
700
|
+
# instances into a shared tenancy VPC (a VPC with the instance placement
|
701
|
+
# tenancy attribute set to `default`), you must set the value of this
|
702
|
+
# property to `dedicated`. For more information, see [Configuring
|
703
|
+
# instance tenancy with Amazon EC2 Auto Scaling][1] in the *Amazon EC2
|
704
|
+
# Auto Scaling User Guide*.
|
657
705
|
#
|
658
706
|
# If you specify `PlacementTenancy`, you must specify at least one
|
659
707
|
# subnet for `VPCZoneIdentifier` when you create your group.
|
660
708
|
#
|
661
|
-
#
|
662
|
-
# EC2 Auto Scaling][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
663
|
-
#
|
664
|
-
# Valid Values: `default` \| `dedicated`
|
709
|
+
# Valid values: `default` \| `dedicated`
|
665
710
|
#
|
666
711
|
#
|
667
712
|
#
|
@@ -676,7 +721,9 @@ module Aws::AutoScaling
|
|
676
721
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds
|
677
722
|
# @return [LaunchConfiguration]
|
678
723
|
def create_launch_configuration(options = {})
|
679
|
-
|
724
|
+
Aws::Plugins::UserAgent.feature('resource') do
|
725
|
+
@client.create_launch_configuration(options)
|
726
|
+
end
|
680
727
|
LaunchConfiguration.new(
|
681
728
|
name: options[:launch_configuration_name],
|
682
729
|
client: @client
|
@@ -695,7 +742,7 @@ module Aws::AutoScaling
|
|
695
742
|
# @param [Hash] options ({})
|
696
743
|
# @option options [Array<String>] :activity_ids
|
697
744
|
# The activity IDs of the desired scaling activities. If you omit this
|
698
|
-
#
|
745
|
+
# property, all activities for the past six weeks are described. If
|
699
746
|
# unknown activities are requested, they are ignored with no error. If
|
700
747
|
# you specify an Auto Scaling group, the results are limited to that
|
701
748
|
# group.
|
@@ -709,7 +756,9 @@ module Aws::AutoScaling
|
|
709
756
|
# @return [Activity::Collection]
|
710
757
|
def activities(options = {})
|
711
758
|
batches = Enumerator.new do |y|
|
712
|
-
resp =
|
759
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
760
|
+
@client.describe_scaling_activities(options)
|
761
|
+
end
|
713
762
|
resp.each_page do |page|
|
714
763
|
batch = []
|
715
764
|
page.data.activities.each do |a|
|
@@ -758,15 +807,17 @@ module Aws::AutoScaling
|
|
758
807
|
# @option options [Array<String>] :auto_scaling_group_names
|
759
808
|
# The names of the Auto Scaling groups. By default, you can only specify
|
760
809
|
# up to 50 names. You can optionally increase this limit using the
|
761
|
-
# `MaxRecords`
|
810
|
+
# `MaxRecords` property.
|
762
811
|
#
|
763
|
-
# If you omit this
|
812
|
+
# If you omit this property, all Auto Scaling groups are described.
|
764
813
|
# @option options [Array<Types::Filter>] :filters
|
765
814
|
# One or more filters to limit the results based on specific tags.
|
766
815
|
# @return [AutoScalingGroup::Collection]
|
767
816
|
def groups(options = {})
|
768
817
|
batches = Enumerator.new do |y|
|
769
|
-
resp =
|
818
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
819
|
+
@client.describe_auto_scaling_groups(options)
|
820
|
+
end
|
770
821
|
resp.each_page do |page|
|
771
822
|
batch = []
|
772
823
|
page.data.auto_scaling_groups.each do |a|
|
@@ -789,7 +840,7 @@ module Aws::AutoScaling
|
|
789
840
|
# })
|
790
841
|
# @param [Hash] options ({})
|
791
842
|
# @option options [Array<String>] :instance_ids
|
792
|
-
# The IDs of the instances. If you omit this
|
843
|
+
# The IDs of the instances. If you omit this property, all Auto Scaling
|
793
844
|
# instances are described. If you specify an ID that does not exist, it
|
794
845
|
# is ignored with no error.
|
795
846
|
#
|
@@ -797,7 +848,9 @@ module Aws::AutoScaling
|
|
797
848
|
# @return [Instance::Collection]
|
798
849
|
def instances(options = {})
|
799
850
|
batches = Enumerator.new do |y|
|
800
|
-
resp =
|
851
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
852
|
+
@client.describe_auto_scaling_instances(options)
|
853
|
+
end
|
801
854
|
resp.each_page do |page|
|
802
855
|
batch = []
|
803
856
|
page.data.auto_scaling_instances.each do |a|
|
@@ -830,14 +883,16 @@ module Aws::AutoScaling
|
|
830
883
|
# })
|
831
884
|
# @param [Hash] options ({})
|
832
885
|
# @option options [Array<String>] :launch_configuration_names
|
833
|
-
# The launch configuration names. If you omit this
|
886
|
+
# The launch configuration names. If you omit this property, all launch
|
834
887
|
# configurations are described.
|
835
888
|
#
|
836
889
|
# Array Members: Maximum number of 50 items.
|
837
890
|
# @return [LaunchConfiguration::Collection]
|
838
891
|
def launch_configurations(options = {})
|
839
892
|
batches = Enumerator.new do |y|
|
840
|
-
resp =
|
893
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
894
|
+
@client.describe_launch_configurations(options)
|
895
|
+
end
|
841
896
|
resp.each_page do |page|
|
842
897
|
batch = []
|
843
898
|
page.data.launch_configurations.each do |l|
|
@@ -864,7 +919,7 @@ module Aws::AutoScaling
|
|
864
919
|
# @option options [String] :auto_scaling_group_name
|
865
920
|
# The name of the Auto Scaling group.
|
866
921
|
# @option options [Array<String>] :policy_names
|
867
|
-
# The names of one or more policies. If you omit this
|
922
|
+
# The names of one or more policies. If you omit this property, all
|
868
923
|
# policies are described. If a group name is provided, the results are
|
869
924
|
# limited to that group. If you specify an unknown policy name, it is
|
870
925
|
# ignored with no error.
|
@@ -876,7 +931,9 @@ module Aws::AutoScaling
|
|
876
931
|
# @return [ScalingPolicy::Collection]
|
877
932
|
def policies(options = {})
|
878
933
|
batches = Enumerator.new do |y|
|
879
|
-
resp =
|
934
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
935
|
+
@client.describe_policies(options)
|
936
|
+
end
|
880
937
|
resp.each_page do |page|
|
881
938
|
batch = []
|
882
939
|
page.data.scaling_policies.each do |s|
|
@@ -922,21 +979,23 @@ module Aws::AutoScaling
|
|
922
979
|
# @option options [String] :auto_scaling_group_name
|
923
980
|
# The name of the Auto Scaling group.
|
924
981
|
# @option options [Array<String>] :scheduled_action_names
|
925
|
-
# The names of one or more scheduled actions. If you omit this
|
926
|
-
#
|
927
|
-
#
|
982
|
+
# The names of one or more scheduled actions. If you omit this property,
|
983
|
+
# all scheduled actions are described. If you specify an unknown
|
984
|
+
# scheduled action, it is ignored with no error.
|
928
985
|
#
|
929
986
|
# Array Members: Maximum number of 50 actions.
|
930
987
|
# @option options [Time,DateTime,Date,Integer,String] :start_time
|
931
988
|
# The earliest scheduled start time to return. If scheduled action names
|
932
|
-
# are provided, this
|
989
|
+
# are provided, this property is ignored.
|
933
990
|
# @option options [Time,DateTime,Date,Integer,String] :end_time
|
934
991
|
# The latest scheduled start time to return. If scheduled action names
|
935
|
-
# are provided, this
|
992
|
+
# are provided, this property is ignored.
|
936
993
|
# @return [ScheduledAction::Collection]
|
937
994
|
def scheduled_actions(options = {})
|
938
995
|
batches = Enumerator.new do |y|
|
939
|
-
resp =
|
996
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
997
|
+
@client.describe_scheduled_actions(options)
|
998
|
+
end
|
940
999
|
resp.each_page do |page|
|
941
1000
|
batch = []
|
942
1001
|
page.data.scheduled_update_group_actions.each do |s|
|
@@ -969,7 +1028,9 @@ module Aws::AutoScaling
|
|
969
1028
|
# @return [Tag::Collection]
|
970
1029
|
def tags(options = {})
|
971
1030
|
batches = Enumerator.new do |y|
|
972
|
-
resp =
|
1031
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
1032
|
+
@client.describe_tags(options)
|
1033
|
+
end
|
973
1034
|
resp.each_page do |page|
|
974
1035
|
batch = []
|
975
1036
|
page.data.tags.each do |t|
|