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.Types.InstanceRefresh
Description
Synopsis
- data InstanceRefresh = InstanceRefresh' {
- status :: Maybe InstanceRefreshStatus
- progressDetails :: Maybe InstanceRefreshProgressDetails
- startTime :: Maybe ISO8601
- preferences :: Maybe RefreshPreferences
- instancesToUpdate :: Maybe Natural
- percentageComplete :: Maybe Natural
- autoScalingGroupName :: Maybe Text
- endTime :: Maybe ISO8601
- statusReason :: Maybe Text
- desiredConfiguration :: Maybe DesiredConfiguration
- instanceRefreshId :: Maybe Text
- newInstanceRefresh :: InstanceRefresh
- instanceRefresh_status :: Lens' InstanceRefresh (Maybe InstanceRefreshStatus)
- instanceRefresh_progressDetails :: Lens' InstanceRefresh (Maybe InstanceRefreshProgressDetails)
- instanceRefresh_startTime :: Lens' InstanceRefresh (Maybe UTCTime)
- instanceRefresh_preferences :: Lens' InstanceRefresh (Maybe RefreshPreferences)
- instanceRefresh_instancesToUpdate :: Lens' InstanceRefresh (Maybe Natural)
- instanceRefresh_percentageComplete :: Lens' InstanceRefresh (Maybe Natural)
- instanceRefresh_autoScalingGroupName :: Lens' InstanceRefresh (Maybe Text)
- instanceRefresh_endTime :: Lens' InstanceRefresh (Maybe UTCTime)
- instanceRefresh_statusReason :: Lens' InstanceRefresh (Maybe Text)
- instanceRefresh_desiredConfiguration :: Lens' InstanceRefresh (Maybe DesiredConfiguration)
- instanceRefresh_instanceRefreshId :: Lens' InstanceRefresh (Maybe Text)
Documentation
data InstanceRefresh Source #
Describes an instance refresh for an Auto Scaling group.
See: newInstanceRefresh
smart constructor.
Constructors
InstanceRefresh' | |
Fields
|
Instances
newInstanceRefresh :: InstanceRefresh Source #
Create a value of InstanceRefresh
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:status:InstanceRefresh'
, instanceRefresh_status
- The current status for the instance refresh operation:
Pending
- The request was created, but the operation has not started.InProgress
- The operation is in progress.Successful
- The operation completed successfully.Failed
- The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.Cancelling
- An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.Cancelled
- The operation is cancelled.
$sel:progressDetails:InstanceRefresh'
, instanceRefresh_progressDetails
- Additional progress details for an Auto Scaling group that has a warm
pool.
$sel:startTime:InstanceRefresh'
, instanceRefresh_startTime
- The date and time at which the instance refresh began.
$sel:preferences:InstanceRefresh'
, instanceRefresh_preferences
- Undocumented member.
$sel:instancesToUpdate:InstanceRefresh'
, instanceRefresh_instancesToUpdate
- The number of instances remaining to update before the instance refresh
is complete.
$sel:percentageComplete:InstanceRefresh'
, instanceRefresh_percentageComplete
- The percentage of the instance refresh that is complete. For each
instance replacement, Amazon EC2 Auto Scaling tracks the instance's
health status and warm-up time. When the instance's health status
changes to healthy and the specified warm-up time passes, the instance
is considered updated and is added to the percentage complete.
$sel:autoScalingGroupName:InstanceRefresh'
, instanceRefresh_autoScalingGroupName
- The name of the Auto Scaling group.
$sel:endTime:InstanceRefresh'
, instanceRefresh_endTime
- The date and time at which the instance refresh ended.
$sel:statusReason:InstanceRefresh'
, instanceRefresh_statusReason
- Provides more details about the current status of the instance refresh.
$sel:desiredConfiguration:InstanceRefresh'
, instanceRefresh_desiredConfiguration
- Describes the specific update you want to deploy.
$sel:instanceRefreshId:InstanceRefresh'
, instanceRefresh_instanceRefreshId
- The instance refresh ID.
instanceRefresh_status :: Lens' InstanceRefresh (Maybe InstanceRefreshStatus) Source #
The current status for the instance refresh operation:
Pending
- The request was created, but the operation has not started.InProgress
- The operation is in progress.Successful
- The operation completed successfully.Failed
- The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.Cancelling
- An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.Cancelled
- The operation is cancelled.
instanceRefresh_progressDetails :: Lens' InstanceRefresh (Maybe InstanceRefreshProgressDetails) Source #
Additional progress details for an Auto Scaling group that has a warm pool.
instanceRefresh_startTime :: Lens' InstanceRefresh (Maybe UTCTime) Source #
The date and time at which the instance refresh began.
instanceRefresh_preferences :: Lens' InstanceRefresh (Maybe RefreshPreferences) Source #
Undocumented member.
instanceRefresh_instancesToUpdate :: Lens' InstanceRefresh (Maybe Natural) Source #
The number of instances remaining to update before the instance refresh is complete.
instanceRefresh_percentageComplete :: Lens' InstanceRefresh (Maybe Natural) Source #
The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
instanceRefresh_autoScalingGroupName :: Lens' InstanceRefresh (Maybe Text) Source #
The name of the Auto Scaling group.
instanceRefresh_endTime :: Lens' InstanceRefresh (Maybe UTCTime) Source #
The date and time at which the instance refresh ended.
instanceRefresh_statusReason :: Lens' InstanceRefresh (Maybe Text) Source #
Provides more details about the current status of the instance refresh.
instanceRefresh_desiredConfiguration :: Lens' InstanceRefresh (Maybe DesiredConfiguration) Source #
Describes the specific update you want to deploy.
instanceRefresh_instanceRefreshId :: Lens' InstanceRefresh (Maybe Text) Source #
The instance refresh ID.