autoscalingplans

package
v1.14.24 Latest Latest
Warning

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

 Go to latest Published: Jul 10, 2018 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

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

Use AWS Auto Scaling to quickly discover all the scalable AWS resources for your application and configure dynamic scaling for your scalable resources.

To get started, create a scaling plan with a set of instructions used to configure dynamic scaling for the scalable resources in your application. AWS Auto Scaling creates target tracking scaling policies for the scalable resources in your scaling plan. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.

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

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

Using the Client

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

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

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

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

Index

Constants

View Source 
const (
	// MetricStatisticAverage is a MetricStatistic enum value
	MetricStatisticAverage = "Average"

	// MetricStatisticMinimum is a MetricStatistic enum value
	MetricStatisticMinimum = "Minimum"

	// MetricStatisticMaximum is a MetricStatistic enum value
	MetricStatisticMaximum = "Maximum"

	// MetricStatisticSampleCount is a MetricStatistic enum value
	MetricStatisticSampleCount = "SampleCount"

	// MetricStatisticSum is a MetricStatistic enum value
	MetricStatisticSum = "Sum"
)
View Source 
const (
	// ScalableDimensionAutoscalingAutoScalingGroupDesiredCapacity is a ScalableDimension enum value
	ScalableDimensionAutoscalingAutoScalingGroupDesiredCapacity = "autoscaling:autoScalingGroup:DesiredCapacity"

	// ScalableDimensionEcsServiceDesiredCount is a ScalableDimension enum value
	ScalableDimensionEcsServiceDesiredCount = "ecs:service:DesiredCount"

	// ScalableDimensionEc2SpotFleetRequestTargetCapacity is a ScalableDimension enum value
	ScalableDimensionEc2SpotFleetRequestTargetCapacity = "ec2:spot-fleet-request:TargetCapacity"

	// ScalableDimensionRdsClusterReadReplicaCount is a ScalableDimension enum value
	ScalableDimensionRdsClusterReadReplicaCount = "rds:cluster:ReadReplicaCount"

	// ScalableDimensionDynamodbTableReadCapacityUnits is a ScalableDimension enum value
	ScalableDimensionDynamodbTableReadCapacityUnits = "dynamodb:table:ReadCapacityUnits"

	// ScalableDimensionDynamodbTableWriteCapacityUnits is a ScalableDimension enum value
	ScalableDimensionDynamodbTableWriteCapacityUnits = "dynamodb:table:WriteCapacityUnits"

	// ScalableDimensionDynamodbIndexReadCapacityUnits is a ScalableDimension enum value
	ScalableDimensionDynamodbIndexReadCapacityUnits = "dynamodb:index:ReadCapacityUnits"

	// ScalableDimensionDynamodbIndexWriteCapacityUnits is a ScalableDimension enum value
	ScalableDimensionDynamodbIndexWriteCapacityUnits = "dynamodb:index:WriteCapacityUnits"
)
View Source 
const (
	// ScalingMetricTypeAsgaverageCpuutilization is a ScalingMetricType enum value
	ScalingMetricTypeAsgaverageCpuutilization = "ASGAverageCPUUtilization"

	// ScalingMetricTypeAsgaverageNetworkIn is a ScalingMetricType enum value
	ScalingMetricTypeAsgaverageNetworkIn = "ASGAverageNetworkIn"

	// ScalingMetricTypeAsgaverageNetworkOut is a ScalingMetricType enum value
	ScalingMetricTypeAsgaverageNetworkOut = "ASGAverageNetworkOut"

	// ScalingMetricTypeDynamoDbreadCapacityUtilization is a ScalingMetricType enum value
	ScalingMetricTypeDynamoDbreadCapacityUtilization = "DynamoDBReadCapacityUtilization"

	// ScalingMetricTypeDynamoDbwriteCapacityUtilization is a ScalingMetricType enum value
	ScalingMetricTypeDynamoDbwriteCapacityUtilization = "DynamoDBWriteCapacityUtilization"

	// ScalingMetricTypeEcsserviceAverageCpuutilization is a ScalingMetricType enum value
	ScalingMetricTypeEcsserviceAverageCpuutilization = "ECSServiceAverageCPUUtilization"

	// ScalingMetricTypeEcsserviceAverageMemoryUtilization is a ScalingMetricType enum value
	ScalingMetricTypeEcsserviceAverageMemoryUtilization = "ECSServiceAverageMemoryUtilization"

	// ScalingMetricTypeAlbrequestCountPerTarget is a ScalingMetricType enum value
	ScalingMetricTypeAlbrequestCountPerTarget = "ALBRequestCountPerTarget"

	// ScalingMetricTypeRdsreaderAverageCpuutilization is a ScalingMetricType enum value
	ScalingMetricTypeRdsreaderAverageCpuutilization = "RDSReaderAverageCPUUtilization"

	// ScalingMetricTypeRdsreaderAverageDatabaseConnections is a ScalingMetricType enum value
	ScalingMetricTypeRdsreaderAverageDatabaseConnections = "RDSReaderAverageDatabaseConnections"

	// ScalingMetricTypeEc2spotFleetRequestAverageCpuutilization is a ScalingMetricType enum value
	ScalingMetricTypeEc2spotFleetRequestAverageCpuutilization = "EC2SpotFleetRequestAverageCPUUtilization"

	// ScalingMetricTypeEc2spotFleetRequestAverageNetworkIn is a ScalingMetricType enum value
	ScalingMetricTypeEc2spotFleetRequestAverageNetworkIn = "EC2SpotFleetRequestAverageNetworkIn"

	// ScalingMetricTypeEc2spotFleetRequestAverageNetworkOut is a ScalingMetricType enum value
	ScalingMetricTypeEc2spotFleetRequestAverageNetworkOut = "EC2SpotFleetRequestAverageNetworkOut"
)
View Source 
const (
	// ScalingPlanStatusCodeActive is a ScalingPlanStatusCode enum value
	ScalingPlanStatusCodeActive = "Active"

	// ScalingPlanStatusCodeActiveWithProblems is a ScalingPlanStatusCode enum value
	ScalingPlanStatusCodeActiveWithProblems = "ActiveWithProblems"

	// ScalingPlanStatusCodeCreationInProgress is a ScalingPlanStatusCode enum value
	ScalingPlanStatusCodeCreationInProgress = "CreationInProgress"

	// ScalingPlanStatusCodeCreationFailed is a ScalingPlanStatusCode enum value
	ScalingPlanStatusCodeCreationFailed = "CreationFailed"

	// ScalingPlanStatusCodeDeletionInProgress is a ScalingPlanStatusCode enum value
	ScalingPlanStatusCodeDeletionInProgress = "DeletionInProgress"

	// ScalingPlanStatusCodeDeletionFailed is a ScalingPlanStatusCode enum value
	ScalingPlanStatusCodeDeletionFailed = "DeletionFailed"

	// ScalingPlanStatusCodeUpdateInProgress is a ScalingPlanStatusCode enum value
	ScalingPlanStatusCodeUpdateInProgress = "UpdateInProgress"

	// ScalingPlanStatusCodeUpdateFailed is a ScalingPlanStatusCode enum value
	ScalingPlanStatusCodeUpdateFailed = "UpdateFailed"
)
View Source 
const (
	// ScalingStatusCodeInactive is a ScalingStatusCode enum value
	ScalingStatusCodeInactive = "Inactive"

	// ScalingStatusCodePartiallyActive is a ScalingStatusCode enum value
	ScalingStatusCodePartiallyActive = "PartiallyActive"

	// ScalingStatusCodeActive is a ScalingStatusCode enum value
	ScalingStatusCodeActive = "Active"
)
View Source 
const (
	// ServiceNamespaceAutoscaling is a ServiceNamespace enum value
	ServiceNamespaceAutoscaling = "autoscaling"

	// ServiceNamespaceEcs is a ServiceNamespace enum value
	ServiceNamespaceEcs = "ecs"

	// ServiceNamespaceEc2 is a ServiceNamespace enum value
	ServiceNamespaceEc2 = "ec2"

	// ServiceNamespaceRds is a ServiceNamespace enum value
	ServiceNamespaceRds = "rds"

	// ServiceNamespaceDynamodb is a ServiceNamespace enum value
	ServiceNamespaceDynamodb = "dynamodb"
)
View Source 
const (

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

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

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

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

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

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// An exception was thrown for a validation issue. Review the parameters provided.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "autoscaling"        // Name of service.
	EndpointsID = ServiceName          // ID to lookup a service endpoint with.
	ServiceID   = "Auto Scaling Plans" // ServiceID is a unique identifer of a specific service.
)

