package autoscalingplans
import "github.com/aws/aws-sdk-go-v2/service/autoscalingplans"
Package autoscalingplans provides the API client, operations, and parameter types for AWS Auto Scaling Plans.
AWS Auto Scaling Use AWS Auto Scaling to create scaling plans for your applications to automatically scale your scalable AWS resources. API Summary You can use the AWS Auto Scaling service API to accomplish the following tasks:
* Create and manage scaling plans
* Define target tracking scaling policies to dynamically scale your resources based on utilization
* Scale Amazon EC2 Auto Scaling groups using predictive scaling and dynamic scaling to scale your Amazon EC2 capacity faster
* Set minimum and maximum capacity limits
* Retrieve information on existing scaling plans
* Access current forecast data and historical forecast data for up to 56 days previous
To learn more 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
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) CreateScalingPlan(ctx context.Context, params *CreateScalingPlanInput, optFns ...func(*Options)) (*CreateScalingPlanOutput, error)
- func (c *Client) DeleteScalingPlan(ctx context.Context, params *DeleteScalingPlanInput, optFns ...func(*Options)) (*DeleteScalingPlanOutput, error)
- func (c *Client) DescribeScalingPlanResources(ctx context.Context, params *DescribeScalingPlanResourcesInput, optFns ...func(*Options)) (*DescribeScalingPlanResourcesOutput, error)
- func (c *Client) DescribeScalingPlans(ctx context.Context, params *DescribeScalingPlansInput, optFns ...func(*Options)) (*DescribeScalingPlansOutput, error)
- func (c *Client) GetScalingPlanResourceForecastData(ctx context.Context, params *GetScalingPlanResourceForecastDataInput, optFns ...func(*Options)) (*GetScalingPlanResourceForecastDataOutput, error)
- func (c *Client) UpdateScalingPlan(ctx context.Context, params *UpdateScalingPlanInput, optFns ...func(*Options)) (*UpdateScalingPlanOutput, error)
- type CreateScalingPlanInput
- type CreateScalingPlanOutput
- type DeleteScalingPlanInput
- type DeleteScalingPlanOutput
- type DescribeScalingPlanResourcesInput
- type DescribeScalingPlanResourcesOutput
- type DescribeScalingPlansInput
- type DescribeScalingPlansOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GetScalingPlanResourceForecastDataInput
- type GetScalingPlanResourceForecastDataOutput
- type HTTPClient
- type HTTPSignerV4
- type Options
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type UpdateScalingPlanInput
- type UpdateScalingPlanOutput
Constants ¶
const ServiceAPIVersion = "2018-01-06"
const ServiceID = "Auto Scaling Plans"
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 ¶
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 ¶
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. For more information, see ApplicationSource // (https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ApplicationSource.html) // in the AWS Auto Scaling API Reference. // // This member is required. ApplicationSource *types.ApplicationSource // The scaling instructions. For more information, see ScalingInstruction // (https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html) // in the AWS Auto Scaling API Reference. // // 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 // contains filtered or unexported fields }
type CreateScalingPlanOutput ¶
type CreateScalingPlanOutput struct { // The version number of the scaling plan. This value is always 1. Currently, you // cannot have multiple scaling plan versions. // // This member is required. ScalingPlanVersion *int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteScalingPlanInput ¶
type DeleteScalingPlanInput struct { // The name of the scaling plan. // // This member is required. ScalingPlanName *string // The version number of the scaling plan. Currently, the only valid value is 1. // // This member is required. ScalingPlanVersion *int64 // contains filtered or unexported fields }
type DeleteScalingPlanOutput ¶
type DeleteScalingPlanOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeScalingPlanResourcesInput ¶
type DescribeScalingPlanResourcesInput struct { // The name of the scaling plan. // // This member is required. ScalingPlanName *string // The version number of the scaling plan. Currently, the only valid value is 1. // // 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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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. Currently, the only valid value is 1. If // you specify a scaling plan version, you must also specify a scaling plan name. ScalingPlanVersion *int64 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 a prefix (autoScalingGroup) // followed by the name of a specified Auto Scaling group (my-asg). Example: // autoScalingGroup/my-asg. // // This member is required. ResourceId *string // The scalable dimension for the resource. The only valid value is // autoscaling:autoScalingGroup:DesiredCapacity. // // 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. Currently, the only valid value is 1. // // This member is required. ScalingPlanVersion *int64 // The namespace of the AWS service. The only valid value is autoscaling. // // 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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type HTTPClient ¶
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 configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // 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 // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. If specified in an operation call's functional // options with a value that is different than the constructed client's Options, // the Client's Retryer will be wrapped to use the operation's specific // RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. Currently does not support per operation call // overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // contains filtered or unexported fields }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
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. The only valid value is 1. Currently, // you cannot have multiple scaling plan versions. // // This member is required. ScalingPlanVersion *int64 // A CloudFormation stack or set of tags. For more information, see // ApplicationSource // (https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ApplicationSource.html) // in the AWS Auto Scaling API Reference. ApplicationSource *types.ApplicationSource // The scaling instructions. For more information, see ScalingInstruction // (https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html) // in the AWS Auto Scaling API Reference. ScalingInstructions []types.ScalingInstruction // contains filtered or unexported fields }
type UpdateScalingPlanOutput ¶
type UpdateScalingPlanOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
api_client.go api_op_CreateScalingPlan.go api_op_DeleteScalingPlan.go api_op_DescribeScalingPlanResources.go api_op_DescribeScalingPlans.go api_op_GetScalingPlanResourceForecastData.go api_op_UpdateScalingPlan.go deserializers.go doc.go endpoints.go go_module_metadata.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v1.12.16
- Published
- Sep 14, 2022
- Platform
- js/wasm
- Imports
- 33 packages
- Last checked
- now –
Tools for package owners.