aws-sdk-autoscaling 1.85.0 → 1.87.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -51,8 +51,8 @@ module Aws::AutoScaling
51
51
  include Aws::Structure
52
52
  end
53
53
 
54
- # The request failed because an active instance refresh for the
55
- # specified Auto Scaling group was not found.
54
+ # The request failed because an active instance refresh or rollback for
55
+ # the specified Auto Scaling group was not found.
56
56
  #
57
57
  # @!attribute [rw] message
58
58
  # @return [String]
@@ -298,12 +298,6 @@ module Aws::AutoScaling
298
298
  # @!attribute [rw] traffic_sources
299
299
  # The unique identifiers of one or more traffic sources. You can
300
300
  # specify up to 10 traffic sources.
301
- #
302
- # Currently, you must specify an Amazon Resource Name (ARN) for an
303
- # existing VPC Lattice target group. Amazon EC2 Auto Scaling registers
304
- # the running instances with the attached target groups. The target
305
- # groups receive incoming traffic and route requests to one or more
306
- # registered targets.
307
301
  # @return [Array<Types::TrafficSourceIdentifier>]
308
302
  #
309
303
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/AttachTrafficSourcesType AWS API Documentation
@@ -372,12 +366,7 @@ module Aws::AutoScaling
372
366
  # @return [Array<String>]
373
367
  #
374
368
  # @!attribute [rw] health_check_type
375
- # Determines whether any additional health checks are performed on the
376
- # instances in this group. Amazon EC2 health checks are always on.
377
- #
378
- # The valid values are `EC2` (default), `ELB`, and `VPC_LATTICE`. The
379
- # `VPC_LATTICE` health check type is reserved for use with VPC
380
- # Lattice, which is in preview release and is subject to change.
369
+ # A comma-separated list of one or more health check types.
381
370
  # @return [String]
382
371
  #
383
372
  # @!attribute [rw] health_check_grace_period
@@ -467,7 +456,7 @@ module Aws::AutoScaling
467
456
  # @return [Integer]
468
457
  #
469
458
  # @!attribute [rw] traffic_sources
470
- # The unique identifiers of the traffic sources.
459
+ # The traffic sources associated with this Auto Scaling group.
471
460
  # @return [Array<Types::TrafficSourceIdentifier>]
472
461
  #
473
462
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/AutoScalingGroup AWS API Documentation
@@ -603,10 +592,10 @@ module Aws::AutoScaling
603
592
  # @return [String]
604
593
  #
605
594
  # @!attribute [rw] health_status
606
- # The last reported health status of this instance. "Healthy" means
595
+ # The last reported health status of this instance. `Healthy` means
607
596
  # that the instance is healthy and should remain in service.
608
- # "Unhealthy" means that the instance is unhealthy and Amazon EC2
609
- # Auto Scaling should terminate and replace it.
597
+ # `Unhealthy` means that the instance is unhealthy and Amazon EC2 Auto
598
+ # Scaling should terminate and replace it.
610
599
  # @return [String]
611
600
  #
612
601
  # @!attribute [rw] launch_configuration_name
@@ -802,7 +791,8 @@ module Aws::AutoScaling
802
791
  end
803
792
 
804
793
  # @!attribute [rw] instance_refresh_id
805
- # The instance refresh ID.
794
+ # The instance refresh ID associated with the request. This is the
795
+ # unique ID assigned to the instance refresh when it was started.
806
796
  # @return [String]
807
797
  #
808
798
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CancelInstanceRefreshAnswer AWS API Documentation
@@ -1005,7 +995,7 @@ module Aws::AutoScaling
1005
995
  # @!attribute [rw] load_balancer_names
1006
996
  # A list of Classic Load Balancers associated with this Auto Scaling
1007
997
  # group. For Application Load Balancers, Network Load Balancers, and
1008
- # Gateway Load Balancer, specify the `TargetGroupARNs` property
998
+ # Gateway Load Balancers, specify the `TargetGroupARNs` property
1009
999
  # instead.
1010
1000
  # @return [Array<String>]
1011
1001
  #
@@ -1024,14 +1014,12 @@ module Aws::AutoScaling
1024
1014
  # @return [Array<String>]
1025
1015
  #
1026
1016
  # @!attribute [rw] health_check_type
1027
- # Determines whether any additional health checks are performed on the
1028
- # instances in this group. Amazon EC2 health checks are always on. For
1029
- # more information, see [Health checks for Auto Scaling instances][1]
1030
- # in the *Amazon EC2 Auto Scaling User Guide*.
1017
+ # A comma-separated list of one or more health check types.
1031
1018
  #
1032
- # The valid values are `EC2` (default), `ELB`, and `VPC_LATTICE`. The
1033
- # `VPC_LATTICE` health check type is reserved for use with VPC
1034
- # Lattice, which is in preview release and is subject to change.
1019
+ # The valid values are `EC2`, `ELB`, and `VPC_LATTICE`. `EC2` is the
1020
+ # default health check and cannot be disabled. For more information,
1021
+ # see [Health checks for Auto Scaling instances][1] in the *Amazon EC2
1022
+ # Auto Scaling User Guide*.
1035
1023
  #
1036
1024
  #
1037
1025
  #
@@ -1191,26 +1179,25 @@ module Aws::AutoScaling
1191
1179
  # @return [String]
1192
1180
  #
1193
1181
  # @!attribute [rw] default_instance_warmup
1194
- # The amount of time, in seconds, until a newly launched instance can
1195
- # contribute to the Amazon CloudWatch metrics. This delay lets an
1196
- # instance finish initializing before Amazon EC2 Auto Scaling
1197
- # aggregates instance metrics, resulting in more reliable usage data.
1198
- # Set this value equal to the amount of time that it takes for
1199
- # resource consumption to become stable after an instance reaches the
1200
- # `InService` state. For more information, see [Set the default
1201
- # instance warmup for an Auto Scaling group][1] in the *Amazon EC2
1202
- # Auto Scaling User Guide*.
1203
- #
1204
- # To manage your warm-up settings at the group level, we recommend
1205
- # that you set the default instance warmup, *even if its value is set
1206
- # to 0 seconds*. This also optimizes the performance of scaling
1207
- # policies that scale continuously, such as target tracking and step
1208
- # scaling policies.
1182
+ # The amount of time, in seconds, until a new instance is considered
1183
+ # to have finished initializing and resource consumption to become
1184
+ # stable after it enters the `InService` state.
1185
+ #
1186
+ # During an instance refresh, Amazon EC2 Auto Scaling waits for the
1187
+ # warm-up period after it replaces an instance before it moves on to
1188
+ # replacing the next instance. Amazon EC2 Auto Scaling also waits for
1189
+ # the warm-up period before aggregating the metrics for new instances
1190
+ # with existing instances in the Amazon CloudWatch metrics that are
1191
+ # used for scaling, resulting in more reliable usage data. For more
1192
+ # information, see [Set the default instance warmup for an Auto
1193
+ # Scaling group][1] in the *Amazon EC2 Auto Scaling User Guide*.
1209
1194
  #
1210
- # If you need to remove a value that you previously set, include the
1195
+ # To manage various warm-up settings at the group level, we recommend
1196
+ # that you set the default instance warmup, *even if it is set to 0
1197
+ # seconds*. To remove a value that you previously set, include the
1211
1198
  # property but specify `-1` for the value. However, we strongly
1212
1199
  # recommend keeping the default instance warmup enabled by specifying
1213
- # a minimum value of `0`.
1200
+ # a value of `0` or other nominal value.
1214
1201
  #
1215
1202
  # Default: None
1216
1203
  #
@@ -1220,17 +1207,10 @@ module Aws::AutoScaling
1220
1207
  # @return [Integer]
1221
1208
  #
1222
1209
  # @!attribute [rw] traffic_sources
1223
- # **Reserved for use with Amazon VPC Lattice, which is in preview
1224
- # release and is subject to change. Do not use this parameter for
1225
- # production workloads. It is also subject to change.**
1226
- #
1227
- # The unique identifiers of one or more traffic sources.
1228
- #
1229
- # Currently, you must specify an Amazon Resource Name (ARN) for an
1230
- # existing VPC Lattice target group. Amazon EC2 Auto Scaling registers
1231
- # the running instances with the attached target groups. The target
1232
- # groups receive incoming traffic and route requests to one or more
1233
- # registered targets.
1210
+ # The list of traffic sources to attach to this Auto Scaling group.
1211
+ # You can use any of the following as traffic sources for an Auto
1212
+ # Scaling group: Classic Load Balancer, Application Load Balancer,
1213
+ # Gateway Load Balancer, Network Load Balancer, and VPC Lattice.
1234
1214
  # @return [Array<Types::TrafficSourceIdentifier>]
1235
1215
  #
1236
1216
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CreateAutoScalingGroupType AWS API Documentation
@@ -2267,8 +2247,16 @@ module Aws::AutoScaling
2267
2247
  # @return [String]
2268
2248
  #
2269
2249
  # @!attribute [rw] traffic_source_type
2270
- # The type of traffic source you are describing. Currently, the only
2271
- # valid value is `vpc-lattice`.
2250
+ # The traffic source type that you want to describe.
2251
+ #
2252
+ # The following lists the valid values:
2253
+ #
2254
+ # * `elb` if the traffic source is a Classic Load Balancer.
2255
+ #
2256
+ # * `elbv2` if the traffic source is a Application Load Balancer,
2257
+ # Gateway Load Balancer, or Network Load Balancer.
2258
+ #
2259
+ # * `vpc-lattice` if the traffic source is VPC Lattice.
2272
2260
  # @return [String]
2273
2261
  #
2274
2262
  # @!attribute [rw] next_token
@@ -2494,13 +2482,6 @@ module Aws::AutoScaling
2494
2482
  # @!attribute [rw] traffic_sources
2495
2483
  # The unique identifiers of one or more traffic sources you are
2496
2484
  # detaching. You can specify up to 10 traffic sources.
2497
- #
2498
- # Currently, you must specify an Amazon Resource Name (ARN) for an
2499
- # existing VPC Lattice target group. When you detach a target group,
2500
- # it enters the `Removing` state while deregistering the instances in
2501
- # the group. When all instances are deregistered, then you can no
2502
- # longer describe the target group using the DescribeTrafficSources
2503
- # API call. The instances continue to run.
2504
2485
  # @return [Array<Types::TrafficSourceIdentifier>]
2505
2486
  #
2506
2487
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DetachTrafficSourcesType AWS API Documentation
@@ -2593,13 +2574,13 @@ module Aws::AutoScaling
2593
2574
  # The volume size, in GiBs. The following are the supported volumes
2594
2575
  # sizes for each volume type:
2595
2576
  #
2596
- # * `gp2` and `gp3`\: 1-16,384
2577
+ # * `gp2` and `gp3`: 1-16,384
2597
2578
  #
2598
- # * `io1`\: 4-16,384
2579
+ # * `io1`: 4-16,384
2599
2580
  #
2600
- # * `st1` and `sc1`\: 125-16,384
2581
+ # * `st1` and `sc1`: 125-16,384
2601
2582
  #
2602
- # * `standard`\: 1-1,024
2583
+ # * `standard`: 1-1,024
2603
2584
  #
2604
2585
  # You must specify either a `SnapshotId` or a `VolumeSize`. If you
2605
2586
  # specify both `SnapshotId` and `VolumeSize`, the volume size must be
@@ -2633,9 +2614,9 @@ module Aws::AutoScaling
2633
2614
  #
2634
2615
  # The following are the supported values for each volume type:
2635
2616
  #
2636
- # * `gp3`\: 3,000-16,000 IOPS
2617
+ # * `gp3`: 3,000-16,000 IOPS
2637
2618
  #
2638
- # * `io1`\: 100-64,000 IOPS
2619
+ # * `io1`: 100-64,000 IOPS
2639
2620
  #
2640
2621
  # For `io1` volumes, we guarantee 64,000 IOPS only for [Instances
2641
2622
  # built on the Nitro System][1]. Other instance families guarantee
@@ -3140,10 +3121,10 @@ module Aws::AutoScaling
3140
3121
  # @return [String]
3141
3122
  #
3142
3123
  # @!attribute [rw] health_status
3143
- # The last reported health status of the instance. "Healthy" means
3124
+ # The last reported health status of the instance. `Healthy` means
3144
3125
  # that the instance is healthy and should remain in service.
3145
- # "Unhealthy" means that the instance is unhealthy and that Amazon
3146
- # EC2 Auto Scaling should terminate and replace it.
3126
+ # `Unhealthy` means that the instance is unhealthy and that Amazon EC2
3127
+ # Auto Scaling should terminate and replace it.
3147
3128
  # @return [String]
3148
3129
  #
3149
3130
  # @!attribute [rw] launch_configuration_name
@@ -3266,27 +3247,30 @@ module Aws::AutoScaling
3266
3247
  # @!attribute [rw] status
3267
3248
  # The current status for the instance refresh operation:
3268
3249
  #
3269
- # * `Pending` - The request was created, but the operation has not
3270
- # started.
3250
+ # * `Pending` - The request was created, but the instance refresh has
3251
+ # not started.
3252
+ #
3253
+ # * `InProgress` - An instance refresh is in progress.
3254
+ #
3255
+ # * `Successful` - An instance refresh completed successfully.
3256
+ #
3257
+ # * `Failed` - An instance refresh failed to complete. You can
3258
+ # troubleshoot using the status reason and the scaling activities.
3271
3259
  #
3272
- # * `InProgress` - The operation is in progress.
3260
+ # * `Cancelling` - An ongoing instance refresh is being cancelled.
3273
3261
  #
3274
- # * `Successful` - The operation completed successfully.
3262
+ # * `Cancelled` - The instance refresh is cancelled.
3275
3263
  #
3276
- # * `Failed` - The operation failed to complete. You can troubleshoot
3277
- # using the status reason and the scaling activities.
3264
+ # * `RollbackInProgress` - An instance refresh is being rolled back.
3278
3265
  #
3279
- # * `Cancelling` - An ongoing operation is being cancelled.
3280
- # Cancellation does not roll back any replacements that have already
3281
- # been completed, but it prevents new replacements from being
3282
- # started.
3266
+ # * `RollbackFailed` - The rollback failed to complete. You can
3267
+ # troubleshoot using the status reason and the scaling activities.
3283
3268
  #
3284
- # * `Cancelled` - The operation is cancelled.
3269
+ # * `RollbackSuccessful` - The rollback completed successfully.
3285
3270
  # @return [String]
3286
3271
  #
3287
3272
  # @!attribute [rw] status_reason
3288
- # Provides more details about the current status of the instance
3289
- # refresh.
3273
+ # The explanation for the specific status assigned to this operation.
3290
3274
  # @return [String]
3291
3275
  #
3292
3276
  # @!attribute [rw] start_time
@@ -3304,11 +3288,24 @@ module Aws::AutoScaling
3304
3288
  # changes to healthy and the specified warm-up time passes, the
3305
3289
  # instance is considered updated and is added to the percentage
3306
3290
  # complete.
3291
+ #
3292
+ # <note markdown="1"> `PercentageComplete` does not include instances that are replaced
3293
+ # during a rollback. This value gradually goes back down to zero
3294
+ # during a rollback.
3295
+ #
3296
+ # </note>
3307
3297
  # @return [Integer]
3308
3298
  #
3309
3299
  # @!attribute [rw] instances_to_update
3310
3300
  # The number of instances remaining to update before the instance
3311
3301
  # refresh is complete.
3302
+ #
3303
+ # <note markdown="1"> If you roll back the instance refresh, `InstancesToUpdate` shows you
3304
+ # the number of instances that were not yet updated by the instance
3305
+ # refresh. Therefore, these instances don't need to be replaced as
3306
+ # part of the rollback.
3307
+ #
3308
+ # </note>
3312
3309
  # @return [Integer]
3313
3310
  #
3314
3311
  # @!attribute [rw] progress_details
@@ -3317,13 +3314,17 @@ module Aws::AutoScaling
3317
3314
  # @return [Types::InstanceRefreshProgressDetails]
3318
3315
  #
3319
3316
  # @!attribute [rw] preferences
3320
- # Describes the preferences for an instance refresh.
3317
+ # The preferences for an instance refresh.
3321
3318
  # @return [Types::RefreshPreferences]
3322
3319
  #
3323
3320
  # @!attribute [rw] desired_configuration
3324
- # Describes the specific update you want to deploy.
3321
+ # Describes the desired configuration for the instance refresh.
3325
3322
  # @return [Types::DesiredConfiguration]
3326
3323
  #
3324
+ # @!attribute [rw] rollback_details
3325
+ # The rollback details.
3326
+ # @return [Types::RollbackDetails]
3327
+ #
3327
3328
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/InstanceRefresh AWS API Documentation
3328
3329
  #
3329
3330
  class InstanceRefresh < Struct.new(
@@ -3337,13 +3338,14 @@ module Aws::AutoScaling
3337
3338
  :instances_to_update,
3338
3339
  :progress_details,
3339
3340
  :preferences,
3340
- :desired_configuration)
3341
+ :desired_configuration,
3342
+ :rollback_details)
3341
3343
  SENSITIVE = []
3342
3344
  include Aws::Structure
3343
3345
  end
3344
3346
 
3345
- # The request failed because an active instance refresh operation
3346
- # already exists for the specified Auto Scaling group.
3347
+ # The request failed because an active instance refresh already exists
3348
+ # for the specified Auto Scaling group.
3347
3349
  #
3348
3350
  # @!attribute [rw] message
3349
3351
  # @return [String]
@@ -3356,8 +3358,8 @@ module Aws::AutoScaling
3356
3358
  include Aws::Structure
3357
3359
  end
3358
3360
 
3359
- # Reports the progress of an instance refresh on instances that are in
3360
- # the Auto Scaling group.
3361
+ # Reports progress on replacing instances that are in the Auto Scaling
3362
+ # group.
3361
3363
  #
3362
3364
  # @!attribute [rw] percentage_complete
3363
3365
  # The percentage of instances in the Auto Scaling group that have been
@@ -3381,18 +3383,17 @@ module Aws::AutoScaling
3381
3383
  include Aws::Structure
3382
3384
  end
3383
3385
 
3384
- # Reports the progress of an instance refresh on an Auto Scaling group
3385
- # that has a warm pool. This includes separate details for instances in
3386
- # the warm pool and instances in the Auto Scaling group (the live pool).
3386
+ # Reports progress on replacing instances in an Auto Scaling group that
3387
+ # has a warm pool. This includes separate details for instances in the
3388
+ # warm pool and instances in the Auto Scaling group (the live pool).
3387
3389
  #
3388
3390
  # @!attribute [rw] live_pool_progress
3389
- # Indicates the progress of an instance refresh on instances that are
3390
- # in the Auto Scaling group.
3391
+ # Reports progress on replacing instances that are in the Auto Scaling
3392
+ # group.
3391
3393
  # @return [Types::InstanceRefreshLivePoolProgress]
3392
3394
  #
3393
3395
  # @!attribute [rw] warm_pool_progress
3394
- # Indicates the progress of an instance refresh on instances that are
3395
- # in the warm pool.
3396
+ # Reports progress on replacing instances that are in the warm pool.
3396
3397
  # @return [Types::InstanceRefreshWarmPoolProgress]
3397
3398
  #
3398
3399
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/InstanceRefreshProgressDetails AWS API Documentation
@@ -3404,8 +3405,7 @@ module Aws::AutoScaling
3404
3405
  include Aws::Structure
3405
3406
  end
3406
3407
 
3407
- # Reports the progress of an instance refresh on instances that are in
3408
- # the warm pool.
3408
+ # Reports progress on replacing instances that are in the warm pool.
3409
3409
  #
3410
3410
  # @!attribute [rw] percentage_complete
3411
3411
  # The percentage of instances in the warm pool that have been
@@ -3953,6 +3953,22 @@ module Aws::AutoScaling
3953
3953
  include Aws::Structure
3954
3954
  end
3955
3955
 
3956
+ # The request failed because a desired configuration was not found or an
3957
+ # incompatible launch template (uses a Systems Manager parameter instead
3958
+ # of an AMI ID) or launch template version (`$Latest` or `$Default`) is
3959
+ # present on the Auto Scaling group.
3960
+ #
3961
+ # @!attribute [rw] message
3962
+ # @return [String]
3963
+ #
3964
+ # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/IrreversibleInstanceRefreshFault AWS API Documentation
3965
+ #
3966
+ class IrreversibleInstanceRefreshFault < Struct.new(
3967
+ :message)
3968
+ SENSITIVE = []
3969
+ include Aws::Structure
3970
+ end
3971
+
3956
3972
  # Describes a launch configuration.
3957
3973
  #
3958
3974
  # @!attribute [rw] launch_configuration_name
@@ -6166,23 +6182,26 @@ module Aws::AutoScaling
6166
6182
  # @return [Integer]
6167
6183
  #
6168
6184
  # @!attribute [rw] instance_warmup
6169
- # *Not needed if the default instance warmup is defined for the
6170
- # group.*
6171
- #
6172
- # The duration of the instance warmup, in seconds.
6173
- #
6174
- # <note markdown="1"> The default is to use the value for the default instance warmup
6175
- # defined for the group. If default instance warmup is null, then
6176
- # `InstanceWarmup` falls back to the value of the health check grace
6177
- # period.
6178
- #
6179
- # </note>
6185
+ # A time period, in seconds, during which an instance refresh waits
6186
+ # before moving on to replacing the next instance after a new instance
6187
+ # enters the `InService` state.
6188
+ #
6189
+ # This property is not required for normal usage. Instead, use the
6190
+ # `DefaultInstanceWarmup` property of the Auto Scaling group. The
6191
+ # `InstanceWarmup` and `DefaultInstanceWarmup` properties work the
6192
+ # same way. Only specify this property if you must override the
6193
+ # `DefaultInstanceWarmup` property.
6194
+ #
6195
+ # If you do not specify this property, the instance warmup by default
6196
+ # is the value of the `DefaultInstanceWarmup` property, if defined
6197
+ # (which is recommended in all cases), or the `HealthCheckGracePeriod`
6198
+ # property otherwise.
6180
6199
  # @return [Integer]
6181
6200
  #
6182
6201
  # @!attribute [rw] checkpoint_percentages
