Class AbstractAmazonAutoScaling
- All Implemented Interfaces:
AmazonAutoScaling
- Direct Known Subclasses:
AbstractAmazonAutoScalingAsync
AmazonAutoScaling
. Convenient method forms
pass through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionattachInstances
(AttachInstancesRequest request) Attaches one or more EC2 instances to the specified Auto Scaling group.Simplified method form for invoking the AttachLoadBalancers operation.Attaches one or more load balancers to the specified Auto Scaling group.Completes the lifecycle action for the specified token or instance with the specified result.Creates an Auto Scaling group with the specified name and attributes.Creates a launch configuration.Creates or updates tags for the specified Auto Scaling group.Deletes the specified Auto Scaling group.Deletes the specified launch configuration.Deletes the specified lifecycle hook.Deletes the specified notification.deletePolicy
(DeletePolicyRequest request) Deletes the specified Auto Scaling policy.Deletes the specified scheduled action.deleteTags
(DeleteTagsRequest request) Deletes the specified tags.Simplified method form for invoking the DescribeAccountLimits operation.Describes the current Auto Scaling resource limits for your AWS account.Simplified method form for invoking the DescribeAdjustmentTypes operation.Describes the policy adjustment types for use with PutScalingPolicy.Simplified method form for invoking the DescribeAutoScalingGroups operation.Describes one or more Auto Scaling groups.Simplified method form for invoking the DescribeAutoScalingInstances operation.Describes one or more Auto Scaling instances.Simplified method form for invoking the DescribeAutoScalingNotificationTypes operation.Describes the notification types that are supported by Auto Scaling.Simplified method form for invoking the DescribeLaunchConfigurations operation.Describes one or more launch configurations.Describes the lifecycle hooks for the specified Auto Scaling group.Simplified method form for invoking the DescribeLifecycleHookTypes operation.Describes the available types of lifecycle hooks.Describes the load balancers for the specified Auto Scaling group.Simplified method form for invoking the DescribeMetricCollectionTypes operation.Describes the available CloudWatch metrics for Auto Scaling.Simplified method form for invoking the DescribeNotificationConfigurations operation.Describes the notification actions associated with the specified Auto Scaling group.Simplified method form for invoking the DescribePolicies operation.describePolicies
(DescribePoliciesRequest request) Describes the policies for the specified Auto Scaling group.Simplified method form for invoking the DescribeScalingActivities operation.Describes one or more scaling activities for the specified Auto Scaling group.Simplified method form for invoking the DescribeScalingProcessTypes operation.Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.Simplified method form for invoking the DescribeScheduledActions operation.Describes the actions scheduled for your Auto Scaling group that haven't run.Simplified method form for invoking the DescribeTags operation.describeTags
(DescribeTagsRequest request) Describes the specified tags.Simplified method form for invoking the DescribeTerminationPolicyTypes operation.Describes the termination policies supported by Auto Scaling.detachInstances
(DetachInstancesRequest request) Removes one or more instances from the specified Auto Scaling group.Simplified method form for invoking the DetachLoadBalancers operation.Removes one or more load balancers from the specified Auto Scaling group.Disables monitoring of the specified metrics for the specified Auto Scaling group.Enables monitoring of the specified metrics for the specified Auto Scaling group.enterStandby
(EnterStandbyRequest request) Moves the specified instances intoStandby
mode.executePolicy
(ExecutePolicyRequest request) Executes the specified policy.exitStandby
(ExitStandbyRequest request) Moves the specified instances out ofStandby
mode.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.putLifecycleHook
(PutLifecycleHookRequest request) Creates or updates a lifecycle hook for the specified Auto Scaling Group.Configures an Auto Scaling group to send notifications when specified events take place.putScalingPolicy
(PutScalingPolicyRequest request) Creates or updates a policy for an Auto Scaling group.Creates or updates a scheduled scaling action for an Auto Scaling group.Records a heartbeat for the lifecycle action associated with the specified token or instance.resumeProcesses
(ResumeProcessesRequest request) Resumes the specified suspended Auto Scaling processes, or all suspended process, for the specified Auto Scaling group.Sets the size of the specified Auto Scaling group.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("https://autoscaling.amazonaws.com").Sets the health status of the specified instance.Updates the instance protection settings of the specified instances.void
An alternative toAmazonAutoScaling.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.suspendProcesses
(SuspendProcessesRequest request) Suspends the specified Auto Scaling processes, or all processes, for the specified Auto Scaling group.Terminates the specified instance and optionally adjusts the desired group size.Updates the configuration for the specified Auto Scaling group.
-
Constructor Details
-
AbstractAmazonAutoScaling
protected AbstractAmazonAutoScaling()
-
-
Method Details
-
setEndpoint
Description copied from interface:AmazonAutoScaling
Overrides the default endpoint for this client ("https://autoscaling.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
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.
- Specified by:
setEndpoint
in interfaceAmazonAutoScaling
- Parameters:
endpoint
- 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.
-
setRegion
Description copied from interface:AmazonAutoScaling
An alternative toAmazonAutoScaling.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.
- Specified by:
setRegion
in interfaceAmazonAutoScaling
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
-
attachInstances
Description copied from interface:AmazonAutoScaling
Attaches one or more EC2 instances to the specified Auto Scaling group.
When you attach instances, 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.
For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Auto Scaling Developer Guide.
- Specified by:
attachInstances
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the AttachInstances operation returned by the service.
-
attachLoadBalancers
Description copied from interface:AmazonAutoScaling
Attaches one or more load balancers to the specified Auto Scaling group.
To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers.
For more information, see Attach a Load Balancer to Your Auto Scaling Group in the Auto Scaling Developer Guide.
- Specified by:
attachLoadBalancers
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the AttachLoadBalancers operation returned by the service.
-
attachLoadBalancers
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the AttachLoadBalancers operation.- Specified by:
attachLoadBalancers
in interfaceAmazonAutoScaling
- See Also:
-
completeLifecycleAction
public CompleteLifecycleActionResult completeLifecycleAction(CompleteLifecycleActionRequest request) Description copied from interface:AmazonAutoScaling
Completes 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 Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.
- (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.
- Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
- If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.
- If you finish before the timeout period ends, complete the lifecycle action.
For more information, see Auto Scaling Lifecycle in the Auto Scaling Developer Guide.
- Specified by:
completeLifecycleAction
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the CompleteLifecycleAction operation returned by the service.
-
createAutoScalingGroup
Description copied from interface:AmazonAutoScaling
Creates an Auto Scaling group with the specified name and attributes.
If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see DescribeAccountLimits.
For more information, see Auto Scaling Groups in the Auto Scaling Developer Guide.
- Specified by:
createAutoScalingGroup
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the CreateAutoScalingGroup operation returned by the service.
-
createLaunchConfiguration
public CreateLaunchConfigurationResult createLaunchConfiguration(CreateLaunchConfigurationRequest request) Description copied from interface:AmazonAutoScaling
Creates a launch configuration.
If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating this limit, see DescribeAccountLimits.
For more information, see Launch Configurations in the Auto Scaling Developer Guide.
- Specified by:
createLaunchConfiguration
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the CreateLaunchConfiguration operation returned by the service.
-
createOrUpdateTags
Description copied from interface:AmazonAutoScaling
Creates 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 Tagging Auto Scaling Groups and Instances in the Auto Scaling Developer Guide.
- Specified by:
createOrUpdateTags
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the CreateOrUpdateTags operation returned by the service.
-
deleteAutoScalingGroup
Description copied from interface:AmazonAutoScaling
Deletes 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.
If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.
To remove instances from the Auto Scaling group before deleting it, call DetachInstances with the list of instances and the option to decrement the desired capacity so that Auto Scaling does not launch replacement instances.
To terminate all instances before deleting the Auto Scaling group, call UpdateAutoScalingGroup and set the minimum size and desired capacity of the Auto Scaling group to zero.
- Specified by:
deleteAutoScalingGroup
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DeleteAutoScalingGroup operation returned by the service.
-
deleteLaunchConfiguration
public DeleteLaunchConfigurationResult deleteLaunchConfiguration(DeleteLaunchConfigurationRequest request) Description copied from interface:AmazonAutoScaling
Deletes 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.
- Specified by:
deleteLaunchConfiguration
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DeleteLaunchConfiguration operation returned by the service.
-
deleteLifecycleHook
Description copied from interface:AmazonAutoScaling
Deletes the specified lifecycle hook.
If there are any outstanding lifecycle actions, they are completed first (
ABANDON
for launching instances,CONTINUE
for terminating instances).- Specified by:
deleteLifecycleHook
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DeleteLifecycleHook operation returned by the service.
-
deleteNotificationConfiguration
public DeleteNotificationConfigurationResult deleteNotificationConfiguration(DeleteNotificationConfigurationRequest request) Description copied from interface:AmazonAutoScaling
Deletes the specified notification.
- Specified by:
deleteNotificationConfiguration
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DeleteNotificationConfiguration operation returned by the service.
-
deletePolicy
Description copied from interface:AmazonAutoScaling
Deletes the specified Auto Scaling policy.
Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.
- Specified by:
deletePolicy
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DeletePolicy operation returned by the service.
-
deleteScheduledAction
Description copied from interface:AmazonAutoScaling
Deletes the specified scheduled action.
- Specified by:
deleteScheduledAction
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DeleteScheduledAction operation returned by the service.
-
deleteTags
Description copied from interface:AmazonAutoScaling
Deletes the specified tags.
- Specified by:
deleteTags
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DeleteTags operation returned by the service.
-
describeAccountLimits
Description copied from interface:AmazonAutoScaling
Describes the current Auto Scaling resource limits for your AWS account.
For information about requesting an increase in these limits, see AWS Service Limits in the Amazon Web Services General Reference.
- Specified by:
describeAccountLimits
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeAccountLimits operation returned by the service.
-
describeAccountLimits
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the DescribeAccountLimits operation.- Specified by:
describeAccountLimits
in interfaceAmazonAutoScaling
- See Also:
-
describeAdjustmentTypes
public DescribeAdjustmentTypesResult describeAdjustmentTypes(DescribeAdjustmentTypesRequest request) Description copied from interface:AmazonAutoScaling
Describes the policy adjustment types for use with PutScalingPolicy.
- Specified by:
describeAdjustmentTypes
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeAdjustmentTypes operation returned by the service.
-
describeAdjustmentTypes
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the DescribeAdjustmentTypes operation.- Specified by:
describeAdjustmentTypes
in interfaceAmazonAutoScaling
- See Also:
-
describeAutoScalingGroups
public DescribeAutoScalingGroupsResult describeAutoScalingGroups(DescribeAutoScalingGroupsRequest request) Description copied from interface:AmazonAutoScaling
Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups.
- Specified by:
describeAutoScalingGroups
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeAutoScalingGroups operation returned by the service.
-
describeAutoScalingGroups
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the DescribeAutoScalingGroups operation.- Specified by:
describeAutoScalingGroups
in interfaceAmazonAutoScaling
- See Also:
-
describeAutoScalingInstances
public DescribeAutoScalingInstancesResult describeAutoScalingInstances(DescribeAutoScalingInstancesRequest request) Description copied from interface:AmazonAutoScaling
Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances.
- Specified by:
describeAutoScalingInstances
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeAutoScalingInstances operation returned by the service.
-
describeAutoScalingInstances
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the DescribeAutoScalingInstances operation.- Specified by:
describeAutoScalingInstances
in interfaceAmazonAutoScaling
- See Also:
-
describeAutoScalingNotificationTypes
public DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest request) Description copied from interface:AmazonAutoScaling
Describes the notification types that are supported by Auto Scaling.
- Specified by:
describeAutoScalingNotificationTypes
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeAutoScalingNotificationTypes operation returned by the service.
-
describeAutoScalingNotificationTypes
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the DescribeAutoScalingNotificationTypes operation.- Specified by:
describeAutoScalingNotificationTypes
in interfaceAmazonAutoScaling
- See Also:
-
describeLaunchConfigurations
public DescribeLaunchConfigurationsResult describeLaunchConfigurations(DescribeLaunchConfigurationsRequest request) Description copied from interface:AmazonAutoScaling
Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations.
- Specified by:
describeLaunchConfigurations
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeLaunchConfigurations operation returned by the service.
-
describeLaunchConfigurations
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the DescribeLaunchConfigurations operation.- Specified by:
describeLaunchConfigurations
in interfaceAmazonAutoScaling
- See Also:
-
describeLifecycleHookTypes
public DescribeLifecycleHookTypesResult describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest request) Description copied from interface:AmazonAutoScaling
Describes the available types of lifecycle hooks.
- Specified by:
describeLifecycleHookTypes
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeLifecycleHookTypes operation returned by the service.
-
describeLifecycleHookTypes
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the DescribeLifecycleHookTypes operation.- Specified by:
describeLifecycleHookTypes
in interfaceAmazonAutoScaling
- See Also:
-
describeLifecycleHooks
Description copied from interface:AmazonAutoScaling
Describes the lifecycle hooks for the specified Auto Scaling group.
- Specified by:
describeLifecycleHooks
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeLifecycleHooks operation returned by the service.
-
describeLoadBalancers
Description copied from interface:AmazonAutoScaling
Describes the load balancers for the specified Auto Scaling group.
- Specified by:
describeLoadBalancers
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeLoadBalancers operation returned by the service.
-
describeMetricCollectionTypes
public DescribeMetricCollectionTypesResult describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest request) Description copied from interface:AmazonAutoScaling
Describes the available CloudWatch metrics for Auto Scaling.
Note that the
GroupStandbyInstances
metric is not returned by default. You must explicitly request this metric when calling EnableMetricsCollection.- Specified by:
describeMetricCollectionTypes
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeMetricCollectionTypes operation returned by the service.
-
describeMetricCollectionTypes
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the DescribeMetricCollectionTypes operation.- Specified by:
describeMetricCollectionTypes
in interfaceAmazonAutoScaling
- See Also:
-
describeNotificationConfigurations
public DescribeNotificationConfigurationsResult describeNotificationConfigurations(DescribeNotificationConfigurationsRequest request) Description copied from interface:AmazonAutoScaling
Describes the notification actions associated with the specified Auto Scaling group.
- Specified by:
describeNotificationConfigurations
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeNotificationConfigurations operation returned by the service.
-
describeNotificationConfigurations
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the DescribeNotificationConfigurations operation.- Specified by:
describeNotificationConfigurations
in interfaceAmazonAutoScaling
- See Also:
-
describePolicies
Description copied from interface:AmazonAutoScaling
Describes the policies for the specified Auto Scaling group.
- Specified by:
describePolicies
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribePolicies operation returned by the service.
-
describePolicies
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the DescribePolicies operation.- Specified by:
describePolicies
in interfaceAmazonAutoScaling
- See Also:
-
describeScalingActivities
public DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest request) Description copied from interface:AmazonAutoScaling
Describes one or more scaling activities for the specified Auto Scaling group. If you omit the
ActivityIds
, the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list.- Specified by:
describeScalingActivities
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeScalingActivities operation returned by the service.
-
describeScalingActivities
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the DescribeScalingActivities operation.- Specified by:
describeScalingActivities
in interfaceAmazonAutoScaling
- See Also:
-
describeScalingProcessTypes
public DescribeScalingProcessTypesResult describeScalingProcessTypes(DescribeScalingProcessTypesRequest request) Description copied from interface:AmazonAutoScaling
Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.
- Specified by:
describeScalingProcessTypes
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeScalingProcessTypes operation returned by the service.
-
describeScalingProcessTypes
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the DescribeScalingProcessTypes operation.- Specified by:
describeScalingProcessTypes
in interfaceAmazonAutoScaling
- See Also:
-
describeScheduledActions
public DescribeScheduledActionsResult describeScheduledActions(DescribeScheduledActionsRequest request) Description copied from interface:AmazonAutoScaling
Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities.
- Specified by:
describeScheduledActions
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeScheduledActions operation returned by the service.
-
describeScheduledActions
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the DescribeScheduledActions operation.- Specified by:
describeScheduledActions
in interfaceAmazonAutoScaling
- See Also:
-
describeTags
Description copied from interface:AmazonAutoScaling
Describes 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.
- Specified by:
describeTags
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeTags operation returned by the service.
-
describeTags
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the DescribeTags operation.- Specified by:
describeTags
in interfaceAmazonAutoScaling
- See Also:
-
describeTerminationPolicyTypes
public DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest request) Description copied from interface:AmazonAutoScaling
Describes the termination policies supported by Auto Scaling.
- Specified by:
describeTerminationPolicyTypes
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeTerminationPolicyTypes operation returned by the service.
-
describeTerminationPolicyTypes
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the DescribeTerminationPolicyTypes operation.- Specified by:
describeTerminationPolicyTypes
in interfaceAmazonAutoScaling
- See Also:
-
detachInstances
Description copied from interface:AmazonAutoScaling
Removes one or more instances from the specified Auto Scaling group.
After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.
If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached.
For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Auto Scaling Developer Guide.
- Specified by:
detachInstances
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DetachInstances operation returned by the service.
-
detachLoadBalancers
Description copied from interface:AmazonAutoScaling
Removes one or more load balancers from the specified Auto Scaling group.
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 DescribeLoadBalancers. Note that the instances remain running.- Specified by:
detachLoadBalancers
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DetachLoadBalancers operation returned by the service.
-
detachLoadBalancers
Description copied from interface:AmazonAutoScaling
Simplified method form for invoking the DetachLoadBalancers operation.- Specified by:
detachLoadBalancers
in interfaceAmazonAutoScaling
- See Also:
-
disableMetricsCollection
public DisableMetricsCollectionResult disableMetricsCollection(DisableMetricsCollectionRequest request) Description copied from interface:AmazonAutoScaling
Disables monitoring of the specified metrics for the specified Auto Scaling group.
- Specified by:
disableMetricsCollection
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the DisableMetricsCollection operation returned by the service.
-
enableMetricsCollection
public EnableMetricsCollectionResult enableMetricsCollection(EnableMetricsCollectionRequest request) Description copied from interface:AmazonAutoScaling
Enables monitoring of the specified metrics for the specified Auto Scaling group.
You can only enable metrics collection if
InstanceMonitoring
in the launch configuration for the group is set toTrue
.- Specified by:
enableMetricsCollection
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the EnableMetricsCollection operation returned by the service.
-
enterStandby
Description copied from interface:AmazonAutoScaling
Moves the specified instances into
Standby
mode.For more information, see Auto Scaling Lifecycle in the Auto Scaling Developer Guide.
- Specified by:
enterStandby
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the EnterStandby operation returned by the service.
-
executePolicy
Description copied from interface:AmazonAutoScaling
Executes the specified policy.
- Specified by:
executePolicy
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the ExecutePolicy operation returned by the service.
-
exitStandby
Description copied from interface:AmazonAutoScaling
Moves the specified instances out of
Standby
mode.For more information, see Auto Scaling Lifecycle in the Auto Scaling Developer Guide.
- Specified by:
exitStandby
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the ExitStandby operation returned by the service.
-
putLifecycleHook
Description copied from interface:AmazonAutoScaling
Creates or updates a lifecycle hook for the specified Auto Scaling Group.
A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
- (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.
- (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.
- Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
- If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.
- If you finish before the timeout period ends, complete the lifecycle action.
For more information, see Auto Scaling Lifecycle in the Auto Scaling Developer Guide.
If you exceed your maximum limit of lifecycle hooks, which by default is 50 per region, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.
- Specified by:
putLifecycleHook
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the PutLifecycleHook operation returned by the service.
-
putNotificationConfiguration
public PutNotificationConfigurationResult putNotificationConfiguration(PutNotificationConfigurationRequest request) Description copied from interface:AmazonAutoScaling
Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to this topic can have messages for events delivered to an endpoint such as a web server or email address.
For more information see Getting Notifications When Your Auto Scaling Group Changes in the Auto Scaling Developer Guide.
This configuration overwrites an existing configuration.
- Specified by:
putNotificationConfiguration
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the PutNotificationConfiguration operation returned by the service.
-
putScalingPolicy
Description copied from interface:AmazonAutoScaling
Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.
If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.
- Specified by:
putScalingPolicy
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the PutScalingPolicy operation returned by the service.
-
putScheduledUpdateGroupAction
public PutScheduledUpdateGroupActionResult putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest request) Description copied from interface:AmazonAutoScaling
Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group.
For more information, see Scheduled Scaling in the Auto Scaling Developer Guide.
- Specified by:
putScheduledUpdateGroupAction
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the PutScheduledUpdateGroupAction operation returned by the service.
-
recordLifecycleActionHeartbeat
public RecordLifecycleActionHeartbeatResult recordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest request) Description copied from interface:AmazonAutoScaling
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 PutLifecycleHook.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
- (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.
- (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.
- Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
- If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.
- If you finish before the timeout period ends, complete the lifecycle action.
For more information, see Auto Scaling Lifecycle in the Auto Scaling Developer Guide.
- Specified by:
recordLifecycleActionHeartbeat
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the RecordLifecycleActionHeartbeat operation returned by the service.
-
resumeProcesses
Description copied from interface:AmazonAutoScaling
Resumes the specified suspended Auto Scaling processes, or all suspended process, for the specified Auto Scaling group.
For more information, see Suspending and Resuming Auto Scaling Processes in the Auto Scaling Developer Guide.
- Specified by:
resumeProcesses
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the ResumeProcesses operation returned by the service.
-
setDesiredCapacity
Description copied from interface:AmazonAutoScaling
Sets the size of the specified Auto Scaling group.
For more information about desired capacity, see What Is Auto Scaling? in the Auto Scaling Developer Guide.
- Specified by:
setDesiredCapacity
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the SetDesiredCapacity operation returned by the service.
-
setInstanceHealth
Description copied from interface:AmazonAutoScaling
Sets the health status of the specified instance.
For more information, see Health Checks in the Auto Scaling Developer Guide.
- Specified by:
setInstanceHealth
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the SetInstanceHealth operation returned by the service.
-
setInstanceProtection
Description copied from interface:AmazonAutoScaling
Updates the instance protection settings of the specified instances.
For more information, see Instance Protection in the Auto Scaling Developer Guide.
- Specified by:
setInstanceProtection
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the SetInstanceProtection operation returned by the service.
-
suspendProcesses
Description copied from interface:AmazonAutoScaling
Suspends the specified Auto Scaling processes, or all processes, for the specified Auto Scaling group.
Note that if you suspend either the
Launch
orTerminate
process types, it can prevent other process types from functioning properly.To resume processes that have been suspended, use ResumeProcesses.
For more information, see Suspending and Resuming Auto Scaling Processes in the Auto Scaling Developer Guide.
- Specified by:
suspendProcesses
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the SuspendProcesses operation returned by the service.
-
terminateInstanceInAutoScalingGroup
public TerminateInstanceInAutoScalingGroupResult terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest request) Description copied from interface:AmazonAutoScaling
Terminates the specified instance and optionally adjusts the desired group size.
This call simply makes a termination request. The instance is not terminated immediately.
- Specified by:
terminateInstanceInAutoScalingGroup
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the TerminateInstanceInAutoScalingGroup operation returned by the service.
-
updateAutoScalingGroup
Description copied from interface:AmazonAutoScaling
Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group with a launch configuration with
InstanceMonitoring
set toFalse
, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection.The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected.
Note the following:
-
If you specify a new value for
MinSize
without specifying a value forDesiredCapacity
, and the newMinSize
is larger than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value ofMinSize
. -
If you specify a new value for
MaxSize
without specifying a value forDesiredCapacity
, and the newMaxSize
is smaller than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value ofMaxSize
. -
All other optional parameters are left unchanged if not specified.
- Specified by:
updateAutoScalingGroup
in interfaceAmazonAutoScaling
- Parameters:
request
-- Returns:
- Result of the UpdateAutoScalingGroup operation returned by the service.
-
-
shutdown
public void shutdown()Description copied from interface:AmazonAutoScaling
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.- Specified by:
shutdown
in interfaceAmazonAutoScaling
-
getCachedResponseMetadata
Description copied from interface:AmazonAutoScaling
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response 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.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonAutoScaling
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-