_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
instance_refreshes
The instance refreshes for the specified group, sorted by creation timestamp in descending order. | STRUCT(
"instance_refresh_id" VARCHAR,
"auto_scaling_group_name" VARCHAR,
"status" VARCHAR,
"status_reason" VARCHAR,
"start_time" TIMESTAMP_S,
"end_time" TIMESTAMP_S,
"percentage_complete" BIGINT,
"instances_to_update" BIGINT,
"progress_details" STRUCT(
"live_pool_progress" STRUCT(
"percentage_complete" BIGINT,
"instances_to_update" BIGINT
),
"warm_pool_progress" STRUCT(
"percentage_complete" BIGINT,
"instances_to_update" BIGINT
)
),
"preferences" STRUCT(
"min_healthy_percentage" BIGINT,
"instance_warmup" BIGINT,
"checkpoint_percentages" BIGINT[],
"checkpoint_delay" BIGINT,
"skip_matching" BOOLEAN,
"auto_rollback" BOOLEAN,
"scale_in_protected_instances" VARCHAR,
"standby_instances" VARCHAR,
"alarm_specification" STRUCT(
"alarms" VARCHAR[]
),
"max_healthy_percentage" BIGINT
),
"desired_configuration" STRUCT(
"launch_template" STRUCT(
"launch_template_id" VARCHAR,
"launch_template_name" VARCHAR,
"version" VARCHAR
),
"mixed_instances_policy" STRUCT(
"launch_template" STRUCT(
"launch_template_specification" STRUCT(
"launch_template_id" VARCHAR,
"launch_template_name" VARCHAR,
"version" VARCHAR
),
"overrides" STRUCT(
"instance_type" VARCHAR,
"weighted_capacity" VARCHAR,
"launch_template_specification" STRUCT(
"launch_template_id" VARCHAR,
"launch_template_name" VARCHAR,
"version" VARCHAR
),
"instance_requirements" STRUCT(
"v_cpu_count" STRUCT(
"min" BIGINT,
"max" BIGINT
),
"memory_mi_b" STRUCT(
"min" BIGINT,
"max" BIGINT
),
"cpu_manufacturers" VARCHAR[],
"memory_gi_b_per_v_cpu" STRUCT(
"min" DOUBLE,
"max" DOUBLE
),
"excluded_instance_types" VARCHAR[],
"instance_generations" VARCHAR[],
"spot_max_price_percentage_over_lowest_price" BIGINT,
"max_spot_price_as_percentage_of_optimal_on_demand_price" BIGINT,
"on_demand_max_price_percentage_over_lowest_price" BIGINT,
"bare_metal" VARCHAR,
"burstable_performance" VARCHAR,
"require_hibernate_support" BOOLEAN,
"network_interface_count" STRUCT(
"min" BIGINT,
"max" BIGINT
),
"local_storage" VARCHAR,
"local_storage_types" VARCHAR[],
"total_local_storage_gb" STRUCT(
"min" DOUBLE,
"max" DOUBLE
),
"baseline_ebs_bandwidth_mbps" STRUCT(
"min" BIGINT,
"max" BIGINT
),
"accelerator_types" VARCHAR[],
"accelerator_count" STRUCT(
"min" BIGINT,
"max" BIGINT
),
"accelerator_manufacturers" VARCHAR[],
"accelerator_names" VARCHAR[],
"accelerator_total_memory_mi_b" STRUCT(
"min" BIGINT,
"max" BIGINT
),
"network_bandwidth_gbps" STRUCT(
"min" DOUBLE,
"max" DOUBLE
),
"allowed_instance_types" VARCHAR[]
)
)[]
),
"instances_distribution" STRUCT(
"on_demand_allocation_strategy" VARCHAR,
"on_demand_base_capacity" BIGINT,
"on_demand_percentage_above_base_capacity" BIGINT,
"spot_allocation_strategy" VARCHAR,
"spot_instance_pools" BIGINT,
"spot_max_price" VARCHAR
)
)
),
"rollback_details" STRUCT(
"rollback_reason" VARCHAR,
"rollback_start_time" TIMESTAMP_S,
"percentage_complete_on_rollback" BIGINT,
"instances_to_update_on_rollback" BIGINT,
"progress_details_on_rollback" STRUCT(
"live_pool_progress" STRUCT(
"percentage_complete" BIGINT,
"instances_to_update" BIGINT
),
"warm_pool_progress" STRUCT(
"percentage_complete" BIGINT,
"instances_to_update" BIGINT
)
)
)
)[] |
Show child fields- instance_refreshes[]
Show child fields- instance_refreshes[].auto_scaling_group_name
The name of the Auto Scaling group. - instance_refreshes[].desired_configuration
Describes the desired configuration for the instance refresh. Show child fields- instance_refreshes[].desired_configuration.launch_template
Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information about launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide. Show child fields- instance_refreshes[].desired_configuration.launch_template.launch_template_id
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. - instance_refreshes[].desired_configuration.launch_template.launch_template_name
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. - instance_refreshes[].desired_configuration.launch_template.version
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.
- instance_refreshes[].desired_configuration.mixed_instances_policy
Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group. A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide. Show child fields- instance_refreshes[].desired_configuration.mixed_instances_policy.instances_distribution
The instances distribution. Show child fields- instance_refreshes[].desired_configuration.mixed_instances_policy.instances_distribution.on_demand_allocation_strategy
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. - instance_refreshes[].desired_configuration.mixed_instances_policy.instances_distribution.on_demand_base_capacity
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 - instance_refreshes[].desired_configuration.mixed_instances_policy.instances_distribution.on_demand_percentage_above_base_capacity
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 - instance_refreshes[].desired_configuration.mixed_instances_policy.instances_distribution.spot_allocation_strategy
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. - instance_refreshes[].desired_configuration.mixed_instances_policy.instances_distribution.spot_instance_pools
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 - instance_refreshes[].desired_configuration.mixed_instances_policy.instances_distribution.spot_max_price
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
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template
One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities. Show child fields- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.launch_template_specification
The launch template. Show child fields- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.launch_template_specification.launch_template_id
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. - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.launch_template_specification.launch_template_name
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. - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.launch_template_specification.version
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.
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[]
Show child fields- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements
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. Show child fields- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.accelerator_count
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 Show child fields- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.accelerator_count.max
The maximum value. - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.accelerator_count.min
The minimum value.
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.accelerator_manufacturers[]
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.accelerator_names[]
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.accelerator_total_memory_mi_b
The minimum and maximum total memory size for the accelerators on an instance type, in MiB. Default: No minimum or maximum limits Show child fields- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.accelerator_total_memory_mi_b.max
The memory maximum in MiB. - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.accelerator_total_memory_mi_b.min
The memory minimum in MiB.
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.accelerator_types[]
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.allowed_instance_types[]
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.bare_metal
Indicates whether bare metal instance types are included, excluded, or required. Default: excluded - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.baseline_ebs_bandwidth_mbps
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 Show child fields- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.baseline_ebs_bandwidth_mbps.max
The maximum value in Mbps. - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.baseline_ebs_bandwidth_mbps.min
The minimum value in Mbps.
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.burstable_performance
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 - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.cpu_manufacturers[]
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.excluded_instance_types[]
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.instance_generations[]
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.local_storage
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 - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.local_storage_types[]
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.max_spot_price_as_percentage_of_optimal_on_demand_price
[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. - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.memory_gi_b_per_v_cpu
The minimum and maximum amount of memory per vCPU for an instance type, in GiB. Default: No minimum or maximum limits Show child fields- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.memory_gi_b_per_v_cpu.max
The memory maximum in GiB. - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.memory_gi_b_per_v_cpu.min
The memory minimum in GiB.
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.memory_mi_b
The minimum and maximum instance memory size for an instance type, in MiB. Show child fields- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.memory_mi_b.max
The memory maximum in MiB. - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.memory_mi_b.min
The memory minimum in MiB.
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.network_bandwidth_gbps
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits Show child fields- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.network_bandwidth_gbps.max
The maximum amount of network bandwidth, in gigabits per second (Gbps). - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.network_bandwidth_gbps.min
The minimum amount of network bandwidth, in gigabits per second (Gbps).
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.network_interface_count
The minimum and maximum number of network interfaces for an instance type. Default: No minimum or maximum limits Show child fields- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.network_interface_count.max
The maximum number of network interfaces. - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.network_interface_count.min
The minimum number of network interfaces.
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.on_demand_max_price_percentage_over_lowest_price
[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 - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.require_hibernate_support
Indicates whether instance types must provide On-Demand Instance hibernation support. Default: false - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.spot_max_price_percentage_over_lowest_price
[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. - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.total_local_storage_gb
The minimum and maximum total local storage size for an instance type, in GB. Default: No minimum or maximum limits Show child fields- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.total_local_storage_gb.max
The storage maximum in GB. - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.total_local_storage_gb.min
The storage minimum in GB.
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.v_cpu_count
The minimum and maximum number of vCPUs for an instance type. Show child fields- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.v_cpu_count.max
The maximum number of vCPUs. - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_requirements.v_cpu_count.min
The minimum number of vCPUs.
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].instance_type
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. - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].launch_template_specification
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. Show child fields- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].launch_template_specification.launch_template_id
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. - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].launch_template_specification.launch_template_name
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. - instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].launch_template_specification.version
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.
- instance_refreshes[].desired_configuration.mixed_instances_policy.launch_template.overrides[].weighted_capacity
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.
- instance_refreshes[].end_time
The date and time at which the instance refresh ended. - instance_refreshes[].instance_refresh_id
The instance refresh ID. - instance_refreshes[].instances_to_update
The number of instances remaining to update before the instance refresh is complete. If you roll back the instance refresh, InstancesToUpdate shows you the number of instances that were not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the rollback. - instance_refreshes[].percentage_complete
The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete. PercentageComplete does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback. - instance_refreshes[].preferences
The preferences for an instance refresh. Show child fields- instance_refreshes[].preferences.alarm_specification
(Optional) The CloudWatch alarm specification. CloudWatch alarms can be used to identify any issues and fail the operation if an alarm threshold is met. Show child fields- instance_refreshes[].preferences.alarm_specification.alarms[]
- instance_refreshes[].preferences.auto_rollback
(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration if the instance refresh fails or a CloudWatch alarm threshold is met. The default is false. A rollback is not supported in the following situations: -
There is no desired configuration specified for the instance refresh. -
The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the ImageId property. -
The Auto Scaling group uses the launch template's $Latest or $Default version. For more information, see Undo changes with a rollback in the Amazon EC2 Auto Scaling User Guide. - instance_refreshes[].preferences.checkpoint_delay
(Optional) The amount of time, in seconds, to wait after a checkpoint before continuing. This property is optional, but if you specify a value for it, you must also specify a value for CheckpointPercentages. If you specify a value for CheckpointPercentages and not for CheckpointDelay, the CheckpointDelay defaults to 3600 (1 hour). - instance_refreshes[].preferences.checkpoint_percentages[]
- instance_refreshes[].preferences.instance_warmup
A time period, in seconds, during which an instance refresh waits before moving on to replacing the next instance after a new instance enters the InService state. This property is not required for normal usage. Instead, use the DefaultInstanceWarmup property of the Auto Scaling group. The InstanceWarmup and DefaultInstanceWarmup properties work the same way. Only specify this property if you must override the DefaultInstanceWarmup property. If you do not specify this property, the instance warmup by default is the value of the DefaultInstanceWarmup property, if defined (which is recommended in all cases), or the HealthCheckGracePeriod property otherwise. - instance_refreshes[].preferences.max_healthy_percentage
Specifies the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 100 to 200. If you specify MaxHealthyPercentage, you must also specify MinHealthyPercentage, and the difference between them cannot be greater than 100. A larger range increases the number of instances that can be replaced at the same time. If you do not specify this property, the default is 100 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined. - instance_refreshes[].preferences.min_healthy_percentage
Specifies the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 0 to 100. If you do not specify this property, the default is 90 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined. - instance_refreshes[].preferences.scale_in_protected_instances
Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in are found. The following lists the valid values: - Refresh
-
Amazon EC2 Auto Scaling replaces instances that are protected from scale in. - Ignore
-
Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected. - Wait (default)
-
Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail. - instance_refreshes[].preferences.skip_matching
(Optional) Indicates whether skip matching is enabled. If enabled (true), then Amazon EC2 Auto Scaling skips replacing instances that match the desired configuration. If no desired configuration is specified, then it skips replacing instances that have the same launch template and instance types that the Auto Scaling group was using before the start of the instance refresh. The default is false. For more information, see Use an instance refresh with skip matching in the Amazon EC2 Auto Scaling User Guide. - instance_refreshes[].preferences.standby_instances
Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in Standby state are found. The following lists the valid values: - Terminate
-
Amazon EC2 Auto Scaling terminates instances that are in Standby. - Ignore
-
Amazon EC2 Auto Scaling ignores instances that are in Standby and continues to replace instances that are in the InService state. - Wait (default)
-
Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.
- instance_refreshes[].progress_details
Additional progress details for an Auto Scaling group that has a warm pool. Show child fields- instance_refreshes[].progress_details.live_pool_progress
Reports progress on replacing instances that are in the Auto Scaling group. Show child fields- instance_refreshes[].progress_details.live_pool_progress.instances_to_update
The number of instances remaining to update. - instance_refreshes[].progress_details.live_pool_progress.percentage_complete
The percentage of instances in the Auto Scaling group that have been replaced. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
- instance_refreshes[].progress_details.warm_pool_progress
Reports progress on replacing instances that are in the warm pool. Show child fields- instance_refreshes[].progress_details.warm_pool_progress.instances_to_update
The number of instances remaining to update. - instance_refreshes[].progress_details.warm_pool_progress.percentage_complete
The percentage of instances in the warm pool that have been replaced. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
- instance_refreshes[].rollback_details
The rollback details. Show child fields- instance_refreshes[].rollback_details.instances_to_update_on_rollback
Indicates the value of InstancesToUpdate at the time the rollback started. - instance_refreshes[].rollback_details.percentage_complete_on_rollback
Indicates the value of PercentageComplete at the time the rollback started. - instance_refreshes[].rollback_details.progress_details_on_rollback
Reports progress on replacing instances in an Auto Scaling group that has a warm pool. This includes separate details for instances in the warm pool and instances in the Auto Scaling group (the live pool). Show child fields- instance_refreshes[].rollback_details.progress_details_on_rollback.live_pool_progress
Reports progress on replacing instances that are in the Auto Scaling group. Show child fields- instance_refreshes[].rollback_details.progress_details_on_rollback.live_pool_progress.instances_to_update
The number of instances remaining to update. - instance_refreshes[].rollback_details.progress_details_on_rollback.live_pool_progress.percentage_complete
The percentage of instances in the Auto Scaling group that have been replaced. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
- instance_refreshes[].rollback_details.progress_details_on_rollback.warm_pool_progress
Reports progress on replacing instances that are in the warm pool. Show child fields- instance_refreshes[].rollback_details.progress_details_on_rollback.warm_pool_progress.instances_to_update
The number of instances remaining to update. - instance_refreshes[].rollback_details.progress_details_on_rollback.warm_pool_progress.percentage_complete
The percentage of instances in the warm pool that have been replaced. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
- instance_refreshes[].rollback_details.rollback_reason
The reason for this instance refresh rollback (for example, whether a manual or automatic rollback was initiated). - instance_refreshes[].rollback_details.rollback_start_time
The date and time at which the rollback began.
- instance_refreshes[].start_time
The date and time at which the instance refresh began. - instance_refreshes[].status
The current status for the instance refresh operation: -
Pending - The request was created, but the instance refresh has not started. -
InProgress - An instance refresh is in progress. -
Successful - An instance refresh completed successfully. -
Failed - An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities. -
Cancelling - An ongoing instance refresh is being cancelled. -
Cancelled - The instance refresh is cancelled. -
RollbackInProgress - An instance refresh is being rolled back. -
RollbackFailed - The rollback failed to complete. You can troubleshoot using the status reason and the scaling activities. -
RollbackSuccessful - The rollback completed successfully. - instance_refreshes[].status_reason
The explanation for the specific status assigned to this operation.
|