auto_scaling_groups

Creates, updates, deletes or gets an auto_scaling_group resource or lists auto_scaling_groups in a region

Overview

Name	`auto_scaling_groups`
Type	Resource
Description	The `AWS::AutoScaling::AutoScalingGroup` resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management. For more information about Amazon EC2 Auto Scaling, see the Amazon EC2 Auto Scaling User Guide. Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide. For help migrating from launch configurations to launch templates, see Migrate CloudFormation stacks from launch configurations to launch templates in the Amazon EC2 Auto Scaling User Guide.
Id	`awscc.autoscaling.auto_scaling_groups`

Fields

get (all properties)
list (identifiers only)

Name	Datatype	Description
▶`lifecycle_hook_specification_list`	`array`	One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
`load_balancer_names`	`array`	A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the `TargetGroupARNs` property instead.
`launch_configuration_name`	`string`	The name of the launch configuration to use to launch instances. Required only if you don't specify `LaunchTemplate`, `MixedInstancesPolicy`, or `InstanceId`.
`service_linked_role_arn`	`string`	The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named `AWSServiceRoleForAutoScaling`, which it creates if it does not exist. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.
▶`availability_zone_impairment_policy`	`object`	The Availability Zone impairment policy.
`target_group_arns`	`array`	The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
`cooldown`	`string`	Only needed if you use simple scaling policies. The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. Default: `300` seconds
▶`notification_configurations`	`array`	Configures an Auto Scaling group to send notifications when specified events take place.
`desired_capacity`	`string`	The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling. The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group. CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.
`health_check_grace_period`	`integer`	The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the `InService` state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. Default: `0` seconds
`default_instance_warmup`	`integer`	The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the `InService` state. During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, even if it is set to 0 seconds. To remove a value that you previously set, include the property but specify `-1` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of `0` or other nominal value. Default: None
`skip_zonal_shift_validation`	`boolean`
`new_instances_protected_from_scale_in`	`boolean`	Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
▶`launch_template`	`object`	Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a `MixedInstancesPolicy`. For more information about creating launch templates, see Create a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. If you omit this property, you must specify `MixedInstancesPolicy`, `LaunchConfigurationName`, or `InstanceId`.
▶`mixed_instances_policy`	`object`	An embedded object that specifies a mixed instances policy. The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
`vpc_zone_identifier`	`array`	A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment. When you update `VPCZoneIdentifier`, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an UpdatePolicy attribute. Required to launch instances into a nondefault VPC. If you specify `VPCZoneIdentifier` with `AvailabilityZones`, the subnets that you specify for this property must reside in those Availability Zones.
▶`tags`	`array`	One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
`context`	`string`	Reserved.
`capacity_rebalance`	`boolean`	Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the in the Amazon EC2 Auto Scaling User Guide.
`instance_id`	`string`	The ID of the instance used to base the launch configuration on. For more information, see Create an Auto Scaling group using an EC2 instance in the Amazon EC2 Auto Scaling User Guide. If you specify `LaunchTemplate`, `MixedInstancesPolicy`, or `LaunchConfigurationName`, don't specify `InstanceId`.
`auto_scaling_group_arn`	`string`
`availability_zones`	`array`	A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the `VPCZoneIdentifier` property, or for attaching a network interface when an existing network interface ID is specified in a launch template.
▶`availability_zone_distribution`	`object`	The instance capacity distribution across Availability Zones.
▶`metrics_collection`	`array`	Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.
▶`instance_maintenance_policy`	`object`	An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
`max_size`	`string`	The maximum size of the group. With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above `MaxSize` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above `MaxSize` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).
`min_size`	`string`	The minimum size of the group.
`termination_policies`	`array`	A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. Valid values: `Default` \| `AllocationStrategy` \| `ClosestToNextInstanceHour` \| `NewestInstance` \| `OldestInstance` \| `OldestLaunchConfiguration` \| `OldestLaunchTemplate` \| `arn:aws:lambda:region:account-id:function:my-function:my-alias`
`auto_scaling_group_name`	`string`	The name of the Auto Scaling group. This name must be unique per Region per account. The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters. You cannot use a colon (:) in the name.
▶`traffic_sources`	`array`	The traffic sources associated with this Auto Scaling group.
`desired_capacity_type`	`string`	The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports `DesiredCapacityType` for attribute-based instance type selection only. For more information, see Create a mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide. By default, Amazon EC2 Auto Scaling specifies `units`, which translates into number of instances. Valid values: `units` \| `vcpu` \| `memory-mib`
`placement_group`	`string`	The name of the placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide. A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
▶`capacity_reservation_specification`	`object`	The capacity reservation specification.
`health_check_type`	`string`	A comma-separated value string of one or more health check types. The valid values are `EC2`, `EBS`, `ELB`, and `VPC_LATTICE`. `EC2` is the default health check and cannot be disabled. For more information, see Health checks for instances in an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. Only specify `EC2` if you must clear a value that was previously set.
`max_instance_lifetime`	`integer`	The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see Replace Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
`region`	`string`	AWS region.

