package types
import "github.com/aws/aws-sdk-go-v2/service/applicationautoscaling/types"
Index ¶
- type AdjustmentType
- type Alarm
- type ConcurrentUpdateException
- func (e *ConcurrentUpdateException) Error() string
- func (e *ConcurrentUpdateException) ErrorCode() string
- func (e *ConcurrentUpdateException) ErrorFault() smithy.ErrorFault
- func (e *ConcurrentUpdateException) ErrorMessage() string
- type CustomizedMetricSpecification
- type FailedResourceAccessException
- func (e *FailedResourceAccessException) Error() string
- func (e *FailedResourceAccessException) ErrorCode() string
- func (e *FailedResourceAccessException) ErrorFault() smithy.ErrorFault
- func (e *FailedResourceAccessException) ErrorMessage() string
- type InternalServiceException
- func (e *InternalServiceException) Error() string
- func (e *InternalServiceException) ErrorCode() string
- func (e *InternalServiceException) ErrorFault() smithy.ErrorFault
- func (e *InternalServiceException) ErrorMessage() string
- type InvalidNextTokenException
- func (e *InvalidNextTokenException) Error() string
- func (e *InvalidNextTokenException) ErrorCode() string
- func (e *InvalidNextTokenException) ErrorFault() smithy.ErrorFault
- func (e *InvalidNextTokenException) ErrorMessage() string
- type LimitExceededException
- func (e *LimitExceededException) Error() string
- func (e *LimitExceededException) ErrorCode() string
- func (e *LimitExceededException) ErrorFault() smithy.ErrorFault
- func (e *LimitExceededException) ErrorMessage() string
- type MetricAggregationType
- type MetricDimension
- type MetricStatistic
- type MetricType
- type ObjectNotFoundException
- func (e *ObjectNotFoundException) Error() string
- func (e *ObjectNotFoundException) ErrorCode() string
- func (e *ObjectNotFoundException) ErrorFault() smithy.ErrorFault
- func (e *ObjectNotFoundException) ErrorMessage() string
- type PolicyType
- type PredefinedMetricSpecification
- type ScalableDimension
- type ScalableTarget
- type ScalableTargetAction
- type ScalingActivity
- type ScalingActivityStatusCode
- type ScalingPolicy
- type ScheduledAction
- type ServiceNamespace
- type StepAdjustment
- type StepScalingPolicyConfiguration
- type SuspendedState
- type TargetTrackingScalingPolicyConfiguration
- type ValidationException
Types ¶
type AdjustmentType ¶
type AdjustmentType string
const ( AdjustmentTypeChangeInCapacity AdjustmentType = "ChangeInCapacity" AdjustmentTypePercentChangeInCapacity AdjustmentType = "PercentChangeInCapacity" AdjustmentTypeExactCapacity AdjustmentType = "ExactCapacity" )
Enum values for AdjustmentType
func (AdjustmentType) Values ¶
func (AdjustmentType) Values() []AdjustmentType
Values returns all known values for AdjustmentType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type Alarm ¶
type Alarm struct { // The Amazon Resource Name (ARN) of the alarm. // // This member is required. AlarmARN *string // The name of the alarm. // // This member is required. AlarmName *string // contains filtered or unexported fields }
Represents a CloudWatch alarm associated with a scaling policy.
type ConcurrentUpdateException ¶
type ConcurrentUpdateException struct { Message *string // contains filtered or unexported fields }
Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.
func (*ConcurrentUpdateException) Error ¶
func (e *ConcurrentUpdateException) Error() string
func (*ConcurrentUpdateException) ErrorCode ¶
func (e *ConcurrentUpdateException) ErrorCode() string
func (*ConcurrentUpdateException) ErrorFault ¶
func (e *ConcurrentUpdateException) ErrorFault() smithy.ErrorFault
func (*ConcurrentUpdateException) ErrorMessage ¶
func (e *ConcurrentUpdateException) ErrorMessage() string
type CustomizedMetricSpecification ¶
type CustomizedMetricSpecification struct { // The name of the metric. // // This member is required. MetricName *string // The namespace of the metric. // // This member is required. Namespace *string // The statistic of the metric. // // This member is required. Statistic MetricStatistic // The dimensions of the metric. Conditional: If you published your metric with // dimensions, you must specify the same dimensions in your scaling policy. Dimensions []MetricDimension // The unit of the metric. Unit *string // contains filtered or unexported fields }
Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Application Auto Scaling. For information about the available metrics for a service, see Amazon Web Services Services That Publish CloudWatch Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the Amazon CloudWatch User Guide. To create your customized metric specification:
* Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) in the Amazon CloudWatch User Guide.
* Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases, and increase when capacity decreases.
For more information about CloudWatch, see Amazon CloudWatch Concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html).
type FailedResourceAccessException ¶
type FailedResourceAccessException struct { Message *string // contains filtered or unexported fields }
Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html) on your behalf.
func (*FailedResourceAccessException) Error ¶
func (e *FailedResourceAccessException) Error() string
func (*FailedResourceAccessException) ErrorCode ¶
func (e *FailedResourceAccessException) ErrorCode() string
func (*FailedResourceAccessException) ErrorFault ¶
func (e *FailedResourceAccessException) ErrorFault() smithy.ErrorFault
func (*FailedResourceAccessException) ErrorMessage ¶
func (e *FailedResourceAccessException) ErrorMessage() string
type InternalServiceException ¶
type InternalServiceException struct { Message *string // contains filtered or unexported fields }
The service encountered an internal error.
func (*InternalServiceException) Error ¶
func (e *InternalServiceException) Error() string
func (*InternalServiceException) ErrorCode ¶
func (e *InternalServiceException) ErrorCode() string
func (*InternalServiceException) ErrorFault ¶
func (e *InternalServiceException) ErrorFault() smithy.ErrorFault
func (*InternalServiceException) ErrorMessage ¶
func (e *InternalServiceException) ErrorMessage() string
type InvalidNextTokenException ¶
type InvalidNextTokenException struct { Message *string // contains filtered or unexported fields }
The next token supplied was invalid.
func (*InvalidNextTokenException) Error ¶
func (e *InvalidNextTokenException) Error() string
func (*InvalidNextTokenException) ErrorCode ¶
func (e *InvalidNextTokenException) ErrorCode() string
func (*InvalidNextTokenException) ErrorFault ¶
func (e *InvalidNextTokenException) ErrorFault() smithy.ErrorFault
func (*InvalidNextTokenException) ErrorMessage ¶
func (e *InvalidNextTokenException) ErrorMessage() string
type LimitExceededException ¶
type LimitExceededException struct { Message *string // contains filtered or unexported fields }
A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-limits.html).
func (*LimitExceededException) Error ¶
func (e *LimitExceededException) Error() string
func (*LimitExceededException) ErrorCode ¶
func (e *LimitExceededException) ErrorCode() string
func (*LimitExceededException) ErrorFault ¶
func (e *LimitExceededException) ErrorFault() smithy.ErrorFault
func (*LimitExceededException) ErrorMessage ¶
func (e *LimitExceededException) ErrorMessage() string
type MetricAggregationType ¶
type MetricAggregationType string
const ( MetricAggregationTypeAverage MetricAggregationType = "Average" MetricAggregationTypeMinimum MetricAggregationType = "Minimum" MetricAggregationTypeMaximum MetricAggregationType = "Maximum" )
Enum values for MetricAggregationType
func (MetricAggregationType) Values ¶
func (MetricAggregationType) Values() []MetricAggregationType
Values returns all known values for MetricAggregationType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type MetricDimension ¶
type MetricDimension struct { // The name of the dimension. // // This member is required. Name *string // The value of the dimension. // // This member is required. Value *string // contains filtered or unexported fields }
Describes the dimension names and values associated with a metric.
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) Values ¶
func (MetricStatistic) Values() []MetricStatistic
Values returns all known values for MetricStatistic. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type MetricType ¶
type MetricType string
const ( MetricTypeDynamoDBReadCapacityUtilization MetricType = "DynamoDBReadCapacityUtilization" MetricTypeDynamoDBWriteCapacityUtilization MetricType = "DynamoDBWriteCapacityUtilization" MetricTypeALBRequestCountPerTarget MetricType = "ALBRequestCountPerTarget" MetricTypeRDSReaderAverageCPUUtilization MetricType = "RDSReaderAverageCPUUtilization" MetricTypeRDSReaderAverageDatabaseConnections MetricType = "RDSReaderAverageDatabaseConnections" MetricTypeEC2SpotFleetRequestAverageCPUUtilization MetricType = "EC2SpotFleetRequestAverageCPUUtilization" MetricTypeEC2SpotFleetRequestAverageNetworkIn MetricType = "EC2SpotFleetRequestAverageNetworkIn" MetricTypeEC2SpotFleetRequestAverageNetworkOut MetricType = "EC2SpotFleetRequestAverageNetworkOut" MetricTypeSageMakerVariantInvocationsPerInstance MetricType = "SageMakerVariantInvocationsPerInstance" MetricTypeECSServiceAverageCPUUtilization MetricType = "ECSServiceAverageCPUUtilization" MetricTypeECSServiceAverageMemoryUtilization MetricType = "ECSServiceAverageMemoryUtilization" MetricTypeAppStreamAverageCapacityUtilization MetricType = "AppStreamAverageCapacityUtilization" MetricTypeComprehendInferenceUtilization MetricType = "ComprehendInferenceUtilization" MetricTypeLambdaProvisionedConcurrencyUtilization MetricType = "LambdaProvisionedConcurrencyUtilization" MetricTypeCassandraReadCapacityUtilization MetricType = "CassandraReadCapacityUtilization" MetricTypeCassandraWriteCapacityUtilization MetricType = "CassandraWriteCapacityUtilization" MetricTypeKafkaBrokerStorageUtilization MetricType = "KafkaBrokerStorageUtilization" MetricTypeElastiCachePrimaryEngineCPUUtilization MetricType = "ElastiCachePrimaryEngineCPUUtilization" MetricTypeElastiCacheReplicaEngineCPUUtilization MetricType = "ElastiCacheReplicaEngineCPUUtilization" MetricTypeElastiCacheDatabaseMemoryUsageCountedForEvictPercentage MetricType = "ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage" MetricTypeNeptuneReaderAverageCPUUtilization MetricType = "NeptuneReaderAverageCPUUtilization" )
Enum values for MetricType
func (MetricType) Values ¶
func (MetricType) Values() []MetricType
Values returns all known values for MetricType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ObjectNotFoundException ¶
type ObjectNotFoundException struct { Message *string // contains filtered or unexported fields }
The specified object could not be found. For any operation that depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.
func (*ObjectNotFoundException) Error ¶
func (e *ObjectNotFoundException) Error() string
func (*ObjectNotFoundException) ErrorCode ¶
func (e *ObjectNotFoundException) ErrorCode() string
func (*ObjectNotFoundException) ErrorFault ¶
func (e *ObjectNotFoundException) ErrorFault() smithy.ErrorFault
func (*ObjectNotFoundException) ErrorMessage ¶
func (e *ObjectNotFoundException) ErrorMessage() string
type PolicyType ¶
type PolicyType string
const ( PolicyTypeStepScaling PolicyType = "StepScaling" PolicyTypeTargetTrackingScaling PolicyType = "TargetTrackingScaling" )
Enum values for PolicyType
func (PolicyType) Values ¶
func (PolicyType) Values() []PolicyType
Values returns all known values for PolicyType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type PredefinedMetricSpecification ¶
type PredefinedMetricSpecification struct { // The metric type. The ALBRequestCountPerTarget metric type applies only to Spot // Fleet requests and ECS services. // // This member is required. PredefinedMetricType MetricType // 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 Spot Fleet request or ECS service. You create the // resource label by appending the final portion of the load balancer ARN and the // final portion of the target group ARN into a single value, separated by a // forward slash (/). The format of the resource label is: // app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff. // Where: // // * app// is the final portion of the load balancer ARN // // * targetgroup// // is the final portion of the target group ARN. // // To find the ARN for an // Application Load Balancer, use the DescribeLoadBalancers // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) // API operation. To find the ARN for the target group, use the // DescribeTargetGroups // (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) // API operation. ResourceLabel *string // contains filtered or unexported fields }
Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling. Only the Amazon Web Services that you're using send metrics to Amazon CloudWatch. To determine whether a desired metric already exists by looking up its namespace and dimension using the CloudWatch metrics dashboard in the console, follow the procedure in Building dashboards with CloudWatch (https://docs.aws.amazon.com/autoscaling/application/userguide/monitoring-cloudwatch.html) in the Application Auto Scaling User Guide.
type ScalableDimension ¶
type ScalableDimension string
const ( ScalableDimensionECSServiceDesiredCount ScalableDimension = "ecs:service:DesiredCount" ScalableDimensionEC2SpotFleetRequestTargetCapacity ScalableDimension = "ec2:spot-fleet-request:TargetCapacity" ScalableDimensionEMRInstanceGroupInstanceCount ScalableDimension = "elasticmapreduce:instancegroup:InstanceCount" ScalableDimensionAppstreamFleetDesiredCapacity ScalableDimension = "appstream:fleet:DesiredCapacity" ScalableDimensionDynamoDBTableReadCapacityUnits ScalableDimension = "dynamodb:table:ReadCapacityUnits" ScalableDimensionDynamoDBTableWriteCapacityUnits ScalableDimension = "dynamodb:table:WriteCapacityUnits" ScalableDimensionDynamoDBIndexReadCapacityUnits ScalableDimension = "dynamodb:index:ReadCapacityUnits" ScalableDimensionDynamoDBIndexWriteCapacityUnits ScalableDimension = "dynamodb:index:WriteCapacityUnits" ScalableDimensionRDSClusterReadReplicaCount ScalableDimension = "rds:cluster:ReadReplicaCount" ScalableDimensionSageMakerVariantDesiredInstanceCount ScalableDimension = "sagemaker:variant:DesiredInstanceCount" ScalableDimensionCustomResourceScalableDimension ScalableDimension = "custom-resource:ResourceType:Property" ScalableDimensionComprehendDocClassifierEndpointInferenceUnits ScalableDimension = "comprehend:document-classifier-endpoint:DesiredInferenceUnits" ScalableDimensionComprehendEntityRecognizerEndpointInferenceUnits ScalableDimension = "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits" ScalableDimensionLambdaFunctionProvisionedConcurrency ScalableDimension = "lambda:function:ProvisionedConcurrency" ScalableDimensionCassandraTableReadCapacityUnits ScalableDimension = "cassandra:table:ReadCapacityUnits" ScalableDimensionCassandraTableWriteCapacityUnits ScalableDimension = "cassandra:table:WriteCapacityUnits" ScalableDimensionKafkaBrokerStorageVolumeSize ScalableDimension = "kafka:broker-storage:VolumeSize" ScalableDimensionElastiCacheReplicationGroupNodeGroups ScalableDimension = "elasticache:replication-group:NodeGroups" ScalableDimensionElastiCacheReplicationGroupReplicas ScalableDimension = "elasticache:replication-group:Replicas" ScalableDimensionNeptuneClusterReadReplicaCount ScalableDimension = "neptune:cluster:ReadReplicaCount" )
Enum values for ScalableDimension
func (ScalableDimension) Values ¶
func (ScalableDimension) Values() []ScalableDimension
Values returns all known values for ScalableDimension. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ScalableTarget ¶
type ScalableTarget struct { // The Unix timestamp for when the scalable target was created. // // This member is required. CreationTime *time.Time // The maximum value to scale to in response to a scale-out activity. // // This member is required. MaxCapacity *int32 // The minimum value to scale to in response to a scale-in activity. // // This member is required. MinCapacity *int32 // The identifier of the resource associated with the scalable target. This string // consists of the resource type and unique identifier. // // * ECS service - The // resource type is service and the unique identifier is the cluster name and // service name. Example: service/default/sample-webapp. // // * Spot Fleet - The // resource type is spot-fleet-request and the unique identifier is the Spot Fleet // request ID. Example: // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. // // * EMR cluster - // The resource type is instancegroup and the unique identifier is the cluster ID // and instance group ID. Example: // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. // // * AppStream 2.0 fleet - The // resource type is fleet and the unique identifier is the fleet name. Example: // fleet/sample-fleet. // // * DynamoDB table - The resource type is table and the // unique identifier is the table name. Example: table/my-table. // // * DynamoDB global // secondary index - The resource type is index and the unique identifier is the // index name. 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. // // * SageMaker endpoint variant - The resource // type is variant and the unique identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering. // // * Custom resources are not // supported with a resource type. This parameter must specify the OutputValue from // the CloudFormation template stack used to access the resources. The unique // identifier is defined by the service provider. More information is available in // our GitHub repository // (https://github.com/aws/aws-auto-scaling-custom-resource). // // * Amazon Comprehend // document classification endpoint - The resource type and unique identifier are // specified using the endpoint ARN. Example: // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. // // * // Amazon Comprehend entity recognizer endpoint - The resource type and unique // identifier are specified using the endpoint ARN. Example: // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. // // * // Lambda provisioned concurrency - The resource type is function and the unique // identifier is the function name with a function version or alias name suffix // that is not $LATEST. Example: function:my-function:prod or // function:my-function:1. // // * Amazon Keyspaces table - The resource type is table // and the unique identifier is the table name. Example: // keyspace/mykeyspace/table/mytable. // // * Amazon MSK cluster - The resource type and // unique identifier are specified using the cluster ARN. Example: // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. // // * // Amazon ElastiCache replication group - The resource type is replication-group // and the unique identifier is the replication group name. Example: // replication-group/mycluster. // // * Neptune cluster - The resource type is cluster // and the unique identifier is the cluster name. Example: cluster:mycluster. // // This member is required. ResourceId *string // The ARN of an IAM role that allows Application Auto Scaling to modify the // scalable target on your behalf. // // This member is required. RoleARN *string // The scalable dimension associated with the scalable target. This string consists // of the service namespace, resource type, and scaling property. // // * // ecs:service:DesiredCount - The desired task count of an ECS service. // // * // elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR // Instance Group. // // * ec2:spot-fleet-request:TargetCapacity - The target capacity // of a Spot Fleet. // // * appstream:fleet:DesiredCapacity - The desired capacity of an // AppStream 2.0 fleet. // // * 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 and Aurora // PostgreSQL-compatible edition. // // * sagemaker:variant:DesiredInstanceCount - The // number of EC2 instances for an SageMaker model endpoint variant. // // * // custom-resource:ResourceType:Property - The scalable dimension for a custom // resource provided by your own application or service. // // * // comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of // inference units for an Amazon Comprehend document classification endpoint. // // * // comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of // inference units for an Amazon Comprehend entity recognizer endpoint. // // * // lambda:function:ProvisionedConcurrency - The provisioned concurrency for a // Lambda function. // // * cassandra:table:ReadCapacityUnits - The provisioned read // capacity for an Amazon Keyspaces table. // // * cassandra:table:WriteCapacityUnits - // The provisioned write capacity for an Amazon Keyspaces table. // // * // kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for // brokers in an Amazon MSK cluster. // // * elasticache:replication-group:NodeGroups - // The number of node groups for an Amazon ElastiCache replication group. // // * // elasticache:replication-group:Replicas - The number of replicas per node group // for an Amazon ElastiCache replication group. // // * neptune:cluster:ReadReplicaCount // - The count of read replicas in an Amazon Neptune DB cluster. // // This member is required. ScalableDimension ScalableDimension // The namespace of the Amazon Web Services service that provides the resource, or // a custom-resource. // // This member is required. ServiceNamespace ServiceNamespace // Specifies whether the scaling activities for a scalable target are in a // suspended state. SuspendedState *SuspendedState // contains filtered or unexported fields }
Represents a scalable target.
type ScalableTargetAction ¶
type ScalableTargetAction struct { // The maximum capacity. Although you can specify a large maximum capacity, note // that service quotas may impose lower limits. Each service has its own default // quotas for the maximum capacity of the resource. If you want to specify a higher // limit, you can request an increase. For more information, consult the // documentation for that service. For information about the default quotas for // each service, see Service Endpoints and Quotas // (https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html) in // the Amazon Web Services General Reference. MaxCapacity *int32 // The minimum capacity. For certain resources, the minimum value allowed is 0. // This includes Lambda provisioned concurrency, Spot Fleet, ECS services, Aurora // DB clusters, EMR clusters, and custom resources. For all other resources, the // minimum value allowed is 1. MinCapacity *int32 // contains filtered or unexported fields }
Represents the minimum and maximum capacity for a scheduled action.
type ScalingActivity ¶
type ScalingActivity struct { // The unique identifier of the scaling activity. // // This member is required. ActivityId *string // A simple description of what caused the scaling activity to happen. // // This member is required. Cause *string // A simple description of what action the scaling activity intends to accomplish. // // This member is required. Description *string // The identifier of the resource associated with the scaling activity. This string // consists of the resource type and unique identifier. // // * ECS service - The // resource type is service and the unique identifier is the cluster name and // service name. Example: service/default/sample-webapp. // // * Spot Fleet - The // resource type is spot-fleet-request and the unique identifier is the Spot Fleet // request ID. Example: // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. // // * EMR cluster - // The resource type is instancegroup and the unique identifier is the cluster ID // and instance group ID. Example: // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. // // * AppStream 2.0 fleet - The // resource type is fleet and the unique identifier is the fleet name. Example: // fleet/sample-fleet. // // * DynamoDB table - The resource type is table and the // unique identifier is the table name. Example: table/my-table. // // * DynamoDB global // secondary index - The resource type is index and the unique identifier is the // index name. 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. // // * SageMaker endpoint variant - The resource // type is variant and the unique identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering. // // * Custom resources are not // supported with a resource type. This parameter must specify the OutputValue from // the CloudFormation template stack used to access the resources. The unique // identifier is defined by the service provider. More information is available in // our GitHub repository // (https://github.com/aws/aws-auto-scaling-custom-resource). // // * Amazon Comprehend // document classification endpoint - The resource type and unique identifier are // specified using the endpoint ARN. Example: // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. // // * // Amazon Comprehend entity recognizer endpoint - The resource type and unique // identifier are specified using the endpoint ARN. Example: // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. // // * // Lambda provisioned concurrency - The resource type is function and the unique // identifier is the function name with a function version or alias name suffix // that is not $LATEST. Example: function:my-function:prod or // function:my-function:1. // // * Amazon Keyspaces table - The resource type is table // and the unique identifier is the table name. Example: // keyspace/mykeyspace/table/mytable. // // * Amazon MSK cluster - The resource type and // unique identifier are specified using the cluster ARN. Example: // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. // // * // Amazon ElastiCache replication group - The resource type is replication-group // and the unique identifier is the replication group name. Example: // replication-group/mycluster. // // * Neptune cluster - The resource type is cluster // and the unique identifier is the cluster name. Example: cluster:mycluster. // // This member is required. ResourceId *string // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. // // * ecs:service:DesiredCount - The desired task count // of an ECS service. // // * elasticmapreduce:instancegroup:InstanceCount - The // instance count of an EMR Instance Group. // // * // ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. // // * // appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 // fleet. // // * 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 and Aurora PostgreSQL-compatible edition. // // * // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an // SageMaker model endpoint variant. // // * custom-resource:ResourceType:Property - The // scalable dimension for a custom resource provided by your own application or // service. // // * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The // number of inference units for an Amazon Comprehend document classification // endpoint. // // * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The // number of inference units for an Amazon Comprehend entity recognizer // endpoint. // // * lambda:function:ProvisionedConcurrency - The provisioned // concurrency for a Lambda function. // // * cassandra:table:ReadCapacityUnits - The // provisioned read capacity for an Amazon Keyspaces table. // // * // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an // Amazon Keyspaces table. // // * kafka:broker-storage:VolumeSize - The provisioned // volume size (in GiB) for brokers in an Amazon MSK cluster. // // * // elasticache:replication-group:NodeGroups - The number of node groups for an // Amazon ElastiCache replication group. // // * elasticache:replication-group:Replicas // - The number of replicas per node group for an Amazon ElastiCache replication // group. // // * neptune:cluster:ReadReplicaCount - The count of read replicas in an // Amazon Neptune DB cluster. // // This member is required. ScalableDimension ScalableDimension // The namespace of the Amazon Web Services service that provides the resource, or // a custom-resource. // // This member is required. ServiceNamespace ServiceNamespace // The Unix timestamp for when the scaling activity began. // // This member is required. StartTime *time.Time // Indicates the status of the scaling activity. // // This member is required. StatusCode ScalingActivityStatusCode // The details about the scaling activity. Details *string // The Unix timestamp for when the scaling activity ended. EndTime *time.Time // A simple message about the current status of the scaling activity. StatusMessage *string // contains filtered or unexported fields }
Represents a scaling activity.
type ScalingActivityStatusCode ¶
type ScalingActivityStatusCode string
const ( ScalingActivityStatusCodePending ScalingActivityStatusCode = "Pending" ScalingActivityStatusCodeInProgress ScalingActivityStatusCode = "InProgress" ScalingActivityStatusCodeSuccessful ScalingActivityStatusCode = "Successful" ScalingActivityStatusCodeOverridden ScalingActivityStatusCode = "Overridden" ScalingActivityStatusCodeUnfulfilled ScalingActivityStatusCode = "Unfulfilled" ScalingActivityStatusCodeFailed ScalingActivityStatusCode = "Failed" )
Enum values for ScalingActivityStatusCode
func (ScalingActivityStatusCode) Values ¶
func (ScalingActivityStatusCode) Values() []ScalingActivityStatusCode
Values returns all known values for ScalingActivityStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ScalingPolicy ¶
type ScalingPolicy struct { // The Unix timestamp for when the scaling policy was created. // // This member is required. CreationTime *time.Time // The Amazon Resource Name (ARN) of the scaling policy. // // This member is required. PolicyARN *string // The name of the scaling policy. // // This member is required. PolicyName *string // The scaling policy type. // // This member is required. PolicyType PolicyType // The identifier of the resource associated with the scaling policy. This string // consists of the resource type and unique identifier. // // * ECS service - The // resource type is service and the unique identifier is the cluster name and // service name. Example: service/default/sample-webapp. // // * Spot Fleet - The // resource type is spot-fleet-request and the unique identifier is the Spot Fleet // request ID. Example: // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. // // * EMR cluster - // The resource type is instancegroup and the unique identifier is the cluster ID // and instance group ID. Example: // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. // // * AppStream 2.0 fleet - The // resource type is fleet and the unique identifier is the fleet name. Example: // fleet/sample-fleet. // // * DynamoDB table - The resource type is table and the // unique identifier is the table name. Example: table/my-table. // // * DynamoDB global // secondary index - The resource type is index and the unique identifier is the // index name. 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. // // * SageMaker endpoint variant - The resource // type is variant and the unique identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering. // // * Custom resources are not // supported with a resource type. This parameter must specify the OutputValue from // the CloudFormation template stack used to access the resources. The unique // identifier is defined by the service provider. More information is available in // our GitHub repository // (https://github.com/aws/aws-auto-scaling-custom-resource). // // * Amazon Comprehend // document classification endpoint - The resource type and unique identifier are // specified using the endpoint ARN. Example: // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. // // * // Amazon Comprehend entity recognizer endpoint - The resource type and unique // identifier are specified using the endpoint ARN. Example: // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. // // * // Lambda provisioned concurrency - The resource type is function and the unique // identifier is the function name with a function version or alias name suffix // that is not $LATEST. Example: function:my-function:prod or // function:my-function:1. // // * Amazon Keyspaces table - The resource type is table // and the unique identifier is the table name. Example: // keyspace/mykeyspace/table/mytable. // // * Amazon MSK cluster - The resource type and // unique identifier are specified using the cluster ARN. Example: // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. // // * // Amazon ElastiCache replication group - The resource type is replication-group // and the unique identifier is the replication group name. Example: // replication-group/mycluster. // // * Neptune cluster - The resource type is cluster // and the unique identifier is the cluster name. Example: cluster:mycluster. // // This member is required. ResourceId *string // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. // // * ecs:service:DesiredCount - The desired task count // of an ECS service. // // * elasticmapreduce:instancegroup:InstanceCount - The // instance count of an EMR Instance Group. // // * // ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. // // * // appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 // fleet. // // * 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 and Aurora PostgreSQL-compatible edition. // // * // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an // SageMaker model endpoint variant. // // * custom-resource:ResourceType:Property - The // scalable dimension for a custom resource provided by your own application or // service. // // * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The // number of inference units for an Amazon Comprehend document classification // endpoint. // // * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The // number of inference units for an Amazon Comprehend entity recognizer // endpoint. // // * lambda:function:ProvisionedConcurrency - The provisioned // concurrency for a Lambda function. // // * cassandra:table:ReadCapacityUnits - The // provisioned read capacity for an Amazon Keyspaces table. // // * // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an // Amazon Keyspaces table. // // * kafka:broker-storage:VolumeSize - The provisioned // volume size (in GiB) for brokers in an Amazon MSK cluster. // // * // elasticache:replication-group:NodeGroups - The number of node groups for an // Amazon ElastiCache replication group. // // * elasticache:replication-group:Replicas // - The number of replicas per node group for an Amazon ElastiCache replication // group. // // * neptune:cluster:ReadReplicaCount - The count of read replicas in an // Amazon Neptune DB cluster. // // This member is required. ScalableDimension ScalableDimension // The namespace of the Amazon Web Services service that provides the resource, or // a custom-resource. // // This member is required. ServiceNamespace ServiceNamespace // The CloudWatch alarms associated with the scaling policy. Alarms []Alarm // A step scaling policy. StepScalingPolicyConfiguration *StepScalingPolicyConfiguration // A target tracking scaling policy. TargetTrackingScalingPolicyConfiguration *TargetTrackingScalingPolicyConfiguration // contains filtered or unexported fields }
Represents a scaling policy to use with Application Auto Scaling. For more information about configuring scaling policies for a specific service, see Getting started with Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/getting-started.html) in the Application Auto Scaling User Guide.
type ScheduledAction ¶
type ScheduledAction struct { // The date and time that the scheduled action was created. // // This member is required. CreationTime *time.Time // The identifier of the resource associated with the scaling policy. This string // consists of the resource type and unique identifier. // // * ECS service - The // resource type is service and the unique identifier is the cluster name and // service name. Example: service/default/sample-webapp. // // * Spot Fleet - The // resource type is spot-fleet-request and the unique identifier is the Spot Fleet // request ID. Example: // spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. // // * EMR cluster - // The resource type is instancegroup and the unique identifier is the cluster ID // and instance group ID. Example: // instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. // // * AppStream 2.0 fleet - The // resource type is fleet and the unique identifier is the fleet name. Example: // fleet/sample-fleet. // // * DynamoDB table - The resource type is table and the // unique identifier is the table name. Example: table/my-table. // // * DynamoDB global // secondary index - The resource type is index and the unique identifier is the // index name. 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. // // * SageMaker endpoint variant - The resource // type is variant and the unique identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering. // // * Custom resources are not // supported with a resource type. This parameter must specify the OutputValue from // the CloudFormation template stack used to access the resources. The unique // identifier is defined by the service provider. More information is available in // our GitHub repository // (https://github.com/aws/aws-auto-scaling-custom-resource). // // * Amazon Comprehend // document classification endpoint - The resource type and unique identifier are // specified using the endpoint ARN. Example: // arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. // // * // Amazon Comprehend entity recognizer endpoint - The resource type and unique // identifier are specified using the endpoint ARN. Example: // arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. // // * // Lambda provisioned concurrency - The resource type is function and the unique // identifier is the function name with a function version or alias name suffix // that is not $LATEST. Example: function:my-function:prod or // function:my-function:1. // // * Amazon Keyspaces table - The resource type is table // and the unique identifier is the table name. Example: // keyspace/mykeyspace/table/mytable. // // * Amazon MSK cluster - The resource type and // unique identifier are specified using the cluster ARN. Example: // arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. // // * // Amazon ElastiCache replication group - The resource type is replication-group // and the unique identifier is the replication group name. Example: // replication-group/mycluster. // // * Neptune cluster - The resource type is cluster // and the unique identifier is the cluster name. Example: cluster:mycluster. // // This member is required. ResourceId *string // The schedule for this action. The following formats are supported: // // * At // expressions - "at(yyyy-mm-ddThh:mm:ss)" // // * Rate expressions - "rate(value // unit)" // // * Cron expressions - "cron(fields)" // // At expressions are useful for // one-time schedules. Cron expressions are useful for scheduled actions that run // periodically at a specified date and time, and rate expressions are useful for // scheduled actions that run at a regular interval. At and cron expressions use // Universal Coordinated Time (UTC) by default. The cron format consists of six // fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] // [Day_of_Week] [Year]. For rate expressions, value is a positive integer and unit // is minute | minutes | hour | hours | day | days. For more information and // examples, see Example scheduled actions for Application Auto Scaling // (https://docs.aws.amazon.com/autoscaling/application/userguide/examples-scheduled-actions.html) // in the Application Auto Scaling User Guide. // // This member is required. Schedule *string // The Amazon Resource Name (ARN) of the scheduled action. // // This member is required. ScheduledActionARN *string // The name of the scheduled action. // // This member is required. ScheduledActionName *string // The namespace of the Amazon Web Services service that provides the resource, or // a custom-resource. // // This member is required. ServiceNamespace ServiceNamespace // The date and time that the action is scheduled to end, in UTC. EndTime *time.Time // The scalable dimension. This string consists of the service namespace, resource // type, and scaling property. // // * ecs:service:DesiredCount - The desired task count // of an ECS service. // // * elasticmapreduce:instancegroup:InstanceCount - The // instance count of an EMR Instance Group. // // * // ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. // // * // appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 // fleet. // // * 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 and Aurora PostgreSQL-compatible edition. // // * // sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an // SageMaker model endpoint variant. // // * custom-resource:ResourceType:Property - The // scalable dimension for a custom resource provided by your own application or // service. // // * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The // number of inference units for an Amazon Comprehend document classification // endpoint. // // * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The // number of inference units for an Amazon Comprehend entity recognizer // endpoint. // // * lambda:function:ProvisionedConcurrency - The provisioned // concurrency for a Lambda function. // // * cassandra:table:ReadCapacityUnits - The // provisioned read capacity for an Amazon Keyspaces table. // // * // cassandra:table:WriteCapacityUnits - The provisioned write capacity for an // Amazon Keyspaces table. // // * kafka:broker-storage:VolumeSize - The provisioned // volume size (in GiB) for brokers in an Amazon MSK cluster. // // * // elasticache:replication-group:NodeGroups - The number of node groups for an // Amazon ElastiCache replication group. // // * elasticache:replication-group:Replicas // - The number of replicas per node group for an Amazon ElastiCache replication // group. // // * neptune:cluster:ReadReplicaCount - The count of read replicas in an // Amazon Neptune DB cluster. ScalableDimension ScalableDimension // The new minimum and maximum capacity. You can set both values or just one. At // the scheduled time, if the current capacity is below the minimum capacity, // Application Auto Scaling scales out to the minimum capacity. If the current // capacity is above the maximum capacity, Application Auto Scaling scales in to // the maximum capacity. ScalableTargetAction *ScalableTargetAction // The date and time that the action is scheduled to begin, in UTC. StartTime *time.Time // The time zone used when referring to the date and time of a scheduled action, // when the scheduled action uses an at or cron expression. Timezone *string // contains filtered or unexported fields }
Represents a scheduled action.
type ServiceNamespace ¶
type ServiceNamespace string
const ( ServiceNamespaceEcs ServiceNamespace = "ecs" ServiceNamespaceEmr ServiceNamespace = "elasticmapreduce" ServiceNamespaceEc2 ServiceNamespace = "ec2" ServiceNamespaceAppstream ServiceNamespace = "appstream" ServiceNamespaceDynamodb ServiceNamespace = "dynamodb" ServiceNamespaceRds ServiceNamespace = "rds" ServiceNamespaceSagemaker ServiceNamespace = "sagemaker" ServiceNamespaceCustomResource ServiceNamespace = "custom-resource" ServiceNamespaceComprehend ServiceNamespace = "comprehend" ServiceNamespaceLambda ServiceNamespace = "lambda" ServiceNamespaceCassandra ServiceNamespace = "cassandra" ServiceNamespaceKafka ServiceNamespace = "kafka" ServiceNamespaceElasticache ServiceNamespace = "elasticache" ServiceNamespaceNeptune ServiceNamespace = "neptune" )
Enum values for ServiceNamespace
func (ServiceNamespace) Values ¶
func (ServiceNamespace) Values() []ServiceNamespace
Values returns all known values for ServiceNamespace. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type StepAdjustment ¶
type StepAdjustment struct { // The amount by which to scale, based on the specified adjustment type. A positive // value adds to the current capacity while a negative number removes from the // current capacity. For exact capacity, you must specify a positive value. // // This member is required. ScalingAdjustment *int32 // The lower bound for the difference between the alarm threshold and the // CloudWatch metric. If the metric value is above the breach threshold, the lower // bound is inclusive (the metric must be greater than or equal to the threshold // plus the lower bound). Otherwise, it is exclusive (the metric must be greater // than the threshold plus the lower bound). A null value indicates negative // infinity. MetricIntervalLowerBound *float64 // The upper bound for the difference between the alarm threshold and the // CloudWatch metric. If the metric value is above the breach threshold, the upper // bound is exclusive (the metric must be less than the threshold plus the upper // bound). Otherwise, it is inclusive (the metric must be less than or equal to the // threshold plus the upper bound). A null value indicates positive infinity. The // upper bound must be greater than the lower bound. MetricIntervalUpperBound *float64 // contains filtered or unexported fields }
Represents a step adjustment for a StepScalingPolicyConfiguration (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html). Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm. For the following examples, suppose that you have an alarm with a breach threshold of 50:
* To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.
* To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.
There are a few rules for the step adjustments for your step policy:
* The ranges of your step adjustments can't overlap or have a gap.
* At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.
* At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.
* The upper and lower bound can't be null in the same step adjustment.
type StepScalingPolicyConfiguration ¶
type StepScalingPolicyConfiguration struct { // Specifies how the ScalingAdjustment value in a StepAdjustment // (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepAdjustment.html) // is interpreted (for example, an absolute number or a percentage). The valid // values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity. // AdjustmentType is required if you are adding a new step scaling policy // configuration. AdjustmentType AdjustmentType // The amount of time, in seconds, to wait for a previous scaling activity to take // effect. With scale-out policies, the intention is to continuously (but not // excessively) scale out. After Application Auto Scaling successfully scales out // using a step scaling policy, it starts to calculate the cooldown time. The // scaling policy won't increase the desired capacity again unless either a larger // scale out is triggered or the cooldown period ends. While the cooldown period is // in effect, capacity added by the initiating scale-out activity is calculated as // part of the desired capacity for the next scale-out activity. For example, when // an alarm triggers a step scaling policy to increase the capacity by 2, the // scaling activity completes successfully, and a cooldown period starts. If the // alarm triggers again during the cooldown period but at a more aggressive step // adjustment of 3, the previous increase of 2 is considered part of the current // capacity. Therefore, only 1 is added to the capacity. With scale-in policies, // the intention is to scale in conservatively to protect your application’s // availability, so scale-in activities are blocked until the cooldown period has // expired. However, if another alarm triggers a scale-out activity during the // cooldown period after a scale-in activity, Application Auto Scaling scales out // the target immediately. In this case, the cooldown period for the scale-in // activity stops and doesn't complete. Application Auto Scaling provides a default // value of 600 for Amazon ElastiCache replication groups and a default value of // 300 for the following scalable targets: // // * AppStream 2.0 fleets // // * Aurora DB // clusters // // * ECS services // // * EMR clusters // // * Neptune clusters // // * SageMaker // endpoint variants // // * Spot Fleets // // * Custom resources // // For all other scalable // targets, the default value is 0: // // * Amazon Comprehend document classification // and entity recognizer endpoints // // * DynamoDB tables and global secondary // indexes // // * Amazon Keyspaces tables // // * Lambda provisioned concurrency // // * Amazon // MSK broker storage Cooldown *int32 // The aggregation type for the CloudWatch metrics. Valid values are Minimum, // Maximum, and Average. If the aggregation type is null, the value is treated as // Average. MetricAggregationType MetricAggregationType // The minimum value to scale by when the adjustment type is // PercentChangeInCapacity. For example, suppose that you create a step scaling // policy to scale out an Amazon ECS service by 25 percent and you specify a // MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy // is performed, 25 percent of 4 is 1. However, because you specified a // MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by // 2 tasks. MinAdjustmentMagnitude *int32 // A set of adjustments that enable you to scale based on the size of the alarm // breach. At least one step adjustment is required if you are adding a new step // scaling policy configuration. StepAdjustments []StepAdjustment // contains filtered or unexported fields }
Represents a step scaling policy configuration to use with Application Auto Scaling.
type SuspendedState ¶
type SuspendedState struct { // Whether scale in by a target tracking scaling policy or a step scaling policy is // suspended. Set the value to true if you don't want Application Auto Scaling to // remove capacity when a scaling policy is triggered. The default is false. DynamicScalingInSuspended *bool // Whether scale out by a target tracking scaling policy or a step scaling policy // is suspended. Set the value to true if you don't want Application Auto Scaling // to add capacity when a scaling policy is triggered. The default is false. DynamicScalingOutSuspended *bool // Whether scheduled scaling is suspended. Set the value to true if you don't want // Application Auto Scaling to add or remove capacity by initiating scheduled // actions. The default is false. ScheduledScalingSuspended *bool // contains filtered or unexported fields }
Specifies whether the scaling activities for a scalable target are in a suspended state.
type TargetTrackingScalingPolicyConfiguration ¶
type TargetTrackingScalingPolicyConfiguration struct { // The target value for the metric. Although this property accepts numbers of type // Double, it won't accept values that are either too small or too large. Values // must be in the range of -2^360 to 2^360. The value must be a valid number based // on the choice of metric. For example, if the metric is CPU utilization, then the // target value is a percent value that represents how much of the CPU can be used // before scaling out. // // This member is required. TargetValue *float64 // A customized metric. You can specify either a predefined metric or a customized // metric. CustomizedMetricSpecification *CustomizedMetricSpecification // Indicates whether scale in by the target tracking scaling policy is disabled. If // the value is true, scale in is disabled and the target tracking scaling policy // won't remove capacity from the scalable target. Otherwise, scale in is enabled // and the target tracking scaling policy can remove capacity from the scalable // target. The default value is false. DisableScaleIn *bool // A predefined metric. You can specify either a predefined metric or a customized // metric. PredefinedMetricSpecification *PredefinedMetricSpecification // The amount of time, in seconds, after a scale-in activity completes before // another scale-in activity can start. With the scale-in cooldown period, the // intention is to scale in conservatively to protect your application’s // availability, so scale-in activities are blocked until the cooldown period has // expired. However, if another alarm triggers a scale-out activity during the // scale-in cooldown period, Application Auto Scaling scales out the target // immediately. In this case, the scale-in cooldown period stops and doesn't // complete. Application Auto Scaling provides a default value of 600 for Amazon // ElastiCache replication groups and a default value of 300 for the following // scalable targets: // // * AppStream 2.0 fleets // // * Aurora DB clusters // // * ECS // services // // * EMR clusters // // * Neptune clusters // // * SageMaker endpoint variants // // * // Spot Fleets // // * Custom resources // // For all other scalable targets, the default // value is 0: // // * Amazon Comprehend document classification and entity recognizer // endpoints // // * DynamoDB tables and global secondary indexes // // * Amazon Keyspaces // tables // // * Lambda provisioned concurrency // // * Amazon MSK broker storage ScaleInCooldown *int32 // The amount of time, in seconds, to wait for a previous scale-out activity to // take effect. With the scale-out cooldown period, the intention is to // continuously (but not excessively) scale out. After Application Auto Scaling // successfully scales out using a target tracking scaling policy, it starts to // calculate the cooldown time. The scaling policy won't increase the desired // capacity again unless either a larger scale out is triggered or the cooldown // period ends. While the cooldown period is in effect, the capacity added by the // initiating scale-out activity is calculated as part of the desired capacity for // the next scale-out activity. Application Auto Scaling provides a default value // of 600 for Amazon ElastiCache replication groups and a default value of 300 for // the following scalable targets: // // * AppStream 2.0 fleets // // * Aurora DB clusters // // * // ECS services // // * EMR clusters // // * Neptune clusters // // * SageMaker endpoint // variants // // * Spot Fleets // // * Custom resources // // For all other scalable targets, the // default value is 0: // // * Amazon Comprehend document classification and entity // recognizer endpoints // // * DynamoDB tables and global secondary indexes // // * Amazon // Keyspaces tables // // * Lambda provisioned concurrency // // * Amazon MSK broker storage ScaleOutCooldown *int32 // contains filtered or unexported fields }
Represents a target tracking scaling policy configuration to use with Application Auto Scaling.
type ValidationException ¶
type ValidationException struct { Message *string // contains filtered or unexported fields }
An exception was thrown for a validation issue. Review the available parameters for the API request.
func (*ValidationException) Error ¶
func (e *ValidationException) Error() string
func (*ValidationException) ErrorCode ¶
func (e *ValidationException) ErrorCode() string
func (*ValidationException) ErrorFault ¶
func (e *ValidationException) ErrorFault() smithy.ErrorFault
func (*ValidationException) ErrorMessage ¶
func (e *ValidationException) ErrorMessage() string
Source Files ¶
- Version
- v1.15.8
- Published
- Jul 5, 2022
- Platform
- js/wasm
- Imports
- 4 packages
- Last checked
- 4 hours ago –
Tools for package owners.