6183
- # Threshold values for each checkpoint in ascending order. Each number
6184
- # must be unique. To replace all instances in the Auto Scaling group,
6185
- # the last number in the array must be `100`.
6202
+ # (Optional) Threshold values for each checkpoint in ascending order.
6203
+ # Each number must be unique. To replace all instances in the Auto
6204
+ # Scaling group, the last number in the array must be `100`.
6186
6205
  #
6187
6206
  # For usage examples, see [Adding checkpoints to an instance
6188
6207
  # refresh][1] in the *Amazon EC2 Auto Scaling User Guide*.
@@ -6193,23 +6212,95 @@ module Aws::AutoScaling
6193
6212
  # @return [Array<Integer>]
6194
6213
  #
6195
6214
  # @!attribute [rw] checkpoint_delay
6196
- # The amount of time, in seconds, to wait after a checkpoint before
6197
- # continuing. This property is optional, but if you specify a value
6198
- # for it, you must also specify a value for `CheckpointPercentages`.
6199
- # If you specify a value for `CheckpointPercentages` and not for
6200
- # `CheckpointDelay`, the `CheckpointDelay` defaults to `3600` (1
6201
- # hour).
6215
+ # (Optional) The amount of time, in seconds, to wait after a
6216
+ # checkpoint before continuing. This property is optional, but if you
6217
+ # specify a value for it, you must also specify a value for
6218
+ # `CheckpointPercentages`. If you specify a value for
6219
+ # `CheckpointPercentages` and not for `CheckpointDelay`, the
6220
+ # `CheckpointDelay` defaults to `3600` (1 hour).
6202
6221
  # @return [Integer]
6203
6222
  #
6204
6223
  # @!attribute [rw] skip_matching
6205
- # A boolean value that indicates whether skip matching is enabled. If
6206
- # true, then Amazon EC2 Auto Scaling skips replacing instances that
6207
- # match the desired configuration. If no desired configuration is
6224
+ # (Optional) Indicates whether skip matching is enabled. If enabled
6225
+ # (`true`), then Amazon EC2 Auto Scaling skips replacing instances
6226
+ # that match the desired configuration. If no desired configuration is
6208
6227
  # specified, then it skips replacing instances that have the same
6209
- # configuration that is already set on the group. The default is
6228
+ # launch template and instance types that the Auto Scaling group was
6229
+ # using before the start of the instance refresh. The default is
6210
6230
  # `false`.
6231
+ #
6232
+ # For more information, see [Use an instance refresh with skip
6233
+ # matching][1] in the *Amazon EC2 Auto Scaling User Guide*.
6234
+ #
6235
+ #
6236
+ #
6237
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh-skip-matching.html
6211
6238
  # @return [Boolean]
6212
6239
  #
6240
+ # @!attribute [rw] auto_rollback
6241
+ # (Optional) Indicates whether to roll back the Auto Scaling group to
6242
+ # its previous configuration if the instance refresh fails. The
6243
+ # default is `false`.
6244
+ #
6245
+ # A rollback is not supported in the following situations:
6246
+ #
6247
+ # * There is no desired configuration specified for the instance
6248
+ # refresh.
6249
+ #
6250
+ # * The Auto Scaling group has a launch template that uses an Amazon
6251
+ # Web Services Systems Manager parameter instead of an AMI ID for
6252
+ # the `ImageId` property.
6253
+ #
6254
+ # * The Auto Scaling group uses the launch template's `$Latest` or
6255
+ # `$Default` version.
6256
+ # @return [Boolean]
6257
+ #
6258
+ # @!attribute [rw] scale_in_protected_instances
6259
+ # Choose the behavior that you want Amazon EC2 Auto Scaling to use if
6260
+ # instances protected from scale in are found.
6261
+ #
6262
+ # The following lists the valid values:
6263
+ #
6264
+ # Refresh
6265
+ #
6266
+ # : Amazon EC2 Auto Scaling replaces instances that are protected from
6267
+ # scale in.
6268
+ #
6269
+ # Ignore
6270
+ #
6271
+ # : Amazon EC2 Auto Scaling ignores instances that are protected from
6272
+ # scale in and continues to replace instances that are not
6273
+ # protected.
6274
+ #
6275
+ # Wait (default)
6276
+ #
6277
+ # : Amazon EC2 Auto Scaling waits one hour for you to remove scale-in
6278
+ # protection. Otherwise, the instance refresh will fail.
6279
+ # @return [String]
6280
+ #
6281
+ # @!attribute [rw] standby_instances
6282
+ # Choose the behavior that you want Amazon EC2 Auto Scaling to use if
6283
+ # instances in `Standby` state are found.
6284
+ #
6285
+ # The following lists the valid values:
6286
+ #
6287
+ # Terminate
6288
+ #
6289
+ # : Amazon EC2 Auto Scaling terminates instances that are in
6290
+ # `Standby`.
6291
+ #
6292
+ # Ignore
6293
+ #
6294
+ # : Amazon EC2 Auto Scaling ignores instances that are in `Standby`
6295
+ # and continues to replace instances that are in the `InService`
6296
+ # state.
6297
+ #
6298
+ # Wait (default)
6299
+ #
6300
+ # : Amazon EC2 Auto Scaling waits one hour for you to return the
6301
+ # instances to service. Otherwise, the instance refresh will fail.
6302
+ # @return [String]
6303
+ #
6213
6304
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/RefreshPreferences AWS API Documentation
6214
6305
  #
6215
6306
  class RefreshPreferences < Struct.new(
@@ -6217,7 +6308,10 @@ module Aws::AutoScaling
6217
6308
  :instance_warmup,
6218
6309
  :checkpoint_percentages,
6219
6310
  :checkpoint_delay,
6220
- :skip_matching)
6311
+ :skip_matching,
6312
+ :auto_rollback,
6313
+ :scale_in_protected_instances,
6314
+ :standby_instances)
6221
6315
  SENSITIVE = []