Name	Datatype	Description
`auto_scaling_group_name`	`string`	The name of the Auto Scaling group. This name must be unique per Region per account. The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters. You cannot use a colon (:) in the name.
`region`	`string`	AWS region.

For more information, see AWS::AutoScaling::AutoScalingGroup.

Methods

Name	Resource	Accessible by	Required Params
`create_resource`	`auto_scaling_groups`	`INSERT`	`MinSize, MaxSize, region`
`delete_resource`	`auto_scaling_groups`	`DELETE`	`Identifier, region`
`update_resource`	`auto_scaling_groups`	`UPDATE`	`Identifier, PatchDocument, region`
`list_resources`	`auto_scaling_groups_list_only`	`SELECT`	`region`
`get_resource`	`auto_scaling_groups`	`SELECT`	`Identifier, region`

`SELECT` examples

get (all properties)
list (identifiers only)

Gets all properties from an individual auto_scaling_group.

SELECT
  region,
  lifecycle_hook_specification_list,
  load_balancer_names,
  launch_configuration_name,
  service_linked_role_arn,
  availability_zone_impairment_policy,
  target_group_arns,
  cooldown,
  notification_configurations,
  desired_capacity,
  health_check_grace_period,
  default_instance_warmup,
  skip_zonal_shift_validation,
  new_instances_protected_from_scale_in,
  launch_template,
  mixed_instances_policy,
  vpc_zone_identifier,
  tags,
  context,
  capacity_rebalance,
  instance_id,
  auto_scaling_group_arn,
  availability_zones,
  notification_configuration,
  availability_zone_distribution,
  metrics_collection,
  instance_maintenance_policy,
  max_size,
  min_size,
  termination_policies,
  auto_scaling_group_name,
  traffic_sources,
  desired_capacity_type,
  placement_group,
  capacity_reservation_specification,
  health_check_type,
  max_instance_lifetime
FROM awscc.autoscaling.auto_scaling_groups
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ auto_scaling_group_name }}';

Lists all auto_scaling_groups in a region.

SELECT
  region,
  auto_scaling_group_name
FROM awscc.autoscaling.auto_scaling_groups_list_only
WHERE
  region = '{{ region }}';

`INSERT` example

Use the following StackQL query and manifest file to create a new auto_scaling_group resource, using stack-deploy.

Required Properties
All Properties
Manifest

/*+ create */
INSERT INTO awscc.autoscaling.auto_scaling_groups (
  MaxSize,
  MinSize,
  region
)
SELECT
  '{{ max_size }}',
  '{{ min_size }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

