com.amazonaws.services.autoscalingplans.model.ScalingInstruction Maven / Gradle / Ivy
Show all versions of aws-java-sdk-autoscalingplans Show documentation
/*
* Copyright 2019-2024 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.autoscalingplans.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Describes a scaling instruction for a scalable resource in a scaling plan. Each scaling instruction applies to one
* resource.
*
*
* AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions. Target tracking scaling
* policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target
* value that you specified.
*
*
* AWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto Scaling groups using a subset of
* parameters, including the load metric, the scaling metric, the target value for the scaling metric, the predictive
* scaling mode (forecast and scale or forecast only), and the desired behavior when the forecast capacity exceeds the
* maximum capacity of the resource. With predictive scaling, AWS Auto Scaling generates forecasts with traffic
* predictions for the two days ahead and schedules scaling actions that proactively add and remove resource capacity to
* match the forecast.
*
*
*
* We recommend waiting a minimum of 24 hours after creating an Auto Scaling group to configure predictive scaling. At
* minimum, there must be 24 hours of historical data to generate a forecast. For more information, see Best Practices for AWS Auto
* Scaling in the AWS Auto Scaling User Guide.
*
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ScalingInstruction implements Serializable, Cloneable, StructuredPojo {
/**
*
* The namespace of the AWS service.
*
*/
private String serviceNamespace;
/**
*
* The ID of the resource. This string consists of the resource type and unique identifier.
*
*
* -
*
* Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of
* the Auto Scaling group. Example: autoScalingGroup/my-asg.
*
*
* -
*
* ECS service - The resource type is service and the unique identifier is the cluster name and service
* name. Example: service/default/sample-webapp.
*
*
* -
*
* Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot
* Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
*
*
* -
*
* DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example:
* table/my-table.
*
*
* -
*
* DynamoDB global secondary index - The resource type is index and the unique identifier is the
* resource ID. Example: table/my-table/index/my-table-index.
*
*
* -
*
* Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
* Example: cluster:my-db-cluster.
*
*
*
*/
private String resourceId;
/**
*
* The scalable dimension associated with the resource.
*
*
* -
*
* autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
*
*
* -
*
* ecs:service:DesiredCount - The desired task count of an ECS service.
*
*
* -
*
* ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
*
*
* -
*
* dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary
* index.
*
*
* -
*
* dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary
* index.
*
*
* -
*
* rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for
* Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
*
*
*
*/
private String scalableDimension;
/**
*
* The minimum capacity of the resource.
*
*/
private Integer minCapacity;
/**
*
* The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting
* for PredictiveScalingMaxCapacityBehavior.
*
*/
private Integer maxCapacity;
/**
*
* The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and
* a target value for the metric.
*
*/
private java.util.List targetTrackingConfigurations;
/**
*
* The predefined load metric to use for predictive scaling. This parameter or a
* CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used
* otherwise.
*
*/
private PredefinedLoadMetricSpecification predefinedLoadMetricSpecification;
/**
*
* The customized load metric to use for predictive scaling. This parameter or a
* PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used
* otherwise.
*
*/
private CustomizedLoadMetricSpecification customizedLoadMetricSpecification;
/**
*
* The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For
* example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of
* the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be
* provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required
* depends on several factors, such as the size of the instance and whether there are startup scripts to complete.
*
*
* The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300
* seconds.
*
*
* Only valid when configuring predictive scaling.
*
*/
private Integer scheduledActionBufferTime;
/**
*
* Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity
* specified for the resource. The default value is SetForecastCapacityToMaxCapacity.
*
*
* The following are possible values:
*
*
* -
*
* SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the
* maximum capacity. The maximum capacity is enforced as a hard limit.
*
*
* -
*
* SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the
* maximum capacity to equal but not exceed forecast capacity.
*
*
* -
*
* SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the
* maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra
* capacity if unexpected traffic occurs.
*
*
*
*
* Only valid when configuring predictive scaling.
*
*/
private String predictiveScalingMaxCapacityBehavior;
/**
*
* The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.
* The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this
* means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the
* effective maximum capacity is 55.
*
*
* Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is
* set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.
*
*
* The range is 1-100.
*
*/
private Integer predictiveScalingMaxCapacityBuffer;
/**
*
* The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling
* forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.
*
*/
private String predictiveScalingMode;
/**
*
* Controls whether a resource's externally created scaling policies are kept or replaced.
*
*
* The default value is KeepExternalPolicies. If the parameter is set to
* ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and
* new target tracking scaling policies created.
*
*
* Only valid when configuring dynamic scaling.
*
*
* Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more
* than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.
*
*/
private String scalingPolicyUpdateBehavior;
/**
*
* Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto
* Scaling creates target tracking scaling policies based on the specified target tracking configurations.
*
*
* The default is enabled (false).
*
*/
private Boolean disableDynamicScaling;
/**
*
* The namespace of the AWS service.
*
*
* @param serviceNamespace
* The namespace of the AWS service.
* @see ServiceNamespace
*/
public void setServiceNamespace(String serviceNamespace) {
this.serviceNamespace = serviceNamespace;
}
/**
*
* The namespace of the AWS service.
*
*
* @return The namespace of the AWS service.
* @see ServiceNamespace
*/
public String getServiceNamespace() {
return this.serviceNamespace;
}
/**
*
* The namespace of the AWS service.
*
*
* @param serviceNamespace
* The namespace of the AWS service.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServiceNamespace
*/
public ScalingInstruction withServiceNamespace(String serviceNamespace) {
setServiceNamespace(serviceNamespace);
return this;
}
/**
*
* The namespace of the AWS service.
*
*
* @param serviceNamespace
* The namespace of the AWS service.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServiceNamespace
*/
public ScalingInstruction withServiceNamespace(ServiceNamespace serviceNamespace) {
this.serviceNamespace = serviceNamespace.toString();
return this;
}
/**
*
* The ID of the resource. This string consists of the resource type and unique identifier.
*
*
* -
*
* Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of
* the Auto Scaling group. Example: autoScalingGroup/my-asg.
*
*
* -
*
* ECS service - The resource type is service and the unique identifier is the cluster name and service
* name. Example: service/default/sample-webapp.
*
*
* -
*
* Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot
* Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
*
*
* -
*
* DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example:
* table/my-table.
*
*
* -
*
* DynamoDB global secondary index - The resource type is index and the unique identifier is the
* resource ID. Example: table/my-table/index/my-table-index.
*
*
* -
*
* Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
* Example: cluster:my-db-cluster.
*
*
*
*
* @param resourceId
* The ID of the resource. This string consists of the resource type and unique identifier.
*
* -
*
* Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the
* name of the Auto Scaling group. Example: autoScalingGroup/my-asg.
*
*
* -
*
* ECS service - The resource type is service and the unique identifier is the cluster name and
* service name. Example: service/default/sample-webapp.
*
*
* -
*
* Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the
* Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
*
*
* -
*
* DynamoDB table - The resource type is table and the unique identifier is the resource ID.
* Example: table/my-table.
*
*
* -
*
* DynamoDB global secondary index - The resource type is index and the unique identifier is the
* resource ID. Example: table/my-table/index/my-table-index.
*
*
* -
*
* Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster
* name. Example: cluster:my-db-cluster.
*
*
*/
public void setResourceId(String resourceId) {
this.resourceId = resourceId;
}
/**
*
* The ID of the resource. This string consists of the resource type and unique identifier.
*
*
* -
*
* Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of
* the Auto Scaling group. Example: autoScalingGroup/my-asg.
*
*
* -
*
* ECS service - The resource type is service and the unique identifier is the cluster name and service
* name. Example: service/default/sample-webapp.
*
*
* -
*
* Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot
* Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
*
*
* -
*
* DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example:
* table/my-table.
*
*
* -
*
* DynamoDB global secondary index - The resource type is index and the unique identifier is the
* resource ID. Example: table/my-table/index/my-table-index.
*
*
* -
*
* Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
* Example: cluster:my-db-cluster.
*
*
*
*
* @return The ID of the resource. This string consists of the resource type and unique identifier.
*
* -
*
* Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the
* name of the Auto Scaling group. Example: autoScalingGroup/my-asg.
*
*
* -
*
* ECS service - The resource type is service and the unique identifier is the cluster name and
* service name. Example: service/default/sample-webapp.
*
*
* -
*
* Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is
* the Spot Fleet request ID. Example:
* spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
*
*
* -
*
* DynamoDB table - The resource type is table and the unique identifier is the resource ID.
* Example: table/my-table.
*
*
* -
*
* DynamoDB global secondary index - The resource type is index and the unique identifier is
* the resource ID. Example: table/my-table/index/my-table-index.
*
*
* -
*
* Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster
* name. Example: cluster:my-db-cluster.
*
*
*/
public String getResourceId() {
return this.resourceId;
}
/**
*
* The ID of the resource. This string consists of the resource type and unique identifier.
*
*
* -
*
* Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of
* the Auto Scaling group. Example: autoScalingGroup/my-asg.
*
*
* -
*
* ECS service - The resource type is service and the unique identifier is the cluster name and service
* name. Example: service/default/sample-webapp.
*
*
* -
*
* Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot
* Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
*
*
* -
*
* DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example:
* table/my-table.
*
*
* -
*
* DynamoDB global secondary index - The resource type is index and the unique identifier is the
* resource ID. Example: table/my-table/index/my-table-index.
*
*
* -
*
* Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
* Example: cluster:my-db-cluster.
*
*
*
*
* @param resourceId
* The ID of the resource. This string consists of the resource type and unique identifier.
*
* -
*
* Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the
* name of the Auto Scaling group. Example: autoScalingGroup/my-asg.
*
*
* -
*
* ECS service - The resource type is service and the unique identifier is the cluster name and
* service name. Example: service/default/sample-webapp.
*
*
* -
*
* Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the
* Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
*
*
* -
*
* DynamoDB table - The resource type is table and the unique identifier is the resource ID.
* Example: table/my-table.
*
*
* -
*
* DynamoDB global secondary index - The resource type is index and the unique identifier is the
* resource ID. Example: table/my-table/index/my-table-index.
*
*
* -
*
* Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster
* name. Example: cluster:my-db-cluster.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ScalingInstruction withResourceId(String resourceId) {
setResourceId(resourceId);
return this;
}
/**
*
* The scalable dimension associated with the resource.
*
*
* -
*
* autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
*
*
* -
*
* ecs:service:DesiredCount - The desired task count of an ECS service.
*
*
* -
*
* ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
*
*
* -
*
* dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary
* index.
*
*
* -
*
* dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary
* index.
*
*
* -
*
* rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for
* Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
*
*
*
*
* @param scalableDimension
* The scalable dimension associated with the resource.
*
* -
*
* autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
*
*
* -
*
* ecs:service:DesiredCount - The desired task count of an ECS service.
*
*
* -
*
* ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
*
*
* -
*
* dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global
* secondary index.
*
*
* -
*
* dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global
* secondary index.
*
*
* -
*
* rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster.
* Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
*
*
* @see ScalableDimension
*/
public void setScalableDimension(String scalableDimension) {
this.scalableDimension = scalableDimension;
}
/**
*
* The scalable dimension associated with the resource.
*
*
* -
*
* autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
*
*
* -
*
* ecs:service:DesiredCount - The desired task count of an ECS service.
*
*
* -
*
* ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
*
*
* -
*
* dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary
* index.
*
*
* -
*
* dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary
* index.
*
*
* -
*
* rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for
* Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
*
*
*
*
* @return The scalable dimension associated with the resource.
*
* -
*
* autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling
* group.
*
*
* -
*
* ecs:service:DesiredCount - The desired task count of an ECS service.
*
*
* -
*
* ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
*
*
* -
*
* dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global
* secondary index.
*
*
* -
*
* dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global
* secondary index.
*
*
* -
*
* rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster.
* Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
*
*
* @see ScalableDimension
*/
public String getScalableDimension() {
return this.scalableDimension;
}
/**
*
* The scalable dimension associated with the resource.
*
*
* -
*
* autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
*
*
* -
*
* ecs:service:DesiredCount - The desired task count of an ECS service.
*
*
* -
*
* ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
*
*
* -
*
* dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary
* index.
*
*
* -
*
* dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary
* index.
*
*
* -
*
* rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for
* Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
*
*
*
*
* @param scalableDimension
* The scalable dimension associated with the resource.
*
* -
*
* autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
*
*
* -
*
* ecs:service:DesiredCount - The desired task count of an ECS service.
*
*
* -
*
* ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
*
*
* -
*
* dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global
* secondary index.
*
*
* -
*
* dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global
* secondary index.
*
*
* -
*
* rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster.
* Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScalableDimension
*/
public ScalingInstruction withScalableDimension(String scalableDimension) {
setScalableDimension(scalableDimension);
return this;
}
/**
*
* The scalable dimension associated with the resource.
*
*
* -
*
* autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
*
*
* -
*
* ecs:service:DesiredCount - The desired task count of an ECS service.
*
*
* -
*
* ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
*
*
* -
*
* dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary
* index.
*
*
* -
*
* dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary
* index.
*
*
* -
*
* rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for
* Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
*
*
*
*
* @param scalableDimension
* The scalable dimension associated with the resource.
*
* -
*
* autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
*
*
* -
*
* ecs:service:DesiredCount - The desired task count of an ECS service.
*
*
* -
*
* ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
*
*
* -
*
* dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
*
*
* -
*
* dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global
* secondary index.
*
*
* -
*
* dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global
* secondary index.
*
*
* -
*
* rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster.
* Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScalableDimension
*/
public ScalingInstruction withScalableDimension(ScalableDimension scalableDimension) {
this.scalableDimension = scalableDimension.toString();
return this;
}
/**
*
* The minimum capacity of the resource.
*
*
* @param minCapacity
* The minimum capacity of the resource.
*/
public void setMinCapacity(Integer minCapacity) {
this.minCapacity = minCapacity;
}
/**
*
* The minimum capacity of the resource.
*
*
* @return The minimum capacity of the resource.
*/
public Integer getMinCapacity() {
return this.minCapacity;
}
/**
*
* The minimum capacity of the resource.
*
*
* @param minCapacity
* The minimum capacity of the resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ScalingInstruction withMinCapacity(Integer minCapacity) {
setMinCapacity(minCapacity);
return this;
}
/**
*
* The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting
* for PredictiveScalingMaxCapacityBehavior.
*
*
* @param maxCapacity
* The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default
* setting for PredictiveScalingMaxCapacityBehavior.
*/
public void setMaxCapacity(Integer maxCapacity) {
this.maxCapacity = maxCapacity;
}
/**
*
* The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting
* for PredictiveScalingMaxCapacityBehavior.
*
*
* @return The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default
* setting for PredictiveScalingMaxCapacityBehavior.
*/
public Integer getMaxCapacity() {
return this.maxCapacity;
}
/**
*
* The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting
* for PredictiveScalingMaxCapacityBehavior.
*
*
* @param maxCapacity
* The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default
* setting for PredictiveScalingMaxCapacityBehavior.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ScalingInstruction withMaxCapacity(Integer maxCapacity) {
setMaxCapacity(maxCapacity);
return this;
}
/**
*
* The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and
* a target value for the metric.
*
*
* @return The target tracking configurations (up to 10). Each of these structures must specify a unique scaling
* metric and a target value for the metric.
*/
public java.util.List getTargetTrackingConfigurations() {
return targetTrackingConfigurations;
}
/**
*
* The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and
* a target value for the metric.
*
*
* @param targetTrackingConfigurations
* The target tracking configurations (up to 10). Each of these structures must specify a unique scaling
* metric and a target value for the metric.
*/
public void setTargetTrackingConfigurations(java.util.Collection targetTrackingConfigurations) {
if (targetTrackingConfigurations == null) {
this.targetTrackingConfigurations = null;
return;
}
this.targetTrackingConfigurations = new java.util.ArrayList(targetTrackingConfigurations);
}
/**
*
* The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and
* a target value for the metric.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTargetTrackingConfigurations(java.util.Collection)} or
* {@link #withTargetTrackingConfigurations(java.util.Collection)} if you want to override the existing values.
*
*
* @param targetTrackingConfigurations
* The target tracking configurations (up to 10). Each of these structures must specify a unique scaling
* metric and a target value for the metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ScalingInstruction withTargetTrackingConfigurations(TargetTrackingConfiguration... targetTrackingConfigurations) {
if (this.targetTrackingConfigurations == null) {
setTargetTrackingConfigurations(new java.util.ArrayList(targetTrackingConfigurations.length));
}
for (TargetTrackingConfiguration ele : targetTrackingConfigurations) {
this.targetTrackingConfigurations.add(ele);
}
return this;
}
/**
*
* The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and
* a target value for the metric.
*
*
* @param targetTrackingConfigurations
* The target tracking configurations (up to 10). Each of these structures must specify a unique scaling
* metric and a target value for the metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ScalingInstruction withTargetTrackingConfigurations(java.util.Collection targetTrackingConfigurations) {
setTargetTrackingConfigurations(targetTrackingConfigurations);
return this;
}
/**
*
* The predefined load metric to use for predictive scaling. This parameter or a
* CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used
* otherwise.
*
*
* @param predefinedLoadMetricSpecification
* The predefined load metric to use for predictive scaling. This parameter or a
* CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be
* used otherwise.
*/
public void setPredefinedLoadMetricSpecification(PredefinedLoadMetricSpecification predefinedLoadMetricSpecification) {
this.predefinedLoadMetricSpecification = predefinedLoadMetricSpecification;
}
/**
*
* The predefined load metric to use for predictive scaling. This parameter or a
* CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used
* otherwise.
*
*
* @return The predefined load metric to use for predictive scaling. This parameter or a
* CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be
* used otherwise.
*/
public PredefinedLoadMetricSpecification getPredefinedLoadMetricSpecification() {
return this.predefinedLoadMetricSpecification;
}
/**
*
* The predefined load metric to use for predictive scaling. This parameter or a
* CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used
* otherwise.
*
*
* @param predefinedLoadMetricSpecification
* The predefined load metric to use for predictive scaling. This parameter or a
* CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be
* used otherwise.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ScalingInstruction withPredefinedLoadMetricSpecification(PredefinedLoadMetricSpecification predefinedLoadMetricSpecification) {
setPredefinedLoadMetricSpecification(predefinedLoadMetricSpecification);
return this;
}
/**
*
* The customized load metric to use for predictive scaling. This parameter or a
* PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used
* otherwise.
*
*
* @param customizedLoadMetricSpecification
* The customized load metric to use for predictive scaling. This parameter or a
* PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be
* used otherwise.
*/
public void setCustomizedLoadMetricSpecification(CustomizedLoadMetricSpecification customizedLoadMetricSpecification) {
this.customizedLoadMetricSpecification = customizedLoadMetricSpecification;
}
/**
*
* The customized load metric to use for predictive scaling. This parameter or a
* PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used
* otherwise.
*
*
* @return The customized load metric to use for predictive scaling. This parameter or a
* PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be
* used otherwise.
*/
public CustomizedLoadMetricSpecification getCustomizedLoadMetricSpecification() {
return this.customizedLoadMetricSpecification;
}
/**
*
* The customized load metric to use for predictive scaling. This parameter or a
* PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used
* otherwise.
*
*
* @param customizedLoadMetricSpecification
* The customized load metric to use for predictive scaling. This parameter or a
* PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be
* used otherwise.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ScalingInstruction withCustomizedLoadMetricSpecification(CustomizedLoadMetricSpecification customizedLoadMetricSpecification) {
setCustomizedLoadMetricSpecification(customizedLoadMetricSpecification);
return this;
}
/**
*
* The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For
* example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of
* the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be
* provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required
* depends on several factors, such as the size of the instance and whether there are startup scripts to complete.
*
*
* The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300
* seconds.
*
*
* Only valid when configuring predictive scaling.
*
*
* @param scheduledActionBufferTime
* The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For
* example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run
* time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources
* time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual
* amount of time required depends on several factors, such as the size of the instance and whether there are
* startup scripts to complete.
*
* The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is
* 300 seconds.
*
*
* Only valid when configuring predictive scaling.
*/
public void setScheduledActionBufferTime(Integer scheduledActionBufferTime) {
this.scheduledActionBufferTime = scheduledActionBufferTime;
}
/**
*
* The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For
* example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of
* the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be
* provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required
* depends on several factors, such as the size of the instance and whether there are startup scripts to complete.
*
*
* The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300
* seconds.
*
*
* Only valid when configuring predictive scaling.
*
*
* @return The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For
* example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run
* time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources
* time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual
* amount of time required depends on several factors, such as the size of the instance and whether there
* are startup scripts to complete.
*
* The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is
* 300 seconds.
*
*
* Only valid when configuring predictive scaling.
*/
public Integer getScheduledActionBufferTime() {
return this.scheduledActionBufferTime;
}
/**
*
* The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For
* example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of
* the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be
* provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required
* depends on several factors, such as the size of the instance and whether there are startup scripts to complete.
*
*
* The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300
* seconds.
*
*
* Only valid when configuring predictive scaling.
*
*
* @param scheduledActionBufferTime
* The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For
* example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run
* time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources
* time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual
* amount of time required depends on several factors, such as the size of the instance and whether there are
* startup scripts to complete.
*
* The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is
* 300 seconds.
*
*
* Only valid when configuring predictive scaling.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ScalingInstruction withScheduledActionBufferTime(Integer scheduledActionBufferTime) {
setScheduledActionBufferTime(scheduledActionBufferTime);
return this;
}
/**
*
* Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity
* specified for the resource. The default value is SetForecastCapacityToMaxCapacity.
*
*
* The following are possible values:
*
*
* -
*
* SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the
* maximum capacity. The maximum capacity is enforced as a hard limit.
*
*
* -
*
* SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the
* maximum capacity to equal but not exceed forecast capacity.
*
*
* -
*
* SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the
* maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra
* capacity if unexpected traffic occurs.
*
*
*
*
* Only valid when configuring predictive scaling.
*
*
* @param predictiveScalingMaxCapacityBehavior
* Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum
* capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity
* .
*
* The following are possible values:
*
*
* -
*
* SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher
* than the maximum capacity. The maximum capacity is enforced as a hard limit.
*
*
* -
*
* SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than
* the maximum capacity to equal but not exceed forecast capacity.
*
*
* -
*
* SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher
* than the maximum capacity by a specified buffer value. The intention is to give the target tracking
* scaling policy extra capacity if unexpected traffic occurs.
*
*
*
*
* Only valid when configuring predictive scaling.
* @see PredictiveScalingMaxCapacityBehavior
*/
public void setPredictiveScalingMaxCapacityBehavior(String predictiveScalingMaxCapacityBehavior) {
this.predictiveScalingMaxCapacityBehavior = predictiveScalingMaxCapacityBehavior;
}
/**
*
* Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity
* specified for the resource. The default value is SetForecastCapacityToMaxCapacity.
*
*
* The following are possible values:
*
*
* -
*
* SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the
* maximum capacity. The maximum capacity is enforced as a hard limit.
*
*
* -
*
* SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the
* maximum capacity to equal but not exceed forecast capacity.
*
*
* -
*
* SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the
* maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra
* capacity if unexpected traffic occurs.
*
*
*
*
* Only valid when configuring predictive scaling.
*
*
* @return Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum
* capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity
* .
*
* The following are possible values:
*
*
* -
*
* SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher
* than the maximum capacity. The maximum capacity is enforced as a hard limit.
*
*
* -
*
* SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than
* the maximum capacity to equal but not exceed forecast capacity.
*
*
* -
*
* SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher
* than the maximum capacity by a specified buffer value. The intention is to give the target tracking
* scaling policy extra capacity if unexpected traffic occurs.
*
*
*
*
* Only valid when configuring predictive scaling.
* @see PredictiveScalingMaxCapacityBehavior
*/
public String getPredictiveScalingMaxCapacityBehavior() {
return this.predictiveScalingMaxCapacityBehavior;
}
/**
*
* Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity
* specified for the resource. The default value is SetForecastCapacityToMaxCapacity.
*
*
* The following are possible values:
*
*
* -
*
* SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the
* maximum capacity. The maximum capacity is enforced as a hard limit.
*
*
* -
*
* SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the
* maximum capacity to equal but not exceed forecast capacity.
*
*
* -
*
* SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the
* maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra
* capacity if unexpected traffic occurs.
*
*
*
*
* Only valid when configuring predictive scaling.
*
*
* @param predictiveScalingMaxCapacityBehavior
* Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum
* capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity
* .
*
* The following are possible values:
*
*
* -
*
* SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher
* than the maximum capacity. The maximum capacity is enforced as a hard limit.
*
*
* -
*
* SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than
* the maximum capacity to equal but not exceed forecast capacity.
*
*
* -
*
* SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher
* than the maximum capacity by a specified buffer value. The intention is to give the target tracking
* scaling policy extra capacity if unexpected traffic occurs.
*
*
*
*
* Only valid when configuring predictive scaling.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PredictiveScalingMaxCapacityBehavior
*/
public ScalingInstruction withPredictiveScalingMaxCapacityBehavior(String predictiveScalingMaxCapacityBehavior) {
setPredictiveScalingMaxCapacityBehavior(predictiveScalingMaxCapacityBehavior);
return this;
}
/**
*
* Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity
* specified for the resource. The default value is SetForecastCapacityToMaxCapacity.
*
*
* The following are possible values:
*
*
* -
*
* SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the
* maximum capacity. The maximum capacity is enforced as a hard limit.
*
*
* -
*
* SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the
* maximum capacity to equal but not exceed forecast capacity.
*
*
* -
*
* SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the
* maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra
* capacity if unexpected traffic occurs.
*
*
*
*
* Only valid when configuring predictive scaling.
*
*
* @param predictiveScalingMaxCapacityBehavior
* Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum
* capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity
* .
*
* The following are possible values:
*
*
* -
*
* SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher
* than the maximum capacity. The maximum capacity is enforced as a hard limit.
*
*
* -
*
* SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than
* the maximum capacity to equal but not exceed forecast capacity.
*
*
* -
*
* SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher
* than the maximum capacity by a specified buffer value. The intention is to give the target tracking
* scaling policy extra capacity if unexpected traffic occurs.
*
*
*
*
* Only valid when configuring predictive scaling.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PredictiveScalingMaxCapacityBehavior
*/
public ScalingInstruction withPredictiveScalingMaxCapacityBehavior(PredictiveScalingMaxCapacityBehavior predictiveScalingMaxCapacityBehavior) {
this.predictiveScalingMaxCapacityBehavior = predictiveScalingMaxCapacityBehavior.toString();
return this;
}
/**
*
* The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.
* The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this
* means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the
* effective maximum capacity is 55.
*
*
* Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is
* set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.
*
*
* The range is 1-100.
*
*
* @param predictiveScalingMaxCapacityBuffer
* The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum
* capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the
* buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum
* capacity is 40, then the effective maximum capacity is 55.
*
* Only valid when configuring predictive scaling. Required if the
* PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity,
* and cannot be used otherwise.
*
*
* The range is 1-100.
*/
public void setPredictiveScalingMaxCapacityBuffer(Integer predictiveScalingMaxCapacityBuffer) {
this.predictiveScalingMaxCapacityBuffer = predictiveScalingMaxCapacityBuffer;
}
/**
*
* The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.
* The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this
* means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the
* effective maximum capacity is 55.
*
*
* Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is
* set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.
*
*
* The range is 1-100.
*
*
* @return The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum
* capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the
* buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum
* capacity is 40, then the effective maximum capacity is 55.
*
* Only valid when configuring predictive scaling. Required if the
* PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity,
* and cannot be used otherwise.
*
*
* The range is 1-100.
*/
public Integer getPredictiveScalingMaxCapacityBuffer() {
return this.predictiveScalingMaxCapacityBuffer;
}
/**
*
* The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.
* The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this
* means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the
* effective maximum capacity is 55.
*
*
* Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is
* set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.
*
*
* The range is 1-100.
*
*
* @param predictiveScalingMaxCapacityBuffer
* The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum
* capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the
* buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum
* capacity is 40, then the effective maximum capacity is 55.
*
* Only valid when configuring predictive scaling. Required if the
* PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity,
* and cannot be used otherwise.
*
*
* The range is 1-100.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ScalingInstruction withPredictiveScalingMaxCapacityBuffer(Integer predictiveScalingMaxCapacityBuffer) {
setPredictiveScalingMaxCapacityBuffer(predictiveScalingMaxCapacityBuffer);
return this;
}
/**
*
* The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling
* forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.
*
*
* @param predictiveScalingMode
* The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto
* Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity
* forecast.
* @see PredictiveScalingMode
*/
public void setPredictiveScalingMode(String predictiveScalingMode) {
this.predictiveScalingMode = predictiveScalingMode;
}
/**
*
* The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling
* forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.
*
*
* @return The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto
* Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity
* forecast.
* @see PredictiveScalingMode
*/
public String getPredictiveScalingMode() {
return this.predictiveScalingMode;
}
/**
*
* The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling
* forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.
*
*
* @param predictiveScalingMode
* The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto
* Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity
* forecast.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PredictiveScalingMode
*/
public ScalingInstruction withPredictiveScalingMode(String predictiveScalingMode) {
setPredictiveScalingMode(predictiveScalingMode);
return this;
}
/**
*
* The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling
* forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.
*
*
* @param predictiveScalingMode
* The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto
* Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity
* forecast.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PredictiveScalingMode
*/
public ScalingInstruction withPredictiveScalingMode(PredictiveScalingMode predictiveScalingMode) {
this.predictiveScalingMode = predictiveScalingMode.toString();
return this;
}
/**
*
* Controls whether a resource's externally created scaling policies are kept or replaced.
*
*
* The default value is KeepExternalPolicies. If the parameter is set to
* ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and
* new target tracking scaling policies created.
*
*
* Only valid when configuring dynamic scaling.
*
*
* Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more
* than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.
*
*
* @param scalingPolicyUpdateBehavior
* Controls whether a resource's externally created scaling policies are kept or replaced.
*
* The default value is KeepExternalPolicies. If the parameter is set to
* ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are
* deleted and new target tracking scaling policies created.
*
*
* Only valid when configuring dynamic scaling.
*
*
* Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are
* more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new
* ones.
* @see ScalingPolicyUpdateBehavior
*/
public void setScalingPolicyUpdateBehavior(String scalingPolicyUpdateBehavior) {
this.scalingPolicyUpdateBehavior = scalingPolicyUpdateBehavior;
}
/**
*
* Controls whether a resource's externally created scaling policies are kept or replaced.
*
*
* The default value is KeepExternalPolicies. If the parameter is set to
* ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and
* new target tracking scaling policies created.
*
*
* Only valid when configuring dynamic scaling.
*
*
* Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more
* than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.
*
*
* @return Controls whether a resource's externally created scaling policies are kept or replaced.
*
* The default value is KeepExternalPolicies. If the parameter is set to
* ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are
* deleted and new target tracking scaling policies created.
*
*
* Only valid when configuring dynamic scaling.
*
*
* Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are
* more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create
* new ones.
* @see ScalingPolicyUpdateBehavior
*/
public String getScalingPolicyUpdateBehavior() {
return this.scalingPolicyUpdateBehavior;
}
/**
*
* Controls whether a resource's externally created scaling policies are kept or replaced.
*
*
* The default value is KeepExternalPolicies. If the parameter is set to
* ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and
* new target tracking scaling policies created.
*
*
* Only valid when configuring dynamic scaling.
*
*
* Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more
* than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.
*
*
* @param scalingPolicyUpdateBehavior
* Controls whether a resource's externally created scaling policies are kept or replaced.
*
* The default value is KeepExternalPolicies. If the parameter is set to
* ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are
* deleted and new target tracking scaling policies created.
*
*
* Only valid when configuring dynamic scaling.
*
*
* Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are
* more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new
* ones.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScalingPolicyUpdateBehavior
*/
public ScalingInstruction withScalingPolicyUpdateBehavior(String scalingPolicyUpdateBehavior) {
setScalingPolicyUpdateBehavior(scalingPolicyUpdateBehavior);
return this;
}
/**
*
* Controls whether a resource's externally created scaling policies are kept or replaced.
*
*
* The default value is KeepExternalPolicies. If the parameter is set to
* ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and
* new target tracking scaling policies created.
*
*
* Only valid when configuring dynamic scaling.
*
*
* Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more
* than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.
*
*
* @param scalingPolicyUpdateBehavior
* Controls whether a resource's externally created scaling policies are kept or replaced.
*
* The default value is KeepExternalPolicies. If the parameter is set to
* ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are
* deleted and new target tracking scaling policies created.
*
*
* Only valid when configuring dynamic scaling.
*
*
* Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are
* more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new
* ones.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScalingPolicyUpdateBehavior
*/
public ScalingInstruction withScalingPolicyUpdateBehavior(ScalingPolicyUpdateBehavior scalingPolicyUpdateBehavior) {
this.scalingPolicyUpdateBehavior = scalingPolicyUpdateBehavior.toString();
return this;
}
/**
*
* Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto
* Scaling creates target tracking scaling policies based on the specified target tracking configurations.
*
*
* The default is enabled (false).
*
*
* @param disableDynamicScaling
* Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS
* Auto Scaling creates target tracking scaling policies based on the specified target tracking
* configurations.
*
* The default is enabled (false).
*/
public void setDisableDynamicScaling(Boolean disableDynamicScaling) {
this.disableDynamicScaling = disableDynamicScaling;
}
/**
*
* Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto
* Scaling creates target tracking scaling policies based on the specified target tracking configurations.
*
*
* The default is enabled (false).
*
*
* @return Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS
* Auto Scaling creates target tracking scaling policies based on the specified target tracking
* configurations.
*
* The default is enabled (false).
*/
public Boolean getDisableDynamicScaling() {
return this.disableDynamicScaling;
}
/**
*
* Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto
* Scaling creates target tracking scaling policies based on the specified target tracking configurations.
*
*
* The default is enabled (false).
*
*
* @param disableDynamicScaling
* Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS
* Auto Scaling creates target tracking scaling policies based on the specified target tracking
* configurations.
*
* The default is enabled (false).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ScalingInstruction withDisableDynamicScaling(Boolean disableDynamicScaling) {
setDisableDynamicScaling(disableDynamicScaling);
return this;
}
/**
*
* Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto
* Scaling creates target tracking scaling policies based on the specified target tracking configurations.
*
*
* The default is enabled (false).
*
*
* @return Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS
* Auto Scaling creates target tracking scaling policies based on the specified target tracking
* configurations.
*
* The default is enabled (false).
*/
public Boolean isDisableDynamicScaling() {
return this.disableDynamicScaling;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getServiceNamespace() != null)
sb.append("ServiceNamespace: ").append(getServiceNamespace()).append(",");
if (getResourceId() != null)
sb.append("ResourceId: ").append(getResourceId()).append(",");
if (getScalableDimension() != null)
sb.append("ScalableDimension: ").append(getScalableDimension()).append(",");
if (getMinCapacity() != null)
sb.append("MinCapacity: ").append(getMinCapacity()).append(",");
if (getMaxCapacity() != null)
sb.append("MaxCapacity: ").append(getMaxCapacity()).append(",");
if (getTargetTrackingConfigurations() != null)
sb.append("TargetTrackingConfigurations: ").append(getTargetTrackingConfigurations()).append(",");
if (getPredefinedLoadMetricSpecification() != null)
sb.append("PredefinedLoadMetricSpecification: ").append(getPredefinedLoadMetricSpecification()).append(",");
if (getCustomizedLoadMetricSpecification() != null)
sb.append("CustomizedLoadMetricSpecification: ").append(getCustomizedLoadMetricSpecification()).append(",");
if (getScheduledActionBufferTime() != null)
sb.append("ScheduledActionBufferTime: ").append(getScheduledActionBufferTime()).append(",");
if (getPredictiveScalingMaxCapacityBehavior() != null)
sb.append("PredictiveScalingMaxCapacityBehavior: ").append(getPredictiveScalingMaxCapacityBehavior()).append(",");
if (getPredictiveScalingMaxCapacityBuffer() != null)
sb.append("PredictiveScalingMaxCapacityBuffer: ").append(getPredictiveScalingMaxCapacityBuffer()).append(",");
if (getPredictiveScalingMode() != null)
sb.append("PredictiveScalingMode: ").append(getPredictiveScalingMode()).append(",");
if (getScalingPolicyUpdateBehavior() != null)
sb.append("ScalingPolicyUpdateBehavior: ").append(getScalingPolicyUpdateBehavior()).append(",");
if (getDisableDynamicScaling() != null)
sb.append("DisableDynamicScaling: ").append(getDisableDynamicScaling());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ScalingInstruction == false)
return false;
ScalingInstruction other = (ScalingInstruction) obj;
if (other.getServiceNamespace() == null ^ this.getServiceNamespace() == null)
return false;
if (other.getServiceNamespace() != null && other.getServiceNamespace().equals(this.getServiceNamespace()) == false)
return false;
if (other.getResourceId() == null ^ this.getResourceId() == null)
return false;
if (other.getResourceId() != null && other.getResourceId().equals(this.getResourceId()) == false)
return false;
if (other.getScalableDimension() == null ^ this.getScalableDimension() == null)
return false;
if (other.getScalableDimension() != null && other.getScalableDimension().equals(this.getScalableDimension()) == false)
return false;
if (other.getMinCapacity() == null ^ this.getMinCapacity() == null)
return false;
if (other.getMinCapacity() != null && other.getMinCapacity().equals(this.getMinCapacity()) == false)
return false;
if (other.getMaxCapacity() == null ^ this.getMaxCapacity() == null)
return false;
if (other.getMaxCapacity() != null && other.getMaxCapacity().equals(this.getMaxCapacity()) == false)
return false;
if (other.getTargetTrackingConfigurations() == null ^ this.getTargetTrackingConfigurations() == null)
return false;
if (other.getTargetTrackingConfigurations() != null && other.getTargetTrackingConfigurations().equals(this.getTargetTrackingConfigurations()) == false)
return false;
if (other.getPredefinedLoadMetricSpecification() == null ^ this.getPredefinedLoadMetricSpecification() == null)
return false;
if (other.getPredefinedLoadMetricSpecification() != null
&& other.getPredefinedLoadMetricSpecification().equals(this.getPredefinedLoadMetricSpecification()) == false)
return false;
if (other.getCustomizedLoadMetricSpecification() == null ^ this.getCustomizedLoadMetricSpecification() == null)
return false;
if (other.getCustomizedLoadMetricSpecification() != null
&& other.getCustomizedLoadMetricSpecification().equals(this.getCustomizedLoadMetricSpecification()) == false)
return false;
if (other.getScheduledActionBufferTime() == null ^ this.getScheduledActionBufferTime() == null)
return false;
if (other.getScheduledActionBufferTime() != null && other.getScheduledActionBufferTime().equals(this.getScheduledActionBufferTime()) == false)
return false;
if (other.getPredictiveScalingMaxCapacityBehavior() == null ^ this.getPredictiveScalingMaxCapacityBehavior() == null)
return false;
if (other.getPredictiveScalingMaxCapacityBehavior() != null
&& other.getPredictiveScalingMaxCapacityBehavior().equals(this.getPredictiveScalingMaxCapacityBehavior()) == false)
return false;
if (other.getPredictiveScalingMaxCapacityBuffer() == null ^ this.getPredictiveScalingMaxCapacityBuffer() == null)
return false;
if (other.getPredictiveScalingMaxCapacityBuffer() != null
&& other.getPredictiveScalingMaxCapacityBuffer().equals(this.getPredictiveScalingMaxCapacityBuffer()) == false)
return false;
if (other.getPredictiveScalingMode() == null ^ this.getPredictiveScalingMode() == null)
return false;
if (other.getPredictiveScalingMode() != null && other.getPredictiveScalingMode().equals(this.getPredictiveScalingMode()) == false)
return false;
if (other.getScalingPolicyUpdateBehavior() == null ^ this.getScalingPolicyUpdateBehavior() == null)
return false;
if (other.getScalingPolicyUpdateBehavior() != null && other.getScalingPolicyUpdateBehavior().equals(this.getScalingPolicyUpdateBehavior()) == false)
return false;
if (other.getDisableDynamicScaling() == null ^ this.getDisableDynamicScaling() == null)
return false;
if (other.getDisableDynamicScaling() != null && other.getDisableDynamicScaling().equals(this.getDisableDynamicScaling()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getServiceNamespace() == null) ? 0 : getServiceNamespace().hashCode());
hashCode = prime * hashCode + ((getResourceId() == null) ? 0 : getResourceId().hashCode());
hashCode = prime * hashCode + ((getScalableDimension() == null) ? 0 : getScalableDimension().hashCode());
hashCode = prime * hashCode + ((getMinCapacity() == null) ? 0 : getMinCapacity().hashCode());
hashCode = prime * hashCode + ((getMaxCapacity() == null) ? 0 : getMaxCapacity().hashCode());
hashCode = prime * hashCode + ((getTargetTrackingConfigurations() == null) ? 0 : getTargetTrackingConfigurations().hashCode());
hashCode = prime * hashCode + ((getPredefinedLoadMetricSpecification() == null) ? 0 : getPredefinedLoadMetricSpecification().hashCode());
hashCode = prime * hashCode + ((getCustomizedLoadMetricSpecification() == null) ? 0 : getCustomizedLoadMetricSpecification().hashCode());
hashCode = prime * hashCode + ((getScheduledActionBufferTime() == null) ? 0 : getScheduledActionBufferTime().hashCode());
hashCode = prime * hashCode + ((getPredictiveScalingMaxCapacityBehavior() == null) ? 0 : getPredictiveScalingMaxCapacityBehavior().hashCode());
hashCode = prime * hashCode + ((getPredictiveScalingMaxCapacityBuffer() == null) ? 0 : getPredictiveScalingMaxCapacityBuffer().hashCode());
hashCode = prime * hashCode + ((getPredictiveScalingMode() == null) ? 0 : getPredictiveScalingMode().hashCode());
hashCode = prime * hashCode + ((getScalingPolicyUpdateBehavior() == null) ? 0 : getScalingPolicyUpdateBehavior().hashCode());
hashCode = prime * hashCode + ((getDisableDynamicScaling() == null) ? 0 : getDisableDynamicScaling().hashCode());
return hashCode;
}
@Override
public ScalingInstruction clone() {
try {
return (ScalingInstruction) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.autoscalingplans.model.transform.ScalingInstructionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}