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.

ScalingActivity

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

type ScalingActivity struct { ActivityId *string `type:"string" required:"true"` Cause *string `type:"string" required:"true"` Description *string `type:"string" required:"true"` Details *string `type:"string"` EndTime *time.Time `type:"timestamp"` ResourceId *string `min:"1" type:"string" required:"true"` ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` StartTime *time.Time `type:"timestamp" required:"true"` StatusCode *string `type:"string" required:"true" enum:"ScalingActivityStatusCode"` StatusMessage *string `type:"string"` }

Represents a scaling activity.

ActivityId

Type: *string

The unique identifier of the scaling activity.

ActivityId is a required field

Cause

Type: *string

A simple description of what caused the scaling activity to happen.

Cause is a required field

Description

Type: *string

A simple description of what action the scaling activity intends to accomplish.

Description is a required field

Details

Type: *string

The details about the scaling activity.

EndTime

Type: *time.Time

The Unix timestamp for when the scaling activity ended.

ResourceId

Type: *string

The identifier of the resource associated with the scaling activity. 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

StartTime

Type: *time.Time

The Unix timestamp for when the scaling activity began.

StartTime is a required field

StatusCode

Type: *string

Indicates the status of the scaling activity.

StatusCode is a required field

StatusMessage

Type: *string

A simple message about the current status of the scaling activity.

Method

GoString

func (s ScalingActivity) GoString() string

GoString returns the string representation

SetActivityId

func (s *ScalingActivity) SetActivityId(v string) *ScalingActivity

SetActivityId sets the ActivityId field's value.

SetCause

func (s *ScalingActivity) SetCause(v string) *ScalingActivity

SetCause sets the Cause field's value.

SetDescription

func (s *ScalingActivity) SetDescription(v string) *ScalingActivity

SetDescription sets the Description field's value.

SetDetails

func (s *ScalingActivity) SetDetails(v string) *ScalingActivity

SetDetails sets the Details field's value.

SetEndTime

func (s *ScalingActivity) SetEndTime(v time.Time) *ScalingActivity

SetEndTime sets the EndTime field's value.

SetResourceId

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

SetResourceId sets the ResourceId field's value.

SetScalableDimension

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

SetScalableDimension sets the ScalableDimension field's value.

SetServiceNamespace

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

SetServiceNamespace sets the ServiceNamespace field's value.

SetStartTime

func (s *ScalingActivity) SetStartTime(v time.Time) *ScalingActivity

SetStartTime sets the StartTime field's value.

SetStatusCode

func (s *ScalingActivity) SetStatusCode(v string) *ScalingActivity

SetStatusCode sets the StatusCode field's value.

SetStatusMessage

func (s *ScalingActivity) SetStatusMessage(v string) *ScalingActivity

SetStatusMessage sets the StatusMessage field's value.

String

func (s ScalingActivity) String() string

String returns the string representation

On this page: