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.

ScalingPolicy

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

type ScalingPolicy struct { Alarms []*Alarm `type:"list"` CreationTime *time.Time `type:"timestamp" required:"true"` PolicyARN *string `min:"1" type:"string" required:"true"` PolicyName *string `min:"1" type:"string" required:"true"` PolicyType *string `type:"string" required:"true" enum:"PolicyType"` ResourceId *string `min:"1" type:"string" required:"true"` ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` StepScalingPolicyConfiguration *StepScalingPolicyConfiguration `type:"structure"` TargetTrackingScalingPolicyConfiguration *TargetTrackingScalingPolicyConfiguration `type:"structure"` }

Represents a scaling policy to use with Application Auto Scaling.

Alarms

Represents a CloudWatch alarm associated with a scaling policy.

CreationTime

Type: *time.Time

The Unix timestamp for when the scaling policy was created.

CreationTime is a required field

PolicyARN

Type: *string

The Amazon Resource Name (ARN) of the scaling policy.

PolicyARN is a required field

PolicyName

Type: *string

The name of the scaling policy.

PolicyName is a required field

PolicyType

Type: *string

The scaling policy type.

PolicyType is a required field

ResourceId

Type: *string

The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

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

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

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

  • Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).

ResourceId is a required field

ScalableDimension

Type: *string

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

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

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

ScalableDimension is a required field

ServiceNamespace

Type: *string

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) in the Amazon Web Services General Reference.

ServiceNamespace is a required field

StepScalingPolicyConfiguration

Represents a step scaling policy configuration to use with Application Auto Scaling.

TargetTrackingScalingPolicyConfiguration

Represents a target tracking scaling policy configuration to use with Application Auto Scaling.

Method

GoString

func (s ScalingPolicy) GoString() string

GoString returns the string representation

SetAlarms

func (s *ScalingPolicy) SetAlarms(v []*Alarm) *ScalingPolicy

SetAlarms sets the Alarms field's value.

SetCreationTime

func (s *ScalingPolicy) SetCreationTime(v time.Time) *ScalingPolicy

SetCreationTime sets the CreationTime field's value.

SetPolicyARN

func (s *ScalingPolicy) SetPolicyARN(v string) *ScalingPolicy

SetPolicyARN sets the PolicyARN field's value.

SetPolicyName

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

SetPolicyName sets the PolicyName field's value.

SetPolicyType

func (s *ScalingPolicy) SetPolicyType(v string) *ScalingPolicy

SetPolicyType sets the PolicyType field's value.

SetResourceId

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

SetResourceId sets the ResourceId field's value.

SetScalableDimension

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

SetScalableDimension sets the ScalableDimension field's value.

SetServiceNamespace

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

SetServiceNamespace sets the ServiceNamespace field's value.

SetStepScalingPolicyConfiguration

func (s *ScalingPolicy) SetStepScalingPolicyConfiguration(v *StepScalingPolicyConfiguration) *ScalingPolicy

SetStepScalingPolicyConfiguration sets the StepScalingPolicyConfiguration field's value.

SetTargetTrackingScalingPolicyConfiguration

func (s *ScalingPolicy) SetTargetTrackingScalingPolicyConfiguration(v *TargetTrackingScalingPolicyConfiguration) *ScalingPolicy

SetTargetTrackingScalingPolicyConfiguration sets the TargetTrackingScalingPolicyConfiguration field's value.

String

func (s ScalingPolicy) String() string

String returns the string representation

On this page: