Interface AutoScalingPlansClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Use AWS Auto Scaling to create scaling plans for your applications to automatically scale your scalable AWS resources.
API Summary
You can use the AWS Auto Scaling service API to accomplish the following tasks:
-
Create and manage scaling plans
-
Define target tracking scaling policies to dynamically scale your resources based on utilization
-
Scale Amazon EC2 Auto Scaling groups using predictive scaling and dynamic scaling to scale your Amazon EC2 capacity faster
-
Set minimum and maximum capacity limits
-
Retrieve information on existing scaling plans
-
Access current forecast data and historical forecast data for up to 56 days previous
To learn more about AWS Auto Scaling, including information about granting IAM users required permissions for AWS Auto Scaling actions, see the AWS Auto Scaling User Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aAutoScalingPlansClient
.static AutoScalingPlansClient
create()
Create aAutoScalingPlansClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateScalingPlanResponse
createScalingPlan
(Consumer<CreateScalingPlanRequest.Builder> createScalingPlanRequest) Creates a scaling plan.default CreateScalingPlanResponse
createScalingPlan
(CreateScalingPlanRequest createScalingPlanRequest) Creates a scaling plan.default DeleteScalingPlanResponse
deleteScalingPlan
(Consumer<DeleteScalingPlanRequest.Builder> deleteScalingPlanRequest) Deletes the specified scaling plan.default DeleteScalingPlanResponse
deleteScalingPlan
(DeleteScalingPlanRequest deleteScalingPlanRequest) Deletes the specified scaling plan.describeScalingPlanResources
(Consumer<DescribeScalingPlanResourcesRequest.Builder> describeScalingPlanResourcesRequest) Describes the scalable resources in the specified scaling plan.describeScalingPlanResources
(DescribeScalingPlanResourcesRequest describeScalingPlanResourcesRequest) Describes the scalable resources in the specified scaling plan.default DescribeScalingPlansResponse
Describes one or more of your scaling plans.default DescribeScalingPlansResponse
describeScalingPlans
(Consumer<DescribeScalingPlansRequest.Builder> describeScalingPlansRequest) Describes one or more of your scaling plans.default DescribeScalingPlansResponse
describeScalingPlans
(DescribeScalingPlansRequest describeScalingPlansRequest) Describes one or more of your scaling plans.getScalingPlanResourceForecastData
(Consumer<GetScalingPlanResourceForecastDataRequest.Builder> getScalingPlanResourceForecastDataRequest) Retrieves the forecast data for a scalable resource.getScalingPlanResourceForecastData
(GetScalingPlanResourceForecastDataRequest getScalingPlanResourceForecastDataRequest) Retrieves the forecast data for a scalable resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default UpdateScalingPlanResponse
updateScalingPlan
(Consumer<UpdateScalingPlanRequest.Builder> updateScalingPlanRequest) Updates the specified scaling plan.default UpdateScalingPlanResponse
updateScalingPlan
(UpdateScalingPlanRequest updateScalingPlanRequest) Updates the specified scaling plan.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createScalingPlan
default CreateScalingPlanResponse createScalingPlan(CreateScalingPlanRequest createScalingPlanRequest) throws ValidationException, LimitExceededException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException Creates a scaling plan.
- Parameters:
createScalingPlanRequest
-- Returns:
- Result of the CreateScalingPlan operation returned by the service.
- See Also:
-
createScalingPlan
default CreateScalingPlanResponse createScalingPlan(Consumer<CreateScalingPlanRequest.Builder> createScalingPlanRequest) throws ValidationException, LimitExceededException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException Creates a scaling plan.
This is a convenience which creates an instance of the
CreateScalingPlanRequest.Builder
avoiding the need to create one manually viaCreateScalingPlanRequest.builder()
- Parameters:
createScalingPlanRequest
- AConsumer
that will call methods onCreateScalingPlanRequest.Builder
to create a request.- Returns:
- Result of the CreateScalingPlan operation returned by the service.
- See Also:
-
deleteScalingPlan
default DeleteScalingPlanResponse deleteScalingPlan(DeleteScalingPlanRequest deleteScalingPlanRequest) throws ValidationException, ObjectNotFoundException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException Deletes the specified scaling plan.
Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan.
If the plan has launched resources or has scaling activities in progress, you must delete those resources separately.
- Parameters:
deleteScalingPlanRequest
-- Returns:
- Result of the DeleteScalingPlan operation returned by the service.
- See Also:
-
deleteScalingPlan
default DeleteScalingPlanResponse deleteScalingPlan(Consumer<DeleteScalingPlanRequest.Builder> deleteScalingPlanRequest) throws ValidationException, ObjectNotFoundException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException Deletes the specified scaling plan.
Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan.
If the plan has launched resources or has scaling activities in progress, you must delete those resources separately.
This is a convenience which creates an instance of the
DeleteScalingPlanRequest.Builder
avoiding the need to create one manually viaDeleteScalingPlanRequest.builder()
- Parameters:
deleteScalingPlanRequest
- AConsumer
that will call methods onDeleteScalingPlanRequest.Builder
to create a request.- Returns:
- Result of the DeleteScalingPlan operation returned by the service.
- See Also:
-
describeScalingPlanResources
default DescribeScalingPlanResourcesResponse describeScalingPlanResources(DescribeScalingPlanResourcesRequest describeScalingPlanResourcesRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException Describes the scalable resources in the specified scaling plan.
- Parameters:
describeScalingPlanResourcesRequest
-- Returns:
- Result of the DescribeScalingPlanResources operation returned by the service.
- See Also:
-
describeScalingPlanResources
default DescribeScalingPlanResourcesResponse describeScalingPlanResources(Consumer<DescribeScalingPlanResourcesRequest.Builder> describeScalingPlanResourcesRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException Describes the scalable resources in the specified scaling plan.
This is a convenience which creates an instance of the
DescribeScalingPlanResourcesRequest.Builder
avoiding the need to create one manually viaDescribeScalingPlanResourcesRequest.builder()
- Parameters:
describeScalingPlanResourcesRequest
- AConsumer
that will call methods onDescribeScalingPlanResourcesRequest.Builder
to create a request.- Returns:
- Result of the DescribeScalingPlanResources operation returned by the service.
- See Also:
-
describeScalingPlans
default DescribeScalingPlansResponse describeScalingPlans(DescribeScalingPlansRequest describeScalingPlansRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException Describes one or more of your scaling plans.
- Parameters:
describeScalingPlansRequest
-- Returns:
- Result of the DescribeScalingPlans operation returned by the service.
- See Also:
-
describeScalingPlans
default DescribeScalingPlansResponse describeScalingPlans(Consumer<DescribeScalingPlansRequest.Builder> describeScalingPlansRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException Describes one or more of your scaling plans.
This is a convenience which creates an instance of the
DescribeScalingPlansRequest.Builder
avoiding the need to create one manually viaDescribeScalingPlansRequest.builder()
- Parameters:
describeScalingPlansRequest
- AConsumer
that will call methods onDescribeScalingPlansRequest.Builder
to create a request.- Returns:
- Result of the DescribeScalingPlans operation returned by the service.
- See Also:
-
describeScalingPlans
default DescribeScalingPlansResponse describeScalingPlans() throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansExceptionDescribes one or more of your scaling plans.
- Returns:
- Result of the DescribeScalingPlans operation returned by the service.
- See Also:
-
getScalingPlanResourceForecastData
default GetScalingPlanResourceForecastDataResponse getScalingPlanResourceForecastData(GetScalingPlanResourceForecastDataRequest getScalingPlanResourceForecastDataRequest) throws ValidationException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException Retrieves the forecast data for a scalable resource.
Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days.
- Parameters:
getScalingPlanResourceForecastDataRequest
-- Returns:
- Result of the GetScalingPlanResourceForecastData operation returned by the service.
- See Also:
-
getScalingPlanResourceForecastData
default GetScalingPlanResourceForecastDataResponse getScalingPlanResourceForecastData(Consumer<GetScalingPlanResourceForecastDataRequest.Builder> getScalingPlanResourceForecastDataRequest) throws ValidationException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException Retrieves the forecast data for a scalable resource.
Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days.
This is a convenience which creates an instance of the
GetScalingPlanResourceForecastDataRequest.Builder
avoiding the need to create one manually viaGetScalingPlanResourceForecastDataRequest.builder()
- Parameters:
getScalingPlanResourceForecastDataRequest
- AConsumer
that will call methods onGetScalingPlanResourceForecastDataRequest.Builder
to create a request.- Returns:
- Result of the GetScalingPlanResourceForecastData operation returned by the service.
- See Also:
-
updateScalingPlan
default UpdateScalingPlanResponse updateScalingPlan(UpdateScalingPlanRequest updateScalingPlanRequest) throws ValidationException, ConcurrentUpdateException, InternalServiceException, ObjectNotFoundException, AwsServiceException, SdkClientException, AutoScalingPlansException Updates the specified scaling plan.
You cannot update a scaling plan if it is in the process of being created, updated, or deleted.
- Parameters:
updateScalingPlanRequest
-- Returns:
- Result of the UpdateScalingPlan operation returned by the service.
- See Also:
-
updateScalingPlan
default UpdateScalingPlanResponse updateScalingPlan(Consumer<UpdateScalingPlanRequest.Builder> updateScalingPlanRequest) throws ValidationException, ConcurrentUpdateException, InternalServiceException, ObjectNotFoundException, AwsServiceException, SdkClientException, AutoScalingPlansException Updates the specified scaling plan.
You cannot update a scaling plan if it is in the process of being created, updated, or deleted.
This is a convenience which creates an instance of the
UpdateScalingPlanRequest.Builder
avoiding the need to create one manually viaUpdateScalingPlanRequest.builder()
- Parameters:
updateScalingPlanRequest
- AConsumer
that will call methods onUpdateScalingPlanRequest.Builder
to create a request.- Returns:
- Result of the UpdateScalingPlan operation returned by the service.
- See Also:
-
create
Create aAutoScalingPlansClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAutoScalingPlansClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-