| 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
Contents
- Service Configuration
- Errors
- InstanceMetadataEndpointState
- InstanceMetadataHttpTokensState
- InstanceRefreshStatus
- LifecycleState
- MetricStatistic
- MetricType
- PredefinedLoadMetricType
- PredefinedMetricPairType
- PredefinedScalingMetricType
- PredictiveScalingMaxCapacityBreachBehavior
- PredictiveScalingMode
- RefreshStrategy
- ScalingActivityStatusCode
- WarmPoolState
- WarmPoolStatus
- Activity
- AdjustmentType
- Alarm
- AutoScalingGroup
- AutoScalingInstanceDetails
- BlockDeviceMapping
- CapacityForecast
- CustomizedMetricSpecification
- DesiredConfiguration
- Ebs
- EnabledMetric
- FailedScheduledUpdateGroupActionRequest
- Filter
- Instance
- InstanceMetadataOptions
- InstanceMonitoring
- InstanceRefresh
- InstanceRefreshLivePoolProgress
- InstanceRefreshProgressDetails
- InstanceRefreshWarmPoolProgress
- InstancesDistribution
- LaunchConfiguration
- LaunchTemplate
- LaunchTemplateOverrides
- LaunchTemplateSpecification
- LifecycleHook
- LifecycleHookSpecification
- LoadBalancerState
- LoadBalancerTargetGroupState
- LoadForecast
- MetricCollectionType
- MetricDimension
- MetricGranularityType
- MixedInstancesPolicy
- NotificationConfiguration
- PredefinedMetricSpecification
- PredictiveScalingConfiguration
- PredictiveScalingMetricSpecification
- PredictiveScalingPredefinedLoadMetric
- PredictiveScalingPredefinedMetricPair
- PredictiveScalingPredefinedScalingMetric
- ProcessType
- RefreshPreferences
- ScalingPolicy
- ScalingProcessQuery
- ScheduledUpdateGroupAction
- ScheduledUpdateGroupActionRequest
- StepAdjustment
- SuspendedProcess
- Tag
- TagDescription
- TargetTrackingConfiguration
- WarmPoolConfiguration
Description
Synopsis
- defaultService :: Service
- _InstanceRefreshInProgressFault :: AsError a => Getting (First ServiceError) a ServiceError
- _AlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextToken :: AsError a => Getting (First ServiceError) a ServiceError
- _ScalingActivityInProgressFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceContentionFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceLinkedRoleFailure :: AsError a => Getting (First ServiceError) a ServiceError
- _ActiveInstanceRefreshNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- newtype InstanceMetadataEndpointState where
- newtype InstanceMetadataHttpTokensState where
- newtype InstanceRefreshStatus where
- InstanceRefreshStatus' { }
- pattern InstanceRefreshStatus_Cancelled :: InstanceRefreshStatus
- pattern InstanceRefreshStatus_Cancelling :: InstanceRefreshStatus
- pattern InstanceRefreshStatus_Failed :: InstanceRefreshStatus
- pattern InstanceRefreshStatus_InProgress :: InstanceRefreshStatus
- pattern InstanceRefreshStatus_Pending :: InstanceRefreshStatus
- pattern InstanceRefreshStatus_Successful :: InstanceRefreshStatus
- newtype LifecycleState where
- LifecycleState' { }
- pattern LifecycleState_Detached :: LifecycleState
- pattern LifecycleState_Detaching :: LifecycleState
- pattern LifecycleState_EnteringStandby :: LifecycleState
- pattern LifecycleState_InService :: LifecycleState
- pattern LifecycleState_Pending :: LifecycleState
- pattern LifecycleState_Pending_Proceed :: LifecycleState
- pattern LifecycleState_Pending_Wait :: LifecycleState
- pattern LifecycleState_Quarantined :: LifecycleState
- pattern LifecycleState_Standby :: LifecycleState
- pattern LifecycleState_Terminated :: LifecycleState
- pattern LifecycleState_Terminating :: LifecycleState
- pattern LifecycleState_Terminating_Proceed :: LifecycleState
- pattern LifecycleState_Terminating_Wait :: LifecycleState
- pattern LifecycleState_Warmed_Pending :: LifecycleState
- pattern LifecycleState_Warmed_Pending_Proceed :: LifecycleState
- pattern LifecycleState_Warmed_Pending_Wait :: LifecycleState
- pattern LifecycleState_Warmed_Running :: LifecycleState
- pattern LifecycleState_Warmed_Stopped :: LifecycleState
- pattern LifecycleState_Warmed_Terminated :: LifecycleState
- pattern LifecycleState_Warmed_Terminating :: LifecycleState
- pattern LifecycleState_Warmed_Terminating_Proceed :: LifecycleState
- pattern LifecycleState_Warmed_Terminating_Wait :: LifecycleState
- newtype MetricStatistic where
- MetricStatistic' { }
- pattern MetricStatistic_Average :: MetricStatistic
- pattern MetricStatistic_Maximum :: MetricStatistic
- pattern MetricStatistic_Minimum :: MetricStatistic
- pattern MetricStatistic_SampleCount :: MetricStatistic
- pattern MetricStatistic_Sum :: MetricStatistic
- newtype MetricType where
- MetricType' { }
- pattern MetricType_ALBRequestCountPerTarget :: MetricType
- pattern MetricType_ASGAverageCPUUtilization :: MetricType
- pattern MetricType_ASGAverageNetworkIn :: MetricType
- pattern MetricType_ASGAverageNetworkOut :: MetricType
- newtype PredefinedLoadMetricType where
- PredefinedLoadMetricType' { }
- pattern PredefinedLoadMetricType_ALBTargetGroupRequestCount :: PredefinedLoadMetricType
- pattern PredefinedLoadMetricType_ASGTotalCPUUtilization :: PredefinedLoadMetricType
- pattern PredefinedLoadMetricType_ASGTotalNetworkIn :: PredefinedLoadMetricType
- pattern PredefinedLoadMetricType_ASGTotalNetworkOut :: PredefinedLoadMetricType
- newtype PredefinedMetricPairType where
- PredefinedMetricPairType' { }
- pattern PredefinedMetricPairType_ALBRequestCount :: PredefinedMetricPairType
- pattern PredefinedMetricPairType_ASGCPUUtilization :: PredefinedMetricPairType
- pattern PredefinedMetricPairType_ASGNetworkIn :: PredefinedMetricPairType
- pattern PredefinedMetricPairType_ASGNetworkOut :: PredefinedMetricPairType
- newtype PredefinedScalingMetricType where
- PredefinedScalingMetricType' { }
- pattern PredefinedScalingMetricType_ALBRequestCountPerTarget :: PredefinedScalingMetricType
- pattern PredefinedScalingMetricType_ASGAverageCPUUtilization :: PredefinedScalingMetricType
- pattern PredefinedScalingMetricType_ASGAverageNetworkIn :: PredefinedScalingMetricType
- pattern PredefinedScalingMetricType_ASGAverageNetworkOut :: PredefinedScalingMetricType
- newtype PredictiveScalingMaxCapacityBreachBehavior where
- newtype PredictiveScalingMode where
- newtype RefreshStrategy where
- RefreshStrategy' { }
- pattern RefreshStrategy_Rolling :: RefreshStrategy
- newtype ScalingActivityStatusCode where
- ScalingActivityStatusCode' { }
- pattern ScalingActivityStatusCode_Cancelled :: ScalingActivityStatusCode
- pattern ScalingActivityStatusCode_Failed :: ScalingActivityStatusCode
- pattern ScalingActivityStatusCode_InProgress :: ScalingActivityStatusCode
- pattern ScalingActivityStatusCode_MidLifecycleAction :: ScalingActivityStatusCode
- pattern ScalingActivityStatusCode_PendingSpotBidPlacement :: ScalingActivityStatusCode
- pattern ScalingActivityStatusCode_PreInService :: ScalingActivityStatusCode
- pattern ScalingActivityStatusCode_Successful :: ScalingActivityStatusCode
- pattern ScalingActivityStatusCode_WaitingForELBConnectionDraining :: ScalingActivityStatusCode
- pattern ScalingActivityStatusCode_WaitingForInstanceId :: ScalingActivityStatusCode
- pattern ScalingActivityStatusCode_WaitingForInstanceWarmup :: ScalingActivityStatusCode
- pattern ScalingActivityStatusCode_WaitingForSpotInstanceId :: ScalingActivityStatusCode
- pattern ScalingActivityStatusCode_WaitingForSpotInstanceRequestId :: ScalingActivityStatusCode
- newtype WarmPoolState where
- WarmPoolState' { }
- pattern WarmPoolState_Running :: WarmPoolState
- pattern WarmPoolState_Stopped :: WarmPoolState
- newtype WarmPoolStatus where
- WarmPoolStatus' { }
- pattern WarmPoolStatus_PendingDelete :: WarmPoolStatus
- data Activity = Activity' {
- progress :: Maybe Int
- statusMessage :: Maybe Text
- autoScalingGroupState :: Maybe Text
- endTime :: Maybe ISO8601
- details :: Maybe Text
- autoScalingGroupARN :: Maybe Text
- description :: Maybe Text
- activityId :: Text
- autoScalingGroupName :: Text
- cause :: Text
- startTime :: ISO8601
- statusCode :: ScalingActivityStatusCode
- newActivity :: Text -> Text -> Text -> UTCTime -> ScalingActivityStatusCode -> Activity
- activity_progress :: Lens' Activity (Maybe Int)
- activity_statusMessage :: Lens' Activity (Maybe Text)
- activity_autoScalingGroupState :: Lens' Activity (Maybe Text)
- activity_endTime :: Lens' Activity (Maybe UTCTime)
- activity_details :: Lens' Activity (Maybe Text)
- activity_autoScalingGroupARN :: Lens' Activity (Maybe Text)
- activity_description :: Lens' Activity (Maybe Text)
- activity_activityId :: Lens' Activity Text
- activity_autoScalingGroupName :: Lens' Activity Text
- activity_cause :: Lens' Activity Text
- activity_startTime :: Lens' Activity UTCTime
- activity_statusCode :: Lens' Activity ScalingActivityStatusCode
- data AdjustmentType = AdjustmentType' {}
- newAdjustmentType :: AdjustmentType
- adjustmentType_adjustmentType :: Lens' AdjustmentType (Maybe Text)
- data Alarm = Alarm' {}
- newAlarm :: Alarm
- alarm_alarmName :: Lens' Alarm (Maybe Text)
- alarm_alarmARN :: Lens' Alarm (Maybe Text)
- data AutoScalingGroup = AutoScalingGroup' {
- status :: Maybe Text
- context :: Maybe Text
- terminationPolicies :: Maybe [Text]
- healthCheckGracePeriod :: Maybe Int
- serviceLinkedRoleARN :: Maybe Text
- newInstancesProtectedFromScaleIn' :: Maybe Bool
- vPCZoneIdentifier :: Maybe Text
- targetGroupARNs :: Maybe [Text]
- maxInstanceLifetime :: Maybe Int
- mixedInstancesPolicy :: Maybe MixedInstancesPolicy
- enabledMetrics :: Maybe [EnabledMetric]
- launchConfigurationName :: Maybe Text
- instances :: Maybe [Instance]
- launchTemplate :: Maybe LaunchTemplateSpecification
- warmPoolConfiguration :: Maybe WarmPoolConfiguration
- capacityRebalance :: Maybe Bool
- autoScalingGroupARN :: Maybe Text
- predictedCapacity :: Maybe Int
- warmPoolSize :: Maybe Int
- placementGroup :: Maybe Text
- suspendedProcesses :: Maybe [SuspendedProcess]
- loadBalancerNames :: Maybe [Text]
- tags :: Maybe [TagDescription]
- autoScalingGroupName :: Text
- minSize :: Int
- maxSize :: Int
- desiredCapacity :: Int
- defaultCooldown :: Int
- availabilityZones :: [Text]
- healthCheckType :: Text
- createdTime :: ISO8601
- newAutoScalingGroup :: Text -> Int -> Int -> Int -> Int -> Text -> UTCTime -> AutoScalingGroup
- autoScalingGroup_status :: Lens' AutoScalingGroup (Maybe Text)
- autoScalingGroup_context :: Lens' AutoScalingGroup (Maybe Text)
- autoScalingGroup_terminationPolicies :: Lens' AutoScalingGroup (Maybe [Text])
- autoScalingGroup_healthCheckGracePeriod :: Lens' AutoScalingGroup (Maybe Int)
- autoScalingGroup_serviceLinkedRoleARN :: Lens' AutoScalingGroup (Maybe Text)
- autoScalingGroup_newInstancesProtectedFromScaleIn :: Lens' AutoScalingGroup (Maybe Bool)
- autoScalingGroup_vPCZoneIdentifier :: Lens' AutoScalingGroup (Maybe Text)
- autoScalingGroup_targetGroupARNs :: Lens' AutoScalingGroup (Maybe [Text])
- autoScalingGroup_maxInstanceLifetime :: Lens' AutoScalingGroup (Maybe Int)
- autoScalingGroup_mixedInstancesPolicy :: Lens' AutoScalingGroup (Maybe MixedInstancesPolicy)
- autoScalingGroup_enabledMetrics :: Lens' AutoScalingGroup (Maybe [EnabledMetric])
- autoScalingGroup_launchConfigurationName :: Lens' AutoScalingGroup (Maybe Text)
- autoScalingGroup_instances :: Lens' AutoScalingGroup (Maybe [Instance])
- autoScalingGroup_launchTemplate :: Lens' AutoScalingGroup (Maybe LaunchTemplateSpecification)
- autoScalingGroup_warmPoolConfiguration :: Lens' AutoScalingGroup (Maybe WarmPoolConfiguration)
- autoScalingGroup_capacityRebalance :: Lens' AutoScalingGroup (Maybe Bool)
- autoScalingGroup_autoScalingGroupARN :: Lens' AutoScalingGroup (Maybe Text)
- autoScalingGroup_predictedCapacity :: Lens' AutoScalingGroup (Maybe Int)
- autoScalingGroup_warmPoolSize :: Lens' AutoScalingGroup (Maybe Int)
- autoScalingGroup_placementGroup :: Lens' AutoScalingGroup (Maybe Text)
- autoScalingGroup_suspendedProcesses :: Lens' AutoScalingGroup (Maybe [SuspendedProcess])
- autoScalingGroup_loadBalancerNames :: Lens' AutoScalingGroup (Maybe [Text])
- autoScalingGroup_tags :: Lens' AutoScalingGroup (Maybe [TagDescription])
- autoScalingGroup_autoScalingGroupName :: Lens' AutoScalingGroup Text
- autoScalingGroup_minSize :: Lens' AutoScalingGroup Int
- autoScalingGroup_maxSize :: Lens' AutoScalingGroup Int
- autoScalingGroup_desiredCapacity :: Lens' AutoScalingGroup Int
- autoScalingGroup_defaultCooldown :: Lens' AutoScalingGroup Int
- autoScalingGroup_availabilityZones :: Lens' AutoScalingGroup [Text]
- autoScalingGroup_healthCheckType :: Lens' AutoScalingGroup Text
- autoScalingGroup_createdTime :: Lens' AutoScalingGroup UTCTime
- data AutoScalingInstanceDetails = AutoScalingInstanceDetails' {}
- newAutoScalingInstanceDetails :: Text -> Text -> Text -> Text -> Text -> Bool -> AutoScalingInstanceDetails
- autoScalingInstanceDetails_weightedCapacity :: Lens' AutoScalingInstanceDetails (Maybe Text)
- autoScalingInstanceDetails_instanceType :: Lens' AutoScalingInstanceDetails (Maybe Text)
- autoScalingInstanceDetails_launchConfigurationName :: Lens' AutoScalingInstanceDetails (Maybe Text)
- autoScalingInstanceDetails_launchTemplate :: Lens' AutoScalingInstanceDetails (Maybe LaunchTemplateSpecification)
- autoScalingInstanceDetails_instanceId :: Lens' AutoScalingInstanceDetails Text
- autoScalingInstanceDetails_autoScalingGroupName :: Lens' AutoScalingInstanceDetails Text
- autoScalingInstanceDetails_availabilityZone :: Lens' AutoScalingInstanceDetails Text
- autoScalingInstanceDetails_lifecycleState :: Lens' AutoScalingInstanceDetails Text
- autoScalingInstanceDetails_healthStatus :: Lens' AutoScalingInstanceDetails Text
- autoScalingInstanceDetails_protectedFromScaleIn :: Lens' AutoScalingInstanceDetails Bool
- data BlockDeviceMapping = BlockDeviceMapping' {}
- newBlockDeviceMapping :: Text -> BlockDeviceMapping
- blockDeviceMapping_virtualName :: Lens' BlockDeviceMapping (Maybe Text)
- blockDeviceMapping_noDevice :: Lens' BlockDeviceMapping (Maybe Bool)
- blockDeviceMapping_ebs :: Lens' BlockDeviceMapping (Maybe Ebs)
- blockDeviceMapping_deviceName :: Lens' BlockDeviceMapping Text
- data CapacityForecast = CapacityForecast' {
- timestamps :: [ISO8601]
- values :: [Double]
- newCapacityForecast :: CapacityForecast
- capacityForecast_timestamps :: Lens' CapacityForecast [UTCTime]
- capacityForecast_values :: Lens' CapacityForecast [Double]
- data CustomizedMetricSpecification = CustomizedMetricSpecification' {
- dimensions :: Maybe [MetricDimension]
- unit :: Maybe Text
- metricName :: Text
- namespace :: Text
- statistic :: MetricStatistic
- newCustomizedMetricSpecification :: Text -> Text -> MetricStatistic -> CustomizedMetricSpecification
- customizedMetricSpecification_dimensions :: Lens' CustomizedMetricSpecification (Maybe [MetricDimension])
- customizedMetricSpecification_unit :: Lens' CustomizedMetricSpecification (Maybe Text)
- customizedMetricSpecification_metricName :: Lens' CustomizedMetricSpecification Text
- customizedMetricSpecification_namespace :: Lens' CustomizedMetricSpecification Text
- customizedMetricSpecification_statistic :: Lens' CustomizedMetricSpecification MetricStatistic
- data DesiredConfiguration = DesiredConfiguration' {}
- newDesiredConfiguration :: DesiredConfiguration
- desiredConfiguration_mixedInstancesPolicy :: Lens' DesiredConfiguration (Maybe MixedInstancesPolicy)
- desiredConfiguration_launchTemplate :: Lens' DesiredConfiguration (Maybe LaunchTemplateSpecification)
- data Ebs = Ebs' {}
- newEbs :: Ebs
- ebs_deleteOnTermination :: Lens' Ebs (Maybe Bool)
- ebs_throughput :: Lens' Ebs (Maybe Natural)
- ebs_volumeSize :: Lens' Ebs (Maybe Natural)
- ebs_iops :: Lens' Ebs (Maybe Natural)
- ebs_encrypted :: Lens' Ebs (Maybe Bool)
- ebs_volumeType :: Lens' Ebs (Maybe Text)
- ebs_snapshotId :: Lens' Ebs (Maybe Text)
- data EnabledMetric = EnabledMetric' {}
- newEnabledMetric :: EnabledMetric
- enabledMetric_granularity :: Lens' EnabledMetric (Maybe Text)
- enabledMetric_metric :: Lens' EnabledMetric (Maybe Text)
- data FailedScheduledUpdateGroupActionRequest = FailedScheduledUpdateGroupActionRequest' {}
- newFailedScheduledUpdateGroupActionRequest :: Text -> FailedScheduledUpdateGroupActionRequest
- failedScheduledUpdateGroupActionRequest_errorCode :: Lens' FailedScheduledUpdateGroupActionRequest (Maybe Text)
- failedScheduledUpdateGroupActionRequest_errorMessage :: Lens' FailedScheduledUpdateGroupActionRequest (Maybe Text)
- failedScheduledUpdateGroupActionRequest_scheduledActionName :: Lens' FailedScheduledUpdateGroupActionRequest Text
- data Filter = Filter' {}
- newFilter :: Text -> Filter
- filter_values :: Lens' Filter (Maybe [Text])
- filter_name :: Lens' Filter Text
- data Instance = Instance' {}
- newInstance :: Text -> Text -> LifecycleState -> Text -> Bool -> Instance
- instance_weightedCapacity :: Lens' Instance (Maybe Text)
- instance_instanceType :: Lens' Instance (Maybe Text)
- instance_launchConfigurationName :: Lens' Instance (Maybe Text)
- instance_launchTemplate :: Lens' Instance (Maybe LaunchTemplateSpecification)
- instance_instanceId :: Lens' Instance Text
- instance_availabilityZone :: Lens' Instance Text
- instance_lifecycleState :: Lens' Instance LifecycleState
- instance_healthStatus :: Lens' Instance Text
- instance_protectedFromScaleIn :: Lens' Instance Bool
- data InstanceMetadataOptions = InstanceMetadataOptions' {}
- newInstanceMetadataOptions :: InstanceMetadataOptions
- instanceMetadataOptions_httpEndpoint :: Lens' InstanceMetadataOptions (Maybe InstanceMetadataEndpointState)
- instanceMetadataOptions_httpPutResponseHopLimit :: Lens' InstanceMetadataOptions (Maybe Natural)
- instanceMetadataOptions_httpTokens :: Lens' InstanceMetadataOptions (Maybe InstanceMetadataHttpTokensState)
- data InstanceMonitoring = InstanceMonitoring' {}
- newInstanceMonitoring :: InstanceMonitoring
- instanceMonitoring_enabled :: Lens' InstanceMonitoring (Maybe Bool)
- 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)
- data InstanceRefreshLivePoolProgress = InstanceRefreshLivePoolProgress' {}
- newInstanceRefreshLivePoolProgress :: InstanceRefreshLivePoolProgress
- instanceRefreshLivePoolProgress_instancesToUpdate :: Lens' InstanceRefreshLivePoolProgress (Maybe Natural)
- instanceRefreshLivePoolProgress_percentageComplete :: Lens' InstanceRefreshLivePoolProgress (Maybe Natural)
- data InstanceRefreshProgressDetails = InstanceRefreshProgressDetails' {}
- newInstanceRefreshProgressDetails :: InstanceRefreshProgressDetails
- instanceRefreshProgressDetails_livePoolProgress :: Lens' InstanceRefreshProgressDetails (Maybe InstanceRefreshLivePoolProgress)
- instanceRefreshProgressDetails_warmPoolProgress :: Lens' InstanceRefreshProgressDetails (Maybe InstanceRefreshWarmPoolProgress)
- data InstanceRefreshWarmPoolProgress = InstanceRefreshWarmPoolProgress' {}
- newInstanceRefreshWarmPoolProgress :: InstanceRefreshWarmPoolProgress
- instanceRefreshWarmPoolProgress_instancesToUpdate :: Lens' InstanceRefreshWarmPoolProgress (Maybe Natural)
- instanceRefreshWarmPoolProgress_percentageComplete :: Lens' InstanceRefreshWarmPoolProgress (Maybe Natural)
- data InstancesDistribution = InstancesDistribution' {}
- newInstancesDistribution :: InstancesDistribution
- instancesDistribution_spotAllocationStrategy :: Lens' InstancesDistribution (Maybe Text)
- instancesDistribution_spotInstancePools :: Lens' InstancesDistribution (Maybe Int)
- instancesDistribution_spotMaxPrice :: Lens' InstancesDistribution (Maybe Text)
- instancesDistribution_onDemandBaseCapacity :: Lens' InstancesDistribution (Maybe Int)
- instancesDistribution_onDemandAllocationStrategy :: Lens' InstancesDistribution (Maybe Text)
- instancesDistribution_onDemandPercentageAboveBaseCapacity :: Lens' InstancesDistribution (Maybe Int)
- data LaunchConfiguration = LaunchConfiguration' {
- associatePublicIpAddress :: Maybe Bool
- securityGroups :: Maybe [Text]
- spotPrice :: Maybe Text
- instanceMonitoring :: Maybe InstanceMonitoring
- keyName :: Maybe Text
- classicLinkVPCSecurityGroups :: Maybe [Text]
- ramdiskId :: Maybe Text
- kernelId :: Maybe Text
- ebsOptimized :: Maybe Bool
- userData :: Maybe Text
- classicLinkVPCId :: Maybe Text
- iamInstanceProfile :: Maybe Text
- metadataOptions :: Maybe InstanceMetadataOptions
- launchConfigurationARN :: Maybe Text
- placementTenancy :: Maybe Text
- blockDeviceMappings :: Maybe [BlockDeviceMapping]
- launchConfigurationName :: Text
- imageId :: Text
- instanceType :: Text
- createdTime :: ISO8601
- newLaunchConfiguration :: Text -> Text -> Text -> UTCTime -> LaunchConfiguration
- launchConfiguration_associatePublicIpAddress :: Lens' LaunchConfiguration (Maybe Bool)
- launchConfiguration_securityGroups :: Lens' LaunchConfiguration (Maybe [Text])
- launchConfiguration_spotPrice :: Lens' LaunchConfiguration (Maybe Text)
- launchConfiguration_instanceMonitoring :: Lens' LaunchConfiguration (Maybe InstanceMonitoring)
- launchConfiguration_keyName :: Lens' LaunchConfiguration (Maybe Text)
- launchConfiguration_classicLinkVPCSecurityGroups :: Lens' LaunchConfiguration (Maybe [Text])
- launchConfiguration_ramdiskId :: Lens' LaunchConfiguration (Maybe Text)
- launchConfiguration_kernelId :: Lens' LaunchConfiguration (Maybe Text)
- launchConfiguration_ebsOptimized :: Lens' LaunchConfiguration (Maybe Bool)
- launchConfiguration_userData :: Lens' LaunchConfiguration (Maybe Text)
- launchConfiguration_classicLinkVPCId :: Lens' LaunchConfiguration (Maybe Text)
- launchConfiguration_iamInstanceProfile :: Lens' LaunchConfiguration (Maybe Text)
- launchConfiguration_metadataOptions :: Lens' LaunchConfiguration (Maybe InstanceMetadataOptions)
- launchConfiguration_launchConfigurationARN :: Lens' LaunchConfiguration (Maybe Text)
- launchConfiguration_placementTenancy :: Lens' LaunchConfiguration (Maybe Text)
- launchConfiguration_blockDeviceMappings :: Lens' LaunchConfiguration (Maybe [BlockDeviceMapping])
- launchConfiguration_launchConfigurationName :: Lens' LaunchConfiguration Text
- launchConfiguration_imageId :: Lens' LaunchConfiguration Text
- launchConfiguration_instanceType :: Lens' LaunchConfiguration Text
- launchConfiguration_createdTime :: Lens' LaunchConfiguration UTCTime
- data LaunchTemplate = LaunchTemplate' {}
- newLaunchTemplate :: LaunchTemplate
- launchTemplate_overrides :: Lens' LaunchTemplate (Maybe [LaunchTemplateOverrides])
- launchTemplate_launchTemplateSpecification :: Lens' LaunchTemplate (Maybe LaunchTemplateSpecification)
- data LaunchTemplateOverrides = LaunchTemplateOverrides' {}
- newLaunchTemplateOverrides :: LaunchTemplateOverrides
- launchTemplateOverrides_weightedCapacity :: Lens' LaunchTemplateOverrides (Maybe Text)
- launchTemplateOverrides_instanceType :: Lens' LaunchTemplateOverrides (Maybe Text)
- launchTemplateOverrides_launchTemplateSpecification :: Lens' LaunchTemplateOverrides (Maybe LaunchTemplateSpecification)
- data LaunchTemplateSpecification = LaunchTemplateSpecification' {}
- newLaunchTemplateSpecification :: LaunchTemplateSpecification
- launchTemplateSpecification_launchTemplateName :: Lens' LaunchTemplateSpecification (Maybe Text)
- launchTemplateSpecification_launchTemplateId :: Lens' LaunchTemplateSpecification (Maybe Text)
- launchTemplateSpecification_version :: Lens' LaunchTemplateSpecification (Maybe Text)
- data LifecycleHook = LifecycleHook' {}
- newLifecycleHook :: LifecycleHook
- lifecycleHook_defaultResult :: Lens' LifecycleHook (Maybe Text)
- lifecycleHook_lifecycleHookName :: Lens' LifecycleHook (Maybe Text)
- lifecycleHook_heartbeatTimeout :: Lens' LifecycleHook (Maybe Int)
- lifecycleHook_autoScalingGroupName :: Lens' LifecycleHook (Maybe Text)
- lifecycleHook_notificationMetadata :: Lens' LifecycleHook (Maybe Text)
- lifecycleHook_globalTimeout :: Lens' LifecycleHook (Maybe Int)
- lifecycleHook_notificationTargetARN :: Lens' LifecycleHook (Maybe Text)
- lifecycleHook_lifecycleTransition :: Lens' LifecycleHook (Maybe Text)
- lifecycleHook_roleARN :: Lens' LifecycleHook (Maybe Text)
- data LifecycleHookSpecification = LifecycleHookSpecification' {}
- newLifecycleHookSpecification :: Text -> Text -> LifecycleHookSpecification
- lifecycleHookSpecification_defaultResult :: Lens' LifecycleHookSpecification (Maybe Text)
- lifecycleHookSpecification_heartbeatTimeout :: Lens' LifecycleHookSpecification (Maybe Int)
- lifecycleHookSpecification_notificationMetadata :: Lens' LifecycleHookSpecification (Maybe Text)
- lifecycleHookSpecification_notificationTargetARN :: Lens' LifecycleHookSpecification (Maybe Text)
- lifecycleHookSpecification_roleARN :: Lens' LifecycleHookSpecification (Maybe Text)
- lifecycleHookSpecification_lifecycleHookName :: Lens' LifecycleHookSpecification Text
- lifecycleHookSpecification_lifecycleTransition :: Lens' LifecycleHookSpecification Text
- data LoadBalancerState = LoadBalancerState' {}
- newLoadBalancerState :: LoadBalancerState
- loadBalancerState_state :: Lens' LoadBalancerState (Maybe Text)
- loadBalancerState_loadBalancerName :: Lens' LoadBalancerState (Maybe Text)
- data LoadBalancerTargetGroupState = LoadBalancerTargetGroupState' {}
- newLoadBalancerTargetGroupState :: LoadBalancerTargetGroupState
- loadBalancerTargetGroupState_state :: Lens' LoadBalancerTargetGroupState (Maybe Text)
- loadBalancerTargetGroupState_loadBalancerTargetGroupARN :: Lens' LoadBalancerTargetGroupState (Maybe Text)
- data LoadForecast = LoadForecast' {}
- newLoadForecast :: PredictiveScalingMetricSpecification -> LoadForecast
- loadForecast_timestamps :: Lens' LoadForecast [UTCTime]
- loadForecast_values :: Lens' LoadForecast [Double]
- loadForecast_metricSpecification :: Lens' LoadForecast PredictiveScalingMetricSpecification
- data MetricCollectionType = MetricCollectionType' {}
- newMetricCollectionType :: MetricCollectionType
- metricCollectionType_metric :: Lens' MetricCollectionType (Maybe Text)
- data MetricDimension = MetricDimension' {}
- newMetricDimension :: Text -> Text -> MetricDimension
- metricDimension_name :: Lens' MetricDimension Text
- metricDimension_value :: Lens' MetricDimension Text
- data MetricGranularityType = MetricGranularityType' {
- granularity :: Maybe Text
- newMetricGranularityType :: MetricGranularityType
- metricGranularityType_granularity :: Lens' MetricGranularityType (Maybe Text)
- data MixedInstancesPolicy = MixedInstancesPolicy' {}
- newMixedInstancesPolicy :: MixedInstancesPolicy
- mixedInstancesPolicy_launchTemplate :: Lens' MixedInstancesPolicy (Maybe LaunchTemplate)
- mixedInstancesPolicy_instancesDistribution :: Lens' MixedInstancesPolicy (Maybe InstancesDistribution)
- data NotificationConfiguration = NotificationConfiguration' {}
- newNotificationConfiguration :: NotificationConfiguration
- notificationConfiguration_topicARN :: Lens' NotificationConfiguration (Maybe Text)
- notificationConfiguration_autoScalingGroupName :: Lens' NotificationConfiguration (Maybe Text)
- notificationConfiguration_notificationType :: Lens' NotificationConfiguration (Maybe Text)
- data PredefinedMetricSpecification = PredefinedMetricSpecification' {}
- newPredefinedMetricSpecification :: MetricType -> PredefinedMetricSpecification
- predefinedMetricSpecification_resourceLabel :: Lens' PredefinedMetricSpecification (Maybe Text)
- predefinedMetricSpecification_predefinedMetricType :: Lens' PredefinedMetricSpecification MetricType
- data PredictiveScalingConfiguration = PredictiveScalingConfiguration' {}
- newPredictiveScalingConfiguration :: PredictiveScalingConfiguration
- predictiveScalingConfiguration_schedulingBufferTime :: Lens' PredictiveScalingConfiguration (Maybe Natural)
- predictiveScalingConfiguration_maxCapacityBuffer :: Lens' PredictiveScalingConfiguration (Maybe Natural)
- predictiveScalingConfiguration_mode :: Lens' PredictiveScalingConfiguration (Maybe PredictiveScalingMode)
- predictiveScalingConfiguration_maxCapacityBreachBehavior :: Lens' PredictiveScalingConfiguration (Maybe PredictiveScalingMaxCapacityBreachBehavior)
- predictiveScalingConfiguration_metricSpecifications :: Lens' PredictiveScalingConfiguration [PredictiveScalingMetricSpecification]
- data PredictiveScalingMetricSpecification = PredictiveScalingMetricSpecification' {}
- newPredictiveScalingMetricSpecification :: Double -> PredictiveScalingMetricSpecification
- predictiveScalingMetricSpecification_predefinedScalingMetricSpecification :: Lens' PredictiveScalingMetricSpecification (Maybe PredictiveScalingPredefinedScalingMetric)
- predictiveScalingMetricSpecification_predefinedMetricPairSpecification :: Lens' PredictiveScalingMetricSpecification (Maybe PredictiveScalingPredefinedMetricPair)
- predictiveScalingMetricSpecification_predefinedLoadMetricSpecification :: Lens' PredictiveScalingMetricSpecification (Maybe PredictiveScalingPredefinedLoadMetric)
- predictiveScalingMetricSpecification_targetValue :: Lens' PredictiveScalingMetricSpecification Double
- data PredictiveScalingPredefinedLoadMetric = PredictiveScalingPredefinedLoadMetric' {}
- newPredictiveScalingPredefinedLoadMetric :: PredefinedLoadMetricType -> PredictiveScalingPredefinedLoadMetric
- predictiveScalingPredefinedLoadMetric_resourceLabel :: Lens' PredictiveScalingPredefinedLoadMetric (Maybe Text)
- predictiveScalingPredefinedLoadMetric_predefinedMetricType :: Lens' PredictiveScalingPredefinedLoadMetric PredefinedLoadMetricType
- data PredictiveScalingPredefinedMetricPair = PredictiveScalingPredefinedMetricPair' {}
- newPredictiveScalingPredefinedMetricPair :: PredefinedMetricPairType -> PredictiveScalingPredefinedMetricPair
- predictiveScalingPredefinedMetricPair_resourceLabel :: Lens' PredictiveScalingPredefinedMetricPair (Maybe Text)
- predictiveScalingPredefinedMetricPair_predefinedMetricType :: Lens' PredictiveScalingPredefinedMetricPair PredefinedMetricPairType
- data PredictiveScalingPredefinedScalingMetric = PredictiveScalingPredefinedScalingMetric' {}
- newPredictiveScalingPredefinedScalingMetric :: PredefinedScalingMetricType -> PredictiveScalingPredefinedScalingMetric
- predictiveScalingPredefinedScalingMetric_resourceLabel :: Lens' PredictiveScalingPredefinedScalingMetric (Maybe Text)
- predictiveScalingPredefinedScalingMetric_predefinedMetricType :: Lens' PredictiveScalingPredefinedScalingMetric PredefinedScalingMetricType
- data ProcessType = ProcessType' {
- processName :: Text
- newProcessType :: Text -> ProcessType
- processType_processName :: Lens' ProcessType Text
- data RefreshPreferences = RefreshPreferences' {}
- newRefreshPreferences :: RefreshPreferences
- refreshPreferences_minHealthyPercentage :: Lens' RefreshPreferences (Maybe Natural)
- refreshPreferences_skipMatching :: Lens' RefreshPreferences (Maybe Bool)
- refreshPreferences_checkpointPercentages :: Lens' RefreshPreferences (Maybe [Natural])
- refreshPreferences_checkpointDelay :: Lens' RefreshPreferences (Maybe Natural)
- refreshPreferences_instanceWarmup :: Lens' RefreshPreferences (Maybe Natural)
- data ScalingPolicy = ScalingPolicy' {
- minAdjustmentStep :: Maybe Int
- estimatedInstanceWarmup :: Maybe Int
- policyName :: Maybe Text
- enabled :: Maybe Bool
- policyType :: Maybe Text
- stepAdjustments :: Maybe [StepAdjustment]
- targetTrackingConfiguration :: Maybe TargetTrackingConfiguration
- adjustmentType :: Maybe Text
- autoScalingGroupName :: Maybe Text
- predictiveScalingConfiguration :: Maybe PredictiveScalingConfiguration
- scalingAdjustment :: Maybe Int
- cooldown :: Maybe Int
- policyARN :: Maybe Text
- alarms :: Maybe [Alarm]
- metricAggregationType :: Maybe Text
- minAdjustmentMagnitude :: Maybe Int
- newScalingPolicy :: ScalingPolicy
- scalingPolicy_minAdjustmentStep :: Lens' ScalingPolicy (Maybe Int)
- scalingPolicy_estimatedInstanceWarmup :: Lens' ScalingPolicy (Maybe Int)
- scalingPolicy_policyName :: Lens' ScalingPolicy (Maybe Text)
- scalingPolicy_enabled :: Lens' ScalingPolicy (Maybe Bool)
- scalingPolicy_policyType :: Lens' ScalingPolicy (Maybe Text)
- scalingPolicy_stepAdjustments :: Lens' ScalingPolicy (Maybe [StepAdjustment])
- scalingPolicy_targetTrackingConfiguration :: Lens' ScalingPolicy (Maybe TargetTrackingConfiguration)
- scalingPolicy_adjustmentType :: Lens' ScalingPolicy (Maybe Text)
- scalingPolicy_autoScalingGroupName :: Lens' ScalingPolicy (Maybe Text)
- scalingPolicy_predictiveScalingConfiguration :: Lens' ScalingPolicy (Maybe PredictiveScalingConfiguration)
- scalingPolicy_scalingAdjustment :: Lens' ScalingPolicy (Maybe Int)
- scalingPolicy_cooldown :: Lens' ScalingPolicy (Maybe Int)
- scalingPolicy_policyARN :: Lens' ScalingPolicy (Maybe Text)
- scalingPolicy_alarms :: Lens' ScalingPolicy (Maybe [Alarm])
- scalingPolicy_metricAggregationType :: Lens' ScalingPolicy (Maybe Text)
- scalingPolicy_minAdjustmentMagnitude :: Lens' ScalingPolicy (Maybe Int)
- data ScalingProcessQuery = ScalingProcessQuery' {}
- newScalingProcessQuery :: Text -> ScalingProcessQuery
- scalingProcessQuery_scalingProcesses :: Lens' ScalingProcessQuery (Maybe [Text])
- scalingProcessQuery_autoScalingGroupName :: Lens' ScalingProcessQuery Text
- data ScheduledUpdateGroupAction = ScheduledUpdateGroupAction' {}
- newScheduledUpdateGroupAction :: ScheduledUpdateGroupAction
- scheduledUpdateGroupAction_scheduledActionARN :: Lens' ScheduledUpdateGroupAction (Maybe Text)
- scheduledUpdateGroupAction_startTime :: Lens' ScheduledUpdateGroupAction (Maybe UTCTime)
- scheduledUpdateGroupAction_time :: Lens' ScheduledUpdateGroupAction (Maybe UTCTime)
- scheduledUpdateGroupAction_scheduledActionName :: Lens' ScheduledUpdateGroupAction (Maybe Text)
- scheduledUpdateGroupAction_maxSize :: Lens' ScheduledUpdateGroupAction (Maybe Int)
- scheduledUpdateGroupAction_recurrence :: Lens' ScheduledUpdateGroupAction (Maybe Text)
- scheduledUpdateGroupAction_desiredCapacity :: Lens' ScheduledUpdateGroupAction (Maybe Int)
- scheduledUpdateGroupAction_minSize :: Lens' ScheduledUpdateGroupAction (Maybe Int)
- scheduledUpdateGroupAction_autoScalingGroupName :: Lens' ScheduledUpdateGroupAction (Maybe Text)
- scheduledUpdateGroupAction_endTime :: Lens' ScheduledUpdateGroupAction (Maybe UTCTime)
- scheduledUpdateGroupAction_timeZone :: Lens' ScheduledUpdateGroupAction (Maybe Text)
- data ScheduledUpdateGroupActionRequest = ScheduledUpdateGroupActionRequest' {}
- newScheduledUpdateGroupActionRequest :: Text -> ScheduledUpdateGroupActionRequest
- scheduledUpdateGroupActionRequest_startTime :: Lens' ScheduledUpdateGroupActionRequest (Maybe UTCTime)
- scheduledUpdateGroupActionRequest_maxSize :: Lens' ScheduledUpdateGroupActionRequest (Maybe Int)
- scheduledUpdateGroupActionRequest_recurrence :: Lens' ScheduledUpdateGroupActionRequest (Maybe Text)
- scheduledUpdateGroupActionRequest_desiredCapacity :: Lens' ScheduledUpdateGroupActionRequest (Maybe Int)
- scheduledUpdateGroupActionRequest_minSize :: Lens' ScheduledUpdateGroupActionRequest (Maybe Int)
- scheduledUpdateGroupActionRequest_endTime :: Lens' ScheduledUpdateGroupActionRequest (Maybe UTCTime)
- scheduledUpdateGroupActionRequest_timeZone :: Lens' ScheduledUpdateGroupActionRequest (Maybe Text)
- scheduledUpdateGroupActionRequest_scheduledActionName :: Lens' ScheduledUpdateGroupActionRequest Text
- data StepAdjustment = StepAdjustment' {}
- newStepAdjustment :: Int -> StepAdjustment
- stepAdjustment_metricIntervalLowerBound :: Lens' StepAdjustment (Maybe Double)
- stepAdjustment_metricIntervalUpperBound :: Lens' StepAdjustment (Maybe Double)
- stepAdjustment_scalingAdjustment :: Lens' StepAdjustment Int
- data SuspendedProcess = SuspendedProcess' {}
- newSuspendedProcess :: SuspendedProcess
- suspendedProcess_processName :: Lens' SuspendedProcess (Maybe Text)
- suspendedProcess_suspensionReason :: Lens' SuspendedProcess (Maybe Text)
- data Tag = Tag' {
- key :: Text
- resourceId :: Text
- resourceType :: Text
- propagateAtLaunch :: Bool
- value :: Text
- newTag :: Text -> Text -> Text -> Bool -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_resourceId :: Lens' Tag Text
- tag_resourceType :: Lens' Tag Text
- tag_propagateAtLaunch :: Lens' Tag Bool
- tag_value :: Lens' Tag Text
- data TagDescription = TagDescription' {
- resourceId :: Text
- resourceType :: Text
- key :: Text
- propagateAtLaunch :: Bool
- value :: Text
- newTagDescription :: Text -> Text -> Text -> Bool -> Text -> TagDescription
- tagDescription_resourceId :: Lens' TagDescription Text
- tagDescription_resourceType :: Lens' TagDescription Text
- tagDescription_key :: Lens' TagDescription Text
- tagDescription_propagateAtLaunch :: Lens' TagDescription Bool
- tagDescription_value :: Lens' TagDescription Text
- data TargetTrackingConfiguration = TargetTrackingConfiguration' {}
- newTargetTrackingConfiguration :: Double -> TargetTrackingConfiguration
- targetTrackingConfiguration_predefinedMetricSpecification :: Lens' TargetTrackingConfiguration (Maybe PredefinedMetricSpecification)
- targetTrackingConfiguration_customizedMetricSpecification :: Lens' TargetTrackingConfiguration (Maybe CustomizedMetricSpecification)
- targetTrackingConfiguration_disableScaleIn :: Lens' TargetTrackingConfiguration (Maybe Bool)
- targetTrackingConfiguration_targetValue :: Lens' TargetTrackingConfiguration Double
- data WarmPoolConfiguration = WarmPoolConfiguration' {}
- newWarmPoolConfiguration :: WarmPoolConfiguration
- warmPoolConfiguration_status :: Lens' WarmPoolConfiguration (Maybe WarmPoolStatus)
- warmPoolConfiguration_minSize :: Lens' WarmPoolConfiguration (Maybe Natural)
- warmPoolConfiguration_maxGroupPreparedCapacity :: Lens' WarmPoolConfiguration (Maybe Int)
- warmPoolConfiguration_poolState :: Lens' WarmPoolConfiguration (Maybe WarmPoolState)
Service Configuration
defaultService :: Service Source #
API version 2011-01-01 of the Amazon Auto Scaling SDK configuration.
Errors
_InstanceRefreshInProgressFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request failed because an active instance refresh operation already exists for the specified Auto Scaling group.
_AlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You already have an Auto Scaling group or launch configuration with this name.
_LimitExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.
_ResourceInUseFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation can't be performed because the resource is in use.
_InvalidNextToken :: AsError a => Getting (First ServiceError) a ServiceError Source #
The NextToken value is not valid.
_ScalingActivityInProgressFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation can't be performed because there are scaling activities in progress.
_ResourceContentionFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).
_ServiceLinkedRoleFailure :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service-linked role is not yet ready for use.
_ActiveInstanceRefreshNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request failed because an active instance refresh for the specified Auto Scaling group was not found.
InstanceMetadataEndpointState
newtype InstanceMetadataEndpointState Source #
Constructors
| InstanceMetadataEndpointState' | |
Fields | |
Bundled Patterns
| pattern InstanceMetadataEndpointState_Disabled :: InstanceMetadataEndpointState | |
| pattern InstanceMetadataEndpointState_Enabled :: InstanceMetadataEndpointState |
Instances
InstanceMetadataHttpTokensState
newtype InstanceMetadataHttpTokensState Source #
Constructors
| InstanceMetadataHttpTokensState' | |
Fields | |
Bundled Patterns
| pattern InstanceMetadataHttpTokensState_Optional :: InstanceMetadataHttpTokensState | |
| pattern InstanceMetadataHttpTokensState_Required :: InstanceMetadataHttpTokensState |
Instances
InstanceRefreshStatus
newtype InstanceRefreshStatus Source #
Constructors
| InstanceRefreshStatus' | |
Fields | |
Bundled Patterns
Instances
LifecycleState
newtype LifecycleState Source #
Constructors
| LifecycleState' | |
Fields | |
Bundled Patterns
Instances
MetricStatistic
newtype MetricStatistic Source #
Constructors
| MetricStatistic' | |
Fields | |
Bundled Patterns
| pattern MetricStatistic_Average :: MetricStatistic | |
| pattern MetricStatistic_Maximum :: MetricStatistic | |
| pattern MetricStatistic_Minimum :: MetricStatistic | |
| pattern MetricStatistic_SampleCount :: MetricStatistic | |
| pattern MetricStatistic_Sum :: MetricStatistic |
Instances
MetricType
newtype MetricType Source #
Constructors
| MetricType' | |
Fields | |
Bundled Patterns
| pattern MetricType_ALBRequestCountPerTarget :: MetricType | |
| pattern MetricType_ASGAverageCPUUtilization :: MetricType | |
| pattern MetricType_ASGAverageNetworkIn :: MetricType | |
| pattern MetricType_ASGAverageNetworkOut :: MetricType |
Instances
PredefinedLoadMetricType
newtype PredefinedLoadMetricType Source #
Constructors
| PredefinedLoadMetricType' | |
Fields | |
Bundled Patterns
Instances
PredefinedMetricPairType
newtype PredefinedMetricPairType Source #
Constructors
| PredefinedMetricPairType' | |
Fields | |
Bundled Patterns
Instances
PredefinedScalingMetricType
newtype PredefinedScalingMetricType Source #
Constructors
| PredefinedScalingMetricType' | |
Fields | |
Bundled Patterns
Instances
PredictiveScalingMaxCapacityBreachBehavior
newtype PredictiveScalingMaxCapacityBreachBehavior Source #
Constructors
| PredictiveScalingMaxCapacityBreachBehavior' | |
Bundled Patterns
Instances
PredictiveScalingMode
newtype PredictiveScalingMode Source #
Constructors
| PredictiveScalingMode' | |
Fields | |
Bundled Patterns
| pattern PredictiveScalingMode_ForecastAndScale :: PredictiveScalingMode | |
| pattern PredictiveScalingMode_ForecastOnly :: PredictiveScalingMode |
Instances
RefreshStrategy
newtype RefreshStrategy Source #
Constructors
| RefreshStrategy' | |
Fields | |
Bundled Patterns
| pattern RefreshStrategy_Rolling :: RefreshStrategy |
Instances
ScalingActivityStatusCode
newtype ScalingActivityStatusCode Source #
Constructors
| ScalingActivityStatusCode' | |
Fields | |
Bundled Patterns
Instances
WarmPoolState
newtype WarmPoolState Source #
Constructors
| WarmPoolState' | |
Fields | |
Bundled Patterns
| pattern WarmPoolState_Running :: WarmPoolState | |
| pattern WarmPoolState_Stopped :: WarmPoolState |
Instances
WarmPoolStatus
newtype WarmPoolStatus Source #
Constructors
| WarmPoolStatus' | |
Fields | |
Bundled Patterns
| pattern WarmPoolStatus_PendingDelete :: WarmPoolStatus |
Instances
Activity
Describes scaling activity, which is a long-running process that represents a change to your Auto Scaling group, such as changing its size or replacing an instance.
See: newActivity smart constructor.
Constructors
| Activity' | |
Fields
| |
Instances
Create a value of Activity 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:progress:Activity', activity_progress - A value between 0 and 100 that indicates the progress of the activity.
$sel:statusMessage:Activity', activity_statusMessage - A friendly, more verbose description of the activity status.
$sel:autoScalingGroupState:Activity', activity_autoScalingGroupState - The state of the Auto Scaling group, which is either InService or
Deleted.
$sel:endTime:Activity', activity_endTime - The end time of the activity.
$sel:details:Activity', activity_details - The details about the activity.
$sel:autoScalingGroupARN:Activity', activity_autoScalingGroupARN - The Amazon Resource Name (ARN) of the Auto Scaling group.
$sel:description:Activity', activity_description - A friendly, more verbose description of the activity.
$sel:activityId:Activity', activity_activityId - The ID of the activity.
$sel:autoScalingGroupName:Activity', activity_autoScalingGroupName - The name of the Auto Scaling group.
$sel:cause:Activity', activity_cause - The reason the activity began.
$sel:startTime:Activity', activity_startTime - The start time of the activity.
$sel:statusCode:Activity', activity_statusCode - The current status of the activity.
activity_progress :: Lens' Activity (Maybe Int) Source #
A value between 0 and 100 that indicates the progress of the activity.
activity_statusMessage :: Lens' Activity (Maybe Text) Source #
A friendly, more verbose description of the activity status.
activity_autoScalingGroupState :: Lens' Activity (Maybe Text) Source #
The state of the Auto Scaling group, which is either InService or
Deleted.
activity_autoScalingGroupARN :: Lens' Activity (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Auto Scaling group.
activity_description :: Lens' Activity (Maybe Text) Source #
A friendly, more verbose description of the activity.
activity_statusCode :: Lens' Activity ScalingActivityStatusCode Source #
The current status of the activity.
AdjustmentType
data AdjustmentType Source #
Describes a policy adjustment type.
See: newAdjustmentType smart constructor.
Constructors
| AdjustmentType' | |
Fields
| |
Instances
newAdjustmentType :: AdjustmentType Source #
Create a value of AdjustmentType 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:adjustmentType:AdjustmentType', adjustmentType_adjustmentType - The policy adjustment type. The valid values are ChangeInCapacity,
ExactCapacity, and PercentChangeInCapacity.
adjustmentType_adjustmentType :: Lens' AdjustmentType (Maybe Text) Source #
The policy adjustment type. The valid values are ChangeInCapacity,
ExactCapacity, and PercentChangeInCapacity.
Alarm
Describes an alarm.
See: newAlarm smart constructor.
Constructors
| Alarm' | |
Instances
| Eq Alarm Source # | |
| Read Alarm Source # | |
| Show Alarm Source # | |
| Generic Alarm Source # | |
| NFData Alarm Source # | |
Defined in Amazonka.AutoScaling.Types.Alarm | |
| Hashable Alarm Source # | |
Defined in Amazonka.AutoScaling.Types.Alarm | |
| FromXML Alarm Source # | |
| type Rep Alarm Source # | |
Defined in Amazonka.AutoScaling.Types.Alarm type Rep Alarm = D1 ('MetaData "Alarm" "Amazonka.AutoScaling.Types.Alarm" "libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling" 'False) (C1 ('MetaCons "Alarm'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alarmName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "alarmARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Alarm 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:alarmName:Alarm', alarm_alarmName - The name of the alarm.
$sel:alarmARN:Alarm', alarm_alarmARN - The Amazon Resource Name (ARN) of the alarm.
AutoScalingGroup
data AutoScalingGroup Source #
Describes an Auto Scaling group.
See: newAutoScalingGroup smart constructor.
Constructors
| AutoScalingGroup' | |
Fields
| |
Instances
Create a value of AutoScalingGroup 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:AutoScalingGroup', autoScalingGroup_status - The current state of the group when the DeleteAutoScalingGroup operation
is in progress.
$sel:context:AutoScalingGroup', autoScalingGroup_context - Reserved.
$sel:terminationPolicies:AutoScalingGroup', autoScalingGroup_terminationPolicies - The termination policies for the group.
$sel:healthCheckGracePeriod:AutoScalingGroup', autoScalingGroup_healthCheckGracePeriod - The amount of time, in seconds, that Amazon EC2 Auto Scaling waits
before checking the health status of an EC2 instance that has come into
service.
$sel:serviceLinkedRoleARN:AutoScalingGroup', autoScalingGroup_serviceLinkedRoleARN - The Amazon Resource Name (ARN) of the service-linked role that the Auto
Scaling group uses to call other Amazon Web Services on your behalf.
$sel:newInstancesProtectedFromScaleIn':AutoScalingGroup', autoScalingGroup_newInstancesProtectedFromScaleIn - Indicates whether newly launched instances are protected from
termination by Amazon EC2 Auto Scaling when scaling in.
$sel:vPCZoneIdentifier:AutoScalingGroup', autoScalingGroup_vPCZoneIdentifier - One or more subnet IDs, if applicable, separated by commas.
$sel:targetGroupARNs:AutoScalingGroup', autoScalingGroup_targetGroupARNs - The Amazon Resource Names (ARN) of the target groups for your load
balancer.
$sel:maxInstanceLifetime:AutoScalingGroup', autoScalingGroup_maxInstanceLifetime - The maximum amount of time, in seconds, that an instance can be in
service.
Valid Range: Minimum value of 0.
$sel:mixedInstancesPolicy:AutoScalingGroup', autoScalingGroup_mixedInstancesPolicy - The mixed instances policy for the group.
$sel:enabledMetrics:AutoScalingGroup', autoScalingGroup_enabledMetrics - The metrics enabled for the group.
$sel:launchConfigurationName:AutoScalingGroup', autoScalingGroup_launchConfigurationName - The name of the associated launch configuration.
$sel:instances:AutoScalingGroup', autoScalingGroup_instances - The EC2 instances associated with the group.
$sel:launchTemplate:AutoScalingGroup', autoScalingGroup_launchTemplate - The launch template for the group.
$sel:warmPoolConfiguration:AutoScalingGroup', autoScalingGroup_warmPoolConfiguration - The warm pool for the group.
$sel:capacityRebalance:AutoScalingGroup', autoScalingGroup_capacityRebalance - Indicates whether Capacity Rebalancing is enabled.
$sel:autoScalingGroupARN:AutoScalingGroup', autoScalingGroup_autoScalingGroupARN - The Amazon Resource Name (ARN) of the Auto Scaling group.
$sel:predictedCapacity:AutoScalingGroup', autoScalingGroup_predictedCapacity - The predicted capacity of the group when it has a predictive scaling
policy.
$sel:warmPoolSize:AutoScalingGroup', autoScalingGroup_warmPoolSize - The current size of the warm pool.
$sel:placementGroup:AutoScalingGroup', autoScalingGroup_placementGroup - The name of the placement group into which to launch your instances, if
any.
$sel:suspendedProcesses:AutoScalingGroup', autoScalingGroup_suspendedProcesses - The suspended processes associated with the group.
$sel:loadBalancerNames:AutoScalingGroup', autoScalingGroup_loadBalancerNames - One or more load balancers associated with the group.
$sel:tags:AutoScalingGroup', autoScalingGroup_tags - The tags for the group.
$sel:autoScalingGroupName:AutoScalingGroup', autoScalingGroup_autoScalingGroupName - The name of the Auto Scaling group.
$sel:minSize:AutoScalingGroup', autoScalingGroup_minSize - The minimum size of the group.
$sel:maxSize:AutoScalingGroup', autoScalingGroup_maxSize - The maximum size of the group.
$sel:desiredCapacity:AutoScalingGroup', autoScalingGroup_desiredCapacity - The desired size of the group.
$sel:defaultCooldown:AutoScalingGroup', autoScalingGroup_defaultCooldown - The duration of the default cooldown period, in seconds.
$sel:availabilityZones:AutoScalingGroup', autoScalingGroup_availabilityZones - One or more Availability Zones for the group.
$sel:healthCheckType:AutoScalingGroup', autoScalingGroup_healthCheckType - The service to use for the health checks. The valid values are EC2 and
ELB. If you configure an Auto Scaling group to use ELB health
checks, it considers the instance unhealthy if it fails either the EC2
status checks or the load balancer health checks.
$sel:createdTime:AutoScalingGroup', autoScalingGroup_createdTime - The date and time the group was created.
autoScalingGroup_status :: Lens' AutoScalingGroup (Maybe Text) Source #
The current state of the group when the DeleteAutoScalingGroup operation is in progress.
autoScalingGroup_context :: Lens' AutoScalingGroup (Maybe Text) Source #
Reserved.
autoScalingGroup_terminationPolicies :: Lens' AutoScalingGroup (Maybe [Text]) Source #
The termination policies for the group.
autoScalingGroup_healthCheckGracePeriod :: Lens' AutoScalingGroup (Maybe Int) Source #
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
autoScalingGroup_serviceLinkedRoleARN :: Lens' AutoScalingGroup (Maybe Text) Source #
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf.
autoScalingGroup_newInstancesProtectedFromScaleIn :: Lens' AutoScalingGroup (Maybe Bool) Source #
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
autoScalingGroup_vPCZoneIdentifier :: Lens' AutoScalingGroup (Maybe Text) Source #
One or more subnet IDs, if applicable, separated by commas.
autoScalingGroup_targetGroupARNs :: Lens' AutoScalingGroup (Maybe [Text]) Source #
The Amazon Resource Names (ARN) of the target groups for your load balancer.
autoScalingGroup_maxInstanceLifetime :: Lens' AutoScalingGroup (Maybe Int) Source #
The maximum amount of time, in seconds, that an instance can be in service.
Valid Range: Minimum value of 0.
autoScalingGroup_mixedInstancesPolicy :: Lens' AutoScalingGroup (Maybe MixedInstancesPolicy) Source #
The mixed instances policy for the group.
autoScalingGroup_enabledMetrics :: Lens' AutoScalingGroup (Maybe [EnabledMetric]) Source #
The metrics enabled for the group.
autoScalingGroup_launchConfigurationName :: Lens' AutoScalingGroup (Maybe Text) Source #
The name of the associated launch configuration.
autoScalingGroup_instances :: Lens' AutoScalingGroup (Maybe [Instance]) Source #
The EC2 instances associated with the group.
autoScalingGroup_launchTemplate :: Lens' AutoScalingGroup (Maybe LaunchTemplateSpecification) Source #
The launch template for the group.
autoScalingGroup_warmPoolConfiguration :: Lens' AutoScalingGroup (Maybe WarmPoolConfiguration) Source #
The warm pool for the group.
autoScalingGroup_capacityRebalance :: Lens' AutoScalingGroup (Maybe Bool) Source #
Indicates whether Capacity Rebalancing is enabled.
autoScalingGroup_autoScalingGroupARN :: Lens' AutoScalingGroup (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Auto Scaling group.
autoScalingGroup_predictedCapacity :: Lens' AutoScalingGroup (Maybe Int) Source #
The predicted capacity of the group when it has a predictive scaling policy.
autoScalingGroup_warmPoolSize :: Lens' AutoScalingGroup (Maybe Int) Source #
The current size of the warm pool.
autoScalingGroup_placementGroup :: Lens' AutoScalingGroup (Maybe Text) Source #
The name of the placement group into which to launch your instances, if any.
autoScalingGroup_suspendedProcesses :: Lens' AutoScalingGroup (Maybe [SuspendedProcess]) Source #
The suspended processes associated with the group.
autoScalingGroup_loadBalancerNames :: Lens' AutoScalingGroup (Maybe [Text]) Source #
One or more load balancers associated with the group.
autoScalingGroup_tags :: Lens' AutoScalingGroup (Maybe [TagDescription]) Source #
The tags for the group.
autoScalingGroup_autoScalingGroupName :: Lens' AutoScalingGroup Text Source #
The name of the Auto Scaling group.
autoScalingGroup_minSize :: Lens' AutoScalingGroup Int Source #
The minimum size of the group.
autoScalingGroup_maxSize :: Lens' AutoScalingGroup Int Source #
The maximum size of the group.
autoScalingGroup_desiredCapacity :: Lens' AutoScalingGroup Int Source #
The desired size of the group.
autoScalingGroup_defaultCooldown :: Lens' AutoScalingGroup Int Source #
The duration of the default cooldown period, in seconds.
autoScalingGroup_availabilityZones :: Lens' AutoScalingGroup [Text] Source #
One or more Availability Zones for the group.
autoScalingGroup_healthCheckType :: Lens' AutoScalingGroup Text Source #
The service to use for the health checks. The valid values are EC2 and
ELB. If you configure an Auto Scaling group to use ELB health
checks, it considers the instance unhealthy if it fails either the EC2
status checks or the load balancer health checks.
autoScalingGroup_createdTime :: Lens' AutoScalingGroup UTCTime Source #
The date and time the group was created.
AutoScalingInstanceDetails
data AutoScalingInstanceDetails Source #
Describes an EC2 instance associated with an Auto Scaling group.
See: newAutoScalingInstanceDetails smart constructor.
Constructors
| AutoScalingInstanceDetails' | |
Fields
| |
Instances
newAutoScalingInstanceDetails Source #
Create a value of AutoScalingInstanceDetails 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:weightedCapacity:AutoScalingInstanceDetails', autoScalingInstanceDetails_weightedCapacity - The number of capacity units contributed by the instance based on its
instance type.
Valid Range: Minimum value of 1. Maximum value of 999.
$sel:instanceType:AutoScalingInstanceDetails', autoScalingInstanceDetails_instanceType - The instance type of the EC2 instance.
$sel:launchConfigurationName:AutoScalingInstanceDetails', autoScalingInstanceDetails_launchConfigurationName - The launch configuration used to launch the instance. This value is not
available if you attached the instance to the Auto Scaling group.
$sel:launchTemplate:AutoScalingInstanceDetails', autoScalingInstanceDetails_launchTemplate - The launch template for the instance.
$sel:instanceId:AutoScalingInstanceDetails', autoScalingInstanceDetails_instanceId - The ID of the instance.
$sel:autoScalingGroupName:AutoScalingInstanceDetails', autoScalingInstanceDetails_autoScalingGroupName - The name of the Auto Scaling group for the instance.
$sel:availabilityZone:AutoScalingInstanceDetails', autoScalingInstanceDetails_availabilityZone - The Availability Zone for the instance.
$sel:lifecycleState:AutoScalingInstanceDetails', autoScalingInstanceDetails_lifecycleState - The lifecycle state for the instance. The Quarantined state is not
used. For information about lifecycle states, see
Instance lifecycle
in the Amazon EC2 Auto Scaling User Guide.
Valid Values: Pending | Pending:Wait | Pending:Proceed |
Quarantined | InService | Terminating | Terminating:Wait |
Terminating:Proceed | Terminated | Detaching | Detached |
EnteringStandby | Standby | Warmed:Pending | Warmed:Pending:Wait
| Warmed:Pending:Proceed | Warmed:Terminating |
Warmed:Terminating:Wait | Warmed:Terminating:Proceed |
Warmed:Terminated | Warmed:Stopped | Warmed:Running
$sel:healthStatus:AutoScalingInstanceDetails', autoScalingInstanceDetails_healthStatus - The last reported health status of this instance. "Healthy" means that
the instance is healthy and should remain in service. "Unhealthy"
means that the instance is unhealthy and Amazon EC2 Auto Scaling should
terminate and replace it.
$sel:protectedFromScaleIn:AutoScalingInstanceDetails', autoScalingInstanceDetails_protectedFromScaleIn - Indicates whether the instance is protected from termination by Amazon
EC2 Auto Scaling when scaling in.
autoScalingInstanceDetails_weightedCapacity :: Lens' AutoScalingInstanceDetails (Maybe Text) Source #
The number of capacity units contributed by the instance based on its instance type.
Valid Range: Minimum value of 1. Maximum value of 999.
autoScalingInstanceDetails_instanceType :: Lens' AutoScalingInstanceDetails (Maybe Text) Source #
The instance type of the EC2 instance.
autoScalingInstanceDetails_launchConfigurationName :: Lens' AutoScalingInstanceDetails (Maybe Text) Source #
The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.
autoScalingInstanceDetails_launchTemplate :: Lens' AutoScalingInstanceDetails (Maybe LaunchTemplateSpecification) Source #
The launch template for the instance.
autoScalingInstanceDetails_instanceId :: Lens' AutoScalingInstanceDetails Text Source #
The ID of the instance.
autoScalingInstanceDetails_autoScalingGroupName :: Lens' AutoScalingInstanceDetails Text Source #
The name of the Auto Scaling group for the instance.
autoScalingInstanceDetails_availabilityZone :: Lens' AutoScalingInstanceDetails Text Source #
The Availability Zone for the instance.
autoScalingInstanceDetails_lifecycleState :: Lens' AutoScalingInstanceDetails Text Source #
The lifecycle state for the instance. The Quarantined state is not
used. For information about lifecycle states, see
Instance lifecycle
in the Amazon EC2 Auto Scaling User Guide.
Valid Values: Pending | Pending:Wait | Pending:Proceed |
Quarantined | InService | Terminating | Terminating:Wait |
Terminating:Proceed | Terminated | Detaching | Detached |
EnteringStandby | Standby | Warmed:Pending | Warmed:Pending:Wait
| Warmed:Pending:Proceed | Warmed:Terminating |
Warmed:Terminating:Wait | Warmed:Terminating:Proceed |
Warmed:Terminated | Warmed:Stopped | Warmed:Running
autoScalingInstanceDetails_healthStatus :: Lens' AutoScalingInstanceDetails Text Source #
The last reported health status of this instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.
autoScalingInstanceDetails_protectedFromScaleIn :: Lens' AutoScalingInstanceDetails Bool Source #
Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
BlockDeviceMapping
data BlockDeviceMapping Source #
Describes a block device mapping.
See: newBlockDeviceMapping smart constructor.
Constructors
| BlockDeviceMapping' | |
Fields
| |
Instances
newBlockDeviceMapping Source #
Arguments
| :: Text | |
| -> BlockDeviceMapping |
Create a value of BlockDeviceMapping 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:virtualName:BlockDeviceMapping', blockDeviceMapping_virtualName - The name of the virtual device (for example, ephemeral0).
You can specify either VirtualName or Ebs, but not both.
$sel:noDevice:BlockDeviceMapping', blockDeviceMapping_noDevice - Setting this value to true suppresses the specified device included in
the block device mapping of the AMI.
If NoDevice is true for the root device, instances might fail the
EC2 health check. In that case, Amazon EC2 Auto Scaling launches
replacement instances.
If you specify NoDevice, you cannot specify Ebs.
$sel:ebs:BlockDeviceMapping', blockDeviceMapping_ebs - Parameters used to automatically set up EBS volumes when an instance is
launched.
You can specify either VirtualName or Ebs, but not both.
$sel:deviceName:BlockDeviceMapping', blockDeviceMapping_deviceName - The device name exposed to the EC2 instance (for example, /dev/sdh
or xvdh). For more information, see
Device Naming on Linux Instances
in the Amazon EC2 User Guide for Linux Instances.
blockDeviceMapping_virtualName :: Lens' BlockDeviceMapping (Maybe Text) Source #
The name of the virtual device (for example, ephemeral0).
You can specify either VirtualName or Ebs, but not both.
blockDeviceMapping_noDevice :: Lens' BlockDeviceMapping (Maybe Bool) Source #
Setting this value to true suppresses the specified device included in
the block device mapping of the AMI.
If NoDevice is true for the root device, instances might fail the
EC2 health check. In that case, Amazon EC2 Auto Scaling launches
replacement instances.
If you specify NoDevice, you cannot specify Ebs.
blockDeviceMapping_ebs :: Lens' BlockDeviceMapping (Maybe Ebs) Source #
Parameters used to automatically set up EBS volumes when an instance is launched.
You can specify either VirtualName or Ebs, but not both.
blockDeviceMapping_deviceName :: Lens' BlockDeviceMapping Text Source #
The device name exposed to the EC2 instance (for example, /dev/sdh
or xvdh). For more information, see
Device Naming on Linux Instances
in the Amazon EC2 User Guide for Linux Instances.
CapacityForecast
data CapacityForecast Source #
A GetPredictiveScalingForecast call returns the capacity forecast for
a predictive scaling policy. This structure includes the data points for
that capacity forecast, along with the timestamps of those data points.
See: newCapacityForecast smart constructor.
Constructors
| CapacityForecast' | |
Fields
| |
Instances
newCapacityForecast :: CapacityForecast Source #
Create a value of CapacityForecast 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:timestamps:CapacityForecast', capacityForecast_timestamps - The time stamps for the data points, in UTC format.
$sel:values:CapacityForecast', capacityForecast_values - The values of the data points.
capacityForecast_timestamps :: Lens' CapacityForecast [UTCTime] Source #
The time stamps for the data points, in UTC format.
capacityForecast_values :: Lens' CapacityForecast [Double] Source #
The values of the data points.
CustomizedMetricSpecification
data CustomizedMetricSpecification Source #
Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.
To create your customized metric specification:
- Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.
- Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.
For more information about CloudWatch, see Amazon CloudWatch Concepts.
See: newCustomizedMetricSpecification smart constructor.
Constructors
| CustomizedMetricSpecification' | |
Fields
| |
Instances
newCustomizedMetricSpecification Source #
Arguments
| :: Text | |
| -> Text | |
| -> MetricStatistic | |
| -> CustomizedMetricSpecification |
Create a value of CustomizedMetricSpecification 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:dimensions:CustomizedMetricSpecification', customizedMetricSpecification_dimensions - The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
$sel:unit:CustomizedMetricSpecification', customizedMetricSpecification_unit - The unit of the metric.
$sel:metricName:CustomizedMetricSpecification', customizedMetricSpecification_metricName - The name of the metric.
$sel:namespace:CustomizedMetricSpecification', customizedMetricSpecification_namespace - The namespace of the metric.
$sel:statistic:CustomizedMetricSpecification', customizedMetricSpecification_statistic - The statistic of the metric.
customizedMetricSpecification_dimensions :: Lens' CustomizedMetricSpecification (Maybe [MetricDimension]) Source #
The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
customizedMetricSpecification_unit :: Lens' CustomizedMetricSpecification (Maybe Text) Source #
The unit of the metric.
customizedMetricSpecification_metricName :: Lens' CustomizedMetricSpecification Text Source #
The name of the metric.
customizedMetricSpecification_namespace :: Lens' CustomizedMetricSpecification Text Source #
The namespace of the metric.
customizedMetricSpecification_statistic :: Lens' CustomizedMetricSpecification MetricStatistic Source #
The statistic of the metric.
DesiredConfiguration
data DesiredConfiguration Source #
Describes the desired configuration for an instance refresh.
If you specify a desired configuration, you must specify either a
LaunchTemplate or a MixedInstancesPolicy.
See: newDesiredConfiguration smart constructor.
Constructors
| DesiredConfiguration' | |
Instances
newDesiredConfiguration :: DesiredConfiguration Source #
Create a value of DesiredConfiguration 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:mixedInstancesPolicy:DesiredConfiguration', desiredConfiguration_mixedInstancesPolicy - Undocumented member.
$sel:launchTemplate:DesiredConfiguration', desiredConfiguration_launchTemplate - Undocumented member.
desiredConfiguration_mixedInstancesPolicy :: Lens' DesiredConfiguration (Maybe MixedInstancesPolicy) Source #
Undocumented member.
desiredConfiguration_launchTemplate :: Lens' DesiredConfiguration (Maybe LaunchTemplateSpecification) Source #
Undocumented member.
Ebs
Describes information used to set up an Amazon EBS volume specified in a block device mapping.
See: newEbs smart constructor.
Constructors
| Ebs' | |
Fields
| |
Instances
Create a value of Ebs 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:deleteOnTermination:Ebs', ebs_deleteOnTermination - Indicates whether the volume is deleted on instance termination. For
Amazon EC2 Auto Scaling, the default value is true.
$sel:throughput:Ebs', ebs_throughput - The throughput (MiBps) to provision for a gp3 volume.
$sel:volumeSize:Ebs', ebs_volumeSize - The volume size, in GiBs. The following are the supported volumes sizes
for each volume type:
gp2andgp3: 1-16,384io1: 4-16,384st1andsc1: 125-16,384standard: 1-1,024
You must specify either a SnapshotId or a VolumeSize. If you specify
both SnapshotId and VolumeSize, the volume size must be equal or
greater than the size of the snapshot.
$sel:iops:Ebs', ebs_iops - The number of input/output (I/O) operations per second (IOPS) to
provision for the volume. For gp3 and io1 volumes, this represents
the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline performance of the volume and the
rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPSio1: 100-64,000 IOPS
For io1 volumes, we guarantee 64,000 IOPS only for
Instances built on the Nitro System.
Other instance families guarantee performance up to 32,000 IOPS.
Iops is supported when the volume type is gp3 or io1 and required
only when the volume type is io1. (Not used with standard, gp2,
st1, or sc1 volumes.)
$sel:encrypted:Ebs', ebs_encrypted - Specifies whether the volume should be encrypted. Encrypted EBS volumes
can only be attached to instances that support Amazon EBS encryption.
For more information, see
Supported instance types.
If your AMI uses encrypted volumes, you can also only launch it on
supported instance types.
If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.
If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted.
For more information, see Using Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide.
$sel:volumeType:Ebs', ebs_volumeType - The volume type. For more information, see
Amazon EBS volume types
in the Amazon EC2 User Guide for Linux Instances.
Valid Values: standard | io1 | gp2 | st1 | sc1 | gp3
$sel:snapshotId:Ebs', ebs_snapshotId - The snapshot ID of the volume to use.
You must specify either a VolumeSize or a SnapshotId.
ebs_deleteOnTermination :: Lens' Ebs (Maybe Bool) Source #
Indicates whether the volume is deleted on instance termination. For
Amazon EC2 Auto Scaling, the default value is true.
ebs_throughput :: Lens' Ebs (Maybe Natural) Source #
The throughput (MiBps) to provision for a gp3 volume.
ebs_volumeSize :: Lens' Ebs (Maybe Natural) Source #
The volume size, in GiBs. The following are the supported volumes sizes for each volume type:
gp2andgp3: 1-16,384io1: 4-16,384st1andsc1: 125-16,384standard: 1-1,024
You must specify either a SnapshotId or a VolumeSize. If you specify
both SnapshotId and VolumeSize, the volume size must be equal or
greater than the size of the snapshot.
ebs_iops :: Lens' Ebs (Maybe Natural) Source #
The number of input/output (I/O) operations per second (IOPS) to
provision for the volume. For gp3 and io1 volumes, this represents
the number of IOPS that are provisioned for the volume. For gp2
volumes, this represents the baseline performance of the volume and the
rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPSio1: 100-64,000 IOPS
For io1 volumes, we guarantee 64,000 IOPS only for
Instances built on the Nitro System.
Other instance families guarantee performance up to 32,000 IOPS.
Iops is supported when the volume type is gp3 or io1 and required
only when the volume type is io1. (Not used with standard, gp2,
st1, or sc1 volumes.)
ebs_encrypted :: Lens' Ebs (Maybe Bool) Source #
Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.
If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.
If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted.
For more information, see Using Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide.
ebs_volumeType :: Lens' Ebs (Maybe Text) Source #
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide for Linux Instances.
Valid Values: standard | io1 | gp2 | st1 | sc1 | gp3
ebs_snapshotId :: Lens' Ebs (Maybe Text) Source #
The snapshot ID of the volume to use.
You must specify either a VolumeSize or a SnapshotId.
EnabledMetric
data EnabledMetric Source #
Describes an enabled metric.
See: newEnabledMetric smart constructor.
Constructors
| EnabledMetric' | |
Fields
| |
Instances
newEnabledMetric :: EnabledMetric Source #
Create a value of EnabledMetric 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:granularity:EnabledMetric', enabledMetric_granularity - The granularity of the metric. The only valid value is 1Minute.
$sel:metric:EnabledMetric', enabledMetric_metric - One of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
GroupInServiceCapacity
GroupPendingCapacity
GroupStandbyCapacity
GroupTerminatingCapacity
GroupTotalCapacity
WarmPoolDesiredCapacity
WarmPoolWarmedCapacity
WarmPoolPendingCapacity
WarmPoolTerminatingCapacity
WarmPoolTotalCapacity
GroupAndWarmPoolDesiredCapacity
GroupAndWarmPoolTotalCapacity
enabledMetric_granularity :: Lens' EnabledMetric (Maybe Text) Source #
The granularity of the metric. The only valid value is 1Minute.
enabledMetric_metric :: Lens' EnabledMetric (Maybe Text) Source #
One of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
GroupInServiceCapacity
GroupPendingCapacity
GroupStandbyCapacity
GroupTerminatingCapacity
GroupTotalCapacity
WarmPoolDesiredCapacity
WarmPoolWarmedCapacity
WarmPoolPendingCapacity
WarmPoolTerminatingCapacity
WarmPoolTotalCapacity
GroupAndWarmPoolDesiredCapacity
GroupAndWarmPoolTotalCapacity
FailedScheduledUpdateGroupActionRequest
data FailedScheduledUpdateGroupActionRequest Source #
Describes a scheduled action that could not be created, updated, or deleted.
See: newFailedScheduledUpdateGroupActionRequest smart constructor.
Constructors
| FailedScheduledUpdateGroupActionRequest' | |
Fields
| |
Instances
newFailedScheduledUpdateGroupActionRequest Source #
Arguments
| :: Text |
|
| -> FailedScheduledUpdateGroupActionRequest |
Create a value of FailedScheduledUpdateGroupActionRequest 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:errorCode:FailedScheduledUpdateGroupActionRequest', failedScheduledUpdateGroupActionRequest_errorCode - The error code.
$sel:errorMessage:FailedScheduledUpdateGroupActionRequest', failedScheduledUpdateGroupActionRequest_errorMessage - The error message accompanying the error code.
$sel:scheduledActionName:FailedScheduledUpdateGroupActionRequest', failedScheduledUpdateGroupActionRequest_scheduledActionName - The name of the scheduled action.
failedScheduledUpdateGroupActionRequest_errorCode :: Lens' FailedScheduledUpdateGroupActionRequest (Maybe Text) Source #
The error code.
failedScheduledUpdateGroupActionRequest_errorMessage :: Lens' FailedScheduledUpdateGroupActionRequest (Maybe Text) Source #
The error message accompanying the error code.
failedScheduledUpdateGroupActionRequest_scheduledActionName :: Lens' FailedScheduledUpdateGroupActionRequest Text Source #
The name of the scheduled action.
Filter
Describes a filter that is used to return a more specific list of results from a describe operation.
If you specify multiple filters, the filters are joined with an AND,
and the request returns only results that match all of the specified
filters.
For more information, see Tagging Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
See: newFilter smart constructor.
Constructors
| Filter' | |
Fields
| |
Instances
| Eq Filter Source # | |
| Read Filter Source # | |
| Show Filter Source # | |
| Generic Filter Source # | |
| NFData Filter Source # | |
Defined in Amazonka.AutoScaling.Types.Filter | |
| Hashable Filter Source # | |
Defined in Amazonka.AutoScaling.Types.Filter | |
| ToQuery Filter Source # | |
Defined in Amazonka.AutoScaling.Types.Filter Methods toQuery :: Filter -> QueryString # | |
| type Rep Filter Source # | |
Defined in Amazonka.AutoScaling.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.AutoScaling.Types.Filter" "libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Filter 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:values:Filter', filter_values - One or more filter values. Filter values are case-sensitive.
If you specify multiple values for a filter, the values are joined with
an OR, and the request returns all results that match any of the
specified values. For example, specify "tag:environment" for the
filter name and "production,development" for the filter values to find
Auto Scaling groups with the tag "environment=production" or
"environment=development".
$sel:name:Filter', filter_name - The name of the filter.
The valid values for Name depend on the API operation that you are
including the filter in, DescribeAutoScalingGroups or DescribeTags.
DescribeAutoScalingGroups
Valid values for Name include the following:
tag-key- Accepts tag keys. The results will only include information about the Auto Scaling groups associated with these tag keys.tag-value- Accepts tag values. The results will only include information about the Auto Scaling groups associated with these tag values.tag:<key>- Accepts the key/value combination of the tag. Use the tag key in the filter name and the tag value as the filter value. The results will only include information about the Auto Scaling groups associated with the specified key/value combination.
DescribeTags
Valid values for Name include the following:
auto-scaling-group- Accepts the names of Auto Scaling groups. The results will only include information about the tags associated with these Auto Scaling groups.key- Accepts tag keys. The results will only include information about the tags associated with these tag keys.value- Accepts tag values. The results will only include information about the tags associated with these tag values.propagate-at-launch- Accepts a boolean value, which specifies whether tags propagate to instances at launch. The results will only include information about the tags associated with the specified boolean value.
filter_values :: Lens' Filter (Maybe [Text]) Source #
One or more filter values. Filter values are case-sensitive.
If you specify multiple values for a filter, the values are joined with
an OR, and the request returns all results that match any of the
specified values. For example, specify "tag:environment" for the
filter name and "production,development" for the filter values to find
Auto Scaling groups with the tag "environment=production" or
"environment=development".
filter_name :: Lens' Filter Text Source #
The name of the filter.
The valid values for Name depend on the API operation that you are
including the filter in, DescribeAutoScalingGroups or DescribeTags.
DescribeAutoScalingGroups
Valid values for Name include the following:
tag-key- Accepts tag keys. The results will only include information about the Auto Scaling groups associated with these tag keys.tag-value- Accepts tag values. The results will only include information about the Auto Scaling groups associated with these tag values.tag:<key>- Accepts the key/value combination of the tag. Use the tag key in the filter name and the tag value as the filter value. The results will only include information about the Auto Scaling groups associated with the specified key/value combination.
DescribeTags
Valid values for Name include the following:
auto-scaling-group- Accepts the names of Auto Scaling groups. The results will only include information about the tags associated with these Auto Scaling groups.key- Accepts tag keys. The results will only include information about the tags associated with these tag keys.value- Accepts tag values. The results will only include information about the tags associated with these tag values.propagate-at-launch- Accepts a boolean value, which specifies whether tags propagate to instances at launch. The results will only include information about the tags associated with the specified boolean value.
Instance
Describes an EC2 instance.
See: newInstance smart constructor.
Constructors
| Instance' | |
Fields
| |
Instances
Create a value of Instance 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:weightedCapacity:Instance', instance_weightedCapacity - The number of capacity units contributed by the instance based on its
instance type.
Valid Range: Minimum value of 1. Maximum value of 999.
$sel:instanceType:Instance', instance_instanceType - The instance type of the EC2 instance.
$sel:launchConfigurationName:Instance', instance_launchConfigurationName - The launch configuration associated with the instance.
$sel:launchTemplate:Instance', instance_launchTemplate - The launch template for the instance.
$sel:instanceId:Instance', instance_instanceId - The ID of the instance.
$sel:availabilityZone:Instance', instance_availabilityZone - The Availability Zone in which the instance is running.
$sel:lifecycleState:Instance', instance_lifecycleState - A description of the current lifecycle state. The Quarantined state is
not used. For information about lifecycle states, see
Instance lifecycle
in the Amazon EC2 Auto Scaling User Guide.
$sel:healthStatus:Instance', instance_healthStatus - The last reported health status of the instance. "Healthy" means that
the instance is healthy and should remain in service. "Unhealthy"
means that the instance is unhealthy and that Amazon EC2 Auto Scaling
should terminate and replace it.
$sel:protectedFromScaleIn:Instance', instance_protectedFromScaleIn - Indicates whether the instance is protected from termination by Amazon
EC2 Auto Scaling when scaling in.
instance_weightedCapacity :: Lens' Instance (Maybe Text) Source #
The number of capacity units contributed by the instance based on its instance type.
Valid Range: Minimum value of 1. Maximum value of 999.
instance_launchConfigurationName :: Lens' Instance (Maybe Text) Source #
The launch configuration associated with the instance.
instance_launchTemplate :: Lens' Instance (Maybe LaunchTemplateSpecification) Source #
The launch template for the instance.
instance_availabilityZone :: Lens' Instance Text Source #
The Availability Zone in which the instance is running.
instance_lifecycleState :: Lens' Instance LifecycleState Source #
A description of the current lifecycle state. The Quarantined state is
not used. For information about lifecycle states, see
Instance lifecycle
in the Amazon EC2 Auto Scaling User Guide.
instance_healthStatus :: Lens' Instance Text Source #
The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.
instance_protectedFromScaleIn :: Lens' Instance Bool Source #
Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
InstanceMetadataOptions
data InstanceMetadataOptions Source #
The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.
See: newInstanceMetadataOptions smart constructor.
Constructors
| InstanceMetadataOptions' | |
Fields
| |
Instances
newInstanceMetadataOptions :: InstanceMetadataOptions Source #
Create a value of InstanceMetadataOptions 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:httpEndpoint:InstanceMetadataOptions', instanceMetadataOptions_httpEndpoint - This parameter enables or disables the HTTP metadata endpoint on your
instances. If the parameter is not specified, the default state is
enabled.
If you specify a value of disabled, you will not be able to access
your instance metadata.
$sel:httpPutResponseHopLimit:InstanceMetadataOptions', instanceMetadataOptions_httpPutResponseHopLimit - The desired HTTP PUT response hop limit for instance metadata requests.
The larger the number, the further instance metadata requests can
travel.
Default: 1
$sel:httpTokens:InstanceMetadataOptions', instanceMetadataOptions_httpTokens - The state of token usage for your instance metadata requests. If the
parameter is not specified in the request, the default state is
optional.
If the state is optional, you can choose to retrieve instance metadata
with or without a signed token header on your request. If you retrieve
the IAM role credentials without a token, the version 1.0 role
credentials are returned. If you retrieve the IAM role credentials using
a valid signed token, the version 2.0 role credentials are returned.
If the state is required, you must send a signed token header with any
instance metadata retrieval requests. In this state, retrieving the IAM
role credentials always returns the version 2.0 credentials; the version
1.0 credentials are not available.
instanceMetadataOptions_httpEndpoint :: Lens' InstanceMetadataOptions (Maybe InstanceMetadataEndpointState) Source #
This parameter enables or disables the HTTP metadata endpoint on your
instances. If the parameter is not specified, the default state is
enabled.
If you specify a value of disabled, you will not be able to access
your instance metadata.
instanceMetadataOptions_httpPutResponseHopLimit :: Lens' InstanceMetadataOptions (Maybe Natural) Source #
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
instanceMetadataOptions_httpTokens :: Lens' InstanceMetadataOptions (Maybe InstanceMetadataHttpTokensState) Source #
The state of token usage for your instance metadata requests. If the
parameter is not specified in the request, the default state is
optional.
If the state is optional, you can choose to retrieve instance metadata
with or without a signed token header on your request. If you retrieve
the IAM role credentials without a token, the version 1.0 role
credentials are returned. If you retrieve the IAM role credentials using
a valid signed token, the version 2.0 role credentials are returned.
If the state is required, you must send a signed token header with any
instance metadata retrieval requests. In this state, retrieving the IAM
role credentials always returns the version 2.0 credentials; the version
1.0 credentials are not available.
InstanceMonitoring
data InstanceMonitoring Source #
Describes whether detailed monitoring is enabled for the Auto Scaling instances.
See: newInstanceMonitoring smart constructor.
Constructors
| InstanceMonitoring' | |
Instances
newInstanceMonitoring :: InstanceMonitoring Source #
Create a value of InstanceMonitoring 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:enabled:InstanceMonitoring', instanceMonitoring_enabled - If true, detailed monitoring is enabled. Otherwise, basic monitoring
is enabled.
instanceMonitoring_enabled :: Lens' InstanceMonitoring (Maybe Bool) Source #
If true, detailed monitoring is enabled. Otherwise, basic monitoring
is enabled.
InstanceRefresh
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.
InstanceRefreshLivePoolProgress
data InstanceRefreshLivePoolProgress Source #
Reports the progress of an instance refresh on instances that are in the Auto Scaling group.
See: newInstanceRefreshLivePoolProgress smart constructor.
Constructors
| InstanceRefreshLivePoolProgress' | |
Fields
| |
Instances
newInstanceRefreshLivePoolProgress :: InstanceRefreshLivePoolProgress Source #
Create a value of InstanceRefreshLivePoolProgress 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:instancesToUpdate:InstanceRefreshLivePoolProgress', instanceRefreshLivePoolProgress_instancesToUpdate - The number of instances remaining to update.
$sel:percentageComplete:InstanceRefreshLivePoolProgress', instanceRefreshLivePoolProgress_percentageComplete - The percentage of instances in the Auto Scaling group that have been
replaced. 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.
instanceRefreshLivePoolProgress_instancesToUpdate :: Lens' InstanceRefreshLivePoolProgress (Maybe Natural) Source #
The number of instances remaining to update.
instanceRefreshLivePoolProgress_percentageComplete :: Lens' InstanceRefreshLivePoolProgress (Maybe Natural) Source #
The percentage of instances in the Auto Scaling group that have been replaced. 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.
InstanceRefreshProgressDetails
data InstanceRefreshProgressDetails Source #
Reports the progress of an instance refresh on an Auto Scaling group that has a warm pool. This includes separate details for instances in the warm pool and instances in the Auto Scaling group (the live pool).
See: newInstanceRefreshProgressDetails smart constructor.
Constructors
| InstanceRefreshProgressDetails' | |
Fields
| |
Instances
newInstanceRefreshProgressDetails :: InstanceRefreshProgressDetails Source #
Create a value of InstanceRefreshProgressDetails 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:livePoolProgress:InstanceRefreshProgressDetails', instanceRefreshProgressDetails_livePoolProgress - Indicates the progress of an instance refresh on instances that are in
the Auto Scaling group.
$sel:warmPoolProgress:InstanceRefreshProgressDetails', instanceRefreshProgressDetails_warmPoolProgress - Indicates the progress of an instance refresh on instances that are in
the warm pool.
instanceRefreshProgressDetails_livePoolProgress :: Lens' InstanceRefreshProgressDetails (Maybe InstanceRefreshLivePoolProgress) Source #
Indicates the progress of an instance refresh on instances that are in the Auto Scaling group.
instanceRefreshProgressDetails_warmPoolProgress :: Lens' InstanceRefreshProgressDetails (Maybe InstanceRefreshWarmPoolProgress) Source #
Indicates the progress of an instance refresh on instances that are in the warm pool.
InstanceRefreshWarmPoolProgress
data InstanceRefreshWarmPoolProgress Source #
Reports the progress of an instance refresh on instances that are in the warm pool.
See: newInstanceRefreshWarmPoolProgress smart constructor.
Constructors
| InstanceRefreshWarmPoolProgress' | |
Fields
| |
Instances
newInstanceRefreshWarmPoolProgress :: InstanceRefreshWarmPoolProgress Source #
Create a value of InstanceRefreshWarmPoolProgress 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:instancesToUpdate:InstanceRefreshWarmPoolProgress', instanceRefreshWarmPoolProgress_instancesToUpdate - The number of instances remaining to update.
$sel:percentageComplete:InstanceRefreshWarmPoolProgress', instanceRefreshWarmPoolProgress_percentageComplete - The percentage of instances in the warm pool that have been replaced.
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.
instanceRefreshWarmPoolProgress_instancesToUpdate :: Lens' InstanceRefreshWarmPoolProgress (Maybe Natural) Source #
The number of instances remaining to update.
instanceRefreshWarmPoolProgress_percentageComplete :: Lens' InstanceRefreshWarmPoolProgress (Maybe Natural) Source #
The percentage of instances in the warm pool that have been replaced. 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.
InstancesDistribution
data InstancesDistribution Source #
Describes an instances distribution for an Auto Scaling group with a MixedInstancesPolicy.
The instances distribution specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities.
When you modify SpotAllocationStrategy, SpotInstancePools, or
SpotMaxPrice in the UpdateAutoScalingGroup API call, this update
action does not deploy any changes across the running Amazon EC2
instances in the group. Your existing Spot Instances continue to run as
long as the maximum price for those instances is higher than the current
Spot price. When scale out occurs, Amazon EC2 Auto Scaling launches
instances based on the new settings. When scale in occurs, Amazon EC2
Auto Scaling terminates instances according to the group's termination
policies.
See: newInstancesDistribution smart constructor.
Constructors
| InstancesDistribution' | |
Fields
| |
Instances
newInstancesDistribution :: InstancesDistribution Source #
Create a value of InstancesDistribution 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:spotAllocationStrategy:InstancesDistribution', instancesDistribution_spotAllocationStrategy - Indicates how to allocate instances across Spot Instance pools.
If the allocation strategy is lowest-price, the Auto Scaling group
launches instances using the Spot pools with the lowest price, and
evenly allocates your instances across the number of Spot pools that you
specify. Defaults to lowest-price if not specified.
If the allocation strategy is capacity-optimized (recommended), the
Auto Scaling group launches instances using Spot pools that are
optimally chosen based on the available Spot capacity. Alternatively,
you can use capacity-optimized-prioritized and set the order of
instance types in the list of launch template overrides from highest to
lowest priority (from first to last in the list). Amazon EC2 Auto
Scaling honors the instance type priorities on a best-effort basis but
optimizes for capacity first.
$sel:spotInstancePools:InstancesDistribution', instancesDistribution_spotInstancePools - The number of Spot Instance pools across which to allocate your Spot
Instances. The Spot pools are determined from the different instance
types in the overrides. Valid only when the Spot allocation strategy is
lowest-price. Value must be in the range of 1 to 20. Defaults to 2 if
not specified.
$sel:spotMaxPrice:InstancesDistribution', instancesDistribution_spotMaxPrice - The maximum price per unit hour that you are willing to pay for a Spot
Instance. If you leave the value at its default (empty), Amazon EC2 Auto
Scaling uses the On-Demand price as the maximum Spot price. To remove a
value that you previously set, include the property but specify an empty
string ("") for the value.
$sel:onDemandBaseCapacity:InstancesDistribution', instancesDistribution_onDemandBaseCapacity - The minimum amount of the Auto Scaling group's capacity that must be
fulfilled by On-Demand Instances. This base portion is provisioned first
as your group scales. Defaults to 0 if not specified. If you specify
weights for the instance types in the overrides, set the value of
OnDemandBaseCapacity in terms of the number of capacity units, and not
the number of instances.
$sel:onDemandAllocationStrategy:InstancesDistribution', instancesDistribution_onDemandAllocationStrategy - Indicates how to allocate instance types to fulfill On-Demand capacity.
The only valid value is prioritized, which is also the default value.
This strategy uses the order of instance types in the
LaunchTemplateOverrides to define the launch priority of each instance
type. The first instance type in the array is prioritized higher than
the last. If all your On-Demand capacity cannot be fulfilled using your
highest priority instance, then the Auto Scaling groups launches the
remaining capacity using the second priority instance type, and so on.
$sel:onDemandPercentageAboveBaseCapacity:InstancesDistribution', instancesDistribution_onDemandPercentageAboveBaseCapacity - Controls the percentages of On-Demand Instances and Spot Instances for
your additional capacity beyond OnDemandBaseCapacity. Expressed as a
number (for example, 20 specifies 20% On-Demand Instances, 80% Spot
Instances). Defaults to 100 if not specified. If set to 100, only
On-Demand Instances are provisioned.
instancesDistribution_spotAllocationStrategy :: Lens' InstancesDistribution (Maybe Text) Source #
Indicates how to allocate instances across Spot Instance pools.
If the allocation strategy is lowest-price, the Auto Scaling group
launches instances using the Spot pools with the lowest price, and
evenly allocates your instances across the number of Spot pools that you
specify. Defaults to lowest-price if not specified.
If the allocation strategy is capacity-optimized (recommended), the
Auto Scaling group launches instances using Spot pools that are
optimally chosen based on the available Spot capacity. Alternatively,
you can use capacity-optimized-prioritized and set the order of
instance types in the list of launch template overrides from highest to
lowest priority (from first to last in the list). Amazon EC2 Auto
Scaling honors the instance type priorities on a best-effort basis but
optimizes for capacity first.
instancesDistribution_spotInstancePools :: Lens' InstancesDistribution (Maybe Int) Source #
The number of Spot Instance pools across which to allocate your Spot
Instances. The Spot pools are determined from the different instance
types in the overrides. Valid only when the Spot allocation strategy is
lowest-price. Value must be in the range of 1 to 20. Defaults to 2 if
not specified.
instancesDistribution_spotMaxPrice :: Lens' InstancesDistribution (Maybe Text) Source #
The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value at its default (empty), Amazon EC2 Auto Scaling uses the On-Demand price as the maximum Spot price. To remove a value that you previously set, include the property but specify an empty string ("") for the value.
instancesDistribution_onDemandBaseCapacity :: Lens' InstancesDistribution (Maybe Int) Source #
The minimum amount of the Auto Scaling group's capacity that must be
fulfilled by On-Demand Instances. This base portion is provisioned first
as your group scales. Defaults to 0 if not specified. If you specify
weights for the instance types in the overrides, set the value of
OnDemandBaseCapacity in terms of the number of capacity units, and not
the number of instances.
instancesDistribution_onDemandAllocationStrategy :: Lens' InstancesDistribution (Maybe Text) Source #
Indicates how to allocate instance types to fulfill On-Demand capacity.
The only valid value is prioritized, which is also the default value.
This strategy uses the order of instance types in the
LaunchTemplateOverrides to define the launch priority of each instance
type. The first instance type in the array is prioritized higher than
the last. If all your On-Demand capacity cannot be fulfilled using your
highest priority instance, then the Auto Scaling groups launches the
remaining capacity using the second priority instance type, and so on.
instancesDistribution_onDemandPercentageAboveBaseCapacity :: Lens' InstancesDistribution (Maybe Int) Source #
Controls the percentages of On-Demand Instances and Spot Instances for
your additional capacity beyond OnDemandBaseCapacity. Expressed as a
number (for example, 20 specifies 20% On-Demand Instances, 80% Spot
Instances). Defaults to 100 if not specified. If set to 100, only
On-Demand Instances are provisioned.
LaunchConfiguration
data LaunchConfiguration Source #
Describes a launch configuration.
See: newLaunchConfiguration smart constructor.
Constructors
| LaunchConfiguration' | |
Fields
| |
Instances
newLaunchConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> LaunchConfiguration |
Create a value of LaunchConfiguration 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:associatePublicIpAddress:LaunchConfiguration', launchConfiguration_associatePublicIpAddress - For Auto Scaling groups that are running in a VPC, specifies whether to
assign a public IP address to the group's instances. For more
information, see
Launching Auto Scaling instances in a VPC
in the Amazon EC2 Auto Scaling User Guide.
$sel:securityGroups:LaunchConfiguration', launchConfiguration_securityGroups - A list that contains the security groups to assign to the instances in
the Auto Scaling group. For more information, see
Security Groups for Your VPC
in the Amazon Virtual Private Cloud User Guide.
$sel:spotPrice:LaunchConfiguration', launchConfiguration_spotPrice - The maximum hourly price to be paid for any Spot Instance launched to
fulfill the request. Spot Instances are launched when the price you
specify exceeds the current Spot price. For more information, see
Requesting Spot Instances
in the Amazon EC2 Auto Scaling User Guide.
$sel:instanceMonitoring:LaunchConfiguration', launchConfiguration_instanceMonitoring - Controls whether instances in this group are launched with detailed
(true) or basic (false) monitoring.
For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
$sel:keyName:LaunchConfiguration', launchConfiguration_keyName - The name of the key pair.
For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
$sel:classicLinkVPCSecurityGroups:LaunchConfiguration', launchConfiguration_classicLinkVPCSecurityGroups - The IDs of one or more security groups for the VPC specified in
ClassicLinkVPCId.
For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
$sel:ramdiskId:LaunchConfiguration', launchConfiguration_ramdiskId - The ID of the RAM disk associated with the AMI.
$sel:kernelId:LaunchConfiguration', launchConfiguration_kernelId - The ID of the kernel associated with the AMI.
$sel:ebsOptimized:LaunchConfiguration', launchConfiguration_ebsOptimized - Specifies whether the launch configuration is optimized for EBS I/O
(true) or not (false). For more information, see
Amazon EBS-Optimized Instances
in the Amazon EC2 User Guide for Linux Instances.
$sel:userData:LaunchConfiguration', launchConfiguration_userData - The user data to make available to the launched EC2 instances. For more
information, see
Instance metadata and user data
(Linux) and
Instance metadata and user data
(Windows). If you are using a command line tool, base64-encoding is
performed for you, and you can load the text from a file. Otherwise, you
must provide base64-encoded text. User data is limited to 16 KB.
$sel:classicLinkVPCId:LaunchConfiguration', launchConfiguration_classicLinkVPCId - The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances
to. For more information, see
ClassicLink
in the Amazon EC2 User Guide for Linux Instances and
Linking EC2-Classic instances to a VPC
in the Amazon EC2 Auto Scaling User Guide.
$sel:iamInstanceProfile:LaunchConfiguration', launchConfiguration_iamInstanceProfile - The name or the Amazon Resource Name (ARN) of the instance profile
associated with the IAM role for the instance. The instance profile
contains the IAM role. For more information, see
IAM role for applications that run on Amazon EC2 instances
in the Amazon EC2 Auto Scaling User Guide.
$sel:metadataOptions:LaunchConfiguration', launchConfiguration_metadataOptions - The metadata options for the instances. For more information, see
Configuring the Instance Metadata Options
in the Amazon EC2 Auto Scaling User Guide.
$sel:launchConfigurationARN:LaunchConfiguration', launchConfiguration_launchConfigurationARN - The Amazon Resource Name (ARN) of the launch configuration.
$sel:placementTenancy:LaunchConfiguration', launchConfiguration_placementTenancy - The tenancy of the instance, either default or dedicated. An
instance with dedicated tenancy runs on isolated, single-tenant
hardware and can only be launched into a VPC.
For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
$sel:blockDeviceMappings:LaunchConfiguration', launchConfiguration_blockDeviceMappings - A block device mapping, which specifies the block devices for the
instance. For more information, see
Block Device Mapping
in the Amazon EC2 User Guide for Linux Instances.
$sel:launchConfigurationName:LaunchConfiguration', launchConfiguration_launchConfigurationName - The name of the launch configuration.
$sel:imageId:LaunchConfiguration', launchConfiguration_imageId - The ID of the Amazon Machine Image (AMI) to use to launch your EC2
instances. For more information, see
Finding an AMI
in the Amazon EC2 User Guide for Linux Instances.
$sel:instanceType:LaunchConfiguration', launchConfiguration_instanceType - The instance type for the instances.
For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.
$sel:createdTime:LaunchConfiguration', launchConfiguration_createdTime - The creation date and time for the launch configuration.
launchConfiguration_associatePublicIpAddress :: Lens' LaunchConfiguration (Maybe Bool) Source #
For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP address to the group's instances. For more information, see Launching Auto Scaling instances in a VPC in the Amazon EC2 Auto Scaling User Guide.
launchConfiguration_securityGroups :: Lens' LaunchConfiguration (Maybe [Text]) Source #
A list that contains the security groups to assign to the instances in the Auto Scaling group. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
launchConfiguration_spotPrice :: Lens' LaunchConfiguration (Maybe Text) Source #
The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Requesting Spot Instances in the Amazon EC2 Auto Scaling User Guide.
launchConfiguration_instanceMonitoring :: Lens' LaunchConfiguration (Maybe InstanceMonitoring) Source #
Controls whether instances in this group are launched with detailed
(true) or basic (false) monitoring.
For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
launchConfiguration_keyName :: Lens' LaunchConfiguration (Maybe Text) Source #
The name of the key pair.
For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
launchConfiguration_classicLinkVPCSecurityGroups :: Lens' LaunchConfiguration (Maybe [Text]) Source #
The IDs of one or more security groups for the VPC specified in
ClassicLinkVPCId.
For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
launchConfiguration_ramdiskId :: Lens' LaunchConfiguration (Maybe Text) Source #
The ID of the RAM disk associated with the AMI.
launchConfiguration_kernelId :: Lens' LaunchConfiguration (Maybe Text) Source #
The ID of the kernel associated with the AMI.
launchConfiguration_ebsOptimized :: Lens' LaunchConfiguration (Maybe Bool) Source #
Specifies whether the launch configuration is optimized for EBS I/O
(true) or not (false). For more information, see
Amazon EBS-Optimized Instances
in the Amazon EC2 User Guide for Linux Instances.
launchConfiguration_userData :: Lens' LaunchConfiguration (Maybe Text) Source #
The user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.
launchConfiguration_classicLinkVPCId :: Lens' LaunchConfiguration (Maybe Text) Source #
The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
launchConfiguration_iamInstanceProfile :: Lens' LaunchConfiguration (Maybe Text) Source #
The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.
launchConfiguration_metadataOptions :: Lens' LaunchConfiguration (Maybe InstanceMetadataOptions) Source #
The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.
launchConfiguration_launchConfigurationARN :: Lens' LaunchConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) of the launch configuration.
launchConfiguration_placementTenancy :: Lens' LaunchConfiguration (Maybe Text) Source #
The tenancy of the instance, either default or dedicated. An
instance with dedicated tenancy runs on isolated, single-tenant
hardware and can only be launched into a VPC.
For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
launchConfiguration_blockDeviceMappings :: Lens' LaunchConfiguration (Maybe [BlockDeviceMapping]) Source #
A block device mapping, which specifies the block devices for the instance. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.
launchConfiguration_launchConfigurationName :: Lens' LaunchConfiguration Text Source #
The name of the launch configuration.
launchConfiguration_imageId :: Lens' LaunchConfiguration Text Source #
The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.
launchConfiguration_instanceType :: Lens' LaunchConfiguration Text Source #
The instance type for the instances.
For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.
launchConfiguration_createdTime :: Lens' LaunchConfiguration UTCTime Source #
The creation date and time for the launch configuration.
LaunchTemplate
data LaunchTemplate Source #
Describes a launch template and overrides.
You specify these properties as part of a mixed instances policy.
When you update the launch template or overrides in the UpdateAutoScalingGroup API call, existing Amazon EC2 instances continue to run. When scale out occurs, Amazon EC2 Auto Scaling launches instances to match the new settings. When scale in occurs, Amazon EC2 Auto Scaling terminates instances according to the group's termination policies.
See: newLaunchTemplate smart constructor.
Constructors
| LaunchTemplate' | |
Fields
| |
Instances
newLaunchTemplate :: LaunchTemplate Source #
Create a value of LaunchTemplate 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:overrides:LaunchTemplate', launchTemplate_overrides - Any properties that you specify override the same properties in the
launch template. If not provided, Amazon EC2 Auto Scaling uses the
instance type specified in the launch template when it launches an
instance.
$sel:launchTemplateSpecification:LaunchTemplate', launchTemplate_launchTemplateSpecification - The launch template to use.
launchTemplate_overrides :: Lens' LaunchTemplate (Maybe [LaunchTemplateOverrides]) Source #
Any properties that you specify override the same properties in the launch template. If not provided, Amazon EC2 Auto Scaling uses the instance type specified in the launch template when it launches an instance.
launchTemplate_launchTemplateSpecification :: Lens' LaunchTemplate (Maybe LaunchTemplateSpecification) Source #
The launch template to use.
LaunchTemplateOverrides
data LaunchTemplateOverrides Source #
Describes an override for a launch template. The maximum number of instance types that can be associated with an Auto Scaling group is 40. The maximum number of distinct launch templates you can define for an Auto Scaling group is 20. For more information about configuring overrides, see Configuring overrides in the Amazon EC2 Auto Scaling User Guide.
See: newLaunchTemplateOverrides smart constructor.
Constructors
| LaunchTemplateOverrides' | |
Fields
| |
Instances
newLaunchTemplateOverrides :: LaunchTemplateOverrides Source #
Create a value of LaunchTemplateOverrides 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:weightedCapacity:LaunchTemplateOverrides', launchTemplateOverrides_weightedCapacity - The number of capacity units provided by the specified instance type in
terms of virtual CPUs, memory, storage, throughput, or other relative
performance characteristic. When a Spot or On-Demand Instance is
provisioned, the capacity units count toward the desired capacity.
Amazon EC2 Auto Scaling provisions instances until the desired capacity
is totally fulfilled, even if this results in an overage. For example,
if there are 2 units remaining to fulfill capacity, and Amazon EC2 Auto
Scaling can only provision an instance with a WeightedCapacity of 5
units, the instance is provisioned, and the desired capacity is exceeded
by 3 units. For more information, see
Instance weighting for Amazon EC2 Auto Scaling
in the Amazon EC2 Auto Scaling User Guide. Value must be in the range
of 1 to 999.
$sel:instanceType:LaunchTemplateOverrides', launchTemplateOverrides_instanceType - The instance type, such as m3.xlarge. You must use an instance type
that is supported in your requested Region and Availability Zones. For
more information, see
Instance types
in the Amazon Elastic Compute Cloud User Guide.
$sel:launchTemplateSpecification:LaunchTemplateOverrides', launchTemplateOverrides_launchTemplateSpecification - Provides the launch template to be used when launching the instance
type. For example, some instance types might require a launch template
with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the
launch template that's defined for your mixed instances policy. For
more information, see
Specifying a different launch template for an instance type
in the Amazon EC2 Auto Scaling User Guide.
launchTemplateOverrides_weightedCapacity :: Lens' LaunchTemplateOverrides (Maybe Text) Source #
The number of capacity units provided by the specified instance type in
terms of virtual CPUs, memory, storage, throughput, or other relative
performance characteristic. When a Spot or On-Demand Instance is
provisioned, the capacity units count toward the desired capacity.
Amazon EC2 Auto Scaling provisions instances until the desired capacity
is totally fulfilled, even if this results in an overage. For example,
if there are 2 units remaining to fulfill capacity, and Amazon EC2 Auto
Scaling can only provision an instance with a WeightedCapacity of 5
units, the instance is provisioned, and the desired capacity is exceeded
by 3 units. For more information, see
Instance weighting for Amazon EC2 Auto Scaling
in the Amazon EC2 Auto Scaling User Guide. Value must be in the range
of 1 to 999.
launchTemplateOverrides_instanceType :: Lens' LaunchTemplateOverrides (Maybe Text) Source #
The instance type, such as m3.xlarge. You must use an instance type
that is supported in your requested Region and Availability Zones. For
more information, see
Instance types
in the Amazon Elastic Compute Cloud User Guide.
launchTemplateOverrides_launchTemplateSpecification :: Lens' LaunchTemplateOverrides (Maybe LaunchTemplateSpecification) Source #
Provides the launch template to be used when launching the instance type. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's defined for your mixed instances policy. For more information, see Specifying a different launch template for an instance type in the Amazon EC2 Auto Scaling User Guide.
LaunchTemplateSpecification
data LaunchTemplateSpecification Source #
Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information about launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
See: newLaunchTemplateSpecification smart constructor.
Constructors
| LaunchTemplateSpecification' | |
Fields
| |
Instances
newLaunchTemplateSpecification :: LaunchTemplateSpecification Source #
Create a value of LaunchTemplateSpecification 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:launchTemplateName:LaunchTemplateSpecification', launchTemplateSpecification_launchTemplateName - The name of the launch template. To get the template name, use the
Amazon EC2
DescribeLaunchTemplates
API operation. New launch templates can be created using the Amazon EC2
CreateLaunchTemplate
API.
Conditional: You must specify either a LaunchTemplateId or a
LaunchTemplateName.
$sel:launchTemplateId:LaunchTemplateSpecification', launchTemplateSpecification_launchTemplateId - The ID of the launch template. To get the template ID, use the Amazon
EC2
DescribeLaunchTemplates
API operation. New launch templates can be created using the Amazon EC2
CreateLaunchTemplate
API.
Conditional: You must specify either a LaunchTemplateId or a
LaunchTemplateName.
$sel:version:LaunchTemplateSpecification', launchTemplateSpecification_version - The version number, $Latest, or $Default. To get the version number,
use the Amazon EC2
DescribeLaunchTemplateVersions
API operation. New launch template versions can be created using the
Amazon EC2
CreateLaunchTemplateVersion
API. If the value is $Latest, Amazon EC2 Auto Scaling selects the
latest version of the launch template when launching instances. If the
value is $Default, Amazon EC2 Auto Scaling selects the default version
of the launch template when launching instances. The default value is
$Default.
launchTemplateSpecification_launchTemplateName :: Lens' LaunchTemplateSpecification (Maybe Text) Source #
The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a LaunchTemplateId or a
LaunchTemplateName.
launchTemplateSpecification_launchTemplateId :: Lens' LaunchTemplateSpecification (Maybe Text) Source #
The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a LaunchTemplateId or a
LaunchTemplateName.
launchTemplateSpecification_version :: Lens' LaunchTemplateSpecification (Maybe Text) Source #
The version number, $Latest, or $Default. To get the version number,
use the Amazon EC2
DescribeLaunchTemplateVersions
API operation. New launch template versions can be created using the
Amazon EC2
CreateLaunchTemplateVersion
API. If the value is $Latest, Amazon EC2 Auto Scaling selects the
latest version of the launch template when launching instances. If the
value is $Default, Amazon EC2 Auto Scaling selects the default version
of the launch template when launching instances. The default value is
$Default.
LifecycleHook
data LifecycleHook Source #
Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or terminates instances.
See: newLifecycleHook smart constructor.
Constructors
| LifecycleHook' | |
Fields
| |
Instances
newLifecycleHook :: LifecycleHook Source #
Create a value of LifecycleHook 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:defaultResult:LifecycleHook', lifecycleHook_defaultResult - Defines the action the Auto Scaling group should take when the lifecycle
hook timeout elapses or if an unexpected failure occurs. The possible
values are CONTINUE and ABANDON.
$sel:lifecycleHookName:LifecycleHook', lifecycleHook_lifecycleHookName - The name of the lifecycle hook.
$sel:heartbeatTimeout:LifecycleHook', lifecycleHook_heartbeatTimeout - The maximum time, in seconds, that can elapse before the lifecycle hook
times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling
performs the action that you specified in the DefaultResult parameter.
$sel:autoScalingGroupName:LifecycleHook', lifecycleHook_autoScalingGroupName - The name of the Auto Scaling group for the lifecycle hook.
$sel:notificationMetadata:LifecycleHook', lifecycleHook_notificationMetadata - Additional information that is included any time Amazon EC2 Auto Scaling
sends a message to the notification target.
$sel:globalTimeout:LifecycleHook', lifecycleHook_globalTimeout - The maximum time, in seconds, that an instance can remain in a
Pending:Wait or Terminating:Wait state. The maximum is 172800
seconds (48 hours) or 100 times HeartbeatTimeout, whichever is
smaller.
$sel:notificationTargetARN:LifecycleHook', lifecycleHook_notificationTargetARN - The ARN of the target that Amazon EC2 Auto Scaling sends notifications
to when an instance is in the transition state for the lifecycle hook.
The notification target can be either an SQS queue or an SNS topic.
$sel:lifecycleTransition:LifecycleHook', lifecycleHook_lifecycleTransition - The state of the EC2 instance to which to attach the lifecycle hook. The
following are possible values:
- autoscaling:EC2_INSTANCE_LAUNCHING
- autoscaling:EC2_INSTANCE_TERMINATING
$sel:roleARN:LifecycleHook', lifecycleHook_roleARN - The ARN of the IAM role that allows the Auto Scaling group to publish to
the specified notification target.
lifecycleHook_defaultResult :: Lens' LifecycleHook (Maybe Text) Source #
Defines the action the Auto Scaling group should take when the lifecycle
hook timeout elapses or if an unexpected failure occurs. The possible
values are CONTINUE and ABANDON.
lifecycleHook_lifecycleHookName :: Lens' LifecycleHook (Maybe Text) Source #
The name of the lifecycle hook.
lifecycleHook_heartbeatTimeout :: Lens' LifecycleHook (Maybe Int) Source #
The maximum time, in seconds, that can elapse before the lifecycle hook
times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling
performs the action that you specified in the DefaultResult parameter.
lifecycleHook_autoScalingGroupName :: Lens' LifecycleHook (Maybe Text) Source #
The name of the Auto Scaling group for the lifecycle hook.
lifecycleHook_notificationMetadata :: Lens' LifecycleHook (Maybe Text) Source #
Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
lifecycleHook_globalTimeout :: Lens' LifecycleHook (Maybe Int) Source #
The maximum time, in seconds, that an instance can remain in a
Pending:Wait or Terminating:Wait state. The maximum is 172800
seconds (48 hours) or 100 times HeartbeatTimeout, whichever is
smaller.
lifecycleHook_notificationTargetARN :: Lens' LifecycleHook (Maybe Text) Source #
The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.
lifecycleHook_lifecycleTransition :: Lens' LifecycleHook (Maybe Text) Source #
The state of the EC2 instance to which to attach the lifecycle hook. The following are possible values:
- autoscaling:EC2_INSTANCE_LAUNCHING
- autoscaling:EC2_INSTANCE_TERMINATING
lifecycleHook_roleARN :: Lens' LifecycleHook (Maybe Text) Source #
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
LifecycleHookSpecification
data LifecycleHookSpecification Source #
Describes information used to specify a lifecycle hook for an Auto Scaling group.
A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).
This step is a part of the procedure for creating a lifecycle hook for an Auto Scaling group:
- (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
- (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
- __Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.__
- If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.
- If you finish before the timeout period ends, complete the lifecycle action.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
See: newLifecycleHookSpecification smart constructor.
Constructors
| LifecycleHookSpecification' | |
Fields
| |
Instances
newLifecycleHookSpecification Source #
Arguments
| :: Text | |
| -> Text | |
| -> LifecycleHookSpecification |
Create a value of LifecycleHookSpecification 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:defaultResult:LifecycleHookSpecification', lifecycleHookSpecification_defaultResult - Defines the action the Auto Scaling group should take when the lifecycle
hook timeout elapses or if an unexpected failure occurs. The valid
values are CONTINUE and ABANDON. The default value is ABANDON.
$sel:heartbeatTimeout:LifecycleHookSpecification', lifecycleHookSpecification_heartbeatTimeout - The maximum time, in seconds, that can elapse before the lifecycle hook
times out.
If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the
action that you specified in the DefaultResult parameter. You can
prevent the lifecycle hook from timing out by calling
RecordLifecycleActionHeartbeat.
$sel:notificationMetadata:LifecycleHookSpecification', lifecycleHookSpecification_notificationMetadata - Additional information that you want to include any time Amazon EC2 Auto
Scaling sends a message to the notification target.
$sel:notificationTargetARN:LifecycleHookSpecification', lifecycleHookSpecification_notificationTargetARN - The ARN of the target that Amazon EC2 Auto Scaling sends notifications
to when an instance is in the transition state for the lifecycle hook.
The notification target can be either an SQS queue or an SNS topic.
$sel:roleARN:LifecycleHookSpecification', lifecycleHookSpecification_roleARN - The ARN of the IAM role that allows the Auto Scaling group to publish to
the specified notification target, for example, an Amazon SNS topic or
an Amazon SQS queue.
$sel:lifecycleHookName:LifecycleHookSpecification', lifecycleHookSpecification_lifecycleHookName - The name of the lifecycle hook.
$sel:lifecycleTransition:LifecycleHookSpecification', lifecycleHookSpecification_lifecycleTransition - The state of the EC2 instance to which you want to attach the lifecycle
hook. The valid values are:
- autoscaling:EC2_INSTANCE_LAUNCHING
- autoscaling:EC2_INSTANCE_TERMINATING
lifecycleHookSpecification_defaultResult :: Lens' LifecycleHookSpecification (Maybe Text) Source #
Defines the action the Auto Scaling group should take when the lifecycle
hook timeout elapses or if an unexpected failure occurs. The valid
values are CONTINUE and ABANDON. The default value is ABANDON.
lifecycleHookSpecification_heartbeatTimeout :: Lens' LifecycleHookSpecification (Maybe Int) Source #
The maximum time, in seconds, that can elapse before the lifecycle hook times out.
If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the
action that you specified in the DefaultResult parameter. You can
prevent the lifecycle hook from timing out by calling
RecordLifecycleActionHeartbeat.
lifecycleHookSpecification_notificationMetadata :: Lens' LifecycleHookSpecification (Maybe Text) Source #
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
lifecycleHookSpecification_notificationTargetARN :: Lens' LifecycleHookSpecification (Maybe Text) Source #
The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.
lifecycleHookSpecification_roleARN :: Lens' LifecycleHookSpecification (Maybe Text) Source #
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
lifecycleHookSpecification_lifecycleHookName :: Lens' LifecycleHookSpecification Text Source #
The name of the lifecycle hook.
lifecycleHookSpecification_lifecycleTransition :: Lens' LifecycleHookSpecification Text Source #
The state of the EC2 instance to which you want to attach the lifecycle hook. The valid values are:
- autoscaling:EC2_INSTANCE_LAUNCHING
- autoscaling:EC2_INSTANCE_TERMINATING
LoadBalancerState
data LoadBalancerState Source #
Describes the state of a Classic Load Balancer.
See: newLoadBalancerState smart constructor.
Constructors
| LoadBalancerState' | |
Fields
| |
Instances
newLoadBalancerState :: LoadBalancerState Source #
Create a value of LoadBalancerState 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:state:LoadBalancerState', loadBalancerState_state - One of the following load balancer states:
Adding- The Auto Scaling instances are being registered with the load balancer.Added- All Auto Scaling instances are registered with the load balancer.InService- At least one Auto Scaling instance passed anELBhealth check.Removing- The Auto Scaling instances are being deregistered from the load balancer. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.Removed- All Auto Scaling instances are deregistered from the load balancer.
$sel:loadBalancerName:LoadBalancerState', loadBalancerState_loadBalancerName - The name of the load balancer.
loadBalancerState_state :: Lens' LoadBalancerState (Maybe Text) Source #
One of the following load balancer states:
Adding- The Auto Scaling instances are being registered with the load balancer.Added- All Auto Scaling instances are registered with the load balancer.InService- At least one Auto Scaling instance passed anELBhealth check.Removing- The Auto Scaling instances are being deregistered from the load balancer. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.Removed- All Auto Scaling instances are deregistered from the load balancer.
loadBalancerState_loadBalancerName :: Lens' LoadBalancerState (Maybe Text) Source #
The name of the load balancer.
LoadBalancerTargetGroupState
data LoadBalancerTargetGroupState Source #
Describes the state of a target group.
See: newLoadBalancerTargetGroupState smart constructor.
Constructors
| LoadBalancerTargetGroupState' | |
Fields
| |
Instances
newLoadBalancerTargetGroupState :: LoadBalancerTargetGroupState Source #
Create a value of LoadBalancerTargetGroupState 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:state:LoadBalancerTargetGroupState', loadBalancerTargetGroupState_state - The state of the target group.
Adding- The Auto Scaling instances are being registered with the target group.Added- All Auto Scaling instances are registered with the target group.InService- At least one Auto Scaling instance passed anELBhealth check.Removing- The Auto Scaling instances are being deregistered from the target group. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.Removed- All Auto Scaling instances are deregistered from the target group.
$sel:loadBalancerTargetGroupARN:LoadBalancerTargetGroupState', loadBalancerTargetGroupState_loadBalancerTargetGroupARN - The Amazon Resource Name (ARN) of the target group.
loadBalancerTargetGroupState_state :: Lens' LoadBalancerTargetGroupState (Maybe Text) Source #
The state of the target group.
Adding- The Auto Scaling instances are being registered with the target group.Added- All Auto Scaling instances are registered with the target group.InService- At least one Auto Scaling instance passed anELBhealth check.Removing- The Auto Scaling instances are being deregistered from the target group. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.Removed- All Auto Scaling instances are deregistered from the target group.
loadBalancerTargetGroupState_loadBalancerTargetGroupARN :: Lens' LoadBalancerTargetGroupState (Maybe Text) Source #
The Amazon Resource Name (ARN) of the target group.
LoadForecast
data LoadForecast Source #
A GetPredictiveScalingForecast call returns the load forecast for a
predictive scaling policy. This structure includes the data points for
that load forecast, along with the timestamps of those data points and
the metric specification.
See: newLoadForecast smart constructor.
Constructors
| LoadForecast' | |
Fields
| |
Instances
Arguments
| :: PredictiveScalingMetricSpecification | |
| -> LoadForecast |
Create a value of LoadForecast 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:timestamps:LoadForecast', loadForecast_timestamps - The time stamps for the data points, in UTC format.
$sel:values:LoadForecast', loadForecast_values - The values of the data points.
$sel:metricSpecification:LoadForecast', loadForecast_metricSpecification - The metric specification for the load forecast.
loadForecast_timestamps :: Lens' LoadForecast [UTCTime] Source #
The time stamps for the data points, in UTC format.
loadForecast_values :: Lens' LoadForecast [Double] Source #
The values of the data points.
loadForecast_metricSpecification :: Lens' LoadForecast PredictiveScalingMetricSpecification Source #
The metric specification for the load forecast.
MetricCollectionType
data MetricCollectionType Source #
Describes a metric.
See: newMetricCollectionType smart constructor.
Constructors
| MetricCollectionType' | |
Fields
| |
Instances
newMetricCollectionType :: MetricCollectionType Source #
Create a value of MetricCollectionType 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:metric:MetricCollectionType', metricCollectionType_metric - One of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
GroupInServiceCapacity
GroupPendingCapacity
GroupStandbyCapacity
GroupTerminatingCapacity
GroupTotalCapacity
WarmPoolDesiredCapacity
WarmPoolWarmedCapacity
WarmPoolPendingCapacity
WarmPoolTerminatingCapacity
WarmPoolTotalCapacity
GroupAndWarmPoolDesiredCapacity
GroupAndWarmPoolTotalCapacity
metricCollectionType_metric :: Lens' MetricCollectionType (Maybe Text) Source #
One of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
GroupInServiceCapacity
GroupPendingCapacity
GroupStandbyCapacity
GroupTerminatingCapacity
GroupTotalCapacity
WarmPoolDesiredCapacity
WarmPoolWarmedCapacity
WarmPoolPendingCapacity
WarmPoolTerminatingCapacity
WarmPoolTotalCapacity
GroupAndWarmPoolDesiredCapacity
GroupAndWarmPoolTotalCapacity
MetricDimension
data MetricDimension Source #
Describes the dimension of a metric.
See: newMetricDimension smart constructor.
Constructors
| MetricDimension' | |
Instances
Create a value of MetricDimension 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:name:MetricDimension', metricDimension_name - The name of the dimension.
$sel:value:MetricDimension', metricDimension_value - The value of the dimension.
metricDimension_name :: Lens' MetricDimension Text Source #
The name of the dimension.
metricDimension_value :: Lens' MetricDimension Text Source #
The value of the dimension.
MetricGranularityType
data MetricGranularityType Source #
Describes a granularity of a metric.
See: newMetricGranularityType smart constructor.
Constructors
| MetricGranularityType' | |
Fields
| |
Instances
newMetricGranularityType :: MetricGranularityType Source #
Create a value of MetricGranularityType 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:granularity:MetricGranularityType', metricGranularityType_granularity - The granularity. The only valid value is 1Minute.
metricGranularityType_granularity :: Lens' MetricGranularityType (Maybe Text) Source #
The granularity. The only valid value is 1Minute.
MixedInstancesPolicy
data MixedInstancesPolicy Source #
Describes a mixed instances policy. A mixed instances policy contains the instance types Amazon EC2 Auto Scaling can launch, and other information Amazon EC2 Auto Scaling can use to launch instances to help you optimize your costs. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
See: newMixedInstancesPolicy smart constructor.
Constructors
| MixedInstancesPolicy' | |
Fields
| |
Instances
newMixedInstancesPolicy :: MixedInstancesPolicy Source #
Create a value of MixedInstancesPolicy 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:launchTemplate:MixedInstancesPolicy', mixedInstancesPolicy_launchTemplate - Specifies the launch template to use and the instance types (overrides)
that are used to provision EC2 instances to fulfill On-Demand and Spot
capacities. Required when creating a mixed instances policy.
$sel:instancesDistribution:MixedInstancesPolicy', mixedInstancesPolicy_instancesDistribution - Specifies the instances distribution. If not provided, the value for
each property in InstancesDistribution uses a default value.
mixedInstancesPolicy_launchTemplate :: Lens' MixedInstancesPolicy (Maybe LaunchTemplate) Source #
Specifies the launch template to use and the instance types (overrides) that are used to provision EC2 instances to fulfill On-Demand and Spot capacities. Required when creating a mixed instances policy.
mixedInstancesPolicy_instancesDistribution :: Lens' MixedInstancesPolicy (Maybe InstancesDistribution) Source #
Specifies the instances distribution. If not provided, the value for
each property in InstancesDistribution uses a default value.
NotificationConfiguration
data NotificationConfiguration Source #
Describes a notification.
See: newNotificationConfiguration smart constructor.
Constructors
| NotificationConfiguration' | |
Fields
| |
Instances
newNotificationConfiguration :: NotificationConfiguration Source #
Create a value of NotificationConfiguration 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:topicARN:NotificationConfiguration', notificationConfiguration_topicARN - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service
(Amazon SNS) topic.
$sel:autoScalingGroupName:NotificationConfiguration', notificationConfiguration_autoScalingGroupName - The name of the Auto Scaling group.
$sel:notificationType:NotificationConfiguration', notificationConfiguration_notificationType - One of the following event notification types:
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
notificationConfiguration_topicARN :: Lens' NotificationConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.
notificationConfiguration_autoScalingGroupName :: Lens' NotificationConfiguration (Maybe Text) Source #
The name of the Auto Scaling group.
notificationConfiguration_notificationType :: Lens' NotificationConfiguration (Maybe Text) Source #
One of the following event notification types:
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
PredefinedMetricSpecification
data PredefinedMetricSpecification Source #
Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.
See: newPredefinedMetricSpecification smart constructor.
Constructors
| PredefinedMetricSpecification' | |
Fields
| |
Instances
newPredefinedMetricSpecification Source #
Arguments
| :: MetricType | |
| -> PredefinedMetricSpecification |
Create a value of PredefinedMetricSpecification 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:resourceLabel:PredefinedMetricSpecification', predefinedMetricSpecification_resourceLabel - A label that uniquely identifies a specific Application Load Balancer
target group from which to determine the average request count served by
your Auto Scaling group. You can't specify a resource label unless the
target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
- app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
- targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
$sel:predefinedMetricType:PredefinedMetricSpecification', predefinedMetricSpecification_predefinedMetricType - The metric type. The following predefined metrics are available:
ASGAverageCPUUtilization- Average CPU utilization of the Auto Scaling group.ASGAverageNetworkIn- Average number of bytes received on all network interfaces by the Auto Scaling group.ASGAverageNetworkOut- Average number of bytes sent out on all network interfaces by the Auto Scaling group.ALBRequestCountPerTarget- Number of requests completed per target in an Application Load Balancer target group.
predefinedMetricSpecification_resourceLabel :: Lens' PredefinedMetricSpecification (Maybe Text) Source #
A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
- app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
- targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
predefinedMetricSpecification_predefinedMetricType :: Lens' PredefinedMetricSpecification MetricType Source #
The metric type. The following predefined metrics are available:
ASGAverageCPUUtilization- Average CPU utilization of the Auto Scaling group.ASGAverageNetworkIn- Average number of bytes received on all network interfaces by the Auto Scaling group.ASGAverageNetworkOut- Average number of bytes sent out on all network interfaces by the Auto Scaling group.ALBRequestCountPerTarget- Number of requests completed per target in an Application Load Balancer target group.
PredictiveScalingConfiguration
data PredictiveScalingConfiguration Source #
Represents a predictive scaling policy configuration to use with Amazon EC2 Auto Scaling.
See: newPredictiveScalingConfiguration smart constructor.
Constructors
| PredictiveScalingConfiguration' | |
Fields
| |
Instances
newPredictiveScalingConfiguration :: PredictiveScalingConfiguration Source #
Create a value of PredictiveScalingConfiguration 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:schedulingBufferTime:PredictiveScalingConfiguration', predictiveScalingConfiguration_schedulingBufferTime - The amount of time, in seconds, by which the instance launch time can be
advanced. For example, the forecast says to add capacity at 10:00 AM,
and you choose to pre-launch instances by 5 minutes. In that case, the
instances will be launched at 9:55 AM. The intention is to give
resources time to be provisioned. It can take a few minutes to launch an
EC2 instance. The actual amount of time required depends on several
factors, such as the size of the instance and whether there are startup
scripts to complete.
The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
$sel:maxCapacityBuffer:PredictiveScalingConfiguration', predictiveScalingConfiguration_maxCapacityBuffer - The size of the capacity buffer to use when the forecast capacity is
close to or exceeds the maximum capacity. The value is specified as a
percentage relative to the forecast capacity. For example, if the buffer
is 10, this means a 10 percent buffer, such that if the forecast
capacity is 50, and the maximum capacity is 40, then the effective
maximum capacity is 55.
If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.
Required if the MaxCapacityBreachBehavior property is set to
IncreaseMaxCapacity, and cannot be used otherwise.
$sel:mode:PredictiveScalingConfiguration', predictiveScalingConfiguration_mode - The predictive scaling mode. Defaults to ForecastOnly if not
specified.
$sel:maxCapacityBreachBehavior:PredictiveScalingConfiguration', predictiveScalingConfiguration_maxCapacityBreachBehavior - Defines the behavior that should be applied if the forecast capacity
approaches or exceeds the maximum capacity of the Auto Scaling group.
Defaults to HonorMaxCapacity if not specified.
The following are possible values:
HonorMaxCapacity- Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.IncreaseMaxCapacity- Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value forMaxCapacityBuffer.
$sel:metricSpecifications:PredictiveScalingConfiguration', predictiveScalingConfiguration_metricSpecifications - This structure includes the metrics and target utilization to use for
predictive scaling.
This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
predictiveScalingConfiguration_schedulingBufferTime :: Lens' PredictiveScalingConfiguration (Maybe Natural) Source #
The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.
The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
predictiveScalingConfiguration_maxCapacityBuffer :: Lens' PredictiveScalingConfiguration (Maybe Natural) Source #
The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.
Required if the MaxCapacityBreachBehavior property is set to
IncreaseMaxCapacity, and cannot be used otherwise.
predictiveScalingConfiguration_mode :: Lens' PredictiveScalingConfiguration (Maybe PredictiveScalingMode) Source #
The predictive scaling mode. Defaults to ForecastOnly if not
specified.
predictiveScalingConfiguration_maxCapacityBreachBehavior :: Lens' PredictiveScalingConfiguration (Maybe PredictiveScalingMaxCapacityBreachBehavior) Source #
Defines the behavior that should be applied if the forecast capacity
approaches or exceeds the maximum capacity of the Auto Scaling group.
Defaults to HonorMaxCapacity if not specified.
The following are possible values:
HonorMaxCapacity- Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.IncreaseMaxCapacity- Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value forMaxCapacityBuffer.
predictiveScalingConfiguration_metricSpecifications :: Lens' PredictiveScalingConfiguration [PredictiveScalingMetricSpecification] Source #
This structure includes the metrics and target utilization to use for predictive scaling.
This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
PredictiveScalingMetricSpecification
data PredictiveScalingMetricSpecification Source #
This structure specifies the metrics and target utilization settings for a predictive scaling policy.
You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.
Example
- You create a predictive scaling policy and specify
ALBRequestCountas the value for the metric pair and1000.0as the target value. For this type of metric, you must provide the metric dimension for the corresponding target group, so you also provide a resource label for the Application Load Balancer target group that is attached to your Auto Scaling group. - The number of requests the target group receives per minute provides
the load metric, and the request count averaged between the members
of the target group provides the scaling metric. In CloudWatch, this
refers to the
RequestCountandRequestCountPerTargetmetrics, respectively. - For optimal use of predictive scaling, you adhere to the best practice of using a dynamic scaling policy to automatically scale between the minimum capacity and maximum capacity in response to real-time changes in resource utilization.
- Amazon EC2 Auto Scaling consumes data points for the load metric over the last 14 days and creates an hourly load forecast for predictive scaling. (A minimum of 24 hours of data is required.)
- After creating the load forecast, Amazon EC2 Auto Scaling determines when to reduce or increase the capacity of your Auto Scaling group in each hour of the forecast period so that the average number of requests received by each instance is as close to 1000 requests per minute as possible at all times.
See: newPredictiveScalingMetricSpecification smart constructor.
Constructors
| PredictiveScalingMetricSpecification' | |
Fields
| |
Instances
newPredictiveScalingMetricSpecification Source #
Arguments
| :: Double | |
| -> PredictiveScalingMetricSpecification |
Create a value of PredictiveScalingMetricSpecification 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:predefinedScalingMetricSpecification:PredictiveScalingMetricSpecification', predictiveScalingMetricSpecification_predefinedScalingMetricSpecification - The scaling metric specification.
$sel:predefinedMetricPairSpecification:PredictiveScalingMetricSpecification', predictiveScalingMetricSpecification_predefinedMetricPairSpecification - The metric pair specification from which Amazon EC2 Auto Scaling
determines the appropriate scaling metric and load metric to use.
$sel:predefinedLoadMetricSpecification:PredictiveScalingMetricSpecification', predictiveScalingMetricSpecification_predefinedLoadMetricSpecification - The load metric specification.
$sel:targetValue:PredictiveScalingMetricSpecification', predictiveScalingMetricSpecification_targetValue - Specifies the target utilization.
predictiveScalingMetricSpecification_predefinedScalingMetricSpecification :: Lens' PredictiveScalingMetricSpecification (Maybe PredictiveScalingPredefinedScalingMetric) Source #
The scaling metric specification.
predictiveScalingMetricSpecification_predefinedMetricPairSpecification :: Lens' PredictiveScalingMetricSpecification (Maybe PredictiveScalingPredefinedMetricPair) Source #
The metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
predictiveScalingMetricSpecification_predefinedLoadMetricSpecification :: Lens' PredictiveScalingMetricSpecification (Maybe PredictiveScalingPredefinedLoadMetric) Source #
The load metric specification.
predictiveScalingMetricSpecification_targetValue :: Lens' PredictiveScalingMetricSpecification Double Source #
Specifies the target utilization.
PredictiveScalingPredefinedLoadMetric
data PredictiveScalingPredefinedLoadMetric Source #
Describes a load metric for a predictive scaling policy.
When returned in the output of DescribePolicies, it indicates that a
predictive scaling policy uses individually specified load and scaling
metrics instead of a metric pair.
See: newPredictiveScalingPredefinedLoadMetric smart constructor.
Constructors
| PredictiveScalingPredefinedLoadMetric' | |
Fields
| |
Instances
newPredictiveScalingPredefinedLoadMetric Source #
Arguments
| :: PredefinedLoadMetricType |
|
| -> PredictiveScalingPredefinedLoadMetric |
Create a value of PredictiveScalingPredefinedLoadMetric 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:resourceLabel:PredictiveScalingPredefinedLoadMetric', predictiveScalingPredefinedLoadMetric_resourceLabel - A label that uniquely identifies a specific Application Load Balancer
target group from which to determine the request count served by your
Auto Scaling group. You can't specify a resource label unless the
target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
- app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
- targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
$sel:predefinedMetricType:PredictiveScalingPredefinedLoadMetric', predictiveScalingPredefinedLoadMetric_predefinedMetricType - The metric type.
predictiveScalingPredefinedLoadMetric_resourceLabel :: Lens' PredictiveScalingPredefinedLoadMetric (Maybe Text) Source #
A label that uniquely identifies a specific Application Load Balancer target group from which to determine the request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
- app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
- targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
predictiveScalingPredefinedLoadMetric_predefinedMetricType :: Lens' PredictiveScalingPredefinedLoadMetric PredefinedLoadMetricType Source #
The metric type.
PredictiveScalingPredefinedMetricPair
data PredictiveScalingPredefinedMetricPair Source #
Represents a metric pair for a predictive scaling policy.
See: newPredictiveScalingPredefinedMetricPair smart constructor.
Constructors
| PredictiveScalingPredefinedMetricPair' | |
Fields
| |
Instances
newPredictiveScalingPredefinedMetricPair Source #
Arguments
| :: PredefinedMetricPairType |
|
| -> PredictiveScalingPredefinedMetricPair |
Create a value of PredictiveScalingPredefinedMetricPair 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:resourceLabel:PredictiveScalingPredefinedMetricPair', predictiveScalingPredefinedMetricPair_resourceLabel - A label that uniquely identifies a specific Application Load Balancer
target group from which to determine the total and average request count
served by your Auto Scaling group. You can't specify a resource label
unless the target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
- app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
- targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
$sel:predefinedMetricType:PredictiveScalingPredefinedMetricPair', predictiveScalingPredefinedMetricPair_predefinedMetricType - Indicates which metrics to use. There are two different types of metrics
for each metric type: one is a load metric and one is a scaling metric.
For example, if the metric type is ASGCPUUtilization, the Auto Scaling
group's total CPU metric is used as the load metric, and the average
CPU metric is used for the scaling metric.
predictiveScalingPredefinedMetricPair_resourceLabel :: Lens' PredictiveScalingPredefinedMetricPair (Maybe Text) Source #
A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
- app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
- targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
predictiveScalingPredefinedMetricPair_predefinedMetricType :: Lens' PredictiveScalingPredefinedMetricPair PredefinedMetricPairType Source #
Indicates which metrics to use. There are two different types of metrics
for each metric type: one is a load metric and one is a scaling metric.
For example, if the metric type is ASGCPUUtilization, the Auto Scaling
group's total CPU metric is used as the load metric, and the average
CPU metric is used for the scaling metric.
PredictiveScalingPredefinedScalingMetric
data PredictiveScalingPredefinedScalingMetric Source #
Describes a scaling metric for a predictive scaling policy.
When returned in the output of DescribePolicies, it indicates that a
predictive scaling policy uses individually specified load and scaling
metrics instead of a metric pair.
See: newPredictiveScalingPredefinedScalingMetric smart constructor.
Constructors
| PredictiveScalingPredefinedScalingMetric' | |
Fields
| |
Instances
newPredictiveScalingPredefinedScalingMetric Source #
Arguments
| :: PredefinedScalingMetricType |
|
| -> PredictiveScalingPredefinedScalingMetric |
Create a value of PredictiveScalingPredefinedScalingMetric 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:resourceLabel:PredictiveScalingPredefinedScalingMetric', predictiveScalingPredefinedScalingMetric_resourceLabel - A label that uniquely identifies a specific Application Load Balancer
target group from which to determine the average request count served by
your Auto Scaling group. You can't specify a resource label unless the
target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
- app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
- targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
$sel:predefinedMetricType:PredictiveScalingPredefinedScalingMetric', predictiveScalingPredefinedScalingMetric_predefinedMetricType - The metric type.
predictiveScalingPredefinedScalingMetric_resourceLabel :: Lens' PredictiveScalingPredefinedScalingMetric (Maybe Text) Source #
A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
- app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
- targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
predictiveScalingPredefinedScalingMetric_predefinedMetricType :: Lens' PredictiveScalingPredefinedScalingMetric PredefinedScalingMetricType Source #
The metric type.
ProcessType
data ProcessType Source #
Describes a process type.
For more information, see Scaling processes in the Amazon EC2 Auto Scaling User Guide.
See: newProcessType smart constructor.
Constructors
| ProcessType' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ProcessType |
Create a value of ProcessType 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:processName:ProcessType', processType_processName - One of the following processes:
Launch
Terminate
AddToLoadBalancer
AlarmNotification
AZRebalance
HealthCheck
InstanceRefresh
ReplaceUnhealthy
ScheduledActions
processType_processName :: Lens' ProcessType Text Source #
One of the following processes:
Launch
Terminate
AddToLoadBalancer
AlarmNotification
AZRebalance
HealthCheck
InstanceRefresh
ReplaceUnhealthy
ScheduledActions
RefreshPreferences
data RefreshPreferences Source #
Describes the preferences for an instance refresh.
See: newRefreshPreferences smart constructor.
Constructors
| RefreshPreferences' | |
Fields
| |
Instances
newRefreshPreferences :: RefreshPreferences Source #
Create a value of RefreshPreferences 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:minHealthyPercentage:RefreshPreferences', refreshPreferences_minHealthyPercentage - The amount of capacity in the Auto Scaling group that must remain
healthy during an instance refresh to allow the operation to continue.
The value is expressed as a percentage of the desired capacity of the
Auto Scaling group (rounded up to the nearest integer). The default is
90.
Setting the minimum healthy percentage to 100 percent limits the rate of replacement to one instance at a time. In contrast, setting it to 0 percent has the effect of replacing all instances at the same time.
$sel:skipMatching:RefreshPreferences', refreshPreferences_skipMatching - A boolean value that indicates whether skip matching is enabled. If
true, then Amazon EC2 Auto Scaling skips replacing instances that match
the desired configuration. If no desired configuration is specified,
then it skips replacing instances that have the same configuration that
is already set on the group. The default is false.
$sel:checkpointPercentages:RefreshPreferences', refreshPreferences_checkpointPercentages - Threshold values for each checkpoint in ascending order. Each number
must be unique. To replace all instances in the Auto Scaling group, the
last number in the array must be 100.
For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.
$sel:checkpointDelay:RefreshPreferences', refreshPreferences_checkpointDelay - The amount of time, in seconds, to wait after a checkpoint before
continuing. This property is optional, but if you specify a value for
it, you must also specify a value for CheckpointPercentages. If you
specify a value for CheckpointPercentages and not for
CheckpointDelay, the CheckpointDelay defaults to 3600 (1 hour).
$sel:instanceWarmup:RefreshPreferences', refreshPreferences_instanceWarmup - The number of seconds until a newly launched instance is configured and
ready to use. During this time, Amazon EC2 Auto Scaling does not
immediately move on to the next replacement. The default is to use the
value for the health check grace period defined for the group.
refreshPreferences_minHealthyPercentage :: Lens' RefreshPreferences (Maybe Natural) Source #
The amount of capacity in the Auto Scaling group that must remain
healthy during an instance refresh to allow the operation to continue.
The value is expressed as a percentage of the desired capacity of the
Auto Scaling group (rounded up to the nearest integer). The default is
90.
Setting the minimum healthy percentage to 100 percent limits the rate of replacement to one instance at a time. In contrast, setting it to 0 percent has the effect of replacing all instances at the same time.
refreshPreferences_skipMatching :: Lens' RefreshPreferences (Maybe Bool) Source #
A boolean value that indicates whether skip matching is enabled. If
true, then Amazon EC2 Auto Scaling skips replacing instances that match
the desired configuration. If no desired configuration is specified,
then it skips replacing instances that have the same configuration that
is already set on the group. The default is false.
refreshPreferences_checkpointPercentages :: Lens' RefreshPreferences (Maybe [Natural]) Source #
Threshold values for each checkpoint in ascending order. Each number
must be unique. To replace all instances in the Auto Scaling group, the
last number in the array must be 100.
For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.
refreshPreferences_checkpointDelay :: Lens' RefreshPreferences (Maybe Natural) Source #
The amount of time, in seconds, to wait after a checkpoint before
continuing. This property is optional, but if you specify a value for
it, you must also specify a value for CheckpointPercentages. If you
specify a value for CheckpointPercentages and not for
CheckpointDelay, the CheckpointDelay defaults to 3600 (1 hour).
refreshPreferences_instanceWarmup :: Lens' RefreshPreferences (Maybe Natural) Source #
The number of seconds until a newly launched instance is configured and ready to use. During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The default is to use the value for the health check grace period defined for the group.
ScalingPolicy
data ScalingPolicy Source #
Describes a scaling policy.
See: newScalingPolicy smart constructor.
Constructors
| ScalingPolicy' | |
Fields
| |
Instances
newScalingPolicy :: ScalingPolicy Source #
Create a value of ScalingPolicy 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:minAdjustmentStep:ScalingPolicy', scalingPolicy_minAdjustmentStep - Available for backward compatibility. Use MinAdjustmentMagnitude
instead.
$sel:estimatedInstanceWarmup:ScalingPolicy', scalingPolicy_estimatedInstanceWarmup - The estimated time, in seconds, until a newly launched instance can
contribute to the CloudWatch metrics.
$sel:policyName:ScalingPolicy', scalingPolicy_policyName - The name of the scaling policy.
$sel:enabled:ScalingPolicy', scalingPolicy_enabled - Indicates whether the policy is enabled (true) or disabled (false).
$sel:policyType:ScalingPolicy', scalingPolicy_policyType - One of the following policy types:
TargetTrackingScaling
StepScaling
SimpleScaling(default)PredictiveScaling
For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
$sel:stepAdjustments:ScalingPolicy', scalingPolicy_stepAdjustments - A set of adjustments that enable you to scale based on the size of the
alarm breach.
$sel:targetTrackingConfiguration:ScalingPolicy', scalingPolicy_targetTrackingConfiguration - A target tracking scaling policy.
$sel:adjustmentType:ScalingPolicy', scalingPolicy_adjustmentType - Specifies how the scaling adjustment is interpreted (for example, an
absolute number or a percentage). The valid values are
ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
$sel:autoScalingGroupName:ScalingPolicy', scalingPolicy_autoScalingGroupName - The name of the Auto Scaling group.
$sel:predictiveScalingConfiguration:ScalingPolicy', scalingPolicy_predictiveScalingConfiguration - A predictive scaling policy.
$sel:scalingAdjustment:ScalingPolicy', scalingPolicy_scalingAdjustment - The amount by which to scale, based on the specified adjustment type. A
positive value adds to the current capacity while a negative number
removes from the current capacity.
$sel:cooldown:ScalingPolicy', scalingPolicy_cooldown - The duration of the policy's cooldown period, in seconds.
$sel:policyARN:ScalingPolicy', scalingPolicy_policyARN - The Amazon Resource Name (ARN) of the policy.
$sel:alarms:ScalingPolicy', scalingPolicy_alarms - The CloudWatch alarms related to the policy.
$sel:metricAggregationType:ScalingPolicy', scalingPolicy_metricAggregationType - The aggregation type for the CloudWatch metrics. The valid values are
Minimum, Maximum, and Average.
$sel:minAdjustmentMagnitude:ScalingPolicy', scalingPolicy_minAdjustmentMagnitude - The minimum value to scale by when the adjustment type is
PercentChangeInCapacity.
scalingPolicy_minAdjustmentStep :: Lens' ScalingPolicy (Maybe Int) Source #
Available for backward compatibility. Use MinAdjustmentMagnitude
instead.
scalingPolicy_estimatedInstanceWarmup :: Lens' ScalingPolicy (Maybe Int) Source #
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
scalingPolicy_policyName :: Lens' ScalingPolicy (Maybe Text) Source #
The name of the scaling policy.
scalingPolicy_enabled :: Lens' ScalingPolicy (Maybe Bool) Source #
Indicates whether the policy is enabled (true) or disabled (false).
scalingPolicy_policyType :: Lens' ScalingPolicy (Maybe Text) Source #
One of the following policy types:
TargetTrackingScaling
StepScaling
SimpleScaling(default)PredictiveScaling
For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
scalingPolicy_stepAdjustments :: Lens' ScalingPolicy (Maybe [StepAdjustment]) Source #
A set of adjustments that enable you to scale based on the size of the alarm breach.
scalingPolicy_targetTrackingConfiguration :: Lens' ScalingPolicy (Maybe TargetTrackingConfiguration) Source #
A target tracking scaling policy.
scalingPolicy_adjustmentType :: Lens' ScalingPolicy (Maybe Text) Source #
Specifies how the scaling adjustment is interpreted (for example, an
absolute number or a percentage). The valid values are
ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
scalingPolicy_autoScalingGroupName :: Lens' ScalingPolicy (Maybe Text) Source #
The name of the Auto Scaling group.
scalingPolicy_predictiveScalingConfiguration :: Lens' ScalingPolicy (Maybe PredictiveScalingConfiguration) Source #
A predictive scaling policy.
scalingPolicy_scalingAdjustment :: Lens' ScalingPolicy (Maybe Int) Source #
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
scalingPolicy_cooldown :: Lens' ScalingPolicy (Maybe Int) Source #
The duration of the policy's cooldown period, in seconds.
scalingPolicy_policyARN :: Lens' ScalingPolicy (Maybe Text) Source #
The Amazon Resource Name (ARN) of the policy.
scalingPolicy_alarms :: Lens' ScalingPolicy (Maybe [Alarm]) Source #
The CloudWatch alarms related to the policy.
scalingPolicy_metricAggregationType :: Lens' ScalingPolicy (Maybe Text) Source #
The aggregation type for the CloudWatch metrics. The valid values are
Minimum, Maximum, and Average.
scalingPolicy_minAdjustmentMagnitude :: Lens' ScalingPolicy (Maybe Int) Source #
The minimum value to scale by when the adjustment type is
PercentChangeInCapacity.
ScalingProcessQuery
data ScalingProcessQuery Source #
See: newScalingProcessQuery smart constructor.
Constructors
| ScalingProcessQuery' | |
Fields
| |
Instances
newScalingProcessQuery Source #
Create a value of ScalingProcessQuery 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:scalingProcesses:ScalingProcessQuery', scalingProcessQuery_scalingProcesses - One or more of the following processes:
Launch
Terminate
AddToLoadBalancer
AlarmNotification
AZRebalance
HealthCheck
InstanceRefresh
ReplaceUnhealthy
ScheduledActions
If you omit this parameter, all processes are specified.
$sel:autoScalingGroupName:ScalingProcessQuery', scalingProcessQuery_autoScalingGroupName - The name of the Auto Scaling group.
scalingProcessQuery_scalingProcesses :: Lens' ScalingProcessQuery (Maybe [Text]) Source #
One or more of the following processes:
Launch
Terminate
AddToLoadBalancer
AlarmNotification
AZRebalance
HealthCheck
InstanceRefresh
ReplaceUnhealthy
ScheduledActions
If you omit this parameter, all processes are specified.
scalingProcessQuery_autoScalingGroupName :: Lens' ScalingProcessQuery Text Source #
The name of the Auto Scaling group.
ScheduledUpdateGroupAction
data ScheduledUpdateGroupAction Source #
Describes a scheduled scaling action.
See: newScheduledUpdateGroupAction smart constructor.
Constructors
| ScheduledUpdateGroupAction' | |
Fields
| |
Instances
newScheduledUpdateGroupAction :: ScheduledUpdateGroupAction Source #
Create a value of ScheduledUpdateGroupAction 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:scheduledActionARN:ScheduledUpdateGroupAction', scheduledUpdateGroupAction_scheduledActionARN - The Amazon Resource Name (ARN) of the scheduled action.
$sel:startTime:ScheduledUpdateGroupAction', scheduledUpdateGroupAction_startTime - The date and time in UTC for this action to start. For example,
"2019-06-01T00:00:00Z".
$sel:time:ScheduledUpdateGroupAction', scheduledUpdateGroupAction_time - This parameter is no longer used.
$sel:scheduledActionName:ScheduledUpdateGroupAction', scheduledUpdateGroupAction_scheduledActionName - The name of the scheduled action.
$sel:maxSize:ScheduledUpdateGroupAction', scheduledUpdateGroupAction_maxSize - The maximum size of the Auto Scaling group.
$sel:recurrence:ScheduledUpdateGroupAction', scheduledUpdateGroupAction_recurrence - The recurring schedule for the action, in Unix cron syntax format.
When StartTime and EndTime are specified with Recurrence, they
form the boundaries of when the recurring action starts and stops.
$sel:desiredCapacity:ScheduledUpdateGroupAction', scheduledUpdateGroupAction_desiredCapacity - The desired capacity is the initial capacity of the Auto Scaling group
after the scheduled action runs and the capacity it attempts to
maintain.
$sel:minSize:ScheduledUpdateGroupAction', scheduledUpdateGroupAction_minSize - The minimum size of the Auto Scaling group.
$sel:autoScalingGroupName:ScheduledUpdateGroupAction', scheduledUpdateGroupAction_autoScalingGroupName - The name of the Auto Scaling group.
$sel:endTime:ScheduledUpdateGroupAction', scheduledUpdateGroupAction_endTime - The date and time in UTC for the recurring schedule to end. For example,
"2019-06-01T00:00:00Z".
$sel:timeZone:ScheduledUpdateGroupAction', scheduledUpdateGroupAction_timeZone - The time zone for the cron expression.
scheduledUpdateGroupAction_scheduledActionARN :: Lens' ScheduledUpdateGroupAction (Maybe Text) Source #
The Amazon Resource Name (ARN) of the scheduled action.
scheduledUpdateGroupAction_startTime :: Lens' ScheduledUpdateGroupAction (Maybe UTCTime) Source #
The date and time in UTC for this action to start. For example,
"2019-06-01T00:00:00Z".
scheduledUpdateGroupAction_time :: Lens' ScheduledUpdateGroupAction (Maybe UTCTime) Source #
This parameter is no longer used.
scheduledUpdateGroupAction_scheduledActionName :: Lens' ScheduledUpdateGroupAction (Maybe Text) Source #
The name of the scheduled action.
scheduledUpdateGroupAction_maxSize :: Lens' ScheduledUpdateGroupAction (Maybe Int) Source #
The maximum size of the Auto Scaling group.
scheduledUpdateGroupAction_recurrence :: Lens' ScheduledUpdateGroupAction (Maybe Text) Source #
The recurring schedule for the action, in Unix cron syntax format.
When StartTime and EndTime are specified with Recurrence, they
form the boundaries of when the recurring action starts and stops.
scheduledUpdateGroupAction_desiredCapacity :: Lens' ScheduledUpdateGroupAction (Maybe Int) Source #
The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
scheduledUpdateGroupAction_minSize :: Lens' ScheduledUpdateGroupAction (Maybe Int) Source #
The minimum size of the Auto Scaling group.
scheduledUpdateGroupAction_autoScalingGroupName :: Lens' ScheduledUpdateGroupAction (Maybe Text) Source #
The name of the Auto Scaling group.
scheduledUpdateGroupAction_endTime :: Lens' ScheduledUpdateGroupAction (Maybe UTCTime) Source #
The date and time in UTC for the recurring schedule to end. For example,
"2019-06-01T00:00:00Z".
scheduledUpdateGroupAction_timeZone :: Lens' ScheduledUpdateGroupAction (Maybe Text) Source #
The time zone for the cron expression.
ScheduledUpdateGroupActionRequest
data ScheduledUpdateGroupActionRequest Source #
Describes information used for one or more scheduled scaling action updates in a BatchPutScheduledUpdateGroupAction operation.
See: newScheduledUpdateGroupActionRequest smart constructor.
Constructors
| ScheduledUpdateGroupActionRequest' | |
Fields
| |
Instances
newScheduledUpdateGroupActionRequest Source #
Arguments
| :: Text | |
| -> ScheduledUpdateGroupActionRequest |
Create a value of ScheduledUpdateGroupActionRequest 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:startTime:ScheduledUpdateGroupActionRequest', scheduledUpdateGroupActionRequest_startTime - The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ
format in UTC/GMT only and in quotes (for example,
"2019-06-01T00:00:00Z").
If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling
performs the action at this time, and then performs the action based on
the specified recurrence.
If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.
$sel:maxSize:ScheduledUpdateGroupActionRequest', scheduledUpdateGroupActionRequest_maxSize - The maximum size of the Auto Scaling group.
$sel:recurrence:ScheduledUpdateGroupActionRequest', scheduledUpdateGroupActionRequest_recurrence - The recurring schedule for the action, in Unix cron syntax format. This
format consists of five fields separated by white spaces: [Minute]
[Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be
in quotes (for example, "30 0 1 1,6,12 *"). For more information
about this format, see Crontab.
When StartTime and EndTime are specified with Recurrence, they
form the boundaries of when the recurring action starts and stops.
Cron expressions use Universal Coordinated Time (UTC) by default.
$sel:desiredCapacity:ScheduledUpdateGroupActionRequest', scheduledUpdateGroupActionRequest_desiredCapacity - The desired capacity is the initial capacity of the Auto Scaling group
after the scheduled action runs and the capacity it attempts to
maintain.
$sel:minSize:ScheduledUpdateGroupActionRequest', scheduledUpdateGroupActionRequest_minSize - The minimum size of the Auto Scaling group.
$sel:endTime:ScheduledUpdateGroupActionRequest', scheduledUpdateGroupActionRequest_endTime - The date and time for the recurring schedule to end, in UTC.
$sel:timeZone:ScheduledUpdateGroupActionRequest', scheduledUpdateGroupActionRequest_timeZone - Specifies the time zone for a cron expression. If a time zone is not
provided, UTC is used by default.
Valid values are the canonical names of the IANA time zones, derived
from the IANA Time Zone Database (such as Etc/GMT+9 or
Pacific/Tahiti). For more information, see
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
$sel:scheduledActionName:ScheduledUpdateGroupActionRequest', scheduledUpdateGroupActionRequest_scheduledActionName - The name of the scaling action.
scheduledUpdateGroupActionRequest_startTime :: Lens' ScheduledUpdateGroupActionRequest (Maybe UTCTime) Source #
The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ
format in UTC/GMT only and in quotes (for example,
"2019-06-01T00:00:00Z").
If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling
performs the action at this time, and then performs the action based on
the specified recurrence.
If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.
scheduledUpdateGroupActionRequest_maxSize :: Lens' ScheduledUpdateGroupActionRequest (Maybe Int) Source #
The maximum size of the Auto Scaling group.
scheduledUpdateGroupActionRequest_recurrence :: Lens' ScheduledUpdateGroupActionRequest (Maybe Text) Source #
The recurring schedule for the action, in Unix cron syntax format. This
format consists of five fields separated by white spaces: [Minute]
[Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be
in quotes (for example, "30 0 1 1,6,12 *"). For more information
about this format, see Crontab.
When StartTime and EndTime are specified with Recurrence, they
form the boundaries of when the recurring action starts and stops.
Cron expressions use Universal Coordinated Time (UTC) by default.
scheduledUpdateGroupActionRequest_desiredCapacity :: Lens' ScheduledUpdateGroupActionRequest (Maybe Int) Source #
The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
scheduledUpdateGroupActionRequest_minSize :: Lens' ScheduledUpdateGroupActionRequest (Maybe Int) Source #
The minimum size of the Auto Scaling group.
scheduledUpdateGroupActionRequest_endTime :: Lens' ScheduledUpdateGroupActionRequest (Maybe UTCTime) Source #
The date and time for the recurring schedule to end, in UTC.
scheduledUpdateGroupActionRequest_timeZone :: Lens' ScheduledUpdateGroupActionRequest (Maybe Text) Source #
Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default.
Valid values are the canonical names of the IANA time zones, derived
from the IANA Time Zone Database (such as Etc/GMT+9 or
Pacific/Tahiti). For more information, see
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
scheduledUpdateGroupActionRequest_scheduledActionName :: Lens' ScheduledUpdateGroupActionRequest Text Source #
The name of the scaling action.
StepAdjustment
data StepAdjustment Source #
Describes information used to create a step adjustment for a step scaling policy.
For the following examples, suppose that you have an alarm with a breach threshold of 50:
- To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.
- To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.
There are a few rules for the step adjustments for your step policy:
- The ranges of your step adjustments can't overlap or have a gap.
- At most, one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.
- At most, one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.
- The upper and lower bound can't be null in the same step adjustment.
For more information, see Step adjustments in the Amazon EC2 Auto Scaling User Guide.
See: newStepAdjustment smart constructor.
Constructors
| StepAdjustment' | |
Fields
| |
Instances
Arguments
| :: Int | |
| -> StepAdjustment |
Create a value of StepAdjustment 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:metricIntervalLowerBound:StepAdjustment', stepAdjustment_metricIntervalLowerBound - The lower bound for the difference between the alarm threshold and the
CloudWatch metric. If the metric value is above the breach threshold,
the lower bound is inclusive (the metric must be greater than or equal
to the threshold plus the lower bound). Otherwise, it is exclusive (the
metric must be greater than the threshold plus the lower bound). A null
value indicates negative infinity.
$sel:metricIntervalUpperBound:StepAdjustment', stepAdjustment_metricIntervalUpperBound - The upper bound for the difference between the alarm threshold and the
CloudWatch metric. If the metric value is above the breach threshold,
the upper bound is exclusive (the metric must be less than the threshold
plus the upper bound). Otherwise, it is inclusive (the metric must be
less than or equal to the threshold plus the upper bound). A null value
indicates positive infinity.
The upper bound must be greater than the lower bound.
$sel:scalingAdjustment:StepAdjustment', stepAdjustment_scalingAdjustment - The amount by which to scale, based on the specified adjustment type. A
positive value adds to the current capacity while a negative number
removes from the current capacity.
stepAdjustment_metricIntervalLowerBound :: Lens' StepAdjustment (Maybe Double) Source #
The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
stepAdjustment_metricIntervalUpperBound :: Lens' StepAdjustment (Maybe Double) Source #
The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
The upper bound must be greater than the lower bound.
stepAdjustment_scalingAdjustment :: Lens' StepAdjustment Int Source #
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
SuspendedProcess
data SuspendedProcess Source #
Describes an auto scaling process that has been suspended.
For more information, see Scaling processes in the Amazon EC2 Auto Scaling User Guide.
See: newSuspendedProcess smart constructor.
Constructors
| SuspendedProcess' | |
Fields
| |
Instances
newSuspendedProcess :: SuspendedProcess Source #
Create a value of SuspendedProcess 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:processName:SuspendedProcess', suspendedProcess_processName - The name of the suspended process.
$sel:suspensionReason:SuspendedProcess', suspendedProcess_suspensionReason - The reason that the process was suspended.
suspendedProcess_processName :: Lens' SuspendedProcess (Maybe Text) Source #
The name of the suspended process.
suspendedProcess_suspensionReason :: Lens' SuspendedProcess (Maybe Text) Source #
The reason that the process was suspended.
Tag
Describes a tag for an Auto Scaling group.
See: newTag smart constructor.
Constructors
| Tag' | |
Fields
| |
Instances
Create a value of Tag 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:key:Tag', tag_key - The tag key.
$sel:resourceId:Tag', tag_resourceId - The name of the Auto Scaling group.
$sel:resourceType:Tag', tag_resourceType - The type of resource. The only supported value is auto-scaling-group.
$sel:propagateAtLaunch:Tag', tag_propagateAtLaunch - Determines whether the tag is added to new instances as they are
launched in the group.
$sel:value:Tag', tag_value - The tag value.
tag_resourceType :: Lens' Tag Text Source #
The type of resource. The only supported value is auto-scaling-group.
tag_propagateAtLaunch :: Lens' Tag Bool Source #
Determines whether the tag is added to new instances as they are launched in the group.
TagDescription
data TagDescription Source #
Describes a tag for an Auto Scaling group.
See: newTagDescription smart constructor.
Constructors
| TagDescription' | |
Fields
| |
Instances
Create a value of TagDescription 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:resourceId:TagDescription', tagDescription_resourceId - The name of the group.
$sel:resourceType:TagDescription', tagDescription_resourceType - The type of resource. The only supported value is auto-scaling-group.
$sel:key:TagDescription', tagDescription_key - The tag key.
$sel:propagateAtLaunch:TagDescription', tagDescription_propagateAtLaunch - Determines whether the tag is added to new instances as they are
launched in the group.
$sel:value:TagDescription', tagDescription_value - The tag value.
tagDescription_resourceId :: Lens' TagDescription Text Source #
The name of the group.
tagDescription_resourceType :: Lens' TagDescription Text Source #
The type of resource. The only supported value is auto-scaling-group.
tagDescription_key :: Lens' TagDescription Text Source #
The tag key.
tagDescription_propagateAtLaunch :: Lens' TagDescription Bool Source #
Determines whether the tag is added to new instances as they are launched in the group.
tagDescription_value :: Lens' TagDescription Text Source #
The tag value.
TargetTrackingConfiguration
data TargetTrackingConfiguration Source #
Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.
See: newTargetTrackingConfiguration smart constructor.
Constructors
| TargetTrackingConfiguration' | |
Fields
| |
Instances
newTargetTrackingConfiguration Source #
Create a value of TargetTrackingConfiguration 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:predefinedMetricSpecification:TargetTrackingConfiguration', targetTrackingConfiguration_predefinedMetricSpecification - A predefined metric. You must specify either a predefined metric or a
customized metric.
$sel:customizedMetricSpecification:TargetTrackingConfiguration', targetTrackingConfiguration_customizedMetricSpecification - A customized metric. You must specify either a predefined metric or a
customized metric.
$sel:disableScaleIn:TargetTrackingConfiguration', targetTrackingConfiguration_disableScaleIn - Indicates whether scaling in by the target tracking scaling policy is
disabled. If scaling in is disabled, the target tracking scaling policy
doesn't remove instances from the Auto Scaling group. Otherwise, the
target tracking scaling policy can remove instances from the Auto
Scaling group. The default is false.
$sel:targetValue:TargetTrackingConfiguration', targetTrackingConfiguration_targetValue - The target value for the metric.
targetTrackingConfiguration_predefinedMetricSpecification :: Lens' TargetTrackingConfiguration (Maybe PredefinedMetricSpecification) Source #
A predefined metric. You must specify either a predefined metric or a customized metric.
targetTrackingConfiguration_customizedMetricSpecification :: Lens' TargetTrackingConfiguration (Maybe CustomizedMetricSpecification) Source #
A customized metric. You must specify either a predefined metric or a customized metric.
targetTrackingConfiguration_disableScaleIn :: Lens' TargetTrackingConfiguration (Maybe Bool) Source #
Indicates whether scaling in by the target tracking scaling policy is
disabled. If scaling in is disabled, the target tracking scaling policy
doesn't remove instances from the Auto Scaling group. Otherwise, the
target tracking scaling policy can remove instances from the Auto
Scaling group. The default is false.
targetTrackingConfiguration_targetValue :: Lens' TargetTrackingConfiguration Double Source #
The target value for the metric.
WarmPoolConfiguration
data WarmPoolConfiguration Source #
Describes a warm pool configuration.
See: newWarmPoolConfiguration smart constructor.
Constructors
| WarmPoolConfiguration' | |
Fields
| |
Instances
newWarmPoolConfiguration :: WarmPoolConfiguration Source #
Create a value of WarmPoolConfiguration 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:WarmPoolConfiguration', warmPoolConfiguration_status - The status of a warm pool that is marked for deletion.
$sel:minSize:WarmPoolConfiguration', warmPoolConfiguration_minSize - The minimum number of instances to maintain in the warm pool.
$sel:maxGroupPreparedCapacity:WarmPoolConfiguration', warmPoolConfiguration_maxGroupPreparedCapacity - The maximum number of instances that are allowed to be in the warm pool
or in any state except Terminated for the Auto Scaling group.
$sel:poolState:WarmPoolConfiguration', warmPoolConfiguration_poolState - The instance state to transition to after the lifecycle actions are
complete.
warmPoolConfiguration_status :: Lens' WarmPoolConfiguration (Maybe WarmPoolStatus) Source #
The status of a warm pool that is marked for deletion.
warmPoolConfiguration_minSize :: Lens' WarmPoolConfiguration (Maybe Natural) Source #
The minimum number of instances to maintain in the warm pool.
warmPoolConfiguration_maxGroupPreparedCapacity :: Lens' WarmPoolConfiguration (Maybe Int) Source #
The maximum number of instances that are allowed to be in the warm pool
or in any state except Terminated for the Auto Scaling group.
warmPoolConfiguration_poolState :: Lens' WarmPoolConfiguration (Maybe WarmPoolState) Source #
The instance state to transition to after the lifecycle actions are complete.