Use AWS Auto Scaling to quickly discover all the scalable AWS resources for your application and configure dynamic scaling and predictive scaling for your resources using scaling plans. Use this service in conjunction with the Amazon EC2 Auto Scaling, Application Auto Scaling, Amazon CloudWatch, and AWS CloudFormation services.
Currently, predictive scaling is only available for Amazon EC2 Auto Scaling groups.
For more information about AWS Auto Scaling, including information about granting IAM users required permissions for AWS Auto Scaling actions, see the AWS Auto Scaling User Guide.
", + "service": "Use AWS Auto Scaling to create scaling plans for your applications to automatically scale your scalable AWS resources.
API Summary
You can use the AWS Auto Scaling service API to accomplish the following tasks:
Create and manage scaling plans
Define target tracking scaling policies to dynamically scale your resources based on utilization
Scale Amazon EC2 Auto Scaling groups using predictive scaling and dynamic scaling to scale your Amazon EC2 capacity faster
Set minimum and maximum capacity limits
Retrieve information on existing scaling plans
Access current forecast data and historical forecast data for up to 56 days previous
To learn more about AWS Auto Scaling, including information about granting IAM users required permissions for AWS Auto Scaling actions, see the AWS Auto Scaling User Guide.
", "operations": { - "CreateScalingPlan": "Creates a scaling plan.
", + "CreateScalingPlan": "Creates a scaling plan.
", "DeleteScalingPlan": "Deletes the specified scaling plan.
Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan.
If the plan has launched resources or has scaling activities in progress, you must delete those resources separately.
", "DescribeScalingPlanResources": "Describes the scalable resources in the specified scaling plan.
", "DescribeScalingPlans": "Describes one or more of your scaling plans.
", @@ -14,9 +14,9 @@ "base": "Represents an application source.
", "refs": { "ApplicationSources$member": null, - "CreateScalingPlanRequest$ApplicationSource": "A CloudFormation stack or set of tags. You can create one scaling plan per application source.
", - "ScalingPlan$ApplicationSource": "The application source.
", - "UpdateScalingPlanRequest$ApplicationSource": "A CloudFormation stack or set of tags.
" + "CreateScalingPlanRequest$ApplicationSource": "A CloudFormation stack or set of tags. You can create one scaling plan per application source.
For more information, see ApplicationSource in the AWS Auto Scaling API Reference.
", + "ScalingPlan$ApplicationSource": "A CloudFormation stack or a set of tags. You can create one scaling plan per application source.
", + "UpdateScalingPlanRequest$ApplicationSource": "A CloudFormation stack or set of tags.
For more information, see ApplicationSource in the AWS Auto Scaling API Reference.
" } }, "ApplicationSources": { @@ -33,8 +33,8 @@ "Cooldown": { "base": null, "refs": { - "TargetTrackingConfiguration$ScaleOutCooldown": "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.
", - "TargetTrackingConfiguration$ScaleInCooldown": "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.
", + "TargetTrackingConfiguration$ScaleOutCooldown": "The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group.
With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After 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.
", + "TargetTrackingConfiguration$ScaleInCooldown": "The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. This property is not used if the scalable resource is an Auto Scaling group.
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, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
", "TargetTrackingConfiguration$EstimatedInstanceWarmup": "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.
" } }, @@ -49,13 +49,13 @@ } }, "CustomizedLoadMetricSpecification": { - "base": "Represents a CloudWatch metric of your choosing that can be used for predictive scaling.
For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the Sum and Average statistics that CloudWatch computes from metric data. Statistics are calculations used to aggregate data over specified time periods.
When you choose a load metric, make sure that the required Sum and Average statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The Sum statistic must represent the total load on the resource, and the Average statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the Sum statistic represents the total request count processed by the group, then the Average statistic for the specified metric must represent the average request count processed by each instance of the group.
For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.
", + "base": "Represents a CloudWatch metric of your choosing that can be used for predictive scaling.
For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the Sum and Average statistics that CloudWatch computes from metric data.
When you choose a load metric, make sure that the required Sum and Average statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The Sum statistic must represent the total load on the resource, and the Average statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the Sum statistic represents the total request count processed by the group, then the Average statistic for the specified metric must represent the average request count processed by each instance of the group.
If you publish your own metrics, you can aggregate the data points at a given interval and then publish the aggregated data points to CloudWatch. Before AWS Auto Scaling generates the forecast, it sums up all the metric data points that occurred within each hour to match the granularity period that is used in the forecast (60 minutes).
For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.
After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see View Scaling Information for a Resource in the AWS Auto Scaling User Guide.
", "refs": { "ScalingInstruction$CustomizedLoadMetricSpecification": "The customized load metric to use for predictive scaling. This parameter or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
" } }, "CustomizedScalingMetricSpecification": { - "base": "Represents a CloudWatch metric of your choosing that can be used for dynamic scaling as part of a target tracking scaling policy.
To create your customized scaling 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 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.
For more information about CloudWatch, see Amazon CloudWatch Concepts.
", + "base": "Represents a CloudWatch metric of your choosing that can be used for dynamic scaling as part of a target tracking scaling policy.
To create your customized scaling 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 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.
For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.
", "refs": { "TargetTrackingConfiguration$CustomizedScalingMetricSpecification": "A customized metric. You can specify either a predefined metric or a customized metric.
" } @@ -212,13 +212,13 @@ "base": null, "refs": { "Datapoint$Value": "The value of the data point.
", - "TargetTrackingConfiguration$TargetValue": "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).
" + "TargetTrackingConfiguration$TargetValue": "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.
" } }, "MetricStatistic": { "base": null, "refs": { - "CustomizedLoadMetricSpecification$Statistic": "The statistic of the metric. Currently, the value must always be Sum.
The statistic of the metric. The only valid value is Sum.
The statistic of the metric.
" } }, @@ -256,7 +256,7 @@ } }, "PredefinedLoadMetricSpecification": { - "base": "Represents a predefined metric that can be used for predictive scaling.
", + "base": "Represents a predefined metric that can be used for predictive scaling.
After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see View Scaling Information for a Resource in the AWS Auto Scaling User Guide.
", "refs": { "ScalingInstruction$PredefinedLoadMetricSpecification": "The predefined load metric to use for predictive scaling. This parameter or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
" } @@ -297,20 +297,20 @@ "ResourceLabel": { "base": null, "refs": { - "PredefinedLoadMetricSpecification$ResourceLabel": "Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group.
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.
Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.
The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN.
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group.
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 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.
This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
", + "PredefinedScalingMetricSpecification$ResourceLabel": "Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.
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 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.
This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
" } }, "ScalableDimension": { "base": null, "refs": { - "GetScalingPlanResourceForecastDataRequest$ScalableDimension": "The scalable dimension for the resource.
", + "GetScalingPlanResourceForecastDataRequest$ScalableDimension": "The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.
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 and Aurora PostgreSQL-compatible edition.
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 and Aurora PostgreSQL-compatible edition.
Describes a scaling instruction for a scalable resource.
The scaling instruction is used in combination with a scaling plan, which is a set of instructions for configuring dynamic scaling and predictive scaling for the scalable resources in your application. Each scaling instruction applies to one resource.
AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.
AWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto Scaling groups using a subset of parameters, including the load metric, the scaling metric, the target value for the scaling metric, the predictive scaling mode (forecast and scale or forecast only), and the desired behavior when the forecast capacity exceeds the maximum capacity of the resource. With predictive scaling, AWS Auto Scaling generates forecasts with traffic predictions for the two days ahead and schedules scaling actions that proactively add and remove resource capacity to match the forecast.
We recommend waiting a minimum of 24 hours after creating an Auto Scaling group to configure predictive scaling. At minimum, there must be 24 hours of historical data to generate a forecast.
For more information, see Getting Started with AWS Auto Scaling.
", + "base": "Describes a scaling instruction for a scalable resource in a scaling plan. Each scaling instruction applies to one resource.
AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.
AWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto Scaling groups using a subset of parameters, including the load metric, the scaling metric, the target value for the scaling metric, the predictive scaling mode (forecast and scale or forecast only), and the desired behavior when the forecast capacity exceeds the maximum capacity of the resource. With predictive scaling, AWS Auto Scaling generates forecasts with traffic predictions for the two days ahead and schedules scaling actions that proactively add and remove resource capacity to match the forecast.
We recommend waiting a minimum of 24 hours after creating an Auto Scaling group to configure predictive scaling. At minimum, there must be 24 hours of historical data to generate a forecast. For more information, see Best Practices for AWS Auto Scaling in the AWS Auto Scaling User Guide.
The scaling instructions.
", + "CreateScalingPlanRequest$ScalingInstructions": "The scaling instructions.
For more information, see ScalingInstruction in the AWS Auto Scaling API Reference.
", "ScalingPlan$ScalingInstructions": "The scaling instructions.
", - "UpdateScalingPlanRequest$ScalingInstructions": "The scaling instructions.
" + "UpdateScalingPlanRequest$ScalingInstructions": "The scaling instructions.
For more information, see ScalingInstruction in the AWS Auto Scaling API Reference.
" } }, "ScalingMetricType": { @@ -375,14 +375,14 @@ "ScalingPlanVersion": { "base": null, "refs": { - "CreateScalingPlanResponse$ScalingPlanVersion": "The version number of the scaling plan. This value is always 1.
Currently, you cannot specify multiple scaling plan versions.
", - "DeleteScalingPlanRequest$ScalingPlanVersion": "The version number of the scaling plan.
", - "DescribeScalingPlanResourcesRequest$ScalingPlanVersion": "The version number of the scaling plan.
", - "DescribeScalingPlansRequest$ScalingPlanVersion": "The version number of the scaling plan. If you specify a scaling plan version, you must also specify a scaling plan name.
", - "GetScalingPlanResourceForecastDataRequest$ScalingPlanVersion": "The version number of the scaling plan.
", + "CreateScalingPlanResponse$ScalingPlanVersion": "The version number of the scaling plan. This value is always 1. Currently, you cannot have multiple scaling plan versions.
The version number of the scaling plan. Currently, the only valid value is 1.
The version number of the scaling plan. Currently, the only valid value is 1.
The version number of the scaling plan. Currently, the only valid value is 1.
If you specify a scaling plan version, you must also specify a scaling plan name.
The version number of the scaling plan. Currently, the only valid value is 1.
The version number of the scaling plan.
", "ScalingPlanResource$ScalingPlanVersion": "The version number of the scaling plan.
", - "UpdateScalingPlanRequest$ScalingPlanVersion": "The version number of the scaling plan.
" + "UpdateScalingPlanRequest$ScalingPlanVersion": "The version number of the scaling plan. The only valid value is 1. Currently, you cannot have multiple scaling plan versions.
The namespace of the AWS service.
", + "GetScalingPlanResourceForecastDataRequest$ServiceNamespace": "The namespace of the AWS service. The only valid value is autoscaling.
The namespace of the AWS service.
", "ScalingPlanResource$ServiceNamespace": "The namespace of the AWS service.
" } @@ -457,7 +457,7 @@ "TargetTrackingConfigurations": { "base": null, "refs": { - "ScalingInstruction$TargetTrackingConfigurations": "The structure that defines new target tracking configurations (up to 10). Each of these structures includes a specific scaling metric and a target value for the metric, along with various parameters to use with dynamic scaling.
With predictive scaling and dynamic scaling, the resource scales based on the target tracking configuration that provides the largest capacity for both scale in and scale out.
Condition: The scaling metric must be unique across target tracking configurations.
" + "ScalingInstruction$TargetTrackingConfigurations": "The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.
" } }, "TimestampType": { @@ -489,7 +489,7 @@ "base": null, "refs": { "ApplicationSource$CloudFormationStackARN": "The Amazon Resource Name (ARN) of a AWS CloudFormation stack.
", - "GetScalingPlanResourceForecastDataRequest$ResourceId": "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.
The ID of the resource. This string consists of a prefix (autoScalingGroup) followed by the name of a specified Auto Scaling group (my-asg). Example: autoScalingGroup/my-asg.
A simple message about the current status of the scaling plan.
", "ScalingPlanResource$ScalingStatusMessage": "A simple message about the current scaling status of the resource.
" } diff --git a/models/apis/autoscaling/2011-01-01/docs-2.json b/models/apis/autoscaling/2011-01-01/docs-2.json index bce617010a3..263578c4640 100644 --- a/models/apis/autoscaling/2011-01-01/docs-2.json +++ b/models/apis/autoscaling/2011-01-01/docs-2.json @@ -9,7 +9,7 @@ "BatchPutScheduledUpdateGroupAction": "Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.
", "CancelInstanceRefresh": "Cancels an instance refresh operation in progress. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.
", "CompleteLifecycleAction": "Completes the lifecycle action for the specified token or instance with the specified result.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.
If you finish before the timeout period ends, complete the lifecycle action.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
", - "CreateAutoScalingGroup": "Creates an Auto Scaling group with the specified name and attributes.
If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.
For introductory exercises for creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling and Tutorial: Set up a scaled and load-balanced application in the Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling groups in the Amazon EC2 Auto Scaling User Guide.
Every Auto Scaling group has three size parameters (DesiredCapacity, MaxSize, and MinSize). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.
We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Creates an Auto Scaling group with the specified name and attributes.
If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.
For introductory exercises for creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling and Tutorial: Set up a scaled and load-balanced application in the Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling groups in the Amazon EC2 Auto Scaling User Guide.
Every Auto Scaling group has three size parameters (DesiredCapacity, MaxSize, and MinSize). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.
Creates a launch configuration.
If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.
For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.
", "CreateOrUpdateTags": "Creates or updates tags for the specified Auto Scaling group.
When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.
For more information, see Tagging Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
", "DeleteAutoScalingGroup": "Deletes the specified Auto Scaling group.
If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed.
If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.
To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.
To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity of the Auto Scaling group to zero.
", @@ -58,7 +58,7 @@ "StartInstanceRefresh": "Starts a new instance refresh operation, which triggers a rolling replacement of all previously launched instances in the Auto Scaling group with a new group of instances.
If successful, this call creates a new instance refresh request with a unique ID that you can use to track its progress. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh operation in progress, use the CancelInstanceRefresh API.
For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.
", "SuspendProcesses": "Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly. For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
To resume processes that have been suspended, call the ResumeProcesses API.
", "TerminateInstanceInAutoScalingGroup": "Terminates the specified instance and optionally adjusts the desired group size.
This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an instance after you've terminated it.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated.
By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.
", - "UpdateAutoScalingGroup": "Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group, specify the name of the group and the parameter that you want to change. Any parameters that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.
If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.
Note the following about changing DesiredCapacity, MaxSize, or MinSize:
If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.
If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, this sets the group's DesiredCapacity to the new MinSize value.
If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, this sets the group's DesiredCapacity to the new MaxSize value.
To see which parameters have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.
" + "UpdateAutoScalingGroup": "We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group, specify the name of the group and the parameter that you want to change. Any parameters that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.
If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.
Note the following about changing DesiredCapacity, MaxSize, or MinSize:
If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.
If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, this sets the group's DesiredCapacity to the new MinSize value.
If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, this sets the group's DesiredCapacity to the new MaxSize value.
To see which parameters have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.
" }, "shapes": { "ActiveInstanceRefreshNotFoundFault": { @@ -726,7 +726,7 @@ "InstanceMetadataHttpPutResponseHopLimit": { "base": null, "refs": { - "InstanceMetadataOptions$HttpPutResponseHopLimit": "The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
" + "InstanceMetadataOptions$HttpPutResponseHopLimit": "The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
" } }, "InstanceMetadataHttpTokensState": { @@ -864,7 +864,7 @@ } }, "LaunchTemplateOverrides": { - "base": "Describes an override for a launch template. The maximum number of instance types that can be associated with an Auto Scaling group is 20. For more information, see Configuring overrides in the Amazon EC2 Auto Scaling User Guide.
", + "base": "Describes an override for a launch template. The maximum number of instance types that can be associated with an Auto Scaling group is 40. The maximum number of distinct launch templates you can define for an Auto Scaling group is 20. For more information about configuring overrides, see Configuring overrides in the Amazon EC2 Auto Scaling User Guide.
", "refs": { "Overrides$member": null } @@ -874,7 +874,7 @@ "refs": { "AutoScalingGroup$LaunchTemplate": "The launch template for the group.
", "AutoScalingInstanceDetails$LaunchTemplate": "The launch template for the instance.
", - "CreateAutoScalingGroupType$LaunchTemplate": "Parameters used to specify the launch template and version to use to launch instances.
Conditional: You must specify either a launch template (LaunchTemplate or MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName or InstanceId).
The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Parameters used to specify the launch template and version to use to launch instances.
Conditional: You must specify either a launch template (LaunchTemplate or MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName or InstanceId).
The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
The launch template for the instance.
", "LaunchTemplate$LaunchTemplateSpecification": "The launch template to use.
", "LaunchTemplateOverrides$LaunchTemplateSpecification": "Provides the launch template to be used when launching the instance type. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's defined for your mixed instances policy. For more information, see Specifying a different launch template for an instance type in the Amazon EC2 Auto Scaling User Guide.
", @@ -930,7 +930,7 @@ "LifecycleState": { "base": null, "refs": { - "Instance$LifecycleState": "A description of the current lifecycle state. The Quarantined state is not used.
A description of the current lifecycle state. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.
The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.
If you do not specify InstanceId, you must specify ImageId.
The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
", "CreateLaunchConfigurationType$ClassicLinkVPCId": "The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
This parameter can only be used if you are launching EC2-Classic instances.
", - "CreateLaunchConfigurationType$InstanceType": "Specifies the instance type of the EC2 instance.
For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.
If you do not specify InstanceId, you must specify InstanceType.
Specifies the instance type of the EC2 instance.
For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.
If you do not specify InstanceId, you must specify InstanceType.
The ID of the kernel associated with the AMI.
", "CreateLaunchConfigurationType$RamdiskId": "The ID of the RAM disk to select.
", "DeleteAutoScalingGroupType$AutoScalingGroupName": "The name of the Auto Scaling group.
", @@ -1794,7 +1794,7 @@ "LaunchConfiguration$ImageId": "The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.
", "LaunchConfiguration$KeyName": "The name of the key pair.
For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
", "LaunchConfiguration$ClassicLinkVPCId": "The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
", - "LaunchConfiguration$InstanceType": "The instance type for the instances.
For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.
", + "LaunchConfiguration$InstanceType": "The instance type for the instances.
For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.
", "LaunchConfiguration$KernelId": "The ID of the kernel associated with the AMI.
", "LaunchConfiguration$RamdiskId": "The ID of the RAM disk associated with the AMI.
", "LaunchConfigurationNameType$LaunchConfigurationName": "The name of the launch configuration.
", @@ -1857,7 +1857,7 @@ "base": null, "refs": { "AutoScalingGroup$HealthCheckType": "The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.
The lifecycle state for the instance.
", + "AutoScalingInstanceDetails$LifecycleState": "The lifecycle state for the instance. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.
Valid Values: Pending | Pending:Wait | Pending:Proceed | Quarantined | InService | Terminating | Terminating:Wait | Terminating:Proceed | Terminated | Detaching | Detached | EnteringStandby | Standby
The last reported health status of this instance. \"Healthy\" means that the instance is healthy and should remain in service. \"Unhealthy\" means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.
", "AutoScalingInstanceDetails$WeightedCapacity": "The number of capacity units contributed by the instance based on its instance type.
Valid Range: Minimum value of 1. Maximum value of 999.
", "CreateAutoScalingGroupType$HealthCheckType": "The service to use for the health checks. The valid values are EC2 (default) and ELB. If you configure an Auto Scaling group to use load balancer (ELB) health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks. For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.
The Base64-encoded user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data in the Amazon EC2 User Guide for Linux Instances.
", - "LaunchConfiguration$UserData": "The Base64-encoded user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data in the Amazon EC2 User Guide for Linux Instances.
" + "CreateLaunchConfigurationType$UserData": "The user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.
", + "LaunchConfiguration$UserData": "The user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.
" } } } diff --git a/models/apis/transfer/2018-11-05/api-2.json b/models/apis/transfer/2018-11-05/api-2.json index 94b3428fba2..273fca1ec71 100644 --- a/models/apis/transfer/2018-11-05/api-2.json +++ b/models/apis/transfer/2018-11-05/api-2.json @@ -359,6 +359,7 @@ "type":"structure", "members":{ "Certificate":{"shape":"Certificate"}, + "Domain":{"shape":"Domain"}, "EndpointDetails":{"shape":"EndpointDetails"}, "EndpointType":{"shape":"EndpointType"}, "HostKey":{"shape":"HostKey"}, @@ -389,6 +390,7 @@ "HomeDirectoryType":{"shape":"HomeDirectoryType"}, "HomeDirectoryMappings":{"shape":"HomeDirectoryMappings"}, "Policy":{"shape":"Policy"}, + "PosixProfile":{"shape":"PosixProfile"}, "Role":{"shape":"Role"}, "ServerId":{"shape":"ServerId"}, "SshPublicKeyBody":{"shape":"SshPublicKeyBody"}, @@ -507,6 +509,7 @@ "members":{ "Arn":{"shape":"Arn"}, "Certificate":{"shape":"Certificate"}, + "Domain":{"shape":"Domain"}, "EndpointDetails":{"shape":"EndpointDetails"}, "EndpointType":{"shape":"EndpointType"}, "HostKeyFingerprint":{"shape":"HostKeyFingerprint"}, @@ -530,12 +533,20 @@ "HomeDirectoryMappings":{"shape":"HomeDirectoryMappings"}, "HomeDirectoryType":{"shape":"HomeDirectoryType"}, "Policy":{"shape":"Policy"}, + "PosixProfile":{"shape":"PosixProfile"}, "Role":{"shape":"Role"}, "SshPublicKeys":{"shape":"SshPublicKeys"}, "Tags":{"shape":"Tags"}, "UserName":{"shape":"UserName"} } }, + "Domain":{ + "type":"string", + "enum":[ + "S3", + "EFS" + ] + }, "EndpointDetails":{ "type":"structure", "members":{ @@ -728,6 +739,7 @@ "required":["Arn"], "members":{ "Arn":{"shape":"Arn"}, + "Domain":{"shape":"Domain"}, "IdentityProviderType":{"shape":"IdentityProviderType"}, "EndpointType":{"shape":"EndpointType"}, "LoggingRole":{"shape":"Role"}, @@ -786,6 +798,23 @@ "type":"string", "max":2048 }, + "PosixId":{ + "type":"long", + "max":4294967295, + "min":0 + }, + "PosixProfile":{ + "type":"structure", + "required":[ + "Uid", + "Gid" + ], + "members":{ + "Uid":{"shape":"PosixId"}, + "Gid":{"shape":"PosixId"}, + "SecondaryGids":{"shape":"SecondaryGids"} + } + }, "Protocol":{ "type":"string", "enum":[ @@ -838,6 +867,12 @@ "min":20, "pattern":"arn:.*role/.*" }, + "SecondaryGids":{ + "type":"list", + "member":{"shape":"PosixId"}, + "max":16, + "min":0 + }, "SecurityGroupId":{ "type":"string", "max":20, @@ -1067,6 +1102,7 @@ "HomeDirectoryType":{"shape":"HomeDirectoryType"}, "HomeDirectoryMappings":{"shape":"HomeDirectoryMappings"}, "Policy":{"shape":"Policy"}, + "PosixProfile":{"shape":"PosixProfile"}, "Role":{"shape":"Role"}, "ServerId":{"shape":"ServerId"}, "UserName":{"shape":"UserName"} diff --git a/models/apis/transfer/2018-11-05/docs-2.json b/models/apis/transfer/2018-11-05/docs-2.json index 78b364947f2..d6e60bfcd74 100644 --- a/models/apis/transfer/2018-11-05/docs-2.json +++ b/models/apis/transfer/2018-11-05/docs-2.json @@ -156,6 +156,14 @@ "DescribeUserResponse$User": "An array containing the properties of the user account for the ServerID value that you specified.
The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
Allows you to supply a scope-down policy for your user so you can use the same IAM role across multiple users. The policy scopes down user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see Creating a scope-down policy.
For more information, see AssumeRole in the AWS Security Token Service API Reference.
The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
" } }, + "SecondaryGids": { + "base": null, + "refs": { + "PosixProfile$SecondaryGids": null + } + }, "SecurityGroupId": { "base": null, "refs": { diff --git a/service/autoscaling/api.go b/service/autoscaling/api.go index e049b13a5e8..b32db3ee720 100644 --- a/service/autoscaling/api.go +++ b/service/autoscaling/api.go @@ -727,6 +727,9 @@ func (c *AutoScaling) CreateAutoScalingGroupRequest(input *CreateAutoScalingGrou // CreateAutoScalingGroup API operation for Auto Scaling. // +// We strongly recommend using a launch template when calling this operation +// to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. +// // Creates an Auto Scaling group with the specified name and attributes. // // If you exceed your maximum limit of Auto Scaling groups, the call fails. @@ -5600,6 +5603,9 @@ func (c *AutoScaling) UpdateAutoScalingGroupRequest(input *UpdateAutoScalingGrou // UpdateAutoScalingGroup API operation for Auto Scaling. // +// We strongly recommend that all Auto Scaling groups use launch templates to +// ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. +// // Updates the configuration for the specified Auto Scaling group. // // To update an Auto Scaling group, specify the name of the group and the parameter @@ -6572,8 +6578,8 @@ type CreateAutoScalingGroupInput struct { // or InstanceId). LaunchConfigurationName *string `min:"1" type:"string"` - // Parameters used to specify the launch template (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) - // and version to use to launch instances. + // Parameters used to specify the launch template and version to use to launch + // instances. // // Conditional: You must specify either a launch template (LaunchTemplate or // MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName @@ -7089,9 +7095,12 @@ type CreateLaunchConfigurationInput struct { // running instances is higher than the current Spot price. SpotPrice *string `min:"1" type:"string"` - // The Base64-encoded user data to make available to the launched EC2 instances. - // For more information, see Instance metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) - // in the Amazon EC2 User Guide for Linux Instances. + // The user data to make available to the launched EC2 instances. For more information, + // see Instance metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) + // (Linux) and Instance metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html) + // (Windows). If you are using a command line tool, base64-encoding is performed + // for you, and you can load the text from a file. Otherwise, you must provide + // base64-encoded text. User data is limited to 16 KB. UserData *string `type:"string"` } @@ -10651,7 +10660,8 @@ type Instance struct { LaunchTemplate *LaunchTemplateSpecification `type:"structure"` // A description of the current lifecycle state. The Quarantined state is not - // used. + // used. For information about lifecycle states, see Instance lifecycle (https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html) + // in the Amazon EC2 Auto Scaling User Guide. // // LifecycleState is a required field LifecycleState *string `type:"string" required:"true" enum:"LifecycleState"` @@ -10770,7 +10780,13 @@ type InstanceDetails struct { // The launch template for the instance. LaunchTemplate *LaunchTemplateSpecification `type:"structure"` - // The lifecycle state for the instance. + // The lifecycle state for the instance. The Quarantined state is not used. + // For information about lifecycle states, see Instance lifecycle (https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html) + // in the Amazon EC2 Auto Scaling User Guide. + // + // Valid Values: Pending | Pending:Wait | Pending:Proceed | Quarantined | InService + // | Terminating | Terminating:Wait | Terminating:Proceed | Terminated | Detaching + // | Detached | EnteringStandby | Standby // // LifecycleState is a required field LifecycleState *string `min:"1" type:"string" required:"true"` @@ -10875,8 +10891,6 @@ type InstanceMetadataOptions struct { // larger the number, the further instance metadata requests can travel. // // Default: 1 - // - // Possible values: Integers from 1 to 64 HttpPutResponseHopLimit *int64 `min:"1" type:"integer"` // The state of token usage for your instance metadata requests. If the parameter @@ -11294,9 +11308,12 @@ type LaunchConfiguration struct { // in the Amazon EC2 Auto Scaling User Guide. SpotPrice *string `min:"1" type:"string"` - // The Base64-encoded user data to make available to the launched EC2 instances. - // For more information, see Instance metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) - // in the Amazon EC2 User Guide for Linux Instances. + // The user data to make available to the launched EC2 instances. For more information, + // see Instance metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) + // (Linux) and Instance metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html) + // (Windows). If you are using a command line tool, base64-encoding is performed + // for you, and you can load the text from a file. Otherwise, you must provide + // base64-encoded text. User data is limited to 16 KB. UserData *string `type:"string"` } @@ -11498,8 +11515,10 @@ func (s *LaunchTemplate) SetOverrides(v []*LaunchTemplateOverrides) *LaunchTempl } // Describes an override for a launch template. The maximum number of instance -// types that can be associated with an Auto Scaling group is 20. For more information, -// see Configuring overrides (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-override-options.html) +// types that can be associated with an Auto Scaling group is 40. The maximum +// number of distinct launch templates you can define for an Auto Scaling group +// is 20. For more information about configuring overrides, see Configuring +// overrides (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-override-options.html) // in the Amazon EC2 Auto Scaling User Guide. type LaunchTemplateOverrides struct { _ struct{} `type:"structure"` diff --git a/service/autoscalingplans/api.go b/service/autoscalingplans/api.go index da115a42b19..ea7f35a5552 100644 --- a/service/autoscalingplans/api.go +++ b/service/autoscalingplans/api.go @@ -672,11 +672,17 @@ type CreateScalingPlanInput struct { // A CloudFormation stack or set of tags. You can create one scaling plan per // application source. // + // For more information, see ApplicationSource (https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ApplicationSource.html) + // in the AWS Auto Scaling API Reference. + // // ApplicationSource is a required field ApplicationSource *ApplicationSource `type:"structure" required:"true"` // The scaling instructions. // + // For more information, see ScalingInstruction (https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html) + // in the AWS Auto Scaling API Reference. + // // ScalingInstructions is a required field ScalingInstructions []*ScalingInstruction `type:"list" required:"true"` @@ -755,9 +761,8 @@ func (s *CreateScalingPlanInput) SetScalingPlanName(v string) *CreateScalingPlan type CreateScalingPlanOutput struct { _ struct{} `type:"structure"` - // The version number of the scaling plan. This value is always 1. - // - // Currently, you cannot specify multiple scaling plan versions. + // The version number of the scaling plan. This value is always 1. Currently, + // you cannot have multiple scaling plan versions. // // ScalingPlanVersion is a required field ScalingPlanVersion *int64 `type:"long" required:"true"` @@ -784,8 +789,7 @@ func (s *CreateScalingPlanOutput) SetScalingPlanVersion(v int64) *CreateScalingP // // For predictive scaling to work with a customized load metric specification, // AWS Auto Scaling needs access to the Sum and Average statistics that CloudWatch -// computes from metric data. Statistics are calculations used to aggregate -// data over specified time periods. +// computes from metric data. // // When you choose a load metric, make sure that the required Sum and Average // statistics for your metric are available in CloudWatch and that they provide @@ -797,9 +801,20 @@ func (s *CreateScalingPlanOutput) SetScalingPlanVersion(v int64) *CreateScalingP // group, then the Average statistic for the specified metric must represent // the average request count processed by each instance of the group. // +// If you publish your own metrics, you can aggregate the data points at a given +// interval and then publish the aggregated data points to CloudWatch. Before +// AWS Auto Scaling generates the forecast, it sums up all the metric data points +// that occurred within each hour to match the granularity period that is used +// in the forecast (60 minutes). +// // For information about terminology, available metrics, or how to publish new // metrics, see Amazon CloudWatch Concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) // in the Amazon CloudWatch User Guide. +// +// After creating your scaling plan, you can use the AWS Auto Scaling console +// to visualize forecasts for the specified metric. For more information, see +// View Scaling Information for a Resource (https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource) +// in the AWS Auto Scaling User Guide. type CustomizedLoadMetricSpecification struct { _ struct{} `type:"structure"` @@ -819,7 +834,7 @@ type CustomizedLoadMetricSpecification struct { // Namespace is a required field Namespace *string `type:"string" required:"true"` - // The statistic of the metric. Currently, the value must always be Sum. + // The statistic of the metric. The only valid value is Sum. // // Statistic is a required field Statistic *string `type:"string" required:"true" enum:"MetricStatistic"` @@ -913,7 +928,9 @@ func (s *CustomizedLoadMetricSpecification) SetUnit(v string) *CustomizedLoadMet // number of capacity units. That is, the value of the metric should decrease // when capacity increases. // -// For more information about CloudWatch, see Amazon CloudWatch Concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html). +// For information about terminology, available metrics, or how to publish new +// metrics, see Amazon CloudWatch Concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) +// in the Amazon CloudWatch User Guide. type CustomizedScalingMetricSpecification struct { _ struct{} `type:"structure"` @@ -1052,7 +1069,8 @@ type DeleteScalingPlanInput struct { // ScalingPlanName is a required field ScalingPlanName *string `min:"1" type:"string" required:"true"` - // The version number of the scaling plan. + // The version number of the scaling plan. Currently, the only valid value is + // 1. // // ScalingPlanVersion is a required field ScalingPlanVersion *int64 `type:"long" required:"true"` @@ -1128,7 +1146,8 @@ type DescribeScalingPlanResourcesInput struct { // ScalingPlanName is a required field ScalingPlanName *string `min:"1" type:"string" required:"true"` - // The version number of the scaling plan. + // The version number of the scaling plan. Currently, the only valid value is + // 1. // // ScalingPlanVersion is a required field ScalingPlanVersion *int64 `type:"long" required:"true"` @@ -1238,8 +1257,11 @@ type DescribeScalingPlansInput struct { // you cannot specify scaling plan names. ScalingPlanNames []*string `type:"list"` - // The version number of the scaling plan. If you specify a scaling plan version, - // you must also specify a scaling plan name. + // The version number of the scaling plan. Currently, the only valid value is + // 1. + // + // If you specify a scaling plan version, you must also specify a scaling plan + // name. ScalingPlanVersion *int64 `type:"long"` } @@ -1366,31 +1388,14 @@ type GetScalingPlanResourceForecastDataInput struct { // ForecastDataType is a required field ForecastDataType *string `type:"string" required:"true" enum:"ForecastDataType"` - // 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. + // The ID of the resource. This string consists of a prefix (autoScalingGroup) + // followed by the name of a specified Auto Scaling group (my-asg). Example: + // autoScalingGroup/my-asg. // // ResourceId is a required field ResourceId *string `type:"string" required:"true"` - // The scalable dimension for the resource. + // The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity. // // ScalableDimension is a required field ScalableDimension *string `type:"string" required:"true" enum:"ScalableDimension"` @@ -1400,12 +1405,13 @@ type GetScalingPlanResourceForecastDataInput struct { // ScalingPlanName is a required field ScalingPlanName *string `min:"1" type:"string" required:"true"` - // The version number of the scaling plan. + // The version number of the scaling plan. Currently, the only valid value is + // 1. // // ScalingPlanVersion is a required field ScalingPlanVersion *int64 `type:"long" required:"true"` - // The namespace of the AWS service. + // The namespace of the AWS service. The only valid value is autoscaling. // // ServiceNamespace is a required field ServiceNamespace *string `type:"string" required:"true" enum:"ServiceNamespace"` @@ -1816,6 +1822,11 @@ func (s *ObjectNotFoundException) RequestID() string { } // Represents a predefined metric that can be used for predictive scaling. +// +// After creating your scaling plan, you can use the AWS Auto Scaling console +// to visualize forecasts for the specified metric. For more information, see +// View Scaling Information for a Resource (https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource) +// in the AWS Auto Scaling User Guide. type PredefinedLoadMetricSpecification struct { _ struct{} `type:"structure"` @@ -1825,18 +1836,28 @@ type PredefinedLoadMetricSpecification struct { PredefinedLoadMetricType *string `type:"string" required:"true" enum:"LoadMetricType"` // Identifies the resource associated with the metric type. You can't specify - // a resource label unless the metric type is ALBRequestCountPerTarget and there - // is a target group for an Application Load Balancer attached to the Auto Scaling - // group. + // a resource label unless the metric type is ALBTargetGroupRequestCount and + // there is a target group for an Application Load Balancer attached to the + // Auto Scaling group. // - // The format is app/