Documentation

Overview

    Package autoscalingplans provides the API client, operations, and parameter types for AWS Auto Scaling Plans.

    AWS Auto Scaling Use AWS Auto Scaling to quickly discover all the scalable AWS resources for your application and configure dynamic scaling and predictive scaling for your resources using scaling plans. Use this service in conjunction with the Amazon EC2 Auto Scaling, Application Auto Scaling, Amazon CloudWatch, and AWS CloudFormation services. Currently, predictive scaling is only available for Amazon EC2 Auto Scaling groups. For more information about AWS Auto Scaling, including information about granting IAM users required permissions for AWS Auto Scaling actions, see the AWS Auto Scaling User Guide (https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html).

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2018-01-06"
    View Source
    const ServiceID = "Auto Scaling Plans"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

          type Client struct {
          	// contains filtered or unexported fields
          }

            Client provides the API client to make operations call for AWS Auto Scaling Plans.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) CreateScalingPlan

                func (c *Client) CreateScalingPlan(ctx context.Context, params *CreateScalingPlanInput, optFns ...func(*Options)) (*CreateScalingPlanOutput, error)

                  Creates a scaling plan.

                  func (*Client) DeleteScalingPlan

                  func (c *Client) DeleteScalingPlan(ctx context.Context, params *DeleteScalingPlanInput, optFns ...func(*Options)) (*DeleteScalingPlanOutput, error)

                    Deletes the specified scaling plan. Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan. If the plan has launched resources or has scaling activities in progress, you must delete those resources separately.

                    func (*Client) DescribeScalingPlanResources

                    func (c *Client) DescribeScalingPlanResources(ctx context.Context, params *DescribeScalingPlanResourcesInput, optFns ...func(*Options)) (*DescribeScalingPlanResourcesOutput, error)

                      Describes the scalable resources in the specified scaling plan.

                      func (*Client) DescribeScalingPlans

                      func (c *Client) DescribeScalingPlans(ctx context.Context, params *DescribeScalingPlansInput, optFns ...func(*Options)) (*DescribeScalingPlansOutput, error)

                        Describes one or more of your scaling plans.

                        func (*Client) GetScalingPlanResourceForecastData

                        func (c *Client) GetScalingPlanResourceForecastData(ctx context.Context, params *GetScalingPlanResourceForecastDataInput, optFns ...func(*Options)) (*GetScalingPlanResourceForecastDataOutput, error)

                          Retrieves the forecast data for a scalable resource. Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days.

                          func (*Client) UpdateScalingPlan

                          func (c *Client) UpdateScalingPlan(ctx context.Context, params *UpdateScalingPlanInput, optFns ...func(*Options)) (*UpdateScalingPlanOutput, error)

                            Updates the specified scaling plan. You cannot update a scaling plan if it is in the process of being created, updated, or deleted.

                            type CreateScalingPlanInput

                            type CreateScalingPlanInput struct {
                            
                            	// A CloudFormation stack or set of tags. You can create one scaling plan per
                            	// application source.
                            	//
                            	// This member is required.
                            	ApplicationSource *types.ApplicationSource
                            
                            	// The scaling instructions.
                            	//
                            	// This member is required.
                            	ScalingInstructions []types.ScalingInstruction
                            
                            	// The name of the scaling plan. Names cannot contain vertical bars, colons, or
                            	// forward slashes.
                            	//
                            	// This member is required.
                            	ScalingPlanName *string
                            }

                            type CreateScalingPlanOutput

                            type CreateScalingPlanOutput struct {
                            
                            	// The version number of the scaling plan. This value is always 1. Currently, you
                            	// cannot specify multiple scaling plan versions.
                            	//
                            	// This member is required.
                            	ScalingPlanVersion *int64
                            
                            	// Metadata pertaining to the operation's result.
                            	ResultMetadata middleware.Metadata
                            }

                            type DeleteScalingPlanInput

                            type DeleteScalingPlanInput struct {
                            
                            	// The name of the scaling plan.
                            	//
                            	// This member is required.
                            	ScalingPlanName *string
                            
                            	// The version number of the scaling plan.
                            	//
                            	// This member is required.
                            	ScalingPlanVersion *int64
                            }

                            type DeleteScalingPlanOutput

                            type DeleteScalingPlanOutput struct {
                            	// Metadata pertaining to the operation's result.
                            	ResultMetadata middleware.Metadata
                            }

                            type DescribeScalingPlanResourcesInput

                            type DescribeScalingPlanResourcesInput struct {
                            
                            	// The name of the scaling plan.
                            	//
                            	// This member is required.
                            	ScalingPlanName *string
                            
                            	// The version number of the scaling plan.
                            	//
                            	// This member is required.
                            	ScalingPlanVersion *int64
                            
                            	// The maximum number of scalable resources to return. The value must be between 1
                            	// and 50. The default value is 50.
                            	MaxResults *int32
                            
                            	// The token for the next set of results.
                            	NextToken *string
                            }

                            type DescribeScalingPlanResourcesOutput

                            type DescribeScalingPlanResourcesOutput struct {
                            
                            	// The token required to get the next set of results. This value is null if there
                            	// are no more results to return.
                            	NextToken *string
                            
                            	// Information about the scalable resources.
                            	ScalingPlanResources []types.ScalingPlanResource
                            
                            	// Metadata pertaining to the operation's result.
                            	ResultMetadata middleware.Metadata
                            }

                            type DescribeScalingPlansInput

                            type DescribeScalingPlansInput struct {
                            
                            	// The sources for the applications (up to 10). If you specify scaling plan names,
                            	// you cannot specify application sources.
                            	ApplicationSources []types.ApplicationSource
                            
                            	// The maximum number of scalable resources to return. This value can be between 1
                            	// and 50. The default value is 50.
                            	MaxResults *int32
                            
                            	// The token for the next set of results.
                            	NextToken *string
                            
                            	// The names of the scaling plans (up to 10). If you specify application sources,
                            	// you cannot specify scaling plan names.
                            	ScalingPlanNames []string
                            
                            	// The version number of the scaling plan. If you specify a scaling plan version,
                            	// you must also specify a scaling plan name.
                            	ScalingPlanVersion *int64
                            }

                            type DescribeScalingPlansOutput

                            type DescribeScalingPlansOutput struct {
                            
                            	// The token required to get the next set of results. This value is null if there
                            	// are no more results to return.
                            	NextToken *string
                            
                            	// Information about the scaling plans.
                            	ScalingPlans []types.ScalingPlan
                            
                            	// Metadata pertaining to the operation's result.
                            	ResultMetadata middleware.Metadata
                            }

                            type EndpointResolver

                            type EndpointResolver interface {
                            	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                            }

                              EndpointResolver interface for resolving service endpoints.

                              func EndpointResolverFromURL

                              func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                                EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                                type EndpointResolverFunc

                                type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                  EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                  func (EndpointResolverFunc) ResolveEndpoint

                                  func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                  type EndpointResolverOptions

                                  type EndpointResolverOptions = internalendpoints.Options

                                    EndpointResolverOptions is the service endpoint resolver options

                                    type GetScalingPlanResourceForecastDataInput

                                    type GetScalingPlanResourceForecastDataInput struct {
                                    
                                    	// The exclusive end time of the time range for the forecast data to get. The
                                    	// maximum time duration between the start and end time is seven days. Although
                                    	// this parameter can accept a date and time that is more than two days in the
                                    	// future, the availability of forecast data has limits. AWS Auto Scaling only
                                    	// issues forecasts for periods of two days in advance.
                                    	//
                                    	// This member is required.
                                    	EndTime *time.Time
                                    
                                    	// The type of forecast data to get.
                                    	//
                                    	// * LoadForecast: The load metric forecast.
                                    	//
                                    	// *
                                    	// CapacityForecast: The capacity forecast.
                                    	//
                                    	// * ScheduledActionMinCapacity: The
                                    	// minimum capacity for each scheduled scaling action. This data is calculated as
                                    	// the larger of two values: the capacity forecast or the minimum capacity in the
                                    	// scaling instruction.
                                    	//
                                    	// * ScheduledActionMaxCapacity: The maximum capacity for
                                    	// each scheduled scaling action. The calculation used is determined by the
                                    	// predictive scaling maximum capacity behavior setting in the scaling instruction.
                                    	//
                                    	// This member is required.
                                    	ForecastDataType types.ForecastDataType
                                    
                                    	// 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.
                                    	//
                                    	// This member is required.
                                    	ResourceId *string
                                    
                                    	// The scalable dimension for the resource.
                                    	//
                                    	// This member is required.
                                    	ScalableDimension types.ScalableDimension
                                    
                                    	// The name of the scaling plan.
                                    	//
                                    	// This member is required.
                                    	ScalingPlanName *string
                                    
                                    	// The version number of the scaling plan.
                                    	//
                                    	// This member is required.
                                    	ScalingPlanVersion *int64
                                    
                                    	// The namespace of the AWS service.
                                    	//
                                    	// This member is required.
                                    	ServiceNamespace types.ServiceNamespace
                                    
                                    	// The inclusive start time of the time range for the forecast data to get. The
                                    	// date and time can be at most 56 days before the current date and time.
                                    	//
                                    	// This member is required.
                                    	StartTime *time.Time
                                    }

                                    type GetScalingPlanResourceForecastDataOutput

                                    type GetScalingPlanResourceForecastDataOutput struct {
                                    
                                    	// The data points to return.
                                    	//
                                    	// This member is required.
                                    	Datapoints []types.Datapoint
                                    
                                    	// Metadata pertaining to the operation's result.
                                    	ResultMetadata middleware.Metadata
                                    }

                                    type HTTPClient

                                    type HTTPClient interface {
                                    	Do(*http.Request) (*http.Response, error)
                                    }

                                    type HTTPSignerV4

                                    type HTTPSignerV4 interface {
                                    	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                    }

                                    type Options

                                    type Options struct {
                                    	// Set of options to modify how an operation is invoked. These apply to all
                                    	// operations invoked for this client. Use functional options on operation call to
                                    	// modify this list for per operation behavior.
                                    	APIOptions []func(*middleware.Stack) error
                                    
                                    	// Configures the events that will be sent to the configured logger.
                                    	ClientLogMode aws.ClientLogMode
                                    
                                    	// The credentials object to use when signing requests.
                                    	Credentials aws.CredentialsProvider
                                    
                                    	// The endpoint options to be used when attempting to resolve an endpoint.
                                    	EndpointOptions EndpointResolverOptions
                                    
                                    	// The service endpoint resolver.
                                    	EndpointResolver EndpointResolver
                                    
                                    	// Signature Version 4 (SigV4) Signer
                                    	HTTPSignerV4 HTTPSignerV4
                                    
                                    	// The logger writer interface to write logging messages to.
                                    	Logger logging.Logger
                                    
                                    	// The region to send requests to. (Required)
                                    	Region string
                                    
                                    	// Retryer guides how HTTP requests should be retried in case of recoverable
                                    	// failures. When nil the API client will use a default retryer.
                                    	Retryer aws.Retryer
                                    
                                    	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                    	// implementation if nil.
                                    	HTTPClient HTTPClient
                                    }

                                    func (Options) Copy

                                    func (o Options) Copy() Options

                                      Copy creates a clone where the APIOptions list is deep copied.

                                      type ResolveEndpoint

                                      type ResolveEndpoint struct {
                                      	Resolver EndpointResolver
                                      	Options  EndpointResolverOptions
                                      }

                                      func (*ResolveEndpoint) HandleSerialize

                                      func (*ResolveEndpoint) ID

                                      func (*ResolveEndpoint) ID() string

                                      type UpdateScalingPlanInput

                                      type UpdateScalingPlanInput struct {
                                      
                                      	// The name of the scaling plan.
                                      	//
                                      	// This member is required.
                                      	ScalingPlanName *string
                                      
                                      	// The version number of the scaling plan.
                                      	//
                                      	// This member is required.
                                      	ScalingPlanVersion *int64
                                      
                                      	// A CloudFormation stack or set of tags.
                                      	ApplicationSource *types.ApplicationSource
                                      
                                      	// The scaling instructions.
                                      	ScalingInstructions []types.ScalingInstruction
                                      }

                                      type UpdateScalingPlanOutput

                                      type UpdateScalingPlanOutput struct {
                                      	// Metadata pertaining to the operation's result.
                                      	ResultMetadata middleware.Metadata
                                      }

                                      Directories

                                      Path Synopsis
                                      internal