6222
6316
  include Aws::Structure
6223
6317
  end
@@ -6250,6 +6344,71 @@ module Aws::AutoScaling
6250
6344
  include Aws::Structure
6251
6345
  end
6252
6346
 
6347
+ # Details about an instance refresh rollback.
6348
+ #
6349
+ # @!attribute [rw] rollback_reason
6350
+ # The reason for this instance refresh rollback (for example, whether
6351
+ # a manual or automatic rollback was initiated).
6352
+ # @return [String]
6353
+ #
6354
+ # @!attribute [rw] rollback_start_time
6355
+ # The date and time at which the rollback began.
6356
+ # @return [Time]
6357
+ #
6358
+ # @!attribute [rw] percentage_complete_on_rollback
6359
+ # Indicates the value of `PercentageComplete` at the time the rollback
6360
+ # started.
6361
+ # @return [Integer]
6362
+ #
6363
+ # @!attribute [rw] instances_to_update_on_rollback
6364
+ # Indicates the value of `InstancesToUpdate` at the time the rollback
6365
+ # started.
6366
+ # @return [Integer]
6367
+ #
6368
+ # @!attribute [rw] progress_details_on_rollback
6369
+ # Reports progress on replacing instances in an Auto Scaling group
6370
+ # that has a warm pool. This includes separate details for instances
6371
+ # in the warm pool and instances in the Auto Scaling group (the live
6372
+ # pool).
6373
+ # @return [Types::InstanceRefreshProgressDetails]
6374
+ #
6375
+ # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/RollbackDetails AWS API Documentation
6376
+ #
6377
+ class RollbackDetails < Struct.new(
6378
+ :rollback_reason,
6379
+ :rollback_start_time,
6380
+ :percentage_complete_on_rollback,
6381
+ :instances_to_update_on_rollback,
6382
+ :progress_details_on_rollback)
6383
+ SENSITIVE = []
6384
+ include Aws::Structure
6385
+ end
6386
+
6387
+ # @!attribute [rw] instance_refresh_id
6388
+ # The instance refresh ID associated with the request. This is the
6389
+ # unique ID assigned to the instance refresh when it was started.
6390
+ # @return [String]
6391
+ #
6392
+ # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/RollbackInstanceRefreshAnswer AWS API Documentation
6393
+ #
6394
+ class RollbackInstanceRefreshAnswer < Struct.new(
6395
+ :instance_refresh_id)
6396
+ SENSITIVE = []
6397
+ include Aws::Structure
6398
+ end
6399
+
6400
+ # @!attribute [rw] auto_scaling_group_name
6401
+ # The name of the Auto Scaling group.
6402
+ # @return [String]
6403
+ #
6404
+ # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/RollbackInstanceRefreshType AWS API Documentation
6405
+ #
6406
+ class RollbackInstanceRefreshType < Struct.new(
6407
+ :auto_scaling_group_name)
6408
+ SENSITIVE = []
6409
+ include Aws::Structure
6410
+ end
6411
+
6253
6412
  # The operation can't be performed because there are scaling activities
6254
6413
  # in progress.
6255
6414
  #
@@ -6699,7 +6858,7 @@ module Aws::AutoScaling
6699
6858
  end
6700
6859
 
6701
6860
  # @!attribute [rw] instance_refresh_id
6702
- # A unique ID for tracking the progress of the request.
6861
+ # A unique ID for tracking the progress of the instance refresh.
6703
6862
  # @return [String]
6704
6863
  #
6705
6864
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/StartInstanceRefreshAnswer AWS API Documentation
@@ -6717,12 +6876,6 @@ module Aws::AutoScaling
6717
6876
  # @!attribute [rw] strategy
6718
6877
  # The strategy to use for the instance refresh. The only valid value
6719
6878
  # is `Rolling`.
6720
- #
6721
- # A rolling update helps you update your instances gradually. A
6722
- # rolling update can fail due to failed health checks or if instances
6723
- # are on standby or are protected from scale in. If the rolling update
6724
- # process fails, any instances that are replaced are not rolled back
6725
- # to their previous configuration.
6726
6879
  # @return [String]
6727
6880
  #
6728
6881
  # @!attribute [rw] desired_configuration
@@ -6738,16 +6891,26 @@ module Aws::AutoScaling
6738
6891
  # current launch template for your desired configuration, consider
6739
6892
  # enabling the `SkipMatching` property in preferences. If it's
6740
6893
  # enabled, Amazon EC2 Auto Scaling skips replacing instances that
6741
- # already use the specified launch template and version. This can help
6742
- # you reduce the number of replacements that are required to apply
6743
- # updates.
6894
+ # already use the specified launch template and instance types. This
6895
+ # can help you reduce the number of replacements that are required to
6896
+ # apply updates.
6744
6897
  #
6745
6898
  # </note>
6746
6899
  # @return [Types::DesiredConfiguration]
6747
6900
  #
6748
6901
  # @!attribute [rw] preferences
6749
- # Set of preferences associated with the instance refresh request. If
6750
- # not provided, the default values are used.
6902
+ # Sets your preferences for the instance refresh so that it performs
6903
+ # as expected when you start it. Includes the instance warmup time,
6904
+ # the minimum healthy percentage, and the behaviors that you want
6905
+ # Amazon EC2 Auto Scaling to use if instances that are in `Standby`
6906
+ # state or protected from scale in are found. You can also choose to
6907
+ # enable additional features, such as the following:
6908
+ #
6909
+ # * Auto rollback
6910
+ #
6911
+ # * Checkpoints
6912
+ #
6913
+ # * Skip matching
6751
6914
  # @return [Types::RefreshPreferences]
6752
6915
  #
