@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonAutoScaling extends Object implements AmazonAutoScaling
AmazonAutoScaling. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AttachInstancesResult |
attachInstances(AttachInstancesRequest request)
Attaches one or more EC2 instances to the specified Auto Scaling group.
|
AttachLoadBalancersResult |
attachLoadBalancers()
Simplified method form for invoking the AttachLoadBalancers operation.
|
AttachLoadBalancersResult |
attachLoadBalancers(AttachLoadBalancersRequest request)
|
AttachLoadBalancerTargetGroupsResult |
attachLoadBalancerTargetGroups(AttachLoadBalancerTargetGroupsRequest request)
|
AttachTrafficSourcesResult |
attachTrafficSources(AttachTrafficSourcesRequest request)
Attaches one or more traffic sources to the specified Auto Scaling group.
|
BatchDeleteScheduledActionResult |
batchDeleteScheduledAction(BatchDeleteScheduledActionRequest request)
Deletes one or more scheduled actions for the specified Auto Scaling group.
|
BatchPutScheduledUpdateGroupActionResult |
batchPutScheduledUpdateGroupAction(BatchPutScheduledUpdateGroupActionRequest request)
Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
|
CancelInstanceRefreshResult |
cancelInstanceRefresh(CancelInstanceRefreshRequest request)
Cancels an instance refresh or rollback that is in progress.
|
CompleteLifecycleActionResult |
completeLifecycleAction(CompleteLifecycleActionRequest request)
Completes the lifecycle action for the specified token or instance with the specified result.
|
CreateAutoScalingGroupResult |
createAutoScalingGroup(CreateAutoScalingGroupRequest request)
We strongly recommend using a launch template when calling this operation to ensure full functionality for
Amazon EC2 Auto Scaling and Amazon EC2.
|
CreateLaunchConfigurationResult |
createLaunchConfiguration(CreateLaunchConfigurationRequest request)
Creates a launch configuration.
|
CreateOrUpdateTagsResult |
createOrUpdateTags(CreateOrUpdateTagsRequest request)
Creates or updates tags for the specified Auto Scaling group.
|
DeleteAutoScalingGroupResult |
deleteAutoScalingGroup(DeleteAutoScalingGroupRequest request)
Deletes the specified Auto Scaling group.
|
DeleteLaunchConfigurationResult |
deleteLaunchConfiguration(DeleteLaunchConfigurationRequest request)
Deletes the specified launch configuration.
|
DeleteLifecycleHookResult |
deleteLifecycleHook(DeleteLifecycleHookRequest request)
Deletes the specified lifecycle hook.
|
DeleteNotificationConfigurationResult |
deleteNotificationConfiguration(DeleteNotificationConfigurationRequest request)
Deletes the specified notification.
|
DeletePolicyResult |
deletePolicy(DeletePolicyRequest request)
Deletes the specified scaling policy.
|
DeleteScheduledActionResult |
deleteScheduledAction(DeleteScheduledActionRequest request)
Deletes the specified scheduled action.
|
DeleteTagsResult |
deleteTags(DeleteTagsRequest request)
Deletes the specified tags.
|
DeleteWarmPoolResult |
deleteWarmPool(DeleteWarmPoolRequest request)
Deletes the warm pool for the specified Auto Scaling group.
|
DescribeAccountLimitsResult |
describeAccountLimits()
Simplified method form for invoking the DescribeAccountLimits operation.
|
DescribeAccountLimitsResult |
describeAccountLimits(DescribeAccountLimitsRequest request)
Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
|
DescribeAdjustmentTypesResult |
describeAdjustmentTypes()
Simplified method form for invoking the DescribeAdjustmentTypes operation.
|
DescribeAdjustmentTypesResult |
describeAdjustmentTypes(DescribeAdjustmentTypesRequest request)
Describes the available adjustment types for step scaling and simple scaling policies.
|
DescribeAutoScalingGroupsResult |
describeAutoScalingGroups()
Simplified method form for invoking the DescribeAutoScalingGroups operation.
|
DescribeAutoScalingGroupsResult |
describeAutoScalingGroups(DescribeAutoScalingGroupsRequest request)
Gets information about the Auto Scaling groups in the account and Region.
|
DescribeAutoScalingInstancesResult |
describeAutoScalingInstances()
Simplified method form for invoking the DescribeAutoScalingInstances operation.
|
DescribeAutoScalingInstancesResult |
describeAutoScalingInstances(DescribeAutoScalingInstancesRequest request)
Gets information about the Auto Scaling instances in the account and Region.
|
DescribeAutoScalingNotificationTypesResult |
describeAutoScalingNotificationTypes()
Simplified method form for invoking the DescribeAutoScalingNotificationTypes operation.
|
DescribeAutoScalingNotificationTypesResult |
describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest request)
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
|
DescribeInstanceRefreshesResult |
describeInstanceRefreshes(DescribeInstanceRefreshesRequest request)
Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks.
|
DescribeLaunchConfigurationsResult |
describeLaunchConfigurations()
Simplified method form for invoking the DescribeLaunchConfigurations operation.
|
DescribeLaunchConfigurationsResult |
describeLaunchConfigurations(DescribeLaunchConfigurationsRequest request)
Gets information about the launch configurations in the account and Region.
|
DescribeLifecycleHooksResult |
describeLifecycleHooks(DescribeLifecycleHooksRequest request)
Gets information about the lifecycle hooks for the specified Auto Scaling group.
|
DescribeLifecycleHookTypesResult |
describeLifecycleHookTypes()
Simplified method form for invoking the DescribeLifecycleHookTypes operation.
|
DescribeLifecycleHookTypesResult |
describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest request)
Describes the available types of lifecycle hooks.
|
DescribeLoadBalancersResult |
describeLoadBalancers(DescribeLoadBalancersRequest request)
|
DescribeLoadBalancerTargetGroupsResult |
describeLoadBalancerTargetGroups(DescribeLoadBalancerTargetGroupsRequest request)
|
DescribeMetricCollectionTypesResult |
describeMetricCollectionTypes()
Simplified method form for invoking the DescribeMetricCollectionTypes operation.
|
DescribeMetricCollectionTypesResult |
describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest request)
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
|
DescribeNotificationConfigurationsResult |
describeNotificationConfigurations()
Simplified method form for invoking the DescribeNotificationConfigurations operation.
|
DescribeNotificationConfigurationsResult |
describeNotificationConfigurations(DescribeNotificationConfigurationsRequest request)
Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
|
DescribePoliciesResult |
describePolicies()
Simplified method form for invoking the DescribePolicies operation.
|
DescribePoliciesResult |
describePolicies(DescribePoliciesRequest request)
Gets information about the scaling policies in the account and Region.
|
DescribeScalingActivitiesResult |
describeScalingActivities()
Simplified method form for invoking the DescribeScalingActivities operation.
|
DescribeScalingActivitiesResult |
describeScalingActivities(DescribeScalingActivitiesRequest request)
Gets information about the scaling activities in the account and Region.
|
DescribeScalingProcessTypesResult |
describeScalingProcessTypes()
Simplified method form for invoking the DescribeScalingProcessTypes operation.
|
DescribeScalingProcessTypesResult |
describeScalingProcessTypes(DescribeScalingProcessTypesRequest request)
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
|
DescribeScheduledActionsResult |
describeScheduledActions()
Simplified method form for invoking the DescribeScheduledActions operation.
|
DescribeScheduledActionsResult |
describeScheduledActions(DescribeScheduledActionsRequest request)
Gets information about the scheduled actions that haven't run or that have not reached their end time.
|
DescribeTagsResult |
describeTags()
Simplified method form for invoking the DescribeTags operation.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest request)
Describes the specified tags.
|
DescribeTerminationPolicyTypesResult |
describeTerminationPolicyTypes()
Simplified method form for invoking the DescribeTerminationPolicyTypes operation.
|
DescribeTerminationPolicyTypesResult |
describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest request)
Describes the termination policies supported by Amazon EC2 Auto Scaling.
|
DescribeTrafficSourcesResult |
describeTrafficSources(DescribeTrafficSourcesRequest request)
Gets information about the traffic sources for the specified Auto Scaling group.
|
DescribeWarmPoolResult |
describeWarmPool(DescribeWarmPoolRequest request)
Gets information about a warm pool and its instances.
|
DetachInstancesResult |
detachInstances(DetachInstancesRequest request)
Removes one or more instances from the specified Auto Scaling group.
|
DetachLoadBalancersResult |
detachLoadBalancers()
Simplified method form for invoking the DetachLoadBalancers operation.
|
DetachLoadBalancersResult |
detachLoadBalancers(DetachLoadBalancersRequest request)
|
DetachLoadBalancerTargetGroupsResult |
detachLoadBalancerTargetGroups(DetachLoadBalancerTargetGroupsRequest request)
|
DetachTrafficSourcesResult |
detachTrafficSources(DetachTrafficSourcesRequest request)
Detaches one or more traffic sources from the specified Auto Scaling group.
|
DisableMetricsCollectionResult |
disableMetricsCollection(DisableMetricsCollectionRequest request)
Disables group metrics collection for the specified Auto Scaling group.
|
EnableMetricsCollectionResult |
enableMetricsCollection(EnableMetricsCollectionRequest request)
Enables group metrics collection for the specified Auto Scaling group.
|
EnterStandbyResult |
enterStandby(EnterStandbyRequest request)
Moves the specified instances into the standby state.
|
ExecutePolicyResult |
executePolicy(ExecutePolicyRequest request)
Executes the specified policy.
|
ExitStandbyResult |
exitStandby(ExitStandbyRequest request)
Moves the specified instances out of the standby state.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetPredictiveScalingForecastResult |
getPredictiveScalingForecast(GetPredictiveScalingForecastRequest request)
Retrieves the forecast data for a predictive scaling policy.
|
PutLifecycleHookResult |
putLifecycleHook(PutLifecycleHookRequest request)
Creates or updates a lifecycle hook for the specified Auto Scaling group.
|
PutNotificationConfigurationResult |
putNotificationConfiguration(PutNotificationConfigurationRequest request)
Configures an Auto Scaling group to send notifications when specified events take place.
|
PutScalingPolicyResult |
putScalingPolicy(PutScalingPolicyRequest request)
Creates or updates a scaling policy for an Auto Scaling group.
|
PutScheduledUpdateGroupActionResult |
putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest request)
Creates or updates a scheduled scaling action for an Auto Scaling group.
|
PutWarmPoolResult |
putWarmPool(PutWarmPoolRequest request)
Creates or updates a warm pool for the specified Auto Scaling group.
|
RecordLifecycleActionHeartbeatResult |
recordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest request)
Records a heartbeat for the lifecycle action associated with the specified token or instance.
|
ResumeProcessesResult |
resumeProcesses(ResumeProcessesRequest request)
Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling
group.
|
RollbackInstanceRefreshResult |
rollbackInstanceRefresh(RollbackInstanceRefreshRequest request)
Cancels an instance refresh that is in progress and rolls back any changes that it made.
|
SetDesiredCapacityResult |
setDesiredCapacity(SetDesiredCapacityRequest request)
Sets the size of the specified Auto Scaling group.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://autoscaling.amazonaws.com").
|
SetInstanceHealthResult |
setInstanceHealth(SetInstanceHealthRequest request)
Sets the health status of the specified instance.
|
SetInstanceProtectionResult |
setInstanceProtection(SetInstanceProtectionRequest request)
Updates the instance protection settings of the specified instances.
|
void |
setRegion(Region region)
An alternative to
AmazonAutoScaling.setEndpoint(String), sets the regional endpoint for this client's
service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartInstanceRefreshResult |
startInstanceRefresh(StartInstanceRefreshRequest request)
Starts an instance refresh.
|
SuspendProcessesResult |
suspendProcesses(SuspendProcessesRequest request)
Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
|
TerminateInstanceInAutoScalingGroupResult |
terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest request)
Terminates the specified instance and optionally adjusts the desired group size.
|
UpdateAutoScalingGroupResult |
updateAutoScalingGroup(UpdateAutoScalingGroupRequest request)
We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for
Amazon EC2 Auto Scaling and Amazon EC2.
|
AmazonAutoScalingWaiters |
waiters() |
public void setEndpoint(String endpoint)
AmazonAutoScaling
Callers can pass in just the endpoint (ex: "autoscaling.amazonaws.com") or a full URL, including the protocol
(ex: "https://autoscaling.amazonaws.com"). If the protocol is not specified here, the default protocol from this
client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AmazonAutoScalingendpoint - The endpoint (ex: "autoscaling.amazonaws.com") or a full URL, including the protocol (ex:
"https://autoscaling.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AmazonAutoScalingAmazonAutoScaling.setEndpoint(String), sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AmazonAutoScalingregion - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public AttachInstancesResult attachInstances(AttachInstancesRequest request)
AmazonAutoScalingAttaches one or more EC2 instances to the specified Auto Scaling group.
When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.
If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.
For more information, see Detach or attach instances in the Amazon EC2 Auto Scaling User Guide.
attachInstances in interface AmazonAutoScalingpublic AttachLoadBalancerTargetGroupsResult attachLoadBalancerTargetGroups(AttachLoadBalancerTargetGroupsRequest request)
AmazonAutoScaling
This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types.
We recommend using AttachTrafficSources to simplify how you manage traffic sources. However, we
continue to support AttachLoadBalancerTargetGroups. You can use both the original
AttachLoadBalancerTargetGroups API operation and AttachTrafficSources on the same Auto
Scaling group.
Attaches one or more target groups to the specified Auto Scaling group.
This operation is used with the following load balancer types:
Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.
Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.
Gateway Load Balancer - Operates at the network layer (layer 3).
To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
This operation is additive and does not detach existing target groups or Classic Load Balancers from the Auto Scaling group.
For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
attachLoadBalancerTargetGroups in interface AmazonAutoScalingpublic AttachLoadBalancersResult attachLoadBalancers(AttachLoadBalancersRequest request)
AmazonAutoScaling
This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types.
We recommend using AttachTrafficSources to simplify how you manage traffic sources. However, we
continue to support AttachLoadBalancers. You can use both the original
AttachLoadBalancers API operation and AttachTrafficSources on the same Auto Scaling
group.
Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instances with these Classic Load Balancers.
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.
This operation is additive and does not detach existing Classic Load Balancers or target groups from the Auto Scaling group.
For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
attachLoadBalancers in interface AmazonAutoScalingpublic AttachLoadBalancersResult attachLoadBalancers()
AmazonAutoScalingattachLoadBalancers in interface AmazonAutoScalingAmazonAutoScaling.attachLoadBalancers(AttachLoadBalancersRequest)public AttachTrafficSourcesResult attachTrafficSources(AttachTrafficSourcesRequest request)
AmazonAutoScalingAttaches one or more traffic sources to the specified Auto Scaling group.
You can use any of the following as traffic sources for an Auto Scaling group:
Application Load Balancer
Classic Load Balancer
Gateway Load Balancer
Network Load Balancer
VPC Lattice
This operation is additive and does not detach existing traffic sources from the Auto Scaling group.
After the operation completes, use the DescribeTrafficSources API to return details about the state of the attachments between traffic sources and your Auto Scaling group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.
attachTrafficSources in interface AmazonAutoScalingpublic BatchDeleteScheduledActionResult batchDeleteScheduledAction(BatchDeleteScheduledActionRequest request)
AmazonAutoScalingDeletes one or more scheduled actions for the specified Auto Scaling group.
batchDeleteScheduledAction in interface AmazonAutoScalingpublic BatchPutScheduledUpdateGroupActionResult batchPutScheduledUpdateGroupAction(BatchPutScheduledUpdateGroupActionRequest request)
AmazonAutoScalingCreates or updates one or more scheduled scaling actions for an Auto Scaling group.
batchPutScheduledUpdateGroupAction in interface AmazonAutoScalingpublic CancelInstanceRefreshResult cancelInstanceRefresh(CancelInstanceRefreshRequest request)
AmazonAutoScaling
Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in
progress, an ActiveInstanceRefreshNotFound error occurs.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
When you cancel an instance refresh, this does not roll back any changes that it made. Use the RollbackInstanceRefresh API to roll back instead.
cancelInstanceRefresh in interface AmazonAutoScalingpublic CompleteLifecycleActionResult completeLifecycleAction(CompleteLifecycleActionRequest request)
AmazonAutoScalingCompletes the lifecycle action for the specified token or instance with the specified result.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Complete a lifecycle action in the Amazon EC2 Auto Scaling User Guide.
completeLifecycleAction in interface AmazonAutoScalingpublic CreateAutoScalingGroupResult createAutoScalingGroup(CreateAutoScalingGroupRequest request)
AmazonAutoScalingWe strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Creates an Auto Scaling group with the specified name and attributes.
If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
If you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Every Auto Scaling group has three size properties (DesiredCapacity, MaxSize, and
MinSize). Usually, you set these sizes based on a specific number of instances. However, if you
configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with
the same units that you use for weighting instances.
createAutoScalingGroup in interface AmazonAutoScalingpublic CreateLaunchConfigurationResult createLaunchConfiguration(CreateLaunchConfigurationRequest request)
AmazonAutoScalingCreates a launch configuration.
If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.
Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
createLaunchConfiguration in interface AmazonAutoScalingpublic CreateOrUpdateTagsResult createOrUpdateTags(CreateOrUpdateTagsRequest request)
AmazonAutoScalingCreates or updates tags for the specified Auto Scaling group.
When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.
For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
createOrUpdateTags in interface AmazonAutoScalingpublic DeleteAutoScalingGroupResult deleteAutoScalingGroup(DeleteAutoScalingGroupRequest request)
AmazonAutoScalingDeletes the specified Auto Scaling group.
If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. The force delete operation will also terminate the EC2 instances. If the group has a warm pool, the force delete option also deletes the warm pool.
To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.
To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity of the Auto Scaling group to zero.
If the group has scaling policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.
For more information, see Delete your Auto Scaling infrastructure in the Amazon EC2 Auto Scaling User Guide.
deleteAutoScalingGroup in interface AmazonAutoScalingpublic DeleteLaunchConfigurationResult deleteLaunchConfiguration(DeleteLaunchConfigurationRequest request)
AmazonAutoScalingDeletes the specified launch configuration.
The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.
deleteLaunchConfiguration in interface AmazonAutoScalingpublic DeleteLifecycleHookResult deleteLifecycleHook(DeleteLifecycleHookRequest request)
AmazonAutoScalingDeletes the specified lifecycle hook.
If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching
instances, CONTINUE for terminating instances).
deleteLifecycleHook in interface AmazonAutoScalingpublic DeleteNotificationConfigurationResult deleteNotificationConfiguration(DeleteNotificationConfigurationRequest request)
AmazonAutoScalingDeletes the specified notification.
deleteNotificationConfiguration in interface AmazonAutoScalingpublic DeletePolicyResult deletePolicy(DeletePolicyRequest request)
AmazonAutoScalingDeletes the specified scaling policy.
Deleting either a step scaling policy or a simple scaling policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.
For more information, see Delete a scaling policy in the Amazon EC2 Auto Scaling User Guide.
deletePolicy in interface AmazonAutoScalingpublic DeleteScheduledActionResult deleteScheduledAction(DeleteScheduledActionRequest request)
AmazonAutoScalingDeletes the specified scheduled action.
deleteScheduledAction in interface AmazonAutoScalingpublic DeleteTagsResult deleteTags(DeleteTagsRequest request)
AmazonAutoScalingDeletes the specified tags.
deleteTags in interface AmazonAutoScalingpublic DeleteWarmPoolResult deleteWarmPool(DeleteWarmPoolRequest request)
AmazonAutoScalingDeletes the warm pool for the specified Auto Scaling group.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
deleteWarmPool in interface AmazonAutoScalingpublic DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest request)
AmazonAutoScalingDescribes the current Amazon EC2 Auto Scaling resource quotas for your account.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of Auto Scaling groups and launch configurations that you can create in a given Region. For more information, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
describeAccountLimits in interface AmazonAutoScalingpublic DescribeAccountLimitsResult describeAccountLimits()
AmazonAutoScalingdescribeAccountLimits in interface AmazonAutoScalingAmazonAutoScaling.describeAccountLimits(DescribeAccountLimitsRequest)public DescribeAdjustmentTypesResult describeAdjustmentTypes(DescribeAdjustmentTypesRequest request)
AmazonAutoScalingDescribes the available adjustment types for step scaling and simple scaling policies.
The following adjustment types are supported:
ChangeInCapacity
ExactCapacity
PercentChangeInCapacity
describeAdjustmentTypes in interface AmazonAutoScalingpublic DescribeAdjustmentTypesResult describeAdjustmentTypes()
AmazonAutoScalingdescribeAdjustmentTypes in interface AmazonAutoScalingAmazonAutoScaling.describeAdjustmentTypes(DescribeAdjustmentTypesRequest)public DescribeAutoScalingGroupsResult describeAutoScalingGroups(DescribeAutoScalingGroupsRequest request)
AmazonAutoScalingGets information about the Auto Scaling groups in the account and Region.
If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.
This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.
describeAutoScalingGroups in interface AmazonAutoScalingpublic DescribeAutoScalingGroupsResult describeAutoScalingGroups()
AmazonAutoScalingdescribeAutoScalingGroups in interface AmazonAutoScalingAmazonAutoScaling.describeAutoScalingGroups(DescribeAutoScalingGroupsRequest)public DescribeAutoScalingInstancesResult describeAutoScalingInstances(DescribeAutoScalingInstancesRequest request)
AmazonAutoScalingGets information about the Auto Scaling instances in the account and Region.
describeAutoScalingInstances in interface AmazonAutoScalingpublic DescribeAutoScalingInstancesResult describeAutoScalingInstances()
AmazonAutoScalingdescribeAutoScalingInstances in interface AmazonAutoScalingAmazonAutoScaling.describeAutoScalingInstances(DescribeAutoScalingInstancesRequest)public DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest request)
AmazonAutoScalingDescribes the notification types that are supported by Amazon EC2 Auto Scaling.
describeAutoScalingNotificationTypes in interface AmazonAutoScalingpublic DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes()
AmazonAutoScalingdescribeAutoScalingNotificationTypes in interface AmazonAutoScalingAmazonAutoScaling.describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest)public DescribeInstanceRefreshesResult describeInstanceRefreshes(DescribeInstanceRefreshesRequest request)
AmazonAutoScalingGets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information about the instance refreshes you previously initiated, including their status, start time, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete. If a rollback is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information about the rollback of the instance refresh.
describeInstanceRefreshes in interface AmazonAutoScalingpublic DescribeLaunchConfigurationsResult describeLaunchConfigurations(DescribeLaunchConfigurationsRequest request)
AmazonAutoScalingGets information about the launch configurations in the account and Region.
describeLaunchConfigurations in interface AmazonAutoScalingpublic DescribeLaunchConfigurationsResult describeLaunchConfigurations()
AmazonAutoScalingdescribeLaunchConfigurations in interface AmazonAutoScalingAmazonAutoScaling.describeLaunchConfigurations(DescribeLaunchConfigurationsRequest)public DescribeLifecycleHookTypesResult describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest request)
AmazonAutoScalingDescribes the available types of lifecycle hooks.
The following hook types are supported:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
describeLifecycleHookTypes in interface AmazonAutoScalingpublic DescribeLifecycleHookTypesResult describeLifecycleHookTypes()
AmazonAutoScalingdescribeLifecycleHookTypes in interface AmazonAutoScalingAmazonAutoScaling.describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest)public DescribeLifecycleHooksResult describeLifecycleHooks(DescribeLifecycleHooksRequest request)
AmazonAutoScalingGets information about the lifecycle hooks for the specified Auto Scaling group.
describeLifecycleHooks in interface AmazonAutoScalingpublic DescribeLoadBalancerTargetGroupsResult describeLoadBalancerTargetGroups(DescribeLoadBalancerTargetGroupsRequest request)
AmazonAutoScaling
This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources
types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However,
we continue to support DescribeLoadBalancerTargetGroups. You can use both the original
DescribeLoadBalancerTargetGroups API operation and DescribeTrafficSources on the same
Auto Scaling group.
Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.
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.
Target groups also have an InService state if you attach them in the CreateAutoScalingGroup
API call. If your target group state is InService, but it is not working properly, check the scaling
activities by calling DescribeScalingActivities and take any corrective actions necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
You can use this operation to describe target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
describeLoadBalancerTargetGroups in interface AmazonAutoScalingpublic DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest request)
AmazonAutoScaling
This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources
types. We recommend using DescribeTrafficSources to simplify how you manage traffic sources.
However, we continue to support DescribeLoadBalancers. You can use both the original
DescribeLoadBalancers API operation and DescribeTrafficSources on the same Auto Scaling
group.
Gets information about the load balancers for the specified Auto Scaling group.
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.
To determine the attachment status of the load balancer, use the State element in the response. When
you attach a load balancer 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 load
balancer. 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 load
balancer 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 load balancer doesn't
enter the InService state.
Load balancers also have an InService state if you attach them in the CreateAutoScalingGroup
API call. If your load balancer state is InService, but it is not working properly, check the
scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
describeLoadBalancers in interface AmazonAutoScalingpublic DescribeMetricCollectionTypesResult describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest request)
AmazonAutoScalingDescribes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
describeMetricCollectionTypes in interface AmazonAutoScalingpublic DescribeMetricCollectionTypesResult describeMetricCollectionTypes()
AmazonAutoScalingdescribeMetricCollectionTypes in interface AmazonAutoScalingAmazonAutoScaling.describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest)public DescribeNotificationConfigurationsResult describeNotificationConfigurations(DescribeNotificationConfigurationsRequest request)
AmazonAutoScalingGets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
describeNotificationConfigurations in interface AmazonAutoScalingpublic DescribeNotificationConfigurationsResult describeNotificationConfigurations()
AmazonAutoScalingdescribeNotificationConfigurations in interface AmazonAutoScalingAmazonAutoScaling.describeNotificationConfigurations(DescribeNotificationConfigurationsRequest)public DescribePoliciesResult describePolicies(DescribePoliciesRequest request)
AmazonAutoScalingGets information about the scaling policies in the account and Region.
describePolicies in interface AmazonAutoScalingpublic DescribePoliciesResult describePolicies()
AmazonAutoScalingdescribePolicies in interface AmazonAutoScalingAmazonAutoScaling.describePolicies(DescribePoliciesRequest)public DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest request)
AmazonAutoScalingGets information about the scaling activities in the account and Region.
When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verify a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
If the scaling event succeeds, the value of the StatusCode element in the response is
Successful. If an attempt to launch instances failed, the StatusCode value is
Failed or Cancelled and the StatusMessage element in the response
indicates the cause of the failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2
Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
describeScalingActivities in interface AmazonAutoScalingpublic DescribeScalingActivitiesResult describeScalingActivities()
AmazonAutoScalingdescribeScalingActivities in interface AmazonAutoScalingAmazonAutoScaling.describeScalingActivities(DescribeScalingActivitiesRequest)public DescribeScalingProcessTypesResult describeScalingProcessTypes(DescribeScalingProcessTypesRequest request)
AmazonAutoScalingDescribes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
describeScalingProcessTypes in interface AmazonAutoScalingpublic DescribeScalingProcessTypesResult describeScalingProcessTypes()
AmazonAutoScalingdescribeScalingProcessTypes in interface AmazonAutoScalingAmazonAutoScaling.describeScalingProcessTypes(DescribeScalingProcessTypesRequest)public DescribeScheduledActionsResult describeScheduledActions(DescribeScheduledActionsRequest request)
AmazonAutoScalingGets information about the scheduled actions that haven't run or that have not reached their end time.
To describe the scaling activities for scheduled actions that have already run, call the DescribeScalingActivities API.
describeScheduledActions in interface AmazonAutoScalingpublic DescribeScheduledActionsResult describeScheduledActions()
AmazonAutoScalingdescribeScheduledActions in interface AmazonAutoScalingAmazonAutoScaling.describeScheduledActions(DescribeScheduledActionsRequest)public DescribeTagsResult describeTags(DescribeTagsRequest request)
AmazonAutoScalingDescribes the specified tags.
You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.
You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.
For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
describeTags in interface AmazonAutoScalingpublic DescribeTagsResult describeTags()
AmazonAutoScalingdescribeTags in interface AmazonAutoScalingAmazonAutoScaling.describeTags(DescribeTagsRequest)public DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest request)
AmazonAutoScalingDescribes the termination policies supported by Amazon EC2 Auto Scaling.
For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
describeTerminationPolicyTypes in interface AmazonAutoScalingpublic DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes()
AmazonAutoScalingdescribeTerminationPolicyTypes in interface AmazonAutoScalingAmazonAutoScaling.describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest)public DescribeTrafficSourcesResult describeTrafficSources(DescribeTrafficSourcesRequest request)
AmazonAutoScalingGets information about the traffic sources for the specified Auto Scaling group.
You can optionally provide a traffic source type. If you provide a traffic source type, then the results only include that traffic source type.
If you do not provide a traffic source type, then the results include all the traffic sources for the specified Auto Scaling group.
describeTrafficSources in interface AmazonAutoScalingpublic DescribeWarmPoolResult describeWarmPool(DescribeWarmPoolRequest request)
AmazonAutoScalingGets information about a warm pool and its instances.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
describeWarmPool in interface AmazonAutoScalingpublic DetachInstancesResult detachInstances(DetachInstancesRequest request)
AmazonAutoScalingRemoves one or more instances from the specified Auto Scaling group.
After the instances are detached, you can manage them independent of the Auto Scaling group.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached.
If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.
For more information, see Detach or attach instances in the Amazon EC2 Auto Scaling User Guide.
detachInstances in interface AmazonAutoScalingpublic DetachLoadBalancerTargetGroupsResult detachLoadBalancerTargetGroups(DetachLoadBalancerTargetGroupsRequest request)
AmazonAutoScaling
This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types.
We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we
continue to support DetachLoadBalancerTargetGroups. You can use both the original
DetachLoadBalancerTargetGroups API operation and DetachTrafficSources on the same Auto
Scaling group.
Detaches one or more target groups from the specified Auto Scaling group.
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.
You can use this operation to detach target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
detachLoadBalancerTargetGroups in interface AmazonAutoScalingpublic DetachLoadBalancersResult detachLoadBalancers(DetachLoadBalancersRequest request)
AmazonAutoScaling
This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types.
We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we
continue to support DetachLoadBalancers. You can use both the original
DetachLoadBalancers API operation and DetachTrafficSources on the same Auto Scaling
group.
Detaches one or more Classic Load Balancers from the specified Auto Scaling group.
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.
When you detach a load balancer, it enters the Removing state while deregistering the instances in
the group. When all instances are deregistered, then you can no longer describe the load balancer using the
DescribeLoadBalancers API call. The instances remain running.
detachLoadBalancers in interface AmazonAutoScalingpublic DetachLoadBalancersResult detachLoadBalancers()
AmazonAutoScalingdetachLoadBalancers in interface AmazonAutoScalingAmazonAutoScaling.detachLoadBalancers(DetachLoadBalancersRequest)public DetachTrafficSourcesResult detachTrafficSources(DetachTrafficSourcesRequest request)
AmazonAutoScalingDetaches one or more traffic sources from the specified Auto Scaling group.
When you detach a traffic source, it enters the Removing state while deregistering the instances in
the group. When all instances are deregistered, then you can no longer describe the traffic source using the
DescribeTrafficSources API call. The instances continue to run.
detachTrafficSources in interface AmazonAutoScalingpublic DisableMetricsCollectionResult disableMetricsCollection(DisableMetricsCollectionRequest request)
AmazonAutoScalingDisables group metrics collection for the specified Auto Scaling group.
disableMetricsCollection in interface AmazonAutoScalingpublic EnableMetricsCollectionResult enableMetricsCollection(EnableMetricsCollectionRequest request)
AmazonAutoScalingEnables group metrics collection for the specified Auto Scaling group.
You can use these metrics to track changes in an Auto Scaling group and to set alarms on threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch console. For more information, see Monitor CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
enableMetricsCollection in interface AmazonAutoScalingpublic EnterStandbyResult enterStandby(EnterStandbyRequest request)
AmazonAutoScalingMoves the specified instances into the standby state.
If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group.
If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
enterStandby in interface AmazonAutoScalingpublic ExecutePolicyResult executePolicy(ExecutePolicyRequest request)
AmazonAutoScalingExecutes the specified policy. This can be useful for testing the design of your scaling policy.
executePolicy in interface AmazonAutoScalingpublic ExitStandbyResult exitStandby(ExitStandbyRequest request)
AmazonAutoScalingMoves the specified instances out of the standby state.
After you put the instances back in service, the desired capacity is incremented.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
exitStandby in interface AmazonAutoScalingpublic GetPredictiveScalingForecastResult getPredictiveScalingForecast(GetPredictiveScalingForecastRequest request)
AmazonAutoScalingRetrieves the forecast data for a predictive scaling policy.
Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.
A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.
For more information, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
getPredictiveScalingForecast in interface AmazonAutoScalingpublic PutLifecycleHookResult putLifecycleHook(PutLifecycleHookRequest request)
AmazonAutoScalingCreates or updates a lifecycle hook for the specified Auto Scaling group.
Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state using the RecordLifecycleActionHeartbeat API call.
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.
You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.
putLifecycleHook in interface AmazonAutoScalingpublic PutNotificationConfigurationResult putNotificationConfiguration(PutNotificationConfigurationRequest request)
AmazonAutoScalingConfigures 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.
This configuration overwrites any existing configuration.
For more information, see Amazon SNS notification options for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.
putNotificationConfiguration in interface AmazonAutoScalingpublic PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest request)
AmazonAutoScalingCreates 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.
For more information about using dynamic scaling, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
For more information about using predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.
putScalingPolicy in interface AmazonAutoScalingpublic PutScheduledUpdateGroupActionResult putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest request)
AmazonAutoScalingCreates or updates a scheduled scaling action for an Auto Scaling group.
For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide.
You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a scheduled action, you can delete it by calling the DeleteScheduledAction API.
If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.
putScheduledUpdateGroupAction in interface AmazonAutoScalingpublic PutWarmPoolResult putWarmPool(PutWarmPoolRequest request)
AmazonAutoScalingCreates 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.
This operation must be called from the Region in which the Auto Scaling group was created.
You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
putWarmPool in interface AmazonAutoScalingpublic RecordLifecycleActionHeartbeatResult recordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest request)
AmazonAutoScalingRecords 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.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
recordLifecycleActionHeartbeat in interface AmazonAutoScalingpublic ResumeProcessesResult resumeProcesses(ResumeProcessesRequest request)
AmazonAutoScalingResumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.
For more information, see Suspend and resume Amazon EC2 Auto Scaling processes in the Amazon EC2 Auto Scaling User Guide.
resumeProcesses in interface AmazonAutoScalingpublic RollbackInstanceRefreshResult rollbackInstanceRefresh(RollbackInstanceRefreshRequest request)
AmazonAutoScalingCancels 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.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
A rollback is not supported in the following situations:
There is no desired configuration specified for the instance refresh.
The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead
of an AMI ID for the ImageId property.
The Auto Scaling group uses the launch template's $Latest or $Default version.
When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes API operation.
rollbackInstanceRefresh in interface AmazonAutoScalingpublic SetDesiredCapacityResult setDesiredCapacity(SetDesiredCapacityRequest request)
AmazonAutoScalingSets the size of the specified Auto Scaling group.
If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the
current size of the group, the Auto Scaling group uses its termination policy to determine which instances to
terminate.
For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.
setDesiredCapacity in interface AmazonAutoScalingpublic SetInstanceHealthResult setInstanceHealth(SetInstanceHealthRequest request)
AmazonAutoScalingSets the health status of the specified instance.
For more information, see Health checks for instances in an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
setInstanceHealth in interface AmazonAutoScalingpublic SetInstanceProtectionResult setInstanceProtection(SetInstanceProtectionRequest request)
AmazonAutoScalingUpdates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool.
For more information, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails.
setInstanceProtection in interface AmazonAutoScalingpublic StartInstanceRefreshResult startInstanceRefresh(StartInstanceRefreshRequest request)
AmazonAutoScalingStarts an instance refresh.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group.
If successful, the request's response contains a unique ID that you can use to track the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh that is in progress, use the CancelInstanceRefresh API.
An instance refresh might fail for several reasons, such as EC2 launch failures, misconfigured health checks, or
not ignoring or allowing the termination of instances that are in Standby state or protected from
scale in. You can monitor for failed EC2 launches using the scaling activities. To find the scaling activities,
call the DescribeScalingActivities API.
If you enable auto rollback, your Auto Scaling group will be rolled back automatically when the instance refresh
fails. You can enable this feature before starting an instance refresh by specifying the
AutoRollback property in the instance refresh preferences. Otherwise, to roll back an instance
refresh before it finishes, use the RollbackInstanceRefresh API.
startInstanceRefresh in interface AmazonAutoScalingpublic SuspendProcessesResult suspendProcesses(SuspendProcessesRequest request)
AmazonAutoScalingSuspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
If you suspend either the Launch or Terminate process types, it can prevent other
process types from functioning properly. For more information, see Suspend and resume
Amazon EC2 Auto Scaling processes in the Amazon EC2 Auto Scaling User Guide.
To resume processes that have been suspended, call the ResumeProcesses API.
suspendProcesses in interface AmazonAutoScalingpublic TerminateInstanceInAutoScalingGroupResult terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest request)
AmazonAutoScalingTerminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool.
This call simply makes a termination request. The instance is not terminated immediately. When an instance is
terminated, the instance status changes to terminated. You can't connect to or start an instance
after you've terminated it.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated.
By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.
terminateInstanceInAutoScalingGroup in interface AmazonAutoScalingpublic UpdateAutoScalingGroupResult updateAutoScalingGroup(UpdateAutoScalingGroupRequest request)
AmazonAutoScalingWe strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group, specify the name of the group and the property that you want to change. Any properties that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.
If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.
Note the following about changing DesiredCapacity, MaxSize, or MinSize:
If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the
current size of the group, the Auto Scaling group uses its termination policy to determine which instances to
terminate.
If you specify a new value for MinSize without specifying a value for DesiredCapacity,
and the new MinSize is larger than the current size of the group, this sets the group's
DesiredCapacity to the new MinSize value.
If you specify a new value for MaxSize without specifying a value for DesiredCapacity,
and the new MaxSize is smaller than the current size of the group, this sets the group's
DesiredCapacity to the new MaxSize value.
To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.
updateAutoScalingGroup in interface AmazonAutoScalingpublic void shutdown()
AmazonAutoScalingshutdown in interface AmazonAutoScalingpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonAutoScalingResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonAutoScalingrequest - The originally executed request.public AmazonAutoScalingWaiters waiters()
waiters in interface AmazonAutoScaling