/*+ create */
INSERT INTO awscc.autoscaling.auto_scaling_groups (
  LifecycleHookSpecificationList,
  LoadBalancerNames,
  LaunchConfigurationName,
  ServiceLinkedRoleARN,
  AvailabilityZoneImpairmentPolicy,
  TargetGroupARNs,
  Cooldown,
  NotificationConfigurations,
  DesiredCapacity,
  HealthCheckGracePeriod,
  DefaultInstanceWarmup,
  SkipZonalShiftValidation,
  NewInstancesProtectedFromScaleIn,
  LaunchTemplate,
  MixedInstancesPolicy,
  VPCZoneIdentifier,
  Tags,
  Context,
  CapacityRebalance,
  InstanceId,
  AvailabilityZones,
  NotificationConfiguration,
  AvailabilityZoneDistribution,
  MetricsCollection,
  InstanceMaintenancePolicy,
  MaxSize,
  MinSize,
  TerminationPolicies,
  AutoScalingGroupName,
  TrafficSources,
  DesiredCapacityType,
  PlacementGroup,
  CapacityReservationSpecification,
  HealthCheckType,
  MaxInstanceLifetime,
  region
)
SELECT
  '{{ lifecycle_hook_specification_list }}',
  '{{ load_balancer_names }}',
  '{{ launch_configuration_name }}',
  '{{ service_linked_role_arn }}',
  '{{ availability_zone_impairment_policy }}',
  '{{ target_group_arns }}',
  '{{ cooldown }}',
  '{{ notification_configurations }}',
  '{{ desired_capacity }}',
  '{{ health_check_grace_period }}',
  '{{ default_instance_warmup }}',
  '{{ skip_zonal_shift_validation }}',
  '{{ new_instances_protected_from_scale_in }}',
  '{{ launch_template }}',
  '{{ mixed_instances_policy }}',
  '{{ vpc_zone_identifier }}',
  '{{ tags }}',
  '{{ context }}',
  '{{ capacity_rebalance }}',
  '{{ instance_id }}',
  '{{ availability_zones }}',
  '{{ notification_configuration }}',
  '{{ availability_zone_distribution }}',
  '{{ metrics_collection }}',
  '{{ instance_maintenance_policy }}',
  '{{ max_size }}',
  '{{ min_size }}',
  '{{ termination_policies }}',
  '{{ auto_scaling_group_name }}',
  '{{ traffic_sources }}',
  '{{ desired_capacity_type }}',
  '{{ placement_group }}',
  '{{ capacity_reservation_specification }}',
  '{{ health_check_type }}',
  '{{ max_instance_lifetime }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: auto_scaling_group
  props:
    - name: lifecycle_hook_specification_list
      value:
        - lifecycle_hook_name: '{{ lifecycle_hook_name }}'
          lifecycle_transition: '{{ lifecycle_transition }}'
          heartbeat_timeout: '{{ heartbeat_timeout }}'
          notification_metadata: '{{ notification_metadata }}'
          default_result: '{{ default_result }}'
          notification_target_arn: '{{ notification_target_arn }}'
          role_arn: '{{ role_arn }}'
    - name: load_balancer_names
      value:
        - '{{ load_balancer_names[0] }}'
    - name: launch_configuration_name
      value: '{{ launch_configuration_name }}'
    - name: service_linked_role_arn
      value: '{{ service_linked_role_arn }}'
    - name: availability_zone_impairment_policy
      value:
        zonal_shift_enabled: '{{ zonal_shift_enabled }}'
        impaired_zone_health_check_behavior: '{{ impaired_zone_health_check_behavior }}'
    - name: target_group_arns
      value:
        - '{{ target_group_arns[0] }}'
    - name: cooldown
      value: '{{ cooldown }}'
    - name: notification_configurations
      value:
        - topic_arn:
            - '{{ topic_arn[0] }}'
          notification_types:
            - '{{ notification_types[0] }}'
    - name: desired_capacity
      value: '{{ desired_capacity }}'
    - name: health_check_grace_period
      value: '{{ health_check_grace_period }}'
    - name: default_instance_warmup
      value: '{{ default_instance_warmup }}'
    - name: skip_zonal_shift_validation
      value: '{{ skip_zonal_shift_validation }}'
    - name: new_instances_protected_from_scale_in
      value: '{{ new_instances_protected_from_scale_in }}'
    - name: launch_template
      value:
        launch_template_name: '{{ launch_template_name }}'
        version: '{{ version }}'
        launch_template_id: '{{ launch_template_id }}'
    - name: mixed_instances_policy
      value:
        instances_distribution:
          on_demand_allocation_strategy: '{{ on_demand_allocation_strategy }}'
          on_demand_base_capacity: '{{ on_demand_base_capacity }}'
          on_demand_percentage_above_base_capacity: '{{ on_demand_percentage_above_base_capacity }}'
          spot_instance_pools: '{{ spot_instance_pools }}'
          spot_allocation_strategy: '{{ spot_allocation_strategy }}'
          spot_max_price: '{{ spot_max_price }}'
        launch_template:
          launch_template_specification: null
          overrides:
            - launch_template_specification: null
              weighted_capacity: '{{ weighted_capacity }}'
              instance_requirements:
                instance_generations:
                  - '{{ instance_generations[0] }}'
                accelerator_types:
                  - '{{ accelerator_types[0] }}'
                memory_gi_bper_vcpu:
                  min: null
                  max: null
                accelerator_manufacturers:
                  - '{{ accelerator_manufacturers[0] }}'
                v_cpu_count:
                  min: '{{ min }}'
                  max: '{{ max }}'
                local_storage: '{{ local_storage }}'
                cpu_manufacturers:
                  - '{{ cpu_manufacturers[0] }}'
                bare_metal: '{{ bare_metal }}'
                require_hibernate_support: '{{ require_hibernate_support }}'
                max_spot_price_as_percentage_of_optimal_on_demand_price: '{{ max_spot_price_as_percentage_of_optimal_on_demand_price }}'
                on_demand_max_price_percentage_over_lowest_price: '{{ on_demand_max_price_percentage_over_lowest_price }}'
                memory_mi_b:
                  min: '{{ min }}'
                  max: '{{ max }}'
                local_storage_types:
                  - '{{ local_storage_types[0] }}'
                network_interface_count:
                  min: '{{ min }}'
                  max: '{{ max }}'
                excluded_instance_types:
                  - '{{ excluded_instance_types[0] }}'
                allowed_instance_types:
                  - '{{ allowed_instance_types[0] }}'
                accelerator_count:
                  min: '{{ min }}'
                  max: '{{ max }}'
                network_bandwidth_gbps:
                  min: null
                  max: null
                baseline_performance_factors:
                  cpu:
                    references:
                      - instance_family: '{{ instance_family }}'
                baseline_ebs_bandwidth_mbps:
                  min: '{{ min }}'
                  max: '{{ max }}'
                spot_max_price_percentage_over_lowest_price: '{{ spot_max_price_percentage_over_lowest_price }}'
                accelerator_names:
                  - '{{ accelerator_names[0] }}'
                accelerator_total_memory_mi_b:
                  min: '{{ min }}'
                  max: '{{ max }}'
                burstable_performance: '{{ burstable_performance }}'
                total_local_storage_gb:
                  min: null
                  max: null
              instance_type: '{{ instance_type }}'
    - name: vpc_zone_identifier
      value:
        - '{{ vpc_zone_identifier[0] }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'
          propagate_at_launch: '{{ propagate_at_launch }}'
    - name: context
      value: '{{ context }}'
    - name: capacity_rebalance
      value: '{{ capacity_rebalance }}'
    - name: instance_id
      value: '{{ instance_id }}'
    - name: availability_zones
      value:
        - '{{ availability_zones[0] }}'
    - name: notification_configuration
      value: null
    - name: availability_zone_distribution
      value:
        capacity_distribution_strategy: '{{ capacity_distribution_strategy }}'
    - name: metrics_collection
      value:
        - metrics:
            - '{{ metrics[0] }}'
          granularity: '{{ granularity }}'
    - name: instance_maintenance_policy
      value:
        max_healthy_percentage: '{{ max_healthy_percentage }}'
        min_healthy_percentage: '{{ min_healthy_percentage }}'
    - name: max_size
      value: '{{ max_size }}'
    - name: min_size
      value: '{{ min_size }}'
    - name: termination_policies
      value:
        - '{{ termination_policies[0] }}'
    - name: auto_scaling_group_name
      value: '{{ auto_scaling_group_name }}'
    - name: traffic_sources
      value:
        - type: '{{ type }}'
          identifier: '{{ identifier }}'
    - name: desired_capacity_type
      value: '{{ desired_capacity_type }}'
    - name: placement_group
      value: '{{ placement_group }}'
    - name: capacity_reservation_specification
      value:
        capacity_reservation_preference: '{{ capacity_reservation_preference }}'
        capacity_reservation_target:
          capacity_reservation_ids:
            - '{{ capacity_reservation_ids[0] }}'
          capacity_reservation_resource_group_arns:
            - '{{ capacity_reservation_resource_group_arns[0] }}'
    - name: health_check_type
      value: '{{ health_check_type }}'
    - name: max_instance_lifetime
      value: '{{ max_instance_lifetime }}'

