This product is not supported for your selected Datadog site. ().
이 페이지는 아직 영어로 제공되지 않습니다. 번역 작업 중입니다.
현재 번역 프로젝트에 대한 질문이나 피드백이 있으신 경우 언제든지 연락주시기 바랍니다.

aws_autoscaling_group

account_id

Type: STRING

auto_scaling_group_arn

Type: STRING
Provider name: AutoScalingGroupARN
Description: The Amazon Resource Name (ARN) of the Auto Scaling group.

auto_scaling_group_name

Type: STRING
Provider name: AutoScalingGroupName
Description: The name of the Auto Scaling group.

availability_zone_distribution

Type: STRUCT
Provider name: AvailabilityZoneDistribution
Description: The instance capacity distribution across Availability Zones.

  • capacity_distribution_strategy
    Type: STRING
    Provider name: CapacityDistributionStrategy
    Description: If launches fail in an Availability Zone, the following strategies are available. The default is balanced-best-effort.
    • balanced-only - If launches fail in an Availability Zone, Auto Scaling will continue to attempt to launch in the unhealthy zone to preserve a balanced distribution.
    • balanced-best-effort - If launches fail in an Availability Zone, Auto Scaling will attempt to launch in another healthy Availability Zone instead.

availability_zone_impairment_policy

Type: STRUCT
Provider name: AvailabilityZoneImpairmentPolicy
Description: The Availability Zone impairment policy.

  • impaired_zone_health_check_behavior
    Type: STRING
    Provider name: ImpairedZoneHealthCheckBehavior
    Description: Specifies the health check behavior for the impaired Availability Zone in an active zonal shift. If you select Replace unhealthy, instances that appear unhealthy will be replaced in all Availability Zones. If you select Ignore unhealthy, instances will not be replaced in the Availability Zone with the active zonal shift. For more information, see Auto Scaling group zonal shift in the Amazon EC2 Auto Scaling User Guide.
  • zonal_shift_enabled
    Type: BOOLEAN
    Provider name: ZonalShiftEnabled
    Description: If true, enable zonal shift for your Auto Scaling group.

availability_zones

Type: UNORDERED_LIST_STRING
Provider name: AvailabilityZones
Description: One or more Availability Zones for the group.

capacity_rebalance

Type: BOOLEAN
Provider name: CapacityRebalance
Description: Indicates whether Capacity Rebalancing is enabled.

capacity_reservation_specification

Type: STRUCT
Provider name: CapacityReservationSpecification
Description: The capacity reservation specification.

  • capacity_reservation_preference
    Type: STRING
    Provider name: CapacityReservationPreference
    Description: The capacity reservation preference. The following options are available:
    • capacity-reservations-only - Auto Scaling will only launch instances into a Capacity Reservation or Capacity Reservation resource group. If capacity isn’t available, instances will fail to launch.
    • capacity-reservations-first - Auto Scaling will try to launch instances into a Capacity Reservation or Capacity Reservation resource group first. If capacity isn’t available, instances will run in On-Demand capacity.
    • none - Auto Scaling will not launch instances into a Capacity Reservation. Instances will run in On-Demand capacity.
    • default - Auto Scaling uses the Capacity Reservation preference from your launch template or an open Capacity Reservation.
  • capacity_reservation_target
    Type: STRUCT
    Provider name: CapacityReservationTarget
    Description: Describes a target Capacity Reservation or Capacity Reservation resource group.
    • capacity_reservation_ids
      Type: UNORDERED_LIST_STRING
      Provider name: CapacityReservationIds
      Description: The Capacity Reservation IDs to launch instances into.
    • capacity_reservation_resource_group_arns
      Type: UNORDERED_LIST_STRING
      Provider name: CapacityReservationResourceGroupArns
      Description: The resource group ARNs of the Capacity Reservation to launch instances into.

context

Type: STRING
Provider name: Context
Description: Reserved.

created_time

Type: TIMESTAMP
Provider name: CreatedTime
Description: The date and time the group was created.

default_cooldown

Type: INT32
Provider name: DefaultCooldown
Description: The duration of the default cooldown period, in seconds.

default_instance_warmup

Type: INT32
Provider name: DefaultInstanceWarmup
Description: The duration of the default instance warmup, in seconds.

