| 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.ApplicationAutoScaling.Types
Contents
- Service Configuration
- Errors
- AdjustmentType
- MetricAggregationType
- MetricStatistic
- MetricType
- PolicyType
- ScalableDimension
- ScalingActivityStatusCode
- ServiceNamespace
- Alarm
- CustomizedMetricSpecification
- MetricDimension
- PredefinedMetricSpecification
- ScalableTarget
- ScalableTargetAction
- ScalingActivity
- ScalingPolicy
- ScheduledAction
- StepAdjustment
- StepScalingPolicyConfiguration
- SuspendedState
- TargetTrackingScalingPolicyConfiguration
Description
Synopsis
- defaultService :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _FailedResourceAccessException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentUpdateException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError
- _ObjectNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype AdjustmentType where
- AdjustmentType' { }
- pattern AdjustmentType_ChangeInCapacity :: AdjustmentType
- pattern AdjustmentType_ExactCapacity :: AdjustmentType
- pattern AdjustmentType_PercentChangeInCapacity :: AdjustmentType
- newtype MetricAggregationType where
- 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_AppStreamAverageCapacityUtilization :: MetricType
- pattern MetricType_CassandraReadCapacityUtilization :: MetricType
- pattern MetricType_CassandraWriteCapacityUtilization :: MetricType
- pattern MetricType_ComprehendInferenceUtilization :: MetricType
- pattern MetricType_DynamoDBReadCapacityUtilization :: MetricType
- pattern MetricType_DynamoDBWriteCapacityUtilization :: MetricType
- pattern MetricType_EC2SpotFleetRequestAverageCPUUtilization :: MetricType
- pattern MetricType_EC2SpotFleetRequestAverageNetworkIn :: MetricType
- pattern MetricType_EC2SpotFleetRequestAverageNetworkOut :: MetricType
- pattern MetricType_ECSServiceAverageCPUUtilization :: MetricType
- pattern MetricType_ECSServiceAverageMemoryUtilization :: MetricType
- pattern MetricType_ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage :: MetricType
- pattern MetricType_ElastiCachePrimaryEngineCPUUtilization :: MetricType
- pattern MetricType_ElastiCacheReplicaEngineCPUUtilization :: MetricType
- pattern MetricType_KafkaBrokerStorageUtilization :: MetricType
- pattern MetricType_LambdaProvisionedConcurrencyUtilization :: MetricType
- pattern MetricType_NeptuneReaderAverageCPUUtilization :: MetricType
- pattern MetricType_RDSReaderAverageCPUUtilization :: MetricType
- pattern MetricType_RDSReaderAverageDatabaseConnections :: MetricType
- pattern MetricType_SageMakerVariantInvocationsPerInstance :: MetricType
- newtype PolicyType where
- PolicyType' { }
- pattern PolicyType_StepScaling :: PolicyType
- pattern PolicyType_TargetTrackingScaling :: PolicyType
- newtype ScalableDimension where
- ScalableDimension' { }
- pattern ScalableDimension_Appstream_fleet_DesiredCapacity :: ScalableDimension
- pattern ScalableDimension_Cassandra_table_ReadCapacityUnits :: ScalableDimension
- pattern ScalableDimension_Cassandra_table_WriteCapacityUnits :: ScalableDimension
- pattern ScalableDimension_Comprehend_document_classifier_endpoint_DesiredInferenceUnits :: ScalableDimension
- pattern ScalableDimension_Comprehend_entity_recognizer_endpoint_DesiredInferenceUnits :: ScalableDimension
- pattern ScalableDimension_Custom_resource_ResourceType_Property :: ScalableDimension
- pattern ScalableDimension_Dynamodb_index_ReadCapacityUnits :: ScalableDimension
- pattern ScalableDimension_Dynamodb_index_WriteCapacityUnits :: ScalableDimension
- pattern ScalableDimension_Dynamodb_table_ReadCapacityUnits :: ScalableDimension
- pattern ScalableDimension_Dynamodb_table_WriteCapacityUnits :: ScalableDimension
- pattern ScalableDimension_Ec2_spot_fleet_request_TargetCapacity :: ScalableDimension
- pattern ScalableDimension_Ecs_service_DesiredCount :: ScalableDimension
- pattern ScalableDimension_Elasticache_replication_group_NodeGroups :: ScalableDimension
- pattern ScalableDimension_Elasticache_replication_group_Replicas :: ScalableDimension
- pattern ScalableDimension_Elasticmapreduce_instancegroup_InstanceCount :: ScalableDimension
- pattern ScalableDimension_Kafka_broker_storage_VolumeSize :: ScalableDimension
- pattern ScalableDimension_Lambda_function_ProvisionedConcurrency :: ScalableDimension
- pattern ScalableDimension_Neptune_cluster_ReadReplicaCount :: ScalableDimension
- pattern ScalableDimension_Rds_cluster_ReadReplicaCount :: ScalableDimension
- pattern ScalableDimension_Sagemaker_variant_DesiredInstanceCount :: ScalableDimension
- newtype ScalingActivityStatusCode where
- ScalingActivityStatusCode' { }
- pattern ScalingActivityStatusCode_Failed :: ScalingActivityStatusCode
- pattern ScalingActivityStatusCode_InProgress :: ScalingActivityStatusCode
- pattern ScalingActivityStatusCode_Overridden :: ScalingActivityStatusCode
- pattern ScalingActivityStatusCode_Pending :: ScalingActivityStatusCode
- pattern ScalingActivityStatusCode_Successful :: ScalingActivityStatusCode
- pattern ScalingActivityStatusCode_Unfulfilled :: ScalingActivityStatusCode
- newtype ServiceNamespace where
- ServiceNamespace' { }
- pattern ServiceNamespace_Appstream :: ServiceNamespace
- pattern ServiceNamespace_Cassandra :: ServiceNamespace
- pattern ServiceNamespace_Comprehend :: ServiceNamespace
- pattern ServiceNamespace_Custom_resource :: ServiceNamespace
- pattern ServiceNamespace_Dynamodb :: ServiceNamespace
- pattern ServiceNamespace_Ec2 :: ServiceNamespace
- pattern ServiceNamespace_Ecs :: ServiceNamespace
- pattern ServiceNamespace_Elasticache :: ServiceNamespace
- pattern ServiceNamespace_Elasticmapreduce :: ServiceNamespace
- pattern ServiceNamespace_Kafka :: ServiceNamespace
- pattern ServiceNamespace_Lambda :: ServiceNamespace
- pattern ServiceNamespace_Neptune :: ServiceNamespace
- pattern ServiceNamespace_Rds :: ServiceNamespace
- pattern ServiceNamespace_Sagemaker :: ServiceNamespace
- data Alarm = Alarm' {}
- newAlarm :: Text -> Text -> Alarm
- alarm_alarmName :: Lens' Alarm Text
- alarm_alarmARN :: Lens' Alarm Text
- 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 MetricDimension = MetricDimension' {}
- newMetricDimension :: Text -> Text -> MetricDimension
- metricDimension_name :: Lens' MetricDimension Text
- metricDimension_value :: Lens' MetricDimension Text
- data PredefinedMetricSpecification = PredefinedMetricSpecification' {}
- newPredefinedMetricSpecification :: MetricType -> PredefinedMetricSpecification
- predefinedMetricSpecification_resourceLabel :: Lens' PredefinedMetricSpecification (Maybe Text)
- predefinedMetricSpecification_predefinedMetricType :: Lens' PredefinedMetricSpecification MetricType
- data ScalableTarget = ScalableTarget' {}
- newScalableTarget :: ServiceNamespace -> Text -> ScalableDimension -> Int -> Int -> Text -> UTCTime -> ScalableTarget
- scalableTarget_suspendedState :: Lens' ScalableTarget (Maybe SuspendedState)
- scalableTarget_serviceNamespace :: Lens' ScalableTarget ServiceNamespace
- scalableTarget_resourceId :: Lens' ScalableTarget Text
- scalableTarget_scalableDimension :: Lens' ScalableTarget ScalableDimension
- scalableTarget_minCapacity :: Lens' ScalableTarget Int
- scalableTarget_maxCapacity :: Lens' ScalableTarget Int
- scalableTarget_roleARN :: Lens' ScalableTarget Text
- scalableTarget_creationTime :: Lens' ScalableTarget UTCTime
- data ScalableTargetAction = ScalableTargetAction' {
- maxCapacity :: Maybe Int
- minCapacity :: Maybe Int
- newScalableTargetAction :: ScalableTargetAction
- scalableTargetAction_maxCapacity :: Lens' ScalableTargetAction (Maybe Int)
- scalableTargetAction_minCapacity :: Lens' ScalableTargetAction (Maybe Int)
- data ScalingActivity = ScalingActivity' {}
- newScalingActivity :: Text -> ServiceNamespace -> Text -> ScalableDimension -> Text -> Text -> UTCTime -> ScalingActivityStatusCode -> ScalingActivity
- scalingActivity_statusMessage :: Lens' ScalingActivity (Maybe Text)
- scalingActivity_endTime :: Lens' ScalingActivity (Maybe UTCTime)
- scalingActivity_details :: Lens' ScalingActivity (Maybe Text)
- scalingActivity_activityId :: Lens' ScalingActivity Text
- scalingActivity_serviceNamespace :: Lens' ScalingActivity ServiceNamespace
- scalingActivity_resourceId :: Lens' ScalingActivity Text
- scalingActivity_scalableDimension :: Lens' ScalingActivity ScalableDimension
- scalingActivity_description :: Lens' ScalingActivity Text
- scalingActivity_cause :: Lens' ScalingActivity Text
- scalingActivity_startTime :: Lens' ScalingActivity UTCTime
- scalingActivity_statusCode :: Lens' ScalingActivity ScalingActivityStatusCode
- data ScalingPolicy = ScalingPolicy' {
- targetTrackingScalingPolicyConfiguration :: Maybe TargetTrackingScalingPolicyConfiguration
- stepScalingPolicyConfiguration :: Maybe StepScalingPolicyConfiguration
- alarms :: Maybe [Alarm]
- policyARN :: Text
- policyName :: Text
- serviceNamespace :: ServiceNamespace
- resourceId :: Text
- scalableDimension :: ScalableDimension
- policyType :: PolicyType
- creationTime :: POSIX
- newScalingPolicy :: Text -> Text -> ServiceNamespace -> Text -> ScalableDimension -> PolicyType -> UTCTime -> ScalingPolicy
- scalingPolicy_targetTrackingScalingPolicyConfiguration :: Lens' ScalingPolicy (Maybe TargetTrackingScalingPolicyConfiguration)
- scalingPolicy_stepScalingPolicyConfiguration :: Lens' ScalingPolicy (Maybe StepScalingPolicyConfiguration)
- scalingPolicy_alarms :: Lens' ScalingPolicy (Maybe [Alarm])
- scalingPolicy_policyARN :: Lens' ScalingPolicy Text
- scalingPolicy_policyName :: Lens' ScalingPolicy Text
- scalingPolicy_serviceNamespace :: Lens' ScalingPolicy ServiceNamespace
- scalingPolicy_resourceId :: Lens' ScalingPolicy Text
- scalingPolicy_scalableDimension :: Lens' ScalingPolicy ScalableDimension
- scalingPolicy_policyType :: Lens' ScalingPolicy PolicyType
- scalingPolicy_creationTime :: Lens' ScalingPolicy UTCTime
- data ScheduledAction = ScheduledAction' {
- scalableDimension :: Maybe ScalableDimension
- startTime :: Maybe POSIX
- endTime :: Maybe POSIX
- scalableTargetAction :: Maybe ScalableTargetAction
- timezone :: Maybe Text
- scheduledActionName :: Text
- scheduledActionARN :: Text
- serviceNamespace :: ServiceNamespace
- schedule :: Text
- resourceId :: Text
- creationTime :: POSIX
- newScheduledAction :: Text -> Text -> ServiceNamespace -> Text -> Text -> UTCTime -> ScheduledAction
- scheduledAction_scalableDimension :: Lens' ScheduledAction (Maybe ScalableDimension)
- scheduledAction_startTime :: Lens' ScheduledAction (Maybe UTCTime)
- scheduledAction_endTime :: Lens' ScheduledAction (Maybe UTCTime)
- scheduledAction_scalableTargetAction :: Lens' ScheduledAction (Maybe ScalableTargetAction)
- scheduledAction_timezone :: Lens' ScheduledAction (Maybe Text)
- scheduledAction_scheduledActionName :: Lens' ScheduledAction Text
- scheduledAction_scheduledActionARN :: Lens' ScheduledAction Text
- scheduledAction_serviceNamespace :: Lens' ScheduledAction ServiceNamespace
- scheduledAction_schedule :: Lens' ScheduledAction Text
- scheduledAction_resourceId :: Lens' ScheduledAction Text
- scheduledAction_creationTime :: Lens' ScheduledAction UTCTime
- data StepAdjustment = StepAdjustment' {}
- newStepAdjustment :: Int -> StepAdjustment
- stepAdjustment_metricIntervalLowerBound :: Lens' StepAdjustment (Maybe Double)
- stepAdjustment_metricIntervalUpperBound :: Lens' StepAdjustment (Maybe Double)
- stepAdjustment_scalingAdjustment :: Lens' StepAdjustment Int
- data StepScalingPolicyConfiguration = StepScalingPolicyConfiguration' {}
- newStepScalingPolicyConfiguration :: StepScalingPolicyConfiguration
- stepScalingPolicyConfiguration_stepAdjustments :: Lens' StepScalingPolicyConfiguration (Maybe [StepAdjustment])
- stepScalingPolicyConfiguration_adjustmentType :: Lens' StepScalingPolicyConfiguration (Maybe AdjustmentType)
- stepScalingPolicyConfiguration_cooldown :: Lens' StepScalingPolicyConfiguration (Maybe Int)
- stepScalingPolicyConfiguration_metricAggregationType :: Lens' StepScalingPolicyConfiguration (Maybe MetricAggregationType)
- stepScalingPolicyConfiguration_minAdjustmentMagnitude :: Lens' StepScalingPolicyConfiguration (Maybe Int)
- data SuspendedState = SuspendedState' {}
- newSuspendedState :: SuspendedState
- suspendedState_dynamicScalingInSuspended :: Lens' SuspendedState (Maybe Bool)
- suspendedState_scheduledScalingSuspended :: Lens' SuspendedState (Maybe Bool)
- suspendedState_dynamicScalingOutSuspended :: Lens' SuspendedState (Maybe Bool)
- data TargetTrackingScalingPolicyConfiguration = TargetTrackingScalingPolicyConfiguration' {}
- newTargetTrackingScalingPolicyConfiguration :: Double -> TargetTrackingScalingPolicyConfiguration
- targetTrackingScalingPolicyConfiguration_predefinedMetricSpecification :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe PredefinedMetricSpecification)
- targetTrackingScalingPolicyConfiguration_scaleInCooldown :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Int)
- targetTrackingScalingPolicyConfiguration_customizedMetricSpecification :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe CustomizedMetricSpecification)
- targetTrackingScalingPolicyConfiguration_disableScaleIn :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Bool)
- targetTrackingScalingPolicyConfiguration_scaleOutCooldown :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Int)
- targetTrackingScalingPolicyConfiguration_targetValue :: Lens' TargetTrackingScalingPolicyConfiguration Double
Service Configuration
defaultService :: Service Source #
API version 2016-02-06 of the Amazon Application Auto Scaling SDK configuration.
Errors
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception was thrown for a validation issue. Review the available parameters for the API request.
_FailedResourceAccessException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The next token supplied was invalid.
_ConcurrentUpdateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.
_InternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service encountered an internal error.
_ObjectNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified object could not be found. For any operation that depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.
AdjustmentType
newtype AdjustmentType Source #
Constructors
| AdjustmentType' | |
Fields | |
Bundled Patterns
| pattern AdjustmentType_ChangeInCapacity :: AdjustmentType | |
| pattern AdjustmentType_ExactCapacity :: AdjustmentType | |
| pattern AdjustmentType_PercentChangeInCapacity :: AdjustmentType |
Instances
MetricAggregationType
newtype MetricAggregationType Source #
Constructors
| MetricAggregationType' | |
Fields | |
Bundled Patterns
| pattern MetricAggregationType_Average :: MetricAggregationType | |
| pattern MetricAggregationType_Maximum :: MetricAggregationType | |
| pattern MetricAggregationType_Minimum :: MetricAggregationType |
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
Instances
PolicyType
newtype PolicyType Source #
Constructors
| PolicyType' | |
Fields | |
Bundled Patterns
| pattern PolicyType_StepScaling :: PolicyType | |
| pattern PolicyType_TargetTrackingScaling :: PolicyType |
Instances
ScalableDimension
newtype ScalableDimension Source #
Constructors
| ScalableDimension' | |
Fields | |
Bundled Patterns
Instances
ScalingActivityStatusCode
newtype ScalingActivityStatusCode Source #
Constructors
| ScalingActivityStatusCode' | |
Fields | |
Bundled Patterns
Instances
ServiceNamespace
newtype ServiceNamespace Source #
Constructors
| ServiceNamespace' | |
Fields | |
Bundled Patterns
| pattern ServiceNamespace_Appstream :: ServiceNamespace | |
| pattern ServiceNamespace_Cassandra :: ServiceNamespace | |
| pattern ServiceNamespace_Comprehend :: ServiceNamespace | |
| pattern ServiceNamespace_Custom_resource :: ServiceNamespace | |
| pattern ServiceNamespace_Dynamodb :: ServiceNamespace | |
| pattern ServiceNamespace_Ec2 :: ServiceNamespace | |
| pattern ServiceNamespace_Ecs :: ServiceNamespace | |
| pattern ServiceNamespace_Elasticache :: ServiceNamespace | |
| pattern ServiceNamespace_Elasticmapreduce :: ServiceNamespace | |
| pattern ServiceNamespace_Kafka :: ServiceNamespace | |
| pattern ServiceNamespace_Lambda :: ServiceNamespace | |
| pattern ServiceNamespace_Neptune :: ServiceNamespace | |
| pattern ServiceNamespace_Rds :: ServiceNamespace | |
| pattern ServiceNamespace_Sagemaker :: ServiceNamespace |
Instances
Alarm
Represents a CloudWatch alarm associated with a scaling policy.
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.ApplicationAutoScaling.Types.Alarm | |
| Hashable Alarm Source # | |
Defined in Amazonka.ApplicationAutoScaling.Types.Alarm | |
| FromJSON Alarm Source # | |
| type Rep Alarm Source # | |
Defined in Amazonka.ApplicationAutoScaling.Types.Alarm type Rep Alarm = D1 ('MetaData "Alarm" "Amazonka.ApplicationAutoScaling.Types.Alarm" "libZSservicesZSamazonka-application-autoscalingZSamazonka-application-autoscaling" 'False) (C1 ('MetaCons "Alarm'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alarmName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "alarmARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 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.
CustomizedMetricSpecification
data CustomizedMetricSpecification Source #
Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Application Auto Scaling.
For information about the available metrics for a service, see Amazon Web Services Services That Publish CloudWatch Metrics in the Amazon CloudWatch User Guide.
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, and increase when capacity decreases.
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.
MetricDimension
data MetricDimension Source #
Describes the dimension names and values associated with 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.
PredefinedMetricSpecification
data PredefinedMetricSpecification Source #
Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling.
Only the Amazon Web Services that you're using send metrics to Amazon CloudWatch. To determine whether a desired metric already exists by looking up its namespace and dimension using the CloudWatch metrics dashboard in the console, follow the procedure in Building dashboards with CloudWatch in the Application Auto Scaling User Guide.
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 - Identifies the resource associated with the metric type. You can't
specify a resource label unless the metric type is
ALBRequestCountPerTarget and there is a target group attached to the
Spot Fleet request or ECS service.
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 ALBRequestCountPerTarget metric type applies only
to Spot Fleet requests and ECS services.
predefinedMetricSpecification_resourceLabel :: Lens' PredefinedMetricSpecification (Maybe Text) Source #
Identifies the resource associated with the metric type. You can't
specify a resource label unless the metric type is
ALBRequestCountPerTarget and there is a target group attached to the
Spot Fleet request or ECS service.
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 ALBRequestCountPerTarget metric type applies only
to Spot Fleet requests and ECS services.
ScalableTarget
data ScalableTarget Source #
Represents a scalable target.
See: newScalableTarget smart constructor.
Constructors
| ScalableTarget' | |
Fields
| |
Instances
Arguments
| :: ServiceNamespace | |
| -> Text | |
| -> ScalableDimension | |
| -> Int | |
| -> Int | |
| -> Text | |
| -> UTCTime | |
| -> ScalableTarget |
Create a value of ScalableTarget 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:suspendedState:ScalableTarget', scalableTarget_suspendedState - Undocumented member.
$sel:serviceNamespace:ScalableTarget', scalableTarget_serviceNamespace - The namespace of the Amazon Web Services service that provides the
resource, or a custom-resource.
$sel:resourceId:ScalableTarget', scalableTarget_resourceId - The identifier of the resource associated with the scalable target. This
string consists of the resource type and unique identifier.
- ECS service - The resource type is
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. - Spot Fleet - The resource type is
spot-fleet-requestand the unique identifier is the Spot Fleet request ID. Example:spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - EMR cluster - The resource type is
instancegroupand the unique identifier is the cluster ID and instance group ID. Example:instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - AppStream 2.0 fleet - The resource type is
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. - DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. - DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. - Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. - SageMaker endpoint variant - The resource type is
variantand the unique identifier is the resource ID. Example:endpoint/my-end-point/variant/KMeansClustering. - Custom resources are not supported with a resource type. This
parameter must specify the
OutputValuefrom the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. - Amazon Comprehend document classification endpoint - The resource
type and unique identifier are specified using the endpoint ARN.
Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - Amazon Comprehend entity recognizer endpoint - The resource type and
unique identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - Lambda provisioned concurrency - The resource type is
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. - Amazon Keyspaces table - The resource type is
tableand the unique identifier is the table name. Example:keyspace/mykeyspace/table/mytable. - Amazon MSK cluster - The resource type and unique identifier are
specified using the cluster ARN. Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - Amazon ElastiCache replication group - The resource type is
replication-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. - Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
$sel:scalableDimension:ScalableTarget', scalableTarget_scalableDimension - The scalable dimension associated with the scalable target. This string
consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount- The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount- The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity- The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity- The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits- The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits- The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits- The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits- The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount- The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property- The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency- The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits- The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits- The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups- The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas- The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount- The count of read replicas in an Amazon Neptune DB cluster.
$sel:minCapacity:ScalableTarget', scalableTarget_minCapacity - The minimum value to scale to in response to a scale-in activity.
$sel:maxCapacity:ScalableTarget', scalableTarget_maxCapacity - The maximum value to scale to in response to a scale-out activity.
$sel:roleARN:ScalableTarget', scalableTarget_roleARN - The ARN of an IAM role that allows Application Auto Scaling to modify
the scalable target on your behalf.
$sel:creationTime:ScalableTarget', scalableTarget_creationTime - The Unix timestamp for when the scalable target was created.
scalableTarget_suspendedState :: Lens' ScalableTarget (Maybe SuspendedState) Source #
Undocumented member.
scalableTarget_serviceNamespace :: Lens' ScalableTarget ServiceNamespace Source #
The namespace of the Amazon Web Services service that provides the
resource, or a custom-resource.
scalableTarget_resourceId :: Lens' ScalableTarget Text Source #
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
- ECS service - The resource type is
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. - Spot Fleet - The resource type is
spot-fleet-requestand the unique identifier is the Spot Fleet request ID. Example:spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - EMR cluster - The resource type is
instancegroupand the unique identifier is the cluster ID and instance group ID. Example:instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - AppStream 2.0 fleet - The resource type is
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. - DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. - DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. - Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. - SageMaker endpoint variant - The resource type is
variantand the unique identifier is the resource ID. Example:endpoint/my-end-point/variant/KMeansClustering. - Custom resources are not supported with a resource type. This
parameter must specify the
OutputValuefrom the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. - Amazon Comprehend document classification endpoint - The resource
type and unique identifier are specified using the endpoint ARN.
Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - Amazon Comprehend entity recognizer endpoint - The resource type and
unique identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - Lambda provisioned concurrency - The resource type is
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. - Amazon Keyspaces table - The resource type is
tableand the unique identifier is the table name. Example:keyspace/mykeyspace/table/mytable. - Amazon MSK cluster - The resource type and unique identifier are
specified using the cluster ARN. Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - Amazon ElastiCache replication group - The resource type is
replication-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. - Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
scalableTarget_scalableDimension :: Lens' ScalableTarget ScalableDimension Source #
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount- The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount- The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity- The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity- The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits- The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits- The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits- The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits- The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount- The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property- The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency- The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits- The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits- The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups- The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas- The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount- The count of read replicas in an Amazon Neptune DB cluster.
scalableTarget_minCapacity :: Lens' ScalableTarget Int Source #
The minimum value to scale to in response to a scale-in activity.
scalableTarget_maxCapacity :: Lens' ScalableTarget Int Source #
The maximum value to scale to in response to a scale-out activity.
scalableTarget_roleARN :: Lens' ScalableTarget Text Source #
The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
scalableTarget_creationTime :: Lens' ScalableTarget UTCTime Source #
The Unix timestamp for when the scalable target was created.
ScalableTargetAction
data ScalableTargetAction Source #
Represents the minimum and maximum capacity for a scheduled action.
See: newScalableTargetAction smart constructor.
Constructors
| ScalableTargetAction' | |
Fields
| |
Instances
newScalableTargetAction :: ScalableTargetAction Source #
Create a value of ScalableTargetAction 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:maxCapacity:ScalableTargetAction', scalableTargetAction_maxCapacity - The maximum capacity.
Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service Endpoints and Quotas in the Amazon Web Services General Reference.
$sel:minCapacity:ScalableTargetAction', scalableTargetAction_minCapacity - The minimum capacity.
For certain resources, the minimum value allowed is 0. This includes Lambda provisioned concurrency, Spot Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For all other resources, the minimum value allowed is 1.
scalableTargetAction_maxCapacity :: Lens' ScalableTargetAction (Maybe Int) Source #
The maximum capacity.
Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service Endpoints and Quotas in the Amazon Web Services General Reference.
scalableTargetAction_minCapacity :: Lens' ScalableTargetAction (Maybe Int) Source #
The minimum capacity.
For certain resources, the minimum value allowed is 0. This includes Lambda provisioned concurrency, Spot Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For all other resources, the minimum value allowed is 1.
ScalingActivity
data ScalingActivity Source #
Represents a scaling activity.
See: newScalingActivity smart constructor.
Constructors
| ScalingActivity' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ServiceNamespace | |
| -> Text | |
| -> ScalableDimension | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> ScalingActivityStatusCode | |
| -> ScalingActivity |
Create a value of ScalingActivity 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:statusMessage:ScalingActivity', scalingActivity_statusMessage - A simple message about the current status of the scaling activity.
$sel:endTime:ScalingActivity', scalingActivity_endTime - The Unix timestamp for when the scaling activity ended.
$sel:details:ScalingActivity', scalingActivity_details - The details about the scaling activity.
$sel:activityId:ScalingActivity', scalingActivity_activityId - The unique identifier of the scaling activity.
$sel:serviceNamespace:ScalingActivity', scalingActivity_serviceNamespace - The namespace of the Amazon Web Services service that provides the
resource, or a custom-resource.
$sel:resourceId:ScalingActivity', scalingActivity_resourceId - The identifier of the resource associated with the scaling activity.
This string consists of the resource type and unique identifier.
- ECS service - The resource type is
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. - Spot Fleet - The resource type is
spot-fleet-requestand the unique identifier is the Spot Fleet request ID. Example:spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - EMR cluster - The resource type is
instancegroupand the unique identifier is the cluster ID and instance group ID. Example:instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - AppStream 2.0 fleet - The resource type is
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. - DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. - DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. - Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. - SageMaker endpoint variant - The resource type is
variantand the unique identifier is the resource ID. Example:endpoint/my-end-point/variant/KMeansClustering. - Custom resources are not supported with a resource type. This
parameter must specify the
OutputValuefrom the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. - Amazon Comprehend document classification endpoint - The resource
type and unique identifier are specified using the endpoint ARN.
Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - Amazon Comprehend entity recognizer endpoint - The resource type and
unique identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - Lambda provisioned concurrency - The resource type is
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. - Amazon Keyspaces table - The resource type is
tableand the unique identifier is the table name. Example:keyspace/mykeyspace/table/mytable. - Amazon MSK cluster - The resource type and unique identifier are
specified using the cluster ARN. Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - Amazon ElastiCache replication group - The resource type is
replication-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. - Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
$sel:scalableDimension:ScalingActivity', scalingActivity_scalableDimension - The scalable dimension. This string consists of the service namespace,
resource type, and scaling property.
ecs:service:DesiredCount- The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount- The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity- The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity- The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits- The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits- The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits- The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits- The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount- The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property- The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency- The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits- The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits- The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups- The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas- The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount- The count of read replicas in an Amazon Neptune DB cluster.
$sel:description:ScalingActivity', scalingActivity_description - A simple description of what action the scaling activity intends to
accomplish.
$sel:cause:ScalingActivity', scalingActivity_cause - A simple description of what caused the scaling activity to happen.
$sel:startTime:ScalingActivity', scalingActivity_startTime - The Unix timestamp for when the scaling activity began.
$sel:statusCode:ScalingActivity', scalingActivity_statusCode - Indicates the status of the scaling activity.
scalingActivity_statusMessage :: Lens' ScalingActivity (Maybe Text) Source #
A simple message about the current status of the scaling activity.
scalingActivity_endTime :: Lens' ScalingActivity (Maybe UTCTime) Source #
The Unix timestamp for when the scaling activity ended.
scalingActivity_details :: Lens' ScalingActivity (Maybe Text) Source #
The details about the scaling activity.
scalingActivity_activityId :: Lens' ScalingActivity Text Source #
The unique identifier of the scaling activity.
scalingActivity_serviceNamespace :: Lens' ScalingActivity ServiceNamespace Source #
The namespace of the Amazon Web Services service that provides the
resource, or a custom-resource.
scalingActivity_resourceId :: Lens' ScalingActivity Text Source #
The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.
- ECS service - The resource type is
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. - Spot Fleet - The resource type is
spot-fleet-requestand the unique identifier is the Spot Fleet request ID. Example:spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - EMR cluster - The resource type is
instancegroupand the unique identifier is the cluster ID and instance group ID. Example:instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - AppStream 2.0 fleet - The resource type is
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. - DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. - DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. - Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. - SageMaker endpoint variant - The resource type is
variantand the unique identifier is the resource ID. Example:endpoint/my-end-point/variant/KMeansClustering. - Custom resources are not supported with a resource type. This
parameter must specify the
OutputValuefrom the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. - Amazon Comprehend document classification endpoint - The resource
type and unique identifier are specified using the endpoint ARN.
Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - Amazon Comprehend entity recognizer endpoint - The resource type and
unique identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - Lambda provisioned concurrency - The resource type is
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. - Amazon Keyspaces table - The resource type is
tableand the unique identifier is the table name. Example:keyspace/mykeyspace/table/mytable. - Amazon MSK cluster - The resource type and unique identifier are
specified using the cluster ARN. Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - Amazon ElastiCache replication group - The resource type is
replication-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. - Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
scalingActivity_scalableDimension :: Lens' ScalingActivity ScalableDimension Source #
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount- The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount- The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity- The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity- The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits- The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits- The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits- The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits- The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount- The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property- The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency- The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits- The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits- The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups- The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas- The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount- The count of read replicas in an Amazon Neptune DB cluster.
scalingActivity_description :: Lens' ScalingActivity Text Source #
A simple description of what action the scaling activity intends to accomplish.
scalingActivity_cause :: Lens' ScalingActivity Text Source #
A simple description of what caused the scaling activity to happen.
scalingActivity_startTime :: Lens' ScalingActivity UTCTime Source #
The Unix timestamp for when the scaling activity began.
scalingActivity_statusCode :: Lens' ScalingActivity ScalingActivityStatusCode Source #
Indicates the status of the scaling activity.
ScalingPolicy
data ScalingPolicy Source #
Represents a scaling policy to use with Application Auto Scaling.
For more information about configuring scaling policies for a specific service, see Getting started with Application Auto Scaling in the Application Auto Scaling User Guide.
See: newScalingPolicy smart constructor.
Constructors
| ScalingPolicy' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ServiceNamespace | |
| -> Text | |
| -> ScalableDimension | |
| -> PolicyType | |
| -> UTCTime | |
| -> ScalingPolicy |
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:targetTrackingScalingPolicyConfiguration:ScalingPolicy', scalingPolicy_targetTrackingScalingPolicyConfiguration - A target tracking scaling policy.
$sel:stepScalingPolicyConfiguration:ScalingPolicy', scalingPolicy_stepScalingPolicyConfiguration - A step scaling policy.
$sel:alarms:ScalingPolicy', scalingPolicy_alarms - The CloudWatch alarms associated with the scaling policy.
$sel:policyARN:ScalingPolicy', scalingPolicy_policyARN - The Amazon Resource Name (ARN) of the scaling policy.
$sel:policyName:ScalingPolicy', scalingPolicy_policyName - The name of the scaling policy.
$sel:serviceNamespace:ScalingPolicy', scalingPolicy_serviceNamespace - The namespace of the Amazon Web Services service that provides the
resource, or a custom-resource.
$sel:resourceId:ScalingPolicy', scalingPolicy_resourceId - The identifier of the resource associated with the scaling policy. This
string consists of the resource type and unique identifier.
- ECS service - The resource type is
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. - Spot Fleet - The resource type is
spot-fleet-requestand the unique identifier is the Spot Fleet request ID. Example:spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - EMR cluster - The resource type is
instancegroupand the unique identifier is the cluster ID and instance group ID. Example:instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - AppStream 2.0 fleet - The resource type is
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. - DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. - DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. - Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. - SageMaker endpoint variant - The resource type is
variantand the unique identifier is the resource ID. Example:endpoint/my-end-point/variant/KMeansClustering. - Custom resources are not supported with a resource type. This
parameter must specify the
OutputValuefrom the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. - Amazon Comprehend document classification endpoint - The resource
type and unique identifier are specified using the endpoint ARN.
Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - Amazon Comprehend entity recognizer endpoint - The resource type and
unique identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - Lambda provisioned concurrency - The resource type is
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. - Amazon Keyspaces table - The resource type is
tableand the unique identifier is the table name. Example:keyspace/mykeyspace/table/mytable. - Amazon MSK cluster - The resource type and unique identifier are
specified using the cluster ARN. Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - Amazon ElastiCache replication group - The resource type is
replication-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. - Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
$sel:scalableDimension:ScalingPolicy', scalingPolicy_scalableDimension - The scalable dimension. This string consists of the service namespace,
resource type, and scaling property.
ecs:service:DesiredCount- The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount- The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity- The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity- The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits- The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits- The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits- The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits- The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount- The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property- The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency- The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits- The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits- The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups- The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas- The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount- The count of read replicas in an Amazon Neptune DB cluster.
$sel:policyType:ScalingPolicy', scalingPolicy_policyType - The scaling policy type.
$sel:creationTime:ScalingPolicy', scalingPolicy_creationTime - The Unix timestamp for when the scaling policy was created.
scalingPolicy_targetTrackingScalingPolicyConfiguration :: Lens' ScalingPolicy (Maybe TargetTrackingScalingPolicyConfiguration) Source #
A target tracking scaling policy.
scalingPolicy_stepScalingPolicyConfiguration :: Lens' ScalingPolicy (Maybe StepScalingPolicyConfiguration) Source #
A step scaling policy.
scalingPolicy_alarms :: Lens' ScalingPolicy (Maybe [Alarm]) Source #
The CloudWatch alarms associated with the scaling policy.
scalingPolicy_policyARN :: Lens' ScalingPolicy Text Source #
The Amazon Resource Name (ARN) of the scaling policy.
scalingPolicy_policyName :: Lens' ScalingPolicy Text Source #
The name of the scaling policy.
scalingPolicy_serviceNamespace :: Lens' ScalingPolicy ServiceNamespace Source #
The namespace of the Amazon Web Services service that provides the
resource, or a custom-resource.
scalingPolicy_resourceId :: Lens' ScalingPolicy Text Source #
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
- ECS service - The resource type is
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. - Spot Fleet - The resource type is
spot-fleet-requestand the unique identifier is the Spot Fleet request ID. Example:spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - EMR cluster - The resource type is
instancegroupand the unique identifier is the cluster ID and instance group ID. Example:instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - AppStream 2.0 fleet - The resource type is
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. - DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. - DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. - Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. - SageMaker endpoint variant - The resource type is
variantand the unique identifier is the resource ID. Example:endpoint/my-end-point/variant/KMeansClustering. - Custom resources are not supported with a resource type. This
parameter must specify the
OutputValuefrom the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. - Amazon Comprehend document classification endpoint - The resource
type and unique identifier are specified using the endpoint ARN.
Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - Amazon Comprehend entity recognizer endpoint - The resource type and
unique identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - Lambda provisioned concurrency - The resource type is
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. - Amazon Keyspaces table - The resource type is
tableand the unique identifier is the table name. Example:keyspace/mykeyspace/table/mytable. - Amazon MSK cluster - The resource type and unique identifier are
specified using the cluster ARN. Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - Amazon ElastiCache replication group - The resource type is
replication-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. - Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
scalingPolicy_scalableDimension :: Lens' ScalingPolicy ScalableDimension Source #
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount- The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount- The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity- The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity- The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits- The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits- The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits- The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits- The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount- The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property- The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency- The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits- The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits- The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups- The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas- The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount- The count of read replicas in an Amazon Neptune DB cluster.
scalingPolicy_policyType :: Lens' ScalingPolicy PolicyType Source #
The scaling policy type.
scalingPolicy_creationTime :: Lens' ScalingPolicy UTCTime Source #
The Unix timestamp for when the scaling policy was created.
ScheduledAction
data ScheduledAction Source #
Represents a scheduled action.
See: newScheduledAction smart constructor.
Constructors
| ScheduledAction' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ServiceNamespace | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> ScheduledAction |
Create a value of ScheduledAction 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:scalableDimension:ScheduledAction', scheduledAction_scalableDimension - The scalable dimension. This string consists of the service namespace,
resource type, and scaling property.
ecs:service:DesiredCount- The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount- The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity- The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity- The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits- The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits- The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits- The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits- The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount- The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property- The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency- The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits- The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits- The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups- The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas- The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount- The count of read replicas in an Amazon Neptune DB cluster.
$sel:startTime:ScheduledAction', scheduledAction_startTime - The date and time that the action is scheduled to begin, in UTC.
$sel:endTime:ScheduledAction', scheduledAction_endTime - The date and time that the action is scheduled to end, in UTC.
$sel:scalableTargetAction:ScheduledAction', scheduledAction_scalableTargetAction - The new minimum and maximum capacity. You can set both values or just
one. At the scheduled time, if the current capacity is below the minimum
capacity, Application Auto Scaling scales out to the minimum capacity.
If the current capacity is above the maximum capacity, Application Auto
Scaling scales in to the maximum capacity.
$sel:timezone:ScheduledAction', scheduledAction_timezone - The time zone used when referring to the date and time of a scheduled
action, when the scheduled action uses an at or cron expression.
$sel:scheduledActionName:ScheduledAction', scheduledAction_scheduledActionName - The name of the scheduled action.
$sel:scheduledActionARN:ScheduledAction', scheduledAction_scheduledActionARN - The Amazon Resource Name (ARN) of the scheduled action.
$sel:serviceNamespace:ScheduledAction', scheduledAction_serviceNamespace - The namespace of the Amazon Web Services service that provides the
resource, or a custom-resource.
$sel:schedule:ScheduledAction', scheduledAction_schedule - The schedule for this action. The following formats are supported:
- At expressions - "
at(yyyy-mm-ddThh:mm:ss)" - Rate expressions - "
rate(value unit)" - Cron expressions - "
cron(fields)"
At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.
At and cron expressions use Universal Coordinated Time (UTC) by default.
The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
For rate expressions, value is a positive integer and unit is
minute | minutes | hour | hours | day | days.
For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide.
$sel:resourceId:ScheduledAction', scheduledAction_resourceId - The identifier of the resource associated with the scaling policy. This
string consists of the resource type and unique identifier.
- ECS service - The resource type is
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. - Spot Fleet - The resource type is
spot-fleet-requestand the unique identifier is the Spot Fleet request ID. Example:spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - EMR cluster - The resource type is
instancegroupand the unique identifier is the cluster ID and instance group ID. Example:instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - AppStream 2.0 fleet - The resource type is
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. - DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. - DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. - Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. - SageMaker endpoint variant - The resource type is
variantand the unique identifier is the resource ID. Example:endpoint/my-end-point/variant/KMeansClustering. - Custom resources are not supported with a resource type. This
parameter must specify the
OutputValuefrom the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. - Amazon Comprehend document classification endpoint - The resource
type and unique identifier are specified using the endpoint ARN.
Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - Amazon Comprehend entity recognizer endpoint - The resource type and
unique identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - Lambda provisioned concurrency - The resource type is
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. - Amazon Keyspaces table - The resource type is
tableand the unique identifier is the table name. Example:keyspace/mykeyspace/table/mytable. - Amazon MSK cluster - The resource type and unique identifier are
specified using the cluster ARN. Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - Amazon ElastiCache replication group - The resource type is
replication-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. - Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
$sel:creationTime:ScheduledAction', scheduledAction_creationTime - The date and time that the scheduled action was created.
scheduledAction_scalableDimension :: Lens' ScheduledAction (Maybe ScalableDimension) Source #
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount- The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount- The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity- The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity- The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits- The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits- The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits- The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits- The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount- The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property- The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency- The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits- The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits- The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups- The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas- The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount- The count of read replicas in an Amazon Neptune DB cluster.
scheduledAction_startTime :: Lens' ScheduledAction (Maybe UTCTime) Source #
The date and time that the action is scheduled to begin, in UTC.
scheduledAction_endTime :: Lens' ScheduledAction (Maybe UTCTime) Source #
The date and time that the action is scheduled to end, in UTC.
scheduledAction_scalableTargetAction :: Lens' ScheduledAction (Maybe ScalableTargetAction) Source #
The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
scheduledAction_timezone :: Lens' ScheduledAction (Maybe Text) Source #
The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.
scheduledAction_scheduledActionName :: Lens' ScheduledAction Text Source #
The name of the scheduled action.
scheduledAction_scheduledActionARN :: Lens' ScheduledAction Text Source #
The Amazon Resource Name (ARN) of the scheduled action.
scheduledAction_serviceNamespace :: Lens' ScheduledAction ServiceNamespace Source #
The namespace of the Amazon Web Services service that provides the
resource, or a custom-resource.
scheduledAction_schedule :: Lens' ScheduledAction Text Source #
The schedule for this action. The following formats are supported:
- At expressions - "
at(yyyy-mm-ddThh:mm:ss)" - Rate expressions - "
rate(value unit)" - Cron expressions - "
cron(fields)"
At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.
At and cron expressions use Universal Coordinated Time (UTC) by default.
The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
For rate expressions, value is a positive integer and unit is
minute | minutes | hour | hours | day | days.
For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide.
scheduledAction_resourceId :: Lens' ScheduledAction Text Source #
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
- ECS service - The resource type is
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. - Spot Fleet - The resource type is
spot-fleet-requestand the unique identifier is the Spot Fleet request ID. Example:spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. - EMR cluster - The resource type is
instancegroupand the unique identifier is the cluster ID and instance group ID. Example:instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. - AppStream 2.0 fleet - The resource type is
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. - DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. - DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. - Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. - SageMaker endpoint variant - The resource type is
variantand the unique identifier is the resource ID. Example:endpoint/my-end-point/variant/KMeansClustering. - Custom resources are not supported with a resource type. This
parameter must specify the
OutputValuefrom the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. - Amazon Comprehend document classification endpoint - The resource
type and unique identifier are specified using the endpoint ARN.
Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. - Amazon Comprehend entity recognizer endpoint - The resource type and
unique identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. - Lambda provisioned concurrency - The resource type is
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. - Amazon Keyspaces table - The resource type is
tableand the unique identifier is the table name. Example:keyspace/mykeyspace/table/mytable. - Amazon MSK cluster - The resource type and unique identifier are
specified using the cluster ARN. Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. - Amazon ElastiCache replication group - The resource type is
replication-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. - Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
scheduledAction_creationTime :: Lens' ScheduledAction UTCTime Source #
The date and time that the scheduled action was created.
StepAdjustment
data StepAdjustment Source #
Represents a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.
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.
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. For exact capacity, you must specify
a positive value.
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. For exact capacity, you must specify a positive value.
StepScalingPolicyConfiguration
data StepScalingPolicyConfiguration Source #
Represents a step scaling policy configuration to use with Application Auto Scaling.
See: newStepScalingPolicyConfiguration smart constructor.
Constructors
| StepScalingPolicyConfiguration' | |
Fields
| |
Instances
newStepScalingPolicyConfiguration :: StepScalingPolicyConfiguration Source #
Create a value of StepScalingPolicyConfiguration 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:stepAdjustments:StepScalingPolicyConfiguration', stepScalingPolicyConfiguration_stepAdjustments - A set of adjustments that enable you to scale based on the size of the
alarm breach.
At least one step adjustment is required if you are adding a new step scaling policy configuration.
$sel:adjustmentType:StepScalingPolicyConfiguration', stepScalingPolicyConfiguration_adjustmentType - Specifies how the ScalingAdjustment value in a
StepAdjustment
is interpreted (for example, an absolute number or a percentage). The
valid values are ChangeInCapacity, ExactCapacity, and
PercentChangeInCapacity.
AdjustmentType is required if you are adding a new step scaling policy
configuration.
$sel:cooldown:StepScalingPolicyConfiguration', stepScalingPolicyConfiguration_cooldown - The amount of time, in seconds, to wait for a previous scaling activity
to take effect.
With scale-out policies, the intention is to continuously (but not excessively) scale out. After Application Auto Scaling successfully scales out using a step scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends. While the cooldown period is in effect, capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity. For example, when an alarm triggers a step scaling policy to increase the capacity by 2, the scaling activity completes successfully, and a cooldown period starts. If the alarm triggers again during the cooldown period but at a more aggressive step adjustment of 3, the previous increase of 2 is considered part of the current capacity. Therefore, only 1 is added to the capacity.
With scale-in policies, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the cooldown period after a scale-in activity, Application Auto Scaling scales out the target immediately. In this case, the cooldown period for the scale-in activity stops and doesn't complete.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
- AppStream 2.0 fleets
- Aurora DB clusters
- ECS services
- EMR clusters
- Neptune clusters
- SageMaker endpoint variants
- Spot Fleets
- Custom resources
For all other scalable targets, the default value is 0:
- Amazon Comprehend document classification and entity recognizer endpoints
- DynamoDB tables and global secondary indexes
- Amazon Keyspaces tables
- Lambda provisioned concurrency
- Amazon MSK broker storage
$sel:metricAggregationType:StepScalingPolicyConfiguration', stepScalingPolicyConfiguration_metricAggregationType - The aggregation type for the CloudWatch metrics. Valid values are
Minimum, Maximum, and Average. If the aggregation type is null,
the value is treated as Average.
$sel:minAdjustmentMagnitude:StepScalingPolicyConfiguration', stepScalingPolicyConfiguration_minAdjustmentMagnitude - The minimum value to scale by when the adjustment type is
PercentChangeInCapacity. For example, suppose that you create a step
scaling policy to scale out an Amazon ECS service by 25 percent and you
specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and
the scaling policy is performed, 25 percent of 4 is 1. However, because
you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling
scales out the service by 2 tasks.
stepScalingPolicyConfiguration_stepAdjustments :: Lens' StepScalingPolicyConfiguration (Maybe [StepAdjustment]) Source #
A set of adjustments that enable you to scale based on the size of the alarm breach.
At least one step adjustment is required if you are adding a new step scaling policy configuration.
stepScalingPolicyConfiguration_adjustmentType :: Lens' StepScalingPolicyConfiguration (Maybe AdjustmentType) Source #
Specifies how the ScalingAdjustment value in a
StepAdjustment
is interpreted (for example, an absolute number or a percentage). The
valid values are ChangeInCapacity, ExactCapacity, and
PercentChangeInCapacity.
AdjustmentType is required if you are adding a new step scaling policy
configuration.
stepScalingPolicyConfiguration_cooldown :: Lens' StepScalingPolicyConfiguration (Maybe Int) Source #
The amount of time, in seconds, to wait for a previous scaling activity to take effect.
With scale-out policies, the intention is to continuously (but not excessively) scale out. After Application Auto Scaling successfully scales out using a step scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends. While the cooldown period is in effect, capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity. For example, when an alarm triggers a step scaling policy to increase the capacity by 2, the scaling activity completes successfully, and a cooldown period starts. If the alarm triggers again during the cooldown period but at a more aggressive step adjustment of 3, the previous increase of 2 is considered part of the current capacity. Therefore, only 1 is added to the capacity.
With scale-in policies, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the cooldown period after a scale-in activity, Application Auto Scaling scales out the target immediately. In this case, the cooldown period for the scale-in activity stops and doesn't complete.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
- AppStream 2.0 fleets
- Aurora DB clusters
- ECS services
- EMR clusters
- Neptune clusters
- SageMaker endpoint variants
- Spot Fleets
- Custom resources
For all other scalable targets, the default value is 0:
- Amazon Comprehend document classification and entity recognizer endpoints
- DynamoDB tables and global secondary indexes
- Amazon Keyspaces tables
- Lambda provisioned concurrency
- Amazon MSK broker storage
stepScalingPolicyConfiguration_metricAggregationType :: Lens' StepScalingPolicyConfiguration (Maybe MetricAggregationType) Source #
The aggregation type for the CloudWatch metrics. Valid values are
Minimum, Maximum, and Average. If the aggregation type is null,
the value is treated as Average.
stepScalingPolicyConfiguration_minAdjustmentMagnitude :: Lens' StepScalingPolicyConfiguration (Maybe Int) Source #
The minimum value to scale by when the adjustment type is
PercentChangeInCapacity. For example, suppose that you create a step
scaling policy to scale out an Amazon ECS service by 25 percent and you
specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and
the scaling policy is performed, 25 percent of 4 is 1. However, because
you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling
scales out the service by 2 tasks.
SuspendedState
data SuspendedState Source #
Specifies whether the scaling activities for a scalable target are in a suspended state.
See: newSuspendedState smart constructor.
Constructors
| SuspendedState' | |
Fields
| |
Instances
newSuspendedState :: SuspendedState Source #
Create a value of SuspendedState 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:dynamicScalingInSuspended:SuspendedState', suspendedState_dynamicScalingInSuspended - Whether scale in by a target tracking scaling policy or a step scaling
policy is suspended. Set the value to true if you don't want
Application Auto Scaling to remove capacity when a scaling policy is
triggered. The default is false.
$sel:scheduledScalingSuspended:SuspendedState', suspendedState_scheduledScalingSuspended - Whether scheduled scaling is suspended. Set the value to true if you
don't want Application Auto Scaling to add or remove capacity by
initiating scheduled actions. The default is false.
$sel:dynamicScalingOutSuspended:SuspendedState', suspendedState_dynamicScalingOutSuspended - Whether scale out by a target tracking scaling policy or a step scaling
policy is suspended. Set the value to true if you don't want
Application Auto Scaling to add capacity when a scaling policy is
triggered. The default is false.
suspendedState_dynamicScalingInSuspended :: Lens' SuspendedState (Maybe Bool) Source #
Whether scale in by a target tracking scaling policy or a step scaling
policy is suspended. Set the value to true if you don't want
Application Auto Scaling to remove capacity when a scaling policy is
triggered. The default is false.
suspendedState_scheduledScalingSuspended :: Lens' SuspendedState (Maybe Bool) Source #
Whether scheduled scaling is suspended. Set the value to true if you
don't want Application Auto Scaling to add or remove capacity by
initiating scheduled actions. The default is false.
suspendedState_dynamicScalingOutSuspended :: Lens' SuspendedState (Maybe Bool) Source #
Whether scale out by a target tracking scaling policy or a step scaling
policy is suspended. Set the value to true if you don't want
Application Auto Scaling to add capacity when a scaling policy is
triggered. The default is false.
TargetTrackingScalingPolicyConfiguration
data TargetTrackingScalingPolicyConfiguration Source #
Represents a target tracking scaling policy configuration to use with Application Auto Scaling.
See: newTargetTrackingScalingPolicyConfiguration smart constructor.
Constructors
| TargetTrackingScalingPolicyConfiguration' | |
Fields
| |
Instances
newTargetTrackingScalingPolicyConfiguration Source #
Arguments
| :: Double | |
| -> TargetTrackingScalingPolicyConfiguration |
Create a value of TargetTrackingScalingPolicyConfiguration 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:TargetTrackingScalingPolicyConfiguration', targetTrackingScalingPolicyConfiguration_predefinedMetricSpecification - A predefined metric. You can specify either a predefined metric or a
customized metric.
$sel:scaleInCooldown:TargetTrackingScalingPolicyConfiguration', targetTrackingScalingPolicyConfiguration_scaleInCooldown - The amount of time, in seconds, after a scale-in activity completes
before another scale-in activity can start.
With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Application Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
- AppStream 2.0 fleets
- Aurora DB clusters
- ECS services
- EMR clusters
- Neptune clusters
- SageMaker endpoint variants
- Spot Fleets
- Custom resources
For all other scalable targets, the default value is 0:
- Amazon Comprehend document classification and entity recognizer endpoints
- DynamoDB tables and global secondary indexes
- Amazon Keyspaces tables
- Lambda provisioned concurrency
- Amazon MSK broker storage
$sel:customizedMetricSpecification:TargetTrackingScalingPolicyConfiguration', targetTrackingScalingPolicyConfiguration_customizedMetricSpecification - A customized metric. You can specify either a predefined metric or a
customized metric.
$sel:disableScaleIn:TargetTrackingScalingPolicyConfiguration', targetTrackingScalingPolicyConfiguration_disableScaleIn - Indicates whether scale in by the target tracking scaling policy is
disabled. If the value is true, scale in is disabled and the target
tracking scaling policy won't remove capacity from the scalable target.
Otherwise, scale in is enabled and the target tracking scaling policy
can remove capacity from the scalable target. The default value is
false.
$sel:scaleOutCooldown:TargetTrackingScalingPolicyConfiguration', targetTrackingScalingPolicyConfiguration_scaleOutCooldown - The amount of time, in seconds, to wait for a previous scale-out
activity to take effect.
With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Application Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends. While the cooldown period is in effect, the capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
- AppStream 2.0 fleets
- Aurora DB clusters
- ECS services
- EMR clusters
- Neptune clusters
- SageMaker endpoint variants
- Spot Fleets
- Custom resources
For all other scalable targets, the default value is 0:
- Amazon Comprehend document classification and entity recognizer endpoints
- DynamoDB tables and global secondary indexes
- Amazon Keyspaces tables
- Lambda provisioned concurrency
- Amazon MSK broker storage
$sel:targetValue:TargetTrackingScalingPolicyConfiguration', targetTrackingScalingPolicyConfiguration_targetValue - The target value for the metric. Although this property accepts numbers
of type Double, it won't accept values that are either too small or too
large. Values must be in the range of -2^360 to 2^360. The value must be
a valid number based on the choice of metric. For example, if the metric
is CPU utilization, then the target value is a percent value that
represents how much of the CPU can be used before scaling out.
targetTrackingScalingPolicyConfiguration_predefinedMetricSpecification :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe PredefinedMetricSpecification) Source #
A predefined metric. You can specify either a predefined metric or a customized metric.
targetTrackingScalingPolicyConfiguration_scaleInCooldown :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Int) Source #
The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Application Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
- AppStream 2.0 fleets
- Aurora DB clusters
- ECS services
- EMR clusters
- Neptune clusters
- SageMaker endpoint variants
- Spot Fleets
- Custom resources
For all other scalable targets, the default value is 0:
- Amazon Comprehend document classification and entity recognizer endpoints
- DynamoDB tables and global secondary indexes
- Amazon Keyspaces tables
- Lambda provisioned concurrency
- Amazon MSK broker storage
targetTrackingScalingPolicyConfiguration_customizedMetricSpecification :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe CustomizedMetricSpecification) Source #
A customized metric. You can specify either a predefined metric or a customized metric.
targetTrackingScalingPolicyConfiguration_disableScaleIn :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Bool) Source #
Indicates whether scale in by the target tracking scaling policy is
disabled. If the value is true, scale in is disabled and the target
tracking scaling policy won't remove capacity from the scalable target.
Otherwise, scale in is enabled and the target tracking scaling policy
can remove capacity from the scalable target. The default value is
false.
targetTrackingScalingPolicyConfiguration_scaleOutCooldown :: Lens' TargetTrackingScalingPolicyConfiguration (Maybe Int) Source #
The amount of time, in seconds, to wait for a previous scale-out activity to take effect.
With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Application Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends. While the cooldown period is in effect, the capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
- AppStream 2.0 fleets
- Aurora DB clusters
- ECS services
- EMR clusters
- Neptune clusters
- SageMaker endpoint variants
- Spot Fleets
- Custom resources
For all other scalable targets, the default value is 0:
- Amazon Comprehend document classification and entity recognizer endpoints
- DynamoDB tables and global secondary indexes
- Amazon Keyspaces tables
- Lambda provisioned concurrency
- Amazon MSK broker storage
targetTrackingScalingPolicyConfiguration_targetValue :: Lens' TargetTrackingScalingPolicyConfiguration Double Source #
The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.