Service information constants

View Source 
const (
	// PolicyTypeTargetTrackingScaling is a PolicyType enum value
	PolicyTypeTargetTrackingScaling = "TargetTrackingScaling"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ApplicationSource 

type ApplicationSource struct {

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

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

Represents an application source.

func (ApplicationSource) GoString 

func (s ApplicationSource) GoString() string

GoString returns the string representation

func (*ApplicationSource) SetCloudFormationStackARN 

func (s *ApplicationSource) SetCloudFormationStackARN(v string) *ApplicationSource

SetCloudFormationStackARN sets the CloudFormationStackARN field's value.

func (*ApplicationSource) SetTagFilters added in v1.13.35 

func (s *ApplicationSource) SetTagFilters(v []*TagFilter) *ApplicationSource

SetTagFilters sets the TagFilters field's value.

func (ApplicationSource) String 

func (s ApplicationSource) String() string

String returns the string representation

func (*ApplicationSource) Validate added in v1.13.35 

func (s *ApplicationSource) Validate() error

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

type AutoScalingPlans 

type AutoScalingPlans struct {
	*client.Client
}

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

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *AutoScalingPlans

New creates a new instance of the AutoScalingPlans 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 AutoScalingPlans client from just a session.
svc := autoscalingplans.New(mySession)

// Create a AutoScalingPlans client with additional configuration
svc := autoscalingplans.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*AutoScalingPlans) CreateScalingPlan 

func (c *AutoScalingPlans) CreateScalingPlan(input *CreateScalingPlanInput) (*CreateScalingPlanOutput, error)

CreateScalingPlan API operation for AWS Auto Scaling Plans.

Creates a scaling plan.

A scaling plan contains a set of instructions used to configure dynamic scaling for the scalable resources in your application. AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions in your scaling plan.

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 AWS Auto Scaling Plans's API operation CreateScalingPlan for usage and error information.

Returned Error Codes:

  • ErrCodeValidationException "ValidationException" An exception was thrown for a validation issue. Review the parameters provided.

  • ErrCodeLimitExceededException "LimitExceededException" Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded.

  • ErrCodeConcurrentUpdateException "ConcurrentUpdateException" Concurrent updates caused an exception, for example, if you request an update to a scaling plan that already has a pending update.

  • ErrCodeInternalServiceException "InternalServiceException" The service encountered an internal error.

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

func (*AutoScalingPlans) CreateScalingPlanRequest 

func (c *AutoScalingPlans) CreateScalingPlanRequest(input *CreateScalingPlanInput) (req *request.Request, output *CreateScalingPlanOutput)

CreateScalingPlanRequest generates a "aws/request.Request" representing the client's request for the CreateScalingPlan operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateScalingPlan for more information on using the CreateScalingPlan API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateScalingPlanRequest method.
req, resp := client.CreateScalingPlanRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*AutoScalingPlans) CreateScalingPlanWithContext 

func (c *AutoScalingPlans) CreateScalingPlanWithContext(ctx aws.Context, input *CreateScalingPlanInput, opts ...request.Option) (*CreateScalingPlanOutput, error)

CreateScalingPlanWithContext is the same as CreateScalingPlan with the addition of the ability to pass a context and additional request options.

See CreateScalingPlan for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScalingPlans) DeleteScalingPlan 

func (c *AutoScalingPlans) DeleteScalingPlan(input *DeleteScalingPlanInput) (*DeleteScalingPlanOutput, error)

DeleteScalingPlan API operation for AWS Auto Scaling Plans.

Deletes the specified scaling plan.

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 AWS Auto Scaling Plans's API operation DeleteScalingPlan for usage and error information.

Returned Error Codes:

  • ErrCodeValidationException "ValidationException" An exception was thrown for a validation issue. Review the parameters provided.

  • ErrCodeObjectNotFoundException "ObjectNotFoundException" The specified object could not be found.

  • ErrCodeConcurrentUpdateException "ConcurrentUpdateException" Concurrent updates caused an exception, for example, if you request an update to a scaling plan that already has a pending update.

  • ErrCodeInternalServiceException "InternalServiceException" The service encountered an internal error.

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

func (*AutoScalingPlans) DeleteScalingPlanRequest 

func (c *AutoScalingPlans) DeleteScalingPlanRequest(input *DeleteScalingPlanInput) (req *request.Request, output *DeleteScalingPlanOutput)

DeleteScalingPlanRequest generates a "aws/request.Request" representing the client's request for the DeleteScalingPlan operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteScalingPlan for more information on using the DeleteScalingPlan API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteScalingPlanRequest method.
req, resp := client.DeleteScalingPlanRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*AutoScalingPlans) DeleteScalingPlanWithContext 

func (c *AutoScalingPlans) DeleteScalingPlanWithContext(ctx aws.Context, input *DeleteScalingPlanInput, opts ...request.Option) (*DeleteScalingPlanOutput, error)

DeleteScalingPlanWithContext is the same as DeleteScalingPlan with the addition of the ability to pass a context and additional request options.

See DeleteScalingPlan for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScalingPlans) DescribeScalingPlanResources 

func (c *AutoScalingPlans) DescribeScalingPlanResources(input *DescribeScalingPlanResourcesInput) (*DescribeScalingPlanResourcesOutput, error)

DescribeScalingPlanResources API operation for AWS Auto Scaling Plans.

Describes the scalable resources in the specified scaling plan.

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 AWS Auto Scaling Plans's API operation DescribeScalingPlanResources for usage and error information.

Returned Error Codes:

  • ErrCodeValidationException "ValidationException" An exception was thrown for a validation issue. Review the parameters provided.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The token provided is not valid.

  • ErrCodeConcurrentUpdateException "ConcurrentUpdateException" Concurrent updates caused an exception, for example, if you request an update to a scaling plan that already has a pending update.

  • ErrCodeInternalServiceException "InternalServiceException" The service encountered an internal error.

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

func (*AutoScalingPlans) DescribeScalingPlanResourcesRequest 

func (c *AutoScalingPlans) DescribeScalingPlanResourcesRequest(input *DescribeScalingPlanResourcesInput) (req *request.Request, output *DescribeScalingPlanResourcesOutput)

DescribeScalingPlanResourcesRequest generates a "aws/request.Request" representing the client's request for the DescribeScalingPlanResources operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeScalingPlanResources for more information on using the DescribeScalingPlanResources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeScalingPlanResourcesRequest method.
req, resp := client.DescribeScalingPlanResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*AutoScalingPlans) DescribeScalingPlanResourcesWithContext 

func (c *AutoScalingPlans) DescribeScalingPlanResourcesWithContext(ctx aws.Context, input *DescribeScalingPlanResourcesInput, opts ...request.Option) (*DescribeScalingPlanResourcesOutput, error)

DescribeScalingPlanResourcesWithContext is the same as DescribeScalingPlanResources with the addition of the ability to pass a context and additional request options.

See DescribeScalingPlanResources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScalingPlans) DescribeScalingPlans 

func (c *AutoScalingPlans) DescribeScalingPlans(input *DescribeScalingPlansInput) (*DescribeScalingPlansOutput, error)

DescribeScalingPlans API operation for AWS Auto Scaling Plans.

Describes the specified scaling plans or all of your scaling plans.

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 AWS Auto Scaling Plans's API operation DescribeScalingPlans for usage and error information.

Returned Error Codes:

  • ErrCodeValidationException "ValidationException" An exception was thrown for a validation issue. Review the parameters provided.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The token provided is not valid.

  • ErrCodeConcurrentUpdateException "ConcurrentUpdateException" Concurrent updates caused an exception, for example, if you request an update to a scaling plan that already has a pending update.

  • ErrCodeInternalServiceException "InternalServiceException" The service encountered an internal error.

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

func (*AutoScalingPlans) DescribeScalingPlansRequest 

func (c *AutoScalingPlans) DescribeScalingPlansRequest(input *DescribeScalingPlansInput) (req *request.Request, output *DescribeScalingPlansOutput)

DescribeScalingPlansRequest generates a "aws/request.Request" representing the client's request for the DescribeScalingPlans operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeScalingPlans for more information on using the DescribeScalingPlans API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeScalingPlansRequest method.
req, resp := client.DescribeScalingPlansRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*AutoScalingPlans) DescribeScalingPlansWithContext 

func (c *AutoScalingPlans) DescribeScalingPlansWithContext(ctx aws.Context, input *DescribeScalingPlansInput, opts ...request.Option) (*DescribeScalingPlansOutput, error)

DescribeScalingPlansWithContext is the same as DescribeScalingPlans with the addition of the ability to pass a context and additional request options.

See DescribeScalingPlans for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*AutoScalingPlans) UpdateScalingPlan added in v1.13.35 

func (c *AutoScalingPlans) UpdateScalingPlan(input *UpdateScalingPlanInput) (*UpdateScalingPlanOutput, error)

UpdateScalingPlan API operation for AWS Auto Scaling Plans.

Updates the scaling plan for the specified scaling plan.

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

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 AWS Auto Scaling Plans's API operation UpdateScalingPlan for usage and error information.

Returned Error Codes:

  • ErrCodeValidationException "ValidationException" An exception was thrown for a validation issue. Review the parameters provided.

  • ErrCodeConcurrentUpdateException "ConcurrentUpdateException" Concurrent updates caused an exception, for example, if you request an update to a scaling plan that already has a pending update.

  • ErrCodeInternalServiceException "InternalServiceException" The service encountered an internal error.

  • ErrCodeObjectNotFoundException "ObjectNotFoundException" The specified object could not be found.

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

func (*AutoScalingPlans) UpdateScalingPlanRequest added in v1.13.35 

func (c *AutoScalingPlans) UpdateScalingPlanRequest(input *UpdateScalingPlanInput) (req *request.Request, output *UpdateScalingPlanOutput)

UpdateScalingPlanRequest generates a "aws/request.Request" representing the client's request for the UpdateScalingPlan operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateScalingPlan for more information on using the UpdateScalingPlan API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateScalingPlanRequest method.
req, resp := client.UpdateScalingPlanRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*AutoScalingPlans) UpdateScalingPlanWithContext added in v1.13.35 

func (c *AutoScalingPlans) UpdateScalingPlanWithContext(ctx aws.Context, input *UpdateScalingPlanInput, opts ...request.Option) (*UpdateScalingPlanOutput, error)

UpdateScalingPlanWithContext is the same as UpdateScalingPlan with the addition of the ability to pass a context and additional request options.

See UpdateScalingPlan for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type CreateScalingPlanInput 

type CreateScalingPlanInput struct {

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

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

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

func (CreateScalingPlanInput) GoString 

func (s CreateScalingPlanInput) GoString() string

GoString returns the string representation

func (*CreateScalingPlanInput) SetApplicationSource 

func (s *CreateScalingPlanInput) SetApplicationSource(v *ApplicationSource) *CreateScalingPlanInput

SetApplicationSource sets the ApplicationSource field's value.

func (*CreateScalingPlanInput) SetScalingInstructions 

func (s *CreateScalingPlanInput) SetScalingInstructions(v []*ScalingInstruction) *CreateScalingPlanInput

SetScalingInstructions sets the ScalingInstructions field's value.

func (*CreateScalingPlanInput) SetScalingPlanName 

func (s *CreateScalingPlanInput) SetScalingPlanName(v string) *CreateScalingPlanInput

SetScalingPlanName sets the ScalingPlanName field's value.

func (CreateScalingPlanInput) String 

func (s CreateScalingPlanInput) String() string

String returns the string representation

func (*CreateScalingPlanInput) Validate 

func (s *CreateScalingPlanInput) Validate() error

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

type CreateScalingPlanOutput 

type CreateScalingPlanOutput struct {

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

func (CreateScalingPlanOutput) GoString 

func (s CreateScalingPlanOutput) GoString() string

GoString returns the string representation

func (*CreateScalingPlanOutput) SetScalingPlanVersion 

func (s *CreateScalingPlanOutput) SetScalingPlanVersion(v int64) *CreateScalingPlanOutput

SetScalingPlanVersion sets the ScalingPlanVersion field's value.

func (CreateScalingPlanOutput) String 

func (s CreateScalingPlanOutput) String() string

String returns the string representation

type CustomizedScalingMetricSpecification 

type CustomizedScalingMetricSpecification struct {

	// The dimensions of the metric.
	Dimensions []*MetricDimension `type:"list"`

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

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

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

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

Represents a customized metric for a target tracking policy.

func (CustomizedScalingMetricSpecification) GoString 

func (s CustomizedScalingMetricSpecification) GoString() string

GoString returns the string representation

func (*CustomizedScalingMetricSpecification) SetDimensions 

func (s *CustomizedScalingMetricSpecification) SetDimensions(v []*MetricDimension) *CustomizedScalingMetricSpecification

SetDimensions sets the Dimensions field's value.

func (*CustomizedScalingMetricSpecification) SetMetricName 

func (s *CustomizedScalingMetricSpecification) SetMetricName(v string) *CustomizedScalingMetricSpecification

SetMetricName sets the MetricName field's value.

func (*CustomizedScalingMetricSpecification) SetNamespace 

func (s *CustomizedScalingMetricSpecification) SetNamespace(v string) *CustomizedScalingMetricSpecification

SetNamespace sets the Namespace field's value.

func (*CustomizedScalingMetricSpecification) SetStatistic 

func (s *CustomizedScalingMetricSpecification) SetStatistic(v string) *CustomizedScalingMetricSpecification

SetStatistic sets the Statistic field's value.

func (*CustomizedScalingMetricSpecification) SetUnit 

func (s *CustomizedScalingMetricSpecification) SetUnit(v string) *CustomizedScalingMetricSpecification

SetUnit sets the Unit field's value.

func (CustomizedScalingMetricSpecification) String 

func (s CustomizedScalingMetricSpecification) String() string

String returns the string representation

func (*CustomizedScalingMetricSpecification) Validate 

func (s *CustomizedScalingMetricSpecification) Validate() error

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

type DeleteScalingPlanInput 

type DeleteScalingPlanInput struct {

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

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

func (DeleteScalingPlanInput) GoString 

func (s DeleteScalingPlanInput) GoString() string

GoString returns the string representation

func (*DeleteScalingPlanInput) SetScalingPlanName 

func (s *DeleteScalingPlanInput) SetScalingPlanName(v string) *DeleteScalingPlanInput

SetScalingPlanName sets the ScalingPlanName field's value.

func (*DeleteScalingPlanInput) SetScalingPlanVersion 

func (s *DeleteScalingPlanInput) SetScalingPlanVersion(v int64) *DeleteScalingPlanInput

SetScalingPlanVersion sets the ScalingPlanVersion field's value.

func (DeleteScalingPlanInput) String 

func (s DeleteScalingPlanInput) String() string

String returns the string representation

func (*DeleteScalingPlanInput) Validate 

func (s *DeleteScalingPlanInput) Validate() error

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

type DeleteScalingPlanOutput 

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

func (DeleteScalingPlanOutput) GoString 

func (s DeleteScalingPlanOutput) GoString() string

GoString returns the string representation

func (DeleteScalingPlanOutput) String 

func (s DeleteScalingPlanOutput) String() string

String returns the string representation

type DescribeScalingPlanResourcesInput 

type DescribeScalingPlanResourcesInput struct {

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

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

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

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

func (DescribeScalingPlanResourcesInput) GoString 

func (s DescribeScalingPlanResourcesInput) GoString() string

GoString returns the string representation

func (*DescribeScalingPlanResourcesInput) SetMaxResults 

func (s *DescribeScalingPlanResourcesInput) SetMaxResults(v int64) *DescribeScalingPlanResourcesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeScalingPlanResourcesInput) SetNextToken 

func (s *DescribeScalingPlanResourcesInput) SetNextToken(v string) *DescribeScalingPlanResourcesInput

SetNextToken sets the NextToken field's value.

func (*DescribeScalingPlanResourcesInput) SetScalingPlanName 

func (s *DescribeScalingPlanResourcesInput) SetScalingPlanName(v string) *DescribeScalingPlanResourcesInput

SetScalingPlanName sets the ScalingPlanName field's value.

func (*DescribeScalingPlanResourcesInput) SetScalingPlanVersion 

func (s *DescribeScalingPlanResourcesInput) SetScalingPlanVersion(v int64) *DescribeScalingPlanResourcesInput

SetScalingPlanVersion sets the ScalingPlanVersion field's value.

func (DescribeScalingPlanResourcesInput) String 

func (s DescribeScalingPlanResourcesInput) String() string

String returns the string representation

func (*DescribeScalingPlanResourcesInput) Validate 

func (s *DescribeScalingPlanResourcesInput) Validate() error

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

type DescribeScalingPlanResourcesOutput 

type DescribeScalingPlanResourcesOutput struct {

	// The token required to get the next set of results. This value is null if
	// there are no more results to return.
	NextToken *string `type:"string"`

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

func (DescribeScalingPlanResourcesOutput) GoString 

func (s DescribeScalingPlanResourcesOutput) GoString() string

GoString returns the string representation

func (*DescribeScalingPlanResourcesOutput) SetNextToken 

func (s *DescribeScalingPlanResourcesOutput) SetNextToken(v string) *DescribeScalingPlanResourcesOutput

SetNextToken sets the NextToken field's value.

func (*DescribeScalingPlanResourcesOutput) SetScalingPlanResources 

func (s *DescribeScalingPlanResourcesOutput) SetScalingPlanResources(v []*ScalingPlanResource) *DescribeScalingPlanResourcesOutput

SetScalingPlanResources sets the ScalingPlanResources field's value.

func (DescribeScalingPlanResourcesOutput) String 

func (s DescribeScalingPlanResourcesOutput) String() string

String returns the string representation

type DescribeScalingPlansInput 

type DescribeScalingPlansInput struct {

	// The sources for the applications (up to 10). If you specify scaling plan
	// names, you cannot specify application sources.
	ApplicationSources []*ApplicationSource `type:"list"`

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

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

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

	// The version of the scaling plan. If you specify a scaling plan version, you
	// must also specify a scaling plan name.
	ScalingPlanVersion *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (DescribeScalingPlansInput) GoString 

func (s DescribeScalingPlansInput) GoString() string

GoString returns the string representation

func (*DescribeScalingPlansInput) SetApplicationSources 

func (s *DescribeScalingPlansInput) SetApplicationSources(v []*ApplicationSource) *DescribeScalingPlansInput

SetApplicationSources sets the ApplicationSources field's value.

func (*DescribeScalingPlansInput) SetMaxResults 

func (s *DescribeScalingPlansInput) SetMaxResults(v int64) *DescribeScalingPlansInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeScalingPlansInput) SetNextToken 

func (s *DescribeScalingPlansInput) SetNextToken(v string) *DescribeScalingPlansInput

SetNextToken sets the NextToken field's value.

func (*DescribeScalingPlansInput) SetScalingPlanNames 

func (s *DescribeScalingPlansInput) SetScalingPlanNames(v []*string) *DescribeScalingPlansInput

SetScalingPlanNames sets the ScalingPlanNames field's value.

func (*DescribeScalingPlansInput) SetScalingPlanVersion 

func (s *DescribeScalingPlansInput) SetScalingPlanVersion(v int64) *DescribeScalingPlansInput

SetScalingPlanVersion sets the ScalingPlanVersion field's value.

func (DescribeScalingPlansInput) String 

func (s DescribeScalingPlansInput) String() string

String returns the string representation

func (*DescribeScalingPlansInput) Validate added in v1.13.35 

func (s *DescribeScalingPlansInput) Validate() error

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

type DescribeScalingPlansOutput 

type DescribeScalingPlansOutput struct {

	// The token required to get the next set of results. This value is null if
	// there are no more results to return.
	NextToken *string `type:"string"`

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

func (DescribeScalingPlansOutput) GoString 

func (s DescribeScalingPlansOutput) GoString() string

GoString returns the string representation

func (*DescribeScalingPlansOutput) SetNextToken 

func (s *DescribeScalingPlansOutput) SetNextToken(v string) *DescribeScalingPlansOutput

SetNextToken sets the NextToken field's value.

func (*DescribeScalingPlansOutput) SetScalingPlans 

func (s *DescribeScalingPlansOutput) SetScalingPlans(v []*ScalingPlan) *DescribeScalingPlansOutput

SetScalingPlans sets the ScalingPlans field's value.

func (DescribeScalingPlansOutput) String 

func (s DescribeScalingPlansOutput) String() string

String returns the string representation

type MetricDimension 

type MetricDimension struct {

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

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

Represents a dimension for a customized metric.

func (MetricDimension) GoString 

func (s MetricDimension) GoString() string

GoString returns the string representation

func (*MetricDimension) SetName 

func (s *MetricDimension) SetName(v string) *MetricDimension

SetName sets the Name field's value.

func (*MetricDimension) SetValue 

func (s *MetricDimension) SetValue(v string) *MetricDimension

SetValue sets the Value field's value.

func (MetricDimension) String 

func (s MetricDimension) String() string

String returns the string representation

func (*MetricDimension) Validate 

func (s *MetricDimension) Validate() error

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

type PredefinedScalingMetricSpecification 

type PredefinedScalingMetricSpecification struct {

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

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

Represents a predefined metric for a target tracking policy.

func (PredefinedScalingMetricSpecification) GoString 

func (s PredefinedScalingMetricSpecification) GoString() string

GoString returns the string representation

func (*PredefinedScalingMetricSpecification) SetPredefinedScalingMetricType 

func (s *PredefinedScalingMetricSpecification) SetPredefinedScalingMetricType(v string) *PredefinedScalingMetricSpecification

SetPredefinedScalingMetricType sets the PredefinedScalingMetricType field's value.

func (*PredefinedScalingMetricSpecification) SetResourceLabel 

func (s *PredefinedScalingMetricSpecification) SetResourceLabel(v string) *PredefinedScalingMetricSpecification

SetResourceLabel sets the ResourceLabel field's value.

func (PredefinedScalingMetricSpecification) String 

func (s PredefinedScalingMetricSpecification) String() string

String returns the string representation

func (*PredefinedScalingMetricSpecification) Validate 

func (s *PredefinedScalingMetricSpecification) Validate() error

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

type ScalingInstruction 

type ScalingInstruction struct {

	// 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 ID of the resource. This string consists of the resource type and unique
	// identifier.
	//
	//    * Auto Scaling group - The resource type is autoScalingGroup and the unique
	//    identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.
	//
	//    * ECS service - The resource type is service and the unique identifier
	//    is the cluster name and service name. Example: service/default/sample-webapp.
	//
	//    * Spot fleet request - The resource type is spot-fleet-request and the
	//    unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
	//
	//    * DynamoDB table - The resource type is table and the unique identifier
	//    is the resource ID. Example: table/my-table.
	//
	//    * DynamoDB global secondary index - The resource type is index and the
	//    unique identifier is the resource ID. Example: table/my-table/index/my-table-index.
	//
	//    * Aurora DB cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:my-db-cluster.
	//
	// ResourceId is a required field
	ResourceId *string `min:"1" type:"string" required:"true"`

	// The scalable dimension associated with the resource.
	//
	//    * autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity
	//    of an Auto Scaling group.
	//
	//    * ecs:service:DesiredCount - The desired task count of an ECS service.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    fleet request.
	//
	//    * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB global secondary index.
	//
	//    * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB global secondary index.
	//
	//    * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora
	//    DB cluster. Available for Aurora MySQL-compatible edition.
	//
	// ScalableDimension is a required field
	ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`

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

	// The target tracking scaling policies (up to 10).
	//
	// TargetTrackingConfigurations is a required field
	TargetTrackingConfigurations []*TargetTrackingConfiguration `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Specifies the scaling configuration for a scalable resource.

func (ScalingInstruction) GoString 

func (s ScalingInstruction) GoString() string

GoString returns the string representation

func (*ScalingInstruction) SetMaxCapacity 

func (s *ScalingInstruction) SetMaxCapacity(v int64) *ScalingInstruction

SetMaxCapacity sets the MaxCapacity field's value.

func (*ScalingInstruction) SetMinCapacity 

func (s *ScalingInstruction) SetMinCapacity(v int64) *ScalingInstruction

SetMinCapacity sets the MinCapacity field's value.

func (*ScalingInstruction) SetResourceId 

func (s *ScalingInstruction) SetResourceId(v string) *ScalingInstruction

SetResourceId sets the ResourceId field's value.

func (*ScalingInstruction) SetScalableDimension 

func (s *ScalingInstruction) SetScalableDimension(v string) *ScalingInstruction

SetScalableDimension sets the ScalableDimension field's value.

func (*ScalingInstruction) SetServiceNamespace 

func (s *ScalingInstruction) SetServiceNamespace(v string) *ScalingInstruction

SetServiceNamespace sets the ServiceNamespace field's value.

func (*ScalingInstruction) SetTargetTrackingConfigurations 

func (s *ScalingInstruction) SetTargetTrackingConfigurations(v []*TargetTrackingConfiguration) *ScalingInstruction

SetTargetTrackingConfigurations sets the TargetTrackingConfigurations field's value.

func (ScalingInstruction) String 

func (s ScalingInstruction) String() string

String returns the string representation

func (*ScalingInstruction) Validate 

func (s *ScalingInstruction) Validate() error

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

type ScalingPlan 

type ScalingPlan struct {

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

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

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

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

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

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

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

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

Represents a scaling plan.

func (ScalingPlan) GoString 

func (s ScalingPlan) GoString() string

GoString returns the string representation

func (*ScalingPlan) SetApplicationSource 

func (s *ScalingPlan) SetApplicationSource(v *ApplicationSource) *ScalingPlan

SetApplicationSource sets the ApplicationSource field's value.

func (*ScalingPlan) SetCreationTime 

func (s *ScalingPlan) SetCreationTime(v time.Time) *ScalingPlan

SetCreationTime sets the CreationTime field's value.

func (*ScalingPlan) SetScalingInstructions 

func (s *ScalingPlan) SetScalingInstructions(v []*ScalingInstruction) *ScalingPlan

SetScalingInstructions sets the ScalingInstructions field's value.

func (*ScalingPlan) SetScalingPlanName 

func (s *ScalingPlan) SetScalingPlanName(v string) *ScalingPlan

SetScalingPlanName sets the ScalingPlanName field's value.

func (*ScalingPlan) SetScalingPlanVersion 

func (s *ScalingPlan) SetScalingPlanVersion(v int64) *ScalingPlan

SetScalingPlanVersion sets the ScalingPlanVersion field's value.

func (*ScalingPlan) SetStatusCode 

func (s *ScalingPlan) SetStatusCode(v string) *ScalingPlan

SetStatusCode sets the StatusCode field's value.

func (*ScalingPlan) SetStatusMessage 

func (s *ScalingPlan) SetStatusMessage(v string) *ScalingPlan

SetStatusMessage sets the StatusMessage field's value.

func (*ScalingPlan) SetStatusStartTime added in v1.13.35 

func (s *ScalingPlan) SetStatusStartTime(v time.Time) *ScalingPlan

SetStatusStartTime sets the StatusStartTime field's value.

func (ScalingPlan) String 

func (s ScalingPlan) String() string

String returns the string representation

type ScalingPlanResource 

type ScalingPlanResource struct {

	// The ID of the resource. This string consists of the resource type and unique
	// identifier.
	//
	//    * Auto Scaling group - The resource type is autoScalingGroup and the unique
	//    identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.
	//
	//    * ECS service - The resource type is service and the unique identifier
	//    is the cluster name and service name. Example: service/default/sample-webapp.
	//
	//    * Spot fleet request - The resource type is spot-fleet-request and the
	//    unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
	//
	//    * DynamoDB table - The resource type is table and the unique identifier
	//    is the resource ID. Example: table/my-table.
	//
	//    * DynamoDB global secondary index - The resource type is index and the
	//    unique identifier is the resource ID. Example: table/my-table/index/my-table-index.
	//
	//    * Aurora DB cluster - The resource type is cluster and the unique identifier
	//    is the cluster name. Example: cluster:my-db-cluster.
	//
	// ResourceId is a required field
	ResourceId *string `min:"1" type:"string" required:"true"`

	// The scalable dimension for the resource.
	//
	//    * autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity
	//    of an Auto Scaling group.
	//
	//    * ecs:service:DesiredCount - The desired task count of an ECS service.
	//
	//    * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot
	//    fleet request.
	//
	//    * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB table.
	//
	//    * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for
	//    a DynamoDB global secondary index.
	//
	//    * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for
	//    a DynamoDB global secondary index.
	//
	//    * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora
	//    DB cluster. Available for Aurora MySQL-compatible edition.
	//
	// ScalableDimension is a required field
	ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"`

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

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

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

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

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

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

Represents a scalable resource.

func (ScalingPlanResource) GoString 

func (s ScalingPlanResource) GoString() string

GoString returns the string representation

func (*ScalingPlanResource) SetResourceId 

func (s *ScalingPlanResource) SetResourceId(v string) *ScalingPlanResource

SetResourceId sets the ResourceId field's value.

func (*ScalingPlanResource) SetScalableDimension 

func (s *ScalingPlanResource) SetScalableDimension(v string) *ScalingPlanResource

SetScalableDimension sets the ScalableDimension field's value.

func (*ScalingPlanResource) SetScalingPlanName 

func (s *ScalingPlanResource) SetScalingPlanName(v string) *ScalingPlanResource

SetScalingPlanName sets the ScalingPlanName field's value.

func (*ScalingPlanResource) SetScalingPlanVersion 

func (s *ScalingPlanResource) SetScalingPlanVersion(v int64) *ScalingPlanResource

SetScalingPlanVersion sets the ScalingPlanVersion field's value.

func (*ScalingPlanResource) SetScalingPolicies 

func (s *ScalingPlanResource) SetScalingPolicies(v []*ScalingPolicy) *ScalingPlanResource

SetScalingPolicies sets the ScalingPolicies field's value.

func (*ScalingPlanResource) SetScalingStatusCode 

func (s *ScalingPlanResource) SetScalingStatusCode(v string) *ScalingPlanResource

SetScalingStatusCode sets the ScalingStatusCode field's value.

func (*ScalingPlanResource) SetScalingStatusMessage 

func (s *ScalingPlanResource) SetScalingStatusMessage(v string) *ScalingPlanResource

SetScalingStatusMessage sets the ScalingStatusMessage field's value.

func (*ScalingPlanResource) SetServiceNamespace 

func (s *ScalingPlanResource) SetServiceNamespace(v string) *ScalingPlanResource

SetServiceNamespace sets the ServiceNamespace field's value.

func (ScalingPlanResource) String 

func (s ScalingPlanResource) String() string

String returns the string representation

type ScalingPolicy 

type ScalingPolicy struct {

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

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

	// The target tracking scaling policy.
	TargetTrackingConfiguration *TargetTrackingConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Represents a scaling policy.

func (ScalingPolicy) GoString 

func (s ScalingPolicy) GoString() string

GoString returns the string representation

func (*ScalingPolicy) SetPolicyName 

func (s *ScalingPolicy) SetPolicyName(v string) *ScalingPolicy

SetPolicyName sets the PolicyName field's value.

func (*ScalingPolicy) SetPolicyType 

func (s *ScalingPolicy) SetPolicyType(v string) *ScalingPolicy

SetPolicyType sets the PolicyType field's value.

func (*ScalingPolicy) SetTargetTrackingConfiguration 

func (s *ScalingPolicy) SetTargetTrackingConfiguration(v *TargetTrackingConfiguration) *ScalingPolicy

SetTargetTrackingConfiguration sets the TargetTrackingConfiguration field's value.

func (ScalingPolicy) String 

func (s ScalingPolicy) String() string

String returns the string representation

type TagFilter added in v1.13.35 

type TagFilter struct {

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

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

Represents a tag.

func (TagFilter) GoString added in v1.13.35 

func (s TagFilter) GoString() string

GoString returns the string representation

func (*TagFilter) SetKey added in v1.13.35 

func (s *TagFilter) SetKey(v string) *TagFilter

SetKey sets the Key field's value.

func (*TagFilter) SetValues added in v1.13.35 

func (s *TagFilter) SetValues(v []*string) *TagFilter

SetValues sets the Values field's value.

func (TagFilter) String added in v1.13.35 

func (s TagFilter) String() string

String returns the string representation

func (*TagFilter) Validate added in v1.13.35 

func (s *TagFilter) Validate() error

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

type TargetTrackingConfiguration 

type TargetTrackingConfiguration struct {

	// A customized metric.
	CustomizedScalingMetricSpecification *CustomizedScalingMetricSpecification `type:"structure"`

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

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

	// A predefined metric.
	PredefinedScalingMetricSpecification *PredefinedScalingMetricSpecification `type:"structure"`

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

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

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

Represents a target tracking scaling policy.

func (TargetTrackingConfiguration) GoString 

func (s TargetTrackingConfiguration) GoString() string

GoString returns the string representation

func (*TargetTrackingConfiguration) SetCustomizedScalingMetricSpecification 

func (s *TargetTrackingConfiguration) SetCustomizedScalingMetricSpecification(v *CustomizedScalingMetricSpecification) *TargetTrackingConfiguration

SetCustomizedScalingMetricSpecification sets the CustomizedScalingMetricSpecification field's value.

func (*TargetTrackingConfiguration) SetDisableScaleIn 

func (s *TargetTrackingConfiguration) SetDisableScaleIn(v bool) *TargetTrackingConfiguration

SetDisableScaleIn sets the DisableScaleIn field's value.

func (*TargetTrackingConfiguration) SetEstimatedInstanceWarmup 

func (s *TargetTrackingConfiguration) SetEstimatedInstanceWarmup(v int64) *TargetTrackingConfiguration

SetEstimatedInstanceWarmup sets the EstimatedInstanceWarmup field's value.

func (*TargetTrackingConfiguration) SetPredefinedScalingMetricSpecification 

func (s *TargetTrackingConfiguration) SetPredefinedScalingMetricSpecification(v *PredefinedScalingMetricSpecification) *TargetTrackingConfiguration

SetPredefinedScalingMetricSpecification sets the PredefinedScalingMetricSpecification field's value.

func (*TargetTrackingConfiguration) SetScaleInCooldown 

func (s *TargetTrackingConfiguration) SetScaleInCooldown(v int64) *TargetTrackingConfiguration

SetScaleInCooldown sets the ScaleInCooldown field's value.

func (*TargetTrackingConfiguration) SetScaleOutCooldown 

func (s *TargetTrackingConfiguration) SetScaleOutCooldown(v int64) *TargetTrackingConfiguration

SetScaleOutCooldown sets the ScaleOutCooldown field's value.

func (*TargetTrackingConfiguration) SetTargetValue 

func (s *TargetTrackingConfiguration) SetTargetValue(v float64) *TargetTrackingConfiguration

SetTargetValue sets the TargetValue field's value.

func (TargetTrackingConfiguration) String 

func (s TargetTrackingConfiguration) String() string

String returns the string representation

func (*TargetTrackingConfiguration) Validate 

func (s *TargetTrackingConfiguration) Validate() error

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

type UpdateScalingPlanInput added in v1.13.35 

type UpdateScalingPlanInput struct {

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

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

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

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

func (UpdateScalingPlanInput) GoString added in v1.13.35 

func (s UpdateScalingPlanInput) GoString() string

GoString returns the string representation

func (*UpdateScalingPlanInput) SetApplicationSource added in v1.13.35 

func (s *UpdateScalingPlanInput) SetApplicationSource(v *ApplicationSource) *UpdateScalingPlanInput

SetApplicationSource sets the ApplicationSource field's value.

func (*UpdateScalingPlanInput) SetScalingInstructions added in v1.13.35 

func (s *UpdateScalingPlanInput) SetScalingInstructions(v []*ScalingInstruction) *UpdateScalingPlanInput

SetScalingInstructions sets the ScalingInstructions field's value.

func (*UpdateScalingPlanInput) SetScalingPlanName added in v1.13.35 

func (s *UpdateScalingPlanInput) SetScalingPlanName(v string) *UpdateScalingPlanInput

SetScalingPlanName sets the ScalingPlanName field's value.

func (*UpdateScalingPlanInput) SetScalingPlanVersion added in v1.13.35 

func (s *UpdateScalingPlanInput) SetScalingPlanVersion(v int64) *UpdateScalingPlanInput

SetScalingPlanVersion sets the ScalingPlanVersion field's value.

func (UpdateScalingPlanInput) String added in v1.13.35 

func (s UpdateScalingPlanInput) String() string

String returns the string representation

func (*UpdateScalingPlanInput) Validate added in v1.13.35 

func (s *UpdateScalingPlanInput) Validate() error

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

type UpdateScalingPlanOutput added in v1.13.35 

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

func (UpdateScalingPlanOutput) GoString added in v1.13.35 

func (s UpdateScalingPlanOutput) GoString() string

GoString returns the string representation

func (UpdateScalingPlanOutput) String added in v1.13.35 

func (s UpdateScalingPlanOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

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

Jump to

Keyboard shortcuts

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