AutoScaling class

The DescribeAutoScalingGroups API operation might be throttled when retrieving details for an Auto Scaling group that contains many instances. By default, this operation returns details for all instances in the group. To help prevent throttling, you can set the IncludeInstances parameter to false to exclude instance details from the response.

Constructors

AutoScaling({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

attachInstances({required String autoScalingGroupName, List<String>? instanceIds}) → Future<void>
Attaches one or more EC2 instances to the specified Auto Scaling group.
attachLoadBalancers({required String autoScalingGroupName, required List<String> loadBalancerNames}) → Future<void>
To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling group, call the DetachLoadBalancers API.
attachLoadBalancerTargetGroups({required String autoScalingGroupName, required List<String> targetGroupARNs}) → Future<void>
This operation is used with the following load balancer types:
attachTrafficSources({required String autoScalingGroupName, required List<TrafficSourceIdentifier> trafficSources, bool? skipZonalShiftValidation}) → Future<void>
Attaches one or more traffic sources to the specified Auto Scaling group.
batchDeleteScheduledAction({required String autoScalingGroupName, required List<String> scheduledActionNames}) → Future<BatchDeleteScheduledActionAnswer>
Deletes one or more scheduled actions for the specified Auto Scaling group.
batchPutScheduledUpdateGroupAction({required String autoScalingGroupName, required List<ScheduledUpdateGroupActionRequest> scheduledUpdateGroupActions}) → Future<BatchPutScheduledUpdateGroupActionAnswer>
Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
cancelInstanceRefresh({required String autoScalingGroupName, bool? waitForTransitioningInstances}) → Future<CancelInstanceRefreshAnswer>
Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an ActiveInstanceRefreshNotFound error occurs.
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.
completeLifecycleAction({required String autoScalingGroupName, required String lifecycleActionResult, required String lifecycleHookName, String? instanceId, String? lifecycleActionToken}) → Future<void>
Completes the lifecycle action for the specified token or instance with the specified result.
createAutoScalingGroup({required String autoScalingGroupName, required int maxSize, required int minSize, AvailabilityZoneDistribution? availabilityZoneDistribution, List<String>? availabilityZoneIds, AvailabilityZoneImpairmentPolicy? availabilityZoneImpairmentPolicy, List<String>? availabilityZones, bool? capacityRebalance, CapacityReservationSpecification? capacityReservationSpecification, String? context, int? defaultCooldown, int? defaultInstanceWarmup, DeletionProtection? deletionProtection, int? desiredCapacity, String? desiredCapacityType, int? healthCheckGracePeriod, String? healthCheckType, String? instanceId, InstanceLifecyclePolicy? instanceLifecyclePolicy, InstanceMaintenancePolicy? instanceMaintenancePolicy, String? launchConfigurationName, LaunchTemplateSpecification? launchTemplate, List<LifecycleHookSpecification>? lifecycleHookSpecificationList, List<String>? loadBalancerNames, int? maxInstanceLifetime, MixedInstancesPolicy? mixedInstancesPolicy, bool? newInstancesProtectedFromScaleIn, String? placementGroup, String? serviceLinkedRoleARN, bool? skipZonalShiftValidation, List<Tag>? tags, List<String>? targetGroupARNs, List<String>? terminationPolicies, List<TrafficSourceIdentifier>? trafficSources, String? vPCZoneIdentifier}) → Future<void>
We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
createLaunchConfiguration({required String launchConfigurationName, bool? associatePublicIpAddress, List<BlockDeviceMapping>? blockDeviceMappings, String? classicLinkVPCId, List<String>? classicLinkVPCSecurityGroups, bool? ebsOptimized, String? iamInstanceProfile, String? imageId, String? instanceId, InstanceMonitoring? instanceMonitoring, String? instanceType, String? kernelId, String? keyName, InstanceMetadataOptions? metadataOptions, String? placementTenancy, String? ramdiskId, List<String>? securityGroups, String? spotPrice, String? userData}) → Future<void>
Creates a launch configuration.
createOrUpdateTags({required List<Tag> tags}) → Future<void>
Creates or updates tags for the specified Auto Scaling group.
deleteAutoScalingGroup({required String autoScalingGroupName, bool? forceDelete}) → Future<void>
Deletes the specified Auto Scaling group.
deleteLaunchConfiguration({required String launchConfigurationName}) → Future<void>
Deletes the specified launch configuration.
deleteLifecycleHook({required String autoScalingGroupName, required String lifecycleHookName}) → Future<void>
Deletes the specified lifecycle hook.
deleteNotificationConfiguration({required String autoScalingGroupName, required String topicARN}) → Future<void>
Deletes the specified notification.
deletePolicy({required String policyName, String? autoScalingGroupName}) → Future<void>
Deletes the specified scaling policy.
deleteScheduledAction({required String autoScalingGroupName, required String scheduledActionName}) → Future<void>
Deletes the specified scheduled action.
deleteTags({required List<Tag> tags}) → Future<void>
Deletes the specified tags.
deleteWarmPool({required String autoScalingGroupName, bool? forceDelete}) → Future<void>
Deletes the warm pool for the specified Auto Scaling group.
describeAccountLimits() → Future<DescribeAccountLimitsAnswer>
Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
describeAdjustmentTypes() → Future<DescribeAdjustmentTypesAnswer>
Describes the available adjustment types for step scaling and simple scaling policies.
describeAutoScalingGroups({List<String>? autoScalingGroupNames, List<Filter>? filters, bool? includeInstances, int? maxRecords, String? nextToken}) → Future<AutoScalingGroupsType>
Gets information about the Auto Scaling groups in the account and Region.
describeAutoScalingInstances({List<String>? instanceIds, int? maxRecords, String? nextToken}) → Future<AutoScalingInstancesType>
Gets information about the Auto Scaling instances in the account and Region.
describeAutoScalingNotificationTypes() → Future<DescribeAutoScalingNotificationTypesAnswer>
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
describeInstanceRefreshes({required String autoScalingGroupName, List<String>? instanceRefreshIds, int? maxRecords, String? nextToken}) → Future<DescribeInstanceRefreshesAnswer>
Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks.
describeLaunchConfigurations({List<String>? launchConfigurationNames, int? maxRecords, String? nextToken}) → Future<LaunchConfigurationsType>
Gets information about the launch configurations in the account and Region.
describeLifecycleHooks({required String autoScalingGroupName, List<String>? lifecycleHookNames}) → Future<DescribeLifecycleHooksAnswer>
Gets information about the lifecycle hooks for the specified Auto Scaling group.
describeLifecycleHookTypes() → Future<DescribeLifecycleHookTypesAnswer>
Describes the available types of lifecycle hooks.
describeLoadBalancers({required String autoScalingGroupName, int? maxRecords, String? nextToken}) → Future<DescribeLoadBalancersResponse>
This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DescribeLoadBalancerTargetGroups API instead.
describeLoadBalancerTargetGroups({required String autoScalingGroupName, int? maxRecords, String? nextToken}) → Future<DescribeLoadBalancerTargetGroupsResponse>
To determine the attachment status of the target group, use the State element in the response. When you attach a target group to an Auto Scaling group, the initial State value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the target group doesn't enter the InService state.
describeMetricCollectionTypes() → Future<DescribeMetricCollectionTypesAnswer>
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
describeNotificationConfigurations({List<String>? autoScalingGroupNames, int? maxRecords, String? nextToken}) → Future<DescribeNotificationConfigurationsAnswer>
Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
describePolicies({String? autoScalingGroupName, int? maxRecords, String? nextToken, List<String>? policyNames, List<String>? policyTypes}) → Future<PoliciesType>
Gets information about the scaling policies in the account and Region.
describeScalingActivities({List<String>? activityIds, String? autoScalingGroupName, List<Filter>? filters, bool? includeDeletedGroups, int? maxRecords, String? nextToken}) → Future<ActivitiesType>
Gets information about the scaling activities in the account and Region.
describeScalingProcessTypes() → Future<ProcessesType>
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
describeScheduledActions({String? autoScalingGroupName, DateTime? endTime, int? maxRecords, String? nextToken, List<String>? scheduledActionNames, DateTime? startTime}) → Future<ScheduledActionsType>
Gets information about the scheduled actions that haven't run or that have not reached their end time.
describeTags({List<Filter>? filters, int? maxRecords, String? nextToken}) → Future<TagsType>
Describes the specified tags.
describeTerminationPolicyTypes() → Future<DescribeTerminationPolicyTypesAnswer>
Describes the termination policies supported by Amazon EC2 Auto Scaling.
describeTrafficSources({required String autoScalingGroupName, int? maxRecords, String? nextToken, String? trafficSourceType}) → Future<DescribeTrafficSourcesResponse>
Gets information about the traffic sources for the specified Auto Scaling group.
describeWarmPool({required String autoScalingGroupName, int? maxRecords, String? nextToken}) → Future<DescribeWarmPoolAnswer>
Gets information about a warm pool and its instances.
detachInstances({required String autoScalingGroupName, required bool shouldDecrementDesiredCapacity, List<String>? instanceIds}) → Future<DetachInstancesAnswer>
Removes one or more instances from the specified Auto Scaling group.
detachLoadBalancers({required String autoScalingGroupName, required List<String> loadBalancerNames}) → Future<void>
This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.
detachLoadBalancerTargetGroups({required String autoScalingGroupName, required List<String> targetGroupARNs}) → Future<void>
When you detach a target group, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain running.
detachTrafficSources({required String autoScalingGroupName, required List<TrafficSourceIdentifier> trafficSources}) → Future<void>
Detaches one or more traffic sources from the specified Auto Scaling group.
disableMetricsCollection({required String autoScalingGroupName, List<String>? metrics}) → Future<void>
Disables group metrics collection for the specified Auto Scaling group.
enableMetricsCollection({required String autoScalingGroupName, required String granularity, List<String>? metrics}) → Future<void>
Enables group metrics collection for the specified Auto Scaling group.
enterStandby({required String autoScalingGroupName, required bool shouldDecrementDesiredCapacity, List<String>? instanceIds}) → Future<EnterStandbyAnswer>
Moves the specified instances into the standby state.
executePolicy({required String policyName, String? autoScalingGroupName, double? breachThreshold, bool? honorCooldown, double? metricValue}) → Future<void>
Executes the specified policy. This can be useful for testing the design of your scaling policy.
exitStandby({required String autoScalingGroupName, List<String>? instanceIds}) → Future<ExitStandbyAnswer>
Moves the specified instances out of the standby state.
getPredictiveScalingForecast({required String autoScalingGroupName, required DateTime endTime, required String policyName, required DateTime startTime}) → Future<GetPredictiveScalingForecastAnswer>
Retrieves the forecast data for a predictive scaling policy.
launchInstances({required String autoScalingGroupName, required int requestedCapacity, List<String>? availabilityZoneIds, List<String>? availabilityZones, String? clientToken, RetryStrategy? retryStrategy, List<String>? subnetIds}) → Future<LaunchInstancesResult>
Launches a specified number of instances in an Auto Scaling group. Returns instance IDs and other details if launch is successful or error details if launch is unsuccessful.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putLifecycleHook({required String autoScalingGroupName, required String lifecycleHookName, String? defaultResult, int? heartbeatTimeout, String? lifecycleTransition, String? notificationMetadata, String? notificationTargetARN, String? roleARN}) → Future<void>
Creates or updates a lifecycle hook for the specified Auto Scaling group.
putNotificationConfiguration({required String autoScalingGroupName, required List<String> notificationTypes, required String topicARN}) → Future<void>
Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.
putScalingPolicy({required String autoScalingGroupName, required String policyName, String? adjustmentType, int? cooldown, bool? enabled, int? estimatedInstanceWarmup, String? metricAggregationType, int? minAdjustmentMagnitude, int? minAdjustmentStep, String? policyType, PredictiveScalingConfiguration? predictiveScalingConfiguration, int? scalingAdjustment, List<StepAdjustment>? stepAdjustments, TargetTrackingConfiguration? targetTrackingConfiguration}) → Future<PolicyARNType>
Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used.
putScheduledUpdateGroupAction({required String autoScalingGroupName, required String scheduledActionName, int? desiredCapacity, DateTime? endTime, int? maxSize, int? minSize, String? recurrence, DateTime? startTime, DateTime? time, String? timeZone}) → Future<void>
Creates or updates a scheduled scaling action for an Auto Scaling group.
putWarmPool({required String autoScalingGroupName, InstanceReusePolicy? instanceReusePolicy, int? maxGroupPreparedCapacity, int? minSize, WarmPoolState? poolState}) → Future<void>
Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.
recordLifecycleActionHeartbeat({required String autoScalingGroupName, required String lifecycleHookName, String? instanceId, String? lifecycleActionToken}) → Future<void>
Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.
resumeProcesses({required String autoScalingGroupName, List<String>? scalingProcesses}) → Future<void>
Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.
rollbackInstanceRefresh({required String autoScalingGroupName}) → Future<RollbackInstanceRefreshAnswer>
Cancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. This restores your Auto Scaling group to the configuration that it was using before the start of the instance refresh.
setDesiredCapacity({required String autoScalingGroupName, required int desiredCapacity, bool? honorCooldown}) → Future<void>
Sets the size of the specified Auto Scaling group.
setInstanceHealth({required String healthStatus, required String instanceId, bool? shouldRespectGracePeriod}) → Future<void>
Sets the health status of the specified instance.
setInstanceProtection({required String autoScalingGroupName, required List<String> instanceIds, required bool protectedFromScaleIn}) → Future<void>
Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool.
startInstanceRefresh({required String autoScalingGroupName, DesiredConfiguration? desiredConfiguration, RefreshPreferences? preferences, RefreshStrategy? strategy}) → Future<StartInstanceRefreshAnswer>
Starts an instance refresh.
suspendProcesses({required String autoScalingGroupName, List<String>? scalingProcesses}) → Future<void>
Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
terminateInstanceInAutoScalingGroup({required String instanceId, required bool shouldDecrementDesiredCapacity}) → Future<ActivityType>
Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool.
toString() → String
A string representation of this object.
inherited
updateAutoScalingGroup({required String autoScalingGroupName, AvailabilityZoneDistribution? availabilityZoneDistribution, List<String>? availabilityZoneIds, AvailabilityZoneImpairmentPolicy? availabilityZoneImpairmentPolicy, List<String>? availabilityZones, bool? capacityRebalance, CapacityReservationSpecification? capacityReservationSpecification, String? context, int? defaultCooldown, int? defaultInstanceWarmup, DeletionProtection? deletionProtection, int? desiredCapacity, String? desiredCapacityType, int? healthCheckGracePeriod, String? healthCheckType, InstanceLifecyclePolicy? instanceLifecyclePolicy, InstanceMaintenancePolicy? instanceMaintenancePolicy, String? launchConfigurationName, LaunchTemplateSpecification? launchTemplate, int? maxInstanceLifetime, int? maxSize, int? minSize, MixedInstancesPolicy? mixedInstancesPolicy, bool? newInstancesProtectedFromScaleIn, String? placementGroup, String? serviceLinkedRoleARN, bool? skipZonalShiftValidation, List<String>? terminationPolicies, String? vPCZoneIdentifier}) → Future<void>
We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.

Operators

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