aws-sdk-autoscaling 1.27.0 → 1.28.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/lib/aws-sdk-autoscaling.rb +1 -1
- data/lib/aws-sdk-autoscaling/auto_scaling_group.rb +64 -40
- data/lib/aws-sdk-autoscaling/client.rb +193 -135
- data/lib/aws-sdk-autoscaling/launch_configuration.rb +110 -20
- data/lib/aws-sdk-autoscaling/resource.rb +104 -78
- data/lib/aws-sdk-autoscaling/scheduled_action.rb +1 -1
- data/lib/aws-sdk-autoscaling/types.rb +310 -162
- metadata +2 -2
@@ -769,24 +769,16 @@ module Aws::AutoScaling
|
|
769
769
|
# @!attribute [rw] launch_configuration_name
|
770
770
|
# The name of the launch configuration.
|
771
771
|
#
|
772
|
-
# For more information, see [Creating an Auto Scaling Group Using a
|
773
|
-
# Launch Configuration][1] in the *Amazon EC2 Auto Scaling User
|
774
|
-
# Guide*.
|
775
|
-
#
|
776
772
|
# If you do not specify `LaunchConfigurationName`, you must specify
|
777
773
|
# one of the following parameters: `InstanceId`, `LaunchTemplate`, or
|
778
774
|
# `MixedInstancesPolicy`.
|
779
|
-
#
|
780
|
-
#
|
781
|
-
#
|
782
|
-
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg.html
|
783
775
|
# @return [String]
|
784
776
|
#
|
785
777
|
# @!attribute [rw] launch_template
|
786
778
|
# The launch template to use to launch instances.
|
787
779
|
#
|
788
|
-
# For more information, see [
|
789
|
-
#
|
780
|
+
# For more information, see [LaunchTemplateSpecification][1] in the
|
781
|
+
# *Amazon EC2 Auto Scaling API Reference*.
|
790
782
|
#
|
791
783
|
# If you do not specify `LaunchTemplate`, you must specify one of the
|
792
784
|
# following parameters: `InstanceId`, `LaunchConfigurationName`, or
|
@@ -794,7 +786,7 @@ module Aws::AutoScaling
|
|
794
786
|
#
|
795
787
|
#
|
796
788
|
#
|
797
|
-
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/
|
789
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_LaunchTemplateSpecification.html
|
798
790
|
# @return [Types::LaunchTemplateSpecification]
|
799
791
|
#
|
800
792
|
# @!attribute [rw] mixed_instances_policy
|
@@ -804,14 +796,15 @@ module Aws::AutoScaling
|
|
804
796
|
#
|
805
797
|
# The policy includes parameters that not only define the distribution
|
806
798
|
# of On-Demand Instances and Spot Instances, the maximum price to pay
|
807
|
-
# for Spot
|
799
|
+
# for Spot Instances, and how the Auto Scaling group allocates
|
808
800
|
# instance types to fulfill On-Demand and Spot capacity, but also the
|
809
801
|
# parameters that specify the instance configuration information—the
|
810
802
|
# launch template and instance types.
|
811
803
|
#
|
812
|
-
# For more information, see [
|
813
|
-
#
|
814
|
-
#
|
804
|
+
# For more information, see [MixedInstancesPolicy][1] in the *Amazon
|
805
|
+
# EC2 Auto Scaling API Reference* and [Auto Scaling Groups with
|
806
|
+
# Multiple Instance Types and Purchase Options][2] in the *Amazon EC2
|
807
|
+
# Auto Scaling User Guide*.
|
815
808
|
#
|
816
809
|
# You must specify one of the following parameters in your request:
|
817
810
|
# `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
|
@@ -819,7 +812,8 @@ module Aws::AutoScaling
|
|
819
812
|
#
|
820
813
|
#
|
821
814
|
#
|
822
|
-
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/
|
815
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_MixedInstancesPolicy.html
|
816
|
+
# [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html
|
823
817
|
# @return [Types::MixedInstancesPolicy]
|
824
818
|
#
|
825
819
|
# @!attribute [rw] instance_id
|
@@ -928,15 +922,15 @@ module Aws::AutoScaling
|
|
928
922
|
# into service. During this time, any health check failures for the
|
929
923
|
# instance are ignored. The default value is `0`.
|
930
924
|
#
|
931
|
-
# For more information, see [Health
|
932
|
-
#
|
925
|
+
# For more information, see [Health Check Grace Period][1] in the
|
926
|
+
# *Amazon EC2 Auto Scaling User Guide*.
|
933
927
|
#
|
934
928
|
# Conditional: This parameter is required if you are adding an `ELB`
|
935
929
|
# health check.
|
936
930
|
#
|
937
931
|
#
|
938
932
|
#
|
939
|
-
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
|
933
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period
|
940
934
|
# @return [Integer]
|
941
935
|
#
|
942
936
|
# @!attribute [rw] placement_group
|
@@ -1091,14 +1085,12 @@ module Aws::AutoScaling
|
|
1091
1085
|
# @return [String]
|
1092
1086
|
#
|
1093
1087
|
# @!attribute [rw] image_id
|
1094
|
-
# The ID of the Amazon Machine Image (AMI)
|
1095
|
-
#
|
1088
|
+
# The ID of the Amazon Machine Image (AMI) that was assigned during
|
1089
|
+
# registration. For more information, see [Finding an AMI][1] in the
|
1090
|
+
# *Amazon EC2 User Guide for Linux Instances*.
|
1096
1091
|
#
|
1097
1092
|
# If you do not specify `InstanceId`, you must specify `ImageId`.
|
1098
1093
|
#
|
1099
|
-
# For more information, see [Finding an AMI][1] in the *Amazon EC2
|
1100
|
-
# User Guide for Linux Instances*.
|
1101
|
-
#
|
1102
1094
|
#
|
1103
1095
|
#
|
1104
1096
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html
|
@@ -1114,30 +1106,31 @@ module Aws::AutoScaling
|
|
1114
1106
|
# @return [String]
|
1115
1107
|
#
|
1116
1108
|
# @!attribute [rw] security_groups
|
1117
|
-
#
|
1109
|
+
# A list that contains the security groups to assign to the instances
|
1110
|
+
# in the Auto Scaling group.
|
1118
1111
|
#
|
1119
|
-
#
|
1120
|
-
#
|
1121
|
-
#
|
1122
|
-
# User Guide for Linux Instances*.
|
1112
|
+
# \[EC2-VPC\] Specify the security group IDs. For more information,
|
1113
|
+
# see [Security Groups for Your VPC][1] in the *Amazon Virtual Private
|
1114
|
+
# Cloud User Guide*.
|
1123
1115
|
#
|
1124
|
-
#
|
1125
|
-
# IDs. For more information, see [
|
1126
|
-
# the *Amazon
|
1116
|
+
# \[EC2-Classic\] Specify either the security group names or the
|
1117
|
+
# security group IDs. For more information, see [Amazon EC2 Security
|
1118
|
+
# Groups][2] in the *Amazon EC2 User Guide for Linux Instances*.
|
1127
1119
|
#
|
1128
1120
|
#
|
1129
1121
|
#
|
1130
|
-
# [1]: https://docs.aws.amazon.com/
|
1131
|
-
# [2]: https://docs.aws.amazon.com/
|
1122
|
+
# [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html
|
1123
|
+
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html
|
1132
1124
|
# @return [Array<String>]
|
1133
1125
|
#
|
1134
1126
|
# @!attribute [rw] classic_link_vpc_id
|
1135
1127
|
# The ID of a ClassicLink-enabled VPC to link your EC2-Classic
|
1136
|
-
# instances to.
|
1137
|
-
# EC2
|
1138
|
-
# the *Amazon EC2 User Guide
|
1139
|
-
#
|
1140
|
-
#
|
1128
|
+
# instances to. For more information, see [ClassicLink][1] in the
|
1129
|
+
# *Amazon EC2 User Guide for Linux Instances* and [Linking EC2-Classic
|
1130
|
+
# Instances to a VPC][2] in the *Amazon EC2 Auto Scaling User Guide*.
|
1131
|
+
#
|
1132
|
+
# This parameter can only be used if you are launching EC2-Classic
|
1133
|
+
# instances.
|
1141
1134
|
#
|
1142
1135
|
#
|
1143
1136
|
#
|
@@ -1152,8 +1145,8 @@ module Aws::AutoScaling
|
|
1152
1145
|
# EC2-Classic Instances to a VPC][2] in the *Amazon EC2 Auto Scaling
|
1153
1146
|
# User Guide*.
|
1154
1147
|
#
|
1155
|
-
#
|
1156
|
-
#
|
1148
|
+
# If you specify the `ClassicLinkVPCId` parameter, you must specify
|
1149
|
+
# this parameter.
|
1157
1150
|
#
|
1158
1151
|
#
|
1159
1152
|
#
|
@@ -1162,9 +1155,9 @@ module Aws::AutoScaling
|
|
1162
1155
|
# @return [Array<String>]
|
1163
1156
|
#
|
1164
1157
|
# @!attribute [rw] user_data
|
1165
|
-
# The user data to make available to the launched EC2
|
1166
|
-
# more information, see [Instance Metadata and User
|
1167
|
-
# *Amazon EC2 User Guide for Linux Instances*.
|
1158
|
+
# The Base64-encoded user data to make available to the launched EC2
|
1159
|
+
# instances. For more information, see [Instance Metadata and User
|
1160
|
+
# Data][1] in the *Amazon EC2 User Guide for Linux Instances*.
|
1168
1161
|
#
|
1169
1162
|
#
|
1170
1163
|
#
|
@@ -1192,7 +1185,7 @@ module Aws::AutoScaling
|
|
1192
1185
|
# @return [String]
|
1193
1186
|
#
|
1194
1187
|
# @!attribute [rw] instance_type
|
1195
|
-
#
|
1188
|
+
# Specifies the instance type of the EC2 instance.
|
1196
1189
|
#
|
1197
1190
|
# For information about available instance types, see [Available
|
1198
1191
|
# Instance Types][1] in the *Amazon EC2 User Guide for Linux
|
@@ -1210,13 +1203,14 @@ module Aws::AutoScaling
|
|
1210
1203
|
# @return [String]
|
1211
1204
|
#
|
1212
1205
|
# @!attribute [rw] ramdisk_id
|
1213
|
-
# The ID of the RAM disk
|
1206
|
+
# The ID of the RAM disk to select.
|
1214
1207
|
# @return [String]
|
1215
1208
|
#
|
1216
1209
|
# @!attribute [rw] block_device_mappings
|
1217
|
-
#
|
1218
|
-
#
|
1219
|
-
# the *Amazon EC2 User
|
1210
|
+
# A block device mapping, which specifies the block devices for the
|
1211
|
+
# instance. You can specify virtual devices and EBS volumes. For more
|
1212
|
+
# information, see [Block Device Mapping][1] in the *Amazon EC2 User
|
1213
|
+
# Guide for Linux Instances*.
|
1220
1214
|
#
|
1221
1215
|
#
|
1222
1216
|
#
|
@@ -1224,8 +1218,20 @@ module Aws::AutoScaling
|
|
1224
1218
|
# @return [Array<Types::BlockDeviceMapping>]
|
1225
1219
|
#
|
1226
1220
|
# @!attribute [rw] instance_monitoring
|
1227
|
-
#
|
1228
|
-
#
|
1221
|
+
# Controls whether instances in this group are launched with detailed
|
1222
|
+
# (`true`) or basic (`false`) monitoring.
|
1223
|
+
#
|
1224
|
+
# The default value is `true` (enabled).
|
1225
|
+
#
|
1226
|
+
# When detailed monitoring is enabled, Amazon CloudWatch generates
|
1227
|
+
# metrics every minute and your account is charged a fee. When you
|
1228
|
+
# disable detailed monitoring, CloudWatch generates metrics every 5
|
1229
|
+
# minutes. For more information, see [Configure Monitoring for Auto
|
1230
|
+
# Scaling Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
1231
|
+
#
|
1232
|
+
#
|
1233
|
+
#
|
1234
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics
|
1229
1235
|
# @return [Types::InstanceMonitoring]
|
1230
1236
|
#
|
1231
1237
|
# @!attribute [rw] spot_price
|
@@ -1235,6 +1241,17 @@ module Aws::AutoScaling
|
|
1235
1241
|
# information, see [Launching Spot Instances in Your Auto Scaling
|
1236
1242
|
# Group][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
1237
1243
|
#
|
1244
|
+
# If a Spot price is set, then the Auto Scaling group will only launch
|
1245
|
+
# instances when the Spot price has been met, regardless of the
|
1246
|
+
# setting in the Auto Scaling group's `DesiredCapacity`.
|
1247
|
+
#
|
1248
|
+
# <note markdown="1"> When you change your Spot price by creating a new launch
|
1249
|
+
# configuration, running instances will continue to run as long as the
|
1250
|
+
# Spot price for those running instances is higher than the current
|
1251
|
+
# Spot market price.
|
1252
|
+
#
|
1253
|
+
# </note>
|
1254
|
+
#
|
1238
1255
|
#
|
1239
1256
|
#
|
1240
1257
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html
|
@@ -1242,14 +1259,12 @@ module Aws::AutoScaling
|
|
1242
1259
|
#
|
1243
1260
|
# @!attribute [rw] iam_instance_profile
|
1244
1261
|
# The name or the Amazon Resource Name (ARN) of the instance profile
|
1245
|
-
# associated with the IAM role for the instance.
|
1262
|
+
# associated with the IAM role for the instance. The instance profile
|
1263
|
+
# contains the IAM role.
|
1246
1264
|
#
|
1247
|
-
#
|
1248
|
-
#
|
1249
|
-
#
|
1250
|
-
# your EC2 instances to securely access other AWS resources. For more
|
1251
|
-
# information, see [IAM Role for Applications That Run on Amazon EC2
|
1252
|
-
# Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
1265
|
+
# For more information, see [IAM Role for Applications That Run on
|
1266
|
+
# Amazon EC2 Instances][1] in the *Amazon EC2 Auto Scaling User
|
1267
|
+
# Guide*.
|
1253
1268
|
#
|
1254
1269
|
#
|
1255
1270
|
#
|
@@ -1257,13 +1272,17 @@ module Aws::AutoScaling
|
|
1257
1272
|
# @return [String]
|
1258
1273
|
#
|
1259
1274
|
# @!attribute [rw] ebs_optimized
|
1260
|
-
#
|
1261
|
-
#
|
1262
|
-
#
|
1263
|
-
#
|
1264
|
-
#
|
1265
|
-
#
|
1266
|
-
#
|
1275
|
+
# Specifies whether the launch configuration is optimized for EBS I/O
|
1276
|
+
# (`true`) or not (`false`). The optimization provides dedicated
|
1277
|
+
# throughput to Amazon EBS and an optimized configuration stack to
|
1278
|
+
# provide optimal I/O performance. This optimization is not available
|
1279
|
+
# with all instance types. Additional fees are incurred when you
|
1280
|
+
# enable EBS optimization for an instance type that is not
|
1281
|
+
# EBS-optimized by default. For more information, see [Amazon
|
1282
|
+
# EBS-Optimized Instances][1] in the *Amazon EC2 User Guide for Linux
|
1283
|
+
# Instances*.
|
1284
|
+
#
|
1285
|
+
# The default value is `false`.
|
1267
1286
|
#
|
1268
1287
|
#
|
1269
1288
|
#
|
@@ -1271,18 +1290,24 @@ module Aws::AutoScaling
|
|
1271
1290
|
# @return [Boolean]
|
1272
1291
|
#
|
1273
1292
|
# @!attribute [rw] associate_public_ip_address
|
1274
|
-
#
|
1275
|
-
# (VPC)
|
1276
|
-
#
|
1277
|
-
#
|
1293
|
+
# For Auto Scaling groups that are running in a virtual private cloud
|
1294
|
+
# (VPC), specifies whether to assign a public IP address to the
|
1295
|
+
# group's instances. If you specify `true`, each instance in the Auto
|
1296
|
+
# Scaling group receives a unique public IP address. For more
|
1297
|
+
# information, see [Launching Auto Scaling Instances in a VPC][1] in
|
1298
|
+
# the *Amazon EC2 Auto Scaling User Guide*.
|
1299
|
+
#
|
1300
|
+
# If you specify this parameter, you must specify at least one subnet
|
1301
|
+
# for `VPCZoneIdentifier` when you create your group.
|
1302
|
+
#
|
1303
|
+
# <note markdown="1"> If the instance is launched into a default subnet, the default is to
|
1304
|
+
# assign a public IP address, unless you disabled the option to assign
|
1305
|
+
# a public IP address on the subnet. If the instance is launched into
|
1306
|
+
# a nondefault subnet, the default is not to assign a public IP
|
1307
|
+
# address, unless you enabled the option to assign a public IP address
|
1308
|
+
# on the subnet.
|
1278
1309
|
#
|
1279
|
-
#
|
1280
|
-
# subnet when you create your group.
|
1281
|
-
#
|
1282
|
-
# Default: If the instance is launched into a default subnet, the
|
1283
|
-
# default is to assign a public IP address. If the instance is
|
1284
|
-
# launched into a nondefault subnet, the default is not to assign a
|
1285
|
-
# public IP address.
|
1310
|
+
# </note>
|
1286
1311
|
#
|
1287
1312
|
#
|
1288
1313
|
#
|
@@ -1290,16 +1315,16 @@ module Aws::AutoScaling
|
|
1290
1315
|
# @return [Boolean]
|
1291
1316
|
#
|
1292
1317
|
# @!attribute [rw] placement_tenancy
|
1293
|
-
# The tenancy of the instance. An instance with
|
1294
|
-
#
|
1318
|
+
# The tenancy of the instance. An instance with `dedicated` tenancy
|
1319
|
+
# runs on isolated, single-tenant hardware and can only be launched
|
1295
1320
|
# into a VPC.
|
1296
1321
|
#
|
1297
|
-
# To launch
|
1322
|
+
# To launch dedicated instances into a shared tenancy VPC (a VPC with
|
1298
1323
|
# the instance placement tenancy attribute set to `default`), you must
|
1299
1324
|
# set the value of this parameter to `dedicated`.
|
1300
1325
|
#
|
1301
|
-
# If you specify `PlacementTenancy`,
|
1302
|
-
# subnet when you create your group.
|
1326
|
+
# If you specify `PlacementTenancy`, you must specify at least one
|
1327
|
+
# subnet for `VPCZoneIdentifier` when you create your group.
|
1303
1328
|
#
|
1304
1329
|
# For more information, see [Instance Placement Tenancy][1] in the
|
1305
1330
|
# *Amazon EC2 Auto Scaling User Guide*.
|
@@ -1591,12 +1616,12 @@ module Aws::AutoScaling
|
|
1591
1616
|
|
1592
1617
|
# @!attribute [rw] max_number_of_auto_scaling_groups
|
1593
1618
|
# The maximum number of groups allowed for your AWS account. The
|
1594
|
-
# default limit is 200 per
|
1619
|
+
# default limit is 200 per AWS Region.
|
1595
1620
|
# @return [Integer]
|
1596
1621
|
#
|
1597
1622
|
# @!attribute [rw] max_number_of_launch_configurations
|
1598
1623
|
# The maximum number of launch configurations allowed for your AWS
|
1599
|
-
# account. The default limit is 200 per
|
1624
|
+
# account. The default limit is 200 per AWS Region.
|
1600
1625
|
# @return [Integer]
|
1601
1626
|
#
|
1602
1627
|
# @!attribute [rw] number_of_auto_scaling_groups
|
@@ -2757,20 +2782,30 @@ module Aws::AutoScaling
|
|
2757
2782
|
# @return [Integer]
|
2758
2783
|
#
|
2759
2784
|
# @!attribute [rw] spot_allocation_strategy
|
2760
|
-
# Indicates how to allocate
|
2785
|
+
# Indicates how to allocate instances across Spot Instance pools.
|
2786
|
+
#
|
2787
|
+
# If the allocation strategy is `lowest-price`, the Auto Scaling group
|
2788
|
+
# launches instances using the Spot pools with the lowest price, and
|
2789
|
+
# evenly allocates your instances across the number of Spot pools that
|
2790
|
+
# you specify. If the allocation strategy is `capacity-optimized`, the
|
2791
|
+
# Auto Scaling group launches instances using Spot pools that are
|
2792
|
+
# optimally chosen based on the available Spot capacity.
|
2761
2793
|
#
|
2762
|
-
# The
|
2763
|
-
#
|
2764
|
-
#
|
2765
|
-
#
|
2794
|
+
# The default Spot allocation strategy for calls that you make through
|
2795
|
+
# the API, the AWS CLI, or the AWS SDKs is `lowest-price`. The default
|
2796
|
+
# Spot allocation strategy for the AWS Management Console is
|
2797
|
+
# `capacity-optimized`.
|
2798
|
+
#
|
2799
|
+
# Valid values: `lowest-price` \| `capacity-optimized`
|
2766
2800
|
# @return [String]
|
2767
2801
|
#
|
2768
2802
|
# @!attribute [rw] spot_instance_pools
|
2769
|
-
# The number of Spot pools
|
2770
|
-
# Spot pools are determined from the different instance
|
2771
|
-
# Overrides array of LaunchTemplate. The range is 1–20.
|
2772
|
-
#
|
2803
|
+
# The number of Spot Instance pools across which to allocate your Spot
|
2804
|
+
# Instances. The Spot pools are determined from the different instance
|
2805
|
+
# types in the Overrides array of LaunchTemplate. The range is 1–20.
|
2773
2806
|
# The default value is `2`.
|
2807
|
+
#
|
2808
|
+
# Valid only when the Spot allocation strategy is `lowest-price`.
|
2774
2809
|
# @return [Integer]
|
2775
2810
|
#
|
2776
2811
|
# @!attribute [rw] spot_max_price
|
@@ -2818,24 +2853,47 @@ module Aws::AutoScaling
|
|
2818
2853
|
# @return [String]
|
2819
2854
|
#
|
2820
2855
|
# @!attribute [rw] image_id
|
2821
|
-
# The ID of the Amazon Machine Image (AMI)
|
2856
|
+
# The ID of the Amazon Machine Image (AMI) to use to launch your EC2
|
2857
|
+
# instances.
|
2858
|
+
#
|
2859
|
+
# For more information, see [Finding an AMI][1] in the *Amazon EC2
|
2860
|
+
# User Guide for Linux Instances*.
|
2861
|
+
#
|
2862
|
+
#
|
2863
|
+
#
|
2864
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html
|
2822
2865
|
# @return [String]
|
2823
2866
|
#
|
2824
2867
|
# @!attribute [rw] key_name
|
2825
2868
|
# The name of the key pair.
|
2869
|
+
#
|
2870
|
+
# For more information, see [Amazon EC2 Key Pairs][1] in the *Amazon
|
2871
|
+
# EC2 User Guide for Linux Instances*.
|
2872
|
+
#
|
2873
|
+
#
|
2874
|
+
#
|
2875
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
|
2826
2876
|
# @return [String]
|
2827
2877
|
#
|
2828
2878
|
# @!attribute [rw] security_groups
|
2829
|
-
#
|
2879
|
+
# A list that contains the security groups to assign to the instances
|
2880
|
+
# in the Auto Scaling group.
|
2881
|
+
#
|
2882
|
+
# For more information, see [Security Groups for Your VPC][1] in the
|
2883
|
+
# *Amazon Virtual Private Cloud User Guide*.
|
2884
|
+
#
|
2885
|
+
#
|
2886
|
+
#
|
2887
|
+
# [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html
|
2830
2888
|
# @return [Array<String>]
|
2831
2889
|
#
|
2832
2890
|
# @!attribute [rw] classic_link_vpc_id
|
2833
2891
|
# The ID of a ClassicLink-enabled VPC to link your EC2-Classic
|
2834
|
-
# instances to.
|
2835
|
-
#
|
2836
|
-
#
|
2837
|
-
# EC2-Classic Instances to a
|
2838
|
-
# User Guide*.
|
2892
|
+
# instances to.
|
2893
|
+
#
|
2894
|
+
# For more information, see [ClassicLink][1] in the *Amazon EC2 User
|
2895
|
+
# Guide for Linux Instances* and [Linking EC2-Classic Instances to a
|
2896
|
+
# VPC][2] in the *Amazon EC2 Auto Scaling User Guide*.
|
2839
2897
|
#
|
2840
2898
|
#
|
2841
2899
|
#
|
@@ -2845,13 +2903,11 @@ module Aws::AutoScaling
|
|
2845
2903
|
#
|
2846
2904
|
# @!attribute [rw] classic_link_vpc_security_groups
|
2847
2905
|
# The IDs of one or more security groups for the VPC specified in
|
2848
|
-
# `ClassicLinkVPCId`.
|
2849
|
-
# the *Amazon EC2 User Guide for Linux Instances* and [Linking
|
2850
|
-
# EC2-Classic Instances to a VPC][2] in the *Amazon EC2 Auto Scaling
|
2851
|
-
# User Guide*.
|
2906
|
+
# `ClassicLinkVPCId`.
|
2852
2907
|
#
|
2853
|
-
#
|
2854
|
-
#
|
2908
|
+
# For more information, see [ClassicLink][1] in the *Amazon EC2 User
|
2909
|
+
# Guide for Linux Instances* and [Linking EC2-Classic Instances to a
|
2910
|
+
# VPC][2] in the *Amazon EC2 Auto Scaling User Guide*.
|
2855
2911
|
#
|
2856
2912
|
#
|
2857
2913
|
#
|
@@ -2860,11 +2916,27 @@ module Aws::AutoScaling
|
|
2860
2916
|
# @return [Array<String>]
|
2861
2917
|
#
|
2862
2918
|
# @!attribute [rw] user_data
|
2863
|
-
# The user data available to the
|
2919
|
+
# The Base64-encoded user data to make available to the launched EC2
|
2920
|
+
# instances.
|
2921
|
+
#
|
2922
|
+
# For more information, see [Instance Metadata and User Data][1] in
|
2923
|
+
# the *Amazon EC2 User Guide for Linux Instances*.
|
2924
|
+
#
|
2925
|
+
#
|
2926
|
+
#
|
2927
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
|
2864
2928
|
# @return [String]
|
2865
2929
|
#
|
2866
2930
|
# @!attribute [rw] instance_type
|
2867
2931
|
# The instance type for the instances.
|
2932
|
+
#
|
2933
|
+
# For information about available instance types, see [Available
|
2934
|
+
# Instance Types][1] in the *Amazon EC2 User Guide for Linux
|
2935
|
+
# Instances.*
|
2936
|
+
#
|
2937
|
+
#
|
2938
|
+
#
|
2939
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes
|
2868
2940
|
# @return [String]
|
2869
2941
|
#
|
2870
2942
|
# @!attribute [rw] kernel_id
|
@@ -2878,20 +2950,52 @@ module Aws::AutoScaling
|
|
2878
2950
|
# @!attribute [rw] block_device_mappings
|
2879
2951
|
# A block device mapping, which specifies the block devices for the
|
2880
2952
|
# instance.
|
2953
|
+
#
|
2954
|
+
# For more information, see [Block Device Mapping][1] in the *Amazon
|
2955
|
+
# EC2 User Guide for Linux Instances*.
|
2956
|
+
#
|
2957
|
+
#
|
2958
|
+
#
|
2959
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
|
2881
2960
|
# @return [Array<Types::BlockDeviceMapping>]
|
2882
2961
|
#
|
2883
2962
|
# @!attribute [rw] instance_monitoring
|
2884
2963
|
# Controls whether instances in this group are launched with detailed
|
2885
2964
|
# (`true`) or basic (`false`) monitoring.
|
2965
|
+
#
|
2966
|
+
# For more information, see [Configure Monitoring for Auto Scaling
|
2967
|
+
# Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
2968
|
+
#
|
2969
|
+
#
|
2970
|
+
#
|
2971
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics
|
2886
2972
|
# @return [Types::InstanceMonitoring]
|
2887
2973
|
#
|
2888
2974
|
# @!attribute [rw] spot_price
|
2889
|
-
# The price to
|
2975
|
+
# The maximum hourly price to be paid for any Spot Instance launched
|
2976
|
+
# to fulfill the request. Spot Instances are launched when the price
|
2977
|
+
# you specify exceeds the current Spot market price.
|
2978
|
+
#
|
2979
|
+
# For more information, see [Launching Spot Instances in Your Auto
|
2980
|
+
# Scaling Group][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
2981
|
+
#
|
2982
|
+
#
|
2983
|
+
#
|
2984
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html
|
2890
2985
|
# @return [String]
|
2891
2986
|
#
|
2892
2987
|
# @!attribute [rw] iam_instance_profile
|
2893
|
-
# The name or Amazon Resource Name (ARN) of the instance profile
|
2894
|
-
# associated with the IAM role for the instance.
|
2988
|
+
# The name or the Amazon Resource Name (ARN) of the instance profile
|
2989
|
+
# associated with the IAM role for the instance. The instance profile
|
2990
|
+
# contains the IAM role.
|
2991
|
+
#
|
2992
|
+
# For more information, see [IAM Role for Applications That Run on
|
2993
|
+
# Amazon EC2 Instances][1] in the *Amazon EC2 Auto Scaling User
|
2994
|
+
# Guide*.
|
2995
|
+
#
|
2996
|
+
#
|
2997
|
+
#
|
2998
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html
|
2895
2999
|
# @return [String]
|
2896
3000
|
#
|
2897
3001
|
# @!attribute [rw] created_time
|
@@ -2899,19 +3003,40 @@ module Aws::AutoScaling
|
|
2899
3003
|
# @return [Time]
|
2900
3004
|
#
|
2901
3005
|
# @!attribute [rw] ebs_optimized
|
2902
|
-
#
|
2903
|
-
# not (`false`).
|
3006
|
+
# Specifies whether the launch configuration is optimized for EBS I/O
|
3007
|
+
# (`true`) or not (`false`).
|
3008
|
+
#
|
3009
|
+
# For more information, see [Amazon EBS-Optimized Instances][1] in the
|
3010
|
+
# *Amazon EC2 User Guide for Linux Instances*.
|
3011
|
+
#
|
3012
|
+
#
|
3013
|
+
#
|
3014
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html
|
2904
3015
|
# @return [Boolean]
|
2905
3016
|
#
|
2906
3017
|
# @!attribute [rw] associate_public_ip_address
|
2907
|
-
#
|
2908
|
-
#
|
3018
|
+
# For Auto Scaling groups that are running in a VPC, specifies whether
|
3019
|
+
# to assign a public IP address to the group's instances.
|
3020
|
+
#
|
3021
|
+
# For more information, see [Launching Auto Scaling Instances in a
|
3022
|
+
# VPC][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
3023
|
+
#
|
3024
|
+
#
|
3025
|
+
#
|
3026
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
|
2909
3027
|
# @return [Boolean]
|
2910
3028
|
#
|
2911
3029
|
# @!attribute [rw] placement_tenancy
|
2912
3030
|
# The tenancy of the instance, either `default` or `dedicated`. An
|
2913
|
-
# instance with `dedicated` tenancy runs
|
3031
|
+
# instance with `dedicated` tenancy runs on isolated, single-tenant
|
2914
3032
|
# hardware and can only be launched into a VPC.
|
3033
|
+
#
|
3034
|
+
# For more information, see [Instance Placement Tenancy][1] in the
|
3035
|
+
# *Amazon EC2 Auto Scaling User Guide*.
|
3036
|
+
#
|
3037
|
+
#
|
3038
|
+
#
|
3039
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-vpc-tenancy
|
2915
3040
|
# @return [String]
|
2916
3041
|
#
|
2917
3042
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/LaunchConfiguration AWS API Documentation
|
@@ -3128,8 +3253,7 @@ module Aws::AutoScaling
|
|
3128
3253
|
|
3129
3254
|
# Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that
|
3130
3255
|
# you want to perform an action whenever it launches instances or
|
3131
|
-
#
|
3132
|
-
# DescribeLifecycleHooks.
|
3256
|
+
# terminates instances. Used in response to DescribeLifecycleHooks.
|
3133
3257
|
#
|
3134
3258
|
# @!attribute [rw] lifecycle_hook_name
|
3135
3259
|
# The name of the lifecycle hook.
|
@@ -3223,7 +3347,7 @@ module Aws::AutoScaling
|
|
3223
3347
|
# the instances launch or terminate.**
|
3224
3348
|
#
|
3225
3349
|
# 4. If you need more time, record the lifecycle action heartbeat to
|
3226
|
-
# keep the instance in a pending state using
|
3350
|
+
# keep the instance in a pending state using
|
3227
3351
|
# RecordLifecycleActionHeartbeat.
|
3228
3352
|
#
|
3229
3353
|
# 5. If you finish before the timeout period ends, complete the
|
@@ -3494,11 +3618,11 @@ module Aws::AutoScaling
|
|
3494
3618
|
# Instance Types and Purchase Options][1] in the *Amazon EC2 Auto
|
3495
3619
|
# Scaling User Guide*.
|
3496
3620
|
#
|
3497
|
-
# You can create a mixed instances policy for a new Auto Scaling group
|
3498
|
-
#
|
3499
|
-
#
|
3500
|
-
#
|
3501
|
-
#
|
3621
|
+
# You can create a mixed instances policy for a new Auto Scaling group,
|
3622
|
+
# or you can create it for an existing group by updating the group to
|
3623
|
+
# specify `MixedInstancesPolicy` as the top-level parameter instead of a
|
3624
|
+
# launch configuration or template. For more information, see
|
3625
|
+
# CreateAutoScalingGroup and UpdateAutoScalingGroup.
|
3502
3626
|
#
|
3503
3627
|
#
|
3504
3628
|
#
|
@@ -3918,18 +4042,17 @@ module Aws::AutoScaling
|
|
3918
4042
|
# @return [String]
|
3919
4043
|
#
|
3920
4044
|
# @!attribute [rw] adjustment_type
|
3921
|
-
#
|
3922
|
-
#
|
3923
|
-
#
|
3924
|
-
# This parameter is supported if the policy type is `SimpleScaling` or
|
3925
|
-
# `StepScaling`.
|
4045
|
+
# Specifies whether the `ScalingAdjustment` parameter is an absolute
|
4046
|
+
# number or a percentage of the current capacity. The valid values are
|
4047
|
+
# `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.
|
3926
4048
|
#
|
3927
|
-
#
|
3928
|
-
#
|
4049
|
+
# Valid only if the policy type is `StepScaling` or `SimpleScaling`.
|
4050
|
+
# For more information, see [Scaling Adjustment Types][1] in the
|
4051
|
+
# *Amazon EC2 Auto Scaling User Guide*.
|
3929
4052
|
#
|
3930
4053
|
#
|
3931
4054
|
#
|
3932
|
-
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-
|
4055
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
|
3933
4056
|
# @return [String]
|
3934
4057
|
#
|
3935
4058
|
# @!attribute [rw] min_adjustment_step
|
@@ -3943,28 +4066,38 @@ module Aws::AutoScaling
|
|
3943
4066
|
# changes the `DesiredCapacity` of the Auto Scaling group by at least
|
3944
4067
|
# this many instances. Otherwise, the error is `ValidationError`.
|
3945
4068
|
#
|
3946
|
-
# This
|
3947
|
-
#
|
4069
|
+
# This property replaces the `MinAdjustmentStep` property. For
|
4070
|
+
# example, suppose that you create a step scaling policy to scale out
|
4071
|
+
# an Auto Scaling group by 25 percent and you specify a
|
4072
|
+
# `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the
|
4073
|
+
# scaling policy is performed, 25 percent of 4 is 1. However, because
|
4074
|
+
# you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto
|
4075
|
+
# Scaling scales out the group by 2 instances.
|
4076
|
+
#
|
4077
|
+
# Valid only if the policy type is `SimpleScaling` or `StepScaling`.
|
3948
4078
|
# @return [Integer]
|
3949
4079
|
#
|
3950
4080
|
# @!attribute [rw] scaling_adjustment
|
3951
|
-
# The amount by which
|
3952
|
-
#
|
3953
|
-
#
|
3954
|
-
#
|
3955
|
-
#
|
3956
|
-
#
|
4081
|
+
# The amount by which a simple scaling policy scales the Auto Scaling
|
4082
|
+
# group in response to an alarm breach. The adjustment is based on the
|
4083
|
+
# value that you specified in the `AdjustmentType` parameter (either
|
4084
|
+
# an absolute number or a percentage). A positive value adds to the
|
4085
|
+
# current capacity and a negative value subtracts from the current
|
4086
|
+
# capacity. For exact capacity, you must specify a positive value.
|
4087
|
+
#
|
4088
|
+
# Conditional: If you specify `SimpleScaling` for the policy type, you
|
4089
|
+
# must specify this parameter. (Not used with any other policy type.)
|
3957
4090
|
# @return [Integer]
|
3958
4091
|
#
|
3959
4092
|
# @!attribute [rw] cooldown
|
3960
4093
|
# The amount of time, in seconds, after a scaling activity completes
|
3961
|
-
#
|
3962
|
-
# not specified, the default cooldown period for the
|
3963
|
-
#
|
3964
|
-
# This parameter is supported if the policy type is `SimpleScaling`.
|
4094
|
+
# before any further dynamic scaling activities can start. If this
|
4095
|
+
# parameter is not specified, the default cooldown period for the
|
4096
|
+
# group applies.
|
3965
4097
|
#
|
3966
|
-
#
|
3967
|
-
#
|
4098
|
+
# Valid only if the policy type is `SimpleScaling`. For more
|
4099
|
+
# information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
|
4100
|
+
# Scaling User Guide*.
|
3968
4101
|
#
|
3969
4102
|
#
|
3970
4103
|
#
|
@@ -3976,15 +4109,15 @@ module Aws::AutoScaling
|
|
3976
4109
|
# are `Minimum`, `Maximum`, and `Average`. If the aggregation type is
|
3977
4110
|
# null, the value is treated as `Average`.
|
3978
4111
|
#
|
3979
|
-
#
|
4112
|
+
# Valid only if the policy type is `StepScaling`.
|
3980
4113
|
# @return [String]
|
3981
4114
|
#
|
3982
4115
|
# @!attribute [rw] step_adjustments
|
3983
4116
|
# A set of adjustments that enable you to scale based on the size of
|
3984
4117
|
# the alarm breach.
|
3985
4118
|
#
|
3986
|
-
# Conditional:
|
3987
|
-
#
|
4119
|
+
# Conditional: If you specify `StepScaling` for the policy type, you
|
4120
|
+
# must specify this parameter. (Not used with any other policy type.)
|
3988
4121
|
# @return [Array<Types::StepAdjustment>]
|
3989
4122
|
#
|
3990
4123
|
# @!attribute [rw] estimated_instance_warmup
|
@@ -3992,7 +4125,7 @@ module Aws::AutoScaling
|
|
3992
4125
|
# contribute to the CloudWatch metrics. The default is to use the
|
3993
4126
|
# value specified for the default cooldown period for the group.
|
3994
4127
|
#
|
3995
|
-
#
|
4128
|
+
# Valid only if the policy type is `StepScaling` or
|
3996
4129
|
# `TargetTrackingScaling`.
|
3997
4130
|
# @return [Integer]
|
3998
4131
|
#
|
@@ -4000,8 +4133,16 @@ module Aws::AutoScaling
|
|
4000
4133
|
# A target tracking scaling policy. Includes support for predefined or
|
4001
4134
|
# customized metrics.
|
4002
4135
|
#
|
4003
|
-
#
|
4004
|
-
#
|
4136
|
+
# For more information, see [TargetTrackingConfiguration][1] in the
|
4137
|
+
# *Amazon EC2 Auto Scaling API Reference*.
|
4138
|
+
#
|
4139
|
+
# Conditional: If you specify `TargetTrackingScaling` for the policy
|
4140
|
+
# type, you must specify this parameter. (Not used with any other
|
4141
|
+
# policy type.)
|
4142
|
+
#
|
4143
|
+
#
|
4144
|
+
#
|
4145
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html
|
4005
4146
|
# @return [Types::TargetTrackingConfiguration]
|
4006
4147
|
#
|
4007
4148
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PutScalingPolicyType AWS API Documentation
|
@@ -4046,7 +4187,7 @@ module Aws::AutoScaling
|
|
4046
4187
|
# @return [String]
|
4047
4188
|
#
|
4048
4189
|
# @!attribute [rw] time
|
4049
|
-
# This parameter is
|
4190
|
+
# This parameter is no longer used.
|
4050
4191
|
# @return [Time]
|
4051
4192
|
#
|
4052
4193
|
# @!attribute [rw] start_time
|
@@ -4361,7 +4502,7 @@ module Aws::AutoScaling
|
|
4361
4502
|
# @return [String]
|
4362
4503
|
#
|
4363
4504
|
# @!attribute [rw] time
|
4364
|
-
# This parameter is
|
4505
|
+
# This parameter is no longer used.
|
4365
4506
|
# @return [Time]
|
4366
4507
|
#
|
4367
4508
|
# @!attribute [rw] start_time
|
@@ -4947,19 +5088,24 @@ module Aws::AutoScaling
|
|
4947
5088
|
# `LaunchConfigurationName` in your update request, you can't specify
|
4948
5089
|
# `LaunchTemplate` or `MixedInstancesPolicy`.
|
4949
5090
|
#
|
4950
|
-
#
|
5091
|
+
# To update an Auto Scaling group with a launch configuration with
|
4951
5092
|
# `InstanceMonitoring` set to `false`, you must first disable the
|
4952
5093
|
# collection of group metrics. Otherwise, you get an error. If you
|
4953
5094
|
# have previously enabled the collection of group metrics, you can
|
4954
5095
|
# disable it using DisableMetricsCollection.
|
4955
|
-
#
|
4956
|
-
# </note>
|
4957
5096
|
# @return [String]
|
4958
5097
|
#
|
4959
5098
|
# @!attribute [rw] launch_template
|
4960
5099
|
# The launch template and version to use to specify the updates. If
|
4961
5100
|
# you specify `LaunchTemplate` in your update request, you can't
|
4962
5101
|
# specify `LaunchConfigurationName` or `MixedInstancesPolicy`.
|
5102
|
+
#
|
5103
|
+
# For more information, see [LaunchTemplateSpecification][1] in the
|
5104
|
+
# *Amazon EC2 Auto Scaling API Reference*.
|
5105
|
+
#
|
5106
|
+
#
|
5107
|
+
#
|
5108
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_LaunchTemplateSpecification.html
|
4963
5109
|
# @return [Types::LaunchTemplateSpecification]
|
4964
5110
|
#
|
4965
5111
|
# @!attribute [rw] mixed_instances_policy
|
@@ -4969,13 +5115,15 @@ module Aws::AutoScaling
|
|
4969
5115
|
# the policy that is specified. All optional parameters are left
|
4970
5116
|
# unchanged if not specified.
|
4971
5117
|
#
|
4972
|
-
# For more information, see [
|
4973
|
-
#
|
4974
|
-
#
|
5118
|
+
# For more information, see [MixedInstancesPolicy][1] in the *Amazon
|
5119
|
+
# EC2 Auto Scaling API Reference* and [Auto Scaling Groups with
|
5120
|
+
# Multiple Instance Types and Purchase Options][2] in the *Amazon EC2
|
5121
|
+
# Auto Scaling User Guide*.
|
4975
5122
|
#
|
4976
5123
|
#
|
4977
5124
|
#
|
4978
|
-
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/
|
5125
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_MixedInstancesPolicy.html
|
5126
|
+
# [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html
|
4979
5127
|
# @return [Types::MixedInstancesPolicy]
|
4980
5128
|
#
|
4981
5129
|
# @!attribute [rw] min_size
|
@@ -5025,15 +5173,15 @@ module Aws::AutoScaling
|
|
5025
5173
|
# before checking the health status of an EC2 instance that has come
|
5026
5174
|
# into service. The default value is `0`.
|
5027
5175
|
#
|
5028
|
-
# For more information, see [Health
|
5029
|
-
#
|
5176
|
+
# For more information, see [Health Check Grace Period][1] in the
|
5177
|
+
# *Amazon EC2 Auto Scaling User Guide*.
|
5030
5178
|
#
|
5031
5179
|
# Conditional: This parameter is required if you are adding an `ELB`
|
5032
5180
|
# health check.
|
5033
5181
|
#
|
5034
5182
|
#
|
5035
5183
|
#
|
5036
|
-
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
|
5184
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period
|
5037
5185
|
# @return [Integer]
|
5038
5186
|
#
|
5039
5187
|
# @!attribute [rw] placement_group
|