| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.AutoScaling.EnterStandby
Description
Moves the specified instances into the standby state.
If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group.
If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Synopsis
- data EnterStandby = EnterStandby' {}
- newEnterStandby :: Text -> Bool -> EnterStandby
- enterStandby_instanceIds :: Lens' EnterStandby (Maybe [Text])
- enterStandby_autoScalingGroupName :: Lens' EnterStandby Text
- enterStandby_shouldDecrementDesiredCapacity :: Lens' EnterStandby Bool
- data EnterStandbyResponse = EnterStandbyResponse' {
- activities :: Maybe [Activity]
- httpStatus :: Int
- newEnterStandbyResponse :: Int -> EnterStandbyResponse
- enterStandbyResponse_activities :: Lens' EnterStandbyResponse (Maybe [Activity])
- enterStandbyResponse_httpStatus :: Lens' EnterStandbyResponse Int
Creating a Request
data EnterStandby Source #
See: newEnterStandby smart constructor.
Constructors
| EnterStandby' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Bool | |
| -> EnterStandby |
Create a value of EnterStandby with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instanceIds:EnterStandby', enterStandby_instanceIds - The IDs of the instances. You can specify up to 20 instances.
$sel:autoScalingGroupName:EnterStandby', enterStandby_autoScalingGroupName - The name of the Auto Scaling group.
$sel:shouldDecrementDesiredCapacity:EnterStandby', enterStandby_shouldDecrementDesiredCapacity - Indicates whether to decrement the desired capacity of the Auto Scaling
group by the number of instances moved to Standby mode.
Request Lenses
enterStandby_instanceIds :: Lens' EnterStandby (Maybe [Text]) Source #
The IDs of the instances. You can specify up to 20 instances.
enterStandby_autoScalingGroupName :: Lens' EnterStandby Text Source #
The name of the Auto Scaling group.
enterStandby_shouldDecrementDesiredCapacity :: Lens' EnterStandby Bool Source #
Indicates whether to decrement the desired capacity of the Auto Scaling
group by the number of instances moved to Standby mode.
Destructuring the Response
data EnterStandbyResponse Source #
See: newEnterStandbyResponse smart constructor.
Constructors
| EnterStandbyResponse' | |
Fields
| |
Instances
newEnterStandbyResponse Source #
Arguments
| :: Int | |
| -> EnterStandbyResponse |
Create a value of EnterStandbyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:activities:EnterStandbyResponse', enterStandbyResponse_activities - The activities related to moving instances into Standby mode.
$sel:httpStatus:EnterStandbyResponse', enterStandbyResponse_httpStatus - The response's http status code.
Response Lenses
enterStandbyResponse_activities :: Lens' EnterStandbyResponse (Maybe [Activity]) Source #
The activities related to moving instances into Standby mode.
enterStandbyResponse_httpStatus :: Lens' EnterStandbyResponse Int Source #
The response's http status code.