ApplicationAutoScaling class

With Application Auto Scaling, you can configure automatic scaling for the following resources:

  • Amazon ECS services
  • Amazon EC2 Spot Fleet requests
  • Amazon EMR clusters
  • Amazon AppStream 2.0 fleets
  • Amazon DynamoDB tables and global secondary indexes throughput capacity
  • Amazon Aurora Replicas
  • Amazon SageMaker endpoint variants
  • Custom resources provided by your own applications or services
  • Amazon Comprehend document classification and entity recognizer endpoints
  • AWS Lambda function provisioned concurrency
  • Amazon Keyspaces (for Apache Cassandra) tables
  • Amazon Managed Streaming for Apache Kafka cluster storage
API Summary

The Application Auto Scaling service API includes three key sets of actions:

  • Register and manage scalable targets - Register AWS or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.
  • Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.
  • Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by calling the RegisterScalableTarget API action for any Application Auto Scaling scalable target. You can suspend and resume (individually or in combination) scale-out activities that are triggered by a scaling policy, scale-in activities that are triggered by a scaling policy, and scheduled scaling.
To learn more about Application Auto Scaling, including information about granting IAM users required permissions for Application Auto Scaling actions, see the Application Auto Scaling User Guide.

Constructors

ApplicationAutoScaling({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
deleteScalingPolicy({required String policyName, required String resourceId, required ScalableDimension scalableDimension, required ServiceNamespace serviceNamespace}) → Future<void>
Deletes the specified scaling policy for an Application Auto Scaling scalable target.
deleteScheduledAction({required String resourceId, required ScalableDimension scalableDimension, required String scheduledActionName, required ServiceNamespace serviceNamespace}) → Future<void>
Deletes the specified scheduled action for an Application Auto Scaling scalable target.
deregisterScalableTarget({required String resourceId, required ScalableDimension scalableDimension, required ServiceNamespace serviceNamespace}) → Future<void>
Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use DescribeScalableTargets.
describeScalableTargets({required ServiceNamespace serviceNamespace, int? maxResults, String? nextToken, List<String>? resourceIds, ScalableDimension? scalableDimension}) → Future<DescribeScalableTargetsResponse>
Gets information about the scalable targets in the specified namespace.
describeScalingActivities({required ServiceNamespace serviceNamespace, int? maxResults, String? nextToken, String? resourceId, ScalableDimension? scalableDimension}) → Future<DescribeScalingActivitiesResponse>
Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
describeScalingPolicies({required ServiceNamespace serviceNamespace, int? maxResults, String? nextToken, List<String>? policyNames, String? resourceId, ScalableDimension? scalableDimension}) → Future<DescribeScalingPoliciesResponse>
Describes the Application Auto Scaling scaling policies for the specified service namespace.
describeScheduledActions({required ServiceNamespace serviceNamespace, int? maxResults, String? nextToken, String? resourceId, ScalableDimension? scalableDimension, List<String>? scheduledActionNames}) → Future<DescribeScheduledActionsResponse>
Describes the Application Auto Scaling scheduled actions for the specified service namespace.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putScalingPolicy({required String policyName, required String resourceId, required ScalableDimension scalableDimension, required ServiceNamespace serviceNamespace, PolicyType? policyType, StepScalingPolicyConfiguration? stepScalingPolicyConfiguration, TargetTrackingScalingPolicyConfiguration? targetTrackingScalingPolicyConfiguration}) → Future<PutScalingPolicyResponse>
Creates or updates a scaling policy for an Application Auto Scaling scalable target.
putScheduledAction({required String resourceId, required ScalableDimension scalableDimension, required String scheduledActionName, required ServiceNamespace serviceNamespace, DateTime? endTime, ScalableTargetAction? scalableTargetAction, String? schedule, DateTime? startTime}) → Future<void>
Creates or updates a scheduled action for an Application Auto Scaling scalable target.
registerScalableTarget({required String resourceId, required ScalableDimension scalableDimension, required ServiceNamespace serviceNamespace, int? maxCapacity, int? minCapacity, String? roleARN, SuspendedState? suspendedState}) → Future<void>
Registers or updates a scalable target.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited