There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# Actions for Auto Scaling using AWS SDKs
The following code examples demonstrate how to perform individual Auto Scaling actions with AWS SDKs. Each example includes a link to GitHub, where you can find instructions for setting up and running the code.
These excerpts call the Auto Scaling API and are code excerpts from larger programs that must be run in context. You can see actions in context in [Scenarios for Auto Scaling using AWS SDKs](auto-scaling_code_examples_scenarios.md).
The following examples include only the most commonly used actions. For a complete list, see the [Amazon EC2 Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/Welcome.html).
**Topics**
+ [`AttachInstances`](auto-scaling_example_auto-scaling_AttachInstances_section.md)
+ [`AttachLoadBalancerTargetGroups`](auto-scaling_example_auto-scaling_AttachLoadBalancerTargetGroups_section.md)
+ [`AttachLoadBalancers`](auto-scaling_example_auto-scaling_AttachLoadBalancers_section.md)
+ [`CompleteLifecycleAction`](auto-scaling_example_auto-scaling_CompleteLifecycleAction_section.md)
+ [`CreateAutoScalingGroup`](auto-scaling_example_auto-scaling_CreateAutoScalingGroup_section.md)
+ [`CreateLaunchConfiguration`](auto-scaling_example_auto-scaling_CreateLaunchConfiguration_section.md)
+ [`CreateOrUpdateTags`](auto-scaling_example_auto-scaling_CreateOrUpdateTags_section.md)
+ [`DeleteAutoScalingGroup`](auto-scaling_example_auto-scaling_DeleteAutoScalingGroup_section.md)
+ [`DeleteLaunchConfiguration`](auto-scaling_example_auto-scaling_DeleteLaunchConfiguration_section.md)
+ [`DeleteLifecycleHook`](auto-scaling_example_auto-scaling_DeleteLifecycleHook_section.md)
+ [`DeleteNotificationConfiguration`](auto-scaling_example_auto-scaling_DeleteNotificationConfiguration_section.md)
+ [`DeletePolicy`](auto-scaling_example_auto-scaling_DeletePolicy_section.md)
+ [`DeleteScheduledAction`](auto-scaling_example_auto-scaling_DeleteScheduledAction_section.md)
+ [`DeleteTags`](auto-scaling_example_auto-scaling_DeleteTags_section.md)
+ [`DescribeAccountLimits`](auto-scaling_example_auto-scaling_DescribeAccountLimits_section.md)
+ [`DescribeAdjustmentTypes`](auto-scaling_example_auto-scaling_DescribeAdjustmentTypes_section.md)
+ [`DescribeAutoScalingGroups`](auto-scaling_example_auto-scaling_DescribeAutoScalingGroups_section.md)
+ [`DescribeAutoScalingInstances`](auto-scaling_example_auto-scaling_DescribeAutoScalingInstances_section.md)
+ [`DescribeAutoScalingNotificationTypes`](auto-scaling_example_auto-scaling_DescribeAutoScalingNotificationTypes_section.md)
+ [`DescribeLaunchConfigurations`](auto-scaling_example_auto-scaling_DescribeLaunchConfigurations_section.md)
+ [`DescribeLifecycleHookTypes`](auto-scaling_example_auto-scaling_DescribeLifecycleHookTypes_section.md)
+ [`DescribeLifecycleHooks`](auto-scaling_example_auto-scaling_DescribeLifecycleHooks_section.md)
+ [`DescribeLoadBalancers`](auto-scaling_example_auto-scaling_DescribeLoadBalancers_section.md)
+ [`DescribeMetricCollectionTypes`](auto-scaling_example_auto-scaling_DescribeMetricCollectionTypes_section.md)
+ [`DescribeNotificationConfigurations`](auto-scaling_example_auto-scaling_DescribeNotificationConfigurations_section.md)
+ [`DescribePolicies`](auto-scaling_example_auto-scaling_DescribePolicies_section.md)
+ [`DescribeScalingActivities`](auto-scaling_example_auto-scaling_DescribeScalingActivities_section.md)
+ [`DescribeScalingProcessTypes`](auto-scaling_example_auto-scaling_DescribeScalingProcessTypes_section.md)
+ [`DescribeScheduledActions`](auto-scaling_example_auto-scaling_DescribeScheduledActions_section.md)
+ [`DescribeTags`](auto-scaling_example_auto-scaling_DescribeTags_section.md)
+ [`DescribeTerminationPolicyTypes`](auto-scaling_example_auto-scaling_DescribeTerminationPolicyTypes_section.md)
+ [`DetachInstances`](auto-scaling_example_auto-scaling_DetachInstances_section.md)
+ [`DetachLoadBalancers`](auto-scaling_example_auto-scaling_DetachLoadBalancers_section.md)
+ [`DisableMetricsCollection`](auto-scaling_example_auto-scaling_DisableMetricsCollection_section.md)
+ [`EnableMetricsCollection`](auto-scaling_example_auto-scaling_EnableMetricsCollection_section.md)
+ [`EnterStandby`](auto-scaling_example_auto-scaling_EnterStandby_section.md)
+ [`ExecutePolicy`](auto-scaling_example_auto-scaling_ExecutePolicy_section.md)
+ [`ExitStandby`](auto-scaling_example_auto-scaling_ExitStandby_section.md)
+ [`PutLifecycleHook`](auto-scaling_example_auto-scaling_PutLifecycleHook_section.md)
+ [`PutNotificationConfiguration`](auto-scaling_example_auto-scaling_PutNotificationConfiguration_section.md)
+ [`PutScalingPolicy`](auto-scaling_example_auto-scaling_PutScalingPolicy_section.md)
+ [`PutScheduledUpdateGroupAction`](auto-scaling_example_auto-scaling_PutScheduledUpdateGroupAction_section.md)
+ [`RecordLifecycleActionHeartbeat`](auto-scaling_example_auto-scaling_RecordLifecycleActionHeartbeat_section.md)
+ [`ResumeProcesses`](auto-scaling_example_auto-scaling_ResumeProcesses_section.md)
+ [`SetDesiredCapacity`](auto-scaling_example_auto-scaling_SetDesiredCapacity_section.md)
+ [`SetInstanceHealth`](auto-scaling_example_auto-scaling_SetInstanceHealth_section.md)
+ [`SetInstanceProtection`](auto-scaling_example_auto-scaling_SetInstanceProtection_section.md)
+ [`SuspendProcesses`](auto-scaling_example_auto-scaling_SuspendProcesses_section.md)
+ [`TerminateInstanceInAutoScalingGroup`](auto-scaling_example_auto-scaling_TerminateInstanceInAutoScalingGroup_section.md)
+ [`UpdateAutoScalingGroup`](auto-scaling_example_auto-scaling_UpdateAutoScalingGroup_section.md)
# Use `AttachInstances` with a CLI
The following code examples show how to use `AttachInstances`.
------
#### [ CLI ]
**AWS CLI**
**To attach an instance to an Auto Scaling group**
This example attaches the specified instance to the specified Auto Scaling group.
```
aws autoscaling attach-instances \
--instance-ids i-061c63c5eb45f0416 \
--auto-scaling-group-name my-asg
```
This command produces no output.
+ For API details, see [AttachInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/attach-instances.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example attaches the specified instance to the specified Auto Scaling group. Auto Scaling automatically increases the desired capacity of the Auto Scaling group.**
```
Mount-ASInstance -InstanceId i-93633f9b -AutoScalingGroupName my-asg
```
+ For API details, see [AttachInstances](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example attaches the specified instance to the specified Auto Scaling group. Auto Scaling automatically increases the desired capacity of the Auto Scaling group.**
```
Mount-ASInstance -InstanceId i-93633f9b -AutoScalingGroupName my-asg
```
+ For API details, see [AttachInstances](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `AttachLoadBalancerTargetGroups` with an AWS SDK or CLI
The following code examples show how to use `AttachLoadBalancerTargetGroups`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Build and manage a resilient service](auto-scaling_example_cross_ResilientService_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/cross-service/ResilientService/AutoScalerActions#code-examples).
```
///
/// Attaches an Elastic Load Balancing (ELB) target group to this EC2 Auto Scaling group.
/// The
///
/// The name of the Auto Scaling group.
/// The Arn for the target group.
/// Async task.
public async Task AttachLoadBalancerToGroup(string autoScalingGroupName, string targetGroupArn)
{
await _amazonAutoScaling.AttachLoadBalancerTargetGroupsAsync(
new AttachLoadBalancerTargetGroupsRequest()
{
AutoScalingGroupName = autoScalingGroupName,
TargetGroupARNs = new List() { targetGroupArn }
});
}
```
+ For API details, see [AttachLoadBalancerTargetGroups](https://docs.aws.amazon.com/goto/DotNetSDKV3/autoscaling-2011-01-01/AttachLoadBalancerTargetGroups) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To attach a target group to an Auto Scaling group**
This example attaches the specified target group to the specified Auto Scaling group.
```
aws autoscaling attach-load-balancer-target-groups \
--auto-scaling-group-name my-asg \
--target-group-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067
```
This command produces no output.
For more information, see [Elastic Load Balancing and Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [AttachLoadBalancerTargetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/attach-load-balancer-target-groups.html) in *AWS CLI Command Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/wkflw-resilient-service#code-examples).
```
const client = new AutoScalingClient({});
await client.send(
new AttachLoadBalancerTargetGroupsCommand({
AutoScalingGroupName: NAMES.autoScalingGroupName,
TargetGroupARNs: [state.targetGroupArn],
}),
);
```
+ For API details, see [AttachLoadBalancerTargetGroups](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/auto-scaling/command/AttachLoadBalancerTargetGroupsCommand) in *AWS SDK for JavaScript API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/auto-scaling#code-examples).
```
class AutoScalingWrapper:
"""
Encapsulates Amazon EC2 Auto Scaling and EC2 management actions.
"""
def __init__(
self,
resource_prefix: str,
inst_type: str,
ami_param: str,
autoscaling_client: boto3.client,
ec2_client: boto3.client,
ssm_client: boto3.client,
iam_client: boto3.client,
):
"""
Initializes the AutoScaler class with the necessary parameters.
:param resource_prefix: The prefix for naming AWS resources that are created by this class.
:param inst_type: The type of EC2 instance to create, such as t3.micro.
:param ami_param: The Systems Manager parameter used to look up the AMI that is created.
:param autoscaling_client: A Boto3 EC2 Auto Scaling client.
:param ec2_client: A Boto3 EC2 client.
:param ssm_client: A Boto3 Systems Manager client.
:param iam_client: A Boto3 IAM client.
"""
self.inst_type = inst_type
self.ami_param = ami_param
self.autoscaling_client = autoscaling_client
self.ec2_client = ec2_client
self.ssm_client = ssm_client
self.iam_client = iam_client
sts_client = boto3.client("sts")
self.account_id = sts_client.get_caller_identity()["Account"]
self.key_pair_name = f"{resource_prefix}-key-pair"
self.launch_template_name = f"{resource_prefix}-template-"
self.group_name = f"{resource_prefix}-group"
# Happy path
self.instance_policy_name = f"{resource_prefix}-pol"
self.instance_role_name = f"{resource_prefix}-role"
self.instance_profile_name = f"{resource_prefix}-prof"
# Failure mode
self.bad_creds_policy_name = f"{resource_prefix}-bc-pol"
self.bad_creds_role_name = f"{resource_prefix}-bc-role"
self.bad_creds_profile_name = f"{resource_prefix}-bc-prof"
def attach_load_balancer_target_group(
self, lb_target_group: Dict[str, Any]
) -> None:
"""
Attaches an Elastic Load Balancing (ELB) target group to this EC2 Auto Scaling group.
The target group specifies how the load balancer forwards requests to the instances
in the group.
:param lb_target_group: Data about the ELB target group to attach.
"""
try:
self.autoscaling_client.attach_load_balancer_target_groups(
AutoScalingGroupName=self.group_name,
TargetGroupARNs=[lb_target_group["TargetGroupArn"]],
)
log.info(
"Attached load balancer target group %s to auto scaling group %s.",
lb_target_group["TargetGroupName"],
self.group_name,
)
except ClientError as err:
error_code = err.response["Error"]["Code"]
log.error(
f"Failed to attach load balancer target group '{lb_target_group['TargetGroupName']}'."
)
if error_code == "ResourceContentionFault":
log.error(
"The request failed due to a resource contention issue. "
"Ensure that no conflicting operations are being performed on the resource."
)
elif error_code == "ServiceLinkedRoleFailure":
log.error(
"The operation failed because the service-linked role is not ready or does not exist. "
"Check that the service-linked role exists and is correctly configured."
)
log.error(f"Full error:\n\t{err}")
```
+ For API details, see [AttachLoadBalancerTargetGroups](https://docs.aws.amazon.com/goto/boto3/autoscaling-2011-01-01/AttachLoadBalancerTargetGroups) in *AWS SDK for Python (Boto3) API Reference*.
------
# Use `AttachLoadBalancers` with a CLI
The following code examples show how to use `AttachLoadBalancers`.
------
#### [ CLI ]
**AWS CLI**
**To attach a Classic Load Balancer to an Auto Scaling group**
This example attaches the specified Classic Load Balancer to the specified Auto Scaling group.
```
aws autoscaling attach-load-balancers \
--load-balancer-names my-load-balancer \
--auto-scaling-group-name my-asg
```
This command produces no output.
For more information, see [Elastic Load Balancing and Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [AttachLoadBalancers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/attach-load-balancers.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example attaches the specified load balancer to the specified Auto Scaling group.**
```
Add-ASLoadBalancer -LoadBalancerName my-lb -AutoScalingGroupName my-asg
```
+ For API details, see [AttachLoadBalancers](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example attaches the specified load balancer to the specified Auto Scaling group.**
```
Add-ASLoadBalancer -LoadBalancerName my-lb -AutoScalingGroupName my-asg
```
+ For API details, see [AttachLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `CompleteLifecycleAction` with a CLI
The following code examples show how to use `CompleteLifecycleAction`.
------
#### [ CLI ]
**AWS CLI**
**To complete the lifecycle action**
This example notifies Amazon EC2 Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance.
```
aws autoscaling complete-lifecycle-action \
--lifecycle-hook-name my-launch-hook \
--auto-scaling-group-name my-asg \
--lifecycle-action-result CONTINUE \
--lifecycle-action-token bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635
```
This command produces no output.
For more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [CompleteLifecycleAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/complete-lifecycle-action.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example completes the specified lifecycle action.**
```
Complete-ASLifecycleAction -LifecycleHookName myLifecycleHook -AutoScalingGroupName my-asg -LifecycleActionResult CONTINUE -LifecycleActionToken bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635
```
+ For API details, see [CompleteLifecycleAction](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example completes the specified lifecycle action.**
```
Complete-ASLifecycleAction -LifecycleHookName myLifecycleHook -AutoScalingGroupName my-asg -LifecycleActionResult CONTINUE -LifecycleActionToken bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635
```
+ For API details, see [CompleteLifecycleAction](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `CreateAutoScalingGroup` with an AWS SDK or CLI
The following code examples show how to use `CreateAutoScalingGroup`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples:
+ [Learn the basics](auto-scaling_example_auto-scaling_Scenario_GroupsAndInstances_section.md)
+ [Build and manage a resilient service](auto-scaling_example_cross_ResilientService_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/AutoScaling#code-examples).
```
///
/// Create a new Amazon EC2 Auto Scaling group.
///
/// The name to use for the new Auto Scaling
/// group.
/// The name of the Amazon EC2 Auto Scaling
/// launch template to use to create instances in the group.
/// A Boolean value indicating the success of the action.
public async Task CreateAutoScalingGroupAsync(
string groupName,
string launchTemplateName,
string availabilityZone)
{
var templateSpecification = new LaunchTemplateSpecification
{
LaunchTemplateName = launchTemplateName,
};
var zoneList = new List
{
availabilityZone,
};
var request = new CreateAutoScalingGroupRequest
{
AutoScalingGroupName = groupName,
AvailabilityZones = zoneList,
LaunchTemplate = templateSpecification,
MaxSize = 6,
MinSize = 1
};
try
{
var response = await _amazonAutoScaling.CreateAutoScalingGroupAsync(request);
Console.WriteLine($"{groupName} Auto Scaling Group created");
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
catch (AlreadyExistsException)
{
Console.WriteLine($"{groupName} Auto Scaling Group already exists.");
return true;
}
}
```
+ For API details, see [CreateAutoScalingGroup](https://docs.aws.amazon.com/goto/DotNetSDKV4/autoscaling-2011-01-01/CreateAutoScalingGroup) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/autoscaling#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::AutoScaling::AutoScalingClient autoScalingClient(clientConfig);
Aws::AutoScaling::Model::CreateAutoScalingGroupRequest request;
request.SetAutoScalingGroupName(groupName);
Aws::Vector availabilityGroupZones;
availabilityGroupZones.push_back(
availabilityZones[availabilityZoneChoice - 1].GetZoneName());
request.SetAvailabilityZones(availabilityGroupZones);
request.SetMaxSize(1);
request.SetMinSize(1);
Aws::AutoScaling::Model::LaunchTemplateSpecification launchTemplateSpecification;
launchTemplateSpecification.SetLaunchTemplateName(templateName);
request.SetLaunchTemplate(launchTemplateSpecification);
Aws::AutoScaling::Model::CreateAutoScalingGroupOutcome outcome =
autoScalingClient.CreateAutoScalingGroup(request);
if (outcome.IsSuccess()) {
std::cout << "Created Auto Scaling group '" << groupName << "'..."
<< std::endl;
}
else if (outcome.GetError().GetErrorType() ==
Aws::AutoScaling::AutoScalingErrors::ALREADY_EXISTS_FAULT) {
std::cout << "Auto Scaling group '" << groupName << "' already exists."
<< std::endl;
}
else {
std::cerr << "Error with AutoScaling::CreateAutoScalingGroup. "
<< outcome.GetError().GetMessage()
<< std::endl;
}
```
+ For API details, see [CreateAutoScalingGroup](https://docs.aws.amazon.com/goto/SdkForCpp/autoscaling-2011-01-01/CreateAutoScalingGroup) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To create an Auto Scaling group**
The following `create-auto-scaling-group` example creates an Auto Scaling group in subnets in multiple Availability Zones within a Region. The instances launch with the default version of the specified launch template. Note that defaults are used for most other settings, such as the termination policies and health check configuration.
```
aws autoscaling create-auto-scaling-group \
--auto-scaling-group-name my-asg \
--launch-template LaunchTemplateId=lt-1234567890abcde12 \
--min-size 1 \
--max-size 5 \
--vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782"
```
This command produces no output.
For more information, see [Auto Scaling groups](https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 2: To attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer**
This example specifies the ARN of a target group for a load balancer that supports the expected traffic. The health check type specifies `ELB` so that when Elastic Load Balancing reports an instance as unhealthy, the Auto Scaling group replaces it. The command also defines a health check grace period of `600` seconds. The grace period helps prevent premature termination of newly launched instances.
```
aws autoscaling create-auto-scaling-group \
--auto-scaling-group-name my-asg \
--launch-template LaunchTemplateId=lt-1234567890abcde12 \
--target-group-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/943f017f100becff \
--health-check-type ELB \
--health-check-grace-period 600 \
--min-size 1 \
--max-size 5 \
--vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782"
```
This command produces no output.
For more information, see [Elastic Load Balancing and Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 3: To specify a placement group and use the latest version of the launch template**
This example launches instances into a placement group within a single Availability Zone. This can be useful for low-latency groups with HPC workloads. This example also specifies the minimum size, maximum size, and desired capacity of the group.
```
aws autoscaling create-auto-scaling-group \
--auto-scaling-group-name my-asg \
--launch-template LaunchTemplateId=lt-1234567890abcde12,Version='$Latest' \
--min-size 1 \
--max-size 5 \
--desired-capacity 3 \
--placement-group my-placement-group \
--vpc-zone-identifier "subnet-6194ea3b"
```
This command produces no output.
For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*.
**Example 4: To specify a single instance Auto Scaling group and use a specific version of the launch template**
This example creates an Auto Scaling group with minimum and maximum capacity set to `1` to enforce that one instance will be running. The command also specifies v1 of a launch template in which the ID of an existing ENI is specified. When you use a launch template that specifies an existing ENI for eth0, you must specify an Availability Zone for the Auto Scaling group that matches the network interface, without also specifying a subnet ID in the request.
```
aws autoscaling create-auto-scaling-group \
--auto-scaling-group-name my-asg-single-instance \
--launch-template LaunchTemplateName=my-template-for-auto-scaling,Version='1' \
--min-size 1 \
--max-size 1 \
--availability-zones us-west-2a
```
This command produces no output.
For more information, see [Auto Scaling groups](https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 5: To specify a different termination policy**
This example creates an Auto Scaling group using a launch configuration and sets the termination policy to terminate the oldest instances first. The command also applies a tag to the group and its instances, with a key of `Role` and a value of `WebServer`.
```
aws autoscaling create-auto-scaling-group \
--auto-scaling-group-name my-asg \
--launch-configuration-name my-lc \
--min-size 1 \
--max-size 5 \
--termination-policies "OldestInstance" \
--tags "ResourceId=my-asg,ResourceType=auto-scaling-group,Key=Role,Value=WebServer,PropagateAtLaunch=true" \
--vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782"
```
This command produces no output.
For more information, see [Working with Amazon EC2 Auto Scaling termination policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 6: To specify a launch lifecycle hook**
This example creates an Auto Scaling group with a lifecycle hook that supports a custom action at instance launch.
```
aws autoscaling create-auto-scaling-group \
--cli-input-json file://~/config.json
```
Contents of `config.json` file:
```
{
"AutoScalingGroupName": "my-asg",
"LaunchTemplate": {
"LaunchTemplateId": "lt-1234567890abcde12"
},
"LifecycleHookSpecificationList": [{
"LifecycleHookName": "my-launch-hook",
"LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING",
"NotificationTargetARN": "arn:aws:sqs:us-west-2:123456789012:my-sqs-queue",
"RoleARN": "arn:aws:iam::123456789012:role/my-notification-role",
"NotificationMetadata": "SQS message metadata",
"HeartbeatTimeout": 4800,
"DefaultResult": "ABANDON"
}],
"MinSize": 1,
"MaxSize": 5,
"VPCZoneIdentifier": "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782",
"Tags": [{
"ResourceType": "auto-scaling-group",
"ResourceId": "my-asg",
"PropagateAtLaunch": true,
"Value": "test",
"Key": "environment"
}]
}
```
This command produces no output.
For more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 7: To specify a termination lifecycle hook**
This example creates an Auto Scaling group with a lifecycle hook that supports a custom action at instance termination.
```
aws autoscaling create-auto-scaling-group \
--cli-input-json file://~/config.json
```
Contents of `config.json`:
```
{
"AutoScalingGroupName": "my-asg",
"LaunchTemplate": {
"LaunchTemplateId": "lt-1234567890abcde12"
},
"LifecycleHookSpecificationList": [{
"LifecycleHookName": "my-termination-hook",
"LifecycleTransition": "autoscaling:EC2_INSTANCE_TERMINATING",
"HeartbeatTimeout": 120,
"DefaultResult": "CONTINUE"
}],
"MinSize": 1,
"MaxSize": 5,
"TargetGroupARNs": [
"arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
],
"VPCZoneIdentifier": "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782"
}
```
This command produces no output.
For more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 8: To specify a custom termination policy**
This example creates an Auto Scaling group that specifies a custom Lambda function termination policy that tells Amazon EC2 Auto Scaling which instances are safe to terminate on scale in.
```
aws autoscaling create-auto-scaling-group \
--auto-scaling-group-name my-asg-single-instance \
--launch-template LaunchTemplateName=my-template-for-auto-scaling \
--min-size 1 \
--max-size 5 \
--termination-policies "arn:aws:lambda:us-west-2:123456789012:function:HelloFunction:prod" \
--vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782"
```
This command produces no output.
For more information, see [Creating a custom termination policy with Lambda](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lambda-custom-termination-policy.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [CreateAutoScalingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/create-auto-scaling-group.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/autoscale#code-examples).
```
import software.amazon.awssdk.core.waiters.WaiterResponse;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.autoscaling.AutoScalingClient;
import software.amazon.awssdk.services.autoscaling.model.AutoScalingException;
import software.amazon.awssdk.services.autoscaling.model.CreateAutoScalingGroupRequest;
import software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest;
import software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsResponse;
import software.amazon.awssdk.services.autoscaling.model.LaunchTemplateSpecification;
import software.amazon.awssdk.services.autoscaling.waiters.AutoScalingWaiter;
/**
* Before running this SDK for Java (v2) code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class CreateAutoScalingGroup {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
groupName - The name of the Auto Scaling group.
launchTemplateName - The name of the launch template.\s
vpcZoneId - A subnet Id for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.
""";
if (args.length != 3) {
System.out.println(usage);
System.exit(1);
}
String groupName = args[0];
String launchTemplateName = args[1];
String vpcZoneId = args[2];
AutoScalingClient autoScalingClient = AutoScalingClient.builder()
.region(Region.US_EAST_1)
.build();
createAutoScalingGroup(autoScalingClient, groupName, launchTemplateName, vpcZoneId);
autoScalingClient.close();
}
public static void createAutoScalingGroup(AutoScalingClient autoScalingClient,
String groupName,
String launchTemplateName,
String vpcZoneId) {
try {
AutoScalingWaiter waiter = autoScalingClient.waiter();
LaunchTemplateSpecification templateSpecification = LaunchTemplateSpecification.builder()
.launchTemplateName(launchTemplateName)
.build();
CreateAutoScalingGroupRequest request = CreateAutoScalingGroupRequest.builder()
.autoScalingGroupName(groupName)
.availabilityZones("us-east-1a")
.launchTemplate(templateSpecification)
.maxSize(1)
.minSize(1)
.vpcZoneIdentifier(vpcZoneId)
.build();
autoScalingClient.createAutoScalingGroup(request);
DescribeAutoScalingGroupsRequest groupsRequest = DescribeAutoScalingGroupsRequest.builder()
.autoScalingGroupNames(groupName)
.build();
WaiterResponse waiterResponse = waiter
.waitUntilGroupExists(groupsRequest);
waiterResponse.matched().response().ifPresent(System.out::println);
System.out.println("Auto Scaling Group created");
} catch (AutoScalingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ For API details, see [CreateAutoScalingGroup](https://docs.aws.amazon.com/goto/SdkForJavaV2/autoscaling-2011-01-01/CreateAutoScalingGroup) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/autoscale#code-examples).
```
suspend fun createAutoScalingGroup(
groupName: String,
launchTemplateNameVal: String,
serviceLinkedRoleARNVal: String,
vpcZoneIdVal: String,
) {
val templateSpecification =
LaunchTemplateSpecification {
launchTemplateName = launchTemplateNameVal
}
val request =
CreateAutoScalingGroupRequest {
autoScalingGroupName = groupName
availabilityZones = listOf("us-east-1a")
launchTemplate = templateSpecification
maxSize = 1
minSize = 1
vpcZoneIdentifier = vpcZoneIdVal
serviceLinkedRoleArn = serviceLinkedRoleARNVal
}
// This object is required for the waiter call.
val groupsRequestWaiter =
DescribeAutoScalingGroupsRequest {
autoScalingGroupNames = listOf(groupName)
}
AutoScalingClient { region = "us-east-1" }.use { autoScalingClient ->
autoScalingClient.createAutoScalingGroup(request)
autoScalingClient.waitUntilGroupExists(groupsRequestWaiter)
println("$groupName was created!")
}
}
```
+ For API details, see [CreateAutoScalingGroup](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ PHP ]
**SDK for PHP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/auto-scaling#code-examples).
```
public function createAutoScalingGroup(
$autoScalingGroupName,
$availabilityZones,
$minSize,
$maxSize,
$launchTemplateId
) {
return $this->autoScalingClient->createAutoScalingGroup([
'AutoScalingGroupName' => $autoScalingGroupName,
'AvailabilityZones' => $availabilityZones,
'MinSize' => $minSize,
'MaxSize' => $maxSize,
'LaunchTemplate' => [
'LaunchTemplateId' => $launchTemplateId,
],
]);
}
```
+ For API details, see [CreateAutoScalingGroup](https://docs.aws.amazon.com/goto/SdkForPHPV3/autoscaling-2011-01-01/CreateAutoScalingGroup) in *AWS SDK for PHP API Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example creates an Auto Scaling group with the specified name and attributes. The default desired capacity is the minimum size. Therefore, this Auto Scaling group launches two instances, one in each of the specified two Availability Zones.**
```
New-ASAutoScalingGroup -AutoScalingGroupName my-asg -LaunchConfigurationName my-lc -MinSize 2 -MaxSize 6 -AvailabilityZone @("us-west-2a", "us-west-2b")
```
+ For API details, see [CreateAutoScalingGroup](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example creates an Auto Scaling group with the specified name and attributes. The default desired capacity is the minimum size. Therefore, this Auto Scaling group launches two instances, one in each of the specified two Availability Zones.**
```
New-ASAutoScalingGroup -AutoScalingGroupName my-asg -LaunchConfigurationName my-lc -MinSize 2 -MaxSize 6 -AvailabilityZone @("us-west-2a", "us-west-2b")
```
+ For API details, see [CreateAutoScalingGroup](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/auto-scaling#code-examples).
```
class AutoScalingWrapper:
"""Encapsulates Amazon EC2 Auto Scaling actions."""
def __init__(self, autoscaling_client):
"""
:param autoscaling_client: A Boto3 Amazon EC2 Auto Scaling client.
"""
self.autoscaling_client = autoscaling_client
def create_group(
self,
group_name: str,
group_zones: List[str],
launch_template_name: str,
min_size: int,
max_size: int,
) -> None:
"""
Creates an Auto Scaling group.
:param group_name: The name to give to the group.
:param group_zones: The Availability Zones in which instances can be created.
:param launch_template_name: The name of an existing Amazon EC2 launch template.
The launch template specifies the configuration of
instances that are created by auto scaling activities.
:param min_size: The minimum number of active instances in the group.
:param max_size: The maximum number of active instances in the group.
:return: None
:raises ClientError: If there is an error creating the Auto Scaling group.
"""
try:
self.autoscaling_client.create_auto_scaling_group(
AutoScalingGroupName=group_name,
AvailabilityZones=group_zones,
LaunchTemplate={
"LaunchTemplateName": launch_template_name,
"Version": "$Default",
},
MinSize=min_size,
MaxSize=max_size,
)
# Wait for the group to exist.
waiter = self.autoscaling_client.get_waiter("group_exists")
waiter.wait(AutoScalingGroupNames=[group_name])
logger.info(f"Successfully created Auto Scaling group {group_name}.")
except ClientError as err:
error_code = err.response["Error"]["Code"]
logger.error(f"Failed to create Auto Scaling group {group_name}.")
if error_code == "AlreadyExistsFault":
logger.error(
f"An Auto Scaling group with the name '{group_name}' already exists. "
"Please use a different name or update the existing group.",
)
elif error_code == "LimitExceededFault":
logger.error(
"The request failed because you have reached the limit "
"on the number of Auto Scaling groups or launch configurations. "
"Consider deleting unused resources or request a limit increase. "
"\nSee Auto Scaling Service Quota documentation here:"
"\n\thttps://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html"
)
logger.error(f"Full error:\n\t{err}")
raise
```
+ For API details, see [CreateAutoScalingGroup](https://docs.aws.amazon.com/goto/boto3/autoscaling-2011-01-01/CreateAutoScalingGroup) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/auto-scaling#code-examples).
```
async fn create_group(client: &Client, name: &str, id: &str) -> Result<(), Error> {
client
.create_auto_scaling_group()
.auto_scaling_group_name(name)
.instance_id(id)
.min_size(1)
.max_size(5)
.send()
.await?;
println!("Created AutoScaling group");
Ok(())
}
```
+ For API details, see [CreateAutoScalingGroup](https://docs.rs/aws-sdk-autoscaling/latest/aws_sdk_autoscaling/client/struct.Client.html#method.create_auto_scaling_group) in *AWS SDK for Rust API reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/asc#code-examples).
```
DATA lo_launch_template TYPE REF TO /aws1/cl_asclaunchtemplatespec.
" Example: iv_group_name = 'my-auto-scaling-group'
" Example: iv_launch_template_name = 'my-launch-template'
" Example: iv_min_size = 1
" Example: iv_max_size = 3
" Example: iv_vpc_zone_identifier = 'subnet-12345,subnet-67890' (for VPC)
TRY.
" Create launch template specification
lo_launch_template = NEW /aws1/cl_asclaunchtemplatespec(
iv_launchtemplatename = iv_launch_template_name
iv_version = '$Default' ).
" Create the Auto Scaling group
" Use VPCZoneIdentifier for VPC subnets, or AvailabilityZones for EC2-Classic
IF iv_vpc_zone_identifier IS NOT INITIAL.
" VPC-based deployment - use subnet IDs
ao_asc->createautoscalinggroup(
iv_autoscalinggroupname = iv_group_name
iv_vpczoneidentifier = iv_vpc_zone_identifier
io_launchtemplate = lo_launch_template
iv_minsize = iv_min_size
iv_maxsize = iv_max_size ).
ELSE.
" EC2-Classic or default VPC - use availability zones
ao_asc->createautoscalinggroup(
iv_autoscalinggroupname = iv_group_name
it_availabilityzones = it_group_zones
io_launchtemplate = lo_launch_template
iv_minsize = iv_min_size
iv_maxsize = iv_max_size ).
ENDIF.
" Wait for the group to be created (simplified - in production use proper polling)
WAIT UP TO 10 SECONDS.
MESSAGE 'Auto Scaling group created successfully' TYPE 'I'.
CATCH /aws1/cx_ascalreadyexistsfault INTO DATA(lo_already_exists).
RAISE EXCEPTION lo_already_exists.
CATCH /aws1/cx_asclimitexceededfault INTO DATA(lo_limit_exceeded).
RAISE EXCEPTION lo_limit_exceeded.
CATCH /aws1/cx_rt_generic INTO DATA(lo_generic_exception).
RAISE EXCEPTION lo_generic_exception.
ENDTRY.
```
+ For API details, see [CreateAutoScalingGroup](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `CreateLaunchConfiguration` with a CLI
The following code examples show how to use `CreateLaunchConfiguration`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To create a launch configuration**
This example creates a simple launch configuration.
```
aws autoscaling create-launch-configuration \
--launch-configuration-name my-lc \
--image-id ami-04d5cc9b88example \
--instance-type m5.large
```
This command produces no output.
For more information, see [Creating a launch configuration](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 2: To create a launch configuration with a security group, key pair, and bootstrapping script**
This example creates a launch configuration with a security group, a key pair, and a bootstrapping script contained in the user data.
```
aws autoscaling create-launch-configuration \
--launch-configuration-name my-lc \
--image-id ami-04d5cc9b88example \
--instance-type m5.large \
--security-groups sg-eb2af88example \
--key-name my-key-pair \
--user-data file://myuserdata.txt
```
This command produces no output.
For more information, see [Creating a launch configuration](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 3: To create a launch configuration with an IAM role**
This example creates a launch configuration with the instance profile name of an IAM role.
```
aws autoscaling create-launch-configuration \
--launch-configuration-name my-lc \
--image-id ami-04d5cc9b88example \
--instance-type m5.large \
--iam-instance-profile my-autoscaling-role
```
This command produces no output.
For more information, see [IAM role for applications that run on Amazon EC2 instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 4: To create a launch configuration with detailed monitoring enabled**
This example creates a launch configuration with EC2 detailed monitoring enabled, which sends EC2 metrics to CloudWatch in 1-minute periods.
```
aws autoscaling create-launch-configuration \
--launch-configuration-name my-lc \
--image-id ami-04d5cc9b88example \
--instance-type m5.large \
--instance-monitoring Enabled=true
```
This command produces no output.
For more information, see [Configuring monitoring for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/enable-as-instance-metrics.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 5: To create a launch configuration that launches Spot Instances**
This example creates a launch configuration that uses Spot Instances as the only purchase option.
```
aws autoscaling create-launch-configuration \
--launch-configuration-name my-lc \
--image-id ami-04d5cc9b88example \
--instance-type m5.large \
--spot-price "0.50"
```
This command produces no output.
For more information, see [Requesting Spot Instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 6: To create a launch configuration using an EC2 instance**
This example creates a launch configuration based on the attributes of an existing instance. It overrides the placement tenancy and whether a public IP address is set by including the `--placement-tenancy` and `--no-associate-public-ip-address` options.
```
aws autoscaling create-launch-configuration \
--launch-configuration-name my-lc-from-instance \
--instance-id i-0123a456700123456 \
--instance-type m5.large \
--no-associate-public-ip-address \
--placement-tenancy dedicated
```
This command produces no output.
For more information, see [Creating a launch configuration using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 7: To create a launch configuration with a block device mapping for an Amazon EBS volume**
This example creates a launch configuration with a block device mapping for an Amazon EBS `gp3` volume with the device name `/dev/sdh` and a volume size of 20.
```
aws autoscaling create-launch-configuration \
--launch-configuration-name my-lc \
--image-id ami-04d5cc9b88example \
--instance-type m5.large \
--block-device-mappings '[{"DeviceName":"/dev/sdh","Ebs":{"VolumeSize":20,"VolumeType":"gp3"}}]'
```
This command produces no output.
For more information, see [EBS](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_Ebs.html) in the *Amazon EC2 Auto Scaling API Reference*.
For information about the syntax for quoting JSON-formatted parameter values, see [Using quotation marks with strings in the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS Command Line Interface User Guide*.
**Example 8: To create a launch configuration with a block device mapping for an instance store volume**
This example creates a launch configuration with `ephemeral1` as an instance store volume with the device name `/dev/sdc`.
```
aws autoscaling create-launch-configuration \
--launch-configuration-name my-lc \
--image-id ami-04d5cc9b88example \
--instance-type m5.large \
--block-device-mappings '[{"DeviceName":"/dev/sdc","VirtualName":"ephemeral1"}]'
```
This command produces no output.
For more information, see [BlockDeviceMapping](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_BlockDeviceMapping.html) in the *Amazon EC2 Auto Scaling API Reference*.
For information about the syntax for quoting JSON-formatted parameter values, see [Using quotation marks with strings in the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS Command Line Interface User Guide*.
**Example 9: To create a launch configuration and suppress a block device from attaching at launch time**
This example creates a launch configuration that suppresses a block device specified by the block device mapping of the AMI (for example, `/dev/sdf`).
```
aws autoscaling create-launch-configuration \
--launch-configuration-name my-lc \
--image-id ami-04d5cc9b88example \
--instance-type m5.large \
--block-device-mappings '[{"DeviceName":"/dev/sdf","NoDevice":""}]'
```
This command produces no output.
For more information, see [BlockDeviceMapping](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_BlockDeviceMapping.html) in the *Amazon EC2 Auto Scaling API Reference*.
For information about the syntax for quoting JSON-formatted parameter values, see [Using quotation marks with strings in the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS Command Line Interface User Guide*.
+ For API details, see [CreateLaunchConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/create-launch-configuration.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example creates a launch configuration named 'my-lc'. The EC2 instances launched by Auto Scaling groups that use this launch configuration use specified instance type, AMI, security group, and IAM role.**
```
New-ASLaunchConfiguration -LaunchConfigurationName my-lc -InstanceType "m3.medium" -ImageId "ami-12345678" -SecurityGroup "sg-12345678" -IamInstanceProfile "myIamRole"
```
+ For API details, see [CreateLaunchConfiguration](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example creates a launch configuration named 'my-lc'. The EC2 instances launched by Auto Scaling groups that use this launch configuration use specified instance type, AMI, security group, and IAM role.**
```
New-ASLaunchConfiguration -LaunchConfigurationName my-lc -InstanceType "m3.medium" -ImageId "ami-12345678" -SecurityGroup "sg-12345678" -IamInstanceProfile "myIamRole"
```
+ For API details, see [CreateLaunchConfiguration](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `CreateOrUpdateTags` with a CLI
The following code examples show how to use `CreateOrUpdateTags`.
------
#### [ CLI ]
**AWS CLI**
**To create or update tags for an Auto Scaling group**
This example adds two tags to the specified Auto Scaling group.
```
aws autoscaling create-or-update-tags \
--tags ResourceId=my-asg,ResourceType=auto-scaling-group,Key=Role,Value=WebServer,PropagateAtLaunch=true ResourceId=my-asg,ResourceType=auto-scaling-group,Key=Dept,Value=Research,PropagateAtLaunch=true
```
This command produces no output.
For more information, see [Tagging Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [CreateOrUpdateTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/create-or-update-tags.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example adds a single tag to the specified Auto Scaling group. The tag key is 'myTag' and the tag value is 'myTagValue'. Auto Scaling propagates this tag to the subsequent EC2 instances launched by the Auto Scaling group. The syntax used by this example requires PowerShell version 3 or later.**
```
Set-ASTag -Tag @( @{ResourceType="auto-scaling-group"; ResourceId="my-asg"; Key="myTag"; Value="myTagValue"; PropagateAtLaunch=$true} )
```
**Example 2: With PowerShell version 2, you must use New-Object to create the tag for the Tag parameter.**
```
$tag = New-Object Amazon.AutoScaling.Model.Tag
$tag.ResourceType = "auto-scaling-group"
$tag.ResourceId = "my-asg"
$tag.Key = "myTag"
$tag.Value = "myTagValue"
$tag.PropagateAtLaunch = $true
Set-ASTag -Tag $tag
```
+ For API details, see [CreateOrUpdateTags](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example adds a single tag to the specified Auto Scaling group. The tag key is 'myTag' and the tag value is 'myTagValue'. Auto Scaling propagates this tag to the subsequent EC2 instances launched by the Auto Scaling group. The syntax used by this example requires PowerShell version 3 or later.**
```
Set-ASTag -Tag @( @{ResourceType="auto-scaling-group"; ResourceId="my-asg"; Key="myTag"; Value="myTagValue"; PropagateAtLaunch=$true} )
```
**Example 2: With PowerShell version 2, you must use New-Object to create the tag for the Tag parameter.**
```
$tag = New-Object Amazon.AutoScaling.Model.Tag
$tag.ResourceType = "auto-scaling-group"
$tag.ResourceId = "my-asg"
$tag.Key = "myTag"
$tag.Value = "myTagValue"
$tag.PropagateAtLaunch = $true
Set-ASTag -Tag $tag
```
+ For API details, see [CreateOrUpdateTags](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DeleteAutoScalingGroup` with an AWS SDK or CLI
The following code examples show how to use `DeleteAutoScalingGroup`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples:
+ [Learn the basics](auto-scaling_example_auto-scaling_Scenario_GroupsAndInstances_section.md)
+ [Build and manage a resilient service](auto-scaling_example_cross_ResilientService_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/cross-service/ResilientService/AutoScalerActions#code-examples).
Update the minimum size of an Auto Scaling group to zero, terminate all instances in the group, and delete the group.
```
///
/// Try to terminate an instance by its Id.
///
/// The Id of the instance to terminate.
/// Async task.
public async Task TryTerminateInstanceById(string instanceId)
{
var stopping = false;
Console.WriteLine($"Stopping {instanceId}...");
while (!stopping)
{
try
{
await _amazonAutoScaling.TerminateInstanceInAutoScalingGroupAsync(
new TerminateInstanceInAutoScalingGroupRequest()
{
InstanceId = instanceId,
ShouldDecrementDesiredCapacity = false
});
stopping = true;
}
catch (ScalingActivityInProgressException)
{
Console.WriteLine($"Scaling activity in progress for {instanceId}. Waiting...");
Thread.Sleep(10000);
}
}
}
///
/// Tries to delete the EC2 Auto Scaling group. If the group is in use or in progress,
/// waits and retries until the group is successfully deleted.
///
/// The name of the group to try to delete.
/// Async task.
public async Task TryDeleteGroupByName(string groupName)
{
var stopped = false;
while (!stopped)
{
try
{
await _amazonAutoScaling.DeleteAutoScalingGroupAsync(
new DeleteAutoScalingGroupRequest()
{
AutoScalingGroupName = groupName
});
stopped = true;
}
catch (Exception e)
when ((e is ScalingActivityInProgressException)
|| (e is Amazon.AutoScaling.Model.ResourceInUseException))
{
Console.WriteLine($"Some instances are still running. Waiting...");
Thread.Sleep(10000);
}
}
}
///
/// Terminate instances and delete the Auto Scaling group by name.
///
/// The name of the group to delete.
/// Async task.
public async Task TerminateAndDeleteAutoScalingGroupWithName(string groupName)
{
var describeGroupsResponse = await _amazonAutoScaling.DescribeAutoScalingGroupsAsync(
new DescribeAutoScalingGroupsRequest()
{
AutoScalingGroupNames = new List() { groupName }
});
if (describeGroupsResponse.AutoScalingGroups.Any())
{
// Update the size to 0.
await _amazonAutoScaling.UpdateAutoScalingGroupAsync(
new UpdateAutoScalingGroupRequest()
{
AutoScalingGroupName = groupName,
MinSize = 0
});
var group = describeGroupsResponse.AutoScalingGroups[0];
foreach (var instance in group.Instances)
{
await TryTerminateInstanceById(instance.InstanceId);
}
await TryDeleteGroupByName(groupName);
}
else
{
Console.WriteLine($"No groups found with name {groupName}.");
}
}
```
```
///
/// Delete an Auto Scaling group.
///
/// The name of the Amazon EC2 Auto Scaling group.
/// A Boolean value indicating the success of the action.
public async Task DeleteAutoScalingGroupAsync(
string groupName)
{
var deleteAutoScalingGroupRequest = new DeleteAutoScalingGroupRequest
{
AutoScalingGroupName = groupName,
ForceDelete = true,
};
var response = await _amazonAutoScaling.DeleteAutoScalingGroupAsync(deleteAutoScalingGroupRequest);
if (response.HttpStatusCode == System.Net.HttpStatusCode.OK)
{
Console.WriteLine($"You successfully deleted {groupName}");
return true;
}
Console.WriteLine($"Couldn't delete {groupName}.");
return false;
}
```
+ For API details, see [DeleteAutoScalingGroup](https://docs.aws.amazon.com/goto/DotNetSDKV3/autoscaling-2011-01-01/DeleteAutoScalingGroup) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/autoscaling#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::AutoScaling::AutoScalingClient autoScalingClient(clientConfig);
Aws::AutoScaling::Model::DeleteAutoScalingGroupRequest request;
request.SetAutoScalingGroupName(groupName);
Aws::AutoScaling::Model::DeleteAutoScalingGroupOutcome outcome =
autoScalingClient.DeleteAutoScalingGroup(request);
if (outcome.IsSuccess()) {
std::cout << "Auto Scaling group '" << groupName << "' was deleted."
<< std::endl;
}
else {
std::cerr << "Error with AutoScaling::DeleteAutoScalingGroup. "
<< outcome.GetError().GetMessage()
<< std::endl;
result = false;
}
}
```
+ For API details, see [DeleteAutoScalingGroup](https://docs.aws.amazon.com/goto/SdkForCpp/autoscaling-2011-01-01/DeleteAutoScalingGroup) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To delete the specified Auto Scaling group**
This example deletes the specified Auto Scaling group.
```
aws autoscaling delete-auto-scaling-group \
--auto-scaling-group-name my-asg
```
This command produces no output.
For more information, see [Deleting your Auto Scaling infrastructure](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-process-shutdown.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 2: To force delete the specified Auto Scaling group**
To delete the Auto Scaling group without waiting for the instances in the group to terminate, use the `--force-delete` option.
```
aws autoscaling delete-auto-scaling-group \
--auto-scaling-group-name my-asg \
--force-delete
```
This command produces no output.
For more information, see [Deleting your Auto Scaling infrastructure](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-process-shutdown.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DeleteAutoScalingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-auto-scaling-group.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/autoscale#code-examples).
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.autoscaling.AutoScalingClient;
import software.amazon.awssdk.services.autoscaling.model.AutoScalingException;
import software.amazon.awssdk.services.autoscaling.model.DeleteAutoScalingGroupRequest;
/**
* Before running this SDK for Java (v2) code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class DeleteAutoScalingGroup {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
groupName - The name of the Auto Scaling group.
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String groupName = args[0];
AutoScalingClient autoScalingClient = AutoScalingClient.builder()
.region(Region.US_EAST_1)
.build();
deleteAutoScalingGroup(autoScalingClient, groupName);
autoScalingClient.close();
}
public static void deleteAutoScalingGroup(AutoScalingClient autoScalingClient, String groupName) {
try {
DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest = DeleteAutoScalingGroupRequest.builder()
.autoScalingGroupName(groupName)
.forceDelete(true)
.build();
autoScalingClient.deleteAutoScalingGroup(deleteAutoScalingGroupRequest);
System.out.println("You successfully deleted " + groupName);
} catch (AutoScalingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ For API details, see [DeleteAutoScalingGroup](https://docs.aws.amazon.com/goto/SdkForJavaV2/autoscaling-2011-01-01/DeleteAutoScalingGroup) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/autoscale#code-examples).
```
suspend fun deleteSpecificAutoScalingGroup(groupName: String) {
val deleteAutoScalingGroupRequest =
DeleteAutoScalingGroupRequest {
autoScalingGroupName = groupName
forceDelete = true
}
AutoScalingClient { region = "us-east-1" }.use { autoScalingClient ->
autoScalingClient.deleteAutoScalingGroup(deleteAutoScalingGroupRequest)
println("You successfully deleted $groupName")
}
}
```
+ For API details, see [DeleteAutoScalingGroup](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ PHP ]
**SDK for PHP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/auto-scaling#code-examples).
```
public function deleteAutoScalingGroup($autoScalingGroupName)
{
return $this->autoScalingClient->deleteAutoScalingGroup([
'AutoScalingGroupName' => $autoScalingGroupName,
'ForceDelete' => true,
]);
}
```
+ For API details, see [DeleteAutoScalingGroup](https://docs.aws.amazon.com/goto/SdkForPHPV3/autoscaling-2011-01-01/DeleteAutoScalingGroup) in *AWS SDK for PHP API Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example deletes the specified Auto Scaling group if it has no running instances. You are prompted for confirmation before the operation proceeds.**
```
Remove-ASAutoScalingGroup -AutoScalingGroupName my-asg
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASAutoScalingGroup (DeleteAutoScalingGroup)" on Target "my-asg".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Example 2: If you specify the Force parameter, you are not prompted for confirmation before the operation proceeds.**
```
Remove-ASAutoScalingGroup -AutoScalingGroupName my-asg -Force
```
**Example 3: This example deletes the specified Auto Scaling group and terminates any running instances that it contains.**
```
Remove-ASAutoScalingGroup -AutoScalingGroupName my-asg -ForceDelete $true -Force
```
+ For API details, see [DeleteAutoScalingGroup](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example deletes the specified Auto Scaling group if it has no running instances. You are prompted for confirmation before the operation proceeds.**
```
Remove-ASAutoScalingGroup -AutoScalingGroupName my-asg
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASAutoScalingGroup (DeleteAutoScalingGroup)" on Target "my-asg".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Example 2: If you specify the Force parameter, you are not prompted for confirmation before the operation proceeds.**
```
Remove-ASAutoScalingGroup -AutoScalingGroupName my-asg -Force
```
**Example 3: This example deletes the specified Auto Scaling group and terminates any running instances that it contains.**
```
Remove-ASAutoScalingGroup -AutoScalingGroupName my-asg -ForceDelete $true -Force
```
+ For API details, see [DeleteAutoScalingGroup](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/auto-scaling#code-examples).
Update the minimum size of an Auto Scaling group to zero, terminate all instances in the group, and delete the group.
```
class AutoScalingWrapper:
"""
Encapsulates Amazon EC2 Auto Scaling and EC2 management actions.
"""
def __init__(
self,
resource_prefix: str,
inst_type: str,
ami_param: str,
autoscaling_client: boto3.client,
ec2_client: boto3.client,
ssm_client: boto3.client,
iam_client: boto3.client,
):
"""
Initializes the AutoScaler class with the necessary parameters.
:param resource_prefix: The prefix for naming AWS resources that are created by this class.
:param inst_type: The type of EC2 instance to create, such as t3.micro.
:param ami_param: The Systems Manager parameter used to look up the AMI that is created.
:param autoscaling_client: A Boto3 EC2 Auto Scaling client.
:param ec2_client: A Boto3 EC2 client.
:param ssm_client: A Boto3 Systems Manager client.
:param iam_client: A Boto3 IAM client.
"""
self.inst_type = inst_type
self.ami_param = ami_param
self.autoscaling_client = autoscaling_client
self.ec2_client = ec2_client
self.ssm_client = ssm_client
self.iam_client = iam_client
sts_client = boto3.client("sts")
self.account_id = sts_client.get_caller_identity()["Account"]
self.key_pair_name = f"{resource_prefix}-key-pair"
self.launch_template_name = f"{resource_prefix}-template-"
self.group_name = f"{resource_prefix}-group"
# Happy path
self.instance_policy_name = f"{resource_prefix}-pol"
self.instance_role_name = f"{resource_prefix}-role"
self.instance_profile_name = f"{resource_prefix}-prof"
# Failure mode
self.bad_creds_policy_name = f"{resource_prefix}-bc-pol"
self.bad_creds_role_name = f"{resource_prefix}-bc-role"
self.bad_creds_profile_name = f"{resource_prefix}-bc-prof"
def delete_autoscaling_group(self, group_name: str) -> None:
"""
Terminates all instances in the group, then deletes the EC2 Auto Scaling group.
:param group_name: The name of the group to delete.
"""
try:
response = self.autoscaling_client.describe_auto_scaling_groups(
AutoScalingGroupNames=[group_name]
)
groups = response.get("AutoScalingGroups", [])
if len(groups) > 0:
self.autoscaling_client.update_auto_scaling_group(
AutoScalingGroupName=group_name, MinSize=0
)
instance_ids = [inst["InstanceId"] for inst in groups[0]["Instances"]]
for inst_id in instance_ids:
self.terminate_instance(inst_id)
# Wait for all instances to be terminated
if instance_ids:
waiter = self.ec2_client.get_waiter("instance_terminated")
log.info("Waiting for all instances to be terminated...")
waiter.wait(InstanceIds=instance_ids)
log.info("All instances have been terminated.")
else:
log.info(f"No groups found named '{group_name}'! Nothing to do.")
except ClientError as err:
error_code = err.response["Error"]["Code"]
log.error(f"Failed to delete Auto Scaling group '{group_name}'.")
if error_code == "ScalingActivityInProgressFault":
log.error(
"Scaling activity is currently in progress. "
"Wait for the scaling activity to complete before attempting to delete the group again."
)
elif error_code == "ResourceContentionFault":
log.error(
"The request failed due to a resource contention issue. "
"Ensure that no conflicting operations are being performed on the group."
)
log.error(f"Full error:\n\t{err}")
```
+ For API details, see [DeleteAutoScalingGroup](https://docs.aws.amazon.com/goto/boto3/autoscaling-2011-01-01/DeleteAutoScalingGroup) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/auto-scaling#code-examples).
```
async fn delete_group(client: &Client, name: &str, force: bool) -> Result<(), Error> {
client
.delete_auto_scaling_group()
.auto_scaling_group_name(name)
.set_force_delete(if force { Some(true) } else { None })
.send()
.await?;
println!("Deleted Auto Scaling group");
Ok(())
}
```
+ For API details, see [DeleteAutoScalingGroup](https://docs.rs/aws-sdk-autoscaling/latest/aws_sdk_autoscaling/client/struct.Client.html#method.delete_auto_scaling_group) in *AWS SDK for Rust API reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/asc#code-examples).
```
" Example: iv_group_name = 'my-auto-scaling-group'
TRY.
ao_asc->deleteautoscalinggroup(
iv_autoscalinggroupname = iv_group_name ).
" Wait for the group to be deleted (simplified - in production use proper polling)
WAIT UP TO 10 SECONDS.
MESSAGE 'Auto Scaling group deleted successfully' TYPE 'I'.
CATCH /aws1/cx_ascscaactivityinprg00 INTO DATA(lo_activity_in_progress).
RAISE EXCEPTION lo_activity_in_progress.
CATCH /aws1/cx_ascresourceinusefault INTO DATA(lo_resource_in_use).
RAISE EXCEPTION lo_resource_in_use.
CATCH /aws1/cx_rt_generic INTO DATA(lo_generic_exception).
RAISE EXCEPTION lo_generic_exception.
ENDTRY.
```
+ For API details, see [DeleteAutoScalingGroup](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `DeleteLaunchConfiguration` with a CLI
The following code examples show how to use `DeleteLaunchConfiguration`.
------
#### [ CLI ]
**AWS CLI**
**To delete a launch configuration**
This example deletes the specified launch configuration.
```
aws autoscaling delete-launch-configuration \
--launch-configuration-name my-launch-config
```
This command produces no output.
For more information, see [Deleting your Auto Scaling infrastructure](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-process-shutdown.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DeleteLaunchConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-launch-configuration.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example deletes the specified launch configuration if it is not attached to an Auto Scaling group. You are prompted for confirmation before the operation proceeds.**
```
Remove-ASLaunchConfiguration -LaunchConfigurationName my-lc
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASLaunchConfiguration (DeleteLaunchConfiguration)" on Target "my-lc".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Example 2: If you specify the Force parameter, you are not prompted for confirmation before the operation proceeds.**
```
Remove-ASLaunchConfiguration -LaunchConfigurationName my-lc -Force
```
+ For API details, see [DeleteLaunchConfiguration](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example deletes the specified launch configuration if it is not attached to an Auto Scaling group. You are prompted for confirmation before the operation proceeds.**
```
Remove-ASLaunchConfiguration -LaunchConfigurationName my-lc
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASLaunchConfiguration (DeleteLaunchConfiguration)" on Target "my-lc".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Example 2: If you specify the Force parameter, you are not prompted for confirmation before the operation proceeds.**
```
Remove-ASLaunchConfiguration -LaunchConfigurationName my-lc -Force
```
+ For API details, see [DeleteLaunchConfiguration](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DeleteLifecycleHook` with a CLI
The following code examples show how to use `DeleteLifecycleHook`.
------
#### [ CLI ]
**AWS CLI**
**To delete a lifecycle hook**
This example deletes the specified lifecycle hook.
```
aws autoscaling delete-lifecycle-hook \
--lifecycle-hook-name my-lifecycle-hook \
--auto-scaling-group-name my-asg
```
This command produces no output.
+ For API details, see [DeleteLifecycleHook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-lifecycle-hook.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example deletes the specified lifecycle hook for the specified Auto Scaling group. You are prompted for confirmation before the operation proceeds.**
```
Remove-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASLifecycleHook (DeleteLifecycleHook)" on Target "myLifecycleHook".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Example 2: If you specify the Force parameter, you are not prompted for confirmation before the operation proceeds.**
```
Remove-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook -Force
```
+ For API details, see [DeleteLifecycleHook](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example deletes the specified lifecycle hook for the specified Auto Scaling group. You are prompted for confirmation before the operation proceeds.**
```
Remove-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASLifecycleHook (DeleteLifecycleHook)" on Target "myLifecycleHook".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Example 2: If you specify the Force parameter, you are not prompted for confirmation before the operation proceeds.**
```
Remove-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook -Force
```
+ For API details, see [DeleteLifecycleHook](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DeleteNotificationConfiguration` with a CLI
The following code examples show how to use `DeleteNotificationConfiguration`.
------
#### [ CLI ]
**AWS CLI**
**To delete an Auto Scaling notification**
This example deletes the specified notification from the specified Auto Scaling group.
```
aws autoscaling delete-notification-configuration \
--auto-scaling-group-name my-asg \
--topic-arn arn:aws:sns:us-west-2:123456789012:my-sns-topic
```
This command produces no output.
For more information, see [Delete the notification configuration](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html#delete-settingupnotifications) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DeleteNotificationConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-notification-configuration.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example deletes the specified notification action. You are prompted for confirmation before the operation proceeds.**
```
Remove-ASNotificationConfiguration -AutoScalingGroupName my-asg -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic"
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASNotificationConfiguration (DeleteNotificationConfiguration)" on Target
"arn:aws:sns:us-west-2:123456789012:my-topic".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Example 2: If you specify the Force parameter, you are not prompted for confirmation before the operation proceeds.**
```
Remove-ASNotificationConfiguration -AutoScalingGroupName my-asg -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic" -Force
```
+ For API details, see [DeleteNotificationConfiguration](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example deletes the specified notification action. You are prompted for confirmation before the operation proceeds.**
```
Remove-ASNotificationConfiguration -AutoScalingGroupName my-asg -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic"
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASNotificationConfiguration (DeleteNotificationConfiguration)" on Target
"arn:aws:sns:us-west-2:123456789012:my-topic".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Example 2: If you specify the Force parameter, you are not prompted for confirmation before the operation proceeds.**
```
Remove-ASNotificationConfiguration -AutoScalingGroupName my-asg -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic" -Force
```
+ For API details, see [DeleteNotificationConfiguration](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DeletePolicy` with a CLI
The following code examples show how to use `DeletePolicy`.
------
#### [ CLI ]
**AWS CLI**
**To delete a scaling policy**
This example deletes the specified scaling policy.
```
aws autoscaling delete-policy \
--auto-scaling-group-name my-asg \
--policy-name alb1000-target-tracking-scaling-policy
```
This command produces no output.
+ For API details, see [DeletePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-policy.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example deletes the specified policy for the specified Auto Scaling group. You are prompted for confirmation before the operation proceeds.**
```
Remove-ASPolicy -AutoScalingGroupName my-asg -PolicyName myScaleInPolicy
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASPolicy (DeletePolicy)" on Target "myScaleInPolicy".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Example 2: If you specify the Force parameter, you are not prompted for confirmation before the operation proceeds.**
```
Remove-ASPolicy -AutoScalingGroupName my-asg -PolicyName myScaleInPolicy -Force
```
+ For API details, see [DeletePolicy](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example deletes the specified policy for the specified Auto Scaling group. You are prompted for confirmation before the operation proceeds.**
```
Remove-ASPolicy -AutoScalingGroupName my-asg -PolicyName myScaleInPolicy
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASPolicy (DeletePolicy)" on Target "myScaleInPolicy".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Example 2: If you specify the Force parameter, you are not prompted for confirmation before the operation proceeds.**
```
Remove-ASPolicy -AutoScalingGroupName my-asg -PolicyName myScaleInPolicy -Force
```
+ For API details, see [DeletePolicy](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DeleteScheduledAction` with a CLI
The following code examples show how to use `DeleteScheduledAction`.
------
#### [ CLI ]
**AWS CLI**
**To delete a scheduled action from an Auto Scaling group**
This example deletes the specified scheduled action from the specified Auto Scaling group.
```
aws autoscaling delete-scheduled-action \
--auto-scaling-group-name my-asg \
--scheduled-action-name my-scheduled-action
```
This command produces no output.
+ For API details, see [DeleteScheduledAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-scheduled-action.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example deletes the specified scheduled action for the specified Auto Scaling group. You are prompted for confirmation before the operation proceeds.**
```
Remove-ASScheduledAction -AutoScalingGroupName my-asg -ScheduledAction "myScheduledAction"
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASScheduledAction (DeleteScheduledAction)" on Target "myScheduledAction".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Example 2: If you specify the Force parameter, you are not prompted for confirmation before the operation proceeds.**
```
Remove-ASScheduledAction -AutoScalingGroupName my-asg -ScheduledAction "myScheduledAction" -Force
```
+ For API details, see [DeleteScheduledAction](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example deletes the specified scheduled action for the specified Auto Scaling group. You are prompted for confirmation before the operation proceeds.**
```
Remove-ASScheduledAction -AutoScalingGroupName my-asg -ScheduledAction "myScheduledAction"
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASScheduledAction (DeleteScheduledAction)" on Target "myScheduledAction".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Example 2: If you specify the Force parameter, you are not prompted for confirmation before the operation proceeds.**
```
Remove-ASScheduledAction -AutoScalingGroupName my-asg -ScheduledAction "myScheduledAction" -Force
```
+ For API details, see [DeleteScheduledAction](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DeleteTags` with a CLI
The following code examples show how to use `DeleteTags`.
------
#### [ CLI ]
**AWS CLI**
**To delete a tag from an Auto Scaling group**
This example deletes the specified tag from the specified Auto Scaling group.
```
aws autoscaling delete-tags \
--tags ResourceId=my-asg,ResourceType=auto-scaling-group,Key=Dept,Value=Research
```
This command produces no output.
For more information, see [Tagging Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DeleteTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-tags.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example removes the specified tag from the specified Auto Scaling group. You are prompted for confirmation before the operation proceeds. The syntax used by this example requires PowerShell version 3 or later.**
```
Remove-ASTag -Tag @( @{ResourceType="auto-scaling-group"; ResourceId="my-asg"; Key="myTag" } )
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ASTag (DeleteTags)" on target "Amazon.AutoScaling.Model.Tag".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Example 2: If you specify the Force parameter, you are not prompted for confirmation before the operation proceeds.**
```
Remove-ASTag -Tag @( @{ResourceType="auto-scaling-group"; ResourceId="my-asg"; Key="myTag" } ) -Force
```
**Example 3: With Powershell version 2, you must use New-Object to create the tag for the Tag parameter.**
```
$tag = New-Object Amazon.AutoScaling.Model.Tag
$tag.ResourceType = "auto-scaling-group"
$tag.ResourceId = "my-asg"
$tag.Key = "myTag"
Remove-ASTag -Tag $tag -Force
```
+ For API details, see [DeleteTags](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example removes the specified tag from the specified Auto Scaling group. You are prompted for confirmation before the operation proceeds. The syntax used by this example requires PowerShell version 3 or later.**
```
Remove-ASTag -Tag @( @{ResourceType="auto-scaling-group"; ResourceId="my-asg"; Key="myTag" } )
```
**Output:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ASTag (DeleteTags)" on target "Amazon.AutoScaling.Model.Tag".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**Example 2: If you specify the Force parameter, you are not prompted for confirmation before the operation proceeds.**
```
Remove-ASTag -Tag @( @{ResourceType="auto-scaling-group"; ResourceId="my-asg"; Key="myTag" } ) -Force
```
**Example 3: With Powershell version 2, you must use New-Object to create the tag for the Tag parameter.**
```
$tag = New-Object Amazon.AutoScaling.Model.Tag
$tag.ResourceType = "auto-scaling-group"
$tag.ResourceId = "my-asg"
$tag.Key = "myTag"
Remove-ASTag -Tag $tag -Force
```
+ For API details, see [DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeAccountLimits` with a CLI
The following code examples show how to use `DescribeAccountLimits`.
------
#### [ CLI ]
**AWS CLI**
**To describe your Amazon EC2 Auto Scaling account limits**
This example describes the Amazon EC2 Auto Scaling limits for your AWS account.
```
aws autoscaling describe-account-limits
```
Output:
```
{
"NumberOfLaunchConfigurations": 5,
"MaxNumberOfLaunchConfigurations": 100,
"NumberOfAutoScalingGroups": 3,
"MaxNumberOfAutoScalingGroups": 20
}
```
For more information, see [Amazon EC2 Auto Scaling service quotas](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DescribeAccountLimits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-account-limits.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example describes the Auto Scaling resource limits for your AWS account.**
```
Get-ASAccountLimit
```
**Output:**
```
MaxNumberOfAutoScalingGroups : 20
MaxNumberOfLaunchConfigurations : 100
```
+ For API details, see [DescribeAccountLimits](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example describes the Auto Scaling resource limits for your AWS account.**
```
Get-ASAccountLimit
```
**Output:**
```
MaxNumberOfAutoScalingGroups : 20
MaxNumberOfLaunchConfigurations : 100
```
+ For API details, see [DescribeAccountLimits](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeAdjustmentTypes` with a CLI
The following code examples show how to use `DescribeAdjustmentTypes`.
------
#### [ CLI ]
**AWS CLI**
**To describe the available scaling adjustment types**
This example describes the available adjustment types.
```
aws autoscaling describe-adjustment-types
```
Output:
```
{
"AdjustmentTypes": [
{
"AdjustmentType": "ChangeInCapacity"
},
{
"AdjustmentType": "ExactCapacity"
},
{
"AdjustmentType": "PercentChangeInCapacity"
}
]
}
```
For more information, see [Scaling adjustment types](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DescribeAdjustmentTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-adjustment-types.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example describes the adjustment types that are supported by Auto Scaling.**
```
Get-ASAdjustmentType
```
**Output:**
```
Type
----
ChangeInCapacity
ExactCapacity
PercentChangeInCapacity
```
+ For API details, see [DescribeAdjustmentTypes](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example describes the adjustment types that are supported by Auto Scaling.**
```
Get-ASAdjustmentType
```
**Output:**
```
Type
----
ChangeInCapacity
ExactCapacity
PercentChangeInCapacity
```
+ For API details, see [DescribeAdjustmentTypes](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeAutoScalingGroups` with an AWS SDK or CLI
The following code examples show how to use `DescribeAutoScalingGroups`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples:
+ [Learn the basics](auto-scaling_example_auto-scaling_Scenario_GroupsAndInstances_section.md)
+ [Build and manage a resilient service](auto-scaling_example_cross_ResilientService_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/AutoScaling#code-examples).
```
///
/// Get data about the instances in an Amazon EC2 Auto Scaling group.
///
/// The name of the Amazon EC2 Auto Scaling group.
/// A list of Amazon EC2 Auto Scaling details.
public async Task> DescribeAutoScalingInstancesAsync(
string groupName)
{
var groups = await DescribeAutoScalingGroupsAsync(groupName);
var instanceIds = new List();
var instanceDetails = new List();
if (groups != null)
{
groups.ForEach(group =>
{
if (group.AutoScalingGroupName == groupName && group.Instances != null)
{
group.Instances.ForEach(instance =>
{
instanceIds.Add(instance.InstanceId);
});
}
});
var scalingGroupsRequest = new DescribeAutoScalingInstancesRequest
{
MaxRecords = 10,
InstanceIds = instanceIds,
};
var response =
await _amazonAutoScaling.DescribeAutoScalingInstancesAsync(
scalingGroupsRequest);
if (response.AutoScalingInstances != null)
{
instanceDetails = response.AutoScalingInstances;
}
}
return instanceDetails;
}
```
+ For API details, see [DescribeAutoScalingGroups](https://docs.aws.amazon.com/goto/DotNetSDKV4/autoscaling-2011-01-01/DescribeAutoScalingGroups) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/autoscaling#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::AutoScaling::AutoScalingClient autoScalingClient(clientConfig);
Aws::AutoScaling::Model::DescribeAutoScalingGroupsRequest request;
Aws::Vector groupNames;
groupNames.push_back(groupName);
request.SetAutoScalingGroupNames(groupNames);
Aws::AutoScaling::Model::DescribeAutoScalingGroupsOutcome outcome =
client.DescribeAutoScalingGroups(request);
if (outcome.IsSuccess()) {
autoScalingGroup = outcome.GetResult().GetAutoScalingGroups();
}
else {
std::cerr << "Error with AutoScaling::DescribeAutoScalingGroups. "
<< outcome.GetError().GetMessage()
<< std::endl;
}
```
+ For API details, see [DescribeAutoScalingGroups](https://docs.aws.amazon.com/goto/SdkForCpp/autoscaling-2011-01-01/DescribeAutoScalingGroups) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To describe the specified Auto Scaling group**
This example describes the specified Auto Scaling group.
```
aws autoscaling describe-auto-scaling-groups \
--auto-scaling-group-names my-asg
```
Output:
```
{
"AutoScalingGroups": [
{
"AutoScalingGroupName": "my-asg",
"AutoScalingGroupARN": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480f03:autoScalingGroupName/my-asg",
"LaunchTemplate": {
"LaunchTemplateName": "my-launch-template",
"Version": "1",
"LaunchTemplateId": "lt-1234567890abcde12"
},
"MinSize": 0,
"MaxSize": 1,
"DesiredCapacity": 1,
"DefaultCooldown": 300,
"AvailabilityZones": [
"us-west-2a",
"us-west-2b",
"us-west-2c"
],
"LoadBalancerNames": [],
"TargetGroupARNs": [],
"HealthCheckType": "EC2",
"HealthCheckGracePeriod": 0,
"Instances": [
{
"InstanceId": "i-06905f55584de02da",
"InstanceType": "t2.micro",
"AvailabilityZone": "us-west-2a",
"HealthStatus": "Healthy",
"LifecycleState": "InService",
"ProtectedFromScaleIn": false,
"LaunchTemplate": {
"LaunchTemplateName": "my-launch-template",
"Version": "1",
"LaunchTemplateId": "lt-1234567890abcde12"
}
}
],
"CreatedTime": "2023-10-28T02:39:22.152Z",
"SuspendedProcesses": [],
"VPCZoneIdentifier": "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782",
"EnabledMetrics": [],
"Tags": [],
"TerminationPolicies": [
"Default"
],
"NewInstancesProtectedFromScaleIn": false,
"ServiceLinkedRoleARN":"arn",
"TrafficSources": []
}
]
}
```
**Example 2: To describe the first 100 specified Auto Scaling group**
This example describes the specified Auto Scaling groups. It allows you to specify up to 100 group names.
```
aws autoscaling describe-auto-scaling-groups \
--max-items 100 \
--auto-scaling-group-names "group1" "group2" "group3" "group4"
```
See example 1 for sample output.
**Example 3: To describe an Auto Scaling group in the specified region**
This example describes the Auto Scaling groups in the specified region, up to a maximum of 75 groups.
```
aws autoscaling describe-auto-scaling-groups \
--max-items 75 \
--region us-east-1
```
See example 1 for sample output.
**Example 4: To describe the specified number of Auto Scaling group**
To return a specific number of Auto Scaling groups, use the `--max-items` option.
```
aws autoscaling describe-auto-scaling-groups \
--max-items 1
```
See example 1 for sample output.
If the output includes a `NextToken` field, there are more groups. To get the additional groups, use the value of this field with the `--starting-token` option in a subsequent call as follows.
```
aws autoscaling describe-auto-scaling-groups \
--starting-token Z3M3LMPEXAMPLE
```
See example 1 for sample output.
**Example 5: To describe Auto Scaling groups that use launch configurations**
This example uses the `--query` option to describe Auto Scaling groups that use launch configurations.
```
aws autoscaling describe-auto-scaling-groups \
--query 'AutoScalingGroups[?LaunchConfigurationName!=`null`]'
```
Output:
```
[
{
"AutoScalingGroupName": "my-asg",
"AutoScalingGroupARN": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480f03:autoScalingGroupName/my-asg",
"LaunchConfigurationName": "my-lc",
"MinSize": 0,
"MaxSize": 1,
"DesiredCapacity": 1,
"DefaultCooldown": 300,
"AvailabilityZones": [
"us-west-2a",
"us-west-2b",
"us-west-2c"
],
"LoadBalancerNames": [],
"TargetGroupARNs": [],
"HealthCheckType": "EC2",
"HealthCheckGracePeriod": 0,
"Instances": [
{
"InstanceId": "i-088c57934a6449037",
"InstanceType": "t2.micro",
"AvailabilityZone": "us-west-2c",
"HealthStatus": "Healthy",
"LifecycleState": "InService",
"LaunchConfigurationName": "my-lc",
"ProtectedFromScaleIn": false
}
],
"CreatedTime": "2023-10-28T02:39:22.152Z",
"SuspendedProcesses": [],
"VPCZoneIdentifier": "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782",
"EnabledMetrics": [],
"Tags": [],
"TerminationPolicies": [
"Default"
],
"NewInstancesProtectedFromScaleIn": false,
"ServiceLinkedRoleARN":"arn",
"TrafficSources": []
}
]
```
For more information, see [Filter AWS CLI output](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html) in the *AWS Command Line Interface User Guide*.
+ For API details, see [DescribeAutoScalingGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-auto-scaling-groups.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/autoscale#code-examples).
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.autoscaling.AutoScalingClient;
import software.amazon.awssdk.services.autoscaling.model.AutoScalingException;
import software.amazon.awssdk.services.autoscaling.model.AutoScalingGroup;
import software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsResponse;
import software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest;
import software.amazon.awssdk.services.autoscaling.model.Instance;
import java.util.List;
/**
* Before running this SDK for Java (v2) code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class DescribeAutoScalingInstances {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
groupName - The name of the Auto Scaling group.
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String groupName = args[0];
AutoScalingClient autoScalingClient = AutoScalingClient.builder()
.region(Region.US_EAST_1)
.build();
String instanceId = getAutoScaling(autoScalingClient, groupName);
System.out.println(instanceId);
autoScalingClient.close();
}
public static String getAutoScaling(AutoScalingClient autoScalingClient, String groupName) {
try {
String instanceId = "";
DescribeAutoScalingGroupsRequest scalingGroupsRequest = DescribeAutoScalingGroupsRequest.builder()
.autoScalingGroupNames(groupName)
.build();
DescribeAutoScalingGroupsResponse response = autoScalingClient
.describeAutoScalingGroups(scalingGroupsRequest);
List groups = response.autoScalingGroups();
for (AutoScalingGroup group : groups) {
System.out.println("The group name is " + group.autoScalingGroupName());
System.out.println("The group ARN is " + group.autoScalingGroupARN());
List instances = group.instances();
for (Instance instance : instances) {
instanceId = instance.instanceId();
}
}
return instanceId;
} catch (AutoScalingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return "";
}
}
```
+ For API details, see [DescribeAutoScalingGroups](https://docs.aws.amazon.com/goto/SdkForJavaV2/autoscaling-2011-01-01/DescribeAutoScalingGroups) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/autoscale#code-examples).
```
suspend fun getAutoScalingGroups(groupName: String) {
val scalingGroupsRequest =
DescribeAutoScalingGroupsRequest {
autoScalingGroupNames = listOf(groupName)
}
AutoScalingClient { region = "us-east-1" }.use { autoScalingClient ->
val response = autoScalingClient.describeAutoScalingGroups(scalingGroupsRequest)
response.autoScalingGroups?.forEach { group ->
println("The group name is ${group.autoScalingGroupName}")
println("The group ARN is ${group.autoScalingGroupArn}")
group.instances?.forEach { instance ->
println("The instance id is ${instance.instanceId}")
println("The lifecycle state is " + instance.lifecycleState)
}
}
}
}
```
+ For API details, see [DescribeAutoScalingGroups](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ PHP ]
**SDK for PHP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/auto-scaling#code-examples).
```
public function describeAutoScalingGroups($autoScalingGroupNames)
{
return $this->autoScalingClient->describeAutoScalingGroups([
'AutoScalingGroupNames' => $autoScalingGroupNames
]);
}
```
+ For API details, see [DescribeAutoScalingGroups](https://docs.aws.amazon.com/goto/SdkForPHPV3/autoscaling-2011-01-01/DescribeAutoScalingGroups) in *AWS SDK for PHP API Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example lists the names of your Auto Scaling groups.**
```
Get-ASAutoScalingGroup | format-table -property AutoScalingGroupName
```
**Output:**
```
AutoScalingGroupName
--------------------
my-asg-1
my-asg-2
my-asg-3
my-asg-4
my-asg-5
my-asg-6
```
**Example 2: This example describes the specified Auto Scaling group.**
```
Get-ASAutoScalingGroup -AutoScalingGroupName my-asg-1
```
**Output:**
```
AutoScalingGroupARN : arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480
f03:autoScalingGroupName/my-asg-1
AutoScalingGroupName : my-asg-1
AvailabilityZones : {us-west-2b, us-west-2a}
CreatedTime : 3/1/2015 9:05:31 AM
DefaultCooldown : 300
DesiredCapacity : 2
EnabledMetrics : {}
HealthCheckGracePeriod : 300
HealthCheckType : EC2
Instances : {my-lc}
LaunchConfigurationName : my-lc
LoadBalancerNames : {}
MaxSize : 0
MinSize : 0
PlacementGroup :
Status :
SuspendedProcesses : {}
Tags : {}
TerminationPolicies : {Default}
VPCZoneIdentifier : subnet-e4f33493,subnet-5264e837
```
**Example 3: This example describes the specified two Auto Scaling groups.**
```
Get-ASAutoScalingGroup -AutoScalingGroupName @("my-asg-1", "my-asg-2")
```
**Example 4: This example describes the Auto Scaling instances for the specified Auto Scaling group.**
```
(Get-ASAutoScalingGroup -AutoScalingGroupName my-asg-1).Instances
```
**Example 5: This example describes all your Auto Scaling groups.**
```
Get-ASAutoScalingGroup
```
**Example 6: This example describes LaunchTemplate for the specified Auto Scaling group. This example assumes that the "Instance purchase options" is set to "Adhere to launch template". In case this option is set to "Combine purchase options and instance types", LaunchTemplate could be accessed using "MixedInstancesPolicy.LaunchTemplate" property.**
```
(Get-ASAutoScalingGroup -AutoScalingGroupName my-ag-1).LaunchTemplate
```
**Output:**
```
LaunchTemplateId LaunchTemplateName Version
---------------- ------------------ -------
lt-06095fd619cb40371 test-launch-template $Default
```
+ For API details, see [DescribeAutoScalingGroups](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example lists the names of your Auto Scaling groups.**
```
Get-ASAutoScalingGroup | format-table -property AutoScalingGroupName
```
**Output:**
```
AutoScalingGroupName
--------------------
my-asg-1
my-asg-2
my-asg-3
my-asg-4
my-asg-5
my-asg-6
```
**Example 2: This example describes the specified Auto Scaling group.**
```
Get-ASAutoScalingGroup -AutoScalingGroupName my-asg-1
```
**Output:**
```
AutoScalingGroupARN : arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480
f03:autoScalingGroupName/my-asg-1
AutoScalingGroupName : my-asg-1
AvailabilityZones : {us-west-2b, us-west-2a}
CreatedTime : 3/1/2015 9:05:31 AM
DefaultCooldown : 300
DesiredCapacity : 2
EnabledMetrics : {}
HealthCheckGracePeriod : 300
HealthCheckType : EC2
Instances : {my-lc}
LaunchConfigurationName : my-lc
LoadBalancerNames : {}
MaxSize : 0
MinSize : 0
PlacementGroup :
Status :
SuspendedProcesses : {}
Tags : {}
TerminationPolicies : {Default}
VPCZoneIdentifier : subnet-e4f33493,subnet-5264e837
```
**Example 3: This example describes the specified two Auto Scaling groups.**
```
Get-ASAutoScalingGroup -AutoScalingGroupName @("my-asg-1", "my-asg-2")
```
**Example 4: This example describes the Auto Scaling instances for the specified Auto Scaling group.**
```
(Get-ASAutoScalingGroup -AutoScalingGroupName my-asg-1).Instances
```
**Example 5: This example describes all your Auto Scaling groups.**
```
Get-ASAutoScalingGroup
```
**Example 6: This example describes LaunchTemplate for the specified Auto Scaling group. This example assumes that the "Instance purchase options" is set to "Adhere to launch template". In case this option is set to "Combine purchase options and instance types", LaunchTemplate could be accessed using "MixedInstancesPolicy.LaunchTemplate" property.**
```
(Get-ASAutoScalingGroup -AutoScalingGroupName my-ag-1).LaunchTemplate
```
**Output:**
```
LaunchTemplateId LaunchTemplateName Version
---------------- ------------------ -------
lt-06095fd619cb40371 test-launch-template $Default
```
+ For API details, see [DescribeAutoScalingGroups](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/auto-scaling#code-examples).
```
class AutoScalingWrapper:
"""Encapsulates Amazon EC2 Auto Scaling actions."""
def __init__(self, autoscaling_client):
"""
:param autoscaling_client: A Boto3 Amazon EC2 Auto Scaling client.
"""
self.autoscaling_client = autoscaling_client
def describe_group(self, group_name: str) -> Optional[Dict[str, Any]]:
"""
Gets information about an Auto Scaling group.
:param group_name: The name of the group to look up.
:return: A dictionary with information about the group if found, otherwise None.
:raises ClientError: If there is an error describing the Auto Scaling group.
"""
try:
paginator = self.autoscaling_client.get_paginator(
"describe_auto_scaling_groups"
)
response_iterator = paginator.paginate(AutoScalingGroupNames=[group_name])
groups = []
for response in response_iterator:
groups.extend(response.get("AutoScalingGroups", []))
logger.info(
f"Successfully retrieved information for Auto Scaling group {group_name}."
)
except ClientError as err:
error_code = err.response["Error"]["Code"]
logger.error(f"Failed to describe Auto Scaling group {group_name}.")
if error_code == "ResourceContentionFault":
logger.error(
"There is a conflict with another operation that is modifying the "
f"Auto Scaling group '{group_name}' Please try again later."
)
logger.error(f"Full error:\n\t{err}")
raise
else:
return groups[0] if len(groups) > 0 else None
```
+ For API details, see [DescribeAutoScalingGroups](https://docs.aws.amazon.com/goto/boto3/autoscaling-2011-01-01/DescribeAutoScalingGroups) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/auto-scaling#code-examples).
```
async fn list_groups(client: &Client) -> Result<(), Error> {
let resp = client.describe_auto_scaling_groups().send().await?;
println!("Groups:");
let groups = resp.auto_scaling_groups();
for group in groups {
println!(
"Name: {}",
group.auto_scaling_group_name().unwrap_or("Unknown")
);
println!(
"Arn: {}",
group.auto_scaling_group_arn().unwrap_or("unknown"),
);
println!("Zones: {:?}", group.availability_zones(),);
println!();
}
println!("Found {} group(s)", groups.len());
Ok(())
}
```
+ For API details, see [DescribeAutoScalingGroups](https://docs.rs/aws-sdk-autoscaling/latest/aws_sdk_autoscaling/client/struct.Client.html#method.describe_auto_scaling_groups) in *AWS SDK for Rust API reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/asc#code-examples).
```
DATA lt_group_names TYPE /aws1/cl_ascautoscgroupnames_w=>tt_autoscalinggroupnames.
DATA lo_group_name TYPE REF TO /aws1/cl_ascautoscgroupnames_w.
" Example: iv_group_name = 'my-auto-scaling-group'
TRY.
" Build group names parameter
CREATE OBJECT lo_group_name
EXPORTING
iv_value = iv_group_name.
APPEND lo_group_name TO lt_group_names.
" Describe the Auto Scaling group
DATA(lo_output) = ao_asc->describeautoscalinggroups(
it_autoscalinggroupnames = lt_group_names ).
" Return the first (and only) group in the result
DATA(lt_groups) = lo_output->get_autoscalinggroups( ).
IF lines( lt_groups ) > 0.
READ TABLE lt_groups INDEX 1 INTO DATA(lo_group).
oo_output = lo_group.
ENDIF.
MESSAGE 'Auto Scaling group information retrieved successfully' TYPE 'I'.
CATCH /aws1/cx_ascresrccontionfault INTO DATA(lo_contention).
RAISE EXCEPTION lo_contention.
CATCH /aws1/cx_rt_generic INTO DATA(lo_generic_exception).
RAISE EXCEPTION lo_generic_exception.
ENDTRY.
```
+ For API details, see [DescribeAutoScalingGroups](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `DescribeAutoScalingInstances` with an AWS SDK or CLI
The following code examples show how to use `DescribeAutoScalingInstances`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](auto-scaling_example_auto-scaling_Scenario_GroupsAndInstances_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/AutoScaling#code-examples).
```
///
/// Get data about the instances in an Amazon EC2 Auto Scaling group.
///
/// The name of the Amazon EC2 Auto Scaling group.
/// A list of Amazon EC2 Auto Scaling details.
public async Task> DescribeAutoScalingInstancesAsync(
string groupName)
{
var groups = await DescribeAutoScalingGroupsAsync(groupName);
var instanceIds = new List();
var instanceDetails = new List();
if (groups != null)
{
groups.ForEach(group =>
{
if (group.AutoScalingGroupName == groupName && group.Instances != null)
{
group.Instances.ForEach(instance =>
{
instanceIds.Add(instance.InstanceId);
});
}
});
var scalingGroupsRequest = new DescribeAutoScalingInstancesRequest
{
MaxRecords = 10,
InstanceIds = instanceIds,
};
var response =
await _amazonAutoScaling.DescribeAutoScalingInstancesAsync(
scalingGroupsRequest);
if (response.AutoScalingInstances != null)
{
instanceDetails = response.AutoScalingInstances;
}
}
return instanceDetails;
}
```
+ For API details, see [DescribeAutoScalingInstances](https://docs.aws.amazon.com/goto/DotNetSDKV4/autoscaling-2011-01-01/DescribeAutoScalingInstances) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/autoscaling#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::AutoScaling::AutoScalingClient autoScalingClient(clientConfig);
Aws::AutoScaling::Model::DescribeAutoScalingInstancesRequest request;
request.SetInstanceIds(instanceIDs);
Aws::AutoScaling::Model::DescribeAutoScalingInstancesOutcome outcome =
client.DescribeAutoScalingInstances(request);
if (outcome.IsSuccess()) {
const Aws::Vector &instancesDetails =
outcome.GetResult().GetAutoScalingInstances();
}
else {
std::cerr << "Error with AutoScaling::DescribeAutoScalingInstances. "
<< outcome.GetError().GetMessage()
<< std::endl;
return false;
}
```
+ For API details, see [DescribeAutoScalingInstances](https://docs.aws.amazon.com/goto/SdkForCpp/autoscaling-2011-01-01/DescribeAutoScalingInstances) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To describe one or more instances**
This example describes the specified instance.
```
aws autoscaling describe-auto-scaling-instances \
--instance-ids i-06905f55584de02da
```
Output:
```
{
"AutoScalingInstances": [
{
"InstanceId": "i-06905f55584de02da",
"InstanceType": "t2.micro",
"AutoScalingGroupName": "my-asg",
"AvailabilityZone": "us-west-2b",
"LifecycleState": "InService",
"HealthStatus": "HEALTHY",
"ProtectedFromScaleIn": false,
"LaunchTemplate": {
"LaunchTemplateId": "lt-1234567890abcde12",
"LaunchTemplateName": "my-launch-template",
"Version": "1"
}
}
]
}
```
**Example 2: To describe one or more instances**
This example uses the `--max-items` option to specify how many instances to return with this call.
```
aws autoscaling describe-auto-scaling-instances \
--max-items 1
```
If the output includes a `NextToken` field, there are more instances. To get the additional instances, use the value of this field with the `--starting-token` option in a subsequent call as follows.
```
aws autoscaling describe-auto-scaling-instances \
--starting-token Z3M3LMPEXAMPLE
```
See example 1 for sample output.
**Example 3: To describe instances that use launch configurations**
This example uses the `--query` option to describe instances that use launch configurations.
```
aws autoscaling describe-auto-scaling-instances \
--query 'AutoScalingInstances[?LaunchConfigurationName!=`null`]'
```
Output:
```
[
{
"InstanceId": "i-088c57934a6449037",
"InstanceType": "t2.micro",
"AutoScalingGroupName": "my-asg",
"AvailabilityZone": "us-west-2c",
"LifecycleState": "InService",
"HealthStatus": "HEALTHY",
"LaunchConfigurationName": "my-lc",
"ProtectedFromScaleIn": false
}
]
```
For more information, see [Filter AWS CLI output](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html) in the *AWS Command Line Interface User Guide*.
+ For API details, see [DescribeAutoScalingInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-auto-scaling-instances.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/autoscale#code-examples).
```
public static void describeAutoScalingInstance(AutoScalingClient autoScalingClient, String id) {
try {
DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest = DescribeAutoScalingInstancesRequest
.builder()
.instanceIds(id)
.build();
DescribeAutoScalingInstancesResponse response = autoScalingClient
.describeAutoScalingInstances(describeAutoScalingInstancesRequest);
List instances = response.autoScalingInstances();
for (AutoScalingInstanceDetails instance : instances) {
System.out.println("The instance lifecycle state is: " + instance.lifecycleState());
}
} catch (AutoScalingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ For API details, see [DescribeAutoScalingInstances](https://docs.aws.amazon.com/goto/SdkForJavaV2/autoscaling-2011-01-01/DescribeAutoScalingInstances) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/autoscale#code-examples).
```
suspend fun describeAutoScalingInstance(id: String) {
val describeAutoScalingInstancesRequest =
DescribeAutoScalingInstancesRequest {
instanceIds = listOf(id)
}
AutoScalingClient { region = "us-east-1" }.use { autoScalingClient ->
val response = autoScalingClient.describeAutoScalingInstances(describeAutoScalingInstancesRequest)
response.autoScalingInstances?.forEach { group ->
println("The instance lifecycle state is: ${group.lifecycleState}")
}
}
}
```
+ For API details, see [DescribeAutoScalingInstances](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ PHP ]
**SDK for PHP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/auto-scaling#code-examples).
```
public function describeAutoScalingInstances($instanceIds)
{
return $this->autoScalingClient->describeAutoScalingInstances([
'InstanceIds' => $instanceIds
]);
}
```
+ For API details, see [DescribeAutoScalingInstances](https://docs.aws.amazon.com/goto/SdkForPHPV3/autoscaling-2011-01-01/DescribeAutoScalingInstances) in *AWS SDK for PHP API Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example lists the IDs of your Auto Scaling instances.**
```
Get-ASAutoScalingInstance | format-table -property InstanceId
```
**Output:**
```
InstanceId
----------
i-12345678
i-87654321
i-abcd1234
```
**Example 2: This example describes the specified Auto Scaling instance.**
```
Get-ASAutoScalingInstance -InstanceId i-12345678
```
**Output:**
```
AutoScalingGroupName : my-asg
AvailabilityZone : us-west-2b
HealthStatus : HEALTHY
InstanceId : i-12345678
LaunchConfigurationName : my-lc
LifecycleState : InService
```
**Example 3: This example describes the specified two Auto Scaling instances.**
```
Get-ASAutoScalingInstance -InstanceId @("i-12345678", "i-87654321")
```
**Example 4: This example describes the Auto Scaling instances for the specified Auto Scaling group.**
```
(Get-ASAutoScalingGroup -AutoScalingGroupName my-asg).Instances | Get-ASAutoScalingInstance
```
**Example 5: This example describes all your Auto Scaling instances.**
```
Get-ASAutoScalingInstance
```
+ For API details, see [DescribeAutoScalingInstances](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example lists the IDs of your Auto Scaling instances.**
```
Get-ASAutoScalingInstance | format-table -property InstanceId
```
**Output:**
```
InstanceId
----------
i-12345678
i-87654321
i-abcd1234
```
**Example 2: This example describes the specified Auto Scaling instance.**
```
Get-ASAutoScalingInstance -InstanceId i-12345678
```
**Output:**
```
AutoScalingGroupName : my-asg
AvailabilityZone : us-west-2b
HealthStatus : HEALTHY
InstanceId : i-12345678
LaunchConfigurationName : my-lc
LifecycleState : InService
```
**Example 3: This example describes the specified two Auto Scaling instances.**
```
Get-ASAutoScalingInstance -InstanceId @("i-12345678", "i-87654321")
```
**Example 4: This example describes the Auto Scaling instances for the specified Auto Scaling group.**
```
(Get-ASAutoScalingGroup -AutoScalingGroupName my-asg).Instances | Get-ASAutoScalingInstance
```
**Example 5: This example describes all your Auto Scaling instances.**
```
Get-ASAutoScalingInstance
```
+ For API details, see [DescribeAutoScalingInstances](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/auto-scaling#code-examples).
```
class AutoScalingWrapper:
"""Encapsulates Amazon EC2 Auto Scaling actions."""
def __init__(self, autoscaling_client):
"""
:param autoscaling_client: A Boto3 Amazon EC2 Auto Scaling client.
"""
self.autoscaling_client = autoscaling_client
def describe_instances(self, instance_ids: List[str]) -> List[Dict[str, Any]]:
"""
Gets information about instances.
:param instance_ids: A list of instance IDs to look up.
:return: A list of dictionaries with information about each instance,
or an empty list if none are found.
:raises ClientError: If there is an error describing the instances.
"""
try:
paginator = self.autoscaling_client.get_paginator(
"describe_auto_scaling_instances"
)
response_iterator = paginator.paginate(InstanceIds=instance_ids)
instances = []
for response in response_iterator:
instances.extend(response.get("AutoScalingInstances", []))
logger.info(f"Successfully described instances: {instance_ids}")
except ClientError as err:
error_code = err.response["Error"]["Code"]
logger.error(
f"Couldn't describe instances {instance_ids}. Error code: {error_code}, Message: {err.response['Error']['Message']}"
)
raise
else:
return instances
```
+ For API details, see [DescribeAutoScalingInstances](https://docs.aws.amazon.com/goto/boto3/autoscaling-2011-01-01/DescribeAutoScalingInstances) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/auto-scaling#code-examples).
```
pub async fn list_instances(&self) -> Result, ScenarioError> {
// The direct way to list instances is by using DescribeAutoScalingGroup's instances property. However, this returns a Vec, as opposed to a Vec.
// Ok(self.get_group().await?.instances.unwrap_or_default().map(|i| i.instance_id.clone().unwrap_or_default()).filter(|id| !id.is_empty()).collect())
// Alternatively, and for the sake of example, DescribeAutoScalingInstances returns a list that can be filtered by the client.
self.autoscaling
.describe_auto_scaling_instances()
.into_paginator()
.items()
.send()
.try_collect()
.await
.map(|items| {
items
.into_iter()
.filter(|i| {
i.auto_scaling_group_name.as_deref()
== Some(self.auto_scaling_group_name.as_str())
})
.map(|i| i.instance_id.unwrap_or_default())
.filter(|id| !id.is_empty())
.collect::>()
})
.map_err(|err| ScenarioError::new("Failed to get list of auto scaling instances", &err))
}
```
+ For API details, see [DescribeAutoScalingInstances](https://docs.rs/aws-sdk-autoscaling/latest/aws_sdk_autoscaling/client/struct.Client.html#method.describe_auto_scaling_instances) in *AWS SDK for Rust API reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/asc#code-examples).
```
" Example: it_instance_ids contains a list of instance IDs
TRY.
DATA(lo_output) = ao_asc->describeautoscalinginstances(
it_instanceids = it_instance_ids ).
ot_output = lo_output->get_autoscalinginstances( ).
MESSAGE 'Auto Scaling instances information retrieved successfully' TYPE 'I'.
CATCH /aws1/cx_ascresrccontionfault INTO DATA(lo_contention).
RAISE EXCEPTION lo_contention.
CATCH /aws1/cx_rt_generic INTO DATA(lo_generic_exception).
RAISE EXCEPTION lo_generic_exception.
ENDTRY.
```
+ For API details, see [DescribeAutoScalingInstances](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `DescribeAutoScalingNotificationTypes` with a CLI
The following code examples show how to use `DescribeAutoScalingNotificationTypes`.
------
#### [ CLI ]
**AWS CLI**
**To describe the available notification types**
This example describes the available notification types.
```
aws autoscaling describe-auto-scaling-notification-types
```
Output:
```
{
"AutoScalingNotificationTypes": [
"autoscaling:EC2_INSTANCE_LAUNCH",
"autoscaling:EC2_INSTANCE_LAUNCH_ERROR",
"autoscaling:EC2_INSTANCE_TERMINATE",
"autoscaling:EC2_INSTANCE_TERMINATE_ERROR",
"autoscaling:TEST_NOTIFICATION"
]
}
```
For more information, see [Getting Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DescribeAutoScalingNotificationTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-auto-scaling-notification-types.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example lists the notification types that are supported by Auto Scaling.**
```
Get-ASAutoScalingNotificationType
```
**Output:**
```
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
```
+ For API details, see [DescribeAutoScalingNotificationTypes](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example lists the notification types that are supported by Auto Scaling.**
```
Get-ASAutoScalingNotificationType
```
**Output:**
```
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
```
+ For API details, see [DescribeAutoScalingNotificationTypes](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeLaunchConfigurations` with a CLI
The following code examples show how to use `DescribeLaunchConfigurations`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To describe the specified launch configuration**
This example describes the specified launch configuration.
```
aws autoscaling describe-launch-configurations \
--launch-configuration-names my-launch-config
```
Output:
```
{
"LaunchConfigurations": [
{
"LaunchConfigurationName": "my-launch-config",
"LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config",
"ImageId": "ami-0528a5175983e7f28",
"KeyName": "my-key-pair-uswest2",
"SecurityGroups": [
"sg-05eaec502fcdadc2e"
],
"ClassicLinkVPCSecurityGroups": [],
"UserData": "",
"InstanceType": "t2.micro",
"KernelId": "",
"RamdiskId": "",
"BlockDeviceMappings": [
{
"DeviceName": "/dev/xvda",
"Ebs": {
"SnapshotId": "snap-06c1606ba5ca274b1",
"VolumeSize": 8,
"VolumeType": "gp2",
"DeleteOnTermination": true,
"Encrypted": false
}
}
],
"InstanceMonitoring": {
"Enabled": true
},
"CreatedTime": "2020-10-28T02:39:22.321Z",
"EbsOptimized": false,
"AssociatePublicIpAddress": true,
"MetadataOptions": {
"HttpTokens": "required",
"HttpPutResponseHopLimit": 1,
"HttpEndpoint": "disabled"
}
}
]
}
```
**Example 2: To describe a specified number of launch configurations**
To return a specific number of launch configurations, use the `--max-items` option.
```
aws autoscaling describe-launch-configurations \
--max-items 1
```
If the output includes a `NextToken` field, there are more launch configurations. To get the additional launch configurations, use the value of this field with the `--starting-token` option in a subsequent call as follows.
```
aws autoscaling describe-launch-configurations \
--starting-token Z3M3LMPEXAMPLE
```
+ For API details, see [DescribeLaunchConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-launch-configurations.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example lists the names of your launch configurations.**
```
Get-ASLaunchConfiguration | format-table -property LaunchConfigurationName
```
**Output:**
```
LaunchConfigurationName
-----------------------
my-lc-1
my-lc-2
my-lc-3
my-lc-4
my-lc-5
```
**Example 2: This example describes the specified launch configuration.**
```
Get-ASLaunchConfiguration -LaunchConfigurationName my-lc-1
```
**Output:**
```
AssociatePublicIpAddress : True
BlockDeviceMappings : {/dev/xvda}
ClassicLinkVPCId :
ClassicLinkVPCSecurityGroups : {}
CreatedTime : 12/12/2014 3:22:08 PM
EbsOptimized : False
IamInstanceProfile :
ImageId : ami-043a5034
InstanceMonitoring : Amazon.AutoScaling.Model.InstanceMonitoring
InstanceType : t2.micro
KernelId :
KeyName :
LaunchConfigurationARN : arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:7e5f31e4-693b-4604-9322-
e6f68d7fafad:launchConfigurationName/my-lc-1
LaunchConfigurationName : my-lc-1
PlacementTenancy :
RamdiskId :
SecurityGroups : {sg-67ef0308}
SpotPrice :
UserData :
```
**Example 3: This example describes the specified two launch configurations.**
```
Get-ASLaunchConfiguration -LaunchConfigurationName @("my-lc-1", "my-lc-2")
```
**Example 4: This example describes all your launch configurations.**
```
Get-ASLaunchConfiguration
```
+ For API details, see [DescribeLaunchConfigurations](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example lists the names of your launch configurations.**
```
Get-ASLaunchConfiguration | format-table -property LaunchConfigurationName
```
**Output:**
```
LaunchConfigurationName
-----------------------
my-lc-1
my-lc-2
my-lc-3
my-lc-4
my-lc-5
```
**Example 2: This example describes the specified launch configuration.**
```
Get-ASLaunchConfiguration -LaunchConfigurationName my-lc-1
```
**Output:**
```
AssociatePublicIpAddress : True
BlockDeviceMappings : {/dev/xvda}
ClassicLinkVPCId :
ClassicLinkVPCSecurityGroups : {}
CreatedTime : 12/12/2014 3:22:08 PM
EbsOptimized : False
IamInstanceProfile :
ImageId : ami-043a5034
InstanceMonitoring : Amazon.AutoScaling.Model.InstanceMonitoring
InstanceType : t2.micro
KernelId :
KeyName :
LaunchConfigurationARN : arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:7e5f31e4-693b-4604-9322-
e6f68d7fafad:launchConfigurationName/my-lc-1
LaunchConfigurationName : my-lc-1
PlacementTenancy :
RamdiskId :
SecurityGroups : {sg-67ef0308}
SpotPrice :
UserData :
```
**Example 3: This example describes the specified two launch configurations.**
```
Get-ASLaunchConfiguration -LaunchConfigurationName @("my-lc-1", "my-lc-2")
```
**Example 4: This example describes all your launch configurations.**
```
Get-ASLaunchConfiguration
```
+ For API details, see [DescribeLaunchConfigurations](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeLifecycleHookTypes` with a CLI
The following code examples show how to use `DescribeLifecycleHookTypes`.
------
#### [ CLI ]
**AWS CLI**
**To describe the available lifecycle hook types**
This example describes the available lifecycle hook types.
```
aws autoscaling describe-lifecycle-hook-types
```
Output:
```
{
"LifecycleHookTypes": [
"autoscaling:EC2_INSTANCE_LAUNCHING",
"autoscaling:EC2_INSTANCE_TERMINATING"
]
}
```
+ For API details, see [DescribeLifecycleHookTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-lifecycle-hook-types.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example lists the lifecycle hook types supported by Auto Scaling.**
```
Get-ASLifecycleHookType
```
**Output:**
```
autoscaling:EC2_INSTANCE_LAUNCHING
auto-scaling:EC2_INSTANCE_TERMINATING
```
+ For API details, see [DescribeLifecycleHookTypes](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example lists the lifecycle hook types supported by Auto Scaling.**
```
Get-ASLifecycleHookType
```
**Output:**
```
autoscaling:EC2_INSTANCE_LAUNCHING
auto-scaling:EC2_INSTANCE_TERMINATING
```
+ For API details, see [DescribeLifecycleHookTypes](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeLifecycleHooks` with a CLI
The following code examples show how to use `DescribeLifecycleHooks`.
------
#### [ CLI ]
**AWS CLI**
**To describe your lifecycle hooks**
This example describes the lifecycle hooks for the specified Auto Scaling group.
```
aws autoscaling describe-lifecycle-hooks \
--auto-scaling-group-name my-asg
```
Output:
```
{
"LifecycleHooks": [
{
"GlobalTimeout": 3000,
"HeartbeatTimeout": 30,
"AutoScalingGroupName": "my-asg",
"LifecycleHookName": "my-launch-hook",
"DefaultResult": "ABANDON",
"LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING"
},
{
"GlobalTimeout": 6000,
"HeartbeatTimeout": 60,
"AutoScalingGroupName": "my-asg",
"LifecycleHookName": "my-termination-hook",
"DefaultResult": "CONTINUE",
"LifecycleTransition": "autoscaling:EC2_INSTANCE_TERMINATING"
}
]
}
```
+ For API details, see [DescribeLifecycleHooks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-lifecycle-hooks.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example describes the specified lifecycle hook.**
```
Get-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook
```
**Output:**
```
AutoScalingGroupName : my-asg
DefaultResult : ABANDON
GlobalTimeout : 172800
HeartbeatTimeout : 3600
LifecycleHookName : myLifecycleHook
LifecycleTransition : auto-scaling:EC2_INSTANCE_LAUNCHING
NotificationMetadata :
NotificationTargetARN : arn:aws:sns:us-west-2:123456789012:my-topic
RoleARN : arn:aws:iam::123456789012:role/my-iam-role
```
**Example 2: This example describes all lifecycle hooks for the specified Auto Scaling group.**
```
Get-ASLifecycleHook -AutoScalingGroupName my-asg
```
**Example 3: This example describes all lifecycle hooks for all your Auto Scaling groups.**
```
Get-ASLifecycleHook
```
+ For API details, see [DescribeLifecycleHooks](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example describes the specified lifecycle hook.**
```
Get-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook
```
**Output:**
```
AutoScalingGroupName : my-asg
DefaultResult : ABANDON
GlobalTimeout : 172800
HeartbeatTimeout : 3600
LifecycleHookName : myLifecycleHook
LifecycleTransition : auto-scaling:EC2_INSTANCE_LAUNCHING
NotificationMetadata :
NotificationTargetARN : arn:aws:sns:us-west-2:123456789012:my-topic
RoleARN : arn:aws:iam::123456789012:role/my-iam-role
```
**Example 2: This example describes all lifecycle hooks for the specified Auto Scaling group.**
```
Get-ASLifecycleHook -AutoScalingGroupName my-asg
```
**Example 3: This example describes all lifecycle hooks for all your Auto Scaling groups.**
```
Get-ASLifecycleHook
```
+ For API details, see [DescribeLifecycleHooks](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeLoadBalancers` with a CLI
The following code examples show how to use `DescribeLoadBalancers`.
------
#### [ CLI ]
**AWS CLI**
**To describe the Classic Load Balancers for an Auto Scaling group**
This example describes the Classic Load Balancers for the specified Auto Scaling group.
```
aws autoscaling describe-load-balancers \
--auto-scaling-group-name my-asg
```
Output:
```
{
"LoadBalancers": [
{
"State": "Added",
"LoadBalancerName": "my-load-balancer"
}
]
}
```
+ For API details, see [DescribeLoadBalancers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-load-balancers.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example describes the load balancers for the specified Auto Scaling group.**
```
Get-ASLoadBalancer -AutoScalingGroupName my-asg
```
**Output:**
```
LoadBalancerName State
---------------- -----
my-lb Added
```
+ For API details, see [DescribeLoadBalancers](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example describes the load balancers for the specified Auto Scaling group.**
```
Get-ASLoadBalancer -AutoScalingGroupName my-asg
```
**Output:**
```
LoadBalancerName State
---------------- -----
my-lb Added
```
+ For API details, see [DescribeLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeMetricCollectionTypes` with a CLI
The following code examples show how to use `DescribeMetricCollectionTypes`.
------
#### [ CLI ]
**AWS CLI**
**To describe the available metric collection types**
This example describes the available metric collection types.
```
aws autoscaling describe-metric-collection-types
```
Output:
```
{
"Metrics": [
{
"Metric": "GroupMinSize"
},
{
"Metric": "GroupMaxSize"
},
{
"Metric": "GroupDesiredCapacity"
},
{
"Metric": "GroupInServiceInstances"
},
{
"Metric": "GroupInServiceCapacity"
},
{
"Metric": "GroupPendingInstances"
},
{
"Metric": "GroupPendingCapacity"
},
{
"Metric": "GroupTerminatingInstances"
},
{
"Metric": "GroupTerminatingCapacity"
},
{
"Metric": "GroupStandbyInstances"
},
{
"Metric": "GroupStandbyCapacity"
},
{
"Metric": "GroupTotalInstances"
},
{
"Metric": "GroupTotalCapacity"
}
],
"Granularities": [
{
"Granularity": "1Minute"
}
]
}
```
For more information, see [Auto Scaling group metrics](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html#as-group-metrics) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DescribeMetricCollectionTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-metric-collection-types.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example lists the metric collection types that are supported by Auto Scaling.**
```
(Get-ASMetricCollectionType).Metrics
```
**Output:**
```
Metric
------
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupStandbyInstances
GroupTotalInstances
```
**Example 2: This example lists the corresponding granularities.**
```
(Get-ASMetricCollectionType).Granularities
```
**Output:**
```
Granularity
-----------
1Minute
```
+ For API details, see [DescribeMetricCollectionTypes](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example lists the metric collection types that are supported by Auto Scaling.**
```
(Get-ASMetricCollectionType).Metrics
```
**Output:**
```
Metric
------
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupStandbyInstances
GroupTotalInstances
```
**Example 2: This example lists the corresponding granularities.**
```
(Get-ASMetricCollectionType).Granularities
```
**Output:**
```
Granularity
-----------
1Minute
```
+ For API details, see [DescribeMetricCollectionTypes](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeNotificationConfigurations` with a CLI
The following code examples show how to use `DescribeNotificationConfigurations`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To describe the notification configurations of a specified group**
This example describes the notification configurations for the specified Auto Scaling group.
```
aws autoscaling describe-notification-configurations \
--auto-scaling-group-name my-asg
```
Output:
```
{
"NotificationConfigurations": [
{
"AutoScalingGroupName": "my-asg",
"NotificationType": "autoscaling:TEST_NOTIFICATION",
"TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2"
},
{
"AutoScalingGroupName": "my-asg",
"NotificationType": "autoscaling:TEST_NOTIFICATION",
"TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic"
}
]
}
```
For more information, see [Getting Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 1: To describe a specified number of notification configurations**
To return a specific number of notification configurations, use the `max-items` parameter.
```
aws autoscaling describe-notification-configurations \
--auto-scaling-group-name my-auto-scaling-group \
--max-items 1
```
Output:
```
{
"NotificationConfigurations": [
{
"AutoScalingGroupName": "my-asg",
"NotificationType": "autoscaling:TEST_NOTIFICATION",
"TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2"
},
{
"AutoScalingGroupName": "my-asg",
"NotificationType": "autoscaling:TEST_NOTIFICATION",
"TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic"
}
]
}
```
If the output includes a `NextToken` field, there are more notification configurations. To get the additional notification configurations, use the value of this field with the `starting-token` parameter in a subsequent call as follows.
```
aws autoscaling describe-notification-configurations \
--auto-scaling-group-name my-asg \
--starting-token Z3M3LMPEXAMPLE
```
For more information, see [Getting Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DescribeNotificationConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-notification-configurations.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example describes the notification actions associated with the specified Auto Scaling group.**
```
Get-ASNotificationConfiguration -AutoScalingGroupName my-asg | format-list
```
**Output:**
```
AutoScalingGroupName : my-asg
NotificationType : auto-scaling:EC2_INSTANCE_LAUNCH
TopicARN : arn:aws:sns:us-west-2:123456789012:my-topic
AutoScalingGroupName : my-asg
NotificationType : auto-scaling:EC2_INSTANCE_TERMINATE
TopicARN : arn:aws:sns:us-west-2:123456789012:my-topic
```
**Example 2: This example describes the notification actions associated with all your Auto Scaling groups.**
```
Get-ASNotificationConfiguration
```
+ For API details, see [DescribeNotificationConfigurations](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example describes the notification actions associated with the specified Auto Scaling group.**
```
Get-ASNotificationConfiguration -AutoScalingGroupName my-asg | format-list
```
**Output:**
```
AutoScalingGroupName : my-asg
NotificationType : auto-scaling:EC2_INSTANCE_LAUNCH
TopicARN : arn:aws:sns:us-west-2:123456789012:my-topic
AutoScalingGroupName : my-asg
NotificationType : auto-scaling:EC2_INSTANCE_TERMINATE
TopicARN : arn:aws:sns:us-west-2:123456789012:my-topic
```
**Example 2: This example describes the notification actions associated with all your Auto Scaling groups.**
```
Get-ASNotificationConfiguration
```
+ For API details, see [DescribeNotificationConfigurations](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribePolicies` with a CLI
The following code examples show how to use `DescribePolicies`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To describe the scaling policies of a specified group**
This example describes the scaling policies for the specified Auto Scaling group.
```
aws autoscaling describe-policies \
--auto-scaling-group-name my-asg
```
Output:
```
{
"ScalingPolicies": [
{
"AutoScalingGroupName": "my-asg",
"PolicyName": "alb1000-target-tracking-scaling-policy",
"PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:3065d9c8-9969-4bec-bb6a-3fbe5550fde6:autoScalingGroupName/my-asg:policyName/alb1000-target-tracking-scaling-policy",
"PolicyType": "TargetTrackingScaling",
"StepAdjustments": [],
"Alarms": [
{
"AlarmName": "TargetTracking-my-asg-AlarmHigh-924887a9-12d7-4e01-8686-6f844d13a196",
"AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmHigh-924887a9-12d7-4e01-8686-6f844d13a196"
},
{
"AlarmName": "TargetTracking-my-asg-AlarmLow-f96f899d-b8e7-4d09-a010-c1aaa35da296",
"AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmLow-f96f899d-b8e7-4d09-a010-c1aaa35da296"
}
],
"TargetTrackingConfiguration": {
"PredefinedMetricSpecification": {
"PredefinedMetricType": "ALBRequestCountPerTarget",
"ResourceLabel": "app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff"
},
"TargetValue": 1000.0,
"DisableScaleIn": false
},
"Enabled": true
},
{
"AutoScalingGroupName": "my-asg",
"PolicyName": "cpu40-target-tracking-scaling-policy",
"PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:5fd26f71-39d4-4690-82a9-b8515c45cdde:autoScalingGroupName/my-asg:policyName/cpu40-target-tracking-scaling-policy",
"PolicyType": "TargetTrackingScaling",
"StepAdjustments": [],
"Alarms": [
{
"AlarmName": "TargetTracking-my-asg-AlarmHigh-139f9789-37b9-42ad-bea5-b5b147d7f473",
"AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmHigh-139f9789-37b9-42ad-bea5-b5b147d7f473"
},
{
"AlarmName": "TargetTracking-my-asg-AlarmLow-bd681c67-fc18-4c56-8468-fb8e413009c9",
"AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmLow-bd681c67-fc18-4c56-8468-fb8e413009c9"
}
],
"TargetTrackingConfiguration": {
"PredefinedMetricSpecification": {
"PredefinedMetricType": "ASGAverageCPUUtilization"
},
"TargetValue": 40.0,
"DisableScaleIn": false
},
"Enabled": true
}
]
}
```
For more information, see [Dynamic scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 2: To describe the scaling policies of a specified name**
To return specific scaling policies, use the `--policy-names` option.
```
aws autoscaling describe-policies \
--auto-scaling-group-name my-asg \
--policy-names cpu40-target-tracking-scaling-policy
```
See example 1 for sample output.
For more information, see [Dynamic scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 3: To describe a number of scaling policies**
To return a specific number of policies, use the `--max-items` option.
```
aws autoscaling describe-policies \
--auto-scaling-group-name my-asg \
--max-items 1
```
See example 1 for sample output.
If the output includes a `NextToken` field, use the value of this field with the `--starting-token` option in a subsequent call to get the additional policies.
```
aws autoscaling describe-policies --auto-scaling-group-name my-asg --starting-token Z3M3LMPEXAMPLE
```
For more information, see [Dynamic scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DescribePolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-policies.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example describes all policies for the specified Auto Scaling group.**
```
Get-ASPolicy -AutoScalingGroupName my-asg
```
**Output:**
```
AdjustmentType : ChangeInCapacity
Alarms : {}
AutoScalingGroupName : my-asg
Cooldown : 0
EstimatedInstanceWarmup : 0
MetricAggregationType :
MinAdjustmentMagnitude : 0
MinAdjustmentStep : 0
PolicyARN : arn:aws:auto-scaling:us-west-2:123456789012:scalingPolicy:aa3836ab-5462-42c7-adab-e1d769fc24ef
:autoScalingGroupName/my-asg:policyName/myScaleInPolicy
PolicyName : myScaleInPolicy
PolicyType : SimpleScaling
ScalingAdjustment : -1
StepAdjustments : {}
```
**Example 2: This example describes the specified policies for the specified Auto Scaling group.**
```
Get-ASPolicy -AutoScalingGroupName my-asg -PolicyName @("myScaleOutPolicy", "myScaleInPolicy")
```
**Example 3: This example describes all policies for all your Auto Scaling groups.**
```
Get-ASPolicy
```
+ For API details, see [DescribePolicies](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example describes all policies for the specified Auto Scaling group.**
```
Get-ASPolicy -AutoScalingGroupName my-asg
```
**Output:**
```
AdjustmentType : ChangeInCapacity
Alarms : {}
AutoScalingGroupName : my-asg
Cooldown : 0
EstimatedInstanceWarmup : 0
MetricAggregationType :
MinAdjustmentMagnitude : 0
MinAdjustmentStep : 0
PolicyARN : arn:aws:auto-scaling:us-west-2:123456789012:scalingPolicy:aa3836ab-5462-42c7-adab-e1d769fc24ef
:autoScalingGroupName/my-asg:policyName/myScaleInPolicy
PolicyName : myScaleInPolicy
PolicyType : SimpleScaling
ScalingAdjustment : -1
StepAdjustments : {}
```
**Example 2: This example describes the specified policies for the specified Auto Scaling group.**
```
Get-ASPolicy -AutoScalingGroupName my-asg -PolicyName @("myScaleOutPolicy", "myScaleInPolicy")
```
**Example 3: This example describes all policies for all your Auto Scaling groups.**
```
Get-ASPolicy
```
+ For API details, see [DescribePolicies](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeScalingActivities` with an AWS SDK or CLI
The following code examples show how to use `DescribeScalingActivities`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](auto-scaling_example_auto-scaling_Scenario_GroupsAndInstances_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/AutoScaling#code-examples).
```
///
/// Retrieve a list of the Amazon EC2 Auto Scaling activities for an
/// Amazon EC2 Auto Scaling group.
///
/// The name of the Amazon EC2 Auto Scaling group.
/// A list of Amazon EC2 Auto Scaling activities.
public async Task> DescribeScalingActivitiesAsync(
string groupName)
{
var activities = new List();
var scalingActivitiesRequest = new DescribeScalingActivitiesRequest
{
AutoScalingGroupName = groupName,
MaxRecords = 10,
};
var response = await _amazonAutoScaling.DescribeScalingActivitiesAsync(scalingActivitiesRequest);
if (response.Activities != null)
{
activities = response.Activities;
}
return activities;
}
```
+ For API details, see [DescribeScalingActivities](https://docs.aws.amazon.com/goto/DotNetSDKV4/autoscaling-2011-01-01/DescribeScalingActivities) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/autoscaling#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::AutoScaling::AutoScalingClient autoScalingClient(clientConfig);
Aws::AutoScaling::Model::DescribeScalingActivitiesRequest request;
request.SetAutoScalingGroupName(groupName);
Aws::Vector allActivities;
Aws::String nextToken; // Used for pagination;
do {
if (!nextToken.empty()) {
request.SetNextToken(nextToken);
}
Aws::AutoScaling::Model::DescribeScalingActivitiesOutcome outcome =
autoScalingClient.DescribeScalingActivities(request);
if (outcome.IsSuccess()) {
const Aws::Vector &activities =
outcome.GetResult().GetActivities();
allActivities.insert(allActivities.end(), activities.begin(), activities.end());
nextToken = outcome.GetResult().GetNextToken();
}
else {
std::cerr << "Error with AutoScaling::DescribeScalingActivities. "
<< outcome.GetError().GetMessage()
<< std::endl;
}
} while (!nextToken.empty());
std::cout << "Found " << allActivities.size() << " activities."
<< std::endl;
std::cout << "Activities are ordered with the most recent first."
<< std::endl;
for (const Aws::AutoScaling::Model::Activity &activity: allActivities) {
std::cout << activity.GetDescription() << std::endl;
std::cout << activity.GetDetails() << std::endl;
}
```
+ For API details, see [DescribeScalingActivities](https://docs.aws.amazon.com/goto/SdkForCpp/autoscaling-2011-01-01/DescribeScalingActivities) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To describe scaling activities for the specified group**
This example describes the scaling activities for the specified Auto Scaling group.
```
aws autoscaling describe-scaling-activities \
--auto-scaling-group-name my-asg
```
Output:
```
{
"Activities": [
{
"ActivityId": "f9f2d65b-f1f2-43e7-b46d-d86756459699",
"Description": "Launching a new EC2 instance: i-0d44425630326060f",
"AutoScalingGroupName": "my-asg",
"Cause": "At 2020-10-30T19:35:51Z a user request update of AutoScalingGroup constraints to min: 0, max: 16, desired: 16 changing the desired capacity from 0 to 16. At 2020-10-30T19:36:07Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 16.",
"StartTime": "2020-10-30T19:36:09.766Z",
"EndTime": "2020-10-30T19:36:41Z",
"StatusCode": "Successful",
"Progress": 100,
"Details": "{\"Subnet ID\":\"subnet-5ea0c127\",\"Availability Zone\":\"us-west-2b\"}"
}
]
}
```
For more information, see [Verify a scaling activity for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 2: To describe the scaling activities for a deleted group**
To describe scaling activities after the Auto Scaling group has been deleted, add the `--include-deleted-groups` option.
```
aws autoscaling describe-scaling-activities \
--auto-scaling-group-name my-asg \
--include-deleted-groups
```
Output:
```
{
"Activities": [
{
"ActivityId": "e1f5de0e-f93e-1417-34ac-092a76fba220",
"Description": "Launching a new EC2 instance. Status Reason: Your Spot request price of 0.001 is lower than the minimum required Spot request fulfillment price of 0.0031. Launching EC2 instance failed.",
"AutoScalingGroupName": "my-asg",
"Cause": "At 2021-01-13T20:47:24Z a user request update of AutoScalingGroup constraints to min: 1, max: 5, desired: 3 changing the desired capacity from 0 to 3. At 2021-01-13T20:47:27Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 3.",
"StartTime": "2021-01-13T20:47:30.094Z",
"EndTime": "2021-01-13T20:47:30Z",
"StatusCode": "Failed",
"StatusMessage": "Your Spot request price of 0.001 is lower than the minimum required Spot request fulfillment price of 0.0031. Launching EC2 instance failed.",
"Progress": 100,
"Details": "{\"Subnet ID\":\"subnet-5ea0c127\",\"Availability Zone\":\"us-west-2b\"}",
"AutoScalingGroupState": "Deleted",
"AutoScalingGroupARN": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:283179a2-f3ce-423d-93f6-66bb518232f7:autoScalingGroupName/my-asg"
}
]
}
```
For more information, see [Troubleshoot Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/CHAP_Troubleshooting.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 3: To describe a specified number of scaling activities**
To return a specific number of activities, use the `--max-items` option.
```
aws autoscaling describe-scaling-activities \
--max-items 1
```
Output:
```
{
"Activities": [
{
"ActivityId": "f9f2d65b-f1f2-43e7-b46d-d86756459699",
"Description": "Launching a new EC2 instance: i-0d44425630326060f",
"AutoScalingGroupName": "my-asg",
"Cause": "At 2020-10-30T19:35:51Z a user request update of AutoScalingGroup constraints to min: 0, max: 16, desired: 16 changing the desired capacity from 0 to 16. At 2020-10-30T19:36:07Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 16.",
"StartTime": "2020-10-30T19:36:09.766Z",
"EndTime": "2020-10-30T19:36:41Z",
"StatusCode": "Successful",
"Progress": 100,
"Details": "{\"Subnet ID\":\"subnet-5ea0c127\",\"Availability Zone\":\"us-west-2b\"}"
}
]
}
```
If the output includes a `NextToken` field, there are more activities. To get the additional activities, use the value of this field with the `--starting-token` option in a subsequent call as follows.
```
aws autoscaling describe-scaling-activities \
--starting-token Z3M3LMPEXAMPLE
```
For more information, see [Verify a scaling activity for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DescribeScalingActivities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-scaling-activities.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/autoscale#code-examples).
```
public static void describeScalingActivities(AutoScalingClient autoScalingClient, String groupName) {
try {
DescribeScalingActivitiesRequest scalingActivitiesRequest = DescribeScalingActivitiesRequest.builder()
.autoScalingGroupName(groupName)
.maxRecords(10)
.build();
DescribeScalingActivitiesResponse response = autoScalingClient
.describeScalingActivities(scalingActivitiesRequest);
List activities = response.activities();
for (Activity activity : activities) {
System.out.println("The activity Id is " + activity.activityId());
System.out.println("The activity details are " + activity.details());
}
} catch (AutoScalingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ For API details, see [DescribeScalingActivities](https://docs.aws.amazon.com/goto/SdkForJavaV2/autoscaling-2011-01-01/DescribeScalingActivities) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/autoscale#code-examples).
```
suspend fun describeAutoScalingGroups(groupName: String) {
val groupsReques =
DescribeAutoScalingGroupsRequest {
autoScalingGroupNames = listOf(groupName)
maxRecords = 10
}
AutoScalingClient { region = "us-east-1" }.use { autoScalingClient ->
val response = autoScalingClient.describeAutoScalingGroups(groupsReques)
response.autoScalingGroups?.forEach { group ->
println("The service to use for the health checks: ${group.healthCheckType}")
}
}
}
```
+ For API details, see [DescribeScalingActivities](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ PHP ]
**SDK for PHP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/auto-scaling#code-examples).
```
public function describeScalingActivities($autoScalingGroupName)
{
return $this->autoScalingClient->describeScalingActivities([
'AutoScalingGroupName' => $autoScalingGroupName,
]);
}
```
+ For API details, see [DescribeScalingActivities](https://docs.aws.amazon.com/goto/SdkForPHPV3/autoscaling-2011-01-01/DescribeScalingActivities) in *AWS SDK for PHP API Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example describes the scaling activities for the last six weeks for the specified Auto Scaling group.**
```
Get-ASScalingActivity -AutoScalingGroupName my-asg
```
**Output:**
```
ActivityId : 063308ae-aa22-4a9b-94f4-9fae4EXAMPLE
AutoScalingGroupName : my-asg
Cause : At 2015-11-22T15:45:16Z a user request explicitly set group desired capacity changing the desired
capacity from 1 to 2. At 2015-11-22T15:45:34Z an instance was started in response to a difference
between desired and actual capacity, increasing the capacity from 1 to 2.
Description : Launching a new EC2 instance: i-26e715fc
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime : 11/22/2015 7:46:09 AM
Progress : 100
StartTime : 11/22/2015 7:45:35 AM
StatusCode : Successful
StatusMessage :
ActivityId : ce719997-086d-4c73-a2f1-ab703EXAMPLE
AutoScalingGroupName : my-asg
Cause : At 2015-11-20T22:57:53Z a user request created an AutoScalingGroup changing the desired capacity
from 0 to 1. At 2015-11-20T22:57:58Z an instance was started in response to a difference betwe
en desired and actual capacity, increasing the capacity from 0 to 1.
Description : Launching a new EC2 instance: i-93633f9b
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime : 11/20/2015 2:58:32 PM
Progress : 100
StartTime : 11/20/2015 2:57:59 PM
StatusCode : Successful
StatusMessage :
```
**Example 2: This example describes the specified scaling activity.**
```
Get-ASScalingActivity -ActivityId "063308ae-aa22-4a9b-94f4-9fae4EXAMPLE"
```
**Example 3: This example describes the scaling activities for the last six weeks for all your Auto Scaling groups.**
```
Get-ASScalingActivity
```
+ For API details, see [DescribeScalingActivities](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example describes the scaling activities for the last six weeks for the specified Auto Scaling group.**
```
Get-ASScalingActivity -AutoScalingGroupName my-asg
```
**Output:**
```
ActivityId : 063308ae-aa22-4a9b-94f4-9fae4EXAMPLE
AutoScalingGroupName : my-asg
Cause : At 2015-11-22T15:45:16Z a user request explicitly set group desired capacity changing the desired
capacity from 1 to 2. At 2015-11-22T15:45:34Z an instance was started in response to a difference
between desired and actual capacity, increasing the capacity from 1 to 2.
Description : Launching a new EC2 instance: i-26e715fc
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime : 11/22/2015 7:46:09 AM
Progress : 100
StartTime : 11/22/2015 7:45:35 AM
StatusCode : Successful
StatusMessage :
ActivityId : ce719997-086d-4c73-a2f1-ab703EXAMPLE
AutoScalingGroupName : my-asg
Cause : At 2015-11-20T22:57:53Z a user request created an AutoScalingGroup changing the desired capacity
from 0 to 1. At 2015-11-20T22:57:58Z an instance was started in response to a difference betwe
en desired and actual capacity, increasing the capacity from 0 to 1.
Description : Launching a new EC2 instance: i-93633f9b
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime : 11/20/2015 2:58:32 PM
Progress : 100
StartTime : 11/20/2015 2:57:59 PM
StatusCode : Successful
StatusMessage :
```
**Example 2: This example describes the specified scaling activity.**
```
Get-ASScalingActivity -ActivityId "063308ae-aa22-4a9b-94f4-9fae4EXAMPLE"
```
**Example 3: This example describes the scaling activities for the last six weeks for all your Auto Scaling groups.**
```
Get-ASScalingActivity
```
+ For API details, see [DescribeScalingActivities](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/auto-scaling#code-examples).
```
class AutoScalingWrapper:
"""Encapsulates Amazon EC2 Auto Scaling actions."""
def __init__(self, autoscaling_client):
"""
:param autoscaling_client: A Boto3 Amazon EC2 Auto Scaling client.
"""
self.autoscaling_client = autoscaling_client
def describe_scaling_activities(self, group_name: str) -> List[Dict[str, Any]]:
"""
Gets information about scaling activities for the group. Scaling activities
are things like instances stopping or starting in response to user requests
or capacity changes.
:param group_name: The name of the group to look up.
:return: A list of dictionaries representing the scaling activities for the
group, ordered with the most recent activity first.
:raises ClientError: If there is an error describing the scaling activities.
"""
try:
paginator = self.autoscaling_client.get_paginator(
"describe_scaling_activities"
)
response_iterator = paginator.paginate(AutoScalingGroupName=group_name)
activities = []
for response in response_iterator:
activities.extend(response.get("Activities", []))
logger.info(
f"Successfully described scaling activities for group '{group_name}'."
)
except ClientError as err:
error_code = err.response["Error"]["Code"]
logger.error(
f"Couldn't describe scaling activities for group '{group_name}'. Error code: {error_code}, Message: {err.response['Error']['Message']}"
)
if error_code == "ResourceContentionFault":
logger.error(
f"There is a conflict with another operation that is modifying the Auto Scaling group '{group_name}'. "
"Please try again later."
)
raise
else:
return activities
```
+ For API details, see [DescribeScalingActivities](https://docs.aws.amazon.com/goto/boto3/autoscaling-2011-01-01/DescribeScalingActivities) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/auto-scaling#code-examples).
```
pub async fn describe_scenario(&self) -> AutoScalingScenarioDescription {
let group = self
.autoscaling
.describe_auto_scaling_groups()
.auto_scaling_group_names(self.auto_scaling_group_name.clone())
.send()
.await
.map(|s| {
s.auto_scaling_groups()
.iter()
.map(|s| {
format!(
"{}: {}",
s.auto_scaling_group_name().unwrap_or("Unknown"),
s.status().unwrap_or("Unknown")
)
})
.collect::>()
})
.map_err(|e| {
ScenarioError::new("Failed to describe auto scaling groups for scenario", &e)
});
let instances = self
.list_instances()
.await
.map_err(|e| anyhow!("There was an error listing instances: {e}",));
// 10. DescribeScalingActivities: list the scaling activities that have occurred for the group so far.
// Bonus: use CloudWatch API to get and show some metrics collected for the group.
// CW.ListMetrics with Namespace='AWS/AutoScaling' and Dimensions=[{'Name': 'AutoScalingGroupName', 'Value': }]
// CW.GetMetricStatistics with Statistics='Sum'. Start and End times must be in UTC!
let activities = self
.autoscaling
.describe_scaling_activities()
.auto_scaling_group_name(self.auto_scaling_group_name.clone())
.into_paginator()
.items()
.send()
.collect::, _>>()
.await
.map_err(|e| {
anyhow!(
"There was an error retrieving scaling activities: {}",
DisplayErrorContext(&e)
)
});
AutoScalingScenarioDescription {
group,
instances,
activities,
}
}
```
+ For API details, see [DescribeScalingActivities](https://docs.rs/aws-sdk-autoscaling/latest/aws_sdk_autoscaling/client/struct.Client.html#method.describe_scaling_activities) in *AWS SDK for Rust API reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/asc#code-examples).
```
" Example: iv_group_name = 'my-auto-scaling-group'
TRY.
DATA(lo_output) = ao_asc->describescalingactivities(
iv_autoscalinggroupname = iv_group_name ).
ot_output = lo_output->get_activities( ).
MESSAGE 'Scaling activities retrieved successfully' TYPE 'I'.
CATCH /aws1/cx_ascresrccontionfault INTO DATA(lo_contention).
RAISE EXCEPTION lo_contention.
CATCH /aws1/cx_rt_generic INTO DATA(lo_generic_exception).
RAISE EXCEPTION lo_generic_exception.
ENDTRY.
```
+ For API details, see [DescribeScalingActivities](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `DescribeScalingProcessTypes` with a CLI
The following code examples show how to use `DescribeScalingProcessTypes`.
------
#### [ CLI ]
**AWS CLI**
**To describe the available process types**
This example describes the available process types.
```
aws autoscaling describe-scaling-process-types
```
Output:
```
{
"Processes": [
{
"ProcessName": "AZRebalance"
},
{
"ProcessName": "AddToLoadBalancer"
},
{
"ProcessName": "AlarmNotification"
},
{
"ProcessName": "HealthCheck"
},
{
"ProcessName": "InstanceRefresh"
},
{
"ProcessName": "Launch"
},
{
"ProcessName": "ReplaceUnhealthy"
},
{
"ProcessName": "ScheduledActions"
},
{
"ProcessName": "Terminate"
}
]
}
```
For more information, see [Suspending and resuming scaling processes](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DescribeScalingProcessTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-scaling-process-types.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example lists the process types that are supported by Auto Scaling.**
```
Get-ASScalingProcessType
```
**Output:**
```
ProcessName
-----------
AZRebalance
AddToLoadBalancer
AlarmNotification
HealthCheck
Launch
ReplaceUnhealthy
ScheduledActions
Terminate
```
+ For API details, see [DescribeScalingProcessTypes](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example lists the process types that are supported by Auto Scaling.**
```
Get-ASScalingProcessType
```
**Output:**
```
ProcessName
-----------
AZRebalance
AddToLoadBalancer
AlarmNotification
HealthCheck
Launch
ReplaceUnhealthy
ScheduledActions
Terminate
```
+ For API details, see [DescribeScalingProcessTypes](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeScheduledActions` with a CLI
The following code examples show how to use `DescribeScheduledActions`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To describe all scheduled actions**
This example describes all your scheduled actions.
```
aws autoscaling describe-scheduled-actions
```
Output:
```
{
"ScheduledUpdateGroupActions": [
{
"AutoScalingGroupName": "my-asg",
"ScheduledActionName": "my-recurring-action",
"Recurrence": "30 0 1 1,6,12 *",
"ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action",
"StartTime": "2023-12-01T04:00:00Z",
"Time": "2023-12-01T04:00:00Z",
"MinSize": 1,
"MaxSize": 6,
"DesiredCapacity": 4,
"TimeZone": "America/New_York"
}
]
}
```
For more information, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 2: To describe scheduled actions for the specified group**
To describe the scheduled actions for a specific Auto Scaling group, use the `--auto-scaling-group-name` option.
```
aws autoscaling describe-scheduled-actions \
--auto-scaling-group-name my-asg
```
Output:
```
{
"ScheduledUpdateGroupActions": [
{
"AutoScalingGroupName": "my-asg",
"ScheduledActionName": "my-recurring-action",
"Recurrence": "30 0 1 1,6,12 *",
"ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action",
"StartTime": "2023-12-01T04:00:00Z",
"Time": "2023-12-01T04:00:00Z",
"MinSize": 1,
"MaxSize": 6,
"DesiredCapacity": 4,
"TimeZone": "America/New_York"
}
]
}
```
For more information, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 3: To describe the specified scheduled action**
To describe a specific scheduled action, use the `--scheduled-action-names` option.
```
aws autoscaling describe-scheduled-actions \
--scheduled-action-names my-recurring-action
```
Output:
```
{
"ScheduledUpdateGroupActions": [
{
"AutoScalingGroupName": "my-asg",
"ScheduledActionName": "my-recurring-action",
"Recurrence": "30 0 1 1,6,12 *",
"ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action",
"StartTime": "2023-12-01T04:00:00Z",
"Time": "2023-12-01T04:00:00Z",
"MinSize": 1,
"MaxSize": 6,
"DesiredCapacity": 4,
"TimeZone": "America/New_York"
}
]
}
```
For more information, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 4: To describe scheduled actions with a specified start time**
To describe the scheduled actions that start at a specific time, use the `--start-time` option.
```
aws autoscaling describe-scheduled-actions \
--start-time "2023-12-01T04:00:00Z"
```
Output:
```
{
"ScheduledUpdateGroupActions": [
{
"AutoScalingGroupName": "my-asg",
"ScheduledActionName": "my-recurring-action",
"Recurrence": "30 0 1 1,6,12 *",
"ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action",
"StartTime": "2023-12-01T04:00:00Z",
"Time": "2023-12-01T04:00:00Z",
"MinSize": 1,
"MaxSize": 6,
"DesiredCapacity": 4,
"TimeZone": "America/New_York"
}
]
}
```
For more information, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 5: To describe scheduled actions that end at a specified time**
To describe the scheduled actions that end at a specific time, use the `--end-time` option.
```
aws autoscaling describe-scheduled-actions \
--end-time "2023-12-01T04:00:00Z"
```
Output:
```
{
"ScheduledUpdateGroupActions": [
{
"AutoScalingGroupName": "my-asg",
"ScheduledActionName": "my-recurring-action",
"Recurrence": "30 0 1 1,6,12 *",
"ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action",
"StartTime": "2023-12-01T04:00:00Z",
"Time": "2023-12-01T04:00:00Z",
"MinSize": 1,
"MaxSize": 6,
"DesiredCapacity": 4,
"TimeZone": "America/New_York"
}
]
}
```
For more information, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 6: To describe a specified number of scheduled actions**
To return a specific number of scheduled actions, use the `--max-items` option.
```
aws autoscaling describe-scheduled-actions \
--auto-scaling-group-name my-asg \
--max-items 1
```
Output:
```
{
"ScheduledUpdateGroupActions": [
{
"AutoScalingGroupName": "my-asg",
"ScheduledActionName": "my-recurring-action",
"Recurrence": "30 0 1 1,6,12 *",
"ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-asg:scheduledActionName/my-recurring-action",
"StartTime": "2023-12-01T04:00:00Z",
"Time": "2023-12-01T04:00:00Z",
"MinSize": 1,
"MaxSize": 6,
"DesiredCapacity": 4,
"TimeZone": "America/New_York"
}
]
}
```
If the output includes a `NextToken` field, there are more scheduled actions. To get the additional scheduled actions, use the value of this field with the `--starting-token` option in a subsequent call as follows.
```
aws autoscaling describe-scheduled-actions \
--auto-scaling-group-name my-asg \
--starting-token Z3M3LMPEXAMPLE
```
For more information, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DescribeScheduledActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-scheduled-actions.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example describes the scheduled scaling actions for the specified Auto Scaling group.**
```
Get-ASScheduledAction -AutoScalingGroupName my-asg
```
**Output:**
```
AutoScalingGroupName : my-asg
DesiredCapacity : 10
EndTime :
MaxSize :
MinSize :
Recurrence :
ScheduledActionARN : arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8a4c5f24-6ec6-4306-a2dd-f7
2c3af3a4d6:autoScalingGroupName/my-asg:scheduledActionName/myScheduledAction
ScheduledActionName : myScheduledAction
StartTime : 11/30/2015 8:00:00 AM
Time : 11/30/2015 8:00:00 AM
```
**Example 2: This example describes the specified scheduled scaling actions.**
```
Get-ASScheduledAction -ScheduledActionName @("myScheduledScaleOut", "myScheduledScaleIn")
```
**Example 3: This example describes the scheduled scaling actions that start by the specified time.**
```
Get-ASScheduledAction -StartTime "2015-12-01T08:00:00Z"
```
**Example 4: This example describes the scheduled scaling actions that end by the specified time.**
```
Get-ASScheduledAction -EndTime "2015-12-30T08:00:00Z"
```
**Example 5: This example describes the scheduled scaling actions for all your Auto Scaling groups.**
```
Get-ASScheduledAction
```
+ For API details, see [DescribeScheduledActions](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example describes the scheduled scaling actions for the specified Auto Scaling group.**
```
Get-ASScheduledAction -AutoScalingGroupName my-asg
```
**Output:**
```
AutoScalingGroupName : my-asg
DesiredCapacity : 10
EndTime :
MaxSize :
MinSize :
Recurrence :
ScheduledActionARN : arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8a4c5f24-6ec6-4306-a2dd-f7
2c3af3a4d6:autoScalingGroupName/my-asg:scheduledActionName/myScheduledAction
ScheduledActionName : myScheduledAction
StartTime : 11/30/2015 8:00:00 AM
Time : 11/30/2015 8:00:00 AM
```
**Example 2: This example describes the specified scheduled scaling actions.**
```
Get-ASScheduledAction -ScheduledActionName @("myScheduledScaleOut", "myScheduledScaleIn")
```
**Example 3: This example describes the scheduled scaling actions that start by the specified time.**
```
Get-ASScheduledAction -StartTime "2015-12-01T08:00:00Z"
```
**Example 4: This example describes the scheduled scaling actions that end by the specified time.**
```
Get-ASScheduledAction -EndTime "2015-12-30T08:00:00Z"
```
**Example 5: This example describes the scheduled scaling actions for all your Auto Scaling groups.**
```
Get-ASScheduledAction
```
+ For API details, see [DescribeScheduledActions](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeTags` with a CLI
The following code examples show how to use `DescribeTags`.
------
#### [ CLI ]
**AWS CLI**
**To describe all tags**
This example describes all your tags.
```
aws autoscaling describe-tags
```
Output:
```
{
"Tags": [
{
"ResourceType": "auto-scaling-group",
"ResourceId": "my-asg",
"PropagateAtLaunch": true,
"Value": "Research",
"Key": "Dept"
},
{
"ResourceType": "auto-scaling-group",
"ResourceId": "my-asg",
"PropagateAtLaunch": true,
"Value": "WebServer",
"Key": "Role"
}
]
}
```
For more information, see [Tagging Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 2: To describe tags for a specified group**
To describe tags for a specific Auto Scaling group, use the `--filters` option.
```
aws autoscaling describe-tags --filters Name=auto-scaling-group,Values=my-asg
```
For more information, see [Tagging Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 3: To describe the specified number of tags**
To return a specific number of tags, use the `--max-items` option.
```
aws autoscaling describe-tags \
--max-items 1
```
If the output includes a `NextToken` field, there are more tags. To get the additional tags, use the value of this field with the `--starting-token` option in a subsequent call as follows.
```
aws autoscaling describe-tags \
--filters Name=auto-scaling-group,Values=my-asg \
--starting-token Z3M3LMPEXAMPLE
```
For more information, see [Tagging Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-tags.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example describes the tags with a key value of either 'myTag' or 'myTag2'. The possible values for the filter name are 'auto-scaling-group', 'key', 'value', and 'propagate-at-launch'. The syntax used by this example requires PowerShell version 3 or later.**
```
Get-ASTag -Filter @( @{ Name="key"; Values=@("myTag", "myTag2") } )
```
**Output:**
```
Key : myTag2
PropagateAtLaunch : True
ResourceId : my-asg
ResourceType : auto-scaling-group
Value : myTagValue2
Key : myTag
PropagateAtLaunch : True
ResourceId : my-asg
ResourceType : auto-scaling-group
Value : myTagValue
```
**Example 2: With PowerShell version 2, you must use New-Object to create the filter for the Filter parameter.**
```
$keys = New-Object string[] 2
$keys[0] = "myTag"
$keys[1] = "myTag2"
$filter = New-Object Amazon.AutoScaling.Model.Filter
$filter.Name = "key"
$filter.Values = $keys
Get-ASTag -Filter @( $filter )
```
**Example 3: This example describes all tags for all your Auto Scaling groups.**
```
Get-ASTag
```
+ For API details, see [DescribeTags](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example describes the tags with a key value of either 'myTag' or 'myTag2'. The possible values for the filter name are 'auto-scaling-group', 'key', 'value', and 'propagate-at-launch'. The syntax used by this example requires PowerShell version 3 or later.**
```
Get-ASTag -Filter @( @{ Name="key"; Values=@("myTag", "myTag2") } )
```
**Output:**
```
Key : myTag2
PropagateAtLaunch : True
ResourceId : my-asg
ResourceType : auto-scaling-group
Value : myTagValue2
Key : myTag
PropagateAtLaunch : True
ResourceId : my-asg
ResourceType : auto-scaling-group
Value : myTagValue
```
**Example 2: With PowerShell version 2, you must use New-Object to create the filter for the Filter parameter.**
```
$keys = New-Object string[] 2
$keys[0] = "myTag"
$keys[1] = "myTag2"
$filter = New-Object Amazon.AutoScaling.Model.Filter
$filter.Name = "key"
$filter.Values = $keys
Get-ASTag -Filter @( $filter )
```
**Example 3: This example describes all tags for all your Auto Scaling groups.**
```
Get-ASTag
```
+ For API details, see [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DescribeTerminationPolicyTypes` with a CLI
The following code examples show how to use `DescribeTerminationPolicyTypes`.
------
#### [ CLI ]
**AWS CLI**
**To describe available termination policy types**
This example describes the available termination policy types.
```
aws autoscaling describe-termination-policy-types
```
Output:
```
{
"TerminationPolicyTypes": [
"AllocationStrategy",
"ClosestToNextInstanceHour",
"Default",
"NewestInstance",
"OldestInstance",
"OldestLaunchConfiguration",
"OldestLaunchTemplate"
]
}
```
For more information, see [Controlling which Auto Scaling instances terminate during scale in](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DescribeTerminationPolicyTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-termination-policy-types.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example lists the termination policies that are supported by Auto Scaling.**
```
Get-ASTerminationPolicyType
```
**Output:**
```
ClosestToNextInstanceHour
Default
NewestInstance
OldestInstance
OldestLaunchConfiguration
```
+ For API details, see [DescribeTerminationPolicyTypes](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example lists the termination policies that are supported by Auto Scaling.**
```
Get-ASTerminationPolicyType
```
**Output:**
```
ClosestToNextInstanceHour
Default
NewestInstance
OldestInstance
OldestLaunchConfiguration
```
+ For API details, see [DescribeTerminationPolicyTypes](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DetachInstances` with a CLI
The following code examples show how to use `DetachInstances`.
------
#### [ CLI ]
**AWS CLI**
**To detach an instance from an Auto Scaling group**
This example detaches the specified instance from the specified Auto Scaling group.
```
aws autoscaling detach-instances \
--instance-ids i-030017cfa84b20135 \
--auto-scaling-group-name my-asg \
--should-decrement-desired-capacity
```
Output:
```
{
"Activities": [
{
"ActivityId": "5091cb52-547a-47ce-a236-c9ccbc2cb2c9",
"AutoScalingGroupName": "my-asg",
"Description": "Detaching EC2 instance: i-030017cfa84b20135",
"Cause": "At 2020-10-31T17:35:04Z instance i-030017cfa84b20135 was detached in response to a user request, shrinking the capacity from 2 to 1.",
"StartTime": "2020-04-12T15:02:16.179Z",
"StatusCode": "InProgress",
"Progress": 50,
"Details": "{\"Subnet ID\":\"subnet-6194ea3b\",\"Availability Zone\":\"us-west-2c\"}"
}
]
}
```
+ For API details, see [DetachInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/detach-instances.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example detaches the specified instance from the specified Auto Scaling group and decreases the desired capacity so that Auto Scaling does not launch a replacement instance.**
```
Dismount-ASInstance -InstanceId i-93633f9b -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $true
```
**Output:**
```
ActivityId : 06733445-ce94-4039-be1b-b9f1866e276e
AutoScalingGroupName : my-asg
Cause : At 2015-11-20T22:34:59Z instance i-93633f9b was detached in response to a user request, shrinking
the capacity from 2 to 1.
Description : Detaching EC2 instance: i-93633f9b
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 50
StartTime : 11/20/2015 2:34:59 PM
StatusCode : InProgress
StatusMessage :
```
**Example 2: This example detaches the specified instance from the specified Auto Scaling group without decreasing the desired capacity. Auto Scaling launches a replacement instance.**
```
Dismount-ASInstance -InstanceId i-7bf746a2 -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $false
```
**Output:**
```
ActivityId : f43a3cd4-d38c-4af7-9fe0-d76ec2307b6d
AutoScalingGroupName : my-asg
Cause : At 2015-11-20T22:34:59Z instance i-7bf746a2 was detached in response to a user request.
Description : Detaching EC2 instance: i-7bf746a2
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 50
StartTime : 11/20/2015 2:34:59 PM
StatusCode : InProgress
StatusMessage :
```
+ For API details, see [DetachInstances](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example detaches the specified instance from the specified Auto Scaling group and decreases the desired capacity so that Auto Scaling does not launch a replacement instance.**
```
Dismount-ASInstance -InstanceId i-93633f9b -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $true
```
**Output:**
```
ActivityId : 06733445-ce94-4039-be1b-b9f1866e276e
AutoScalingGroupName : my-asg
Cause : At 2015-11-20T22:34:59Z instance i-93633f9b was detached in response to a user request, shrinking
the capacity from 2 to 1.
Description : Detaching EC2 instance: i-93633f9b
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 50
StartTime : 11/20/2015 2:34:59 PM
StatusCode : InProgress
StatusMessage :
```
**Example 2: This example detaches the specified instance from the specified Auto Scaling group without decreasing the desired capacity. Auto Scaling launches a replacement instance.**
```
Dismount-ASInstance -InstanceId i-7bf746a2 -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $false
```
**Output:**
```
ActivityId : f43a3cd4-d38c-4af7-9fe0-d76ec2307b6d
AutoScalingGroupName : my-asg
Cause : At 2015-11-20T22:34:59Z instance i-7bf746a2 was detached in response to a user request.
Description : Detaching EC2 instance: i-7bf746a2
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 50
StartTime : 11/20/2015 2:34:59 PM
StatusCode : InProgress
StatusMessage :
```
+ For API details, see [DetachInstances](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DetachLoadBalancers` with a CLI
The following code examples show how to use `DetachLoadBalancers`.
------
#### [ CLI ]
**AWS CLI**
**To detach a Classic Load Balancer from an Auto Scaling group**
This example detaches the specified Classic Load Balancer from the specified Auto Scaling group.
```
aws autoscaling detach-load-balancers \
--load-balancer-names my-load-balancer \
--auto-scaling-group-name my-asg
```
This command produces no output.
For more information, see [Attaching a load balancer to your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DetachLoadBalancers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/detach-load-balancers.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example detaches the specified load balancer from the specified Auto Scaling group.**
```
Dismount-ASLoadBalancer -LoadBalancerName my-lb -AutoScalingGroupName my-asg
```
+ For API details, see [DetachLoadBalancers](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example detaches the specified load balancer from the specified Auto Scaling group.**
```
Dismount-ASLoadBalancer -LoadBalancerName my-lb -AutoScalingGroupName my-asg
```
+ For API details, see [DetachLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `DisableMetricsCollection` with an AWS SDK or CLI
The following code examples show how to use `DisableMetricsCollection`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](auto-scaling_example_auto-scaling_Scenario_GroupsAndInstances_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/AutoScaling#code-examples).
```
///
/// Disable the collection of metric data for an Amazon EC2 Auto Scaling
/// group.
///
/// The name of the Auto Scaling group.
/// A Boolean value that indicates the success or failure of
/// the operation.
public async Task DisableMetricsCollectionAsync(string groupName)
{
var request = new DisableMetricsCollectionRequest
{
AutoScalingGroupName = groupName,
};
var response = await _amazonAutoScaling.DisableMetricsCollectionAsync(request);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
```
+ For API details, see [DisableMetricsCollection](https://docs.aws.amazon.com/goto/DotNetSDKV4/autoscaling-2011-01-01/DisableMetricsCollection) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/autoscaling#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::AutoScaling::AutoScalingClient autoScalingClient(clientConfig);
Aws::AutoScaling::Model::DisableMetricsCollectionRequest request;
request.SetAutoScalingGroupName(groupName);
Aws::AutoScaling::Model::DisableMetricsCollectionOutcome outcome =
autoScalingClient.DisableMetricsCollection(request);
if (outcome.IsSuccess()) {
std::cout << "Metrics collection has been disabled." << std::endl;
}
else {
std::cerr << "Error with AutoScaling::DisableMetricsCollection. "
<< outcome.GetError().GetMessage()
<< std::endl;
}
```
+ For API details, see [DisableMetricsCollection](https://docs.aws.amazon.com/goto/SdkForCpp/autoscaling-2011-01-01/DisableMetricsCollection) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To disable metrics collection for an Auto Scaling group**
This example disables collection of the `GroupDesiredCapacity` metric for the specified Auto Scaling group.
```
aws autoscaling disable-metrics-collection \
--auto-scaling-group-name my-asg \
--metrics GroupDesiredCapacity
```
This command produces no output.
For more information, see [Monitoring CloudWatch metrics for your Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [DisableMetricsCollection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/disable-metrics-collection.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/autoscale#code-examples).
```
public static void disableMetricsCollection(AutoScalingClient autoScalingClient, String groupName) {
try {
DisableMetricsCollectionRequest disableMetricsCollectionRequest = DisableMetricsCollectionRequest.builder()
.autoScalingGroupName(groupName)
.metrics("GroupMaxSize")
.build();
autoScalingClient.disableMetricsCollection(disableMetricsCollectionRequest);
System.out.println("The disable metrics collection operation was successful");
} catch (AutoScalingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ For API details, see [DisableMetricsCollection](https://docs.aws.amazon.com/goto/SdkForJavaV2/autoscaling-2011-01-01/DisableMetricsCollection) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/autoscale#code-examples).
```
suspend fun disableMetricsCollection(groupName: String) {
val disableMetricsCollectionRequest =
DisableMetricsCollectionRequest {
autoScalingGroupName = groupName
metrics = listOf("GroupMaxSize")
}
AutoScalingClient { region = "us-east-1" }.use { autoScalingClient ->
autoScalingClient.disableMetricsCollection(disableMetricsCollectionRequest)
println("The disable metrics collection operation was successful")
}
}
```
+ For API details, see [DisableMetricsCollection](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ PHP ]
**SDK for PHP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/auto-scaling#code-examples).
```
public function disableMetricsCollection($autoScalingGroupName)
{
return $this->autoScalingClient->disableMetricsCollection([
'AutoScalingGroupName' => $autoScalingGroupName,
]);
}
```
+ For API details, see [DisableMetricsCollection](https://docs.aws.amazon.com/goto/SdkForPHPV3/autoscaling-2011-01-01/DisableMetricsCollection) in *AWS SDK for PHP API Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example disables monitoring of the specified metrics for the specified Auto Scaling group.**
```
Disable-ASMetricsCollection -AutoScalingGroupName my-asg -Metric @("GroupMinSize", "GroupMaxSize")
```
**Example 2: This example disables monitoring of all metrics for the specified Auto Scaling group.**
```
Disable-ASMetricsCollection -AutoScalingGroupName my-asg
```
+ For API details, see [DisableMetricsCollection](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example disables monitoring of the specified metrics for the specified Auto Scaling group.**
```
Disable-ASMetricsCollection -AutoScalingGroupName my-asg -Metric @("GroupMinSize", "GroupMaxSize")
```
**Example 2: This example disables monitoring of all metrics for the specified Auto Scaling group.**
```
Disable-ASMetricsCollection -AutoScalingGroupName my-asg
```
+ For API details, see [DisableMetricsCollection](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/auto-scaling#code-examples).
```
class AutoScalingWrapper:
"""Encapsulates Amazon EC2 Auto Scaling actions."""
def __init__(self, autoscaling_client):
"""
:param autoscaling_client: A Boto3 Amazon EC2 Auto Scaling client.
"""
self.autoscaling_client = autoscaling_client
def disable_metrics(self, group_name: str) -> Dict[str, Any]:
"""
Stops CloudWatch metric collection for the Auto Scaling group.
:param group_name: The name of the group.
:return: A dictionary with the response from disabling the metrics collection.
:raises ClientError: If there is an error disabling metrics collection.
"""
try:
response = self.autoscaling_client.disable_metrics_collection(
AutoScalingGroupName=group_name
)
logger.info(
f"Successfully disabled metrics collection for group '{group_name}'."
)
return response
except ClientError as err:
error_code = err.response["Error"]["Code"]
logger.error(
f"Couldn't disable metrics for group '{group_name}'. Error code: {error_code}, Message: {err.response['Error']['Message']}"
)
if error_code == "ResourceContentionFault":
logger.error(
f"There is a conflict with another operation that is modifying the Auto Scaling group '{group_name}'. "
"Please try again later."
)
raise
```
+ For API details, see [DisableMetricsCollection](https://docs.aws.amazon.com/goto/boto3/autoscaling-2011-01-01/DisableMetricsCollection) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/auto-scaling#code-examples).
```
// If this fails it's fine, just means there are extra cloudwatch metrics events for the scale-down.
let _ = self
.autoscaling
.disable_metrics_collection()
.auto_scaling_group_name(self.auto_scaling_group_name.clone())
.send()
.await;
```
+ For API details, see [DisableMetricsCollection](https://docs.rs/aws-sdk-autoscaling/latest/aws_sdk_autoscaling/client/struct.Client.html#method.disable_metrics_collection) in *AWS SDK for Rust API reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/asc#code-examples).
```
" Example: iv_group_name = 'my-auto-scaling-group'
TRY.
ao_asc->disablemetricscollection(
iv_autoscalinggroupname = iv_group_name ).
MESSAGE 'Metrics collection disabled successfully' TYPE 'I'.
CATCH /aws1/cx_ascresrccontionfault INTO DATA(lo_contention).
RAISE EXCEPTION lo_contention.
CATCH /aws1/cx_rt_generic INTO DATA(lo_generic_exception).
RAISE EXCEPTION lo_generic_exception.
ENDTRY.
```
+ For API details, see [DisableMetricsCollection](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `EnableMetricsCollection` with an AWS SDK or CLI
The following code examples show how to use `EnableMetricsCollection`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](auto-scaling_example_auto-scaling_Scenario_GroupsAndInstances_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/AutoScaling#code-examples).
```
///
/// Enable the collection of metric data for an Auto Scaling group.
///
/// The name of the Auto Scaling group.
/// A Boolean value indicating the success of the action.
public async Task EnableMetricsCollectionAsync(string groupName)
{
var listMetrics = new List
{
"GroupMaxSize",
};
var collectionRequest = new EnableMetricsCollectionRequest
{
AutoScalingGroupName = groupName,
Metrics = listMetrics,
Granularity = "1Minute",
};
var response = await _amazonAutoScaling.EnableMetricsCollectionAsync(collectionRequest);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
```
+ For API details, see [EnableMetricsCollection](https://docs.aws.amazon.com/goto/DotNetSDKV4/autoscaling-2011-01-01/EnableMetricsCollection) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/autoscaling#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::AutoScaling::AutoScalingClient autoScalingClient(clientConfig);
Aws::AutoScaling::Model::EnableMetricsCollectionRequest request;
request.SetAutoScalingGroupName(groupName);
request.AddMetrics("GroupMinSize");
request.AddMetrics("GroupMaxSize");
request.AddMetrics("GroupDesiredCapacity");
request.AddMetrics("GroupInServiceInstances");
request.AddMetrics("GroupTotalInstances");
request.SetGranularity("1Minute");
Aws::AutoScaling::Model::EnableMetricsCollectionOutcome outcome =
autoScalingClient.EnableMetricsCollection(request);
if (outcome.IsSuccess()) {
std::cout << "Auto Scaling metrics have been enabled."
<< std::endl;
}
else {
std::cerr << "Error with AutoScaling::EnableMetricsCollection. "
<< outcome.GetError().GetMessage()
<< std::endl;
}
```
+ For API details, see [EnableMetricsCollection](https://docs.aws.amazon.com/goto/SdkForCpp/autoscaling-2011-01-01/EnableMetricsCollection) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To enable metrics collection for an Auto Scaling group**
This example enables data collection for the specified Auto Scaling group.
```
aws autoscaling enable-metrics-collection \
--auto-scaling-group-name my-asg \
--granularity "1Minute"
```
This command produces no output.
For more information, see [Monitoring CloudWatch metrics for your Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 2: To collect data for the specified metric for an Auto Scaling group**
To collect data for a specific metric, use the `--metrics` option.
```
aws autoscaling enable-metrics-collection \
--auto-scaling-group-name my-asg \
--metrics GroupDesiredCapacity --granularity "1Minute"
```
This command produces no output.
For more information, see [Monitoring CloudWatch metrics for your Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [EnableMetricsCollection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/enable-metrics-collection.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/autoscale#code-examples).
```
public static void enableMetricsCollection(AutoScalingClient autoScalingClient, String groupName) {
try {
EnableMetricsCollectionRequest collectionRequest = EnableMetricsCollectionRequest.builder()
.autoScalingGroupName(groupName)
.metrics("GroupMaxSize")
.granularity("1Minute")
.build();
autoScalingClient.enableMetricsCollection(collectionRequest);
System.out.println("The enable metrics collection operation was successful");
} catch (AutoScalingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ For API details, see [EnableMetricsCollection](https://docs.aws.amazon.com/goto/SdkForJavaV2/autoscaling-2011-01-01/EnableMetricsCollection) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/autoscale#code-examples).
```
suspend fun enableMetricsCollection(groupName: String?) {
val collectionRequest =
EnableMetricsCollectionRequest {
autoScalingGroupName = groupName
metrics = listOf("GroupMaxSize")
granularity = "1Minute"
}
AutoScalingClient { region = "us-east-1" }.use { autoScalingClient ->
autoScalingClient.enableMetricsCollection(collectionRequest)
println("The enable metrics collection operation was successful")
}
}
```
+ For API details, see [EnableMetricsCollection](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ PHP ]
**SDK for PHP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/auto-scaling#code-examples).
```
public function enableMetricsCollection($autoScalingGroupName, $granularity)
{
return $this->autoScalingClient->enableMetricsCollection([
'AutoScalingGroupName' => $autoScalingGroupName,
'Granularity' => $granularity,
]);
}
```
+ For API details, see [EnableMetricsCollection](https://docs.aws.amazon.com/goto/SdkForPHPV3/autoscaling-2011-01-01/EnableMetricsCollection) in *AWS SDK for PHP API Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example enables monitoring of the specified metrics for the specified Auto Scaling group.**
```
Enable-ASMetricsCollection -Metric @("GroupMinSize", "GroupMaxSize") -AutoScalingGroupName my-asg -Granularity 1Minute
```
**Example 2: This example enables monitoring of all metrics for the specified Auto Scaling group.**
```
Enable-ASMetricsCollection -AutoScalingGroupName my-asg -Granularity 1Minute
```
+ For API details, see [EnableMetricsCollection](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example enables monitoring of the specified metrics for the specified Auto Scaling group.**
```
Enable-ASMetricsCollection -Metric @("GroupMinSize", "GroupMaxSize") -AutoScalingGroupName my-asg -Granularity 1Minute
```
**Example 2: This example enables monitoring of all metrics for the specified Auto Scaling group.**
```
Enable-ASMetricsCollection -AutoScalingGroupName my-asg -Granularity 1Minute
```
+ For API details, see [EnableMetricsCollection](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/auto-scaling#code-examples).
```
class AutoScalingWrapper:
"""Encapsulates Amazon EC2 Auto Scaling actions."""
def __init__(self, autoscaling_client):
"""
:param autoscaling_client: A Boto3 Amazon EC2 Auto Scaling client.
"""
self.autoscaling_client = autoscaling_client
def enable_metrics(self, group_name: str, metrics: List[str]) -> Dict[str, Any]:
"""
Enables CloudWatch metric collection for Amazon EC2 Auto Scaling activities.
:param group_name: The name of the group to enable.
:param metrics: A list of metrics to collect.
:return: A dictionary with the response from enabling the metrics collection.
:raises ClientError: If there is an error enabling metrics collection.
"""
try:
response = self.autoscaling_client.enable_metrics_collection(
AutoScalingGroupName=group_name, Metrics=metrics, Granularity="1Minute"
)
logger.info(
f"Successfully enabled metrics for Auto Scaling group '{group_name}'."
)
except ClientError as err:
error_code = err.response["Error"]["Code"]
logger.error(
f"Couldn't enable metrics on '{group_name}'. Error code: {error_code}, Message: {err.response['Error']['Message']}"
)
if error_code == "ResourceContentionFault":
logger.error(
f"There is a conflict with another operation that is modifying the Auto Scaling group '{group_name}'. "
"Please try again later."
)
elif error_code == "InvalidParameterCombination":
logger.error(
f"The combination of parameters provided for enabling metrics on '{group_name}' is not valid. "
"Please check the parameters and try again."
)
raise
else:
return response
```
+ For API details, see [EnableMetricsCollection](https://docs.aws.amazon.com/goto/boto3/autoscaling-2011-01-01/EnableMetricsCollection) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/auto-scaling#code-examples).
```
let enable_metrics_collection = autoscaling
.enable_metrics_collection()
.auto_scaling_group_name(auto_scaling_group_name.as_str())
.granularity("1Minute")
.set_metrics(Some(vec![
String::from("GroupMinSize"),
String::from("GroupMaxSize"),
String::from("GroupDesiredCapacity"),
String::from("GroupInServiceInstances"),
String::from("GroupTotalInstances"),
]))
.send()
.await;
```
+ For API details, see [EnableMetricsCollection](https://docs.rs/aws-sdk-autoscaling/latest/aws_sdk_autoscaling/client/struct.Client.html#method.enable_metrics_collection) in *AWS SDK for Rust API reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/asc#code-examples).
```
" Example: iv_group_name = 'my-auto-scaling-group'
" Example: it_metrics contains list of metrics like 'GroupMinSize', 'GroupMaxSize', etc.
TRY.
ao_asc->enablemetricscollection(
iv_autoscalinggroupname = iv_group_name
it_metrics = it_metrics
iv_granularity = '1Minute' ).
MESSAGE 'Metrics collection enabled successfully' TYPE 'I'.
CATCH /aws1/cx_ascresrccontionfault INTO DATA(lo_contention).
RAISE EXCEPTION lo_contention.
CATCH /aws1/cx_rt_generic INTO DATA(lo_generic_exception).
RAISE EXCEPTION lo_generic_exception.
ENDTRY.
```
+ For API details, see [EnableMetricsCollection](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `EnterStandby` with a CLI
The following code examples show how to use `EnterStandby`.
------
#### [ CLI ]
**AWS CLI**
**To move instances into standby mode**
This example puts the specified instance into standby mode. This is useful for updating or troubleshooting an instance that is currently in service.
```
aws autoscaling enter-standby \
--instance-ids i-061c63c5eb45f0416 \
--auto-scaling-group-name my-asg \
--should-decrement-desired-capacity
```
Output:
```
{
"Activities": [
{
"ActivityId": "ffa056b4-6ed3-41ba-ae7c-249dfae6eba1",
"AutoScalingGroupName": "my-asg",
"Description": "Moving EC2 instance to Standby: i-061c63c5eb45f0416",
"Cause": "At 2020-10-31T20:31:00Z instance i-061c63c5eb45f0416 was moved to standby in response to a user request, shrinking the capacity from 1 to 0.",
"StartTime": "2020-10-31T20:31:00.949Z",
"StatusCode": "InProgress",
"Progress": 50,
"Details": "{\"Subnet ID\":\"subnet-6194ea3b\",\"Availability Zone\":\"us-west-2c\"}"
}
]
}
```
For more information, see [Amazon EC2 Auto Scaling instance lifecycle](https://docs.aws.amazon.com/autoscaling/ec2/userguide/detach-instance-asg.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [EnterStandby](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/enter-standby.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example puts the specified instance into standby mode and decreases the desired capacity so that Auto Scaling does not launch a replacement instance.**
```
Enter-ASStandby -InstanceId i-93633f9b -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $true
```
**Output:**
```
ActivityId : e36a5a54-ced6-4df8-bd19-708e2a59a649
AutoScalingGroupName : my-asg
Cause : At 2015-11-22T15:48:06Z instance i-95b8484f was moved to standby in response to a user request,
shrinking the capacity from 2 to 1.
Description : Moving EC2 instance to Standby: i-95b8484f
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 50
StartTime : 11/22/2015 7:48:06 AM
StatusCode : InProgress
StatusMessage :
```
**Example 2: This example puts the specified instance into standby mode without decreasing the desired capacity. Auto Scaling launches a replacement instance.**
```
Enter-ASStandby -InstanceId i-93633f9b -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $false
```
**Output:**
```
ActivityId : e36a5a54-ced6-4df8-bd19-708e2a59a649
AutoScalingGroupName : my-asg
Cause : At 2015-11-22T15:48:06Z instance i-95b8484f was moved to standby in response to a user request.
Description : Moving EC2 instance to Standby: i-95b8484f
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 50
StartTime : 11/22/2015 7:48:06 AM
StatusCode : InProgress
StatusMessage :
```
+ For API details, see [EnterStandby](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example puts the specified instance into standby mode and decreases the desired capacity so that Auto Scaling does not launch a replacement instance.**
```
Enter-ASStandby -InstanceId i-93633f9b -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $true
```
**Output:**
```
ActivityId : e36a5a54-ced6-4df8-bd19-708e2a59a649
AutoScalingGroupName : my-asg
Cause : At 2015-11-22T15:48:06Z instance i-95b8484f was moved to standby in response to a user request,
shrinking the capacity from 2 to 1.
Description : Moving EC2 instance to Standby: i-95b8484f
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 50
StartTime : 11/22/2015 7:48:06 AM
StatusCode : InProgress
StatusMessage :
```
**Example 2: This example puts the specified instance into standby mode without decreasing the desired capacity. Auto Scaling launches a replacement instance.**
```
Enter-ASStandby -InstanceId i-93633f9b -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $false
```
**Output:**
```
ActivityId : e36a5a54-ced6-4df8-bd19-708e2a59a649
AutoScalingGroupName : my-asg
Cause : At 2015-11-22T15:48:06Z instance i-95b8484f was moved to standby in response to a user request.
Description : Moving EC2 instance to Standby: i-95b8484f
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 50
StartTime : 11/22/2015 7:48:06 AM
StatusCode : InProgress
StatusMessage :
```
+ For API details, see [EnterStandby](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ExecutePolicy` with a CLI
The following code examples show how to use `ExecutePolicy`.
------
#### [ CLI ]
**AWS CLI**
**To execute a scaling policy**
This example executes the scaling policy named `my-step-scale-out-policy` for the specified Auto Scaling group.
```
aws autoscaling execute-policy \
--auto-scaling-group-name my-asg \
--policy-name my-step-scale-out-policy \
--metric-value 95 \
--breach-threshold 80
```
This command produces no output.
For more information, see [Step and simple scaling policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [ExecutePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/execute-policy.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example executes the specified policy for the specified Auto Scaling group.**
```
Start-ASPolicy -AutoScalingGroupName my-asg -PolicyName "myScaleInPolicy"
```
**Example 2: This example executes the specified policy for the specified Auto Scaling group, after waiting for the cooldown period to complete.**
```
Start-ASPolicy -AutoScalingGroupName my-asg -PolicyName "myScaleInPolicy" -HonorCooldown $true
```
+ For API details, see [ExecutePolicy](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example executes the specified policy for the specified Auto Scaling group.**
```
Start-ASPolicy -AutoScalingGroupName my-asg -PolicyName "myScaleInPolicy"
```
**Example 2: This example executes the specified policy for the specified Auto Scaling group, after waiting for the cooldown period to complete.**
```
Start-ASPolicy -AutoScalingGroupName my-asg -PolicyName "myScaleInPolicy" -HonorCooldown $true
```
+ For API details, see [ExecutePolicy](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ExitStandby` with a CLI
The following code examples show how to use `ExitStandby`.
------
#### [ CLI ]
**AWS CLI**
**To move instances out of standby mode**
This example moves the specified instance out of standby mode.
```
aws autoscaling exit-standby \
--instance-ids i-061c63c5eb45f0416 \
--auto-scaling-group-name my-asg
```
Output:
```
{
"Activities": [
{
"ActivityId": "142928e1-a2dc-453a-9b24-b85ad6735928",
"AutoScalingGroupName": "my-asg",
"Description": "Moving EC2 instance out of Standby: i-061c63c5eb45f0416",
"Cause": "At 2020-10-31T20:32:50Z instance i-061c63c5eb45f0416 was moved out of standby in response to a user request, increasing the capacity from 0 to 1.",
"StartTime": "2020-10-31T20:32:50.222Z",
"StatusCode": "PreInService",
"Progress": 30,
"Details": "{\"Subnet ID\":\"subnet-6194ea3b\",\"Availability Zone\":\"us-west-2c\"}"
}
]
}
```
For more information, see [Temporarily removing instances from your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [ExitStandby](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/exit-standby.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example moves the specified instance out of standby mode.**
```
Exit-ASStandby -InstanceId i-93633f9b -AutoScalingGroupName my-asg
```
**Output:**
```
ActivityId : 1833d3e8-e32f-454e-b731-0670ad4c6934
AutoScalingGroupName : my-asg
Cause : At 2015-11-22T15:51:21Z instance i-95b8484f was moved out of standby in response to a user
request, increasing the capacity from 1 to 2.
Description : Moving EC2 instance out of Standby: i-95b8484f
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 30
StartTime : 11/22/2015 7:51:21 AM
StatusCode : PreInService
StatusMessage :
```
+ For API details, see [ExitStandby](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example moves the specified instance out of standby mode.**
```
Exit-ASStandby -InstanceId i-93633f9b -AutoScalingGroupName my-asg
```
**Output:**
```
ActivityId : 1833d3e8-e32f-454e-b731-0670ad4c6934
AutoScalingGroupName : my-asg
Cause : At 2015-11-22T15:51:21Z instance i-95b8484f was moved out of standby in response to a user
request, increasing the capacity from 1 to 2.
Description : Moving EC2 instance out of Standby: i-95b8484f
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 30
StartTime : 11/22/2015 7:51:21 AM
StatusCode : PreInService
StatusMessage :
```
+ For API details, see [ExitStandby](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `PutLifecycleHook` with a CLI
The following code examples show how to use `PutLifecycleHook`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To create a lifecycle hook**
This example creates a lifecycle hook that will invoke on any newly launched instances, with a timeout of 4800 seconds. This is useful for keeping the instances in a wait state until the user data scripts have finished, or for invoking an AWS Lambda function using EventBridge.
```
aws autoscaling put-lifecycle-hook \
--auto-scaling-group-name my-asg \
--lifecycle-hook-name my-launch-hook \
--lifecycle-transition autoscaling:EC2_INSTANCE_LAUNCHING \
--heartbeat-timeout 4800
```
This command produces no output. If a lifecycle hook with the same name already exists, it will be overwritten by the new lifecycle hook.
For more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 2: To send an Amazon SNS email message to notify you of instance state transitions**
This example creates a lifecycle hook with the Amazon SNS topic and IAM role to use to receive notification at instance launch.
```
aws autoscaling put-lifecycle-hook \
--auto-scaling-group-name my-asg \
--lifecycle-hook-name my-launch-hook \
--lifecycle-transition autoscaling:EC2_INSTANCE_LAUNCHING \
--notification-target-arn arn:aws:sns:us-west-2:123456789012:my-sns-topic \
--role-arn arn:aws:iam::123456789012:role/my-auto-scaling-role
```
This command produces no output.
For more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 3: To publish a message to an Amazon SQS queue**
This example creates a lifecycle hook that publishes a message with metadata to the specified Amazon SQS queue.
```
aws autoscaling put-lifecycle-hook \
--auto-scaling-group-name my-asg \
--lifecycle-hook-name my-launch-hook \
--lifecycle-transition autoscaling:EC2_INSTANCE_LAUNCHING \
--notification-target-arn arn:aws:sqs:us-west-2:123456789012:my-sqs-queue \
--role-arn arn:aws:iam::123456789012:role/my-notification-role \
--notification-metadata "SQS message metadata"
```
This command produces no output.
For more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [PutLifecycleHook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/put-lifecycle-hook.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example adds the specified lifecycle hook to the specified Auto Scaling group.**
```
Write-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName "myLifecycleHook" -LifecycleTransition "autoscaling:EC2_INSTANCE_LAUNCHING" -NotificationTargetARN "arn:aws:sns:us-west-2:123456789012:my-sns-topic" -RoleARN "arn:aws:iam::123456789012:role/my-iam-role"
```
+ For API details, see [PutLifecycleHook](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example adds the specified lifecycle hook to the specified Auto Scaling group.**
```
Write-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName "myLifecycleHook" -LifecycleTransition "autoscaling:EC2_INSTANCE_LAUNCHING" -NotificationTargetARN "arn:aws:sns:us-west-2:123456789012:my-sns-topic" -RoleARN "arn:aws:iam::123456789012:role/my-iam-role"
```
+ For API details, see [PutLifecycleHook](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `PutNotificationConfiguration` with a CLI
The following code examples show how to use `PutNotificationConfiguration`.
------
#### [ CLI ]
**AWS CLI**
**To add a notification**
This example adds the specified notification to the specified Auto Scaling group.
```
aws autoscaling put-notification-configuration \
--auto-scaling-group-name my-asg \
--topic-arn arn:aws:sns:us-west-2:123456789012:my-sns-topic \
--notification-type autoscaling:TEST_NOTIFICATION
```
This command produces no output.
For more information, see [Getting Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html#as-configure-asg-for-sns) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [PutNotificationConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/put-notification-configuration.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example configures the specified Auto Scaling group to send a notification to the specified SNS topic when it launches EC2 instances.**
```
Write-ASNotificationConfiguration -AutoScalingGroupName my-asg -NotificationType "autoscaling:EC2_INSTANCE_LAUNCH" -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic"
```
**Example 2: This example configures the specified Auto Scaling group to send a notification to the specified SNS topic when it launches or terminates EC2 instances.**
```
Write-ASNotificationConfiguration -AutoScalingGroupName my-asg -NotificationType @("autoscaling:EC2_INSTANCE_LAUNCH", "autoscaling:EC2_INSTANCE_TERMINATE") -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic"
```
+ For API details, see [PutNotificationConfiguration](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example configures the specified Auto Scaling group to send a notification to the specified SNS topic when it launches EC2 instances.**
```
Write-ASNotificationConfiguration -AutoScalingGroupName my-asg -NotificationType "autoscaling:EC2_INSTANCE_LAUNCH" -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic"
```
**Example 2: This example configures the specified Auto Scaling group to send a notification to the specified SNS topic when it launches or terminates EC2 instances.**
```
Write-ASNotificationConfiguration -AutoScalingGroupName my-asg -NotificationType @("autoscaling:EC2_INSTANCE_LAUNCH", "autoscaling:EC2_INSTANCE_TERMINATE") -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic"
```
+ For API details, see [PutNotificationConfiguration](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `PutScalingPolicy` with a CLI
The following code examples show how to use `PutScalingPolicy`.
------
#### [ CLI ]
**AWS CLI**
**To add a target tracking scaling policy to an Auto Scaling group**
The following `put-scaling-policy` example applies a target tracking scaling policy to the specified Auto Scaling group. The output contains the ARNs and names of the two CloudWatch alarms created on your behalf. If a scaling policy with the same name already exists, it will be overwritten by the new scaling policy.
```
aws autoscaling put-scaling-policy --auto-scaling-group-name my-asg \
--policy-name alb1000-target-tracking-scaling-policy \
--policy-type TargetTrackingScaling \
--target-tracking-configuration file://config.json
```
Contents of `config.json`:
```
{
"TargetValue": 1000.0,
"PredefinedMetricSpecification": {
"PredefinedMetricType": "ALBRequestCountPerTarget",
"ResourceLabel": "app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff"
}
}
```
Output:
```
{
"PolicyARN": "arn:aws:autoscaling:region:account-id:scalingPolicy:228f02c2-c665-4bfd-aaac-8b04080bea3c:autoScalingGroupName/my-asg:policyName/alb1000-target-tracking-scaling-policy",
"Alarms": [
{
"AlarmARN": "arn:aws:cloudwatch:region:account-id:alarm:TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e",
"AlarmName": "TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e"
},
{
"AlarmARN": "arn:aws:cloudwatch:region:account-id:alarm:TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2",
"AlarmName": "TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2"
}
]
}
```
For more examples, see [Example scaling policies for the AWS Command Line Interface (AWS CLI)](https://docs.aws.amazon.com/autoscaling/ec2/userguide/examples-scaling-policies.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [PutScalingPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/put-scaling-policy.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example adds the specified policy to the specified Auto Scaling group. The specified adjustment type determines how to interpret the ScalingAdjustment parameter. With 'ChangeInCapacity', a positive value increases the capacity by the specified number of instances and a negative value decreases the capacity by the specified number of instances.**
```
Write-ASScalingPolicy -AutoScalingGroupName my-asg -AdjustmentType "ChangeInCapacity" -PolicyName "myScaleInPolicy" -ScalingAdjustment -1
```
**Output:**
```
arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:aa3836ab-5462-42c7-adab-e1d769fc24ef:autoScalingGroupName/my-asg
:policyName/myScaleInPolicy
```
+ For API details, see [PutScalingPolicy](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example adds the specified policy to the specified Auto Scaling group. The specified adjustment type determines how to interpret the ScalingAdjustment parameter. With 'ChangeInCapacity', a positive value increases the capacity by the specified number of instances and a negative value decreases the capacity by the specified number of instances.**
```
Write-ASScalingPolicy -AutoScalingGroupName my-asg -AdjustmentType "ChangeInCapacity" -PolicyName "myScaleInPolicy" -ScalingAdjustment -1
```
**Output:**
```
arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:aa3836ab-5462-42c7-adab-e1d769fc24ef:autoScalingGroupName/my-asg
:policyName/myScaleInPolicy
```
+ For API details, see [PutScalingPolicy](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `PutScheduledUpdateGroupAction` with a CLI
The following code examples show how to use `PutScheduledUpdateGroupAction`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To add a scheduled action to an Auto Scaling group**
This example adds the specified scheduled action to the specified Auto Scaling group.
```
aws autoscaling put-scheduled-update-group-action \
--auto-scaling-group-name my-asg \
--scheduled-action-name my-scheduled-action \
--start-time "2023-05-12T08:00:00Z" \
--min-size 2 \
--max-size 6 \
--desired-capacity 4
```
This command produces no output. If a scheduled action with the same name already exists, it will be overwritten by the new scheduled action.
For more examples, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 2: To specify a recurring schedule**
This example creates a scheduled action to scale on a recurring schedule that is scheduled to execute at 00:30 hours on the first of January, June, and December every year.
```
aws autoscaling put-scheduled-update-group-action \
--auto-scaling-group-name my-asg \
--scheduled-action-name my-recurring-action \
--recurrence "30 0 1 1,6,12 *" \
--min-size 2 \
--max-size 6 \
--desired-capacity 4
```
This command produces no output. If a scheduled action with the same name already exists, it will be overwritten by the new scheduled action.
For more examples, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [PutScheduledUpdateGroupAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/put-scheduled-update-group-action.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example creates or updates a one-time scheduled action to change the desired capacity at the specified start time.**
```
Write-ASScheduledUpdateGroupAction -AutoScalingGroupName my-asg -ScheduledActionName "myScheduledAction" -StartTime "2015-12-01T00:00:00Z" -DesiredCapacity 10
```
+ For API details, see [PutScheduledUpdateGroupAction](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example creates or updates a one-time scheduled action to change the desired capacity at the specified start time.**
```
Write-ASScheduledUpdateGroupAction -AutoScalingGroupName my-asg -ScheduledActionName "myScheduledAction" -StartTime "2015-12-01T00:00:00Z" -DesiredCapacity 10
```
+ For API details, see [PutScheduledUpdateGroupAction](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `RecordLifecycleActionHeartbeat` with a CLI
The following code examples show how to use `RecordLifecycleActionHeartbeat`.
------
#### [ CLI ]
**AWS CLI**
**To record a lifecycle action heartbeat**
This example records a lifecycle action heartbeat to keep the instance in a pending state.
```
aws autoscaling record-lifecycle-action-heartbeat \
--lifecycle-hook-name my-launch-hook \
--auto-scaling-group-name my-asg \
--lifecycle-action-token bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635
```
This command produces no output.
For more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [RecordLifecycleActionHeartbeat](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/record-lifecycle-action-heartbeat.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example records a heartbeat for the specified lifecycle action. This keeps the instance in a pending state until you complete the custom action.**
```
Write-ASLifecycleActionHeartbeat -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook -LifecycleActionToken bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635
```
+ For API details, see [RecordLifecycleActionHeartbeat](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example records a heartbeat for the specified lifecycle action. This keeps the instance in a pending state until you complete the custom action.**
```
Write-ASLifecycleActionHeartbeat -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook -LifecycleActionToken bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635
```
+ For API details, see [RecordLifecycleActionHeartbeat](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `ResumeProcesses` with a CLI
The following code examples show how to use `ResumeProcesses`.
------
#### [ CLI ]
**AWS CLI**
**To resume suspended processes**
This example resumes the specified suspended scaling process for the specified Auto Scaling group.
```
aws autoscaling resume-processes \
--auto-scaling-group-name my-asg \
--scaling-processes AlarmNotification
```
This command produces no output.
For more information, see [Suspending and resuming scaling processes](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [ResumeProcesses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/resume-processes.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example resumes the specified Auto Scaling process for the specified Auto Scaling group.**
```
Resume-ASProcess -AutoScalingGroupName my-asg -ScalingProcess "AlarmNotification"
```
**Example 2: This example resumes all suspended Auto Scaling processes for the specified Auto Scaling group.**
```
Resume-ASProcess -AutoScalingGroupName my-asg
```
+ For API details, see [ResumeProcesses](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example resumes the specified Auto Scaling process for the specified Auto Scaling group.**
```
Resume-ASProcess -AutoScalingGroupName my-asg -ScalingProcess "AlarmNotification"
```
**Example 2: This example resumes all suspended Auto Scaling processes for the specified Auto Scaling group.**
```
Resume-ASProcess -AutoScalingGroupName my-asg
```
+ For API details, see [ResumeProcesses](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `SetDesiredCapacity` with an AWS SDK or CLI
The following code examples show how to use `SetDesiredCapacity`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](auto-scaling_example_auto-scaling_Scenario_GroupsAndInstances_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/AutoScaling#code-examples).
```
///
/// Set the desired capacity of an Auto Scaling group.
///
/// The name of the Auto Scaling group.
/// The desired capacity for the Auto
/// Scaling group.
/// A Boolean value indicating the success of the action.
public async Task SetDesiredCapacityAsync(
string groupName,
int desiredCapacity)
{
var capacityRequest = new SetDesiredCapacityRequest
{
AutoScalingGroupName = groupName,
DesiredCapacity = desiredCapacity,
};
var response = await _amazonAutoScaling.SetDesiredCapacityAsync(capacityRequest);
Console.WriteLine($"You have set the DesiredCapacity to {desiredCapacity}.");
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
```
+ For API details, see [SetDesiredCapacity](https://docs.aws.amazon.com/goto/DotNetSDKV4/autoscaling-2011-01-01/SetDesiredCapacity) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/autoscaling#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::AutoScaling::AutoScalingClient autoScalingClient(clientConfig);
Aws::AutoScaling::Model::SetDesiredCapacityRequest request;
request.SetAutoScalingGroupName(groupName);
request.SetDesiredCapacity(2);
Aws::AutoScaling::Model::SetDesiredCapacityOutcome outcome =
autoScalingClient.SetDesiredCapacity(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error with AutoScaling::SetDesiredCapacityRequest. "
<< outcome.GetError().GetMessage()
<< std::endl;
}
```
+ For API details, see [SetDesiredCapacity](https://docs.aws.amazon.com/goto/SdkForCpp/autoscaling-2011-01-01/SetDesiredCapacity) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To set the desired capacity for an Auto Scaling group**
This example sets the desired capacity for the specified Auto Scaling group.
```
aws autoscaling set-desired-capacity \
--auto-scaling-group-name my-asg \
--desired-capacity 2 \
--honor-cooldown
```
This command returns to the prompt if successful.
+ For API details, see [SetDesiredCapacity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/set-desired-capacity.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/autoscale#code-examples).
```
public static void setDesiredCapacity(AutoScalingClient autoScalingClient, String groupName) {
try {
SetDesiredCapacityRequest capacityRequest = SetDesiredCapacityRequest.builder()
.autoScalingGroupName(groupName)
.desiredCapacity(2)
.build();
autoScalingClient.setDesiredCapacity(capacityRequest);
System.out.println("You have set the DesiredCapacity to 2");
} catch (AutoScalingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ For API details, see [SetDesiredCapacity](https://docs.aws.amazon.com/goto/SdkForJavaV2/autoscaling-2011-01-01/SetDesiredCapacity) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/autoscale#code-examples).
```
suspend fun setDesiredCapacity(groupName: String) {
val capacityRequest =
SetDesiredCapacityRequest {
autoScalingGroupName = groupName
desiredCapacity = 2
}
AutoScalingClient { region = "us-east-1" }.use { autoScalingClient ->
autoScalingClient.setDesiredCapacity(capacityRequest)
println("You set the DesiredCapacity to 2")
}
}
```
+ For API details, see [SetDesiredCapacity](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ PHP ]
**SDK for PHP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/auto-scaling#code-examples).
```
public function setDesiredCapacity($autoScalingGroupName, $desiredCapacity)
{
return $this->autoScalingClient->setDesiredCapacity([
'AutoScalingGroupName' => $autoScalingGroupName,
'DesiredCapacity' => $desiredCapacity,
]);
}
```
+ For API details, see [SetDesiredCapacity](https://docs.aws.amazon.com/goto/SdkForPHPV3/autoscaling-2011-01-01/SetDesiredCapacity) in *AWS SDK for PHP API Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example sets the size of the specified Auto Scaling group.**
```
Set-ASDesiredCapacity -AutoScalingGroupName my-asg -DesiredCapacity 2
```
**Example 2: This example sets the size of the specified Auto Scaling group and waits for the cooldown period to complete before scaling to the new size.**
```
Set-ASDesiredCapacity -AutoScalingGroupName my-asg -DesiredCapacity 2 -HonorCooldown $true
```
+ For API details, see [SetDesiredCapacity](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example sets the size of the specified Auto Scaling group.**
```
Set-ASDesiredCapacity -AutoScalingGroupName my-asg -DesiredCapacity 2
```
**Example 2: This example sets the size of the specified Auto Scaling group and waits for the cooldown period to complete before scaling to the new size.**
```
Set-ASDesiredCapacity -AutoScalingGroupName my-asg -DesiredCapacity 2 -HonorCooldown $true
```
+ For API details, see [SetDesiredCapacity](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/auto-scaling#code-examples).
```
class AutoScalingWrapper:
"""Encapsulates Amazon EC2 Auto Scaling actions."""
def __init__(self, autoscaling_client):
"""
:param autoscaling_client: A Boto3 Amazon EC2 Auto Scaling client.
"""
self.autoscaling_client = autoscaling_client
def set_desired_capacity(self, group_name: str, capacity: int) -> None:
"""
Sets the desired capacity of the group. Amazon EC2 Auto Scaling tries to keep the
number of running instances equal to the desired capacity.
:param group_name: The name of the group to update.
:param capacity: The desired number of running instances.
:return: None
:raises ClientError: If there is an error setting the desired capacity.
"""
try:
self.autoscaling_client.set_desired_capacity(
AutoScalingGroupName=group_name,
DesiredCapacity=capacity,
HonorCooldown=False,
)
logger.info(
f"Successfully set desired capacity of {capacity} for Auto Scaling group '{group_name}'."
)
except ClientError as err:
error_code = err.response["Error"]["Code"]
logger.error(
f"Failed to set desired capacity for Auto Scaling group '{group_name}'."
)
if error_code == "ScalingActivityInProgress":
logger.error(
f"A scaling activity is currently in progress for the Auto Scaling group '{group_name}'. "
"Please wait for the activity to complete before attempting to set the desired capacity."
)
logger.error(f"Full error:\n\t{err}")
raise
```
+ For API details, see [SetDesiredCapacity](https://docs.aws.amazon.com/goto/boto3/autoscaling-2011-01-01/SetDesiredCapacity) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/auto-scaling#code-examples).
```
pub async fn scale_desired_capacity(&self, capacity: i32) -> Result<(), ScenarioError> {
// 7. SetDesiredCapacity: set desired capacity to 2.
// Wait for a second instance to launch.
let update_group = self
.autoscaling
.set_desired_capacity()
.auto_scaling_group_name(self.auto_scaling_group_name.clone())
.desired_capacity(capacity)
.send()
.await;
if let Err(err) = update_group {
return Err(ScenarioError::new(
format!("Failed to update group to desired capacity ({capacity}))").as_str(),
&err,
));
}
Ok(())
}
```
+ For API details, see [SetDesiredCapacity](https://docs.rs/aws-sdk-autoscaling/latest/aws_sdk_autoscaling/client/struct.Client.html#method.set_desired_capacity) in *AWS SDK for Rust API reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/asc#code-examples).
```
" Example: iv_group_name = 'my-auto-scaling-group'
" Example: iv_capacity = 2
TRY.
ao_asc->setdesiredcapacity(
iv_autoscalinggroupname = iv_group_name
iv_desiredcapacity = iv_capacity
iv_honorcooldown = abap_false ).
MESSAGE 'Desired capacity set successfully' TYPE 'I'.
CATCH /aws1/cx_ascscaactivityinprg00 INTO DATA(lo_activity_in_progress).
RAISE EXCEPTION lo_activity_in_progress.
CATCH /aws1/cx_rt_generic INTO DATA(lo_generic_exception).
RAISE EXCEPTION lo_generic_exception.
ENDTRY.
```
+ For API details, see [SetDesiredCapacity](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `SetInstanceHealth` with a CLI
The following code examples show how to use `SetInstanceHealth`.
------
#### [ CLI ]
**AWS CLI**
**To set the health status of an instance**
This example sets the health status of the specified instance to `Unhealthy`.
```
aws autoscaling set-instance-health \
--instance-id i-061c63c5eb45f0416 \
--health-status Unhealthy
```
This command produces no output.
+ For API details, see [SetInstanceHealth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/set-instance-health.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example sets the status of the specified instance to 'Unhealthy', taking it out of service. Auto Scaling terminates and replaces the instance.**
```
Set-ASInstanceHealth -HealthStatus Unhealthy -InstanceId i-93633f9b
```
**Example 2: This example sets the status of the specified instance to 'Healthy', keeping it in service. Any health check grace period for the Auto Scaling group is not honored.**
```
Set-ASInstanceHealth -HealthStatus Healthy -InstanceId i-93633f9b -ShouldRespectGracePeriod $false
```
+ For API details, see [SetInstanceHealth](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example sets the status of the specified instance to 'Unhealthy', taking it out of service. Auto Scaling terminates and replaces the instance.**
```
Set-ASInstanceHealth -HealthStatus Unhealthy -InstanceId i-93633f9b
```
**Example 2: This example sets the status of the specified instance to 'Healthy', keeping it in service. Any health check grace period for the Auto Scaling group is not honored.**
```
Set-ASInstanceHealth -HealthStatus Healthy -InstanceId i-93633f9b -ShouldRespectGracePeriod $false
```
+ For API details, see [SetInstanceHealth](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `SetInstanceProtection` with a CLI
The following code examples show how to use `SetInstanceProtection`.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To enable the instance protection setting for an instance**
This example enables instance protection for the specified instance.
```
aws autoscaling set-instance-protection \
--instance-ids i-061c63c5eb45f0416 \
--auto-scaling-group-name my-asg --protected-from-scale-in
```
This command produces no output.
**Example 2: To disable the instance protection setting for an instance**
This example disables instance protection for the specified instance.
```
aws autoscaling set-instance-protection \
--instance-ids i-061c63c5eb45f0416 \
--auto-scaling-group-name my-asg \
--no-protected-from-scale-in
```
This command produces no output.
+ For API details, see [SetInstanceProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/set-instance-protection.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example enables instance protection for the specified instance.**
```
Set-ASInstanceProtection -AutoScalingGroupName my-asg -InstanceId i-12345678 -ProtectedFromScaleIn $true
```
**Example 2: This example disables instance protection for the specified instance.**
```
Set-ASInstanceProtection -AutoScalingGroupName my-asg -InstanceId i-12345678 -ProtectedFromScaleIn $false
```
+ For API details, see [SetInstanceProtection](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example enables instance protection for the specified instance.**
```
Set-ASInstanceProtection -AutoScalingGroupName my-asg -InstanceId i-12345678 -ProtectedFromScaleIn $true
```
**Example 2: This example disables instance protection for the specified instance.**
```
Set-ASInstanceProtection -AutoScalingGroupName my-asg -InstanceId i-12345678 -ProtectedFromScaleIn $false
```
+ For API details, see [SetInstanceProtection](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `SuspendProcesses` with a CLI
The following code examples show how to use `SuspendProcesses`.
------
#### [ CLI ]
**AWS CLI**
**To suspend Auto Scaling processes**
This example suspends the specified scaling process for the specified Auto Scaling group.
```
aws autoscaling suspend-processes \
--auto-scaling-group-name my-asg \
--scaling-processes AlarmNotification
```
This command produces no output.
For more information, see [Suspending and resuming scaling processes](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [SuspendProcesses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/suspend-processes.html) in *AWS CLI Command Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example suspends the specified Auto Scaling process for the specified Auto Scaling group.**
```
Suspend-ASProcess -AutoScalingGroupName my-asg -ScalingProcess "AlarmNotification"
```
**Example 2: This example suspends all Auto Scaling processes for the specified Auto Scaling group.**
```
Suspend-ASProcess -AutoScalingGroupName my-asg
```
+ For API details, see [SuspendProcesses](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example suspends the specified Auto Scaling process for the specified Auto Scaling group.**
```
Suspend-ASProcess -AutoScalingGroupName my-asg -ScalingProcess "AlarmNotification"
```
**Example 2: This example suspends all Auto Scaling processes for the specified Auto Scaling group.**
```
Suspend-ASProcess -AutoScalingGroupName my-asg
```
+ For API details, see [SuspendProcesses](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
# Use `TerminateInstanceInAutoScalingGroup` with an AWS SDK or CLI
The following code examples show how to use `TerminateInstanceInAutoScalingGroup`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples:
+ [Learn the basics](auto-scaling_example_auto-scaling_Scenario_GroupsAndInstances_section.md)
+ [Build and manage a resilient service](auto-scaling_example_cross_ResilientService_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/AutoScaling#code-examples).
```
///
/// Terminate all instances in the Auto Scaling group in preparation for
/// deleting the group.
///
/// The instance Id of the instance to terminate.
/// A Boolean value that indicates the success or failure of
/// the operation.
public async Task TerminateInstanceInAutoScalingGroupAsync(
string instanceId)
{
var request = new TerminateInstanceInAutoScalingGroupRequest
{
InstanceId = instanceId,
ShouldDecrementDesiredCapacity = false,
};
var response = await _amazonAutoScaling.TerminateInstanceInAutoScalingGroupAsync(request);
if (response.HttpStatusCode == System.Net.HttpStatusCode.OK)
{
Console.WriteLine($"You have terminated the instance: {instanceId}");
return true;
}
Console.WriteLine($"Could not terminate {instanceId}");
return false;
}
```
+ For API details, see [TerminateInstanceInAutoScalingGroup](https://docs.aws.amazon.com/goto/DotNetSDKV4/autoscaling-2011-01-01/TerminateInstanceInAutoScalingGroup) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/autoscaling#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::AutoScaling::AutoScalingClient autoScalingClient(clientConfig);
Aws::AutoScaling::Model::TerminateInstanceInAutoScalingGroupRequest request;
request.SetInstanceId(instanceIDs[instanceNumber - 1]);
request.SetShouldDecrementDesiredCapacity(false);
Aws::AutoScaling::Model::TerminateInstanceInAutoScalingGroupOutcome outcome =
autoScalingClient.TerminateInstanceInAutoScalingGroup(request);
if (outcome.IsSuccess()) {
std::cout << "Waiting for EC2 instance with ID '"
<< instanceIDs[instanceNumber - 1] << "' to terminate..."
<< std::endl;
}
else {
std::cerr << "Error with AutoScaling::TerminateInstanceInAutoScalingGroup. "
<< outcome.GetError().GetMessage()
<< std::endl;
}
```
+ For API details, see [TerminateInstanceInAutoScalingGroup](https://docs.aws.amazon.com/goto/SdkForCpp/autoscaling-2011-01-01/TerminateInstanceInAutoScalingGroup) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To terminate an instance in an Auto Scaling group**
This example terminates the specified instance from the specified Auto Scaling group without updating the size of the group. Amazon EC2 Auto Scaling launches a replacement instance after the specified instance terminates.
```
aws autoscaling terminate-instance-in-auto-scaling-group \
--instance-id i-061c63c5eb45f0416 \
--no-should-decrement-desired-capacity
```
Output:
```
{
"Activities": [
{
"ActivityId": "8c35d601-793c-400c-fcd0-f64a27530df7",
"AutoScalingGroupName": "my-asg",
"Description": "Terminating EC2 instance: i-061c63c5eb45f0416",
"Cause": "",
"StartTime": "2020-10-31T20:34:25.680Z",
"StatusCode": "InProgress",
"Progress": 0,
"Details": "{\"Subnet ID\":\"subnet-6194ea3b\",\"Availability Zone\":\"us-west-2c\"}"
}
]
}
```
+ For API details, see [TerminateInstanceInAutoScalingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/terminate-instance-in-auto-scaling-group.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/autoscale#code-examples).
```
public static void terminateInstanceInAutoScalingGroup(AutoScalingClient autoScalingClient, String instanceId) {
try {
TerminateInstanceInAutoScalingGroupRequest request = TerminateInstanceInAutoScalingGroupRequest.builder()
.instanceId(instanceId)
.shouldDecrementDesiredCapacity(false)
.build();
autoScalingClient.terminateInstanceInAutoScalingGroup(request);
System.out.println("You have terminated instance " + instanceId);
} catch (AutoScalingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ For API details, see [TerminateInstanceInAutoScalingGroup](https://docs.aws.amazon.com/goto/SdkForJavaV2/autoscaling-2011-01-01/TerminateInstanceInAutoScalingGroup) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/autoscale#code-examples).
```
suspend fun terminateInstanceInAutoScalingGroup(instanceIdVal: String) {
val request =
TerminateInstanceInAutoScalingGroupRequest {
instanceId = instanceIdVal
shouldDecrementDesiredCapacity = false
}
AutoScalingClient { region = "us-east-1" }.use { autoScalingClient ->
autoScalingClient.terminateInstanceInAutoScalingGroup(request)
println("You have terminated instance $instanceIdVal")
}
}
```
+ For API details, see [TerminateInstanceInAutoScalingGroup](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ PHP ]
**SDK for PHP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/auto-scaling#code-examples).
```
public function terminateInstanceInAutoScalingGroup(
$instanceId,
$shouldDecrementDesiredCapacity = true,
$attempts = 0
) {
try {
return $this->autoScalingClient->terminateInstanceInAutoScalingGroup([
'InstanceId' => $instanceId,
'ShouldDecrementDesiredCapacity' => $shouldDecrementDesiredCapacity,
]);
} catch (AutoScalingException $exception) {
if ($exception->getAwsErrorCode() == "ScalingActivityInProgress" && $attempts < 5) {
error_log("Cannot terminate an instance while it is still pending. Waiting then trying again.");
sleep(5 * (1 + $attempts));
return $this->terminateInstanceInAutoScalingGroup(
$instanceId,
$shouldDecrementDesiredCapacity,
++$attempts
);
} else {
throw $exception;
}
}
}
```
+ For API details, see [TerminateInstanceInAutoScalingGroup](https://docs.aws.amazon.com/goto/SdkForPHPV3/autoscaling-2011-01-01/TerminateInstanceInAutoScalingGroup) in *AWS SDK for PHP API Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example terminates the specified instance and decreases the desired capacity of its Auto Scaling group so that Auto Scaling does not launch a replacement instance.**
```
Stop-ASInstanceInAutoScalingGroup -InstanceId i-93633f9b -ShouldDecrementDesiredCapacity $true
```
**Output:**
```
ActivityId : 2e40d9bd-1902-444c-abf3-6ea0002efdc5
AutoScalingGroupName :
Cause : At 2015-11-22T16:09:03Z instance i-93633f9b was taken out of service in response to a user
request, shrinking the capacity from 2 to 1.
Description : Terminating EC2 instance: i-93633f9b
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 0
StartTime : 11/22/2015 8:09:03 AM
StatusCode : InProgress
StatusMessage :
```
**Example 2: This example terminates the specified instance without decreasing the desired capacity of its Auto Scaling group. Auto Scaling launches a replacement instance.**
```
Stop-ASInstanceInAutoScalingGroup -InstanceId i-93633f9b -ShouldDecrementDesiredCapacity $false
```
**Output:**
```
ActivityId : 2e40d9bd-1902-444c-abf3-6ea0002efdc5
AutoScalingGroupName :
Cause : At 2015-11-22T16:09:03Z instance i-93633f9b was taken out of service in response to a user
request.
Description : Terminating EC2 instance: i-93633f9b
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 0
StartTime : 11/22/2015 8:09:03 AM
StatusCode : InProgress
StatusMessage :
```
+ For API details, see [TerminateInstanceInAutoScalingGroup](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example terminates the specified instance and decreases the desired capacity of its Auto Scaling group so that Auto Scaling does not launch a replacement instance.**
```
Stop-ASInstanceInAutoScalingGroup -InstanceId i-93633f9b -ShouldDecrementDesiredCapacity $true
```
**Output:**
```
ActivityId : 2e40d9bd-1902-444c-abf3-6ea0002efdc5
AutoScalingGroupName :
Cause : At 2015-11-22T16:09:03Z instance i-93633f9b was taken out of service in response to a user
request, shrinking the capacity from 2 to 1.
Description : Terminating EC2 instance: i-93633f9b
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 0
StartTime : 11/22/2015 8:09:03 AM
StatusCode : InProgress
StatusMessage :
```
**Example 2: This example terminates the specified instance without decreasing the desired capacity of its Auto Scaling group. Auto Scaling launches a replacement instance.**
```
Stop-ASInstanceInAutoScalingGroup -InstanceId i-93633f9b -ShouldDecrementDesiredCapacity $false
```
**Output:**
```
ActivityId : 2e40d9bd-1902-444c-abf3-6ea0002efdc5
AutoScalingGroupName :
Cause : At 2015-11-22T16:09:03Z instance i-93633f9b was taken out of service in response to a user
request.
Description : Terminating EC2 instance: i-93633f9b
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 0
StartTime : 11/22/2015 8:09:03 AM
StatusCode : InProgress
StatusMessage :
```
+ For API details, see [TerminateInstanceInAutoScalingGroup](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/auto-scaling#code-examples).
```
class AutoScalingWrapper:
"""Encapsulates Amazon EC2 Auto Scaling actions."""
def __init__(self, autoscaling_client):
"""
:param autoscaling_client: A Boto3 Amazon EC2 Auto Scaling client.
"""
self.autoscaling_client = autoscaling_client
def terminate_instance(
self, instance_id: str, decrease_capacity: bool
) -> Dict[str, Any]:
"""
Stops an instance.
:param instance_id: The ID of the instance to stop.
:param decrease_capacity: Specifies whether to decrease the desired capacity
of the group. When passing True for this parameter,
you can stop an instance without having a replacement
instance start when the desired capacity threshold is
crossed.
:return: A dictionary containing details of the scaling activity that occurs
in response to this action.
:raises ClientError: If there is an error terminating the instance.
"""
try:
response = self.autoscaling_client.terminate_instance_in_auto_scaling_group(
InstanceId=instance_id, ShouldDecrementDesiredCapacity=decrease_capacity
)
logger.info(f"Successfully terminated instance {instance_id}.")
return response["Activity"]
except ClientError as err:
error_code = err.response["Error"]["Code"]
logger.error(f"Failed to terminate instance {instance_id}.")
if error_code == "ScalingActivityInProgress":
logger.error(
"A scaling activity is currently in progress for the Auto Scaling group "
f"associated with instance '{instance_id}'. "
"Please wait for the activity to complete before attempting to terminate the instance."
)
elif error_code == "ResourceInUse":
logger.error(
f"The instance '{instance_id}' or an associated resource is currently in use "
"and cannot be terminated. "
"Ensure the instance is not involved in any ongoing processes and try again."
)
logger.error(f"Full error:\n\t{err}")
raise
```
+ For API details, see [TerminateInstanceInAutoScalingGroup](https://docs.aws.amazon.com/goto/boto3/autoscaling-2011-01-01/TerminateInstanceInAutoScalingGroup) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/auto-scaling#code-examples).
```
pub async fn terminate_some_instance(&self) -> Result<(), ScenarioError> {
// Retrieve a list of instances in the auto scaling group.
let auto_scaling_group = self.get_group().await?;
let instances = auto_scaling_group.instances();
// Or use other logic to find an instance to terminate.
let instance = instances.first();
if let Some(instance) = instance {
let instance_id = if let Some(instance_id) = instance.instance_id() {
instance_id
} else {
return Err(ScenarioError::with("Missing instance id"));
};
let termination = self
.ec2
.terminate_instances()
.instance_ids(instance_id)
.send()
.await;
if let Err(err) = termination {
Err(ScenarioError::new(
"There was a problem terminating an instance",
&err,
))
} else {
Ok(())
}
} else {
Err(ScenarioError::with("There was no instance to terminate"))
}
}
async fn get_group(&self) -> Result {
let describe_auto_scaling_groups = self
.autoscaling
.describe_auto_scaling_groups()
.auto_scaling_group_names(self.auto_scaling_group_name.clone())
.send()
.await;
if let Err(err) = describe_auto_scaling_groups {
return Err(ScenarioError::new(
format!(
"Failed to get status of autoscaling group {}",
self.auto_scaling_group_name.clone()
)
.as_str(),
&err,
));
}
let describe_auto_scaling_groups_output = describe_auto_scaling_groups.unwrap();
let auto_scaling_groups = describe_auto_scaling_groups_output.auto_scaling_groups();
let auto_scaling_group = auto_scaling_groups.first();
if auto_scaling_group.is_none() {
return Err(ScenarioError::with(format!(
"Could not find autoscaling group {}",
self.auto_scaling_group_name.clone()
)));
}
Ok(auto_scaling_group.unwrap().clone())
}
```
+ For API details, see [TerminateInstanceInAutoScalingGroup](https://docs.rs/aws-sdk-autoscaling/latest/aws_sdk_autoscaling/client/struct.Client.html#method.terminate_instance_in_auto_scaling_group) in *AWS SDK for Rust API reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/asc#code-examples).
```
" Example: iv_instance_id = 'i-1234567890abcdef0'
" Example: iv_decrease_capacity = abap_true
TRY.
DATA(lo_output) = ao_asc->terminateinstinautoscgroup(
iv_instanceid = iv_instance_id
iv_shoulddecrementdesiredcap = iv_decrease_capacity ).
oo_output = lo_output->get_activity( ).
MESSAGE 'Instance terminated successfully' TYPE 'I'.
CATCH /aws1/cx_ascscaactivityinprg00 INTO DATA(lo_activity_in_progress).
RAISE EXCEPTION lo_activity_in_progress.
CATCH /aws1/cx_ascresrccontionfault INTO DATA(lo_contention).
RAISE EXCEPTION lo_contention.
CATCH /aws1/cx_rt_generic INTO DATA(lo_generic_exception).
RAISE EXCEPTION lo_generic_exception.
ENDTRY.
```
+ For API details, see [TerminateInstanceInAutoScalingGroup](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `UpdateAutoScalingGroup` with an AWS SDK or CLI
The following code examples show how to use `UpdateAutoScalingGroup`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples:
+ [Learn the basics](auto-scaling_example_auto-scaling_Scenario_GroupsAndInstances_section.md)
+ [Build and manage a resilient service](auto-scaling_example_cross_ResilientService_section.md)
------
#### [ .NET ]
**SDK for .NET (v4)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/AutoScaling#code-examples).
```
///
/// Update the capacity of an Auto Scaling group.
///
/// The name of the Auto Scaling group.
/// The name of the EC2 launch template.
/// The maximum number of instances that can be
/// created for the Auto Scaling group.
/// A Boolean value indicating the success of the action.
public async Task UpdateAutoScalingGroupAsync(
string groupName,
string launchTemplateName,
int maxSize)
{
var templateSpecification = new LaunchTemplateSpecification
{
LaunchTemplateName = launchTemplateName,
};
var groupRequest = new UpdateAutoScalingGroupRequest
{
MaxSize = maxSize,
AutoScalingGroupName = groupName,
LaunchTemplate = templateSpecification,
};
var response = await _amazonAutoScaling.UpdateAutoScalingGroupAsync(groupRequest);
if (response.HttpStatusCode == System.Net.HttpStatusCode.OK)
{
Console.WriteLine($"You successfully updated the Auto Scaling group {groupName}.");
return true;
}
else
{
return false;
}
}
```
+ For API details, see [UpdateAutoScalingGroup](https://docs.aws.amazon.com/goto/DotNetSDKV4/autoscaling-2011-01-01/UpdateAutoScalingGroup) in *AWS SDK for .NET API Reference*.
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/autoscaling#code-examples).
```
Aws::Client::ClientConfiguration clientConfig;
// Optional: Set to the AWS Region (overrides config file).
// clientConfig.region = "us-east-1";
Aws::AutoScaling::AutoScalingClient autoScalingClient(clientConfig);
Aws::AutoScaling::Model::UpdateAutoScalingGroupRequest request;
request.SetAutoScalingGroupName(groupName);
request.SetMaxSize(3);
Aws::AutoScaling::Model::UpdateAutoScalingGroupOutcome outcome =
autoScalingClient.UpdateAutoScalingGroup(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error with AutoScaling::UpdateAutoScalingGroup. "
<< outcome.GetError().GetMessage()
<< std::endl;
}
```
+ For API details, see [UpdateAutoScalingGroup](https://docs.aws.amazon.com/goto/SdkForCpp/autoscaling-2011-01-01/UpdateAutoScalingGroup) in *AWS SDK for C\$1\$1 API Reference*.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To update the size limits of an Auto Scaling group**
This example updates the specified Auto Scaling group with a minimum size of 2 and a maximum size of 10.
```
aws autoscaling update-auto-scaling-group \
--auto-scaling-group-name my-asg \
--min-size 2 \
--max-size 10
```
This command produces no output.
For more information, see [Setting capacity limits for your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-capacity-limits.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 2: To add Elastic Load Balancing health checks and specify which Availability Zones and subnets to use**
This example updates the specified Auto Scaling group to add Elastic Load Balancing health checks. This command also updates the value of `--vpc-zone-identifier` with a list of subnet IDs in multiple Availability Zones.
```
aws autoscaling update-auto-scaling-group \
--auto-scaling-group-name my-asg \
--health-check-type ELB \
--health-check-grace-period 600 \
--vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782"
```
This command produces no output.
For more information, see [Elastic Load Balancing and Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 3: To update the placement group and termination policy**
This example updates the placement group and termination policy to use.
```
aws autoscaling update-auto-scaling-group \
--auto-scaling-group-name my-asg \
--placement-group my-placement-group \
--termination-policies "OldestInstance"
```
This command produces no output.
For more information, see [Auto Scaling groups](https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 4: To use the latest version of the launch template**
This example updates the specified Auto Scaling group to use the latest version of the specified launch template.
```
aws autoscaling update-auto-scaling-group \
--auto-scaling-group-name my-asg \
--launch-template LaunchTemplateId=lt-1234567890abcde12,Version='$Latest'
```
This command produces no output.
For more information, see [Launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 5: To use a specific version of the launch template**
This example updates the specified Auto Scaling group to use a specific version of a launch template instead of the latest or default version.
```
aws autoscaling update-auto-scaling-group \
--auto-scaling-group-name my-asg \
--launch-template LaunchTemplateName=my-template-for-auto-scaling,Version='2'
```
This command produces no output.
For more information, see [Launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html) in the *Amazon EC2 Auto Scaling User Guide*.
**Example 6: To define a mixed instances policy and enable capacity rebalancing**
This example updates the specified Auto Scaling group to use a mixed instances policy and enables capacity rebalancing. This structure lets you specify groups with Spot and On-Demand capacities and use different launch templates for different architectures.
```
aws autoscaling update-auto-scaling-group \
--cli-input-json file://~/config.json
```
Contents of `config.json`:
```
{
"AutoScalingGroupName": "my-asg",
"CapacityRebalance": true,
"MixedInstancesPolicy": {
"LaunchTemplate": {
"LaunchTemplateSpecification": {
"LaunchTemplateName": "my-launch-template-for-x86",
"Version": "$Latest"
},
"Overrides": [
{
"InstanceType": "c6g.large",
"LaunchTemplateSpecification": {
"LaunchTemplateName": "my-launch-template-for-arm",
"Version": "$Latest"
}
},
{
"InstanceType": "c5.large"
},
{
"InstanceType": "c5a.large"
}
]
},
"InstancesDistribution": {
"OnDemandPercentageAboveBaseCapacity": 50,
"SpotAllocationStrategy": "capacity-optimized"
}
}
}
```
This command produces no output.
For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html) in the *Amazon EC2 Auto Scaling User Guide*.
+ For API details, see [UpdateAutoScalingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/update-auto-scaling-group.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/autoscale#code-examples).
```
public static void updateAutoScalingGroup(AutoScalingClient autoScalingClient, String groupName,
String launchTemplateName) {
try {
AutoScalingWaiter waiter = autoScalingClient.waiter();
LaunchTemplateSpecification templateSpecification = LaunchTemplateSpecification.builder()
.launchTemplateName(launchTemplateName)
.build();
UpdateAutoScalingGroupRequest groupRequest = UpdateAutoScalingGroupRequest.builder()
.maxSize(3)
.autoScalingGroupName(groupName)
.launchTemplate(templateSpecification)
.build();
autoScalingClient.updateAutoScalingGroup(groupRequest);
DescribeAutoScalingGroupsRequest groupsRequest = DescribeAutoScalingGroupsRequest.builder()
.autoScalingGroupNames(groupName)
.build();
WaiterResponse waiterResponse = waiter
.waitUntilGroupInService(groupsRequest);
waiterResponse.matched().response().ifPresent(System.out::println);
System.out.println("You successfully updated the auto scaling group " + groupName);
} catch (AutoScalingException e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
```
+ For API details, see [UpdateAutoScalingGroup](https://docs.aws.amazon.com/goto/SdkForJavaV2/autoscaling-2011-01-01/UpdateAutoScalingGroup) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/autoscale#code-examples).
```
suspend fun updateAutoScalingGroup(
groupName: String,
launchTemplateNameVal: String,
serviceLinkedRoleARNVal: String,
) {
val templateSpecification =
LaunchTemplateSpecification {
launchTemplateName = launchTemplateNameVal
}
val groupRequest =
UpdateAutoScalingGroupRequest {
maxSize = 3
serviceLinkedRoleArn = serviceLinkedRoleARNVal
autoScalingGroupName = groupName
launchTemplate = templateSpecification
}
val groupsRequestWaiter =
DescribeAutoScalingGroupsRequest {
autoScalingGroupNames = listOf(groupName)
}
AutoScalingClient { region = "us-east-1" }.use { autoScalingClient ->
autoScalingClient.updateAutoScalingGroup(groupRequest)
autoScalingClient.waitUntilGroupExists(groupsRequestWaiter)
println("You successfully updated the Auto Scaling group $groupName")
}
}
```
+ For API details, see [UpdateAutoScalingGroup](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ PHP ]
**SDK for PHP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/auto-scaling#code-examples).
```
public function updateAutoScalingGroup($autoScalingGroupName, $args)
{
if (array_key_exists('MaxSize', $args)) {
$maxSize = ['MaxSize' => $args['MaxSize']];
} else {
$maxSize = [];
}
if (array_key_exists('MinSize', $args)) {
$minSize = ['MinSize' => $args['MinSize']];
} else {
$minSize = [];
}
$parameters = ['AutoScalingGroupName' => $autoScalingGroupName];
$parameters = array_merge($parameters, $minSize, $maxSize);
return $this->autoScalingClient->updateAutoScalingGroup($parameters);
}
```
+ For API details, see [UpdateAutoScalingGroup](https://docs.aws.amazon.com/goto/SdkForPHPV3/autoscaling-2011-01-01/UpdateAutoScalingGroup) in *AWS SDK for PHP API Reference*.
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**Example 1: This example updates the minimum and maximum size of the specified Auto Scaling group.**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -MaxSize 5 -MinSize 1
```
**Example 2: This example updates the default cooldown period of the specified Auto Scaling group.**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -DefaultCooldown 10
```
**Example 3: This example updates the Availability Zones of the specified Auto Scaling group.**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -AvailabilityZone @("us-west-2a", "us-west-2b")
```
**Example 4: This example updates the specified Auto Scaling group to use Elastic Load Balancing health checks.**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -HealthCheckType ELB -HealthCheckGracePeriod 60
```
+ For API details, see [UpdateAutoScalingGroup](https://docs.aws.amazon.com/powershell/v4/reference) in *AWS Tools for PowerShell Cmdlet Reference (V4)*.
**Tools for PowerShell V5**
**Example 1: This example updates the minimum and maximum size of the specified Auto Scaling group.**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -MaxSize 5 -MinSize 1
```
**Example 2: This example updates the default cooldown period of the specified Auto Scaling group.**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -DefaultCooldown 10
```
**Example 3: This example updates the Availability Zones of the specified Auto Scaling group.**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -AvailabilityZone @("us-west-2a", "us-west-2b")
```
**Example 4: This example updates the specified Auto Scaling group to use Elastic Load Balancing health checks.**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -HealthCheckType ELB -HealthCheckGracePeriod 60
```
+ For API details, see [UpdateAutoScalingGroup](https://docs.aws.amazon.com/powershell/v5/reference) in *AWS Tools for PowerShell Cmdlet Reference (V5)*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/auto-scaling#code-examples).
```
class AutoScalingWrapper:
"""Encapsulates Amazon EC2 Auto Scaling actions."""
def __init__(self, autoscaling_client):
"""
:param autoscaling_client: A Boto3 Amazon EC2 Auto Scaling client.
"""
self.autoscaling_client = autoscaling_client
def update_group(self, group_name: str, **kwargs: Any) -> None:
"""
Updates an Auto Scaling group.
:param group_name: The name of the group to update.
:param kwargs: Keyword arguments to pass through to the service.
:return: None
:raises ClientError: If there is an error updating the Auto Scaling group.
"""
try:
self.autoscaling_client.update_auto_scaling_group(
AutoScalingGroupName=group_name, **kwargs
)
logger.info(f"Successfully updated Auto Scaling group {group_name}.")
except ClientError as err:
error_code = err.response["Error"]["Code"]
logger.error(f"Failed to update Auto Scaling group {group_name}.")
if error_code == "ResourceInUse":
logger.error(
"The Auto Scaling group '%s' is currently in use and cannot be modified. Please try again later.",
group_name,
)
elif error_code == "ScalingActivityInProgress":
logger.error(
f"A scaling activity is currently in progress for the Auto Scaling group '{group_name}'."
"Please wait for the activity to complete before attempting to update the group."
)
logger.error(f"Full error:\n\t{err}")
raise
```
+ For API details, see [UpdateAutoScalingGroup](https://docs.aws.amazon.com/goto/boto3/autoscaling-2011-01-01/UpdateAutoScalingGroup) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/auto-scaling#code-examples).
```
async fn update_group(client: &Client, name: &str, size: i32) -> Result<(), Error> {
client
.update_auto_scaling_group()
.auto_scaling_group_name(name)
.max_size(size)
.send()
.await?;
println!("Updated AutoScaling group");
Ok(())
}
```
+ For API details, see [UpdateAutoScalingGroup](https://docs.rs/aws-sdk-autoscaling/latest/aws_sdk_autoscaling/client/struct.Client.html#method.update_auto_scaling_group) in *AWS SDK for Rust API reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/asc#code-examples).
```
" Example: iv_group_name = 'my-auto-scaling-group'
" Example: iv_max_size = 5
TRY.
ao_asc->updateautoscalinggroup(
iv_autoscalinggroupname = iv_group_name
iv_maxsize = iv_max_size
iv_minsize = iv_min_size ).
MESSAGE 'Auto Scaling group updated successfully' TYPE 'I'.
CATCH /aws1/cx_ascresrccontionfault INTO DATA(lo_contention).
RAISE EXCEPTION lo_contention.
CATCH /aws1/cx_ascscaactivityinprg00 INTO DATA(lo_activity_in_progress).
RAISE EXCEPTION lo_activity_in_progress.
CATCH /aws1/cx_rt_generic INTO DATA(lo_generic_exception).
RAISE EXCEPTION lo_generic_exception.
ENDTRY.
```
+ For API details, see [UpdateAutoScalingGroup](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------