desired_capacity

Type: INT32
Provider name: DesiredCapacity
Description: The desired size of the group.

desired_capacity_type

Type: STRING
Provider name: DesiredCapacityType
Description: The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only.

enabled_metrics

Type: UNORDERED_LIST_STRUCT
Provider name: EnabledMetrics
Description: The metrics enabled for the group.

  • granularity
    Type: STRING
    Provider name: Granularity
    Description: The granularity of the metric. The only valid value is 1Minute.
  • metric
    Type: STRING
    Provider name: Metric
    Description: One of the following metrics:
    • GroupMinSize
    • GroupMaxSize
    • GroupDesiredCapacity
    • GroupInServiceInstances
    • GroupPendingInstances
    • GroupStandbyInstances
    • GroupTerminatingInstances
    • GroupTotalInstances
    • GroupInServiceCapacity
    • GroupPendingCapacity
    • GroupStandbyCapacity
    • GroupTerminatingCapacity
    • GroupTotalCapacity
    • WarmPoolDesiredCapacity
    • WarmPoolWarmedCapacity
    • WarmPoolPendingCapacity
    • WarmPoolTerminatingCapacity
    • WarmPoolTotalCapacity
    • GroupAndWarmPoolDesiredCapacity
    • GroupAndWarmPoolTotalCapacity
    For more information, see Amazon CloudWatch metrics for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

health_check_grace_period

Type: INT32
Provider name: HealthCheckGracePeriod
Description: The duration of the health check grace period, in seconds.

health_check_type

Type: STRING
Provider name: HealthCheckType
Description: A comma-separated value string of one or more health check types.

instance_maintenance_policy

Type: STRUCT
Provider name: InstanceMaintenancePolicy
Description: An instance maintenance policy.

  • max_healthy_percentage
    Type: INT32
    Provider name: MaxHealthyPercentage
    Description: Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of -1. Both MinHealthyPercentage and MaxHealthyPercentage must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time.
  • min_healthy_percentage
    Type: INT32
    Provider name: MinHealthyPercentage
    Description: Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of -1.

instances

Type: UNORDERED_LIST_STRUCT
Provider name: Instances
Description: The instances that are currently in the warm pool.

  • availability_zone
    Type: STRING
    Provider name: AvailabilityZone
    Description: The Availability Zone in which the instance is running.
  • health_status
    Type: STRING
    Provider name: HealthStatus
    Description: The last reported health status of the instance. Healthy means that the instance is healthy and should remain in service. Unhealthy means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.
  • instance_id
    Type: STRING
    Provider name: InstanceId
    Description: The ID of the instance.
  • instance_type
    Type: STRING
    Provider name: InstanceType
    Description: The instance type of the EC2 instance.
  • launch_configuration_name
    Type: STRING
    Provider name: LaunchConfigurationName
    Description: The launch configuration associated with the instance.
  • launch_template
    Type: STRUCT
    Provider name: LaunchTemplate
    Description: The launch template for the instance.
    • launch_template_id
      Type: STRING
      Provider name: LaunchTemplateId
      Description: The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API. Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
    • launch_template_name
      Type: STRING
      Provider name: LaunchTemplateName
      Description: The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API. Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
    • version
      Type: STRING
      Provider name: Version
      Description: The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.
  • lifecycle_state
    Type: STRING
    Provider name: LifecycleState
    Description: A description of the current lifecycle state. The Quarantined state is not used. For more information, see Amazon EC2 Auto Scaling instance lifecycle in the Amazon EC2 Auto Scaling User Guide.
  • protected_from_scale_in
    Type: BOOLEAN
    Provider name: ProtectedFromScaleIn
    Description: Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
  • weighted_capacity
    Type: STRING
    Provider name: WeightedCapacity
    Description: The number of capacity units contributed by the instance based on its instance type. Valid Range: Minimum value of 1. Maximum value of 999.

launch_configuration_name

Type: STRING
Provider name: LaunchConfigurationName
Description: The name of the associated launch configuration.

launch_template

