com.amazonaws.services.autoscaling.AmazonAutoScaling Maven / Gradle / Ivy
/*
* Copyright 2010-2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.autoscaling;
import com.amazonaws.*;
import com.amazonaws.services.autoscaling.model.*;
/**
* Interface for accessing AmazonAutoScaling.
*
* Amazon Auto Scaling is an easy-to-use web service designed to
* automatically launch or terminate EC2 instances based on user defined
* triggers. Users can set up Auto Scaling groups and associate triggers
* with these groups to automatically scale computing resources based on
* parameters such as bandwidth usage or CPU utilization. Auto Scaling
* groups can work across multiple Availability Zones - distinct physical
* locations for the hosted EC2 instances - so that if an Availability
* Zone becomes unhealthy or unavailable, Auto Scaling will automatically
* re-distribute applications to a healthy Availability Zone.
*
*/
public 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: "ec2.amazonaws.com") or a full
* URL, including the protocol (ex: "https://ec2.amazonaws.com"). If the
* protocol is not specified here, the default protocol from this client's
* {@link 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
*
* @param endpoint
* The endpoint (ex: "ec2.amazonaws.com") or a full URL,
* including the protocol (ex: "https://ec2.amazonaws.com") of
* the region specific AWS endpoint this client will communicate
* with.
*
* @throws IllegalArgumentException
* If any problems are detected with the specified endpoint.
*/
public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException;
/**
*
* Deletes the specified LaunchConfiguration.
*
*
* The specified LaunchConfiguration must not be currently attached to
* any Auto Scaling group. Once this call completes, the launch
* configuration is no longer available for use.
*
*
* @param deleteLaunchConfigurationRequest Container for the necessary
* parameters to execute the DeleteLaunchConfiguration service method on
* AmazonAutoScaling.
*
* @throws ResourceInUseException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns a full description of the specified AutoScalingGroup's
* triggers.
*
*
* @param describeTriggersRequest Container for the necessary parameters
* to execute the DescribeTriggers service method on AmazonAutoScaling.
*
* @return The response from the DescribeTriggers service method, as
* returned by AmazonAutoScaling.
*
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeTriggersResult describeTriggers(DescribeTriggersRequest describeTriggersRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Updates the configuration for the specified AutoScalingGroup.
*
*
* The new settings are registered upon the completion of this call. Any
* launch configuration settings take effect on any triggers after this
* call returns. Triggers that are currently in progress aren't affected.
*
*
* NOTE: If the new values are specified for the MinSize or
* MaxSize parameters, then there will be an implicit call to
* SetDesiredCapacity to set the group to the new MaxSize. All optional
* parameters are left unchanged if not passed in the request.
*
*
* @param updateAutoScalingGroupRequest Container for the necessary
* parameters to execute the UpdateAutoScalingGroup service method on
* AmazonAutoScaling.
*
* @throws ScalingActivityInProgressException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Creates a new Auto Scaling group with the specified name. Once the
* creation request is completed, the AutoScalingGroup is ready to be
* used in other calls.
*
*
* NOTE: The client must not have already used up their entire
* quota of AutoScaling groups in order for this call to be successful.
*
*
* @param createAutoScalingGroupRequest Container for the necessary
* parameters to execute the CreateAutoScalingGroup service method on
* AmazonAutoScaling.
*
* @throws LimitExceededException
* @throws AlreadyExistsException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Deletes the specified trigger.
*
*
* If a trigger is currently in progress, the trigger continues to run
* until its activities complete.
*
*
* @param deleteTriggerRequest Container for the necessary parameters to
* execute the DeleteTrigger service method on AmazonAutoScaling.
*
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteTrigger(DeleteTriggerRequest deleteTriggerRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Terminates the specified instance. Optionally, the desired group size
* can be adjusted.
*
*
* NOTE: This call simply registers a termination request. The
* termination of the instance cannot happen immediately.
*
*
* @param terminateInstanceInAutoScalingGroupRequest Container for the
* necessary parameters to execute the
* TerminateInstanceInAutoScalingGroup service method on
* AmazonAutoScaling.
*
* @return The response from the TerminateInstanceInAutoScalingGroup
* service method, as returned by AmazonAutoScaling.
*
* @throws ScalingActivityInProgressException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public TerminateInstanceInAutoScalingGroupResult terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Sets the parameters that govern how and when to scale an AutoScaling
* group.
*
*
* @param createOrUpdateScalingTriggerRequest Container for the necessary
* parameters to execute the CreateOrUpdateScalingTrigger service method
* on AmazonAutoScaling.
*
* @throws LimitExceededException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void createOrUpdateScalingTrigger(CreateOrUpdateScalingTriggerRequest createOrUpdateScalingTriggerRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns a full description of the AutoScalingGroup instances
* specified in the given list. This includes all Amazon EC2 instances
* that are members of the Auto Scaling group. If a list of names is not
* provided, then the full details of all AutoScalingGroups is returned.
*
*
* @param describeAutoScalingGroupsRequest Container for the necessary
* parameters to execute the DescribeAutoScalingGroups service method on
* AmazonAutoScaling.
*
* @return The response from the DescribeAutoScalingGroups service
* method, as returned by AmazonAutoScaling.
*
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAutoScalingGroupsResult describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Creates a new launch configuration. Once created, the new launch
* configuration is available for immediate use.
*
*
* NOTE: The launch configuration name used must be unique, within
* the scope of the client's AWS account, and the maximum limit of launch
* configurations must not yet have been met, or else the call will fail.
*
*
* @param createLaunchConfigurationRequest Container for the necessary
* parameters to execute the CreateLaunchConfiguration service method on
* AmazonAutoScaling.
*
* @throws LimitExceededException
* @throws AlreadyExistsException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns a full description of the launch configurations given the
* specified names.
*
*
* If no names are specified, then the full details of all launch
* configurations are returned.
*
*
* @param describeLaunchConfigurationsRequest Container for the necessary
* parameters to execute the DescribeLaunchConfigurations service method
* on AmazonAutoScaling.
*
* @return The response from the DescribeLaunchConfigurations service
* method, as returned by AmazonAutoScaling.
*
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLaunchConfigurationsResult describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns the scaling activities for the specified Auto Scaling group.
*
*
* If the specified ActivityIds list is empty, all the activities
* from the past six weeks are returned. Activities will be sorted by
* completion time. Activities that have no completion time are
* considered as using the most recent possible time.
*
*
* @param describeScalingActivitiesRequest Container for the necessary
* parameters to execute the DescribeScalingActivities service method on
* AmazonAutoScaling.
*
* @return The response from the DescribeScalingActivities service
* method, as returned by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Adjusts the desired size of the AutoScalingGroup by initiating
* scaling activities. When reducing the size of the group, it is not
* possible to define which EC2 instances will be terminated. This
* applies to any auto-scaling decisions that might result in the
* termination of instances.
*
*
* @param setDesiredCapacityRequest Container for the necessary
* parameters to execute the SetDesiredCapacity service method on
* AmazonAutoScaling.
*
* @throws ScalingActivityInProgressException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Deletes all configuration for the specified AutoScalingGroup and
* deletes the group.
*
*
* In order to successfully call this API, no triggers can be currently
* in progress. Once this call successfully executes, no further triggers
* will begin, and the specified AutoScalingGroup will not be available
* for use in other API calls.
*
*
* NOTE: The client cannot delete an AutoScalingGroup if it
* contains instances or if there are scaling activities in progress.
* Before attempting to delete an AutoScalingGroup, call the
* UpdateAutoScalingGroup operation to set the minimum and maximum size
* of the AutoScalingGroup to zero. This will remove all instances and
* avoid problems with a previously set trigger preventing the deletion
* of the AutoScalingGroup.
*
*
* @param deleteAutoScalingGroupRequest Container for the necessary
* parameters to execute the DeleteAutoScalingGroup service method on
* AmazonAutoScaling.
*
* @throws ScalingActivityInProgressException
* @throws ResourceInUseException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns a full description of the AutoScalingGroup instances
* specified in the given list. This includes all Amazon EC2 instances
* that are members of the Auto Scaling group. If a list of names is not
* provided, then the full details of all AutoScalingGroups is returned.
*
*
* @return The response from the DescribeAutoScalingGroups service
* method, as returned by AmazonAutoScaling.
*
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAutoScalingGroupsResult describeAutoScalingGroups() throws AmazonServiceException, AmazonClientException;
/**
*
* Returns a full description of the launch configurations given the
* specified names.
*
*
* If no names are specified, then the full details of all launch
* configurations are returned.
*
*
* @return The response from the DescribeLaunchConfigurations service
* method, as returned by AmazonAutoScaling.
*
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLaunchConfigurationsResult describeLaunchConfigurations() throws AmazonServiceException, AmazonClientException;
/**
* 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.
*/
public void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}