aws-sdk-autoscaling 1.27.0 → 1.28.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -37,29 +37,53 @@ module Aws::AutoScaling
37
37
  data[:launch_configuration_arn]
38
38
  end
39
39
 
40
- # The ID of the Amazon Machine Image (AMI).
40
+ # The ID of the Amazon Machine Image (AMI) to use to launch your EC2
41
+ # instances.
42
+ #
43
+ # For more information, see [Finding an AMI][1] in the *Amazon EC2 User
44
+ # Guide for Linux Instances*.
45
+ #
46
+ #
47
+ #
48
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html
41
49
  # @return [String]
42
50
  def image_id
43
51
  data[:image_id]
44
52
  end
45
53
 
46
54
  # The name of the key pair.
55
+ #
56
+ # For more information, see [Amazon EC2 Key Pairs][1] in the *Amazon EC2
57
+ # User Guide for Linux Instances*.
58
+ #
59
+ #
60
+ #
61
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
47
62
  # @return [String]
48
63
  def key_name
49
64
  data[:key_name]
50
65
  end
51
66
 
52
- # The security groups to associate with the instances.
67
+ # A list that contains the security groups to assign to the instances in
68
+ # the Auto Scaling group.
69
+ #
70
+ # For more information, see [Security Groups for Your VPC][1] in the
71
+ # *Amazon Virtual Private Cloud User Guide*.
72
+ #
73
+ #
74
+ #
75
+ # [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html
53
76
  # @return [Array<String>]
54
77
  def security_groups
55
78
  data[:security_groups]
56
79
  end
57
80
 
58
81
  # The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances
59
- # to. This parameter can only be used if you are launching EC2-Classic
60
- # instances. For more information, see [ClassicLink][1] in the *Amazon
61
- # EC2 User Guide for Linux Instances* and [Linking EC2-Classic Instances
62
- # to a VPC][2] in the *Amazon EC2 Auto Scaling User Guide*.
82
+ # to.
83
+ #
84
+ # For more information, see [ClassicLink][1] in the *Amazon EC2 User
85
+ # Guide for Linux Instances* and [Linking EC2-Classic Instances to a
86
+ # VPC][2] in the *Amazon EC2 Auto Scaling User Guide*.
63
87
  #
64
88
  #
65
89
  #
@@ -71,12 +95,11 @@ module Aws::AutoScaling
71
95
  end
72
96
 
73
97
  # The IDs of one or more security groups for the VPC specified in
74
- # `ClassicLinkVPCId`. For more information, see [ClassicLink][1] in the
75
- # *Amazon EC2 User Guide for Linux Instances* and [Linking EC2-Classic
76
- # Instances to a VPC][2] in the *Amazon EC2 Auto Scaling User Guide*.
98
+ # `ClassicLinkVPCId`.
77
99
  #
78
- # Conditional: This parameter is required if you specify a
79
- # ClassicLink-enabled VPC, and cannot be used otherwise.
100
+ # For more information, see [ClassicLink][1] in the *Amazon EC2 User
101
+ # Guide for Linux Instances* and [Linking EC2-Classic Instances to a
102
+ # VPC][2] in the *Amazon EC2 Auto Scaling User Guide*.
80
103
  #
81
104
  #
82
105
  #
@@ -87,13 +110,28 @@ module Aws::AutoScaling
87
110
  data[:classic_link_vpc_security_groups]
88
111
  end
89
112
 
90
- # The user data available to the instances.
113
+ # The Base64-encoded user data to make available to the launched EC2
114
+ # instances.
115
+ #
116
+ # For more information, see [Instance Metadata and User Data][1] in the
117
+ # *Amazon EC2 User Guide for Linux Instances*.
118
+ #
119
+ #
120
+ #
121
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
91
122
  # @return [String]
92
123
  def user_data
93
124
  data[:user_data]
94
125
  end
95
126
 
96
127
  # The instance type for the instances.
128
+ #
129
+ # For information about available instance types, see [Available
130
+ # Instance Types][1] in the *Amazon EC2 User Guide for Linux Instances.*
131
+ #
132
+ #
133
+ #
134
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes
97
135
  # @return [String]
98
136
  def instance_type
99
137
  data[:instance_type]
@@ -113,6 +151,13 @@ module Aws::AutoScaling
113
151
 
114
152
  # A block device mapping, which specifies the block devices for the
115
153
  # instance.
154
+ #
155
+ # For more information, see [Block Device Mapping][1] in the *Amazon EC2
156
+ # User Guide for Linux Instances*.
157
+ #
158
+ #
159
+ #
160
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
116
161
  # @return [Array<Types::BlockDeviceMapping>]
117
162
  def block_device_mappings
118
163
  data[:block_device_mappings]
@@ -120,19 +165,43 @@ module Aws::AutoScaling
120
165
 
121
166
  # Controls whether instances in this group are launched with detailed
122
167
  # (`true`) or basic (`false`) monitoring.
168
+ #
169
+ # For more information, see [Configure Monitoring for Auto Scaling
170
+ # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
171
+ #
172
+ #
173
+ #
174
+ # [1]: https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics
123
175
  # @return [Types::InstanceMonitoring]
124
176
  def instance_monitoring
125
177
  data[:instance_monitoring]
126
178
  end
127
179
 
128
- # The price to bid when launching Spot Instances.
180
+ # The maximum hourly price to be paid for any Spot Instance launched to
181
+ # fulfill the request. Spot Instances are launched when the price you
182
+ # specify exceeds the current Spot market price.
183
+ #
184
+ # For more information, see [Launching Spot Instances in Your Auto
185
+ # Scaling Group][1] in the *Amazon EC2 Auto Scaling User Guide*.
186
+ #
187
+ #
188
+ #
189
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html
129
190
  # @return [String]
130
191
  def spot_price
131
192
  data[:spot_price]
132
193
  end
133
194
 
134
- # The name or Amazon Resource Name (ARN) of the instance profile
135
- # associated with the IAM role for the instance.
195
+ # The name or the Amazon Resource Name (ARN) of the instance profile
196
+ # associated with the IAM role for the instance. The instance profile
197
+ # contains the IAM role.
198
+ #
199
+ # For more information, see [IAM Role for Applications That Run on
200
+ # Amazon EC2 Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
201
+ #
202
+ #
203
+ #
204
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html
136
205
  # @return [String]
137
206
  def iam_instance_profile
138
207
  data[:iam_instance_profile]
@@ -144,23 +213,44 @@ module Aws::AutoScaling
144
213
  data[:created_time]
145
214
  end
146
215
 
147
- # Controls whether the instance is optimized for EBS I/O (`true`) or not
148
- # (`false`).
216
+ # Specifies whether the launch configuration is optimized for EBS I/O
217
+ # (`true`) or not (`false`).
218
+ #
219
+ # For more information, see [Amazon EBS-Optimized Instances][1] in the
220
+ # *Amazon EC2 User Guide for Linux Instances*.
221
+ #
222
+ #
223
+ #
224
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html
149
225
  # @return [Boolean]
150
226
  def ebs_optimized
151
227
  data[:ebs_optimized]
152
228
  end
153
229
 
154
- # \[EC2-VPC\] Indicates whether to assign a public IP address to each
155
- # instance.
230
+ # For Auto Scaling groups that are running in a VPC, specifies whether
231
+ # to assign a public IP address to the group's instances.
232
+ #
233
+ # For more information, see [Launching Auto Scaling Instances in a
234
+ # VPC][1] in the *Amazon EC2 Auto Scaling User Guide*.
235
+ #
236
+ #
237
+ #
238
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
156
239
  # @return [Boolean]
157
240
  def associate_public_ip_address
158
241
  data[:associate_public_ip_address]
159
242
  end
160
243
 
161
244
  # The tenancy of the instance, either `default` or `dedicated`. An
162
- # instance with `dedicated` tenancy runs in an isolated, single-tenant
245
+ # instance with `dedicated` tenancy runs on isolated, single-tenant
163
246
  # hardware and can only be launched into a VPC.
247
+ #
248
+ # For more information, see [Instance Placement Tenancy][1] in the
249
+ # *Amazon EC2 Auto Scaling User Guide*.
250
+ #
251
+ #
252
+ #
253
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-vpc-tenancy
164
254
  # @return [String]
165
255
  def placement_tenancy
166
256
  data[:placement_tenancy]
@@ -96,21 +96,14 @@ module Aws::AutoScaling
96
96
  # @option options [String] :launch_configuration_name
97
97
  # The name of the launch configuration.
98
98
  #
99
- # For more information, see [Creating an Auto Scaling Group Using a
100
- # Launch Configuration][1] in the *Amazon EC2 Auto Scaling User Guide*.
101
- #
102
99
  # If you do not specify `LaunchConfigurationName`, you must specify one
103
100
  # of the following parameters: `InstanceId`, `LaunchTemplate`, or
104
101
  # `MixedInstancesPolicy`.
105
- #
106
- #
107
- #
108
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg.html
109
102
  # @option options [Types::LaunchTemplateSpecification] :launch_template
110
103
  # The launch template to use to launch instances.
111
104
  #
112
- # For more information, see [Creating an Auto Scaling Group Using a
113
- # Launch Template][1] in the *Amazon EC2 Auto Scaling User Guide*.
105
+ # For more information, see [LaunchTemplateSpecification][1] in the
106
+ # *Amazon EC2 Auto Scaling API Reference*.
114
107
  #
115
108
  # If you do not specify `LaunchTemplate`, you must specify one of the
116
109
  # following parameters: `InstanceId`, `LaunchConfigurationName`, or
@@ -118,7 +111,7 @@ module Aws::AutoScaling
118
111
  #
119
112
  #
120
113
  #
121
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-launch-template.html
114
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_LaunchTemplateSpecification.html
122
115
  # @option options [Types::MixedInstancesPolicy] :mixed_instances_policy
123
116
  # An embedded object that specifies a mixed instances policy. The
124
117
  # required parameters must be specified. If optional parameters are
@@ -126,14 +119,15 @@ module Aws::AutoScaling
126
119
  #
127
120
  # The policy includes parameters that not only define the distribution
128
121
  # of On-Demand Instances and Spot Instances, the maximum price to pay
129
- # for Spot instances, and how the Auto Scaling group allocates instance
122
+ # for Spot Instances, and how the Auto Scaling group allocates instance
130
123
  # types to fulfill On-Demand and Spot capacity, but also the parameters
131
124
  # that specify the instance configuration information—the launch
132
125
  # template and instance types.
133
126
  #
134
- # For more information, see [Auto Scaling Groups with Multiple Instance
135
- # Types and Purchase Options][1] in the *Amazon EC2 Auto Scaling User
136
- # Guide*.
127
+ # For more information, see [MixedInstancesPolicy][1] in the *Amazon EC2
128
+ # Auto Scaling API Reference* and [Auto Scaling Groups with Multiple
129
+ # Instance Types and Purchase Options][2] in the *Amazon EC2 Auto
130
+ # Scaling User Guide*.
137
131
  #
138
132
  # You must specify one of the following parameters in your request:
139
133
  # `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
@@ -141,7 +135,8 @@ module Aws::AutoScaling
141
135
  #
142
136
  #
143
137
  #
144
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html
138
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_MixedInstancesPolicy.html
139
+ # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html
145
140
  # @option options [String] :instance_id
146
141
  # The ID of the instance used to create a launch configuration for the
147
142
  # group.
@@ -229,15 +224,15 @@ module Aws::AutoScaling
229
224
  # into service. During this time, any health check failures for the
230
225
  # instance are ignored. The default value is `0`.
231
226
  #
232
- # For more information, see [Health Checks for Auto Scaling
233
- # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
227
+ # For more information, see [Health Check Grace Period][1] in the
228
+ # *Amazon EC2 Auto Scaling User Guide*.
234
229
  #
235
230
  # Conditional: This parameter is required if you are adding an `ELB`
236
231
  # health check.
237
232
  #
238
233
  #
239
234
  #
240
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
235
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period
241
236
  # @option options [String] :placement_group
242
237
  # The name of the placement group into which to launch your instances,
243
238
  # if any. A placement group is a logical grouping of instances within a
@@ -355,14 +350,12 @@ module Aws::AutoScaling
355
350
  # The name of the launch configuration. This name must be unique per
356
351
  # Region per account.
357
352
  # @option options [String] :image_id
358
- # The ID of the Amazon Machine Image (AMI) to use to launch your EC2
359
- # instances.
353
+ # The ID of the Amazon Machine Image (AMI) that was assigned during
354
+ # registration. For more information, see [Finding an AMI][1] in the
355
+ # *Amazon EC2 User Guide for Linux Instances*.
360
356
  #
361
357
  # If you do not specify `InstanceId`, you must specify `ImageId`.
362
358
  #
363
- # For more information, see [Finding an AMI][1] in the *Amazon EC2 User
364
- # Guide for Linux Instances*.
365
- #
366
359
  #
367
360
  #
368
361
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html
@@ -374,27 +367,29 @@ module Aws::AutoScaling
374
367
  #
375
368
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
376
369
  # @option options [Array<String>] :security_groups
377
- # One or more security groups with which to associate the instances.
370
+ # A list that contains the security groups to assign to the instances in
371
+ # the Auto Scaling group.
378
372
  #
379
- # If your instances are launched in EC2-Classic, you can either specify
380
- # security group names or the security group IDs. For more information,
381
- # see [Amazon EC2 Security Groups][1] in the *Amazon EC2 User Guide for
382
- # Linux Instances*.
373
+ # \[EC2-VPC\] Specify the security group IDs. For more information, see
374
+ # [Security Groups for Your VPC][1] in the *Amazon Virtual Private Cloud
375
+ # User Guide*.
383
376
  #
384
- # If your instances are launched into a VPC, specify security group IDs.
385
- # For more information, see [Security Groups for Your VPC][2] in the
386
- # *Amazon Virtual Private Cloud User Guide*.
377
+ # \[EC2-Classic\] Specify either the security group names or the
378
+ # security group IDs. For more information, see [Amazon EC2 Security
379
+ # Groups][2] in the *Amazon EC2 User Guide for Linux Instances*.
387
380
  #
388
381
  #
389
382
  #
390
- # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html
391
- # [2]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html
383
+ # [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html
384
+ # [2]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html
392
385
  # @option options [String] :classic_link_vpc_id
393
386
  # The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances
394
- # to. This parameter is supported only if you are launching EC2-Classic
395
- # instances. For more information, see [ClassicLink][1] in the *Amazon
396
- # EC2 User Guide for Linux Instances* and [Linking EC2-Classic Instances
397
- # to a VPC][2] in the *Amazon EC2 Auto Scaling User Guide*.
387
+ # to. For more information, see [ClassicLink][1] in the *Amazon EC2 User
388
+ # Guide for Linux Instances* and [Linking EC2-Classic Instances to a
389
+ # VPC][2] in the *Amazon EC2 Auto Scaling User Guide*.
390
+ #
391
+ # This parameter can only be used if you are launching EC2-Classic
392
+ # instances.
398
393
  #
399
394
  #
400
395
  #
@@ -407,17 +402,17 @@ module Aws::AutoScaling
407
402
  # EC2-Classic Instances to a VPC][2] in the *Amazon EC2 Auto Scaling
408
403
  # User Guide*.
409
404
  #
410
- # Conditional: This parameter is required if you specify a
411
- # ClassicLink-enabled VPC, and is not supported otherwise.
405
+ # If you specify the `ClassicLinkVPCId` parameter, you must specify this
406
+ # parameter.
412
407
  #
413
408
  #
414
409
  #
415
410
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
416
411
  # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink
417
412
  # @option options [String] :user_data
418
- # The user data to make available to the launched EC2 instances. For
419
- # more information, see [Instance Metadata and User Data][1] in the
420
- # *Amazon EC2 User Guide for Linux Instances*.
413
+ # The Base64-encoded user data to make available to the launched EC2
414
+ # instances. For more information, see [Instance Metadata and User
415
+ # Data][1] in the *Amazon EC2 User Guide for Linux Instances*.
421
416
  #
422
417
  #
423
418
  #
@@ -441,7 +436,7 @@ module Aws::AutoScaling
441
436
  #
442
437
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html
443
438
  # @option options [String] :instance_type
444
- # The instance type of the EC2 instance.
439
+ # Specifies the instance type of the EC2 instance.
445
440
  #
446
441
  # For information about available instance types, see [Available
447
442
  # Instance Types][1] in the *Amazon EC2 User Guide for Linux Instances.*
@@ -454,18 +449,31 @@ module Aws::AutoScaling
454
449
  # @option options [String] :kernel_id
455
450
  # The ID of the kernel associated with the AMI.
456
451
  # @option options [String] :ramdisk_id
457
- # The ID of the RAM disk associated with the AMI.
452
+ # The ID of the RAM disk to select.
458
453
  # @option options [Array<Types::BlockDeviceMapping>] :block_device_mappings
459
- # One or more mappings that specify how block devices are exposed to the
460
- # instance. For more information, see [Block Device Mapping][1] in the
461
- # *Amazon EC2 User Guide for Linux Instances*.
454
+ # A block device mapping, which specifies the block devices for the
455
+ # instance. You can specify virtual devices and EBS volumes. For more
456
+ # information, see [Block Device Mapping][1] in the *Amazon EC2 User
457
+ # Guide for Linux Instances*.
462
458
  #
463
459
  #
464
460
  #
465
461
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
466
462
  # @option options [Types::InstanceMonitoring] :instance_monitoring
467
- # Enables detailed monitoring (`true`) or basic monitoring (`false`) for
468
- # the Auto Scaling instances. The default value is `true`.
463
+ # Controls whether instances in this group are launched with detailed
464
+ # (`true`) or basic (`false`) monitoring.
465
+ #
466
+ # The default value is `true` (enabled).
467
+ #
468
+ # When detailed monitoring is enabled, Amazon CloudWatch generates
469
+ # metrics every minute and your account is charged a fee. When you
470
+ # disable detailed monitoring, CloudWatch generates metrics every 5
471
+ # minutes. For more information, see [Configure Monitoring for Auto
472
+ # Scaling Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
473
+ #
474
+ #
475
+ #
476
+ # [1]: https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics
469
477
  # @option options [String] :spot_price
470
478
  # The maximum hourly price to be paid for any Spot Instance launched to
471
479
  # fulfill the request. Spot Instances are launched when the price you
@@ -473,62 +481,80 @@ module Aws::AutoScaling
473
481
  # see [Launching Spot Instances in Your Auto Scaling Group][1] in the
474
482
  # *Amazon EC2 Auto Scaling User Guide*.
475
483
  #
484
+ # If a Spot price is set, then the Auto Scaling group will only launch
485
+ # instances when the Spot price has been met, regardless of the setting
486
+ # in the Auto Scaling group's `DesiredCapacity`.
487
+ #
488
+ # <note markdown="1"> When you change your Spot price by creating a new launch
489
+ # configuration, running instances will continue to run as long as the
490
+ # Spot price for those running instances is higher than the current Spot
491
+ # market price.
492
+ #
493
+ # </note>
494
+ #
476
495
  #
477
496
  #
478
497
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html
479
498
  # @option options [String] :iam_instance_profile
480
499
  # The name or the Amazon Resource Name (ARN) of the instance profile
481
- # associated with the IAM role for the instance.
500
+ # associated with the IAM role for the instance. The instance profile
501
+ # contains the IAM role.
482
502
  #
483
- # EC2 instances launched with an IAM role automatically have AWS
484
- # security credentials available. You can use IAM roles with Amazon EC2
485
- # Auto Scaling to automatically enable applications running on your EC2
486
- # instances to securely access other AWS resources. For more
487
- # information, see [IAM Role for Applications That Run on Amazon EC2
488
- # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
503
+ # For more information, see [IAM Role for Applications That Run on
504
+ # Amazon EC2 Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
489
505
  #
490
506
  #
