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.

ScheduledAction

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

type ScheduledAction struct { CreationTime *time.Time `type:"timestamp" required:"true"` EndTime *time.Time `type:"timestamp"` ResourceId *string `min:"1" type:"string" required:"true"` ScalableDimension *string `type:"string" enum:"ScalableDimension"` ScalableTargetAction *ScalableTargetAction `type:"structure"` Schedule *string `min:"1" type:"string" required:"true"` ScheduledActionARN *string `min:"1" type:"string" required:"true"` ScheduledActionName *string `min:"1" type:"string" required:"true"` ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` StartTime *time.Time `type:"timestamp"` }

Represents a scheduled action.

CreationTime

Type: *time.Time

The date and time that the scheduled action was created.

CreationTime is a required field

EndTime

Type: *time.Time

The date and time that the action is scheduled to end.

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.

ScalableTargetAction

Represents the minimum and maximum capacity for a scheduled action.

Schedule

Type: *string

The schedule for this action. The following formats are supported:

  • At expressions - "at(yyyy-mm-ddThh:mm:ss)"

  • Rate expressions - "rate(valueunit)"

  • Cron expressions - "cron(fields)"

At expressions are useful for one-time schedules. Specify the time, in UTC.

For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

For more information about cron expressions, see Cron Expressions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) in the Amazon CloudWatch Events User Guide.

Schedule is a required field

ScheduledActionARN

Type: *string

The Amazon Resource Name (ARN) of the scheduled action.

ScheduledActionARN is a required field

ScheduledActionName

Type: *string

The name of the scheduled action.

ScheduledActionName 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 date and time that the action is scheduled to begin.

Method

GoString

func (s ScheduledAction) GoString() string

GoString returns the string representation

SetCreationTime

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

SetCreationTime sets the CreationTime field's value.

SetEndTime

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

SetEndTime sets the EndTime field's value.

SetResourceId

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

SetResourceId sets the ResourceId field's value.

SetScalableDimension

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

SetScalableDimension sets the ScalableDimension field's value.

SetScalableTargetAction

func (s *ScheduledAction) SetScalableTargetAction(v *ScalableTargetAction) *ScheduledAction

SetScalableTargetAction sets the ScalableTargetAction field's value.

SetSchedule

func (s *ScheduledAction) SetSchedule(v string) *ScheduledAction

SetSchedule sets the Schedule field's value.

SetScheduledActionARN

func (s *ScheduledAction) SetScheduledActionARN(v string) *ScheduledAction

SetScheduledActionARN sets the ScheduledActionARN field's value.

SetScheduledActionName

func (s *ScheduledAction) SetScheduledActionName(v string) *ScheduledAction

SetScheduledActionName sets the ScheduledActionName field's value.

SetServiceNamespace

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

SetServiceNamespace sets the ServiceNamespace field's value.

SetStartTime

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

SetStartTime sets the StartTime field's value.

String

func (s ScheduledAction) String() string

String returns the string representation

On this page: