Skip to content

Commit 59bf88e

Browse files
author
awstools
committed
docs(client-auto-scaling): Documentation update for Amazon EC2 Auto Scaling.
1 parent 6892bb9 commit 59bf88e

22 files changed

+487
-436
lines changed

‎clients/client-auto-scaling/README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,9 @@ AWS SDK for JavaScript AutoScaling Client for Node.js, Browser and React Native.
1111

1212
<fullname>Amazon EC2 Auto Scaling</fullname>
1313

14-
<p>Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances
14+
<p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
1515
based on user-defined scaling policies, scheduled actions, and health checks.</p>
16-
<p>For more information about Amazon EC2 Auto Scaling, see the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html">Amazon EC2 Auto Scaling User Guide</a>. For information about granting IAM users required
17-
permissions for calls to Amazon EC2 Auto Scaling, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/ec2-auto-scaling-api-permissions.html">Granting
18-
IAM users required permissions for Amazon EC2 Auto Scaling resources</a> in the
19-
<i>Amazon EC2 Auto Scaling API Reference</i>.</p>
16+
<p>For more information, see the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/">Amazon EC2 Auto Scaling User Guide</a> and the <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/Welcome.html">Amazon EC2 Auto Scaling API Reference</a>.</p>
2017

2118
## Installing
2219

‎clients/client-auto-scaling/src/AutoScaling.ts

Lines changed: 61 additions & 51 deletions
Large diffs are not rendered by default.

‎clients/client-auto-scaling/src/AutoScalingClient.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -532,12 +532,13 @@ export interface AutoScalingClientResolvedConfig extends AutoScalingClientResolv
532532
*
533533
*
534534
*
535-
* <p>Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances
535+
*
536+
*
537+
*
538+
*
539+
* <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
536540
* based on user-defined scaling policies, scheduled actions, and health checks.</p>
537-
* <p>For more information about Amazon EC2 Auto Scaling, see the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html">Amazon EC2 Auto Scaling User Guide</a>. For information about granting IAM users required
538-
* permissions for calls to Amazon EC2 Auto Scaling, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/ec2-auto-scaling-api-permissions.html">Granting
539-
* IAM users required permissions for Amazon EC2 Auto Scaling resources</a> in the
540-
* <i>Amazon EC2 Auto Scaling API Reference</i>.</p>
541+
* <p>For more information, see the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/">Amazon EC2 Auto Scaling User Guide</a> and the <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/Welcome.html">Amazon EC2 Auto Scaling API Reference</a>.</p>
541542
*/
542543
export class AutoScalingClient extends __Client<
543544
__HttpHandlerOptions,

‎clients/client-auto-scaling/src/commands/AttachLoadBalancerTargetGroupsCommand.ts

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,24 @@ export interface AttachLoadBalancerTargetGroupsCommandOutput
2929
* <p>This operation is used with the following load balancer types: </p>
3030
* <ul>
3131
* <li>
32-
* <p> Application Load Balancer - Operates at the application layer (layer 7) and
33-
* supports HTTP and HTTPS. </p>
32+
* <p>Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and
33+
* HTTPS. </p>
3434
* </li>
3535
* <li>
36-
* <p> Network Load Balancer - Operates at the transport layer (layer 4) and
37-
* supports TCP, TLS, and UDP. </p>
36+
* <p>Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and
37+
* UDP. </p>
3838
* </li>
3939
* <li>
40-
* <p> Gateway Load Balancer - Operates at the network layer (layer 3).</p>
40+
* <p>Gateway Load Balancer - Operates at the network layer (layer 3).</p>
4141
* </li>
4242
* </ul>
4343
* <p>To describe the target groups for an Auto Scaling group, call the <a>DescribeLoadBalancerTargetGroups</a> API. To detach the target group from
4444
* the Auto Scaling group, call the <a>DetachLoadBalancerTargetGroups</a> API.</p>
4545
* <p>This operation is additive and does not detach existing target groups or Classic Load
4646
* Balancers from the Auto Scaling group.</p>
47-
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html">Elastic Load Balancing and
48-
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p>
47+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html">Use Elastic Load Balancing to
48+
* distribute traffic across the instances in your Auto Scaling group</a> in the
49+
* <i>Amazon EC2 Auto Scaling User Guide</i>. </p>
4950
* @example
5051
* Use a bare-bones client and the command you need to make an API call.
5152
* ```javascript

‎clients/client-auto-scaling/src/commands/AttachLoadBalancersCommand.ts

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,17 @@ export interface AttachLoadBalancersCommandOutput extends AttachLoadBalancersRes
2424

2525
/**
2626
* <note>
27-
* <p>To attach an Application Load Balancer, Network Load Balancer, or Gateway Load
28-
* Balancer, use the <a>AttachLoadBalancerTargetGroups</a> API operation
29-
* instead.</p>
27+
* <p>To attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer, use the <a>AttachLoadBalancerTargetGroups</a> API operation instead.</p>
3028
* </note>
31-
* <p>Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling
32-
* registers the running instances with these Classic Load Balancers.</p>
33-
* <p>To describe the load balancers for an Auto Scaling group, call the <a>DescribeLoadBalancers</a> API. To detach the load balancer from the Auto Scaling
29+
* <p>Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the
30+
* running instances with these Classic Load Balancers.</p>
31+
* <p>To describe the load balancers for an Auto Scaling group, call the <a>DescribeLoadBalancers</a> API. To detach a load balancer from the Auto Scaling
3432
* group, call the <a>DetachLoadBalancers</a> API.</p>
3533
* <p>This operation is additive and does not detach existing Classic Load Balancers or
3634
* target groups from the Auto Scaling group.</p>
37-
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html">Elastic Load Balancing and
38-
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p>
35+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html">Use Elastic Load Balancing to
36+
* distribute traffic across the instances in your Auto Scaling group</a> in the
37+
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3938
* @example
4039
* Use a bare-bones client and the command you need to make an API call.
4140
* ```javascript

