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.

ExecutePolicyInput

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

type ExecutePolicyInput struct { AutoScalingGroupName *string `min:"1" type:"string"` BreachThreshold *float64 `type:"double"` HonorCooldown *bool `type:"boolean"` MetricValue *float64 `type:"double"` PolicyName *string `min:"1" type:"string" required:"true"` }

AutoScalingGroupName

Type: *string

The name of the Auto Scaling group.

BreachThreshold

Type: *float64

The breach threshold for the alarm.

This parameter is required if the policy type is StepScaling and not supported otherwise.

HonorCooldown

Type: *bool

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

This parameter is not supported if the policy type is StepScaling.

For more information, see Scaling Cooldowns (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the Amazon EC2 Auto Scaling User Guide.

MetricValue

Type: *float64

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

This parameter is required if the policy type is StepScaling and not supported otherwise.

PolicyName

Type: *string

The name or ARN of the policy.

PolicyName is a required field

Method

GoString

func (s ExecutePolicyInput) GoString() string

GoString returns the string representation

SetAutoScalingGroupName

func (s *ExecutePolicyInput) SetAutoScalingGroupName(v string) *ExecutePolicyInput

SetAutoScalingGroupName sets the AutoScalingGroupName field's value.

SetBreachThreshold

func (s *ExecutePolicyInput) SetBreachThreshold(v float64) *ExecutePolicyInput

SetBreachThreshold sets the BreachThreshold field's value.

SetHonorCooldown

func (s *ExecutePolicyInput) SetHonorCooldown(v bool) *ExecutePolicyInput

SetHonorCooldown sets the HonorCooldown field's value.

SetMetricValue

func (s *ExecutePolicyInput) SetMetricValue(v float64) *ExecutePolicyInput

SetMetricValue sets the MetricValue field's value.

SetPolicyName

func (s *ExecutePolicyInput) SetPolicyName(v string) *ExecutePolicyInput

SetPolicyName sets the PolicyName field's value.

String

func (s ExecutePolicyInput) String() string

String returns the string representation

Validate

func (s *ExecutePolicyInput) Validate() error

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

On this page: