autoscalingplans

package
v2.0.0-preview.3+incom... Latest Latest
Warning

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

 Go to latest Published: Mar 8, 2018 License: Apache-2.0 Imports: 6 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 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 (

	// 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" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName   // Service ID for Regions and Endpoints metadata.
)

Service information constants

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

Represents an application source. Please also see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/ApplicationSource

func (ApplicationSource) GoString 

func (s ApplicationSource) GoString() string

GoString returns the string representation

func (ApplicationSource) String 

func (s ApplicationSource) String() string

String returns the string representation

type AutoScalingPlans 

type AutoScalingPlans struct {
	*aws.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(config aws.Config) *AutoScalingPlans

New creates a new instance of the AutoScalingPlans client with a config.

Example: 

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

func (*AutoScalingPlans) CreateScalingPlanRequest 

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

CreateScalingPlanRequest returns a request value for making 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. 

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

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

func (*AutoScalingPlans) DeleteScalingPlanRequest 

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

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

Deletes the specified scaling plan. 

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

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

func (*AutoScalingPlans) DescribeScalingPlanResourcesRequest 

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

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

Describes the scalable resources in the specified scaling plan. 

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

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

func (*AutoScalingPlans) DescribeScalingPlansRequest 

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

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

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

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

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

type CreateScalingPlanInput 

type CreateScalingPlanInput struct {

	// The source for the application.
	//
	// 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.
	//
	// ScalingPlanName is a required field
	ScalingPlanName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (CreateScalingPlanInput) GoString 

func (s CreateScalingPlanInput) GoString() string

GoString returns the string representation

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
}

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

func (CreateScalingPlanOutput) GoString 

func (s CreateScalingPlanOutput) GoString() string

GoString returns the string representation

func (CreateScalingPlanOutput) SDKResponseMetadata 

func (s CreateScalingPlanOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateScalingPlanOutput) String 

func (s CreateScalingPlanOutput) String() string

String returns the string representation

type CreateScalingPlanRequest 

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

CreateScalingPlanRequest is a API request type for the CreateScalingPlan API operation.

func (CreateScalingPlanRequest) Send 

func (r CreateScalingPlanRequest) Send() (*CreateScalingPlanOutput, error)

Send marshals and sends the CreateScalingPlan API request.

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 MetricStatistic `type:"string" required:"true" enum:"true"`

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

Represents a customized metric for a target tracking policy. Please also see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/CustomizedScalingMetricSpecification

func (CustomizedScalingMetricSpecification) GoString 

func (s CustomizedScalingMetricSpecification) GoString() string

GoString returns the string representation

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
}

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

func (DeleteScalingPlanInput) GoString 

func (s DeleteScalingPlanInput) GoString() string

GoString returns the string representation

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
}

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

func (DeleteScalingPlanOutput) GoString 

func (s DeleteScalingPlanOutput) GoString() string

GoString returns the string representation

func (DeleteScalingPlanOutput) SDKResponseMetadata 

func (s DeleteScalingPlanOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteScalingPlanOutput) String 

func (s DeleteScalingPlanOutput) String() string

String returns the string representation

type DeleteScalingPlanRequest 

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

DeleteScalingPlanRequest is a API request type for the DeleteScalingPlan API operation.

func (DeleteScalingPlanRequest) Send 

func (r DeleteScalingPlanRequest) Send() (*DeleteScalingPlanOutput, error)

Send marshals and sends the DeleteScalingPlan API request.

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
}

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

func (DescribeScalingPlanResourcesInput) GoString 

func (s DescribeScalingPlanResourcesInput) GoString() string

GoString returns the string representation

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
}

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

func (DescribeScalingPlanResourcesOutput) GoString 

func (s DescribeScalingPlanResourcesOutput) GoString() string

GoString returns the string representation

func (DescribeScalingPlanResourcesOutput) SDKResponseMetadata 

func (s DescribeScalingPlanResourcesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeScalingPlanResourcesOutput) String 

func (s DescribeScalingPlanResourcesOutput) String() string

String returns the string representation

type DescribeScalingPlanResourcesRequest 

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

DescribeScalingPlanResourcesRequest is a API request type for the DescribeScalingPlanResources API operation.

func (DescribeScalingPlanResourcesRequest) Send 

func (r DescribeScalingPlanResourcesRequest) Send() (*DescribeScalingPlanResourcesOutput, error)

Send marshals and sends the DescribeScalingPlanResources API request.

type DescribeScalingPlansInput 

type DescribeScalingPlansInput struct {

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

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

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

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

	// The version 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
}

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

func (DescribeScalingPlansInput) GoString 

func (s DescribeScalingPlansInput) GoString() string

GoString returns the string representation

func (DescribeScalingPlansInput) String 

func (s DescribeScalingPlansInput) String() string

String returns the string representation

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
}

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

func (DescribeScalingPlansOutput) GoString 

func (s DescribeScalingPlansOutput) GoString() string

GoString returns the string representation

func (DescribeScalingPlansOutput) SDKResponseMetadata 

func (s DescribeScalingPlansOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeScalingPlansOutput) String 

func (s DescribeScalingPlansOutput) String() string

String returns the string representation

type DescribeScalingPlansRequest 

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

DescribeScalingPlansRequest is a API request type for the DescribeScalingPlans API operation.

func (DescribeScalingPlansRequest) Send 

func (r DescribeScalingPlansRequest) Send() (*DescribeScalingPlansOutput, error)

Send marshals and sends the DescribeScalingPlans API request.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/MetricDimension

func (MetricDimension) GoString 

func (s MetricDimension) GoString() string

GoString returns the string representation

func (MetricDimension) String 

func (s MetricDimension) String() string

String returns the string representation

func (*MetricDimension) Validate 

func (s *MetricDimension) Validate() error

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

type MetricStatistic 

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

Enum values for MetricStatistic

func (MetricStatistic) MarshalValue 

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

func (MetricStatistic) MarshalValueBuf 

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

type PolicyType 

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

Enum values for PolicyType

func (PolicyType) MarshalValue 

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

func (PolicyType) MarshalValueBuf 

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

type 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 ScalingMetricType `type:"string" required:"true" enum:"true"`

	// Identifies the resource associated with the metric type. You can't specify
	// a resource label unless the metric type is ALBRequestCountPerTarget and there
	// is a target group 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/PredefinedScalingMetricSpecification

func (PredefinedScalingMetricSpecification) GoString 

func (s PredefinedScalingMetricSpecification) GoString() string

GoString returns the string representation

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 ScalableDimension 

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

Enum values for ScalableDimension

func (ScalableDimension) MarshalValue 

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

func (ScalableDimension) MarshalValueBuf 

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

type ScalingInstruction 

type ScalingInstruction struct {

	// The 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 ScalableDimension `type:"string" required:"true" enum:"true"`

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

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/ScalingInstruction

func (ScalingInstruction) GoString 

func (s ScalingInstruction) GoString() string

GoString returns the string representation

func (ScalingInstruction) String 

func (s ScalingInstruction) String() string

String returns the string representation

func (*ScalingInstruction) Validate 

func (s *ScalingInstruction) Validate() error

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

type ScalingMetricType 

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

Enum values for ScalingMetricType

func (ScalingMetricType) MarshalValue 

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

func (ScalingMetricType) MarshalValueBuf 

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

type ScalingPlan 

type ScalingPlan struct {

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

	// The Unix 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 ScalingPlanStatusCode `type:"string" required:"true" enum:"true"`

	// A simple message about the current status of the scaling plan.
	StatusMessage *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a scaling plan. Please also see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/ScalingPlan

func (ScalingPlan) GoString 

func (s ScalingPlan) GoString() string

GoString returns the string representation

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 ScalableDimension `type:"string" required:"true" enum:"true"`

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

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

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

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

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

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

Represents a scalable resource. Please also see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/ScalingPlanResource

func (ScalingPlanResource) GoString 

func (s ScalingPlanResource) GoString() string

GoString returns the string representation

func (ScalingPlanResource) String 

func (s ScalingPlanResource) String() string

String returns the string representation

type ScalingPlanStatusCode 

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

Enum values for ScalingPlanStatusCode

func (ScalingPlanStatusCode) MarshalValue 

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

func (ScalingPlanStatusCode) MarshalValueBuf 

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

type ScalingPolicy 

type ScalingPolicy struct {

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

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

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

Represents a scaling policy. Please also see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/ScalingPolicy

func (ScalingPolicy) GoString 

func (s ScalingPolicy) GoString() string

GoString returns the string representation

func (ScalingPolicy) String 

func (s ScalingPolicy) String() string

String returns the string representation

type ScalingStatusCode 

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

Enum values for ScalingStatusCode

func (ScalingStatusCode) MarshalValue 

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

func (ScalingStatusCode) MarshalValueBuf 

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

type ServiceNamespace 

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

Enum values for ServiceNamespace

func (ServiceNamespace) MarshalValue 

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

func (ServiceNamespace) MarshalValueBuf 

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

type 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/TargetTrackingConfiguration

func (TargetTrackingConfiguration) GoString 

func (s TargetTrackingConfiguration) GoString() string

GoString returns the string representation

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.

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.