From a1a1f67ff0e1e99f7f41232450c0b31ca83e72f8 Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 1 Mar 2024 19:12:44 +0000 Subject: [PATCH] docs(client-auto-scaling): With this release, Amazon EC2 Auto Scaling groups, EC2 Fleet, and Spot Fleet improve the default price protection behavior of attribute-based instance type selection of Spot Instances, to consistently select from a wide range of instance types. --- .../commands/CreateAutoScalingGroupCommand.ts | 7 ++--- .../src/models/models_0.ts | 28 ++++++++++--------- .../sdk-codegen/aws-models/auto-scaling.json | 12 ++++---- 3 files changed, 23 insertions(+), 24 deletions(-) diff --git a/clients/client-auto-scaling/src/commands/CreateAutoScalingGroupCommand.ts b/clients/client-auto-scaling/src/commands/CreateAutoScalingGroupCommand.ts index 24e79c4ae83d..40840c6bdd20 100644 --- a/clients/client-auto-scaling/src/commands/CreateAutoScalingGroupCommand.ts +++ b/clients/client-auto-scaling/src/commands/CreateAutoScalingGroupCommand.ts @@ -36,11 +36,8 @@ export interface CreateAutoScalingGroupCommandOutput extends __MetadataBearer {} * call the DescribeAccountLimits API. For information about updating * this limit, see Quotas for * Amazon EC2 Auto Scaling 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.

+ *

If you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started + * with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

*