Type: STRUCT
Provider name: LaunchTemplate
Description: The launch template for the group.

  • launch_template_id
    Type: STRING
    Provider name: LaunchTemplateId
    Description: The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API. Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
  • launch_template_name
    Type: STRING
    Provider name: LaunchTemplateName
    Description: The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API. Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
  • version
    Type: STRING
    Provider name: Version
    Description: The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

load_balancer_names

Type: UNORDERED_LIST_STRING
Provider name: LoadBalancerNames
Description: One or more load balancers associated with the group.

max_instance_lifetime

Type: INT32
Provider name: MaxInstanceLifetime
Description: The maximum amount of time, in seconds, that an instance can be in service. Valid Range: Minimum value of 0.

max_size

Type: INT32
Provider name: MaxSize
Description: The maximum size of the group.

min_size

Type: INT32
Provider name: MinSize
Description: The minimum size of the group.

mixed_instances_policy

Type: STRUCT
Provider name: MixedInstancesPolicy
Description: The mixed instances policy for the group.

  • instances_distribution
    Type: STRUCT
    Provider name: InstancesDistribution
    Description: The instances distribution.
    • on_demand_allocation_strategy
      Type: STRING
      Provider name: OnDemandAllocationStrategy
      Description: The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify. The following lists the valid values:
      lowest-price
      Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements.
      prioritized
      You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don’t specify InstanceRequirements and cannot be used for groups that do.

    • on_demand_base_capacity
      Type: INT32
      Provider name: OnDemandBaseCapacity
      Description: The minimum amount of the Auto Scaling group’s capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales. This number has the same unit of measurement as the group’s desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.
      Default: 0
    • on_demand_percentage_above_base_capacity
      Type: INT32
      Provider name: OnDemandPercentageAboveBaseCapacity
      Description: Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.
      Default: 100
    • spot_allocation_strategy
      Type: STRING
      Provider name: SpotAllocationStrategy
      Description: The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify. The following lists the valid values:
      capacity-optimized
      Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized.
      capacity-optimized-prioritized
      You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements.
      lowest-price
      Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity.
      price-capacity-optimized (recommended)
      The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price.

    • spot_instance_pools
      Type: INT32
      Provider name: SpotInstancePools
      Description: The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the SpotAllocationStrategy is lowest-price. Value must be in the range of 1–20.
      Default: 2
    • spot_max_price
      Type: STRING
      Provider name: SpotMaxPrice
      Description: The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ("") for the value. If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one. Valid Range: Minimum value of 0.001
  • launch_template
    Type: STRUCT
    Provider name: LaunchTemplate
    Description: One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.
    • launch_template_specification
      Type: STRUCT
      Provider name: LaunchTemplateSpecification
      Description: The launch template.
      • launch_template_id
        Type: STRING
        Provider name: LaunchTemplateId
        Description: The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API. Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
      • launch_template_name
        Type: STRING
        Provider name: LaunchTemplateName
        Description: The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API. Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
      • version
        Type: STRING
        Provider name: Version
        Description: The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.
    • overrides
      Type: UNORDERED_LIST_STRUCT
      Provider name: Overrides
      Description: Any properties that you specify override the same properties in the launch template.
      • instance_requirements
        Type: STRUCT
        Provider name: InstanceRequirements
        Description: The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template. If you specify InstanceRequirements, you can’t specify InstanceType.
        • accelerator_count
          Type: STRUCT
          Provider name: AcceleratorCount
          Description: The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) for an instance type. To exclude accelerator-enabled instance types, set Max to 0.
          Default: No minimum or maximum limits
          • max
            Type: INT32
            Provider name: Max
            Description: The maximum value.
          • min
            Type: INT32
            Provider name: Min
            Description: The minimum value.
        • accelerator_manufacturers
          Type: UNORDERED_LIST_STRING
          Provider name: AcceleratorManufacturers
          Description: Indicates whether instance types must have accelerators by specific manufacturers.
          • For instance types with NVIDIA devices, specify nvidia.
          • For instance types with AMD devices, specify amd.
          • For instance types with Amazon Web Services devices, specify amazon-web-services.
          • For instance types with Xilinx devices, specify xilinx.
          Default: Any manufacturer
        • accelerator_names
          Type: UNORDERED_LIST_STRING
          Provider name: AcceleratorNames
          Description: Lists the accelerators that must be on an instance type.
          • For instance types with NVIDIA A100 GPUs, specify a100.
          • For instance types with NVIDIA V100 GPUs, specify v100.
          • For instance types with NVIDIA K80 GPUs, specify k80.
          • For instance types with NVIDIA T4 GPUs, specify t4.
          • For instance types with NVIDIA M60 GPUs, specify m60.
          • For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
          • For instance types with Xilinx VU9P FPGAs, specify vu9p.
          Default: Any accelerator
        • accelerator_total_memory_mib
          Type: STRUCT
          Provider name: AcceleratorTotalMemoryMiB
          Description: The minimum and maximum total memory size for the accelerators on an instance type, in MiB.
          Default: No minimum or maximum limits
          • max
            Type: INT32
            Provider name: Max
            Description: The memory maximum in MiB.
          • min
            Type: INT32
            Provider name: Min
            Description: The memory minimum in MiB.
        • accelerator_types
          Type: UNORDERED_LIST_STRING
          Provider name: AcceleratorTypes
          Description: Lists the accelerator types that must be on an instance type.
          • For instance types with GPU accelerators, specify gpu.
          • For instance types with FPGA accelerators, specify fpga.
          • For instance types with inference accelerators, specify inference.
          Default: Any accelerator type
        • allowed_instance_types
          Type: UNORDERED_LIST_STRING
          Provider name: AllowedInstanceTypes
          Description: The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk (), to allow an instance type, size, or generation. The following are examples: m5.8xlarge, c5., m5a., r*, 3. For example, if you specify c5*, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types. If you specify AllowedInstanceTypes, you can’t specify ExcludedInstanceTypes.
          Default: All instance types
        • bare_metal
          Type: STRING
          Provider name: BareMetal
          Description: Indicates whether bare metal instance types are included, excluded, or required.
          Default: excluded
        • baseline_ebs_bandwidth_mbps
          Type: STRUCT
          Provider name: BaselineEbsBandwidthMbps
          Description: The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide for Linux Instances.
          Default: No minimum or maximum limits
          • max
            Type: INT32
            Provider name: Max
            Description: The maximum value in Mbps.
          • min
            Type: INT32
            Provider name: Min
            Description: The minimum value in Mbps.
        • baseline_performance_factors
          Type: STRUCT
          Provider name: BaselinePerformanceFactors
          Description: The baseline performance factors for the instance requirements.
          • cpu
            Type: STRUCT
            Provider name: Cpu
            Description: The CPU performance to consider, using an instance family as the baseline reference.
            • references
              Type: UNORDERED_LIST_STRUCT
              Provider name: References
              Description: Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Currently only one instance family can be specified in the list.
              • instance_family
                Type: STRING
                Provider name: InstanceFamily
                Description: The instance family to use as a baseline reference. Make sure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance c6i.large, the instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types. The following instance types are not supported for performance protection.
                • c1
                • g3| g3s
                • hpc7g
                • m1| m2
                • mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro
                • p3dn | p4d | p5
                • t1
                • u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb
                If you performance protection by specifying a supported instance family, the returned instance types will exclude the preceding unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response.
        • burstable_performance
          Type: STRING
          Provider name: BurstablePerformance
          Description: Indicates whether burstable performance instance types are included, excluded, or required. For more information, see Burstable performance instances in the Amazon EC2 User Guide for Linux Instances.
          Default: excluded
        • cpu_manufacturers
          Type: UNORDERED_LIST_STRING
          Provider name: CpuManufacturers
          Description: Lists which specific CPU manufacturers to include.
          • For instance types with Intel CPUs, specify intel.
          • For instance types with AMD CPUs, specify amd.
          • For instance types with Amazon Web Services CPUs, specify amazon-web-services.
          Don’t confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
          Default: Any manufacturer
        • excluded_instance_types
          Type: UNORDERED_LIST_STRING
          Provider name: ExcludedInstanceTypes
          Description: The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5., m5a., r*, 3. For example, if you specify c5*, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types. If you specify ExcludedInstanceTypes, you can’t specify AllowedInstanceTypes.
          Default: No excluded instance types
        • instance_generations
          Type: UNORDERED_LIST_STRING
          Provider name: InstanceGenerations
          Description: Indicates whether current or previous generation instance types are included.
          • For current generation instance types, specify current. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide for Linux Instances.
          • For previous generation instance types, specify previous.
          Default: Any current or previous generation
        • local_storage
          Type: STRING
          Provider name: LocalStorage
          Description: Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide for Linux Instances.
          Default: included
        • local_storage_types
          Type: UNORDERED_LIST_STRING
          Provider name: LocalStorageTypes
          Description: Indicates the type of local storage that is required.
          • For instance types with hard disk drive (HDD) storage, specify hdd.
          • For instance types with solid state drive (SSD) storage, specify ssd.
          Default: Any local storage type
        • max_spot_price_as_percentage_of_optimal_on_demand_price
          Type: INT32
          Provider name: MaxSpotPriceAsPercentageOfOptimalOnDemandPrice
          Description: [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don’t specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
        • memory_gib_per_v_cpu
          Type: STRUCT
          Provider name: MemoryGiBPerVCpu
          Description: The minimum and maximum amount of memory per vCPU for an instance type, in GiB.
          Default: No minimum or maximum limits
          • max
            Type: DOUBLE
            Provider name: Max
            Description: The memory maximum in GiB.
          • min
            Type: DOUBLE
            Provider name: Min
            Description: The memory minimum in GiB.
        • memory_mib
          Type: STRUCT
          Provider name: MemoryMiB
          Description: The minimum and maximum instance memory size for an instance type, in MiB.
          • max
            Type: INT32
            Provider name: Max
            Description: The memory maximum in MiB.
          • min
            Type: INT32
            Provider name: Min
            Description: The memory minimum in MiB.
        • network_bandwidth_gbps
          Type: STRUCT
          Provider name: NetworkBandwidthGbps
          Description: The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
          Default: No minimum or maximum limits
          • max
            Type: DOUBLE
            Provider name: Max
            Description: The maximum amount of network bandwidth, in gigabits per second (Gbps).
          • min
            Type: DOUBLE
            Provider name: Min
            Description: The minimum amount of network bandwidth, in gigabits per second (Gbps).
        • network_interface_count
          Type: STRUCT
          Provider name: NetworkInterfaceCount
          Description: The minimum and maximum number of network interfaces for an instance type.
          Default: No minimum or maximum limits
          • max
            Type: INT32
            Provider name: Max
            Description: The maximum number of network interfaces.
          • min
            Type: INT32
            Provider name: Min
            Description: The minimum number of network interfaces.
        • on_demand_max_price_percentage_over_lowest_price
          Type: INT32
          Provider name: OnDemandMaxPricePercentageOverLowestPrice
          Description: [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999. If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price.
          Default: 20
        • require_hibernate_support
          Type: BOOLEAN
          Provider name: RequireHibernateSupport
          Description: Indicates whether instance types must provide On-Demand Instance hibernation support.
          Default: false
        • spot_max_price_percentage_over_lowest_price
          Type: INT32
          Provider name: SpotMaxPricePercentageOverLowestPrice
          Description: [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don’t specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
        • total_local_storage_gb
          Type: STRUCT
          Provider name: TotalLocalStorageGB
          Description: The minimum and maximum total local storage size for an instance type, in GB.
          Default: No minimum or maximum limits
          • max
            Type: DOUBLE
            Provider name: Max
            Description: The storage maximum in GB.
          • min
            Type: DOUBLE
            Provider name: Min
            Description: The storage minimum in GB.
        • v_cpu_count
          Type: STRUCT
          Provider name: VCpuCount
          Description: The minimum and maximum number of vCPUs for an instance type.
          • max
            Type: INT32
            Provider name: Max
            Description: The maximum number of vCPUs.
          • min
            Type: INT32
            Provider name: Min
            Description: The minimum number of vCPUs.
      • instance_type
        Type: STRING
        Provider name: InstanceType
        Description: The instance type, such as m3.xlarge. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see Instance types in the Amazon EC2 User Guide for Linux Instances. You can specify up to 40 instance types per Auto Scaling group.
      • launch_template_specification
        Type: STRUCT
        Provider name: LaunchTemplateSpecification
        Description: Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that’s specified in the LaunchTemplate definition. For more information, see Specifying a different launch template for an instance type in the Amazon EC2 Auto Scaling User Guide. You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the LaunchTemplate definition count towards this limit.
        • launch_template_id
          Type: STRING
          Provider name: LaunchTemplateId
          Description: The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API. Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
        • launch_template_name
          Type: STRING
          Provider name: LaunchTemplateName
          Description: The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API. Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
        • version
          Type: STRING
          Provider name: Version
          Description: The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.
      • weighted_capacity
        Type: STRING
        Provider name: WeightedCapacity
        Description: If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a WeightedCapacity of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see Configure an Auto Scaling group to use instance weights in the Amazon EC2 Auto Scaling User Guide. Value must be in the range of 1–999. If you specify a value for WeightedCapacity for one instance type, you must specify a value for WeightedCapacity for all of them. Every Auto Scaling group has three size parameters (DesiredCapacity, MaxSize, and MinSize). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.

new_instances_protected_from_scale_in

Type: BOOLEAN
Provider name: NewInstancesProtectedFromScaleIn
Description: Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

placement_group

Type: STRING
Provider name: PlacementGroup
Description: The name of the placement group into which to launch your instances, if any.

predicted_capacity

Type: INT32
Provider name: PredictedCapacity
Description: The predicted capacity of the group when it has a predictive scaling policy.

service_linked_role_arn

Type: STRING
Provider name: ServiceLinkedRoleARN
Description: The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf.

status

Type: STRING
Provider name: Status
Description: The current state of the group when the DeleteAutoScalingGroup operation is in progress.

suspended_processes

Type: UNORDERED_LIST_STRUCT
Provider name: SuspendedProcesses
Description: The suspended processes associated with the group.

  • process_name
    Type: STRING
    Provider name: ProcessName
    Description: The name of the suspended process.
  • suspension_reason
    Type: STRING
    Provider name: SuspensionReason
    Description: The reason that the process was suspended.

tags

Type: UNORDERED_LIST_STRING

target_group_arns

Type: UNORDERED_LIST_STRING
Provider name: TargetGroupARNs
Description: The Amazon Resource Names (ARN) of the target groups for your load balancer.

termination_policies

Type: UNORDERED_LIST_STRING
Provider name: TerminationPolicies
Description: The termination policies for the group.

traffic_sources

Type: UNORDERED_LIST_STRUCT
Provider name: TrafficSources
Description: The traffic sources associated with this Auto Scaling group.

  • identifier
    Type: STRING
    Provider name: Identifier
    Description: Identifies the traffic source. For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name of the Classic Load Balancer in this account and Region. For example:
    • Application Load Balancer ARN: arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456
    • Classic Load Balancer name: my-classic-load-balancer
    • VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456
    To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations. To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.
  • type
    Type: STRING
    Provider name: Type
    Description: Provides additional context for the value of Identifier. The following lists the valid values:
    • elb if Identifier is the name of a Classic Load Balancer.
    • elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group.
    • vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
    Required if the identifier is the name of a Classic Load Balancer.

vpc_zone_identifier

Type: STRING
Provider name: VPCZoneIdentifier
Description: One or more subnet IDs, if applicable, separated by commas.

warm_pool_configuration

Type: STRUCT
Provider name: WarmPoolConfiguration
Description: The warm pool configuration details.

  • instance_reuse_policy
    Type: STRUCT
    Provider name: InstanceReusePolicy
    Description: The instance reuse policy.
    • reuse_on_scale_in
      Type: BOOLEAN
      Provider name: ReuseOnScaleIn
      Description: Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in.
  • max_group_prepared_capacity
    Type: INT32
    Provider name: MaxGroupPreparedCapacity
    Description: The maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group.
  • min_size
    Type: INT32
    Provider name: MinSize
    Description: The minimum number of instances to maintain in the warm pool.
  • pool_state
    Type: STRING
    Provider name: PoolState
    Description: The instance state to transition to after the lifecycle actions are complete.
  • status
    Type: STRING
    Provider name: Status
    Description: The status of a warm pool that is marked for deletion.

warm_pool_size

Type: INT32
Provider name: WarmPoolSize
Description: The current size of the warm pool.