Documentation ¶
Overview ¶
Package applicationautoscaling provides a client for Application Auto Scaling.
Index ¶
- Constants
- type Alarm
- type ApplicationAutoScaling
- func (c *ApplicationAutoScaling) DeleteScalingPolicy(input *DeleteScalingPolicyInput) (*DeleteScalingPolicyOutput, error)
- func (c *ApplicationAutoScaling) DeleteScalingPolicyRequest(input *DeleteScalingPolicyInput) (req *request.Request, output *DeleteScalingPolicyOutput)
- func (c *ApplicationAutoScaling) DeregisterScalableTarget(input *DeregisterScalableTargetInput) (*DeregisterScalableTargetOutput, error)
- func (c *ApplicationAutoScaling) DeregisterScalableTargetRequest(input *DeregisterScalableTargetInput) (req *request.Request, output *DeregisterScalableTargetOutput)
- func (c *ApplicationAutoScaling) DescribeScalableTargets(input *DescribeScalableTargetsInput) (*DescribeScalableTargetsOutput, error)
- func (c *ApplicationAutoScaling) DescribeScalableTargetsPages(input *DescribeScalableTargetsInput, ...) error
- func (c *ApplicationAutoScaling) DescribeScalableTargetsRequest(input *DescribeScalableTargetsInput) (req *request.Request, output *DescribeScalableTargetsOutput)
- func (c *ApplicationAutoScaling) DescribeScalingActivities(input *DescribeScalingActivitiesInput) (*DescribeScalingActivitiesOutput, error)
- func (c *ApplicationAutoScaling) DescribeScalingActivitiesPages(input *DescribeScalingActivitiesInput, ...) error
- func (c *ApplicationAutoScaling) DescribeScalingActivitiesRequest(input *DescribeScalingActivitiesInput) (req *request.Request, output *DescribeScalingActivitiesOutput)
- func (c *ApplicationAutoScaling) DescribeScalingPolicies(input *DescribeScalingPoliciesInput) (*DescribeScalingPoliciesOutput, error)
- func (c *ApplicationAutoScaling) DescribeScalingPoliciesPages(input *DescribeScalingPoliciesInput, ...) error
- func (c *ApplicationAutoScaling) DescribeScalingPoliciesRequest(input *DescribeScalingPoliciesInput) (req *request.Request, output *DescribeScalingPoliciesOutput)
- func (c *ApplicationAutoScaling) PutScalingPolicy(input *PutScalingPolicyInput) (*PutScalingPolicyOutput, error)
- func (c *ApplicationAutoScaling) PutScalingPolicyRequest(input *PutScalingPolicyInput) (req *request.Request, output *PutScalingPolicyOutput)
- func (c *ApplicationAutoScaling) RegisterScalableTarget(input *RegisterScalableTargetInput) (*RegisterScalableTargetOutput, error)
- func (c *ApplicationAutoScaling) RegisterScalableTargetRequest(input *RegisterScalableTargetInput) (req *request.Request, output *RegisterScalableTargetOutput)
- type DeleteScalingPolicyInput
- type DeleteScalingPolicyOutput
- type DeregisterScalableTargetInput
- type DeregisterScalableTargetOutput
- type DescribeScalableTargetsInput
- type DescribeScalableTargetsOutput
- type DescribeScalingActivitiesInput
- type DescribeScalingActivitiesOutput
- type DescribeScalingPoliciesInput
- type DescribeScalingPoliciesOutput
- type PutScalingPolicyInput
- type PutScalingPolicyOutput
- type RegisterScalableTargetInput
- type RegisterScalableTargetOutput
- type ScalableTarget
- type ScalingActivity
- type ScalingPolicy
- type StepAdjustment
- type StepScalingPolicyConfiguration
Examples ¶
- ApplicationAutoScaling.DeleteScalingPolicy
- ApplicationAutoScaling.DeregisterScalableTarget
- ApplicationAutoScaling.DescribeScalableTargets
- ApplicationAutoScaling.DescribeScalingActivities
- ApplicationAutoScaling.DescribeScalingPolicies
- ApplicationAutoScaling.PutScalingPolicy
- ApplicationAutoScaling.RegisterScalableTarget
Constants ¶
const ( // @enum AdjustmentType AdjustmentTypeChangeInCapacity = "ChangeInCapacity" // @enum AdjustmentType AdjustmentTypePercentChangeInCapacity = "PercentChangeInCapacity" // @enum AdjustmentType AdjustmentTypeExactCapacity = "ExactCapacity" )
const ( // @enum MetricAggregationType MetricAggregationTypeAverage = "Average" // @enum MetricAggregationType MetricAggregationTypeMinimum = "Minimum" // @enum MetricAggregationType MetricAggregationTypeMaximum = "Maximum" )
const ( // @enum ScalingActivityStatusCode ScalingActivityStatusCodePending = "Pending" // @enum ScalingActivityStatusCode ScalingActivityStatusCodeInProgress = "InProgress" // @enum ScalingActivityStatusCode ScalingActivityStatusCodeSuccessful = "Successful" // @enum ScalingActivityStatusCode ScalingActivityStatusCodeOverridden = "Overridden" // @enum ScalingActivityStatusCode ScalingActivityStatusCodeUnfulfilled = "Unfulfilled" // @enum ScalingActivityStatusCode ScalingActivityStatusCodeFailed = "Failed" )
const (
// @enum PolicyType
PolicyTypeStepScaling = "StepScaling"
)
const (
// @enum ScalableDimension
ScalableDimensionEcsServiceDesiredCount = "ecs:service:DesiredCount"
)
const ServiceName = "autoscaling"
A ServiceName is the name of the service the client will make API calls to.
const (
// @enum ServiceNamespace
ServiceNamespaceEcs = "ecs"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Alarm ¶
type Alarm struct { // The Amazon Resource Name (ARN) of the alarm. AlarmARN *string `type:"string" required:"true"` // The name of the alarm. AlarmName *string `type:"string" required:"true"` // contains filtered or unexported fields }
An object representing a CloudWatch alarm associated with a scaling policy.
type ApplicationAutoScaling ¶
Application Auto Scaling is a general purpose Auto Scaling service for supported elastic AWS resources. With Application Auto Scaling, you can automatically scale your AWS resources, with an experience similar to that of Auto Scaling.
At this time, Application Auto Scaling only supports scaling Amazon ECS
services.
For example, you can use Application Auto Scaling to accomplish the following
tasks:
Define scaling policies for automatically adjusting your application’s
resources
Scale your resources in response to CloudWatch alarms View history of your scaling events
The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *ApplicationAutoScaling
New creates a new instance of the ApplicationAutoScaling client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a ApplicationAutoScaling client from just a session. svc := applicationautoscaling.New(mySession) // Create a ApplicationAutoScaling client with additional configuration svc := applicationautoscaling.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*ApplicationAutoScaling) DeleteScalingPolicy ¶
func (c *ApplicationAutoScaling) DeleteScalingPolicy(input *DeleteScalingPolicyInput) (*DeleteScalingPolicyOutput, error)
Deletes an Application Auto Scaling scaling policy that was previously created. If you are no longer using a scaling policy, you can delete it with this operation.
Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm, even if it no longer has an associated action.
To create a new scaling policy or update an existing one, see PutScalingPolicy.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/applicationautoscaling" ) func main() { svc := applicationautoscaling.New(session.New()) params := &applicationautoscaling.DeleteScalingPolicyInput{ PolicyName: aws.String("ResourceIdMaxLen1600"), // Required ResourceId: aws.String("ResourceIdMaxLen1600"), // Required ScalableDimension: aws.String("ScalableDimension"), // Required ServiceNamespace: aws.String("ServiceNamespace"), // Required } resp, err := svc.DeleteScalingPolicy(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ApplicationAutoScaling) DeleteScalingPolicyRequest ¶
func (c *ApplicationAutoScaling) DeleteScalingPolicyRequest(input *DeleteScalingPolicyInput) (req *request.Request, output *DeleteScalingPolicyOutput)
DeleteScalingPolicyRequest generates a request for the DeleteScalingPolicy operation.
func (*ApplicationAutoScaling) DeregisterScalableTarget ¶
func (c *ApplicationAutoScaling) DeregisterScalableTarget(input *DeregisterScalableTargetInput) (*DeregisterScalableTargetOutput, error)
Deregisters a scalable target that was previously registered. If you are no longer using a scalable target, you can delete it with this operation. When you deregister a scalable target, all of the scaling policies that are associated with that scalable target are deleted.
To create a new scalable target or update an existing one, see RegisterScalableTarget.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/applicationautoscaling" ) func main() { svc := applicationautoscaling.New(session.New()) params := &applicationautoscaling.DeregisterScalableTargetInput{ ResourceId: aws.String("ResourceIdMaxLen1600"), // Required ScalableDimension: aws.String("ScalableDimension"), // Required ServiceNamespace: aws.String("ServiceNamespace"), // Required } resp, err := svc.DeregisterScalableTarget(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ApplicationAutoScaling) DeregisterScalableTargetRequest ¶
func (c *ApplicationAutoScaling) DeregisterScalableTargetRequest(input *DeregisterScalableTargetInput) (req *request.Request, output *DeregisterScalableTargetOutput)
DeregisterScalableTargetRequest generates a request for the DeregisterScalableTarget operation.
func (*ApplicationAutoScaling) DescribeScalableTargets ¶
func (c *ApplicationAutoScaling) DescribeScalableTargets(input *DescribeScalableTargetsInput) (*DescribeScalableTargetsOutput, error)
Provides descriptive information for scalable targets with a specified service namespace.
You can filter the results in a service namespace with the ResourceIds and ScalableDimension parameters.
To create a new scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it with DeregisterScalableTarget.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/applicationautoscaling" ) func main() { svc := applicationautoscaling.New(session.New()) params := &applicationautoscaling.DescribeScalableTargetsInput{ ServiceNamespace: aws.String("ServiceNamespace"), // Required MaxResults: aws.Int64(1), NextToken: aws.String("XmlString"), ResourceIds: []*string{ aws.String("ResourceIdMaxLen1600"), // Required // More values... }, ScalableDimension: aws.String("ScalableDimension"), } resp, err := svc.DescribeScalableTargets(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ApplicationAutoScaling) DescribeScalableTargetsPages ¶
func (c *ApplicationAutoScaling) DescribeScalableTargetsPages(input *DescribeScalableTargetsInput, fn func(p *DescribeScalableTargetsOutput, lastPage bool) (shouldContinue bool)) error
func (*ApplicationAutoScaling) DescribeScalableTargetsRequest ¶
func (c *ApplicationAutoScaling) DescribeScalableTargetsRequest(input *DescribeScalableTargetsInput) (req *request.Request, output *DescribeScalableTargetsOutput)
DescribeScalableTargetsRequest generates a request for the DescribeScalableTargets operation.
func (*ApplicationAutoScaling) DescribeScalingActivities ¶
func (c *ApplicationAutoScaling) DescribeScalingActivities(input *DescribeScalingActivitiesInput) (*DescribeScalingActivitiesOutput, error)
Provides descriptive information for scaling activities with a specified service namespace.
You can filter the results in a service namespace with the ResourceId and ScalableDimension parameters.
Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the existing scaling policies for a service namespace, see DescribeScalingPolicies. To create a new scaling policy or update an existing one, see PutScalingPolicy.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/applicationautoscaling" ) func main() { svc := applicationautoscaling.New(session.New()) params := &applicationautoscaling.DescribeScalingActivitiesInput{ ServiceNamespace: aws.String("ServiceNamespace"), // Required MaxResults: aws.Int64(1), NextToken: aws.String("XmlString"), ResourceId: aws.String("ResourceIdMaxLen1600"), ScalableDimension: aws.String("ScalableDimension"), } resp, err := svc.DescribeScalingActivities(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ApplicationAutoScaling) DescribeScalingActivitiesPages ¶
func (c *ApplicationAutoScaling) DescribeScalingActivitiesPages(input *DescribeScalingActivitiesInput, fn func(p *DescribeScalingActivitiesOutput, lastPage bool) (shouldContinue bool)) error
func (*ApplicationAutoScaling) DescribeScalingActivitiesRequest ¶
func (c *ApplicationAutoScaling) DescribeScalingActivitiesRequest(input *DescribeScalingActivitiesInput) (req *request.Request, output *DescribeScalingActivitiesOutput)
DescribeScalingActivitiesRequest generates a request for the DescribeScalingActivities operation.
func (*ApplicationAutoScaling) DescribeScalingPolicies ¶
func (c *ApplicationAutoScaling) DescribeScalingPolicies(input *DescribeScalingPoliciesInput) (*DescribeScalingPoliciesOutput, error)
Provides descriptive information for scaling policies with a specified service namespace.
You can filter the results in a service namespace with the ResourceId, ScalableDimension, and PolicyNames parameters.
To create a new scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it with DeleteScalingPolicy.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/applicationautoscaling" ) func main() { svc := applicationautoscaling.New(session.New()) params := &applicationautoscaling.DescribeScalingPoliciesInput{ ServiceNamespace: aws.String("ServiceNamespace"), // Required MaxResults: aws.Int64(1), NextToken: aws.String("XmlString"), PolicyNames: []*string{ aws.String("ResourceIdMaxLen1600"), // Required // More values... }, ResourceId: aws.String("ResourceIdMaxLen1600"), ScalableDimension: aws.String("ScalableDimension"), } resp, err := svc.DescribeScalingPolicies(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ApplicationAutoScaling) DescribeScalingPoliciesPages ¶
func (c *ApplicationAutoScaling) DescribeScalingPoliciesPages(input *DescribeScalingPoliciesInput, fn func(p *DescribeScalingPoliciesOutput, lastPage bool) (shouldContinue bool)) error
func (*ApplicationAutoScaling) DescribeScalingPoliciesRequest ¶
func (c *ApplicationAutoScaling) DescribeScalingPoliciesRequest(input *DescribeScalingPoliciesInput) (req *request.Request, output *DescribeScalingPoliciesOutput)
DescribeScalingPoliciesRequest generates a request for the DescribeScalingPolicies operation.
func (*ApplicationAutoScaling) PutScalingPolicy ¶
func (c *ApplicationAutoScaling) PutScalingPolicy(input *PutScalingPolicyInput) (*PutScalingPolicyOutput, error)
Creates or updates a policy for an existing Application Auto Scaling scalable target. Each scalable target is identified by service namespace, a resource ID, and a scalable dimension, and a scaling policy applies to a scalable target that is identified by those three attributes. You cannot create a scaling policy without first registering a scalable target with RegisterScalableTarget.
To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.
You can view the existing scaling policies for a service namespace with DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it with DeleteScalingPolicy.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/applicationautoscaling" ) func main() { svc := applicationautoscaling.New(session.New()) params := &applicationautoscaling.PutScalingPolicyInput{ PolicyName: aws.String("PolicyName"), // Required ResourceId: aws.String("ResourceIdMaxLen1600"), // Required ScalableDimension: aws.String("ScalableDimension"), // Required ServiceNamespace: aws.String("ServiceNamespace"), // Required PolicyType: aws.String("PolicyType"), StepScalingPolicyConfiguration: &applicationautoscaling.StepScalingPolicyConfiguration{ AdjustmentType: aws.String("AdjustmentType"), Cooldown: aws.Int64(1), MetricAggregationType: aws.String("MetricAggregationType"), MinAdjustmentMagnitude: aws.Int64(1), StepAdjustments: []*applicationautoscaling.StepAdjustment{ { // Required ScalingAdjustment: aws.Int64(1), // Required MetricIntervalLowerBound: aws.Float64(1.0), MetricIntervalUpperBound: aws.Float64(1.0), }, // More values... }, }, } resp, err := svc.PutScalingPolicy(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ApplicationAutoScaling) PutScalingPolicyRequest ¶
func (c *ApplicationAutoScaling) PutScalingPolicyRequest(input *PutScalingPolicyInput) (req *request.Request, output *PutScalingPolicyOutput)
PutScalingPolicyRequest generates a request for the PutScalingPolicy operation.
func (*ApplicationAutoScaling) RegisterScalableTarget ¶
func (c *ApplicationAutoScaling) RegisterScalableTarget(input *RegisterScalableTargetInput) (*RegisterScalableTargetOutput, error)
Registers or updates a scalable target. A scalable target is a resource that can be scaled up or down with Application Auto Scaling. After you have registered a scalable target, you can use this command to update the minimum and maximum values for your scalable dimension.
At this time, Application Auto Scaling only supports scaling Amazon ECS
services.
After you register a scalable target with Application Auto Scaling, you
can create and apply scaling policies to it with PutScalingPolicy. You can view the existing scaling policies for a service namespace with DescribeScalableTargets. If you are no longer using a scalable target, you can deregister it with DeregisterScalableTarget.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/applicationautoscaling" ) func main() { svc := applicationautoscaling.New(session.New()) params := &applicationautoscaling.RegisterScalableTargetInput{ ResourceId: aws.String("ResourceIdMaxLen1600"), // Required ScalableDimension: aws.String("ScalableDimension"), // Required ServiceNamespace: aws.String("ServiceNamespace"), // Required MaxCapacity: aws.Int64(1), MinCapacity: aws.Int64(1), RoleARN: aws.String("ResourceIdMaxLen1600"), } resp, err := svc.RegisterScalableTarget(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ApplicationAutoScaling) RegisterScalableTargetRequest ¶
func (c *ApplicationAutoScaling) RegisterScalableTargetRequest(input *RegisterScalableTargetInput) (req *request.Request, output *RegisterScalableTargetOutput)
RegisterScalableTargetRequest generates a request for the RegisterScalableTarget operation.
type DeleteScalingPolicyInput ¶
type DeleteScalingPolicyInput struct { // The name of the scaling policy to delete. PolicyName *string `min:"1" type:"string" required:"true"` // The unique identifier string for the resource associated with the scaling // policy. For Amazon ECS services, this value is the resource type, followed // by the cluster name and service name, such as service/default/sample-webapp. ResourceId *string `min:"1" type:"string" required:"true"` // The scalable dimension associated with the scaling policy. The scalable dimension // contains the service namespace, resource type, and scaling property, such // as ecs:service:DesiredCount for the desired task count of an Amazon ECS service. ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` // The namespace for the AWS service that the scaling policy is associated with. // For more information, see AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // contains filtered or unexported fields }
func (DeleteScalingPolicyInput) GoString ¶
func (s DeleteScalingPolicyInput) GoString() string
GoString returns the string representation
func (DeleteScalingPolicyInput) String ¶
func (s DeleteScalingPolicyInput) String() string
String returns the string representation
func (*DeleteScalingPolicyInput) Validate ¶
func (s *DeleteScalingPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteScalingPolicyOutput ¶
type DeleteScalingPolicyOutput struct {
// contains filtered or unexported fields
}
func (DeleteScalingPolicyOutput) GoString ¶
func (s DeleteScalingPolicyOutput) GoString() string
GoString returns the string representation
func (DeleteScalingPolicyOutput) String ¶
func (s DeleteScalingPolicyOutput) String() string
String returns the string representation
type DeregisterScalableTargetInput ¶
type DeregisterScalableTargetInput struct { // The unique identifier string for the resource associated with the scalable // target. For Amazon ECS services, this value is the resource type, followed // by the cluster name and service name, such as service/default/sample-webapp. ResourceId *string `min:"1" type:"string" required:"true"` // The scalable dimension associated with the scalable target. The scalable // dimension contains the service namespace, resource type, and scaling property, // such as ecs:service:DesiredCount for the desired task count of an Amazon // ECS service. ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` // The namespace for the AWS service that the scalable target is associated // with. For more information, see AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // contains filtered or unexported fields }
func (DeregisterScalableTargetInput) GoString ¶
func (s DeregisterScalableTargetInput) GoString() string
GoString returns the string representation
func (DeregisterScalableTargetInput) String ¶
func (s DeregisterScalableTargetInput) String() string
String returns the string representation
func (*DeregisterScalableTargetInput) Validate ¶
func (s *DeregisterScalableTargetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeregisterScalableTargetOutput ¶
type DeregisterScalableTargetOutput struct {
// contains filtered or unexported fields
}
func (DeregisterScalableTargetOutput) GoString ¶
func (s DeregisterScalableTargetOutput) GoString() string
GoString returns the string representation
func (DeregisterScalableTargetOutput) String ¶
func (s DeregisterScalableTargetOutput) String() string
String returns the string representation
type DescribeScalableTargetsInput ¶
type DescribeScalableTargetsInput struct { // The maximum number of scalable target results returned by DescribeScalableTargets // in paginated output. When this parameter is used, DescribeScalableTargets // returns up to MaxResults results in a single page along with a NextToken // response element. The remaining results of the initial request can be seen // by sending another DescribeScalableTargets request with the returned NextToken // value. This value can be between 1 and 50. If this parameter is not used, // then DescribeScalableTargets returns up to 50 results and a NextToken value, // if applicable. MaxResults *int64 `type:"integer"` // The NextToken value returned from a previous paginated DescribeScalableTargets // request. Pagination continues from the end of the previous results that returned // the NextToken value. This value is null when there are no more results to // return. NextToken *string `type:"string"` // The unique identifier string for the resource associated with the scalable // target. For Amazon ECS services, this value is the resource type, followed // by the cluster name and service name, such as service/default/sample-webapp. // If you specify a scalable dimension, you must also specify a resource ID. ResourceIds []*string `type:"list"` // The scalable dimension associated with the scalable target. The scalable // dimension contains the service namespace, resource type, and scaling property, // such as ecs:service:DesiredCount for the desired task count of an Amazon // ECS service. If you specify a scalable dimension, you must also specify a // resource ID. ScalableDimension *string `type:"string" enum:"ScalableDimension"` // The namespace for the AWS service that the scalable target is associated // with. For more information, see AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // contains filtered or unexported fields }
func (DescribeScalableTargetsInput) GoString ¶
func (s DescribeScalableTargetsInput) GoString() string
GoString returns the string representation
func (DescribeScalableTargetsInput) String ¶
func (s DescribeScalableTargetsInput) String() string
String returns the string representation
func (*DescribeScalableTargetsInput) Validate ¶
func (s *DescribeScalableTargetsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeScalableTargetsOutput ¶
type DescribeScalableTargetsOutput struct { // The NextToken value to include in a future DescribeScalableTargets request. // When the results of a DescribeScalableTargets request exceed MaxResults, // this value can be used to retrieve the next page of results. This value is // null when there are no more results to return. NextToken *string `type:"string"` // The list of scalable targets that matches the request parameters. ScalableTargets []*ScalableTarget `type:"list"` // contains filtered or unexported fields }
func (DescribeScalableTargetsOutput) GoString ¶
func (s DescribeScalableTargetsOutput) GoString() string
GoString returns the string representation
func (DescribeScalableTargetsOutput) String ¶
func (s DescribeScalableTargetsOutput) String() string
String returns the string representation
type DescribeScalingActivitiesInput ¶
type DescribeScalingActivitiesInput struct { // The maximum number of scaling activity results returned by DescribeScalingActivities // in paginated output. When this parameter is used, DescribeScalingActivities // returns up to MaxResults results in a single page along with a NextToken // response element. The remaining results of the initial request can be seen // by sending another DescribeScalingActivities request with the returned NextToken // value. This value can be between 1 and 50. If this parameter is not used, // then DescribeScalingActivities returns up to 50 results and a NextToken value, // if applicable. MaxResults *int64 `type:"integer"` // The NextToken value returned from a previous paginated DescribeScalingActivities // request. Pagination continues from the end of the previous results that returned // the NextToken value. This value is null when there are no more results to // return. NextToken *string `type:"string"` // The unique identifier string for the resource associated with the scaling // activity. For Amazon ECS services, this value is the resource type, followed // by the cluster name and service name, such as service/default/sample-webapp. // If you specify a scalable dimension, you must also specify a resource ID. ResourceId *string `min:"1" type:"string"` // The scalable dimension associated with the scaling activity. The scalable // dimension contains the service namespace, resource type, and scaling property, // such as ecs:service:DesiredCount for the desired task count of an Amazon // ECS service. If you specify a scalable dimension, you must also specify a // resource ID. ScalableDimension *string `type:"string" enum:"ScalableDimension"` // The namespace for the AWS service that the scaling activity is associated // with. For more information, see AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // contains filtered or unexported fields }
func (DescribeScalingActivitiesInput) GoString ¶
func (s DescribeScalingActivitiesInput) GoString() string
GoString returns the string representation
func (DescribeScalingActivitiesInput) String ¶
func (s DescribeScalingActivitiesInput) String() string
String returns the string representation
func (*DescribeScalingActivitiesInput) Validate ¶
func (s *DescribeScalingActivitiesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeScalingActivitiesOutput ¶
type DescribeScalingActivitiesOutput struct { // The NextToken value to include in a future DescribeScalingActivities request. // When the results of a DescribeScalingActivities request exceed MaxResults, // this value can be used to retrieve the next page of results. This value is // null when there are no more results to return. NextToken *string `type:"string"` // A list of scaling activity objects. ScalingActivities []*ScalingActivity `type:"list"` // contains filtered or unexported fields }
func (DescribeScalingActivitiesOutput) GoString ¶
func (s DescribeScalingActivitiesOutput) GoString() string
GoString returns the string representation
func (DescribeScalingActivitiesOutput) String ¶
func (s DescribeScalingActivitiesOutput) String() string
String returns the string representation
type DescribeScalingPoliciesInput ¶
type DescribeScalingPoliciesInput struct { // The maximum number of scaling policy results returned by DescribeScalingPolicies // in paginated output. When this parameter is used, DescribeScalingPolicies // returns up to MaxResults results in a single page along with a NextToken // response element. The remaining results of the initial request can be seen // by sending another DescribeScalingPolicies request with the returned NextToken // value. This value can be between 1 and 50. If this parameter is not used, // then DescribeScalingPolicies returns up to 50 results and a NextToken value, // if applicable. MaxResults *int64 `type:"integer"` // The NextToken value returned from a previous paginated DescribeScalingPolicies // request. Pagination continues from the end of the previous results that returned // the NextToken value. This value is null when there are no more results to // return. NextToken *string `type:"string"` // The names of the scaling policies to describe. PolicyNames []*string `type:"list"` // The unique resource identifier string of the scalable target that the scaling // policy is associated with. For Amazon ECS services, this value is the resource // type, followed by the cluster name and service name, such as service/default/sample-webapp. // If you specify a scalable dimension, you must also specify a resource ID. ResourceId *string `min:"1" type:"string"` // The scalable dimension of the scalable target that the scaling policy is // associated with. The scalable dimension contains the service namespace, resource // type, and scaling property, such as ecs:service:DesiredCount for the desired // task count of an Amazon ECS service. If you specify a scalable dimension, // you must also specify a resource ID. ScalableDimension *string `type:"string" enum:"ScalableDimension"` // The AWS service namespace of the scalable target that the scaling policy // is associated with. For more information, see AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // contains filtered or unexported fields }
func (DescribeScalingPoliciesInput) GoString ¶
func (s DescribeScalingPoliciesInput) GoString() string
GoString returns the string representation
func (DescribeScalingPoliciesInput) String ¶
func (s DescribeScalingPoliciesInput) String() string
String returns the string representation
func (*DescribeScalingPoliciesInput) Validate ¶
func (s *DescribeScalingPoliciesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeScalingPoliciesOutput ¶
type DescribeScalingPoliciesOutput struct { // The NextToken value to include in a future DescribeScalingPolicies request. // When the results of a DescribeScalingPolicies request exceed MaxResults, // this value can be used to retrieve the next page of results. This value is // null when there are no more results to return. NextToken *string `type:"string"` // A list of scaling policy objects. ScalingPolicies []*ScalingPolicy `type:"list"` // contains filtered or unexported fields }
func (DescribeScalingPoliciesOutput) GoString ¶
func (s DescribeScalingPoliciesOutput) GoString() string
GoString returns the string representation
func (DescribeScalingPoliciesOutput) String ¶
func (s DescribeScalingPoliciesOutput) String() string
String returns the string representation
type PutScalingPolicyInput ¶
type PutScalingPolicyInput struct { // The name of the scaling policy. PolicyName *string `min:"1" type:"string" required:"true"` // The policy type. This parameter is required if you are creating a new policy. PolicyType *string `type:"string" enum:"PolicyType"` // The unique resource identifier string for the scalable target that this scaling // policy applies to. For Amazon ECS services, this value is the resource type, // followed by the cluster name and service name, such as service/default/sample-webapp. ResourceId *string `min:"1" type:"string" required:"true"` // The scalable dimension of the scalable target that this scaling policy applies // to. The scalable dimension contains the service namespace, resource type, // and scaling property, such as ecs:service:DesiredCount for the desired task // count of an Amazon ECS service. ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` // The AWS service namespace of the scalable target that this scaling policy // applies to. For more information, see AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // The configuration for the step scaling policy. This parameter is required // if you are creating a new policy. For more information, see StepScalingPolicyConfiguration // (http://docs.aws.amazon.com/http:/docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_StepScalingPolicyConfiguration.html) // and StepAdjustment (http://docs.aws.amazon.com/http:/docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/API_StepAdjustment.html) // in the Application Auto Scaling API Reference. StepScalingPolicyConfiguration *StepScalingPolicyConfiguration `type:"structure"` // contains filtered or unexported fields }
func (PutScalingPolicyInput) GoString ¶
func (s PutScalingPolicyInput) GoString() string
GoString returns the string representation
func (PutScalingPolicyInput) String ¶
func (s PutScalingPolicyInput) String() string
String returns the string representation
func (*PutScalingPolicyInput) Validate ¶
func (s *PutScalingPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutScalingPolicyOutput ¶
type PutScalingPolicyOutput struct { // The Amazon Resource Name (ARN) of the resulting scaling policy. PolicyARN *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (PutScalingPolicyOutput) GoString ¶
func (s PutScalingPolicyOutput) GoString() string
GoString returns the string representation
func (PutScalingPolicyOutput) String ¶
func (s PutScalingPolicyOutput) String() string
String returns the string representation
type RegisterScalableTargetInput ¶
type RegisterScalableTargetInput struct { // The maximum value for this scalable target to scale out to in response to // scaling activities. This parameter is required if you are registering a new // scalable target, and it is optional if you are updating an existing one. MaxCapacity *int64 `type:"integer"` // The minimum value for this scalable target to scale in to in response to // scaling activities. This parameter is required if you are registering a new // scalable target, and it is optional if you are updating an existing one. MinCapacity *int64 `type:"integer"` // The unique identifier string for the resource to associate with the scalable // target. For Amazon ECS services, this value is the resource type, followed // by the cluster name and service name, such as service/default/sample-webapp. ResourceId *string `min:"1" type:"string" required:"true"` // The ARN of the IAM role that allows Application Auto Scaling to modify your // scalable target on your behalf. This parameter is required if you are registering // a new scalable target, and it is optional if you are updating an existing // one. RoleARN *string `min:"1" type:"string"` // The scalable dimension associated with the scalable target. The scalable // dimension contains the service namespace, resource type, and scaling property, // such as ecs:service:DesiredCount for the desired task count of an Amazon // ECS service. ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` // The namespace for the AWS service that the scalable target is associated // with. For Amazon ECS services, the namespace value is ecs. For more information, // see AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // contains filtered or unexported fields }
func (RegisterScalableTargetInput) GoString ¶
func (s RegisterScalableTargetInput) GoString() string
GoString returns the string representation
func (RegisterScalableTargetInput) String ¶
func (s RegisterScalableTargetInput) String() string
String returns the string representation
func (*RegisterScalableTargetInput) Validate ¶
func (s *RegisterScalableTargetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RegisterScalableTargetOutput ¶
type RegisterScalableTargetOutput struct {
// contains filtered or unexported fields
}
func (RegisterScalableTargetOutput) GoString ¶
func (s RegisterScalableTargetOutput) GoString() string
GoString returns the string representation
func (RegisterScalableTargetOutput) String ¶
func (s RegisterScalableTargetOutput) String() string
String returns the string representation
type ScalableTarget ¶
type ScalableTarget struct { // The Unix timestamp for when the scalable target was created. CreationTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"` // The maximum value for this scalable target to scale out to in response to // scaling activities. MaxCapacity *int64 `type:"integer" required:"true"` // The minimum value for this scalable target to scale in to in response to // scaling activities. MinCapacity *int64 `type:"integer" required:"true"` // The unique identifier string for the resource associated with the scalable // target. For Amazon ECS services, this value is the resource type, followed // by the cluster name and service name, such as service/default/sample-webapp. ResourceId *string `min:"1" type:"string" required:"true"` // The ARN of the IAM role that allows Application Auto Scaling to modify your // scalable target on your behalf. RoleARN *string `min:"1" type:"string" required:"true"` // The scalable dimension associated with the scalable target. The scalable // dimension contains the service namespace, resource type, and scaling property, // such as ecs:service:DesiredCount for the desired task count of an Amazon // ECS service. ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` // The namespace for the AWS service that the scalable target is associated // with. For more information, see AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // contains filtered or unexported fields }
An object representing a scalable target.
func (ScalableTarget) GoString ¶
func (s ScalableTarget) GoString() string
GoString returns the string representation
func (ScalableTarget) String ¶
func (s ScalableTarget) String() string
String returns the string representation
type ScalingActivity ¶
type ScalingActivity struct { // The unique identifier string for the scaling activity. ActivityId *string `type:"string" required:"true"` // A simple description of what caused the scaling activity to happen. Cause *string `type:"string" required:"true"` // A simple description of what action the scaling activity intends to accomplish. Description *string `type:"string" required:"true"` // The details about the scaling activity. Details *string `type:"string"` // The Unix timestamp for when the scaling activity ended. EndTime *time.Time `type:"timestamp" timestampFormat:"unix"` // The unique identifier string for the resource associated with the scaling // activity. For Amazon ECS services, this value is the resource type, followed // by the cluster name and service name, such as service/default/sample-webapp. ResourceId *string `min:"1" type:"string" required:"true"` // The scalable dimension associated with the scaling activity. The scalable // dimension contains the service namespace, resource type, and scaling property, // such as ecs:service:DesiredCount for the desired task count of an Amazon // ECS service. ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` // The namespace for the AWS service that the scaling activity is associated // with. For more information, see AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // The Unix timestamp for when the scaling activity began. StartTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"` // Indicates the status of the scaling activity. StatusCode *string `type:"string" required:"true" enum:"ScalingActivityStatusCode"` // A simple message about the current status of the scaling activity. StatusMessage *string `type:"string"` // contains filtered or unexported fields }
An object representing a scaling activity.
func (ScalingActivity) GoString ¶
func (s ScalingActivity) GoString() string
GoString returns the string representation
func (ScalingActivity) String ¶
func (s ScalingActivity) String() string
String returns the string representation
type ScalingPolicy ¶
type ScalingPolicy struct { // The CloudWatch alarms that are associated with the scaling policy. Alarms []*Alarm `type:"list"` // The Unix timestamp for when the scaling policy was created. CreationTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"` // The Amazon Resource Name (ARN) of the scaling policy. PolicyARN *string `min:"1" type:"string" required:"true"` // The name of the scaling policy. PolicyName *string `min:"1" type:"string" required:"true"` // The scaling policy type. PolicyType *string `type:"string" required:"true" enum:"PolicyType"` // The unique identifier string for the resource associated with the scaling // policy. For Amazon ECS services, this value is the resource type, followed // by the cluster name and service name, such as service/default/sample-webapp. ResourceId *string `min:"1" type:"string" required:"true"` // The scalable dimension associated with the scaling policy. The scalable dimension // contains the service namespace, resource type, and scaling property, such // as ecs:service:DesiredCount for the desired task count of an Amazon ECS service. ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` // The namespace for the AWS service that the scaling policy is associated with. // For more information, see AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) // in the Amazon Web Services General Reference. ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` // The configuration for the step scaling policy. StepScalingPolicyConfiguration *StepScalingPolicyConfiguration `type:"structure"` // contains filtered or unexported fields }
An object representing a scaling policy.
func (ScalingPolicy) GoString ¶
func (s ScalingPolicy) GoString() string
GoString returns the string representation
func (ScalingPolicy) String ¶
func (s ScalingPolicy) String() string
String returns the string representation
type StepAdjustment ¶
type StepAdjustment struct { // The lower bound for the difference between the alarm threshold and the CloudWatch // metric. If the metric value is above the breach threshold, the lower bound // is inclusive (the metric must be greater than or equal to the threshold plus // the lower bound). Otherwise, it is exclusive (the metric must be greater // than the threshold plus the lower bound). A null value indicates negative // infinity. MetricIntervalLowerBound *float64 `type:"double"` // The upper bound for the difference between the alarm threshold and the CloudWatch // metric. If the metric value is above the breach threshold, the upper bound // is exclusive (the metric must be less than the threshold plus the upper bound). // Otherwise, it is inclusive (the metric must be less than or equal to the // threshold plus the upper bound). A null value indicates positive infinity. // // The upper bound must be greater than the lower bound. MetricIntervalUpperBound *float64 `type:"double"` // The amount by which to scale, based on the specified adjustment type. A positive // value adds to the current scalable dimension while a negative number removes // from the current scalable dimension. ScalingAdjustment *int64 `type:"integer" required:"true"` // contains filtered or unexported fields }
An object representing a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.
For the following examples, suppose that you have an alarm with a breach threshold of 50:
If you want the adjustment to be triggered when the metric is greater
than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.
If you want the adjustment to be triggered when the metric is greater
than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.
There are a few rules for the step adjustments for your step policy: The ranges of your step adjustments can't overlap or have a gap. At most one step adjustment can have a null lower bound. If one step adjustment
has a negative lower bound, then there must be a step adjustment with a null lower bound.
At most one step adjustment can have a null upper bound. If one step adjustment
has a positive upper bound, then there must be a step adjustment with a null upper bound.
The upper and lower bound can't be null in the same step adjustment.
func (StepAdjustment) GoString ¶
func (s StepAdjustment) GoString() string
GoString returns the string representation
func (StepAdjustment) String ¶
func (s StepAdjustment) String() string
String returns the string representation
func (*StepAdjustment) Validate ¶
func (s *StepAdjustment) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StepScalingPolicyConfiguration ¶
type StepScalingPolicyConfiguration struct { // The adjustment type, which specifies how the ScalingAdjustment parameter // in a StepAdjustment is interpreted. AdjustmentType *string `type:"string" enum:"AdjustmentType"` // The amount of time, in seconds, after a scaling activity completes where // previous trigger-related scaling activities can influence future scaling // events. // // For scale out policies, while Cooldown 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. For example, an alarm // triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, // the scaling activity completes successfully, and a Cooldown period of 5 minutes // starts. During the Cooldown period, if the alarm triggers the same policy // again but at a more aggressive step adjustment to scale out the service by // 3 tasks, the 2 tasks that were added in the previous scale out event are // considered part of that capacity and only 1 additional task is added to the // desired count. // // For scale in policies, 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, Application // Auto Scaling scales out your scalable target immediately. Cooldown *int64 `type:"integer"` // The aggregation type for the CloudWatch metrics. Valid values are Minimum, // Maximum, and Average. MetricAggregationType *string `type:"string" enum:"MetricAggregationType"` // The minimum number to adjust your scalable dimension as a result of a scaling // activity. If the adjustment type is PercentChangeInCapacity, the scaling // policy changes the scalable dimension of the scalable target by this amount. MinAdjustmentMagnitude *int64 `type:"integer"` // A set of adjustments that enable you to scale based on the size of the alarm // breach. StepAdjustments []*StepAdjustment `type:"list"` // contains filtered or unexported fields }
An object representing a step scaling policy configuration.
func (StepScalingPolicyConfiguration) GoString ¶
func (s StepScalingPolicyConfiguration) GoString() string
GoString returns the string representation
func (StepScalingPolicyConfiguration) String ¶
func (s StepScalingPolicyConfiguration) String() string
String returns the string representation
func (*StepScalingPolicyConfiguration) Validate ¶
func (s *StepScalingPolicyConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
Directories ¶
Path | Synopsis |
---|---|
Package applicationautoscalingiface provides an interface for the Application Auto Scaling.
|
Package applicationautoscalingiface provides an interface for the Application Auto Scaling. |