com.amazonaws.services.autoscalingplans.model

Class ScalingInstruction

java.lang.Object

com.amazonaws.services.autoscalingplans.model.ScalingInstruction

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ScalingInstruction
extends Object
implements Serializable, Cloneable, StructuredPojo

Specifies the scaling configuration for a scalable resource.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScalingInstruction()

Method Summary

Modifier and Type	Method and Description
ScalingInstruction	clone()
boolean	equals(Object obj)
Integer	getMaxCapacity() The maximum value to scale to in response to a scale out event.
Integer	getMinCapacity() The minimum value to scale to in response to a scale in event.
String	getResourceId() The ID of the resource.
String	getScalableDimension() The scalable dimension associated with the resource.
String	getServiceNamespace() The namespace of the AWS service.
List<TargetTrackingConfiguration>	getTargetTrackingConfigurations() The target tracking scaling policies (up to 10).
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setMaxCapacity(Integer maxCapacity) The maximum value to scale to in response to a scale out event.
void	setMinCapacity(Integer minCapacity) The minimum value to scale to in response to a scale in event.
void	setResourceId(String resourceId) The ID of the resource.
void	setScalableDimension(String scalableDimension) The scalable dimension associated with the resource.
void	setServiceNamespace(String serviceNamespace) The namespace of the AWS service.
void	setTargetTrackingConfigurations(Collection<TargetTrackingConfiguration> targetTrackingConfigurations) The target tracking scaling policies (up to 10).
String	toString() Returns a string representation of this object; useful for testing and debugging.
ScalingInstruction	withMaxCapacity(Integer maxCapacity) The maximum value to scale to in response to a scale out event.
ScalingInstruction	withMinCapacity(Integer minCapacity) The minimum value to scale to in response to a scale in event.
ScalingInstruction	withResourceId(String resourceId) The ID of the resource.
ScalingInstruction	withScalableDimension(ScalableDimension scalableDimension) The scalable dimension associated with the resource.
ScalingInstruction	withScalableDimension(String scalableDimension) The scalable dimension associated with the resource.
ScalingInstruction	withServiceNamespace(ServiceNamespace serviceNamespace) The namespace of the AWS service.
ScalingInstruction	withServiceNamespace(String serviceNamespace) The namespace of the AWS service.
ScalingInstruction	withTargetTrackingConfigurations(Collection<TargetTrackingConfiguration> targetTrackingConfigurations) The target tracking scaling policies (up to 10).
ScalingInstruction	withTargetTrackingConfigurations(TargetTrackingConfiguration... targetTrackingConfigurations) The target tracking scaling policies (up to 10).

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScalingInstruction

public ScalingInstruction()

Method Detail

setServiceNamespace

public void setServiceNamespace(String serviceNamespace)

The namespace of the AWS service.

Parameters:

serviceNamespace - The namespace of the AWS service.

See Also:

ServiceNamespace

getServiceNamespace

public String getServiceNamespace()

The namespace of the AWS service.

Returns:

The namespace of the AWS service.

See Also:

ServiceNamespace

withServiceNamespace

public ScalingInstruction withServiceNamespace(String serviceNamespace)

The namespace of the AWS service.

Parameters:

serviceNamespace - The namespace of the AWS service.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceNamespace

withServiceNamespace

public ScalingInstruction withServiceNamespace(ServiceNamespace serviceNamespace)

The namespace of the AWS service.

Parameters:

serviceNamespace - The namespace of the AWS service.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceNamespace

setResourceId

public void setResourceId(String 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.

Parameters:

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.

getResourceId

public String getResourceId()

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.

Returns:

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.

withResourceId

public ScalingInstruction withResourceId(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setScalableDimension

public void setScalableDimension(String 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.

Parameters:

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.

See Also:

ScalableDimension

getScalableDimension

public String getScalableDimension()

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.

Returns:

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.

See Also:

ScalableDimension

withScalableDimension

public ScalingInstruction withScalableDimension(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalableDimension

withScalableDimension

public ScalingInstruction withScalableDimension(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalableDimension

setMinCapacity

public void setMinCapacity(Integer minCapacity)

The minimum value to scale to in response to a scale in event.

Parameters:

minCapacity - The minimum value to scale to in response to a scale in event.

getMinCapacity

public Integer getMinCapacity()

The minimum value to scale to in response to a scale in event.

Returns:

The minimum value to scale to in response to a scale in event.

withMinCapacity

public ScalingInstruction withMinCapacity(Integer minCapacity)

The minimum value to scale to in response to a scale in event.

Parameters:

minCapacity - The minimum value to scale to in response to a scale in event.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxCapacity

public void setMaxCapacity(Integer maxCapacity)

The maximum value to scale to in response to a scale out event.

Parameters:

maxCapacity - The maximum value to scale to in response to a scale out event.

getMaxCapacity

public Integer getMaxCapacity()

The maximum value to scale to in response to a scale out event.

Returns:

The maximum value to scale to in response to a scale out event.

withMaxCapacity

public ScalingInstruction withMaxCapacity(Integer maxCapacity)

The maximum value to scale to in response to a scale out event.

Parameters:

maxCapacity - The maximum value to scale to in response to a scale out event.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTargetTrackingConfigurations

public List<TargetTrackingConfiguration> getTargetTrackingConfigurations()

The target tracking scaling policies (up to 10).

Returns:

The target tracking scaling policies (up to 10).

setTargetTrackingConfigurations

public void setTargetTrackingConfigurations(Collection<TargetTrackingConfiguration> targetTrackingConfigurations)

The target tracking scaling policies (up to 10).

Parameters:

targetTrackingConfigurations - The target tracking scaling policies (up to 10).

withTargetTrackingConfigurations

public ScalingInstruction withTargetTrackingConfigurations(TargetTrackingConfiguration... targetTrackingConfigurations)

The target tracking scaling policies (up to 10).

NOTE: This method appends the values to the existing list (if any). Use setTargetTrackingConfigurations(java.util.Collection) or withTargetTrackingConfigurations(java.util.Collection) if you want to override the existing values.

Parameters:

targetTrackingConfigurations - The target tracking scaling policies (up to 10).

Returns:

Returns a reference to this object so that method calls can be chained together.

withTargetTrackingConfigurations

public ScalingInstruction withTargetTrackingConfigurations(Collection<TargetTrackingConfiguration> targetTrackingConfigurations)

The target tracking scaling policies (up to 10).

Parameters:

targetTrackingConfigurations - The target tracking scaling policies (up to 10).

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ScalingInstruction clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo