Class AbstractAWSApplicationAutoScaling
- All Implemented Interfaces:
AWSApplicationAutoScaling
- Direct Known Subclasses:
AbstractAWSApplicationAutoScalingAsync
AWSApplicationAutoScaling
. 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 TypeMethodDescriptionDeletes an Application Auto Scaling scaling policy that was previously created.Deregisters a scalable target that was previously registered.Provides descriptive information for scalable targets with a specified service namespace.Provides descriptive information for scaling activities with a specified service namespace.Provides descriptive information for scaling policies with a specified service namespace.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.putScalingPolicy
(PutScalingPolicyRequest request) Creates or updates a policy for an existing Application Auto Scaling scalable target.Registers or updates a scalable target.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("https://autoscaling.us-east-1.amazonaws.com").void
An alternative toAWSApplicationAutoScaling.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.
-
Constructor Details
-
AbstractAWSApplicationAutoScaling
protected AbstractAWSApplicationAutoScaling()
-
-
Method Details
-
setEndpoint
Description copied from interface:AWSApplicationAutoScaling
Overrides the default endpoint for this client ("https://autoscaling.us-east-1.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.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://autoscaling.us-east-1.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 interfaceAWSApplicationAutoScaling
- Parameters:
endpoint
- The endpoint (ex: "autoscaling.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://autoscaling.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
Description copied from interface:AWSApplicationAutoScaling
An alternative toAWSApplicationAutoScaling.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 interfaceAWSApplicationAutoScaling
- 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:
-
deleteScalingPolicy
Description copied from interface:AWSApplicationAutoScaling
Deletes an Application Auto Scaling scaling policy that was previously created. If you are no longer using a scaling policy, you can delete it with this operation.
Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm, even if it no longer has an associated action.
To create a new scaling policy or update an existing one, see PutScalingPolicy.
- Specified by:
deleteScalingPolicy
in interfaceAWSApplicationAutoScaling
- Parameters:
request
-- Returns:
- Result of the DeleteScalingPolicy operation returned by the service.
-
deregisterScalableTarget
public DeregisterScalableTargetResult deregisterScalableTarget(DeregisterScalableTargetRequest request) Description copied from interface:AWSApplicationAutoScaling
Deregisters a scalable target that was previously registered. If you are no longer using a scalable target, you can delete it with this operation. When you deregister a scalable target, all of the scaling policies that are associated with that scalable target are deleted.
To create a new scalable target or update an existing one, see RegisterScalableTarget.
- Specified by:
deregisterScalableTarget
in interfaceAWSApplicationAutoScaling
- Parameters:
request
-- Returns:
- Result of the DeregisterScalableTarget operation returned by the service.
-
describeScalableTargets
public DescribeScalableTargetsResult describeScalableTargets(DescribeScalableTargetsRequest request) Description copied from interface:AWSApplicationAutoScaling
Provides descriptive information for scalable targets with a specified service namespace.
You can filter the results in a service namespace with the
ResourceIds
andScalableDimension
parameters.To create a new scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it with DeregisterScalableTarget.
- Specified by:
describeScalableTargets
in interfaceAWSApplicationAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeScalableTargets operation returned by the service.
-
describeScalingActivities
public DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest request) Description copied from interface:AWSApplicationAutoScaling
Provides descriptive information for scaling activities with a specified service namespace.
You can filter the results in a service namespace with the
ResourceId
andScalableDimension
parameters.Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the existing scaling policies for a service namespace, see DescribeScalingPolicies. To create a new scaling policy or update an existing one, see PutScalingPolicy.
- Specified by:
describeScalingActivities
in interfaceAWSApplicationAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeScalingActivities operation returned by the service.
-
describeScalingPolicies
public DescribeScalingPoliciesResult describeScalingPolicies(DescribeScalingPoliciesRequest request) Description copied from interface:AWSApplicationAutoScaling
Provides descriptive information for scaling policies with a specified service namespace.
You can filter the results in a service namespace with the
ResourceId
,ScalableDimension
, andPolicyNames
parameters.To create a new scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it with DeleteScalingPolicy.
- Specified by:
describeScalingPolicies
in interfaceAWSApplicationAutoScaling
- Parameters:
request
-- Returns:
- Result of the DescribeScalingPolicies operation returned by the service.
-
putScalingPolicy
Description copied from interface:AWSApplicationAutoScaling
Creates or updates a policy for an existing Application Auto Scaling scalable target. Each scalable target is identified by service namespace, a resource ID, and a scalable dimension, and a scaling policy applies to a scalable target that is identified by those three attributes. You cannot create a scaling policy without first registering a scalable target with RegisterScalableTarget.
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.
You can view the existing scaling policies for a service namespace with DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it with DeleteScalingPolicy.
- Specified by:
putScalingPolicy
in interfaceAWSApplicationAutoScaling
- Parameters:
request
-- Returns:
- Result of the PutScalingPolicy operation returned by the service.
-
registerScalableTarget
Description copied from interface:AWSApplicationAutoScaling
Registers or updates a scalable target. A scalable target is a resource that can be scaled up or down with Application Auto Scaling. After you have registered a scalable target, you can use this command to update the minimum and maximum values for your scalable dimension.
At this time, Application Auto Scaling only supports scaling Amazon ECS services.
After you register a scalable target with Application Auto Scaling, you can create and apply scaling policies to it with PutScalingPolicy. You can view the existing scaling policies for a service namespace with DescribeScalableTargets. If you are no longer using a scalable target, you can deregister it with DeregisterScalableTarget.
- Specified by:
registerScalableTarget
in interfaceAWSApplicationAutoScaling
- Parameters:
request
-- Returns:
- Result of the RegisterScalableTarget operation returned by the service.
-
shutdown
public void shutdown()Description copied from interface:AWSApplicationAutoScaling
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 interfaceAWSApplicationAutoScaling
-
getCachedResponseMetadata
Description copied from interface:AWSApplicationAutoScaling
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 interfaceAWSApplicationAutoScaling
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-