@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSApplicationAutoScaling extends Object implements AWSApplicationAutoScaling
AWSApplicationAutoScaling. 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 |
|---|---|
DeleteScalingPolicyResult |
deleteScalingPolicy(DeleteScalingPolicyRequest request)
Deletes the specified scaling policy for an Application Auto Scaling scalable target.
|
DeleteScheduledActionResult |
deleteScheduledAction(DeleteScheduledActionRequest request)
Deletes the specified scheduled action for an Application Auto Scaling scalable target.
|
DeregisterScalableTargetResult |
deregisterScalableTarget(DeregisterScalableTargetRequest request)
Deregisters an Application Auto Scaling scalable target when you have finished using it.
|
DescribeScalableTargetsResult |
describeScalableTargets(DescribeScalableTargetsRequest request)
Gets information about the scalable targets in the specified namespace.
|
DescribeScalingActivitiesResult |
describeScalingActivities(DescribeScalingActivitiesRequest request)
Provides descriptive information about the scaling activities in the specified namespace from the previous six
weeks.
|
DescribeScalingPoliciesResult |
describeScalingPolicies(DescribeScalingPoliciesRequest request)
Describes the Application Auto Scaling scaling policies for the specified service namespace.
|
DescribeScheduledActionsResult |
describeScheduledActions(DescribeScheduledActionsRequest request)
Describes the Application Auto Scaling scheduled actions for the specified service namespace.
|
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.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns all the tags on the specified Application Auto Scaling scalable target.
|
PutScalingPolicyResult |
putScalingPolicy(PutScalingPolicyRequest request)
Creates or updates a scaling policy for an Application Auto Scaling scalable target.
|
PutScheduledActionResult |
putScheduledAction(PutScheduledActionRequest request)
Creates or updates a scheduled action for an Application Auto Scaling scalable target.
|
RegisterScalableTargetResult |
registerScalableTarget(RegisterScalableTargetRequest request)
Registers or updates a scalable target, which is the resource that you want to scale.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://application-autoscaling.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSApplicationAutoScaling.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.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds or edits tags on an Application Auto Scaling scalable target.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Deletes tags from an Application Auto Scaling scalable target.
|
public void setEndpoint(String endpoint)
AWSApplicationAutoScaling
Callers can pass in just the endpoint (ex: "application-autoscaling.us-east-1.amazonaws.com") or a full URL,
including the protocol (ex: "https://application-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: 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 AWSApplicationAutoScalingendpoint - The endpoint (ex: "application-autoscaling.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://application-autoscaling.us-east-1.amazonaws.com") of the region specific AWS endpoint this
client will communicate with.public void setRegion(Region region)
AWSApplicationAutoScalingAWSApplicationAutoScaling.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 AWSApplicationAutoScalingregion - 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 DeleteScalingPolicyResult deleteScalingPolicy(DeleteScalingPolicyRequest request)
AWSApplicationAutoScalingDeletes the specified scaling policy for an Application Auto Scaling scalable target.
Deleting a step scaling policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.
For more information, see Delete a step scaling policy and Delete a target tracking scaling policy in the Application Auto Scaling User Guide.
deleteScalingPolicy in interface AWSApplicationAutoScalingpublic DeleteScheduledActionResult deleteScheduledAction(DeleteScheduledActionRequest request)
AWSApplicationAutoScalingDeletes the specified scheduled action for an Application Auto Scaling scalable target.
For more information, see Delete a scheduled action in the Application Auto Scaling User Guide.
deleteScheduledAction in interface AWSApplicationAutoScalingpublic DeregisterScalableTargetResult deregisterScalableTarget(DeregisterScalableTargetRequest request)
AWSApplicationAutoScalingDeregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use DescribeScalableTargets.
Deregistering a scalable target deletes the scaling policies and the scheduled actions that are associated with it.
deregisterScalableTarget in interface AWSApplicationAutoScalingpublic DescribeScalableTargetsResult describeScalableTargets(DescribeScalableTargetsRequest request)
AWSApplicationAutoScalingGets information about the scalable targets in the specified namespace.
You can filter the results using ResourceIds and ScalableDimension.
describeScalableTargets in interface AWSApplicationAutoScalingpublic DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest request)
AWSApplicationAutoScalingProvides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
You can filter the results using ResourceId and ScalableDimension.
For information about viewing scaling activities using the Amazon Web Services CLI, see Scaling activities for Application Auto Scaling.
describeScalingActivities in interface AWSApplicationAutoScalingpublic DescribeScalingPoliciesResult describeScalingPolicies(DescribeScalingPoliciesRequest request)
AWSApplicationAutoScalingDescribes the Application Auto Scaling scaling policies for the specified service namespace.
You can filter the results using ResourceId, ScalableDimension, and
PolicyNames.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
describeScalingPolicies in interface AWSApplicationAutoScalingpublic DescribeScheduledActionsResult describeScheduledActions(DescribeScheduledActionsRequest request)
AWSApplicationAutoScalingDescribes the Application Auto Scaling scheduled actions for the specified service namespace.
You can filter the results using the ResourceId, ScalableDimension, and
ScheduledActionNames parameters.
For more information, see Scheduled scaling and Managing scheduled scaling in the Application Auto Scaling User Guide.
describeScheduledActions in interface AWSApplicationAutoScalingpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSApplicationAutoScalingReturns all the tags on the specified Application Auto Scaling scalable target.
For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
listTagsForResource in interface AWSApplicationAutoScalingpublic PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest request)
AWSApplicationAutoScalingCreates or updates a scaling policy for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target.
Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30.
We recommend caution, however, when using target tracking scaling policies with step scaling policies because conflicts between these policies can cause undesirable behavior. For example, if the step scaling policy initiates a scale-in activity before the target tracking policy is ready to scale in, the scale-in activity will not be blocked. After the scale-in activity completes, the target tracking policy could instruct the scalable target to scale out again.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
If a scalable target is deregistered, the scalable target is no longer available to use scaling policies. Any scaling policies that were specified for the scalable target are deleted.
putScalingPolicy in interface AWSApplicationAutoScalingpublic PutScheduledActionResult putScheduledAction(PutScheduledActionRequest request)
AWSApplicationAutoScalingCreates or updates a scheduled action for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target.
When you specify start and end times with a recurring schedule using a cron expression or rates, they form the boundaries for when the recurring action starts and stops.
To update a scheduled action, specify the parameters that you want to change. If you don't specify start and end times, the old values are deleted.
For more information, see Scheduled scaling in the Application Auto Scaling User Guide.
If a scalable target is deregistered, the scalable target is no longer available to run scheduled actions. Any scheduled actions that were specified for the scalable target are deleted.
putScheduledAction in interface AWSApplicationAutoScalingpublic RegisterScalableTargetResult registerScalableTarget(RegisterScalableTargetRequest request)
AWSApplicationAutoScalingRegisters or updates a scalable target, which is the resource that you want to scale.
Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace, which represents some capacity dimension of the underlying service.
When you register a new scalable target, you must specify values for the minimum and maximum capacity. If the specified resource is not active in the target service, this operation does not change the resource's current capacity. Otherwise, it changes the resource's current capacity to a value that is inside of this range.
If you add a scaling policy, current capacity is adjustable within the specified range when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are outside of the minimum and maximum range.
After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget.
To update a scalable target, specify the parameters that you want to change. Include the parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request.
If you call the RegisterScalableTarget API operation to create a scalable target, there might be a
brief delay until the operation achieves eventual
consistency. You might become aware of this brief delay if you get unexpected errors when performing
sequential operations. The typical strategy is to retry the request, and some Amazon Web Services SDKs include
automatic backoff and retry logic.
If you call the RegisterScalableTarget API operation to update an existing scalable target,
Application Auto Scaling retrieves the current capacity of the resource. If it's below the minimum capacity or
above the maximum capacity, Application Auto Scaling adjusts the capacity of the scalable target to place it
within these bounds, even if you don't include the MinCapacity or MaxCapacity request
parameters.
registerScalableTarget in interface AWSApplicationAutoScalingpublic TagResourceResult tagResource(TagResourceRequest request)
AWSApplicationAutoScalingAdds or edits tags on an Application Auto Scaling scalable target.
Each tag consists of a tag key and a tag value, which are both case-sensitive strings. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.
You can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a scaling policy or scheduled action.
You can also add tags to an Application Auto Scaling scalable target while creating it (
RegisterScalableTarget).
For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
Use tags to control access to a scalable target. For more information, see Tagging support for Application Auto Scaling in the Application Auto Scaling User Guide.
tagResource in interface AWSApplicationAutoScalingpublic UntagResourceResult untagResource(UntagResourceRequest request)
AWSApplicationAutoScalingDeletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and the Application Auto Scaling scalable target.
untagResource in interface AWSApplicationAutoScalingpublic void shutdown()
AWSApplicationAutoScalingshutdown in interface AWSApplicationAutoScalingpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSApplicationAutoScalingResponse 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 AWSApplicationAutoScalingrequest - The originally executed request.