6753
6916
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/StartInstanceRefreshType AWS API Documentation
@@ -7069,7 +7232,7 @@ module Aws::AutoScaling
7069
7232
  end
7070
7233
 
7071
7234
  # This structure defines the CloudWatch metric to return, along with the
7072
- # statistic, period, and unit.
7235
+ # statistic and unit.
7073
7236
  #
7074
7237
  # For more information about the CloudWatch terminology below, see
7075
7238
  # [Amazon CloudWatch concepts][1] in the *Amazon CloudWatch User Guide*.
@@ -7079,7 +7242,7 @@ module Aws::AutoScaling
7079
7242
  # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html
7080
7243
  #
7081
7244
  # @!attribute [rw] metric
7082
- # Represents a specific metric.
7245
+ # The metric to use.
7083
7246
  # @return [Types::Metric]
7084
7247
  #
7085
7248
  # @!attribute [rw] stat
@@ -7087,7 +7250,7 @@ module Aws::AutoScaling
7087
7250
  # extended statistic. For a list of valid values, see the table in
7088
7251
  # [Statistics][1] in the *Amazon CloudWatch User Guide*.
7089
7252
  #
7090
- # The most commonly used metrics for scaling is `Average`
7253
+ # The most commonly used metric for scaling is `Average`.
7091
7254
  #
7092
7255
  #
7093
7256
  #
@@ -7152,19 +7315,65 @@ module Aws::AutoScaling
7152
7315
  include Aws::Structure
7153
7316
  end
7154
7317
 
7155
- # Describes the identifier of a traffic source.
7156
- #
7157
- # Currently, you must specify an Amazon Resource Name (ARN) for an
7158
- # existing VPC Lattice target group.
7318
+ # Identifying information for a traffic source.
7159
7319
  #
7160
7320
  # @!attribute [rw] identifier
7161
- # The unique identifier of the traffic source.
7321
+ # Identifies the traffic source.
7322
+ #
7323
+ # For Application Load Balancers, Gateway Load Balancers, Network Load
7324
+ # Balancers, and VPC Lattice, this will be the Amazon Resource Name
7325
+ # (ARN) for a target group in this account and Region. For Classic
7326
+ # Load Balancers, this will be the name of the Classic Load Balancer
7327
+ # in this account and Region.
7328
+ #
7329
+ # For example:
7330
+ #
7331
+ # * Application Load Balancer ARN:
7332
+ # `arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456`
7333
+ #
7334
+ # * Classic Load Balancer name: `my-classic-load-balancer`
7335
+ #
7336
+ # * VPC Lattice ARN:
7337
+ # `arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456`
7338
+ #
7339
+ # To get the ARN of a target group for a Application Load Balancer,
7340
+ # Gateway Load Balancer, or Network Load Balancer, or the name of a
7341
+ # Classic Load Balancer, use the Elastic Load Balancing
7342
+ # [DescribeTargetGroups][1] and [DescribeLoadBalancers][2] API
7343
+ # operations.
7344
+ #
7345
+ # To get the ARN of a target group for VPC Lattice, use the VPC
7346
+ # Lattice [GetTargetGroup][3] API operation.
7347
+ #
7348
+ #
7349
+ #
7350
+ # [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html
7351
+ # [2]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html
7352
+ # [3]: https://docs.aws.amazon.com/vpc-lattice/latest/APIReference/API_GetTargetGroup.html
7353
+ # @return [String]
7354
+ #
7355
+ # @!attribute [rw] type
7356
+ # Provides additional context for the value of `Identifier`.
7357
+ #
7358
+ # The following lists the valid values:
7359
+ #
7360
+ # * `elb` if `Identifier` is the name of a Classic Load Balancer.
7361
+ #
7362
+ # * `elbv2` if `Identifier` is the ARN of an Application Load
7363
+ # Balancer, Gateway Load Balancer, or Network Load Balancer target
7364
+ # group.
7365
+ #
7366
+ # * `vpc-lattice` if `Identifier` is the ARN of a VPC Lattice target
7367
+ # group.
7368
+ #
7369
+ # Required if the identifier is the name of a Classic Load Balancer.
7162
7370
  # @return [String]
7163
7371
  #
7164
7372
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/TrafficSourceIdentifier AWS API Documentation
7165
7373
  #
7166
7374
  class TrafficSourceIdentifier < Struct.new(
7167
- :identifier)
7375
+ :identifier,
7376
+ :type)
7168
7377
  SENSITIVE = []
7169
7378
  include Aws::Structure
7170
7379
  end
@@ -7172,37 +7381,63 @@ module Aws::AutoScaling
7172
7381
  # Describes the state of a traffic source.
7173
7382
  #
7174
7383
  # @!attribute [rw] traffic_source
7175
- # The unique identifier of the traffic source. Currently, this is the
7176
- # Amazon Resource Name (ARN) for a VPC Lattice target group.
7384
+ # This is replaced by `Identifier`.
7177
7385
  # @return [String]
7178
7386
  #
7179
7387
  # @!attribute [rw] state
7180
- # The following are the possible states for a VPC Lattice target
7181
- # group:
7388
+ # Describes the current state of a traffic source.
7389
+ #
7390
+ # The state values are as follows:
7182
7391
  #
7183
7392
  # * `Adding` - The Auto Scaling instances are being registered with
7184
- # the target group.
7393
+ # the load balancer or target group.
7185
7394
  #
7186
- # * `Added` - All Auto Scaling instances are registered with the
7187
- # target group.
7395
+ # * `Added` - All Auto Scaling instances are registered with the load
7396
+ # balancer or target group.
7188
7397
  #
7189
- # * `InService` - At least one Auto Scaling instance passed the
7190
- # `VPC_LATTICE` health check.
7398
+ # * `InService` - For an Elastic Load Balancing load balancer or
7399
+ # target group, at least one Auto Scaling instance passed an `ELB`
7400
+ # health check. For VPC Lattice, at least one Auto Scaling instance
7401
+ # passed an `VPC_LATTICE` health check.
7191
7402
  #
7192
7403
  # * `Removing` - The Auto Scaling instances are being deregistered
7193
- # from the target group. If connection draining is enabled, VPC
7404
+ # from the load balancer or target group. If connection draining
7405
+ # (deregistration delay) is enabled, Elastic Load Balancing or VPC
7194
7406
  # Lattice waits for in-flight requests to complete before
7195
7407
  # deregistering the instances.
7196
7408
  #
7197
7409
  # * `Removed` - All Auto Scaling instances are deregistered from the
7198
- # target group.
7410
+ # load balancer or target group.
7411
+ # @return [String]
7412
+ #
7413
+ # @!attribute [rw] identifier
7414
+ # The unique identifier of the traffic source.
7415
+ # @return [String]
7416
+ #
7417
+ # @!attribute [rw] type
7418
+ # Provides additional context for the value of `Identifier`.
7419
+ #
7420
+ # The following lists the valid values:
7421
+ #
7422
+ # * `elb` if `Identifier` is the name of a Classic Load Balancer.
7423
+ #
7424
+ # * `elbv2` if `Identifier` is the ARN of an Application Load
7425
+ # Balancer, Gateway Load Balancer, or Network Load Balancer target
7426
+ # group.
7427
+ #
7428
+ # * `vpc-lattice` if `Identifier` is the ARN of a VPC Lattice target
7429
+ # group.
7430
+ #
7431
+ # Required if the identifier is the name of a Classic Load Balancer.
7199
7432
  # @return [String]
7200
7433
  #
7201
7434
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/TrafficSourceState AWS API Documentation
7202
7435
  #
7203
7436
  class TrafficSourceState < Struct.new(
7204
7437
  :traffic_source,
7205
- :state)
7438
+ :state,
7439
+ :identifier,
7440
+ :type)
7206
7441
  SENSITIVE = []
7207
7442
  include Aws::Structure
7208
7443
  end
@@ -7276,12 +7511,16 @@ module Aws::AutoScaling
7276
7511
  # @return [Array<String>]
7277
7512
  #
7278
7513
  # @!attribute [rw] health_check_type
7279
- # Determines whether any additional health checks are performed on the
7280
- # instances in this group. Amazon EC2 health checks are always on.
7514
+ # A comma-separated list of one or more health check types.
7515
+ #
7516
+ # The valid values are `EC2`, `ELB`, and `VPC_LATTICE`. `EC2` is the
7517
+ # default health check and cannot be disabled. For more information,
7518
+ # see [Health checks for Auto Scaling instances][1] in the *Amazon EC2
7519
+ # Auto Scaling User Guide*.
7520
+ #
7281
7521
  #
7282
- # The valid values are `EC2` (default), `ELB`, and `VPC_LATTICE`. The
7283
- # `VPC_LATTICE` health check type is reserved for use with VPC
7284
- # Lattice, which is in preview release and is subject to change.
7522
+ #
7523
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
7285
7524
  # @return [String]
7286
7525
  #
7287
7526
  # @!attribute [rw] health_check_grace_period
@@ -7406,26 +7645,25 @@ module Aws::AutoScaling
7406
7645
  # @return [String]
7407
7646
  #
7408
7647
  # @!attribute [rw] default_instance_warmup
7409
- # The amount of time, in seconds, until a newly launched instance can
7410
- # contribute to the Amazon CloudWatch metrics. This delay lets an
7411
- # instance finish initializing before Amazon EC2 Auto Scaling
7412
- # aggregates instance metrics, resulting in more reliable usage data.
7413
- # Set this value equal to the amount of time that it takes for
7414
- # resource consumption to become stable after an instance reaches the
7415
- # `InService` state. For more information, see [Set the default
7416
- # instance warmup for an Auto Scaling group][1] in the *Amazon EC2
7417
- # Auto Scaling User Guide*.
7418
- #
7419
- # To manage your warm-up settings at the group level, we recommend
7420
- # that you set the default instance warmup, *even if its value is set
7421
- # to 0 seconds*. This also optimizes the performance of scaling
7422
- # policies that scale continuously, such as target tracking and step
7423
- # scaling policies.
7648
+ # The amount of time, in seconds, until a new instance is considered
7649
+ # to have finished initializing and resource consumption to become
7650
+ # stable after it enters the `InService` state.
7651
+ #
7652
+ # During an instance refresh, Amazon EC2 Auto Scaling waits for the
7653
+ # warm-up period after it replaces an instance before it moves on to
7654
+ # replacing the next instance. Amazon EC2 Auto Scaling also waits for
7655
+ # the warm-up period before aggregating the metrics for new instances
7656
+ # with existing instances in the Amazon CloudWatch metrics that are
7657
+ # used for scaling, resulting in more reliable usage data. For more
7658
+ # information, see [Set the default instance warmup for an Auto
7659
+ # Scaling group][1] in the *Amazon EC2 Auto Scaling User Guide*.
7424
7660
  #
7425
- # If you need to remove a value that you previously set, include the
7661
+ # To manage various warm-up settings at the group level, we recommend
7662
+ # that you set the default instance warmup, *even if it is set to 0
7663
+ # seconds*. To remove a value that you previously set, include the
7426
7664
  # property but specify `-1` for the value. However, we strongly
7427
7665
  # recommend keeping the default instance warmup enabled by specifying
7428
- # a minimum value of `0`.
7666
+ # a value of `0` or other nominal value.
7429
7667
  #
7430
7668
  #
7431
7669
  #