‎clients/client-auto-scaling/src/commands/CreateAutoScalingGroupCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ export interface CreateAutoScalingGroupCommandOutput extends __MetadataBearer {}
2929
* <p>Creates an Auto Scaling group with the specified name and attributes. </p>
3030
* <p>If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,
3131
* call the <a>DescribeAccountLimits</a> API. For information about updating
32-
* this limit, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html">Amazon EC2 Auto Scaling service
33-
* quotas</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
32+
* this limit, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html">Quotas for
33+
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3434
* <p>For introductory exercises for creating an Auto Scaling group, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/GettingStartedTutorial.html">Getting started with
3535
* Amazon EC2 Auto Scaling</a> and <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-register-lbs-with-asg.html">Tutorial: Set up a
3636
* scaled and load-balanced application</a> in the
3737
* <i>Amazon EC2 Auto Scaling User Guide</i>. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html">Auto Scaling
3838
* groups</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
39-
* <p>Every Auto Scaling group has three size parameters (<code>DesiredCapacity</code>,
39+
* <p>Every Auto Scaling group has three size properties (<code>DesiredCapacity</code>,
4040
* <code>MaxSize</code>, and <code>MinSize</code>). Usually, you set these sizes based
4141
* on a specific number of instances. However, if you configure a mixed instances policy
4242
* that defines weights for the instance types, you must specify these sizes with the same

‎clients/client-auto-scaling/src/commands/CreateLaunchConfigurationCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ export interface CreateLaunchConfigurationCommandOutput extends __MetadataBearer
2626
* <p>Creates a launch configuration.</p>
2727
* <p>If you exceed your maximum limit of launch configurations, the call fails. To query
2828
* this limit, call the <a>DescribeAccountLimits</a> API. For information about
29-
* updating this limit, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html">Amazon EC2 Auto Scaling service
30-
* quotas</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
29+
* updating this limit, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html">Quotas for
30+
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3131
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html">Launch
3232
* configurations</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3333
* @example

‎clients/client-auto-scaling/src/commands/CreateOrUpdateTagsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export interface CreateOrUpdateTagsCommandOutput extends __MetadataBearer {}
2626
* <p>Creates or updates tags for the specified Auto Scaling group.</p>
2727
* <p>When you specify a tag with a key that already exists, the operation overwrites the
2828
* previous tag definition, and you do not get an error message.</p>
29-
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html">Tagging Auto Scaling groups and
29+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html">Tag Auto Scaling groups and
3030
* instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-auto-scaling/src/commands/DescribeAccountLimitsCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ export interface DescribeAccountLimitsCommandOutput extends DescribeAccountLimit
2626
* <p>Describes the current Amazon EC2 Auto Scaling resource quotas for your account.</p>
2727
* <p>When you establish an Amazon Web Services account, the account has initial quotas on the maximum
2828
* number of Auto Scaling groups and launch configurations that you can create in a given Region.
29-
* For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html">Amazon EC2 Auto Scaling service
30-
* quotas</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
29+
* For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html">Quotas for
30+
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.
3333
* ```javascript

‎clients/client-auto-scaling/src/commands/DescribeLoadBalancerTargetGroupsCommand.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,8 @@ export interface DescribeLoadBalancerTargetGroupsCommandOutput
2525
__MetadataBearer {}
2626

2727
/**
28-
* <p>Gets information about the load balancer target groups for the specified Auto Scaling
29-
* group.</p>
30-
* <p>To determine the availability of registered instances, use the <code>State</code>
28+
* <p>Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.</p>
29+
* <p>To determine the attachment status of the target group, use the <code>State</code>
3130
* element in the response. When you attach a target group to an Auto Scaling group, the initial
3231
* <code>State</code> value is <code>Adding</code>. The state transitions to
3332
* <code>Added</code> after all Auto Scaling instances are registered with the target group. If
@@ -43,8 +42,9 @@ export interface DescribeLoadBalancerTargetGroupsCommandOutput
4342
* necessary.</p>
4443
* <p>For help with failed health checks, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ts-as-healthchecks.html">Troubleshooting Amazon EC2 Auto Scaling:
4544
* Health checks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. For more
46-
* information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html">Elastic Load Balancing and
47-
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p>
45+
* information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html">Use Elastic Load Balancing to
46+
* distribute traffic across the instances in your Auto Scaling group</a> in the
47+
* <i>Amazon EC2 Auto Scaling User Guide</i>. </p>
4848
* @example
4949
* Use a bare-bones client and the command you need to make an API call.
5050
* ```javascript

‎clients/client-auto-scaling/src/commands/DescribeLoadBalancersCommand.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ export interface DescribeLoadBalancersCommandOutput extends DescribeLoadBalancer
2424

2525
/**
2626
* <p>Gets information about the load balancers for the specified Auto Scaling group.</p>
27-
* <p>This operation describes only Classic Load Balancers. If you have Application Load
28-
* Balancers, Network Load Balancers, or Gateway Load Balancers, use the <a>DescribeLoadBalancerTargetGroups</a> API instead.</p>
29-
* <p>To determine the availability of registered instances, use the <code>State</code>
27+
* <p>This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancer, use the
28+
* <a>DescribeLoadBalancerTargetGroups</a> API instead.</p>
29+
* <p>To determine the attachment status of the load balancer, use the <code>State</code>
3030
* element in the response. When you attach a load balancer to an Auto Scaling group, the initial
3131
* <code>State</code> value is <code>Adding</code>. The state transitions to
3232
* <code>Added</code> after all Auto Scaling instances are registered with the load balancer.
@@ -43,8 +43,9 @@ export interface DescribeLoadBalancersCommandOutput extends DescribeLoadBalancer
4343
* necessary.</p>
4444
* <p>For help with failed health checks, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ts-as-healthchecks.html">Troubleshooting Amazon EC2 Auto Scaling:
4545
* Health checks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. For more
46-
* information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html">Elastic Load Balancing and
47-
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p>
46+
* information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html">Use Elastic Load Balancing to
47+
* distribute traffic across the instances in your Auto Scaling group</a> in the
48+
* <i>Amazon EC2 Auto Scaling User Guide</i>. </p>
4849
* @example
4950
* Use a bare-bones client and the command you need to make an API call.
5051
* ```javascript

‎clients/client-auto-scaling/src/commands/DescribeMetricCollectionTypesCommand.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@ export interface DescribeMetricCollectionTypesCommandOutput
2626

2727
/**
2828
* <p>Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.</p>
29-
* <p>The <code>GroupStandbyInstances</code> metric is not returned by default. You must
30-
* explicitly request this metric when calling the <a>EnableMetricsCollection</a> API.</p>
3129
* @example
3230
* Use a bare-bones client and the command you need to make an API call.
3331
* ```javascript

‎clients/client-auto-scaling/src/commands/DescribeTagsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export interface DescribeTagsCommandOutput extends TagsType, __MetadataBearer {}
2727
* <p>You can also specify multiple filters. The result includes information for a
2828
* particular tag only if it matches all the filters. If there's no match, no special
2929
* message is returned.</p>
30-
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html">Tagging Auto Scaling groups and
30+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html">Tag Auto Scaling groups and
3131
* instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-auto-scaling/src/commands/DescribeTerminationPolicyTypesCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ export interface DescribeTerminationPolicyTypesCommandOutput
2626

2727
/**
2828
* <p>Describes the termination policies supported by Amazon EC2 Auto Scaling.</p>
29-
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html">Controlling which Auto Scaling
30-
* instances terminate during scale in</a> in the
31-
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
29+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html">Work with
30+
* Amazon EC2 Auto Scaling termination policies</a> in the
31+
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

‎clients/client-auto-scaling/src/commands/DetachLoadBalancerTargetGroupsCommand.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ export interface DetachLoadBalancerTargetGroupsCommandOutput
2626

2727
/**
2828
* <p>Detaches one or more target groups from the specified Auto Scaling group.</p>
29+
* <p>When you detach a target group, it enters the <code>Removing</code> state while
30+
* deregistering the instances in the group. When all instances are deregistered, then you
31+
* can no longer describe the target group using the <a>DescribeLoadBalancerTargetGroups</a> API call. The instances remain
32+
* running.</p>
2933
* @example
3034
* Use a bare-bones client and the command you need to make an API call.
3135
* ```javascript

‎clients/client-auto-scaling/src/commands/DetachLoadBalancersCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ export interface DetachLoadBalancersCommandOutput extends DetachLoadBalancersRes
2424

2525
/**
2626
* <p>Detaches one or more Classic Load Balancers from the specified Auto Scaling group.</p>
27-
* <p>This operation detaches only Classic Load Balancers. If you have Application Load
28-
* Balancers, Network Load Balancers, or Gateway Load Balancers, use the <a>DetachLoadBalancerTargetGroups</a> API instead.</p>
27+
* <p>This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or
28+
* Gateway Load Balancer, use the <a>DetachLoadBalancerTargetGroups</a> API instead.</p>
2929
* <p>When you detach a load balancer, it enters the <code>Removing</code> state while
3030
* deregistering the instances in the group. When all instances are deregistered, then you
3131
* can no longer describe the load balancer using the <a>DescribeLoadBalancers</a> API call. The instances remain running.</p>

0 commit comments

Comments
 (0)