491
507
  #
492
508
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html
493
509
  # @option options [Boolean] :ebs_optimized
494
- # Indicates whether the instance is optimized for Amazon EBS I/O. By
495
- # default, the instance is not optimized for EBS I/O. The optimization
496
- # provides dedicated throughput to Amazon EBS and an optimized
497
- # configuration stack to provide optimal I/O performance. This
498
- # optimization is not available with all instance types. Additional
499
- # usage charges apply. For more information, see [Amazon EBS-Optimized
500
- # Instances][1] in the *Amazon EC2 User Guide for Linux Instances*.
510
+ # Specifies whether the launch configuration is optimized for EBS I/O
511
+ # (`true`) or not (`false`). The optimization provides dedicated
512
+ # throughput to Amazon EBS and an optimized configuration stack to
513
+ # provide optimal I/O performance. This optimization is not available
514
+ # with all instance types. Additional fees are incurred when you enable
515
+ # EBS optimization for an instance type that is not EBS-optimized by
516
+ # default. For more information, see [Amazon EBS-Optimized Instances][1]
517
+ # in the *Amazon EC2 User Guide for Linux Instances*.
518
+ #
519
+ # The default value is `false`.
501
520
  #
502
521
  #
503
522
  #
504
523
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html
505
524
  # @option options [Boolean] :associate_public_ip_address
506
- # Used for groups that launch instances into a virtual private cloud
507
- # (VPC). Specifies whether to assign a public IP address to each
508
- # instance. For more information, see [Launching Auto Scaling Instances
509
- # in a VPC][1] in the *Amazon EC2 Auto Scaling User Guide*.
525
+ # For Auto Scaling groups that are running in a virtual private cloud
526
+ # (VPC), specifies whether to assign a public IP address to the group's
527
+ # instances. If you specify `true`, each instance in the Auto Scaling
528
+ # group receives a unique public IP address. For more information, see
529
+ # [Launching Auto Scaling Instances in a VPC][1] in the *Amazon EC2 Auto
530
+ # Scaling User Guide*.
531
+ #
532
+ # If you specify this parameter, you must specify at least one subnet
533
+ # for `VPCZoneIdentifier` when you create your group.
510
534
  #
511
- # If you specify this parameter, be sure to specify at least one subnet
512
- # when you create your group.
535
+ # <note markdown="1"> If the instance is launched into a default subnet, the default is to
536
+ # assign a public IP address, unless you disabled the option to assign a
537
+ # public IP address on the subnet. If the instance is launched into a
538
+ # nondefault subnet, the default is not to assign a public IP address,
539
+ # unless you enabled the option to assign a public IP address on the
540
+ # subnet.
513
541
  #
514
- # Default: If the instance is launched into a default subnet, the
515
- # default is to assign a public IP address. If the instance is launched
516
- # into a nondefault subnet, the default is not to assign a public IP
517
- # address.
542
+ # </note>
518
543
  #
519
544
  #
520
545
  #
521
546
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
522
547
  # @option options [String] :placement_tenancy
523
- # The tenancy of the instance. An instance with a tenancy of `dedicated`
524
- # runs on single-tenant hardware and can only be launched into a VPC.
548
+ # The tenancy of the instance. An instance with `dedicated` tenancy runs
549
+ # on isolated, single-tenant hardware and can only be launched into a
550
+ # VPC.
525
551
  #
526
- # To launch Dedicated Instances into a shared tenancy VPC (a VPC with
552
+ # To launch dedicated instances into a shared tenancy VPC (a VPC with
527
553
  # the instance placement tenancy attribute set to `default`), you must
528
554
  # set the value of this parameter to `dedicated`.
529
555
  #
530
- # If you specify `PlacementTenancy`, be sure to specify at least one
531
- # subnet when you create your group.
556
+ # If you specify `PlacementTenancy`, you must specify at least one
557
+ # subnet for `VPCZoneIdentifier` when you create your group.
532
558
  #
533
559
  # For more information, see [Instance Placement Tenancy][1] in the
534
560
  # *Amazon EC2 Auto Scaling User Guide*.