AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ScalingInstruction

import "github.com/aws/aws-sdk-go/service/autoscalingplans"

type ScalingInstruction struct { CustomizedLoadMetricSpecification *CustomizedLoadMetricSpecification `type:"structure"` DisableDynamicScaling *bool `type:"boolean"` MaxCapacity *int64 `type:"integer" required:"true"` MinCapacity *int64 `type:"integer" required:"true"` PredefinedLoadMetricSpecification *PredefinedLoadMetricSpecification `type:"structure"` PredictiveScalingMaxCapacityBehavior *string `type:"string" enum:"PredictiveScalingMaxCapacityBehavior"` PredictiveScalingMaxCapacityBuffer *int64 `type:"integer"` PredictiveScalingMode *string `type:"string" enum:"PredictiveScalingMode"` ResourceId *string `min:"1" type:"string" required:"true"` ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` ScalingPolicyUpdateBehavior *string `type:"string" enum:"ScalingPolicyUpdateBehavior"` ScheduledActionBufferTime *int64 `type:"integer"` ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` TargetTrackingConfigurations []*TargetTrackingConfiguration `type:"list" required:"true"` }

Describes a scaling instruction for a scalable resource.

The scaling instruction is used in combination with a scaling plan, which is a set of instructions for configuring dynamic scaling and predictive scaling for the scalable resources in your application. 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 Getting Started with AWS Auto Scaling (https://docs.aws.amazon.com/autoscaling/plans/userguide/auto-scaling-getting-started.html).

CustomizedLoadMetricSpecification

Represents a CloudWatch metric of your choosing that can be used for predictive scaling.

For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the Sum and Average statistics that CloudWatch computes from metric data. Statistics are calculations used to aggregate data over specified time periods.

When you choose a load metric, make sure that the required Sum and Average statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The Sum statistic must represent the total load on the resource, and the Average statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the Sum statistic represents the total request count processed by the group, then the Average statistic for the specified metric must represent the average request count processed by each instance of the group.

For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the Amazon CloudWatch User Guide.

DisableDynamicScaling

Type: *bool

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).

MaxCapacity

Type: *int64

The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.

MaxCapacity is a required field

MinCapacity

Type: *int64

The minimum capacity of the resource.

MinCapacity is a required field

PredefinedLoadMetricSpecification

Represents a predefined metric that can be used for predictive scaling.

PredictiveScalingMaxCapacityBehavior

Type: *string

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.

PredictiveScalingMaxCapacityBuffer

Type: *int64

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.

PredictiveScalingMode

Type: *string

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.

ResourceId

Type: *string

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.

ResourceId is a required field

ScalableDimension

Type: *string

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.

ScalableDimension is a required field

ScalingPolicyUpdateBehavior

Type: *string

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.

ScheduledActionBufferTime

Type: *int64

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.

ServiceNamespace

Type: *string

The namespace of the AWS service.

ServiceNamespace is a required field

TargetTrackingConfigurations

Describes a target tracking configuration to use with AWS Auto Scaling. Used with ScalingInstruction and ScalingPolicy.

Method

GoString

func (s ScalingInstruction) GoString() string

GoString returns the string representation

SetCustomizedLoadMetricSpecification

func (s *ScalingInstruction) SetCustomizedLoadMetricSpecification(v *CustomizedLoadMetricSpecification) *ScalingInstruction

SetCustomizedLoadMetricSpecification sets the CustomizedLoadMetricSpecification field's value.

SetDisableDynamicScaling

func (s *ScalingInstruction) SetDisableDynamicScaling(v bool) *ScalingInstruction

SetDisableDynamicScaling sets the DisableDynamicScaling field's value.

SetMaxCapacity

func (s *ScalingInstruction) SetMaxCapacity(v int64) *ScalingInstruction

SetMaxCapacity sets the MaxCapacity field's value.

SetMinCapacity

func (s *ScalingInstruction) SetMinCapacity(v int64) *ScalingInstruction

SetMinCapacity sets the MinCapacity field's value.

SetPredefinedLoadMetricSpecification

func (s *ScalingInstruction) SetPredefinedLoadMetricSpecification(v *PredefinedLoadMetricSpecification) *ScalingInstruction

SetPredefinedLoadMetricSpecification sets the PredefinedLoadMetricSpecification field's value.

SetPredictiveScalingMaxCapacityBehavior

func (s *ScalingInstruction) SetPredictiveScalingMaxCapacityBehavior(v string) *ScalingInstruction

SetPredictiveScalingMaxCapacityBehavior sets the PredictiveScalingMaxCapacityBehavior field's value.

SetPredictiveScalingMaxCapacityBuffer

func (s *ScalingInstruction) SetPredictiveScalingMaxCapacityBuffer(v int64) *ScalingInstruction

SetPredictiveScalingMaxCapacityBuffer sets the PredictiveScalingMaxCapacityBuffer field's value.

SetPredictiveScalingMode

func (s *ScalingInstruction) SetPredictiveScalingMode(v string) *ScalingInstruction

SetPredictiveScalingMode sets the PredictiveScalingMode field's value.

SetResourceId

func (s *ScalingInstruction) SetResourceId(v string) *ScalingInstruction

SetResourceId sets the ResourceId field's value.

SetScalableDimension

func (s *ScalingInstruction) SetScalableDimension(v string) *ScalingInstruction

SetScalableDimension sets the ScalableDimension field's value.

SetScalingPolicyUpdateBehavior

func (s *ScalingInstruction) SetScalingPolicyUpdateBehavior(v string) *ScalingInstruction

SetScalingPolicyUpdateBehavior sets the ScalingPolicyUpdateBehavior field's value.

SetScheduledActionBufferTime

func (s *ScalingInstruction) SetScheduledActionBufferTime(v int64) *ScalingInstruction

SetScheduledActionBufferTime sets the ScheduledActionBufferTime field's value.

SetServiceNamespace

func (s *ScalingInstruction) SetServiceNamespace(v string) *ScalingInstruction

SetServiceNamespace sets the ServiceNamespace field's value.

SetTargetTrackingConfigurations

func (s *ScalingInstruction) SetTargetTrackingConfigurations(v []*TargetTrackingConfiguration) *ScalingInstruction

SetTargetTrackingConfigurations sets the TargetTrackingConfigurations field's value.

String

func (s ScalingInstruction) String() string

String returns the string representation

Validate

func (s *ScalingInstruction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: