autoscalingplans

package
v0.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 8 Imported by: 16

Documentation

Overview

Package autoscalingplans provides the client and types for making API requests to AWS Auto Scaling Plans.

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

See https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06 for more information on this service.

See autoscalingplans package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/autoscalingplans/

Using the Client

To use AWS Auto Scaling Plans with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Auto Scaling Plans client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/autoscalingplans/#New

Index

Constants

View Source 
const (
	ServiceName = "AWS Auto Scaling Plans" // Service's name
	ServiceID   = "AutoScalingPlans"       // Service's identifier
	EndpointsID = "autoscaling-plans"      // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeConcurrentUpdateException for service response error code
	// "ConcurrentUpdateException".
	//
	// Concurrent updates caused an exception, for example, if you request an update
	// to a scaling plan that already has a pending update.
	ErrCodeConcurrentUpdateException = "ConcurrentUpdateException"

	// ErrCodeInternalServiceException for service response error code
	// "InternalServiceException".
	//
	// The service encountered an internal error.
	ErrCodeInternalServiceException = "InternalServiceException"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// The token provided is not valid.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// Your account exceeded a limit. This exception is thrown when a per-account
	// resource limit is exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeObjectNotFoundException for service response error code
	// "ObjectNotFoundException".
	//
	// The specified object could not be found.
	ErrCodeObjectNotFoundException = "ObjectNotFoundException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// An exception was thrown for a validation issue. Review the parameters provided.
	ErrCodeValidationException = "ValidationException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ApplicationSource 

type ApplicationSource struct {

	// The Amazon Resource Name (ARN) of a AWS CloudFormation stack.
	CloudFormationStackARN *string `type:"string"`

	// A set of tags (up to 50).
	TagFilters []TagFilter `type:"list"`
	// contains filtered or unexported fields
}

Represents an application source.

func (ApplicationSource) String 

func (s ApplicationSource) String() string

String returns the string representation

func (*ApplicationSource) Validate added in v0.4.0 

func (s *ApplicationSource) Validate() error

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

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to AWS Auto Scaling Plans. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := autoscalingplans.New(myConfig)

func (*Client) CreateScalingPlanRequest added in v0.9.0 

func (c *Client) CreateScalingPlanRequest(input *CreateScalingPlanInput) CreateScalingPlanRequest

CreateScalingPlanRequest returns a request value for making API operation for AWS Auto Scaling Plans.

Creates a scaling plan. 

// Example sending a request using CreateScalingPlanRequest.
req := client.CreateScalingPlanRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/CreateScalingPlan

func (*Client) DeleteScalingPlanRequest added in v0.9.0 

func (c *Client) DeleteScalingPlanRequest(input *DeleteScalingPlanInput) DeleteScalingPlanRequest

DeleteScalingPlanRequest returns a request value for making API operation for AWS Auto Scaling Plans.

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. 

// Example sending a request using DeleteScalingPlanRequest.
req := client.DeleteScalingPlanRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/DeleteScalingPlan

func (*Client) DescribeScalingPlanResourcesRequest added in v0.9.0 

func (c *Client) DescribeScalingPlanResourcesRequest(input *DescribeScalingPlanResourcesInput) DescribeScalingPlanResourcesRequest

DescribeScalingPlanResourcesRequest returns a request value for making API operation for AWS Auto Scaling Plans.

Describes the scalable resources in the specified scaling plan. 

// Example sending a request using DescribeScalingPlanResourcesRequest.
req := client.DescribeScalingPlanResourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/DescribeScalingPlanResources

func (*Client) DescribeScalingPlansRequest added in v0.9.0 

func (c *Client) DescribeScalingPlansRequest(input *DescribeScalingPlansInput) DescribeScalingPlansRequest

DescribeScalingPlansRequest returns a request value for making API operation for AWS Auto Scaling Plans.

Describes one or more of your scaling plans. 

// Example sending a request using DescribeScalingPlansRequest.
req := client.DescribeScalingPlansRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/DescribeScalingPlans

func (*Client) GetScalingPlanResourceForecastDataRequest added in v0.9.0 

func (c *Client) GetScalingPlanResourceForecastDataRequest(input *GetScalingPlanResourceForecastDataInput) GetScalingPlanResourceForecastDataRequest

GetScalingPlanResourceForecastDataRequest returns a request value for making API operation for AWS Auto Scaling Plans.

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. 

// Example sending a request using GetScalingPlanResourceForecastDataRequest.
req := client.GetScalingPlanResourceForecastDataRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/GetScalingPlanResourceForecastData

func (*Client) UpdateScalingPlanRequest added in v0.9.0 

func (c *Client) UpdateScalingPlanRequest(input *UpdateScalingPlanInput) UpdateScalingPlanRequest

UpdateScalingPlanRequest returns a request value for making API operation for AWS Auto Scaling Plans.

Updates the specified scaling plan.

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

// Example sending a request using UpdateScalingPlanRequest.
req := client.UpdateScalingPlanRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/UpdateScalingPlan

type CreateScalingPlanInput 

type CreateScalingPlanInput struct {

	// A CloudFormation stack or set of tags. You can create one scaling plan per
	// application source.
	//
	// ApplicationSource is a required field
	ApplicationSource *ApplicationSource `type:"structure" required:"true"`

	// The scaling instructions.
	//
	// ScalingInstructions is a required field
	ScalingInstructions []ScalingInstruction `type:"list" required:"true"`

	// The name of the scaling plan. Names cannot contain vertical bars, colons,
	// or forward slashes.
	//
	// ScalingPlanName is a required field
	ScalingPlanName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateScalingPlanInput) String 

func (s CreateScalingPlanInput) String() string

String returns the string representation

func (*CreateScalingPlanInput) Validate 

func (s *CreateScalingPlanInput) Validate() error

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

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.
	//
	// ScalingPlanVersion is a required field
	ScalingPlanVersion *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (CreateScalingPlanOutput) String 

func (s CreateScalingPlanOutput) String() string

String returns the string representation

type CreateScalingPlanRequest 

type CreateScalingPlanRequest struct {
	*aws.Request
	Input *CreateScalingPlanInput
	Copy  func(*CreateScalingPlanInput) CreateScalingPlanRequest
}

CreateScalingPlanRequest is the request type for the CreateScalingPlan API operation.

func (CreateScalingPlanRequest) Send 

func (r CreateScalingPlanRequest) Send(ctx context.Context) (*CreateScalingPlanResponse, error)

Send marshals and sends the CreateScalingPlan API request.

type CreateScalingPlanResponse added in v0.9.0 

type CreateScalingPlanResponse struct {
	*CreateScalingPlanOutput
	// contains filtered or unexported fields
}

CreateScalingPlanResponse is the response type for the CreateScalingPlan API operation.

func (*CreateScalingPlanResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateScalingPlanResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateScalingPlan request.

type CustomizedLoadMetricSpecification added in v0.6.0 

type CustomizedLoadMetricSpecification struct {

	// The dimensions of the metric.
	//
	// Conditional: If you published your metric with dimensions, you must specify
	// the same dimensions in your customized load metric specification.
	Dimensions []MetricDimension `type:"list"`

	// The name of the metric.
	//
	// MetricName is a required field
	MetricName *string `type:"string" required:"true"`

	// The namespace of the metric.
	//
	// Namespace is a required field
	Namespace *string `type:"string" required:"true"`

	// The statistic of the metric. Currently, the value must always be Sum.
	//
	// Statistic is a required field
	Statistic MetricStatistic `type:"string" required:"true" enum:"true"`

	// The unit of the metric.
	Unit *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a CloudWatch metric of your choosing that can be used for predictive scaling.

For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the Sum and Average statistics that CloudWatch computes from metric data. Statistics are calculations used to aggregate data over specified time periods.

When you choose a load metric, make sure that the required Sum and Average statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The Sum statistic must represent the total load on the resource, and the Average statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the Sum statistic represents the total request count processed by the group, then the Average statistic for the specified metric must represent the average request count processed by each instance of the group.

For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the Amazon CloudWatch User Guide.

func (CustomizedLoadMetricSpecification) String added in v0.6.0 

func (s CustomizedLoadMetricSpecification) String() string

String returns the string representation

func (*CustomizedLoadMetricSpecification) Validate added in v0.6.0 

func (s *CustomizedLoadMetricSpecification) Validate() error

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

type CustomizedScalingMetricSpecification 

type CustomizedScalingMetricSpecification struct {

	// The dimensions of the metric.
	//
	// Conditional: If you published your metric with dimensions, you must specify
	// the same dimensions in your customized scaling metric specification.
	Dimensions []MetricDimension `type:"list"`

	// The name of the metric.
	//
	// MetricName is a required field
	MetricName *string `type:"string" required:"true"`

	// The namespace of the metric.
	//
	// Namespace is a required field
	Namespace *string `type:"string" required:"true"`

	// The statistic of the metric.
	//
	// Statistic is a required field
	Statistic MetricStatistic `type:"string" required:"true" enum:"true"`

	// The unit of the metric.
	Unit *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a CloudWatch metric of your choosing that can be used for dynamic scaling as part of a target tracking scaling policy.

To create your customized scaling metric specification:

  • Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) in the Amazon CloudWatch User Guide.

  • Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.

For more information about CloudWatch, see Amazon CloudWatch Concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html).

func (CustomizedScalingMetricSpecification) String 

func (s CustomizedScalingMetricSpecification) String() string

String returns the string representation

func (*CustomizedScalingMetricSpecification) Validate 

func (s *CustomizedScalingMetricSpecification) Validate() error

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

type Datapoint added in v0.6.0 

type Datapoint struct {

	// The time stamp for the data point in UTC format.
	Timestamp *time.Time `type:"timestamp"`

	// The value of the data point.
	Value *float64 `type:"double"`
	// contains filtered or unexported fields
}

Represents a single value in the forecast data used for predictive scaling.

func (Datapoint) String added in v0.6.0 

func (s Datapoint) String() string

String returns the string representation

type DeleteScalingPlanInput 

type DeleteScalingPlanInput struct {

	// The name of the scaling plan.
	//
	// ScalingPlanName is a required field
	ScalingPlanName *string `min:"1" type:"string" required:"true"`

	// The version number of the scaling plan.
	//
	// ScalingPlanVersion is a required field
	ScalingPlanVersion *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteScalingPlanInput) String 

func (s DeleteScalingPlanInput) String() string

String returns the string representation

func (*DeleteScalingPlanInput) Validate 

func (s *DeleteScalingPlanInput) Validate() error

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

type DeleteScalingPlanOutput 

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

func (DeleteScalingPlanOutput) String 

func (s DeleteScalingPlanOutput) String() string

String returns the string representation

type DeleteScalingPlanRequest 

type DeleteScalingPlanRequest struct {
	*aws.Request
	Input *DeleteScalingPlanInput
	Copy  func(*DeleteScalingPlanInput) DeleteScalingPlanRequest
}

DeleteScalingPlanRequest is the request type for the DeleteScalingPlan API operation.

func (DeleteScalingPlanRequest) Send 

func (r DeleteScalingPlanRequest) Send(ctx context.Context) (*DeleteScalingPlanResponse, error)

Send marshals and sends the DeleteScalingPlan API request.

type DeleteScalingPlanResponse added in v0.9.0 

type DeleteScalingPlanResponse struct {
	*DeleteScalingPlanOutput
	// contains filtered or unexported fields
}

DeleteScalingPlanResponse is the response type for the DeleteScalingPlan API operation.

func (*DeleteScalingPlanResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteScalingPlanResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteScalingPlan request.

type DescribeScalingPlanResourcesInput 

type DescribeScalingPlanResourcesInput struct {

	// The maximum number of scalable resources to return. The value must be between
	// 1 and 50. The default value is 50.
	MaxResults *int64 `type:"integer"`

	// The token for the next set of results.
	NextToken *string `type:"string"`

	// The name of the scaling plan.
	//
	// ScalingPlanName is a required field
	ScalingPlanName *string `min:"1" type:"string" required:"true"`

	// The version number of the scaling plan.
	//
	// ScalingPlanVersion is a required field
	ScalingPlanVersion *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeScalingPlanResourcesInput) String 

func (s DescribeScalingPlanResourcesInput) String() string

String returns the string representation

func (*DescribeScalingPlanResourcesInput) Validate 

func (s *DescribeScalingPlanResourcesInput) Validate() error

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

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 `type:"string"`

	// Information about the scalable resources.
	ScalingPlanResources []ScalingPlanResource `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeScalingPlanResourcesOutput) String 

func (s DescribeScalingPlanResourcesOutput) String() string

String returns the string representation

type DescribeScalingPlanResourcesRequest 

type DescribeScalingPlanResourcesRequest struct {
	*aws.Request
	Input *DescribeScalingPlanResourcesInput
	Copy  func(*DescribeScalingPlanResourcesInput) DescribeScalingPlanResourcesRequest
}

DescribeScalingPlanResourcesRequest is the request type for the DescribeScalingPlanResources API operation.

func (DescribeScalingPlanResourcesRequest) Send 

func (r DescribeScalingPlanResourcesRequest) Send(ctx context.Context) (*DescribeScalingPlanResourcesResponse, error)

Send marshals and sends the DescribeScalingPlanResources API request.

type DescribeScalingPlanResourcesResponse added in v0.9.0 

type DescribeScalingPlanResourcesResponse struct {
	*DescribeScalingPlanResourcesOutput
	// contains filtered or unexported fields
}

DescribeScalingPlanResourcesResponse is the response type for the DescribeScalingPlanResources API operation.

func (*DescribeScalingPlanResourcesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeScalingPlanResourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeScalingPlanResources request.

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 []ApplicationSource `type:"list"`

	// The maximum number of scalable resources to return. This value can be between
	// 1 and 50. The default value is 50.
	MaxResults *int64 `type:"integer"`

	// The token for the next set of results.
	NextToken *string `type:"string"`

	// The names of the scaling plans (up to 10). If you specify application sources,
	// you cannot specify scaling plan names.
	ScalingPlanNames []string `type:"list"`

	// 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:"long"`
	// contains filtered or unexported fields
}

func (DescribeScalingPlansInput) String 

func (s DescribeScalingPlansInput) String() string

String returns the string representation

func (*DescribeScalingPlansInput) Validate added in v0.4.0 

func (s *DescribeScalingPlansInput) Validate() error

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

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 `type:"string"`

	// Information about the scaling plans.
	ScalingPlans []ScalingPlan `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeScalingPlansOutput) String 

func (s DescribeScalingPlansOutput) String() string

String returns the string representation

type DescribeScalingPlansRequest 

type DescribeScalingPlansRequest struct {
	*aws.Request
	Input *DescribeScalingPlansInput
	Copy  func(*DescribeScalingPlansInput) DescribeScalingPlansRequest
}

DescribeScalingPlansRequest is the request type for the DescribeScalingPlans API operation.

func (DescribeScalingPlansRequest) Send 

func (r DescribeScalingPlansRequest) Send(ctx context.Context) (*DescribeScalingPlansResponse, error)

Send marshals and sends the DescribeScalingPlans API request.

type DescribeScalingPlansResponse added in v0.9.0 

type DescribeScalingPlansResponse struct {
	*DescribeScalingPlansOutput
	// contains filtered or unexported fields
}

DescribeScalingPlansResponse is the response type for the DescribeScalingPlans API operation.

func (*DescribeScalingPlansResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeScalingPlansResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeScalingPlans request.

type ForecastDataType added in v0.6.0 

type ForecastDataType string
const (
	ForecastDataTypeCapacityForecast           ForecastDataType = "CapacityForecast"
	ForecastDataTypeLoadForecast               ForecastDataType = "LoadForecast"
	ForecastDataTypeScheduledActionMinCapacity ForecastDataType = "ScheduledActionMinCapacity"
	ForecastDataTypeScheduledActionMaxCapacity ForecastDataType = "ScheduledActionMaxCapacity"
)

Enum values for ForecastDataType

func (ForecastDataType) MarshalValue added in v0.6.0 

func (enum ForecastDataType) MarshalValue() (string, error)

func (ForecastDataType) MarshalValueBuf added in v0.6.0 

func (enum ForecastDataType) MarshalValueBuf(b []byte) ([]byte, error)

type GetScalingPlanResourceForecastDataInput added in v0.6.0 

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.
	//
	// EndTime is a required field
	EndTime *time.Time `type:"timestamp" required:"true"`

	// 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.
	//
	// ForecastDataType is a required field
	ForecastDataType ForecastDataType `type:"string" required:"true" enum:"true"`

	// 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.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`

	// The scalable dimension for the resource.
	//
	// ScalableDimension is a required field
	ScalableDimension ScalableDimension `type:"string" required:"true" enum:"true"`

	// The name of the scaling plan.
	//
	// ScalingPlanName is a required field
	ScalingPlanName *string `min:"1" type:"string" required:"true"`

	// The version number of the scaling plan.
	//
	// ScalingPlanVersion is a required field
	ScalingPlanVersion *int64 `type:"long" required:"true"`

	// The namespace of the AWS service.
	//
	// ServiceNamespace is a required field
	ServiceNamespace ServiceNamespace `type:"string" required:"true" enum:"true"`

	// 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.
	//
	// StartTime is a required field
	StartTime *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (GetScalingPlanResourceForecastDataInput) String added in v0.6.0 

func (s GetScalingPlanResourceForecastDataInput) String() string

String returns the string representation

func (*GetScalingPlanResourceForecastDataInput) Validate added in v0.6.0 

func (s *GetScalingPlanResourceForecastDataInput) Validate() error

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

type GetScalingPlanResourceForecastDataOutput added in v0.6.0 

type GetScalingPlanResourceForecastDataOutput struct {

	// The data points to return.
	//
	// Datapoints is a required field
	Datapoints []Datapoint `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (GetScalingPlanResourceForecastDataOutput) String added in v0.6.0 

func (s GetScalingPlanResourceForecastDataOutput) String() string

String returns the string representation

type GetScalingPlanResourceForecastDataRequest added in v0.6.0 

type GetScalingPlanResourceForecastDataRequest struct {
	*aws.Request
	Input *GetScalingPlanResourceForecastDataInput
	Copy  func(*GetScalingPlanResourceForecastDataInput) GetScalingPlanResourceForecastDataRequest
}

GetScalingPlanResourceForecastDataRequest is the request type for the GetScalingPlanResourceForecastData API operation.

func (GetScalingPlanResourceForecastDataRequest) Send added in v0.6.0 

func (r GetScalingPlanResourceForecastDataRequest) Send(ctx context.Context) (*GetScalingPlanResourceForecastDataResponse, error)

Send marshals and sends the GetScalingPlanResourceForecastData API request.

type GetScalingPlanResourceForecastDataResponse added in v0.9.0 

type GetScalingPlanResourceForecastDataResponse struct {
	*GetScalingPlanResourceForecastDataOutput
	// contains filtered or unexported fields
}

GetScalingPlanResourceForecastDataResponse is the response type for the GetScalingPlanResourceForecastData API operation.

func (*GetScalingPlanResourceForecastDataResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetScalingPlanResourceForecastDataResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetScalingPlanResourceForecastData request.

type LoadMetricType added in v0.6.0 

type LoadMetricType string
const (
	LoadMetricTypeAsgtotalCpuutilization     LoadMetricType = "ASGTotalCPUUtilization"
	LoadMetricTypeAsgtotalNetworkIn          LoadMetricType = "ASGTotalNetworkIn"
	LoadMetricTypeAsgtotalNetworkOut         LoadMetricType = "ASGTotalNetworkOut"
	LoadMetricTypeAlbtargetGroupRequestCount LoadMetricType = "ALBTargetGroupRequestCount"
)

Enum values for LoadMetricType

func (LoadMetricType) MarshalValue added in v0.6.0 

func (enum LoadMetricType) MarshalValue() (string, error)

func (LoadMetricType) MarshalValueBuf added in v0.6.0 

func (enum LoadMetricType) MarshalValueBuf(b []byte) ([]byte, error)

type MetricDimension 

type MetricDimension struct {

	// The name of the dimension.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The value of the dimension.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a dimension for a customized metric.

func (MetricDimension) String 

func (s MetricDimension) String() string

String returns the string representation

func (*MetricDimension) Validate 

func (s *MetricDimension) Validate() error

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

type MetricStatistic 

type MetricStatistic string
const (
	MetricStatisticAverage     MetricStatistic = "Average"
	MetricStatisticMinimum     MetricStatistic = "Minimum"
	MetricStatisticMaximum     MetricStatistic = "Maximum"
	MetricStatisticSampleCount MetricStatistic = "SampleCount"
	MetricStatisticSum         MetricStatistic = "Sum"
)

Enum values for MetricStatistic

func (MetricStatistic) MarshalValue 

func (enum MetricStatistic) MarshalValue() (string, error)

func (MetricStatistic) MarshalValueBuf 

func (enum MetricStatistic) MarshalValueBuf(b []byte) ([]byte, error)

type PolicyType 

type PolicyType string
const (
	PolicyTypeTargetTrackingScaling PolicyType = "TargetTrackingScaling"
)

Enum values for PolicyType

func (PolicyType) MarshalValue 

func (enum PolicyType) MarshalValue() (string, error)

func (PolicyType) MarshalValueBuf 

func (enum PolicyType) MarshalValueBuf(b []byte) ([]byte, error)

type PredefinedLoadMetricSpecification added in v0.6.0 

type PredefinedLoadMetricSpecification struct {

	// The metric type.
	//
	// PredefinedLoadMetricType is a required field
	PredefinedLoadMetricType LoadMetricType `type:"string" required:"true" enum:"true"`

	// Identifies the resource associated with the metric type. You can't specify
	// a resource label unless the metric type is ALBRequestCountPerTarget and there
	// is a target group for an Application Load Balancer attached to the Auto Scaling
	// group.
	//
	// The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>,
	// where:
	//
	//    * app/<load-balancer-name>/<load-balancer-id> is the final portion of
	//    the load balancer ARN.
	//
	//    * targetgroup/<target-group-name>/<target-group-id> is the final portion
	//    of the target group ARN.
	ResourceLabel *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents a predefined metric that can be used for predictive scaling.

func (PredefinedLoadMetricSpecification) String added in v0.6.0 

func (s PredefinedLoadMetricSpecification) String() string

String returns the string representation

func (*PredefinedLoadMetricSpecification) Validate added in v0.6.0 

func (s *PredefinedLoadMetricSpecification) Validate() error

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

type PredefinedScalingMetricSpecification 

type PredefinedScalingMetricSpecification struct {

	// The metric type. The ALBRequestCountPerTarget metric type applies only to
	// Auto Scaling groups, Spot Fleet requests, and ECS services.
	//
	// PredefinedScalingMetricType is a required field
	PredefinedScalingMetricType ScalingMetricType `type:"string" required:"true" enum:"true"`

	// Identifies the resource associated with the metric type. You can't specify
	// a resource label unless the metric type is ALBRequestCountPerTarget and there
	// is a target group for an Application Load Balancer attached to the Auto Scaling
	// group, Spot Fleet request, or ECS service.
	//
	// The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>,
	// where:
	//
	//    * app/<load-balancer-name>/<load-balancer-id> is the final portion of
	//    the load balancer ARN.
	//
	//    * targetgroup/<target-group-name>/<target-group-id> is the final portion
	//    of the target group ARN.
	ResourceLabel *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents a predefined metric that can be used for dynamic scaling as part of a target tracking scaling policy.

func (PredefinedScalingMetricSpecification) String 

func (s PredefinedScalingMetricSpecification) String() string

String returns the string representation

func (*PredefinedScalingMetricSpecification) Validate 

func (s *PredefinedScalingMetricSpecification) Validate() error

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

type PredictiveScalingMaxCapacityBehavior added in v0.6.0 

type PredictiveScalingMaxCapacityBehavior string
const (
	PredictiveScalingMaxCapacityBehaviorSetForecastCapacityToMaxCapacity    PredictiveScalingMaxCapacityBehavior = "SetForecastCapacityToMaxCapacity"
	PredictiveScalingMaxCapacityBehaviorSetMaxCapacityToForecastCapacity    PredictiveScalingMaxCapacityBehavior = "SetMaxCapacityToForecastCapacity"
	PredictiveScalingMaxCapacityBehaviorSetMaxCapacityAboveForecastCapacity PredictiveScalingMaxCapacityBehavior = "SetMaxCapacityAboveForecastCapacity"
)

Enum values for PredictiveScalingMaxCapacityBehavior

func (PredictiveScalingMaxCapacityBehavior) MarshalValue added in v0.6.0 

func (enum PredictiveScalingMaxCapacityBehavior) MarshalValue() (string, error)

func (PredictiveScalingMaxCapacityBehavior) MarshalValueBuf added in v0.6.0 

func (enum PredictiveScalingMaxCapacityBehavior) MarshalValueBuf(b []byte) ([]byte, error)

type PredictiveScalingMode added in v0.6.0 

type PredictiveScalingMode string
const (
	PredictiveScalingModeForecastAndScale PredictiveScalingMode = "ForecastAndScale"
	PredictiveScalingModeForecastOnly     PredictiveScalingMode = "ForecastOnly"
)

Enum values for PredictiveScalingMode

func (PredictiveScalingMode) MarshalValue added in v0.6.0 

func (enum PredictiveScalingMode) MarshalValue() (string, error)

func (PredictiveScalingMode) MarshalValueBuf added in v0.6.0 

func (enum PredictiveScalingMode) MarshalValueBuf(b []byte) ([]byte, error)

type ScalableDimension 

type ScalableDimension string
const (
	ScalableDimensionAutoscalingAutoScalingGroupDesiredCapacity ScalableDimension = "autoscaling:autoScalingGroup:DesiredCapacity"
	ScalableDimensionEcsServiceDesiredCount                     ScalableDimension = "ecs:service:DesiredCount"
	ScalableDimensionEc2SpotFleetRequestTargetCapacity          ScalableDimension = "ec2:spot-fleet-request:TargetCapacity"
	ScalableDimensionRdsClusterReadReplicaCount                 ScalableDimension = "rds:cluster:ReadReplicaCount"
	ScalableDimensionDynamodbTableReadCapacityUnits             ScalableDimension = "dynamodb:table:ReadCapacityUnits"
	ScalableDimensionDynamodbTableWriteCapacityUnits            ScalableDimension = "dynamodb:table:WriteCapacityUnits"
	ScalableDimensionDynamodbIndexReadCapacityUnits             ScalableDimension = "dynamodb:index:ReadCapacityUnits"
	ScalableDimensionDynamodbIndexWriteCapacityUnits            ScalableDimension = "dynamodb:index:WriteCapacityUnits"
)

Enum values for ScalableDimension

func (ScalableDimension) MarshalValue 

func (enum ScalableDimension) MarshalValue() (string, error)

func (ScalableDimension) MarshalValueBuf 

func (enum ScalableDimension) MarshalValueBuf(b []byte) ([]byte, error)

type ScalingInstruction 

type ScalingInstruction struct {

	// The customized load metric to use for predictive scaling. This parameter
	// or a PredefinedLoadMetricSpecification is required when configuring predictive
	// scaling, and cannot be used otherwise.
	CustomizedLoadMetricSpecification *CustomizedLoadMetricSpecification `type:"structure"`

	// Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic
	// scaling is enabled, AWS Auto Scaling creates target tracking scaling policies
	// based on the specified target tracking configurations.
	//
	// The default is enabled (false).
	DisableDynamicScaling *bool `type:"boolean"`

	// The maximum capacity of the resource. The exception to this upper limit is
	// if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.
	//
	// MaxCapacity is a required field
	MaxCapacity *int64 `type:"integer" required:"true"`

	// The minimum capacity of the resource.
	//
	// MinCapacity is a required field
	MinCapacity *int64 `type:"integer" required:"true"`

	// The predefined load metric to use for predictive scaling. This parameter
	// or a CustomizedLoadMetricSpecification is required when configuring predictive
	// scaling, and cannot be used otherwise.
	PredefinedLoadMetricSpecification *PredefinedLoadMetricSpecification `type:"structure"`

	// Defines the behavior that should be applied if the forecast capacity approaches
	// or exceeds the maximum capacity specified for the resource. The default value
	// is SetForecastCapacityToMaxCapacity.
	//
	// The following are possible values:
	//
	//    * SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource
	//    capacity higher than the maximum capacity. The maximum capacity is enforced
	//    as a hard limit.
	//
	//    * SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource
	//    capacity higher than the maximum capacity to equal but not exceed forecast
	//    capacity.
	//
	//    * SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource
	//    capacity higher than the maximum capacity by a specified buffer value.
	//    The intention is to give the target tracking scaling policy extra capacity
	//    if unexpected traffic occurs.
	//
	// Only valid when configuring predictive scaling.
	PredictiveScalingMaxCapacityBehavior PredictiveScalingMaxCapacityBehavior `type:"string" enum:"true"`

	// The size of the capacity buffer to use when the forecast capacity is close
	// to or exceeds the maximum capacity. The value is specified as a percentage
	// relative to the forecast capacity. For example, if the buffer is 10, this
	// means a 10 percent buffer, such that if the forecast capacity is 50, and
	// the maximum capacity is 40, then the effective maximum capacity is 55.
	//
	// Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior
	// is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.
	//
	// The range is 1-100.
	PredictiveScalingMaxCapacityBuffer *int64 `type:"integer"`

	// The predictive scaling mode. The default value is ForecastAndScale. Otherwise,
	// AWS Auto Scaling forecasts capacity but does not create any scheduled scaling
	// actions based on the capacity forecast.
	PredictiveScalingMode PredictiveScalingMode `type:"string" enum:"true"`

	// 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.
	//
	// ResourceId is a required field
	ResourceId *string `min:"1" type:"string" required:"true"`

	// The scalable dimension associated with the resource.
	//
	//    * autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity
	//    of an Auto Scaling group.
	//
	//    * ecs:service:DesiredCount - The desired task count of an ECS service.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    Fleet request.
	//
	//    * 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.
	//
	// ScalableDimension is a required field
	ScalableDimension ScalableDimension `type:"string" required:"true" enum:"true"`

	// Controls whether a resource's externally created scaling policies are kept
	// or replaced.
	//
	// The default value is KeepExternalPolicies. If the parameter is set to ReplaceExternalPolicies,
	// any scaling policies that are external to AWS Auto Scaling are deleted and
	// new target tracking scaling policies created.
	//
	// Only valid when configuring dynamic scaling.
	//
	// Condition: The number of existing policies to be replaced must be less than
	// or equal to 50. If there are more than 50 policies to be replaced, AWS Auto
	// Scaling keeps all existing policies and does not create new ones.
	ScalingPolicyUpdateBehavior ScalingPolicyUpdateBehavior `type:"string" enum:"true"`

	// The amount of time, in seconds, to buffer the run time of scheduled scaling
	// actions when scaling out. For example, if the forecast says to add capacity
	// at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding
	// scheduled scaling action will be 9:55 AM. The intention is to give resources
	// time to be provisioned. For example, it can take a few minutes to launch
	// an EC2 instance. The actual amount of time required depends on several factors,
	// such as the size of the instance and whether there are startup scripts to
	// complete.
	//
	// The value must be less than the forecast interval duration of 3600 seconds
	// (60 minutes). The default is 300 seconds.
	//
	// Only valid when configuring predictive scaling.
	ScheduledActionBufferTime *int64 `type:"integer"`

	// The namespace of the AWS service.
	//
	// ServiceNamespace is a required field
	ServiceNamespace ServiceNamespace `type:"string" required:"true" enum:"true"`

	// The structure that defines new target tracking configurations (up to 10).
	// Each of these structures includes a specific scaling metric and a target
	// value for the metric, along with various parameters to use with dynamic scaling.
	//
	// With predictive scaling and dynamic scaling, the resource scales based on
	// the target tracking configuration that provides the largest capacity for
	// both scale in and scale out.
	//
	// Condition: The scaling metric must be unique across target tracking configurations.
	//
	// TargetTrackingConfigurations is a required field
	TargetTrackingConfigurations []TargetTrackingConfiguration `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Describes a scaling instruction for a scalable resource.

The scaling instruction is used in combination with a scaling plan, which is a set of instructions for configuring dynamic scaling and predictive scaling for the scalable resources in your application. Each scaling instruction applies to one resource.

AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.

AWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto Scaling groups using a subset of parameters, including the load metric, the scaling metric, the target value for the scaling metric, the predictive scaling mode (forecast and scale or forecast only), and the desired behavior when the forecast capacity exceeds the maximum capacity of the resource. With predictive scaling, AWS Auto Scaling generates forecasts with traffic predictions for the two days ahead and schedules scaling actions that proactively add and remove resource capacity to match the forecast.

We recommend waiting a minimum of 24 hours after creating an Auto Scaling group to configure predictive scaling. At minimum, there must be 24 hours of historical data to generate a forecast.

For more information, see Getting Started with AWS Auto Scaling (https://docs.aws.amazon.com/autoscaling/plans/userguide/auto-scaling-getting-started.html).

func (ScalingInstruction) String 

func (s ScalingInstruction) String() string

String returns the string representation

func (*ScalingInstruction) Validate 

func (s *ScalingInstruction) Validate() error

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

type ScalingMetricType 

type ScalingMetricType string
const (
	ScalingMetricTypeAsgaverageCpuutilization                 ScalingMetricType = "ASGAverageCPUUtilization"
	ScalingMetricTypeAsgaverageNetworkIn                      ScalingMetricType = "ASGAverageNetworkIn"
	ScalingMetricTypeAsgaverageNetworkOut                     ScalingMetricType = "ASGAverageNetworkOut"
	ScalingMetricTypeDynamoDbreadCapacityUtilization          ScalingMetricType = "DynamoDBReadCapacityUtilization"
	ScalingMetricTypeDynamoDbwriteCapacityUtilization         ScalingMetricType = "DynamoDBWriteCapacityUtilization"
	ScalingMetricTypeEcsserviceAverageCpuutilization          ScalingMetricType = "ECSServiceAverageCPUUtilization"
	ScalingMetricTypeEcsserviceAverageMemoryUtilization       ScalingMetricType = "ECSServiceAverageMemoryUtilization"
	ScalingMetricTypeAlbrequestCountPerTarget                 ScalingMetricType = "ALBRequestCountPerTarget"
	ScalingMetricTypeRdsreaderAverageCpuutilization           ScalingMetricType = "RDSReaderAverageCPUUtilization"
	ScalingMetricTypeRdsreaderAverageDatabaseConnections      ScalingMetricType = "RDSReaderAverageDatabaseConnections"
	ScalingMetricTypeEc2spotFleetRequestAverageCpuutilization ScalingMetricType = "EC2SpotFleetRequestAverageCPUUtilization"
	ScalingMetricTypeEc2spotFleetRequestAverageNetworkIn      ScalingMetricType = "EC2SpotFleetRequestAverageNetworkIn"
	ScalingMetricTypeEc2spotFleetRequestAverageNetworkOut     ScalingMetricType = "EC2SpotFleetRequestAverageNetworkOut"
)

Enum values for ScalingMetricType

func (ScalingMetricType) MarshalValue 

func (enum ScalingMetricType) MarshalValue() (string, error)

func (ScalingMetricType) MarshalValueBuf 

func (enum ScalingMetricType) MarshalValueBuf(b []byte) ([]byte, error)

type ScalingPlan 

type ScalingPlan struct {

	// The application source.
	//
	// ApplicationSource is a required field
	ApplicationSource *ApplicationSource `type:"structure" required:"true"`

	// The Unix time stamp when the scaling plan was created.
	CreationTime *time.Time `type:"timestamp"`

	// The scaling instructions.
	//
	// ScalingInstructions is a required field
	ScalingInstructions []ScalingInstruction `type:"list" required:"true"`

	// The name of the scaling plan.
	//
	// ScalingPlanName is a required field
	ScalingPlanName *string `min:"1" type:"string" required:"true"`

	// The version number of the scaling plan.
	//
	// ScalingPlanVersion is a required field
	ScalingPlanVersion *int64 `type:"long" required:"true"`

	// The status of the scaling plan.
	//
	//    * Active - The scaling plan is active.
	//
	//    * ActiveWithProblems - The scaling plan is active, but the scaling configuration
	//    for one or more resources could not be applied.
	//
	//    * CreationInProgress - The scaling plan is being created.
	//
	//    * CreationFailed - The scaling plan could not be created.
	//
	//    * DeletionInProgress - The scaling plan is being deleted.
	//
	//    * DeletionFailed - The scaling plan could not be deleted.
	//
	//    * UpdateInProgress - The scaling plan is being updated.
	//
	//    * UpdateFailed - The scaling plan could not be updated.
	//
	// StatusCode is a required field
	StatusCode ScalingPlanStatusCode `type:"string" required:"true" enum:"true"`

	// A simple message about the current status of the scaling plan.
	StatusMessage *string `type:"string"`

	// The Unix time stamp when the scaling plan entered the current status.
	StatusStartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Represents a scaling plan.

func (ScalingPlan) String 

func (s ScalingPlan) String() string

String returns the string representation

type ScalingPlanResource 

type ScalingPlanResource struct {

	// 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.
	//
	// ResourceId is a required field
	ResourceId *string `min:"1" type:"string" required:"true"`

	// The scalable dimension for the resource.
	//
	//    * autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity
	//    of an Auto Scaling group.
	//
	//    * ecs:service:DesiredCount - The desired task count of an ECS service.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    Fleet request.
	//
	//    * 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.
	//
	// ScalableDimension is a required field
	ScalableDimension ScalableDimension `type:"string" required:"true" enum:"true"`

	// The name of the scaling plan.
	//
	// ScalingPlanName is a required field
	ScalingPlanName *string `min:"1" type:"string" required:"true"`

	// The version number of the scaling plan.
	//
	// ScalingPlanVersion is a required field
	ScalingPlanVersion *int64 `type:"long" required:"true"`

	// The scaling policies.
	ScalingPolicies []ScalingPolicy `type:"list"`

	// The scaling status of the resource.
	//
	//    * Active - The scaling configuration is active.
	//
	//    * Inactive - The scaling configuration is not active because the scaling
	//    plan is being created or the scaling configuration could not be applied.
	//    Check the status message for more information.
	//
	//    * PartiallyActive - The scaling configuration is partially active because
	//    the scaling plan is being created or deleted or the scaling configuration
	//    could not be fully applied. Check the status message for more information.
	//
	// ScalingStatusCode is a required field
	ScalingStatusCode ScalingStatusCode `type:"string" required:"true" enum:"true"`

	// A simple message about the current scaling status of the resource.
	ScalingStatusMessage *string `type:"string"`

	// The namespace of the AWS service.
	//
	// ServiceNamespace is a required field
	ServiceNamespace ServiceNamespace `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Represents a scalable resource.

func (ScalingPlanResource) String 

func (s ScalingPlanResource) String() string

String returns the string representation

type ScalingPlanStatusCode 

type ScalingPlanStatusCode string
const (
	ScalingPlanStatusCodeActive             ScalingPlanStatusCode = "Active"
	ScalingPlanStatusCodeActiveWithProblems ScalingPlanStatusCode = "ActiveWithProblems"
	ScalingPlanStatusCodeCreationInProgress ScalingPlanStatusCode = "CreationInProgress"
	ScalingPlanStatusCodeCreationFailed     ScalingPlanStatusCode = "CreationFailed"
	ScalingPlanStatusCodeDeletionInProgress ScalingPlanStatusCode = "DeletionInProgress"
	ScalingPlanStatusCodeDeletionFailed     ScalingPlanStatusCode = "DeletionFailed"
	ScalingPlanStatusCodeUpdateInProgress   ScalingPlanStatusCode = "UpdateInProgress"
	ScalingPlanStatusCodeUpdateFailed       ScalingPlanStatusCode = "UpdateFailed"
)

Enum values for ScalingPlanStatusCode

func (ScalingPlanStatusCode) MarshalValue 

func (enum ScalingPlanStatusCode) MarshalValue() (string, error)

func (ScalingPlanStatusCode) MarshalValueBuf 

func (enum ScalingPlanStatusCode) MarshalValueBuf(b []byte) ([]byte, error)

type ScalingPolicy 

type ScalingPolicy struct {

	// The name of the scaling policy.
	//
	// PolicyName is a required field
	PolicyName *string `min:"1" type:"string" required:"true"`

	// The type of scaling policy.
	//
	// PolicyType is a required field
	PolicyType PolicyType `type:"string" required:"true" enum:"true"`

	// The target tracking scaling policy. Includes support for predefined or customized
	// metrics.
	TargetTrackingConfiguration *TargetTrackingConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Represents a scaling policy.

func (ScalingPolicy) String 

func (s ScalingPolicy) String() string

String returns the string representation

type ScalingPolicyUpdateBehavior added in v0.6.0 

type ScalingPolicyUpdateBehavior string
const (
	ScalingPolicyUpdateBehaviorKeepExternalPolicies    ScalingPolicyUpdateBehavior = "KeepExternalPolicies"
	ScalingPolicyUpdateBehaviorReplaceExternalPolicies ScalingPolicyUpdateBehavior = "ReplaceExternalPolicies"
)

Enum values for ScalingPolicyUpdateBehavior

func (ScalingPolicyUpdateBehavior) MarshalValue added in v0.6.0 

func (enum ScalingPolicyUpdateBehavior) MarshalValue() (string, error)

func (ScalingPolicyUpdateBehavior) MarshalValueBuf added in v0.6.0 

func (enum ScalingPolicyUpdateBehavior) MarshalValueBuf(b []byte) ([]byte, error)

type ScalingStatusCode 

type ScalingStatusCode string
const (
	ScalingStatusCodeInactive        ScalingStatusCode = "Inactive"
	ScalingStatusCodePartiallyActive ScalingStatusCode = "PartiallyActive"
	ScalingStatusCodeActive          ScalingStatusCode = "Active"
)

Enum values for ScalingStatusCode

func (ScalingStatusCode) MarshalValue 

func (enum ScalingStatusCode) MarshalValue() (string, error)

func (ScalingStatusCode) MarshalValueBuf 

func (enum ScalingStatusCode) MarshalValueBuf(b []byte) ([]byte, error)

type ServiceNamespace 

type ServiceNamespace string
const (
	ServiceNamespaceAutoscaling ServiceNamespace = "autoscaling"
	ServiceNamespaceEcs         ServiceNamespace = "ecs"
	ServiceNamespaceEc2         ServiceNamespace = "ec2"
	ServiceNamespaceRds         ServiceNamespace = "rds"
	ServiceNamespaceDynamodb    ServiceNamespace = "dynamodb"
)

Enum values for ServiceNamespace

func (ServiceNamespace) MarshalValue 

func (enum ServiceNamespace) MarshalValue() (string, error)

func (ServiceNamespace) MarshalValueBuf 

func (enum ServiceNamespace) MarshalValueBuf(b []byte) ([]byte, error)

type TagFilter added in v0.4.0 

type TagFilter struct {

	// The tag key.
	Key *string `min:"1" type:"string"`

	// The tag values (0 to 20).
	Values []string `type:"list"`
	// contains filtered or unexported fields
}

Represents a tag.

func (TagFilter) String added in v0.4.0 

func (s TagFilter) String() string

String returns the string representation

func (*TagFilter) Validate added in v0.4.0 

func (s *TagFilter) Validate() error

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

type TargetTrackingConfiguration 

type TargetTrackingConfiguration struct {

	// A customized metric. You can specify either a predefined metric or a customized
	// metric.
	CustomizedScalingMetricSpecification *CustomizedScalingMetricSpecification `type:"structure"`

	// Indicates whether scale in by the target tracking scaling policy is disabled.
	// If the value is true, scale in is disabled and the target tracking scaling
	// policy doesn't remove capacity from the scalable resource. Otherwise, scale
	// in is enabled and the target tracking scaling policy can remove capacity
	// from the scalable resource.
	//
	// The default value is false.
	DisableScaleIn *bool `type:"boolean"`

	// The estimated time, in seconds, until a newly launched instance can contribute
	// to the CloudWatch metrics. This value is used only if the resource is an
	// Auto Scaling group.
	EstimatedInstanceWarmup *int64 `type:"integer"`

	// A predefined metric. You can specify either a predefined metric or a customized
	// metric.
	PredefinedScalingMetricSpecification *PredefinedScalingMetricSpecification `type:"structure"`

	// The amount of time, in seconds, after a scale in activity completes before
	// another scale in activity can start. This value is not used if the scalable
	// resource is an Auto Scaling group.
	//
	// The cooldown period is used to block subsequent scale in requests until it
	// has expired. The intention is to scale in conservatively to protect your
	// application's availability. However, if another alarm triggers a scale-out
	// policy during the cooldown period after a scale-in, AWS Auto Scaling scales
	// out your scalable target immediately.
	ScaleInCooldown *int64 `type:"integer"`

	// The amount of time, in seconds, after a scale-out activity completes before
	// another scale-out activity can start. This value is not used if the scalable
	// resource is an Auto Scaling group.
	//
	// While the cooldown period is in effect, the capacity that has been added
	// by the previous scale-out event that initiated the cooldown is calculated
	// as part of the desired capacity for the next scale out. The intention is
	// to continuously (but not excessively) scale out.
	ScaleOutCooldown *int64 `type:"integer"`

	// The target value for the metric. The range is 8.515920e-109 to 1.174271e+108
	// (Base 10) or 2e-360 to 2e360 (Base 2).
	//
	// TargetValue is a required field
	TargetValue *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

Describes a target tracking configuration to use with AWS Auto Scaling. Used with ScalingInstruction and ScalingPolicy.

func (TargetTrackingConfiguration) String 

func (s TargetTrackingConfiguration) String() string

String returns the string representation

func (*TargetTrackingConfiguration) Validate 

func (s *TargetTrackingConfiguration) Validate() error

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

type UpdateScalingPlanInput added in v0.4.0 

type UpdateScalingPlanInput struct {

	// A CloudFormation stack or set of tags.
	ApplicationSource *ApplicationSource `type:"structure"`

	// The scaling instructions.
	ScalingInstructions []ScalingInstruction `type:"list"`

	// The name of the scaling plan.
	//
	// ScalingPlanName is a required field
	ScalingPlanName *string `min:"1" type:"string" required:"true"`

	// The version number of the scaling plan.
	//
	// ScalingPlanVersion is a required field
	ScalingPlanVersion *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateScalingPlanInput) String added in v0.4.0 

func (s UpdateScalingPlanInput) String() string

String returns the string representation

func (*UpdateScalingPlanInput) Validate added in v0.4.0 

func (s *UpdateScalingPlanInput) Validate() error

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

type UpdateScalingPlanOutput added in v0.4.0 

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

func (UpdateScalingPlanOutput) String added in v0.4.0 

func (s UpdateScalingPlanOutput) String() string

String returns the string representation

type UpdateScalingPlanRequest added in v0.4.0 

type UpdateScalingPlanRequest struct {
	*aws.Request
	Input *UpdateScalingPlanInput
	Copy  func(*UpdateScalingPlanInput) UpdateScalingPlanRequest
}

UpdateScalingPlanRequest is the request type for the UpdateScalingPlan API operation.

func (UpdateScalingPlanRequest) Send added in v0.4.0 

func (r UpdateScalingPlanRequest) Send(ctx context.Context) (*UpdateScalingPlanResponse, error)

Send marshals and sends the UpdateScalingPlan API request.

type UpdateScalingPlanResponse added in v0.9.0 

type UpdateScalingPlanResponse struct {
	*UpdateScalingPlanOutput
	// contains filtered or unexported fields
}

UpdateScalingPlanResponse is the response type for the UpdateScalingPlan API operation.

func (*UpdateScalingPlanResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateScalingPlanResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateScalingPlan request.

Source Files

View all Source files

Directories

Path Synopsis
Package autoscalingplansiface provides an interface to enable mocking the AWS Auto Scaling Plans service client for testing your code.
 Package autoscalingplansiface provides an interface to enable mocking the AWS Auto Scaling Plans service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.