Every Auto Scaling group has three size properties (DesiredCapacity, * MaxSize, and MinSize). Usually, you set these sizes based * on a specific number of instances. However, if you configure a mixed instances policy diff --git a/clients/client-auto-scaling/src/models/models_0.ts b/clients/client-auto-scaling/src/models/models_0.ts index 53897771c292..3604ea664205 100644 --- a/clients/client-auto-scaling/src/models/models_0.ts +++ b/clients/client-auto-scaling/src/models/models_0.ts @@ -1364,18 +1364,19 @@ export interface InstanceRequirements { * types or, failing that, the lowest priced previous generation instance types that match * your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will * exclude instance types whose price exceeds your specified threshold.

- *

The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

- *

To turn off price protection, specify a high value, such as 999999.

+ *

The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

*

If you set DesiredCapacityType to vcpu or * memory-mib, the price protection threshold is based on the per-vCPU or * per-memory price instead of the per instance price.

* *

Only one of SpotMaxPricePercentageOverLowestPrice or - * MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be - * specified.

+ * MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If + * you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection + * to consistently select from a wide range of instance types. To indicate no price + * protection threshold for Spot Instances, meaning you want to consider all instance + * types that match your attributes, include one of these parameters and specify a high + * value, such as 999999.

* - *

Default: 100 - *

*/ SpotMaxPricePercentageOverLowestPrice?: number; @@ -1390,16 +1391,17 @@ export interface InstanceRequirements { * your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will * exclude instance types whose price exceeds your specified threshold.

*

The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

- *

To indicate no price protection threshold, specify a high value, such as - * 999999.

*

If you set DesiredCapacityType to vcpu or * memory-mib, the price protection threshold is based on the per-vCPU or * per-memory price instead of the per instance price.

* *

Only one of SpotMaxPricePercentageOverLowestPrice or * MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If - * you don't specify either, then SpotMaxPricePercentageOverLowestPrice is - * used and the value for that parameter defaults to 100.

+ * you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection + * to consistently select from a wide range of instance types. To indicate no price + * protection threshold for Spot Instances, meaning you want to consider all instance + * types that match your attributes, include one of these parameters and specify a high + * value, such as 999999.

* */ MaxSpotPriceAsPercentageOfOptimalOnDemandPrice?: number; @@ -5961,7 +5963,7 @@ export interface ScalingPolicy { * * *

For more information, see Target tracking - * scaling policies and Step and simple scaling + * scaling policies and Step and simple scaling * policies in the Amazon EC2 Auto Scaling User Guide.

*/ PolicyType?: string; @@ -5986,7 +5988,7 @@ export interface ScalingPolicy { /** * @public *

The minimum value to scale by when the adjustment type is - * PercentChangeInCapacity.

+ * PercentChangeInCapacity.

*/ MinAdjustmentMagnitude?: number; @@ -6014,7 +6016,7 @@ export interface ScalingPolicy { /** * @public *

The aggregation type for the CloudWatch metrics. The valid values are Minimum, - * Maximum, and Average.

+ * Maximum, and Average.

*/ MetricAggregationType?: string; diff --git a/codegen/sdk-codegen/aws-models/auto-scaling.json b/codegen/sdk-codegen/aws-models/auto-scaling.json index 221405c3fa1f..db1764d5dbb9 100644 --- a/codegen/sdk-codegen/aws-models/auto-scaling.json +++ b/codegen/sdk-codegen/aws-models/auto-scaling.json @@ -2796,7 +2796,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Creates an Auto Scaling group with the specified name and attributes.

\n

If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

For introductory exercises for creating an Auto Scaling group, see Getting started with\n Amazon EC2 Auto Scaling and Tutorial: Set up a\n scaled and load-balanced application in the\n Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling\n groups in the Amazon EC2 Auto Scaling User Guide.

\n

Every Auto Scaling group has three size properties (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.

", + "smithy.api#documentation": "

\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Creates an Auto Scaling group with the specified name and attributes.

\n

If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

If you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started\n with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

Every Auto Scaling group has three size properties (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.

", "smithy.api#examples": [ { "title": "To create an Auto Scaling group", @@ -6652,13 +6652,13 @@ "SpotMaxPricePercentageOverLowestPrice": { "target": "com.amazonaws.autoscaling#NullablePositiveInteger", "traits": { - "smithy.api#documentation": "

[Price protection] The price protection threshold for Spot Instances, as a percentage\n higher than an identified Spot price. The identified Spot price is the price of the\n lowest priced current generation C, M, or R instance type with your specified\n attributes. If no current generation C, M, or R instance type matches your attributes,\n then the identified price is from either the lowest priced current generation instance\n types or, failing that, the lowest priced previous generation instance types that match\n your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will\n exclude instance types whose price exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per-vCPU or\n per-memory price instead of the per instance price.

\n \n

Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be\n specified.

\n \n

Default: 100\n

" + "smithy.api#documentation": "

[Price protection] The price protection threshold for Spot Instances, as a percentage\n higher than an identified Spot price. The identified Spot price is the price of the\n lowest priced current generation C, M, or R instance type with your specified\n attributes. If no current generation C, M, or R instance type matches your attributes,\n then the identified price is from either the lowest priced current generation instance\n types or, failing that, the lowest priced previous generation instance types that match\n your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will\n exclude instance types whose price exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

\n

If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per-vCPU or\n per-memory price instead of the per instance price.

\n \n

Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If\n you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection\n to consistently select from a wide range of instance types. To indicate no price\n protection threshold for Spot Instances, meaning you want to consider all instance\n types that match your attributes, include one of these parameters and specify a high\n value, such as 999999.

\n " } }, "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { "target": "com.amazonaws.autoscaling#NullablePositiveInteger", "traits": { - "smithy.api#documentation": "

[Price protection] The price protection threshold for Spot Instances, as a percentage\n of an identified On-Demand price. The identified On-Demand price is the price of the\n lowest priced current generation C, M, or R instance type with your specified\n attributes. If no current generation C, M, or R instance type matches your attributes,\n then the identified price is from either the lowest priced current generation instance\n types or, failing that, the lowest priced previous generation instance types that match\n your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will\n exclude instance types whose price exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

\n

To indicate no price protection threshold, specify a high value, such as\n 999999.

\n

If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per-vCPU or\n per-memory price instead of the per instance price.

\n \n

Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If\n you don't specify either, then SpotMaxPricePercentageOverLowestPrice is\n used and the value for that parameter defaults to 100.

\n " + "smithy.api#documentation": "

[Price protection] The price protection threshold for Spot Instances, as a percentage\n of an identified On-Demand price. The identified On-Demand price is the price of the\n lowest priced current generation C, M, or R instance type with your specified\n attributes. If no current generation C, M, or R instance type matches your attributes,\n then the identified price is from either the lowest priced current generation instance\n types or, failing that, the lowest priced previous generation instance types that match\n your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will\n exclude instance types whose price exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

\n

If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per-vCPU or\n per-memory price instead of the per instance price.

\n \n

Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If\n you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection\n to consistently select from a wide range of instance types. To indicate no price\n protection threshold for Spot Instances, meaning you want to consider all instance\n types that match your attributes, include one of these parameters and specify a high\n value, such as 999999.

\n " } }, "OnDemandMaxPricePercentageOverLowestPrice": { @@ -9608,7 +9608,7 @@ "PolicyType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { - "smithy.api#documentation": "

One of the following policy types:

\n \n

For more information, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

One of the following policy types:

\n \n

For more information, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.

" } }, "AdjustmentType": { @@ -9626,7 +9626,7 @@ "MinAdjustmentMagnitude": { "target": "com.amazonaws.autoscaling#MinAdjustmentMagnitude", "traits": { - "smithy.api#documentation": "

The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity.

" + "smithy.api#documentation": "

The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity.

" } }, "ScalingAdjustment": { @@ -9650,7 +9650,7 @@ "MetricAggregationType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "

The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average.

" + "smithy.api#documentation": "

The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average.

" } }, "EstimatedInstanceWarmup": {