`UPDATE` example

Use the following StackQL query and manifest file to update a auto_scaling_group resource, using stack-deploy.

/*+ update */
UPDATE awscc.autoscaling.auto_scaling_groups
SET PatchDocument = string('{{ {
    "LifecycleHookSpecificationList": lifecycle_hook_specification_list,
    "LoadBalancerNames": load_balancer_names,
    "LaunchConfigurationName": launch_configuration_name,
    "ServiceLinkedRoleARN": service_linked_role_arn,
    "AvailabilityZoneImpairmentPolicy": availability_zone_impairment_policy,
    "TargetGroupARNs": target_group_arns,
    "Cooldown": cooldown,
    "NotificationConfigurations": notification_configurations,
    "DesiredCapacity": desired_capacity,
    "HealthCheckGracePeriod": health_check_grace_period,
    "DefaultInstanceWarmup": default_instance_warmup,
    "SkipZonalShiftValidation": skip_zonal_shift_validation,
    "NewInstancesProtectedFromScaleIn": new_instances_protected_from_scale_in,
    "LaunchTemplate": launch_template,
    "MixedInstancesPolicy": mixed_instances_policy,
    "VPCZoneIdentifier": vpc_zone_identifier,
    "Tags": tags,
    "Context": context,
    "CapacityRebalance": capacity_rebalance,
    "AvailabilityZones": availability_zones,
    "NotificationConfiguration": notification_configuration,
    "AvailabilityZoneDistribution": availability_zone_distribution,
    "MetricsCollection": metrics_collection,
    "InstanceMaintenancePolicy": instance_maintenance_policy,
    "MaxSize": max_size,
    "MinSize": min_size,
    "TerminationPolicies": termination_policies,
    "TrafficSources": traffic_sources,
    "DesiredCapacityType": desired_capacity_type,
    "PlacementGroup": placement_group,
    "CapacityReservationSpecification": capacity_reservation_specification,
    "HealthCheckType": health_check_type,
    "MaxInstanceLifetime": max_instance_lifetime
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ auto_scaling_group_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

`DELETE` example

/*+ delete */
DELETE FROM awscc.autoscaling.auto_scaling_groups
WHERE
  Identifier = '{{ auto_scaling_group_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
`ClientToken`	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
`RoleArn`	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
`TypeVersionId`	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the auto_scaling_groups resource, the following permissions are required:

Read
Create
Update
List
Delete

autoscaling:Describe*,
managed-fleets:Get*

autoscaling:CreateAutoScalingGroup,
autoscaling:UpdateAutoScalingGroup,
autoscaling:CreateOrUpdateTags,
autoscaling:Describe*,
autoscaling:EnableMetricsCollection,
autoscaling:PutNotificationConfiguration,
cloudwatch:PutMetricAlarm,
ec2:Describe*,
ec2:Get*,
ec2:RunInstances,
elasticloadbalancing:Describe*,
iam:CreateServiceLinkedRole,
iam:PassRole,
managed-fleets:Get*,
managed-fleets:CreateAutoScalingGroup,
managed-fleets:UpdateAutoScalingGroup,
ssm:Get*,
vpc-lattice:DeregisterTargets,
vpc-lattice:GetTargetGroup,
vpc-lattice:ListTargets,
vpc-lattice:RegisterTargets

autoscaling:UpdateAutoScalingGroup,
autoscaling:CreateOrUpdateTags,
autoscaling:DeleteTags,
autoscaling:Describe*,
autoscaling:EnableMetricsCollection,
autoscaling:DisableMetricsCollection,
autoscaling:PutNotificationConfiguration,
autoscaling:DeleteNotificationConfiguration,
autoscaling:DetachLoadBalancerTargetGroups,
autoscaling:AttachLoadBalancerTargetGroups,
autoscaling:AttachLoadBalancers,
autoscaling:DetachLoadBalancers,
autoscaling:AttachTrafficSources,
autoscaling:DetachTrafficSources,
autoscaling:DeleteLifecycleHook,
autoscaling:PutLifecycleHook,
cloudwatch:PutMetricAlarm,
ec2:Describe*,
ec2:Get*,
ec2:RunInstances,
elasticloadbalancing:Describe*,
iam:CreateServiceLinkedRole,
iam:PassRole,
managed-fleets:Get*,
managed-fleets:RegisterAutoScalingGroup,
managed-fleets:DeregisterAutoScalingGroup,
managed-fleets:UpdateAutoScalingGroup,
ssm:Get*,
vpc-lattice:DeregisterTargets,
vpc-lattice:GetTargetGroup,
vpc-lattice:ListTargets,
vpc-lattice:RegisterTargets

autoscaling:Describe*

autoscaling:DeleteAutoScalingGroup,
autoscaling:UpdateAutoScalingGroup,
autoscaling:Describe*,
managed-fleets:Get*,
managed-fleets:DeleteAutoScalingGroup

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

UPDATE example​

DELETE example​

Additional Parameters​

Permissions​