ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/vendor/github.com/aws/aws-sdk-go/service/applicationautoscaling/api.go

2400 lines
89 KiB
Go
Raw Blame History

// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
// Package applicationautoscaling provides a client for Application Auto Scaling.
package applicationautoscaling
import (
"fmt"
"time"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/request"
)
const opDeleteScalingPolicy = "DeleteScalingPolicy"
// DeleteScalingPolicyRequest generates a "aws/request.Request" representing the
// client's request for the DeleteScalingPolicy operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See DeleteScalingPolicy for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the DeleteScalingPolicy method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the DeleteScalingPolicyRequest method.
// req, resp := client.DeleteScalingPolicyRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeleteScalingPolicy
func (c *ApplicationAutoScaling) DeleteScalingPolicyRequest(input *DeleteScalingPolicyInput) (req *request.Request, output *DeleteScalingPolicyOutput) {
op := &request.Operation{
Name: opDeleteScalingPolicy,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteScalingPolicyInput{}
}
req = c.newRequest(op, input, output)
output = &DeleteScalingPolicyOutput{}
req.Data = output
return
}
// DeleteScalingPolicy API operation for Application Auto Scaling.
//
// Deletes the specified Application Auto Scaling scaling policy.
//
// Deleting a policy deletes the underlying alarm action, but does not delete
// the CloudWatch alarm associated with the scaling policy, even if it no longer
// has an associated action.
//
// To create a scaling policy or update an existing one, see PutScalingPolicy.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Application Auto Scaling's
// API operation DeleteScalingPolicy for usage and error information.
//
// Returned Error Codes:
// * ValidationException
// An exception was thrown for a validation issue. Review the available parameters
// for the API request.
//
// * ObjectNotFoundException
// The specified object could not be found. For any Put or Register API operation,
// which depends on the existence of a scalable target, this exception is thrown
// if the scalable target with the specified service namespace, resource ID,
// and scalable dimension does not exist. For any Delete or Deregister API operation,
// this exception is thrown if the resource that is to be deleted or deregistered
// cannot be found.
//
// * ConcurrentUpdateException
// Concurrent updates caused an exception, for example, if you request an update
// to an Application Auto Scaling resource that already has a pending update.
//
// * InternalServiceException
// The service encountered an internal error.
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeleteScalingPolicy
func (c *ApplicationAutoScaling) DeleteScalingPolicy(input *DeleteScalingPolicyInput) (*DeleteScalingPolicyOutput, error) {
req, out := c.DeleteScalingPolicyRequest(input)
err := req.Send()
return out, err
}
const opDeregisterScalableTarget = "DeregisterScalableTarget"
// DeregisterScalableTargetRequest generates a "aws/request.Request" representing the
// client's request for the DeregisterScalableTarget operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See DeregisterScalableTarget for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the DeregisterScalableTarget method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the DeregisterScalableTargetRequest method.
// req, resp := client.DeregisterScalableTargetRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeregisterScalableTarget
func (c *ApplicationAutoScaling) DeregisterScalableTargetRequest(input *DeregisterScalableTargetInput) (req *request.Request, output *DeregisterScalableTargetOutput) {
op := &request.Operation{
Name: opDeregisterScalableTarget,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeregisterScalableTargetInput{}
}
req = c.newRequest(op, input, output)
output = &DeregisterScalableTargetOutput{}
req.Data = output
return
}
// DeregisterScalableTarget API operation for Application Auto Scaling.
//
// Deregisters a scalable target.
//
// Deregistering a scalable target deletes the scaling policies that are associated
// with it.
//
// To create a scalable target or update an existing one, see RegisterScalableTarget.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Application Auto Scaling's
// API operation DeregisterScalableTarget for usage and error information.
//
// Returned Error Codes:
// * ValidationException
// An exception was thrown for a validation issue. Review the available parameters
// for the API request.
//
// * ObjectNotFoundException
// The specified object could not be found. For any Put or Register API operation,
// which depends on the existence of a scalable target, this exception is thrown
// if the scalable target with the specified service namespace, resource ID,
// and scalable dimension does not exist. For any Delete or Deregister API operation,
// this exception is thrown if the resource that is to be deleted or deregistered
// cannot be found.
//
// * ConcurrentUpdateException
// Concurrent updates caused an exception, for example, if you request an update
// to an Application Auto Scaling resource that already has a pending update.
//
// * InternalServiceException
// The service encountered an internal error.
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeregisterScalableTarget
func (c *ApplicationAutoScaling) DeregisterScalableTarget(input *DeregisterScalableTargetInput) (*DeregisterScalableTargetOutput, error) {
req, out := c.DeregisterScalableTargetRequest(input)
err := req.Send()
return out, err
}
const opDescribeScalableTargets = "DescribeScalableTargets"
// DescribeScalableTargetsRequest generates a "aws/request.Request" representing the
// client's request for the DescribeScalableTargets operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See DescribeScalableTargets for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the DescribeScalableTargets method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the DescribeScalableTargetsRequest method.
// req, resp := client.DescribeScalableTargetsRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalableTargets
func (c *ApplicationAutoScaling) DescribeScalableTargetsRequest(input *DescribeScalableTargetsInput) (req *request.Request, output *DescribeScalableTargetsOutput) {
op := &request.Operation{
Name: opDescribeScalableTargets,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &DescribeScalableTargetsInput{}
}
req = c.newRequest(op, input, output)
output = &DescribeScalableTargetsOutput{}
req.Data = output
return
}
// DescribeScalableTargets API operation for Application Auto Scaling.
//
// Provides descriptive information about the scalable targets in the specified
// namespace.
//
// You can filter the results using the ResourceIds and ScalableDimension parameters.
//
// To create a scalable target or update an existing one, see RegisterScalableTarget.
// If you are no longer using a scalable target, you can deregister it using
// DeregisterScalableTarget.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Application Auto Scaling's
// API operation DescribeScalableTargets for usage and error information.
//
// Returned Error Codes:
// * ValidationException
// An exception was thrown for a validation issue. Review the available parameters
// for the API request.
//
// * InvalidNextTokenException
// The next token supplied was invalid.
//
// * ConcurrentUpdateException
// Concurrent updates caused an exception, for example, if you request an update
// to an Application Auto Scaling resource that already has a pending update.
//
// * InternalServiceException
// The service encountered an internal error.
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalableTargets
func (c *ApplicationAutoScaling) DescribeScalableTargets(input *DescribeScalableTargetsInput) (*DescribeScalableTargetsOutput, error) {
req, out := c.DescribeScalableTargetsRequest(input)
err := req.Send()
return out, err
}
// DescribeScalableTargetsPages iterates over the pages of a DescribeScalableTargets operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See DescribeScalableTargets method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a DescribeScalableTargets operation.
// pageNum := 0
// err := client.DescribeScalableTargetsPages(params,
// func(page *DescribeScalableTargetsOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
//
func (c *ApplicationAutoScaling) DescribeScalableTargetsPages(input *DescribeScalableTargetsInput, fn func(p *DescribeScalableTargetsOutput, lastPage bool) (shouldContinue bool)) error {
page, _ := c.DescribeScalableTargetsRequest(input)
page.Handlers.Build.PushBack(request.MakeAddToUserAgentFreeFormHandler("Paginator"))
return page.EachPage(func(p interface{}, lastPage bool) bool {
return fn(p.(*DescribeScalableTargetsOutput), lastPage)
})
}
const opDescribeScalingActivities = "DescribeScalingActivities"
// DescribeScalingActivitiesRequest generates a "aws/request.Request" representing the
// client's request for the DescribeScalingActivities operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See DescribeScalingActivities for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the DescribeScalingActivities method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the DescribeScalingActivitiesRequest method.
// req, resp := client.DescribeScalingActivitiesRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingActivities
func (c *ApplicationAutoScaling) DescribeScalingActivitiesRequest(input *DescribeScalingActivitiesInput) (req *request.Request, output *DescribeScalingActivitiesOutput) {
op := &request.Operation{
Name: opDescribeScalingActivities,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &DescribeScalingActivitiesInput{}
}
req = c.newRequest(op, input, output)
output = &DescribeScalingActivitiesOutput{}
req.Data = output
return
}
// DescribeScalingActivities API operation for Application Auto Scaling.
//
// Provides descriptive information about the scaling activities in the specified
// namespace from the previous six weeks.
//
// You can filter the results using the ResourceId and ScalableDimension parameters.
//
// Scaling activities are triggered by CloudWatch alarms that are associated
// with scaling policies. To view the scaling policies for a service namespace,
// see DescribeScalingPolicies. To create a scaling policy or update an existing
// one, see PutScalingPolicy.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Application Auto Scaling's
// API operation DescribeScalingActivities for usage and error information.
//
// Returned Error Codes:
// * ValidationException
// An exception was thrown for a validation issue. Review the available parameters
// for the API request.
//
// * InvalidNextTokenException
// The next token supplied was invalid.
//
// * ConcurrentUpdateException
// Concurrent updates caused an exception, for example, if you request an update
// to an Application Auto Scaling resource that already has a pending update.
//
// * InternalServiceException
// The service encountered an internal error.
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingActivities
func (c *ApplicationAutoScaling) DescribeScalingActivities(input *DescribeScalingActivitiesInput) (*DescribeScalingActivitiesOutput, error) {
req, out := c.DescribeScalingActivitiesRequest(input)
err := req.Send()
return out, err
}
// DescribeScalingActivitiesPages iterates over the pages of a DescribeScalingActivities operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See DescribeScalingActivities method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a DescribeScalingActivities operation.
// pageNum := 0
// err := client.DescribeScalingActivitiesPages(params,
// func(page *DescribeScalingActivitiesOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
//
func (c *ApplicationAutoScaling) DescribeScalingActivitiesPages(input *DescribeScalingActivitiesInput, fn func(p *DescribeScalingActivitiesOutput, lastPage bool) (shouldContinue bool)) error {
page, _ := c.DescribeScalingActivitiesRequest(input)
page.Handlers.Build.PushBack(request.MakeAddToUserAgentFreeFormHandler("Paginator"))
return page.EachPage(func(p interface{}, lastPage bool) bool {
return fn(p.(*DescribeScalingActivitiesOutput), lastPage)
})
}
const opDescribeScalingPolicies = "DescribeScalingPolicies"
// DescribeScalingPoliciesRequest generates a "aws/request.Request" representing the
// client's request for the DescribeScalingPolicies operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See DescribeScalingPolicies for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the DescribeScalingPolicies method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the DescribeScalingPoliciesRequest method.
// req, resp := client.DescribeScalingPoliciesRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingPolicies
func (c *ApplicationAutoScaling) DescribeScalingPoliciesRequest(input *DescribeScalingPoliciesInput) (req *request.Request, output *DescribeScalingPoliciesOutput) {
op := &request.Operation{
Name: opDescribeScalingPolicies,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &DescribeScalingPoliciesInput{}
}
req = c.newRequest(op, input, output)
output = &DescribeScalingPoliciesOutput{}
req.Data = output
return
}
// DescribeScalingPolicies API operation for Application Auto Scaling.
//
// Provides descriptive information about the scaling policies in the specified
// namespace.
//
// You can filter the results using the ResourceId, ScalableDimension, and PolicyNames
// parameters.
//
// To create a scaling policy or update an existing one, see PutScalingPolicy.
// If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Application Auto Scaling's
// API operation DescribeScalingPolicies for usage and error information.
//
// Returned Error Codes:
// * ValidationException
// An exception was thrown for a validation issue. Review the available parameters
// for the API request.
//
// * FailedResourceAccessException
// Failed access to resources caused an exception. This exception currently
// only applies to DescribeScalingPolicies. It is thrown when Application Auto
// Scaling is unable to retrieve the alarms associated with a scaling policy
// due to a client error, for example, if the role ARN specified for a scalable
// target does not have the proper permissions to call the CloudWatch DescribeAlarms
// (http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html)
// API operation on behalf of your account.
//
// * InvalidNextTokenException
// The next token supplied was invalid.
//
// * ConcurrentUpdateException
// Concurrent updates caused an exception, for example, if you request an update
// to an Application Auto Scaling resource that already has a pending update.
//
// * InternalServiceException
// The service encountered an internal error.
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingPolicies
func (c *ApplicationAutoScaling) DescribeScalingPolicies(input *DescribeScalingPoliciesInput) (*DescribeScalingPoliciesOutput, error) {
req, out := c.DescribeScalingPoliciesRequest(input)
err := req.Send()
return out, err
}
// DescribeScalingPoliciesPages iterates over the pages of a DescribeScalingPolicies operation,
// calling the "fn" function with the response data for each page. To stop
// iterating, return false from the fn function.
//
// See DescribeScalingPolicies method for more information on how to use this operation.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over at most 3 pages of a DescribeScalingPolicies operation.
// pageNum := 0
// err := client.DescribeScalingPoliciesPages(params,
// func(page *DescribeScalingPoliciesOutput, lastPage bool) bool {
// pageNum++
// fmt.Println(page)
// return pageNum <= 3
// })
//
func (c *ApplicationAutoScaling) DescribeScalingPoliciesPages(input *DescribeScalingPoliciesInput, fn func(p *DescribeScalingPoliciesOutput, lastPage bool) (shouldContinue bool)) error {
page, _ := c.DescribeScalingPoliciesRequest(input)
page.Handlers.Build.PushBack(request.MakeAddToUserAgentFreeFormHandler("Paginator"))
return page.EachPage(func(p interface{}, lastPage bool) bool {
return fn(p.(*DescribeScalingPoliciesOutput), lastPage)
})
}
const opPutScalingPolicy = "PutScalingPolicy"
// PutScalingPolicyRequest generates a "aws/request.Request" representing the
// client's request for the PutScalingPolicy operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See PutScalingPolicy for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the PutScalingPolicy method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the PutScalingPolicyRequest method.
// req, resp := client.PutScalingPolicyRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/PutScalingPolicy
func (c *ApplicationAutoScaling) PutScalingPolicyRequest(input *PutScalingPolicyInput) (req *request.Request, output *PutScalingPolicyOutput) {
op := &request.Operation{
Name: opPutScalingPolicy,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &PutScalingPolicyInput{}
}
req = c.newRequest(op, input, output)
output = &PutScalingPolicyOutput{}
req.Data = output
return
}
// PutScalingPolicy API operation for Application Auto Scaling.
//
// Creates or updates a policy for an Application Auto Scaling scalable target.
//
// Each scalable target is identified by a service namespace, resource ID, and
// scalable dimension. A scaling policy applies to the scalable target identified
// by those three attributes. You cannot create a scaling policy without first
// registering a scalable target using RegisterScalableTarget.
//
// To update a policy, specify its policy name and the parameters that you want
// to change. Any parameters that you don't specify are not changed by this
// update request.
//
// You can view the scaling policies for a service namespace using DescribeScalingPolicies.
// If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Application Auto Scaling's
// API operation PutScalingPolicy for usage and error information.
//
// Returned Error Codes:
// * ValidationException
// An exception was thrown for a validation issue. Review the available parameters
// for the API request.
//
// * LimitExceededException
// Your account exceeded a limit. This exception is thrown when a per-account
// resource limit is exceeded. For more information, see Application Auto Scaling
// Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_as-app).
//
// * ObjectNotFoundException
// The specified object could not be found. For any Put or Register API operation,
// which depends on the existence of a scalable target, this exception is thrown
// if the scalable target with the specified service namespace, resource ID,
// and scalable dimension does not exist. For any Delete or Deregister API operation,
// this exception is thrown if the resource that is to be deleted or deregistered
// cannot be found.
//
// * ConcurrentUpdateException
// Concurrent updates caused an exception, for example, if you request an update
// to an Application Auto Scaling resource that already has a pending update.
//
// * InternalServiceException
// The service encountered an internal error.
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/PutScalingPolicy
func (c *ApplicationAutoScaling) PutScalingPolicy(input *PutScalingPolicyInput) (*PutScalingPolicyOutput, error) {
req, out := c.PutScalingPolicyRequest(input)
err := req.Send()
return out, err
}
const opRegisterScalableTarget = "RegisterScalableTarget"
// RegisterScalableTargetRequest generates a "aws/request.Request" representing the
// client's request for the RegisterScalableTarget operation. The "output" return
// value can be used to capture response data after the request's "Send" method
// is called.
//
// See RegisterScalableTarget for usage and error information.
//
// Creating a request object using this method should be used when you want to inject
// custom logic into the request's lifecycle using a custom handler, or if you want to
// access properties on the request object before or after sending the request. If
// you just want the service response, call the RegisterScalableTarget method directly
// instead.
//
// Note: You must call the "Send" method on the returned request object in order
// to execute the request.
//
// // Example sending a request using the RegisterScalableTargetRequest method.
// req, resp := client.RegisterScalableTargetRequest(params)
//
// err := req.Send()
// if err == nil { // resp is now filled
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/RegisterScalableTarget
func (c *ApplicationAutoScaling) RegisterScalableTargetRequest(input *RegisterScalableTargetInput) (req *request.Request, output *RegisterScalableTargetOutput) {
op := &request.Operation{
Name: opRegisterScalableTarget,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &RegisterScalableTargetInput{}
}
req = c.newRequest(op, input, output)
output = &RegisterScalableTargetOutput{}
req.Data = output
return
}
// RegisterScalableTarget API operation for Application Auto Scaling.
//
// Registers or updates a scalable target. A scalable target is a resource that
// Application Auto Scaling can scale out or scale in. After you have registered
// a scalable target, you can use this operation to update the minimum and maximum
// values for your scalable dimension.
//
// After you register a scalable target, you can create and apply scaling policies
// using PutScalingPolicy. You can view the scaling policies for a service namespace
// using DescribeScalableTargets. If you are no longer using a scalable target,
// you can deregister it using DeregisterScalableTarget.
//
// Returns awserr.Error for service API and SDK errors. Use runtime type assertions
// with awserr.Error's Code and Message methods to get detailed information about
// the error.
//
// See the AWS API reference guide for Application Auto Scaling's
// API operation RegisterScalableTarget for usage and error information.
//
// Returned Error Codes:
// * ValidationException
// An exception was thrown for a validation issue. Review the available parameters
// for the API request.
//
// * LimitExceededException
// Your account exceeded a limit. This exception is thrown when a per-account
// resource limit is exceeded. For more information, see Application Auto Scaling
// Limits (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_as-app).
//
// * ConcurrentUpdateException
// Concurrent updates caused an exception, for example, if you request an update
// to an Application Auto Scaling resource that already has a pending update.
//
// * InternalServiceException
// The service encountered an internal error.
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/RegisterScalableTarget
func (c *ApplicationAutoScaling) RegisterScalableTarget(input *RegisterScalableTargetInput) (*RegisterScalableTargetOutput, error) {
req, out := c.RegisterScalableTargetRequest(input)
err := req.Send()
return out, err
}
// Represents a CloudWatch alarm associated with a scaling policy.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/Alarm
type Alarm struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the alarm.
//
// AlarmARN is a required field
AlarmARN *string `type:"string" required:"true"`
// The name of the alarm.
//
// AlarmName is a required field
AlarmName *string `type:"string" required:"true"`
}
// String returns the string representation
func (s Alarm) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s Alarm) GoString() string {
return s.String()
}
// SetAlarmARN sets the AlarmARN field's value.
func (s *Alarm) SetAlarmARN(v string) *Alarm {
s.AlarmARN = &v
return s
}
// SetAlarmName sets the AlarmName field's value.
func (s *Alarm) SetAlarmName(v string) *Alarm {
s.AlarmName = &v
return s
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeleteScalingPolicyRequest
type DeleteScalingPolicyInput struct {
_ struct{} `type:"structure"`
// The name of the scaling policy.
//
// PolicyName is a required field
PolicyName *string `min:"1" type:"string" required:"true"`
// The identifier of the resource associated with the scalable target. This
// string consists of the resource type and unique identifier.
//
// * ECS service - The resource type is service and the unique identifier
// is the cluster name and service name. Example: service/default/sample-webapp.
//
// * Spot fleet request - The resource type is spot-fleet-request and the
// unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
//
// * EMR cluster - The resource type is instancegroup and the unique identifier
// is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
//
// ResourceId is a required field
ResourceId *string `min:"1" type:"string" required:"true"`
// The scalable dimension. This string consists of the service namespace, resource
// type, and scaling property.
//
// * ecs:service:DesiredCount - The desired task count of an ECS service.
//
// * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
// fleet request.
//
// * elasticmapreduce:instancegroup:InstanceCount - The instance count of
// an EMR Instance Group.
//
// ScalableDimension is a required field
ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`
// The namespace of the AWS service. 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 is a required field
ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
}
// String returns the string representation
func (s DeleteScalingPolicyInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeleteScalingPolicyInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeleteScalingPolicyInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeleteScalingPolicyInput"}
if s.PolicyName == nil {
invalidParams.Add(request.NewErrParamRequired("PolicyName"))
}
if s.PolicyName != nil && len(*s.PolicyName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("PolicyName", 1))
}
if s.ResourceId == nil {
invalidParams.Add(request.NewErrParamRequired("ResourceId"))
}
if s.ResourceId != nil && len(*s.ResourceId) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ResourceId", 1))
}
if s.ScalableDimension == nil {
invalidParams.Add(request.NewErrParamRequired("ScalableDimension"))
}
if s.ServiceNamespace == nil {
invalidParams.Add(request.NewErrParamRequired("ServiceNamespace"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetPolicyName sets the PolicyName field's value.
func (s *DeleteScalingPolicyInput) SetPolicyName(v string) *DeleteScalingPolicyInput {
s.PolicyName = &v
return s
}
// SetResourceId sets the ResourceId field's value.
func (s *DeleteScalingPolicyInput) SetResourceId(v string) *DeleteScalingPolicyInput {
s.ResourceId = &v
return s
}
// SetScalableDimension sets the ScalableDimension field's value.
func (s *DeleteScalingPolicyInput) SetScalableDimension(v string) *DeleteScalingPolicyInput {
s.ScalableDimension = &v
return s
}
// SetServiceNamespace sets the ServiceNamespace field's value.
func (s *DeleteScalingPolicyInput) SetServiceNamespace(v string) *DeleteScalingPolicyInput {
s.ServiceNamespace = &v
return s
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeleteScalingPolicyResponse
type DeleteScalingPolicyOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s DeleteScalingPolicyOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeleteScalingPolicyOutput) GoString() string {
return s.String()
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeregisterScalableTargetRequest
type DeregisterScalableTargetInput struct {
_ struct{} `type:"structure"`
// The identifier of the resource associated with the scalable target. This
// string consists of the resource type and unique identifier.
//
// * ECS service - The resource type is service and the unique identifier
// is the cluster name and service name. Example: service/default/sample-webapp.
//
// * Spot fleet request - The resource type is spot-fleet-request and the
// unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
//
// * EMR cluster - The resource type is instancegroup and the unique identifier
// is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
//
// ResourceId is a required field
ResourceId *string `min:"1" type:"string" required:"true"`
// The scalable dimension associated with the scalable target. This string consists
// of the service namespace, resource type, and scaling property.
//
// * ecs:service:DesiredCount - The desired task count of an ECS service.
//
// * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
// fleet request.
//
// * elasticmapreduce:instancegroup:InstanceCount - The instance count of
// an EMR Instance Group.
//
// ScalableDimension is a required field
ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`
// The namespace of the AWS service. 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 is a required field
ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
}
// String returns the string representation
func (s DeregisterScalableTargetInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeregisterScalableTargetInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeregisterScalableTargetInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DeregisterScalableTargetInput"}
if s.ResourceId == nil {
invalidParams.Add(request.NewErrParamRequired("ResourceId"))
}
if s.ResourceId != nil && len(*s.ResourceId) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ResourceId", 1))
}
if s.ScalableDimension == nil {
invalidParams.Add(request.NewErrParamRequired("ScalableDimension"))
}
if s.ServiceNamespace == nil {
invalidParams.Add(request.NewErrParamRequired("ServiceNamespace"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetResourceId sets the ResourceId field's value.
func (s *DeregisterScalableTargetInput) SetResourceId(v string) *DeregisterScalableTargetInput {
s.ResourceId = &v
return s
}
// SetScalableDimension sets the ScalableDimension field's value.
func (s *DeregisterScalableTargetInput) SetScalableDimension(v string) *DeregisterScalableTargetInput {
s.ScalableDimension = &v
return s
}
// SetServiceNamespace sets the ServiceNamespace field's value.
func (s *DeregisterScalableTargetInput) SetServiceNamespace(v string) *DeregisterScalableTargetInput {
s.ServiceNamespace = &v
return s
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DeregisterScalableTargetResponse
type DeregisterScalableTargetOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s DeregisterScalableTargetOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeregisterScalableTargetOutput) GoString() string {
return s.String()
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalableTargetsRequest
type DescribeScalableTargetsInput struct {
_ struct{} `type:"structure"`
// The maximum number of scalable target results. This value can be between
// 1 and 50. The default value is 50.
//
// If this parameter is used, the operation returns up to MaxResults results
// at a time, along with a NextToken value. To get the next set of results,
// include the NextToken value in a subsequent call. If this parameter is not
// used, the operation returns up to 50 results and a NextToken value, if applicable.
MaxResults *int64 `type:"integer"`
// The token for the next set of results.
NextToken *string `type:"string"`
// The identifier of the resource associated with the scalable target. This
// string consists of the resource type and unique identifier. If you specify
// a scalable dimension, you must also specify a resource ID.
//
// * ECS service - The resource type is service and the unique identifier
// is the cluster name and service name. Example: service/default/sample-webapp.
//
// * Spot fleet request - The resource type is spot-fleet-request and the
// unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
//
// * EMR cluster - The resource type is instancegroup and the unique identifier
// is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
ResourceIds []*string `type:"list"`
// The scalable dimension associated with the scalable target. This string consists
// of the service namespace, resource type, and scaling property. If you specify
// a scalable dimension, you must also specify a resource ID.
//
// * ecs:service:DesiredCount - The desired task count of an ECS service.
//
// * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
// fleet request.
//
// * elasticmapreduce:instancegroup:InstanceCount - The instance count of
// an EMR Instance Group.
ScalableDimension *string `type:"string" enum:"ScalableDimension"`
// The namespace of the AWS service. 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 is a required field
ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
}
// String returns the string representation
func (s DescribeScalableTargetsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeScalableTargetsInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeScalableTargetsInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeScalableTargetsInput"}
if s.ServiceNamespace == nil {
invalidParams.Add(request.NewErrParamRequired("ServiceNamespace"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMaxResults sets the MaxResults field's value.
func (s *DescribeScalableTargetsInput) SetMaxResults(v int64) *DescribeScalableTargetsInput {
s.MaxResults = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *DescribeScalableTargetsInput) SetNextToken(v string) *DescribeScalableTargetsInput {
s.NextToken = &v
return s
}
// SetResourceIds sets the ResourceIds field's value.
func (s *DescribeScalableTargetsInput) SetResourceIds(v []*string) *DescribeScalableTargetsInput {
s.ResourceIds = v
return s
}
// SetScalableDimension sets the ScalableDimension field's value.
func (s *DescribeScalableTargetsInput) SetScalableDimension(v string) *DescribeScalableTargetsInput {
s.ScalableDimension = &v
return s
}
// SetServiceNamespace sets the ServiceNamespace field's value.
func (s *DescribeScalableTargetsInput) SetServiceNamespace(v string) *DescribeScalableTargetsInput {
s.ServiceNamespace = &v
return s
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalableTargetsResponse
type DescribeScalableTargetsOutput struct {
_ struct{} `type:"structure"`
// 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"`
// The list of scalable targets that matches the request parameters.
ScalableTargets []*ScalableTarget `type:"list"`
}
// String returns the string representation
func (s DescribeScalableTargetsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeScalableTargetsOutput) GoString() string {
return s.String()
}
// SetNextToken sets the NextToken field's value.
func (s *DescribeScalableTargetsOutput) SetNextToken(v string) *DescribeScalableTargetsOutput {
s.NextToken = &v
return s
}
// SetScalableTargets sets the ScalableTargets field's value.
func (s *DescribeScalableTargetsOutput) SetScalableTargets(v []*ScalableTarget) *DescribeScalableTargetsOutput {
s.ScalableTargets = v
return s
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingActivitiesRequest
type DescribeScalingActivitiesInput struct {
_ struct{} `type:"structure"`
// The maximum number of scalable target results. This value can be between
// 1 and 50. The default value is 50.
//
// If this parameter is used, the operation returns up to MaxResults results
// at a time, along with a NextToken value. To get the next set of results,
// include the NextToken value in a subsequent call. If this parameter is not
// used, the operation returns up to 50 results and a NextToken value, if applicable.
MaxResults *int64 `type:"integer"`
// The token for the next set of results.
NextToken *string `type:"string"`
// The identifier of the resource associated with the scaling activity. This
// string consists of the resource type and unique identifier. If you specify
// a scalable dimension, you must also specify a resource ID.
//
// * ECS service - The resource type is service and the unique identifier
// is the cluster name and service name. Example: service/default/sample-webapp.
//
// * Spot fleet request - The resource type is spot-fleet-request and the
// unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
//
// * EMR cluster - The resource type is instancegroup and the unique identifier
// is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
ResourceId *string `min:"1" type:"string"`
// The scalable dimension. This string consists of the service namespace, resource
// type, and scaling property. If you specify a scalable dimension, you must
// also specify a resource ID.
//
// * ecs:service:DesiredCount - The desired task count of an ECS service.
//
// * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
// fleet request.
//
// * elasticmapreduce:instancegroup:InstanceCount - The instance count of
// an EMR Instance Group.
ScalableDimension *string `type:"string" enum:"ScalableDimension"`
// The namespace of the AWS service. 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 is a required field
ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
}
// String returns the string representation
func (s DescribeScalingActivitiesInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeScalingActivitiesInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeScalingActivitiesInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeScalingActivitiesInput"}
if s.ResourceId != nil && len(*s.ResourceId) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ResourceId", 1))
}
if s.ServiceNamespace == nil {
invalidParams.Add(request.NewErrParamRequired("ServiceNamespace"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMaxResults sets the MaxResults field's value.
func (s *DescribeScalingActivitiesInput) SetMaxResults(v int64) *DescribeScalingActivitiesInput {
s.MaxResults = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *DescribeScalingActivitiesInput) SetNextToken(v string) *DescribeScalingActivitiesInput {
s.NextToken = &v
return s
}
// SetResourceId sets the ResourceId field's value.
func (s *DescribeScalingActivitiesInput) SetResourceId(v string) *DescribeScalingActivitiesInput {
s.ResourceId = &v
return s
}
// SetScalableDimension sets the ScalableDimension field's value.
func (s *DescribeScalingActivitiesInput) SetScalableDimension(v string) *DescribeScalingActivitiesInput {
s.ScalableDimension = &v
return s
}
// SetServiceNamespace sets the ServiceNamespace field's value.
func (s *DescribeScalingActivitiesInput) SetServiceNamespace(v string) *DescribeScalingActivitiesInput {
s.ServiceNamespace = &v
return s
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingActivitiesResponse
type DescribeScalingActivitiesOutput struct {
_ struct{} `type:"structure"`
// 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"`
// A list of scaling activity objects.
ScalingActivities []*ScalingActivity `type:"list"`
}
// String returns the string representation
func (s DescribeScalingActivitiesOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeScalingActivitiesOutput) GoString() string {
return s.String()
}
// SetNextToken sets the NextToken field's value.
func (s *DescribeScalingActivitiesOutput) SetNextToken(v string) *DescribeScalingActivitiesOutput {
s.NextToken = &v
return s
}
// SetScalingActivities sets the ScalingActivities field's value.
func (s *DescribeScalingActivitiesOutput) SetScalingActivities(v []*ScalingActivity) *DescribeScalingActivitiesOutput {
s.ScalingActivities = v
return s
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingPoliciesRequest
type DescribeScalingPoliciesInput struct {
_ struct{} `type:"structure"`
// The maximum number of scalable target results. This value can be between
// 1 and 50. The default value is 50.
//
// If this parameter is used, the operation returns up to MaxResults results
// at a time, along with a NextToken value. To get the next set of results,
// include the NextToken value in a subsequent call. If this parameter is not
// used, the operation returns up to 50 results and a NextToken value, if applicable.
MaxResults *int64 `type:"integer"`
// The token for the next set of results.
NextToken *string `type:"string"`
// The names of the scaling policies to describe.
PolicyNames []*string `type:"list"`
// The identifier of the resource associated with the scaling policy. This string
// consists of the resource type and unique identifier. If you specify a scalable
// dimension, you must also specify a resource ID.
//
// * ECS service - The resource type is service and the unique identifier
// is the cluster name and service name. Example: service/default/sample-webapp.
//
// * Spot fleet request - The resource type is spot-fleet-request and the
// unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
//
// * EMR cluster - The resource type is instancegroup and the unique identifier
// is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
ResourceId *string `min:"1" type:"string"`
// The scalable dimension. This string consists of the service namespace, resource
// type, and scaling property. If you specify a scalable dimension, you must
// also specify a resource ID.
//
// * ecs:service:DesiredCount - The desired task count of an ECS service.
//
// * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
// fleet request.
//
// * elasticmapreduce:instancegroup:InstanceCount - The instance count of
// an EMR Instance Group.
ScalableDimension *string `type:"string" enum:"ScalableDimension"`
// The namespace of the AWS service. 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 is a required field
ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
}
// String returns the string representation
func (s DescribeScalingPoliciesInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeScalingPoliciesInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeScalingPoliciesInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "DescribeScalingPoliciesInput"}
if s.ResourceId != nil && len(*s.ResourceId) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ResourceId", 1))
}
if s.ServiceNamespace == nil {
invalidParams.Add(request.NewErrParamRequired("ServiceNamespace"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMaxResults sets the MaxResults field's value.
func (s *DescribeScalingPoliciesInput) SetMaxResults(v int64) *DescribeScalingPoliciesInput {
s.MaxResults = &v
return s
}
// SetNextToken sets the NextToken field's value.
func (s *DescribeScalingPoliciesInput) SetNextToken(v string) *DescribeScalingPoliciesInput {
s.NextToken = &v
return s
}
// SetPolicyNames sets the PolicyNames field's value.
func (s *DescribeScalingPoliciesInput) SetPolicyNames(v []*string) *DescribeScalingPoliciesInput {
s.PolicyNames = v
return s
}
// SetResourceId sets the ResourceId field's value.
func (s *DescribeScalingPoliciesInput) SetResourceId(v string) *DescribeScalingPoliciesInput {
s.ResourceId = &v
return s
}
// SetScalableDimension sets the ScalableDimension field's value.
func (s *DescribeScalingPoliciesInput) SetScalableDimension(v string) *DescribeScalingPoliciesInput {
s.ScalableDimension = &v
return s
}
// SetServiceNamespace sets the ServiceNamespace field's value.
func (s *DescribeScalingPoliciesInput) SetServiceNamespace(v string) *DescribeScalingPoliciesInput {
s.ServiceNamespace = &v
return s
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingPoliciesResponse
type DescribeScalingPoliciesOutput struct {
_ struct{} `type:"structure"`
// 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"`
// A list of scaling policy objects.
ScalingPolicies []*ScalingPolicy `type:"list"`
}
// String returns the string representation
func (s DescribeScalingPoliciesOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeScalingPoliciesOutput) GoString() string {
return s.String()
}
// SetNextToken sets the NextToken field's value.
func (s *DescribeScalingPoliciesOutput) SetNextToken(v string) *DescribeScalingPoliciesOutput {
s.NextToken = &v
return s
}
// SetScalingPolicies sets the ScalingPolicies field's value.
func (s *DescribeScalingPoliciesOutput) SetScalingPolicies(v []*ScalingPolicy) *DescribeScalingPoliciesOutput {
s.ScalingPolicies = v
return s
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/PutScalingPolicyRequest
type PutScalingPolicyInput struct {
_ struct{} `type:"structure"`
// The name of the scaling policy.
//
// PolicyName is a required field
PolicyName *string `min:"1" type:"string" required:"true"`
// The policy type. If you are creating a new policy, this parameter is required.
// If you are updating a policy, this parameter is not required.
PolicyType *string `type:"string" enum:"PolicyType"`
// The identifier of the resource associated with the scaling policy. This string
// consists of the resource type and unique identifier.
//
// * ECS service - The resource type is service and the unique identifier
// is the cluster name and service name. Example: service/default/sample-webapp.
//
// * Spot fleet request - The resource type is spot-fleet-request and the
// unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
//
// * EMR cluster - The resource type is instancegroup and the unique identifier
// is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
//
// ResourceId is a required field
ResourceId *string `min:"1" type:"string" required:"true"`
// The scalable dimension. This string consists of the service namespace, resource
// type, and scaling property.
//
// * ecs:service:DesiredCount - The desired task count of an ECS service.
//
// * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
// fleet request.
//
// * elasticmapreduce:instancegroup:InstanceCount - The instance count of
// an EMR Instance Group.
//
// ScalableDimension is a required field
ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`
// The namespace of the AWS service. 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 is a required field
ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
// The configuration for the step scaling policy. If you are creating a new
// policy, this parameter is required. If you are updating a policy, this parameter
// is not required. For more information, see StepScalingPolicyConfiguration
// and StepAdjustment.
StepScalingPolicyConfiguration *StepScalingPolicyConfiguration `type:"structure"`
}
// String returns the string representation
func (s PutScalingPolicyInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s PutScalingPolicyInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *PutScalingPolicyInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "PutScalingPolicyInput"}
if s.PolicyName == nil {
invalidParams.Add(request.NewErrParamRequired("PolicyName"))
}
if s.PolicyName != nil && len(*s.PolicyName) < 1 {
invalidParams.Add(request.NewErrParamMinLen("PolicyName", 1))
}
if s.ResourceId == nil {
invalidParams.Add(request.NewErrParamRequired("ResourceId"))
}
if s.ResourceId != nil && len(*s.ResourceId) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ResourceId", 1))
}
if s.ScalableDimension == nil {
invalidParams.Add(request.NewErrParamRequired("ScalableDimension"))
}
if s.ServiceNamespace == nil {
invalidParams.Add(request.NewErrParamRequired("ServiceNamespace"))
}
if s.StepScalingPolicyConfiguration != nil {
if err := s.StepScalingPolicyConfiguration.Validate(); err != nil {
invalidParams.AddNested("StepScalingPolicyConfiguration", err.(request.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetPolicyName sets the PolicyName field's value.
func (s *PutScalingPolicyInput) SetPolicyName(v string) *PutScalingPolicyInput {
s.PolicyName = &v
return s
}
// SetPolicyType sets the PolicyType field's value.
func (s *PutScalingPolicyInput) SetPolicyType(v string) *PutScalingPolicyInput {
s.PolicyType = &v
return s
}
// SetResourceId sets the ResourceId field's value.
func (s *PutScalingPolicyInput) SetResourceId(v string) *PutScalingPolicyInput {
s.ResourceId = &v
return s
}
// SetScalableDimension sets the ScalableDimension field's value.
func (s *PutScalingPolicyInput) SetScalableDimension(v string) *PutScalingPolicyInput {
s.ScalableDimension = &v
return s
}
// SetServiceNamespace sets the ServiceNamespace field's value.
func (s *PutScalingPolicyInput) SetServiceNamespace(v string) *PutScalingPolicyInput {
s.ServiceNamespace = &v
return s
}
// SetStepScalingPolicyConfiguration sets the StepScalingPolicyConfiguration field's value.
func (s *PutScalingPolicyInput) SetStepScalingPolicyConfiguration(v *StepScalingPolicyConfiguration) *PutScalingPolicyInput {
s.StepScalingPolicyConfiguration = v
return s
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/PutScalingPolicyResponse
type PutScalingPolicyOutput struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the resulting scaling policy.
//
// PolicyARN is a required field
PolicyARN *string `min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s PutScalingPolicyOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s PutScalingPolicyOutput) GoString() string {
return s.String()
}
// SetPolicyARN sets the PolicyARN field's value.
func (s *PutScalingPolicyOutput) SetPolicyARN(v string) *PutScalingPolicyOutput {
s.PolicyARN = &v
return s
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/RegisterScalableTargetRequest
type RegisterScalableTargetInput struct {
_ struct{} `type:"structure"`
// The maximum value to scale to in response to a scale out event. This parameter
// is required if you are registering a scalable target and optional if you
// are updating one.
MaxCapacity *int64 `type:"integer"`
// The minimum value to scale to in response to a scale in event. This parameter
// is required if you are registering a scalable target and optional if you
// are updating one.
MinCapacity *int64 `type:"integer"`
// The identifier of the resource associated with the scalable target. This
// string consists of the resource type and unique identifier.
//
// * ECS service - The resource type is service and the unique identifier
// is the cluster name and service name. Example: service/default/sample-webapp.
//
// * Spot fleet request - The resource type is spot-fleet-request and the
// unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
//
// * EMR cluster - The resource type is instancegroup and the unique identifier
// is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
//
// ResourceId is a required field
ResourceId *string `min:"1" type:"string" required:"true"`
// The ARN of an IAM role that allows Application Auto Scaling to modify the
// scalable target on your behalf. This parameter is required when you register
// a scalable target and optional when you update one.
RoleARN *string `min:"1" type:"string"`
// The scalable dimension associated with the scalable target. This string consists
// of the service namespace, resource type, and scaling property.
//
// * ecs:service:DesiredCount - The desired task count of an ECS service.
//
// * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
// fleet request.
//
// * elasticmapreduce:instancegroup:InstanceCount - The instance count of
// an EMR Instance Group.
//
// ScalableDimension is a required field
ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`
// The namespace of the AWS service. 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 is a required field
ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
}
// String returns the string representation
func (s RegisterScalableTargetInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s RegisterScalableTargetInput) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *RegisterScalableTargetInput) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "RegisterScalableTargetInput"}
if s.ResourceId == nil {
invalidParams.Add(request.NewErrParamRequired("ResourceId"))
}
if s.ResourceId != nil && len(*s.ResourceId) < 1 {
invalidParams.Add(request.NewErrParamMinLen("ResourceId", 1))
}
if s.RoleARN != nil && len(*s.RoleARN) < 1 {
invalidParams.Add(request.NewErrParamMinLen("RoleARN", 1))
}
if s.ScalableDimension == nil {
invalidParams.Add(request.NewErrParamRequired("ScalableDimension"))
}
if s.ServiceNamespace == nil {
invalidParams.Add(request.NewErrParamRequired("ServiceNamespace"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMaxCapacity sets the MaxCapacity field's value.
func (s *RegisterScalableTargetInput) SetMaxCapacity(v int64) *RegisterScalableTargetInput {
s.MaxCapacity = &v
return s
}
// SetMinCapacity sets the MinCapacity field's value.
func (s *RegisterScalableTargetInput) SetMinCapacity(v int64) *RegisterScalableTargetInput {
s.MinCapacity = &v
return s
}
// SetResourceId sets the ResourceId field's value.
func (s *RegisterScalableTargetInput) SetResourceId(v string) *RegisterScalableTargetInput {
s.ResourceId = &v
return s
}
// SetRoleARN sets the RoleARN field's value.
func (s *RegisterScalableTargetInput) SetRoleARN(v string) *RegisterScalableTargetInput {
s.RoleARN = &v
return s
}
// SetScalableDimension sets the ScalableDimension field's value.
func (s *RegisterScalableTargetInput) SetScalableDimension(v string) *RegisterScalableTargetInput {
s.ScalableDimension = &v
return s
}
// SetServiceNamespace sets the ServiceNamespace field's value.
func (s *RegisterScalableTargetInput) SetServiceNamespace(v string) *RegisterScalableTargetInput {
s.ServiceNamespace = &v
return s
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/RegisterScalableTargetResponse
type RegisterScalableTargetOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s RegisterScalableTargetOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s RegisterScalableTargetOutput) GoString() string {
return s.String()
}
// Represents a scalable target.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/ScalableTarget
type ScalableTarget struct {
_ struct{} `type:"structure"`
// The Unix timestamp for when the scalable target was created.
//
// CreationTime is a required field
CreationTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`
// The maximum value to scale to in response to a scale out event.
//
// MaxCapacity is a required field
MaxCapacity *int64 `type:"integer" required:"true"`
// The minimum value to scale to in response to a scale in event.
//
// MinCapacity is a required field
MinCapacity *int64 `type:"integer" required:"true"`
// The identifier of the resource associated with the scalable target. This
// string consists of the resource type and unique identifier.
//
// * ECS service - The resource type is service and the unique identifier
// is the cluster name and service name. Example: service/default/sample-webapp.
//
// * Spot fleet request - The resource type is spot-fleet-request and the
// unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
//
// * EMR cluster - The resource type is instancegroup and the unique identifier
// is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
//
// ResourceId is a required field
ResourceId *string `min:"1" type:"string" required:"true"`
// The ARN of an IAM role that allows Application Auto Scaling to modify the
// scalable target on your behalf.
//
// RoleARN is a required field
RoleARN *string `min:"1" type:"string" required:"true"`
// The scalable dimension associated with the scalable target. This string consists
// of the service namespace, resource type, and scaling property.
//
// * ecs:service:DesiredCount - The desired task count of an ECS service.
//
// * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
// fleet request.
//
// * elasticmapreduce:instancegroup:InstanceCount - The instance count of
// an EMR Instance Group.
//
// ScalableDimension is a required field
ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`
// The namespace of the AWS service. 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 is a required field
ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
}
// String returns the string representation
func (s ScalableTarget) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ScalableTarget) GoString() string {
return s.String()
}
// SetCreationTime sets the CreationTime field's value.
func (s *ScalableTarget) SetCreationTime(v time.Time) *ScalableTarget {
s.CreationTime = &v
return s
}
// SetMaxCapacity sets the MaxCapacity field's value.
func (s *ScalableTarget) SetMaxCapacity(v int64) *ScalableTarget {
s.MaxCapacity = &v
return s
}
// SetMinCapacity sets the MinCapacity field's value.
func (s *ScalableTarget) SetMinCapacity(v int64) *ScalableTarget {
s.MinCapacity = &v
return s
}
// SetResourceId sets the ResourceId field's value.
func (s *ScalableTarget) SetResourceId(v string) *ScalableTarget {
s.ResourceId = &v
return s
}
// SetRoleARN sets the RoleARN field's value.
func (s *ScalableTarget) SetRoleARN(v string) *ScalableTarget {
s.RoleARN = &v
return s
}
// SetScalableDimension sets the ScalableDimension field's value.
func (s *ScalableTarget) SetScalableDimension(v string) *ScalableTarget {
s.ScalableDimension = &v
return s
}
// SetServiceNamespace sets the ServiceNamespace field's value.
func (s *ScalableTarget) SetServiceNamespace(v string) *ScalableTarget {
s.ServiceNamespace = &v
return s
}
// Represents a scaling activity.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/ScalingActivity
type ScalingActivity struct {
_ struct{} `type:"structure"`
// The unique identifier of the scaling activity.
//
// ActivityId is a required field
ActivityId *string `type:"string" required:"true"`
// A simple description of what caused the scaling activity to happen.
//
// Cause is a required field
Cause *string `type:"string" required:"true"`
// A simple description of what action the scaling activity intends to accomplish.
//
// Description is a required field
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 identifier of the resource associated with the scaling activity. This
// string consists of the resource type and unique identifier.
//
// * ECS service - The resource type is service and the unique identifier
// is the cluster name and service name. Example: service/default/sample-webapp.
//
// * Spot fleet request - The resource type is spot-fleet-request and the
// unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
//
// * EMR cluster - The resource type is instancegroup and the unique identifier
// is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
//
// ResourceId is a required field
ResourceId *string `min:"1" type:"string" required:"true"`
// The scalable dimension. This string consists of the service namespace, resource
// type, and scaling property.
//
// * ecs:service:DesiredCount - The desired task count of an ECS service.
//
// * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
// fleet request.
//
// * elasticmapreduce:instancegroup:InstanceCount - The instance count of
// an EMR Instance Group.
//
// ScalableDimension is a required field
ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`
// The namespace of the AWS service. 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 is a required field
ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
// The Unix timestamp for when the scaling activity began.
//
// StartTime is a required field
StartTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`
// Indicates the status of the scaling activity.
//
// StatusCode is a required field
StatusCode *string `type:"string" required:"true" enum:"ScalingActivityStatusCode"`
// A simple message about the current status of the scaling activity.
StatusMessage *string `type:"string"`
}
// String returns the string representation
func (s ScalingActivity) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ScalingActivity) GoString() string {
return s.String()
}
// SetActivityId sets the ActivityId field's value.
func (s *ScalingActivity) SetActivityId(v string) *ScalingActivity {
s.ActivityId = &v
return s
}
// SetCause sets the Cause field's value.
func (s *ScalingActivity) SetCause(v string) *ScalingActivity {
s.Cause = &v
return s
}
// SetDescription sets the Description field's value.
func (s *ScalingActivity) SetDescription(v string) *ScalingActivity {
s.Description = &v
return s
}
// SetDetails sets the Details field's value.
func (s *ScalingActivity) SetDetails(v string) *ScalingActivity {
s.Details = &v
return s
}
// SetEndTime sets the EndTime field's value.
func (s *ScalingActivity) SetEndTime(v time.Time) *ScalingActivity {
s.EndTime = &v
return s
}
// SetResourceId sets the ResourceId field's value.
func (s *ScalingActivity) SetResourceId(v string) *ScalingActivity {
s.ResourceId = &v
return s
}
// SetScalableDimension sets the ScalableDimension field's value.
func (s *ScalingActivity) SetScalableDimension(v string) *ScalingActivity {
s.ScalableDimension = &v
return s
}
// SetServiceNamespace sets the ServiceNamespace field's value.
func (s *ScalingActivity) SetServiceNamespace(v string) *ScalingActivity {
s.ServiceNamespace = &v
return s
}
// SetStartTime sets the StartTime field's value.
func (s *ScalingActivity) SetStartTime(v time.Time) *ScalingActivity {
s.StartTime = &v
return s
}
// SetStatusCode sets the StatusCode field's value.
func (s *ScalingActivity) SetStatusCode(v string) *ScalingActivity {
s.StatusCode = &v
return s
}
// SetStatusMessage sets the StatusMessage field's value.
func (s *ScalingActivity) SetStatusMessage(v string) *ScalingActivity {
s.StatusMessage = &v
return s
}
// Represents a scaling policy.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/ScalingPolicy
type ScalingPolicy struct {
_ struct{} `type:"structure"`
// The CloudWatch alarms associated with the scaling policy.
Alarms []*Alarm `type:"list"`
// The Unix timestamp for when the scaling policy was created.
//
// CreationTime is a required field
CreationTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`
// The Amazon Resource Name (ARN) of the scaling policy.
//
// PolicyARN is a required field
PolicyARN *string `min:"1" type:"string" required:"true"`
// The name of the scaling policy.
//
// PolicyName is a required field
PolicyName *string `min:"1" type:"string" required:"true"`
// The scaling policy type.
//
// PolicyType is a required field
PolicyType *string `type:"string" required:"true" enum:"PolicyType"`
// The identifier of the resource associated with the scaling policy. This string
// consists of the resource type and unique identifier.
//
// * ECS service - The resource type is service and the unique identifier
// is the cluster name and service name. Example: service/default/sample-webapp.
//
// * Spot fleet request - The resource type is spot-fleet-request and the
// unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
//
// * EMR cluster - The resource type is instancegroup and the unique identifier
// is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
//
// ResourceId is a required field
ResourceId *string `min:"1" type:"string" required:"true"`
// The scalable dimension. This string consists of the service namespace, resource
// type, and scaling property.
//
// * ecs:service:DesiredCount - The desired task count of an ECS service.
//
// * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
// fleet request.
//
// * elasticmapreduce:instancegroup:InstanceCount - The instance count of
// an EMR Instance Group.
//
// ScalableDimension is a required field
ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`
// The namespace of the AWS service. 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 is a required field
ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"`
// The configuration for the step scaling policy.
StepScalingPolicyConfiguration *StepScalingPolicyConfiguration `type:"structure"`
}
// String returns the string representation
func (s ScalingPolicy) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ScalingPolicy) GoString() string {
return s.String()
}
// SetAlarms sets the Alarms field's value.
func (s *ScalingPolicy) SetAlarms(v []*Alarm) *ScalingPolicy {
s.Alarms = v
return s
}
// SetCreationTime sets the CreationTime field's value.
func (s *ScalingPolicy) SetCreationTime(v time.Time) *ScalingPolicy {
s.CreationTime = &v
return s
}
// SetPolicyARN sets the PolicyARN field's value.
func (s *ScalingPolicy) SetPolicyARN(v string) *ScalingPolicy {
s.PolicyARN = &v
return s
}
// SetPolicyName sets the PolicyName field's value.
func (s *ScalingPolicy) SetPolicyName(v string) *ScalingPolicy {
s.PolicyName = &v
return s
}
// SetPolicyType sets the PolicyType field's value.
func (s *ScalingPolicy) SetPolicyType(v string) *ScalingPolicy {
s.PolicyType = &v
return s
}
// SetResourceId sets the ResourceId field's value.
func (s *ScalingPolicy) SetResourceId(v string) *ScalingPolicy {
s.ResourceId = &v
return s
}
// SetScalableDimension sets the ScalableDimension field's value.
func (s *ScalingPolicy) SetScalableDimension(v string) *ScalingPolicy {
s.ScalableDimension = &v
return s
}
// SetServiceNamespace sets the ServiceNamespace field's value.
func (s *ScalingPolicy) SetServiceNamespace(v string) *ScalingPolicy {
s.ServiceNamespace = &v
return s
}
// SetStepScalingPolicyConfiguration sets the StepScalingPolicyConfiguration field's value.
func (s *ScalingPolicy) SetStepScalingPolicyConfiguration(v *StepScalingPolicyConfiguration) *ScalingPolicy {
s.StepScalingPolicyConfiguration = v
return s
}
// Represents 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:
//
// * To trigger the adjustment 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.
//
// * To trigger the adjustment 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.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/StepAdjustment
type StepAdjustment struct {
_ struct{} `type:"structure"`
// 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 is a required field
ScalingAdjustment *int64 `type:"integer" required:"true"`
}
// String returns the string representation
func (s StepAdjustment) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s StepAdjustment) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *StepAdjustment) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "StepAdjustment"}
if s.ScalingAdjustment == nil {
invalidParams.Add(request.NewErrParamRequired("ScalingAdjustment"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetMetricIntervalLowerBound sets the MetricIntervalLowerBound field's value.
func (s *StepAdjustment) SetMetricIntervalLowerBound(v float64) *StepAdjustment {
s.MetricIntervalLowerBound = &v
return s
}
// SetMetricIntervalUpperBound sets the MetricIntervalUpperBound field's value.
func (s *StepAdjustment) SetMetricIntervalUpperBound(v float64) *StepAdjustment {
s.MetricIntervalUpperBound = &v
return s
}
// SetScalingAdjustment sets the ScalingAdjustment field's value.
func (s *StepAdjustment) SetScalingAdjustment(v int64) *StepAdjustment {
s.ScalingAdjustment = &v
return s
}
// Represents a step scaling policy configuration.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/StepScalingPolicyConfiguration
type StepScalingPolicyConfiguration struct {
_ struct{} `type:"structure"`
// 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"`
}
// String returns the string representation
func (s StepScalingPolicyConfiguration) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s StepScalingPolicyConfiguration) GoString() string {
return s.String()
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *StepScalingPolicyConfiguration) Validate() error {
invalidParams := request.ErrInvalidParams{Context: "StepScalingPolicyConfiguration"}
if s.StepAdjustments != nil {
for i, v := range s.StepAdjustments {
if v == nil {
continue
}
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "StepAdjustments", i), err.(request.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// SetAdjustmentType sets the AdjustmentType field's value.
func (s *StepScalingPolicyConfiguration) SetAdjustmentType(v string) *StepScalingPolicyConfiguration {
s.AdjustmentType = &v
return s
}
// SetCooldown sets the Cooldown field's value.
func (s *StepScalingPolicyConfiguration) SetCooldown(v int64) *StepScalingPolicyConfiguration {
s.Cooldown = &v
return s
}
// SetMetricAggregationType sets the MetricAggregationType field's value.
func (s *StepScalingPolicyConfiguration) SetMetricAggregationType(v string) *StepScalingPolicyConfiguration {
s.MetricAggregationType = &v
return s
}
// SetMinAdjustmentMagnitude sets the MinAdjustmentMagnitude field's value.
func (s *StepScalingPolicyConfiguration) SetMinAdjustmentMagnitude(v int64) *StepScalingPolicyConfiguration {
s.MinAdjustmentMagnitude = &v
return s
}
// SetStepAdjustments sets the StepAdjustments field's value.
func (s *StepScalingPolicyConfiguration) SetStepAdjustments(v []*StepAdjustment) *StepScalingPolicyConfiguration {
s.StepAdjustments = v
return s
}
const (
// AdjustmentTypeChangeInCapacity is a AdjustmentType enum value
AdjustmentTypeChangeInCapacity = "ChangeInCapacity"
// AdjustmentTypePercentChangeInCapacity is a AdjustmentType enum value
AdjustmentTypePercentChangeInCapacity = "PercentChangeInCapacity"
// AdjustmentTypeExactCapacity is a AdjustmentType enum value
AdjustmentTypeExactCapacity = "ExactCapacity"
)
const (
// MetricAggregationTypeAverage is a MetricAggregationType enum value
MetricAggregationTypeAverage = "Average"
// MetricAggregationTypeMinimum is a MetricAggregationType enum value
MetricAggregationTypeMinimum = "Minimum"
// MetricAggregationTypeMaximum is a MetricAggregationType enum value
MetricAggregationTypeMaximum = "Maximum"
)
const (
// PolicyTypeStepScaling is a PolicyType enum value
PolicyTypeStepScaling = "StepScaling"
)
const (
// ScalableDimensionEcsServiceDesiredCount is a ScalableDimension enum value
ScalableDimensionEcsServiceDesiredCount = "ecs:service:DesiredCount"
// ScalableDimensionEc2SpotFleetRequestTargetCapacity is a ScalableDimension enum value
ScalableDimensionEc2SpotFleetRequestTargetCapacity = "ec2:spot-fleet-request:TargetCapacity"
// ScalableDimensionElasticmapreduceInstancegroupInstanceCount is a ScalableDimension enum value
ScalableDimensionElasticmapreduceInstancegroupInstanceCount = "elasticmapreduce:instancegroup:InstanceCount"
)
const (
// ScalingActivityStatusCodePending is a ScalingActivityStatusCode enum value
ScalingActivityStatusCodePending = "Pending"
// ScalingActivityStatusCodeInProgress is a ScalingActivityStatusCode enum value
ScalingActivityStatusCodeInProgress = "InProgress"
// ScalingActivityStatusCodeSuccessful is a ScalingActivityStatusCode enum value
ScalingActivityStatusCodeSuccessful = "Successful"
// ScalingActivityStatusCodeOverridden is a ScalingActivityStatusCode enum value
ScalingActivityStatusCodeOverridden = "Overridden"
// ScalingActivityStatusCodeUnfulfilled is a ScalingActivityStatusCode enum value
ScalingActivityStatusCodeUnfulfilled = "Unfulfilled"
// ScalingActivityStatusCodeFailed is a ScalingActivityStatusCode enum value
ScalingActivityStatusCodeFailed = "Failed"
)
const (
// ServiceNamespaceEcs is a ServiceNamespace enum value
ServiceNamespaceEcs = "ecs"
// ServiceNamespaceElasticmapreduce is a ServiceNamespace enum value
ServiceNamespaceElasticmapreduce = "elasticmapreduce"
// ServiceNamespaceEc2 is a ServiceNamespace enum value
ServiceNamespaceEc2 = "ec2"
)
Reference in New Issue View Git Blame Copy Permalink