@awboost/cfn-resource-types 0.1.41 → 0.1.42

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,247 +1,774 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
3
  /**
4
- * Resource Type definition for AWS::AutoScaling::AutoScalingGroup
4
+ * 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.
5
+ For more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling User Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html).
6
+ Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) and [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*.
5
7
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html}
6
8
  */
7
9
  export type AutoScalingAutoScalingGroupProperties = {
10
+ /**
11
+ * The name of the Auto Scaling group. This name must be unique per Region per account.
12
+ The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.
13
+ You cannot use a colon (:) in the name.
14
+ */
8
15
  AutoScalingGroupName?: string;
16
+ /**
17
+ * 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.
18
+ */
9
19
  AvailabilityZones?: string[];
20
+ /**
21
+ * 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](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling User Guide*.
22
+ */
10
23
  CapacityRebalance?: boolean;
24
+ /**
25
+ * Reserved.
26
+ */
11
27
  Context?: string;
28
+ /**
29
+ * *Only needed if you use simple scaling policies.*
30
+ 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](https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the *Amazon EC2 Auto Scaling User Guide*.
31
+ Default: ``300`` seconds
32
+ */
12
33
  Cooldown?: string;
34
+ /**
35
+ * 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.
36
+ 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](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*.
37
+ 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.
38
+ Default: None
39
+ */
13
40
  DefaultInstanceWarmup?: number;
14
41
  /**
15
- * @pattern `^[0-9]+$`
16
- */
42
+ * 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.
43
+ 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.
44
+ 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.
45
+ * @pattern `^[0-9]+$`
46
+ */
17
47
  DesiredCapacity?: string;
48
+ /**
49
+ * 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 [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*.
50
+ By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances.
51
+ Valid values: ``units`` | ``vcpu`` | ``memory-mib``
52
+ */
18
53
  DesiredCapacityType?: string;
54
+ /**
55
+ * 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](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*.
56
+ Default: ``0`` seconds
57
+ */
19
58
  HealthCheckGracePeriod?: number;
59
+ /**
60
+ * A comma-separated value string of one or more health check types.
61
+ The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide*.
62
+ Only specify ``EC2`` if you must clear a value that was previously set.
63
+ */
20
64
  HealthCheckType?: string;
65
+ /**
66
+ * 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](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide*.
67
+ If you specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``LaunchConfigurationName``, don't specify ``InstanceId``.
68
+ */
21
69
  InstanceId?: string;
70
+ /**
71
+ * An instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*.
72
+ */
22
73
  InstanceMaintenancePolicy?: InstanceMaintenancePolicy;
74
+ /**
75
+ * The name of the launch configuration to use to launch instances.
76
+ Required only if you don't specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``InstanceId``.
77
+ */
23
78
  LaunchConfigurationName?: string;
79
+ /**
80
+ * 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](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*.
81
+ If you omit this property, you must specify ``MixedInstancesPolicy``, ``LaunchConfigurationName``, or ``InstanceId``.
82
+ */
24
83
  LaunchTemplate?: LaunchTemplateSpecification;
84
+ /**
85
+ * One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
86
+ */
25
87
  LifecycleHookSpecificationList?: LifecycleHookSpecification[];
88
+ /**
89
+ * 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.
90
+ */
26
91
  LoadBalancerNames?: string[];
27
- MaxInstanceLifetime?: number;
28
92
  /**
29
- * @pattern `^[0-9]+$`
93
+ * 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 [Replacing Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*.
30
94
  */
95
+ MaxInstanceLifetime?: number;
96
+ /**
97
+ * The maximum size of the group.
98
+ 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).
99
+ * @pattern `^[0-9]+$`
100
+ */
31
101
  MaxSize: string;
102
+ /**
103
+ * Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.
104
+ */
32
105
  MetricsCollection?: MetricsCollection[];
33
106
  /**
107
+ * The minimum size of the group.
34
108
  * @pattern `^[0-9]+$`
35
109
  */
36
110
  MinSize: string;
111
+ /**
112
+ * An embedded object that specifies a mixed instances policy.
113
+ 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.
114
+ For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.
115
+ */
37
116
  MixedInstancesPolicy?: MixedInstancesPolicy;
117
+ /**
118
+ * 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 [Using instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*.
119
+ */
38
120
  NewInstancesProtectedFromScaleIn?: boolean;
121
+ /**
122
+ * A structure that specifies an Amazon SNS notification configuration for the ``NotificationConfigurations`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.
123
+ For an example template snippet, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html).
124
+ For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*.
125
+ */
39
126
  NotificationConfiguration?: NotificationConfiguration;
127
+ /**
128
+ * Configures an Auto Scaling group to send notifications when specified events take place.
129
+ */
40
130
  NotificationConfigurations?: NotificationConfiguration[];
131
+ /**
132
+ * The name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*.
133
+ 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.
134
+ */
41
135
  PlacementGroup?: string;
136
+ /**
137
+ * 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](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*.
138
+ */
42
139
  ServiceLinkedRoleARN?: string;
140
+ /**
141
+ * 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](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*.
142
+ */
43
143
  Tags?: TagProperty[];
144
+ /**
145
+ * 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](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.
146
+ */
44
147
  TargetGroupARNs?: string[];
148
+ /**
149
+ * 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 [Work with Amazon EC2 Auto Scaling termination policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*.
150
+ Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias``
151
+ */
45
152
  TerminationPolicies?: string[];
153
+ /**
154
+ * A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.
155
+ 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html).
156
+ 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html).
157
+ 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.
158
+ */
46
159
  VPCZoneIdentifier?: string[];
47
160
  };
48
161
  /**
49
162
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.AcceleratorCountRequest`.
163
+ * ``AcceleratorCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of accelerators for an instance type.
50
164
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-acceleratorcountrequest.html}
51
165
  */
52
166
  export type AcceleratorCountRequest = {
167
+ /**
168
+ * The maximum value.
169
+ */
53
170
  Max?: number;
171
+ /**
172
+ * The minimum value.
173
+ */
54
174
  Min?: number;
55
175
  };
56
176
  /**
57
177
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.AcceleratorTotalMemoryMiBRequest`.
178
+ * ``AcceleratorTotalMemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total memory size for the accelerators for an instance type, in MiB.
58
179
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-acceleratortotalmemorymibrequest.html}
59
180
  */
60
181
  export type AcceleratorTotalMemoryMiBRequest = {
182
+ /**
183
+ * The memory maximum in MiB.
184
+ */
61
185
  Max?: number;
186
+ /**
187
+ * The memory minimum in MiB.
188
+ */
62
189
  Min?: number;
63
190
  };
64
191
  /**
65
192
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.BaselineEbsBandwidthMbpsRequest`.
193
+ * ``BaselineEbsBandwidthMbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum baseline bandwidth performance for an instance type, in Mbps.
66
194
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-baselineebsbandwidthmbpsrequest.html}
67
195
  */
68
196
  export type BaselineEbsBandwidthMbpsRequest = {
197
+ /**
198
+ * The maximum value in Mbps.
199
+ */
69
200
  Max?: number;
201
+ /**
202
+ * The minimum value in Mbps.
203
+ */
70
204
  Min?: number;
71
205
  };
72
206
  /**
73
207
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.InstanceMaintenancePolicy`.
208
+ * ``InstanceMaintenancePolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.
209
+ For more information, see [Instance maintenance policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*.
74
210
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancemaintenancepolicy.html}
75
211
  */
76
212
  export type InstanceMaintenancePolicy = {
213
+ /**
214
+ * 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``.
215
+ 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.
216
+ */
77
217
  MaxHealthyPercentage?: number;
218
+ /**
219
+ * 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``.
220
+ */
78
221
  MinHealthyPercentage?: number;
79
222
  };
80
223
  /**
81
224
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.InstanceRequirements`.
225
+ * The attributes for the instance types for a mixed instances policy. 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.
226
+ When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
227
+ To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you can use one of the following parameters, but not both in the same request:
228
+ + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
229
+ + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.
230
+
231
+ You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.
232
+ For an example template, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html).
233
+ For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see [Preview instance types with specified attributes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements) in the *Amazon EC2 User Guide for Linux Instances*.
234
+ ``InstanceRequirements`` is a property of the ``LaunchTemplateOverrides`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type.
82
235
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancerequirements.html}
83
236
  */
84
237
  export type InstanceRequirements = {
238
+ /**
239
+ * The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.
240
+ To exclude accelerator-enabled instance types, set ``Max`` to ``0``.
241
+ Default: No minimum or maximum limits
242
+ */
85
243
  AcceleratorCount?: AcceleratorCountRequest;
244
+ /**
245
+ * Indicates whether instance types must have accelerators by specific manufacturers.
246
+ + For instance types with NVIDIA devices, specify ``nvidia``.
247
+ + For instance types with AMD devices, specify ``amd``.
248
+ + For instance types with AWS devices, specify ``amazon-web-services``.
249
+ + For instance types with Xilinx devices, specify ``xilinx``.
250
+
251
+ Default: Any manufacturer
252
+ */
86
253
  AcceleratorManufacturers?: string[];
254
+ /**
255
+ * Lists the accelerators that must be on an instance type.
256
+ + For instance types with NVIDIA A100 GPUs, specify ``a100``.
257
+ + For instance types with NVIDIA V100 GPUs, specify ``v100``.
258
+ + For instance types with NVIDIA K80 GPUs, specify ``k80``.
259
+ + For instance types with NVIDIA T4 GPUs, specify ``t4``.
260
+ + For instance types with NVIDIA M60 GPUs, specify ``m60``.
261
+ + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``.
262
+ + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``.
263
+
264
+ Default: Any accelerator
265
+ */
87
266
  AcceleratorNames?: string[];
267
+ /**
268
+ * The minimum and maximum total memory size for the accelerators on an instance type, in MiB.
269
+ Default: No minimum or maximum limits
270
+ */
88
271
  AcceleratorTotalMemoryMiB?: AcceleratorTotalMemoryMiBRequest;
272
+ /**
273
+ * Lists the accelerator types that must be on an instance type.
274
+ + For instance types with GPU accelerators, specify ``gpu``.
275
+ + For instance types with FPGA accelerators, specify ``fpga``.
276
+ + For instance types with inference accelerators, specify ``inference``.
277
+
278
+ Default: Any accelerator type
279
+ */
89
280
  AcceleratorTypes?: string[];
281
+ /**
282
+ * The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
283
+ 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*``.
284
+ 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.
285
+ If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``.
286
+ Default: All instance types
287
+ */
90
288
  AllowedInstanceTypes?: string[];
289
+ /**
290
+ * Indicates whether bare metal instance types are included, excluded, or required.
291
+ Default: ``excluded``
292
+ */
91
293
  BareMetal?: string;
294
+ /**
295
+ * The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide for Linux Instances*.
296
+ Default: No minimum or maximum limits
297
+ */
92
298
  BaselineEbsBandwidthMbps?: BaselineEbsBandwidthMbpsRequest;
299
+ /**
300
+ * Indicates whether burstable performance instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide for Linux Instances*.
301
+ Default: ``excluded``
302
+ */
93
303
  BurstablePerformance?: string;
304
+ /**
305
+ * Lists which specific CPU manufacturers to include.
306
+ + For instance types with Intel CPUs, specify ``intel``.
307
+ + For instance types with AMD CPUs, specify ``amd``.
308
+ + For instance types with AWS CPUs, specify ``amazon-web-services``.
309
+
310
+ 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.
311
+ Default: Any manufacturer
312
+ */
94
313
  CpuManufacturers?: string[];
314
+ /**
315
+ * 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*``.
316
+ 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.
317
+ If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``.
318
+ Default: No excluded instance types
319
+ */
95
320
  ExcludedInstanceTypes?: string[];
321
+ /**
322
+ * Indicates whether current or previous generation instance types are included.
323
+ + 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*.
324
+ + For previous generation instance types, specify ``previous``.
325
+
326
+ Default: Any current or previous generation
327
+ */
96
328
  InstanceGenerations?: string[];
329
+ /**
330
+ * Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide for Linux Instances*.
331
+ Default: ``included``
332
+ */
97
333
  LocalStorage?: string;
334
+ /**
335
+ * Indicates the type of local storage that is required.
336
+ + For instance types with hard disk drive (HDD) storage, specify ``hdd``.
337
+ + For instance types with solid state drive (SSD) storage, specify ``ssd``.
338
+
339
+ Default: Any local storage type
340
+ */
98
341
  LocalStorageTypes?: string[];
342
+ /**
343
+ * [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.
344
+ The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
345
+ To indicate no price protection threshold, specify a high value, such as ``999999``.
346
+ 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.
347
+ Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, then ``SpotMaxPricePercentageOverLowestPrice`` is used and the value for that parameter defaults to ``100``.
348
+ */
99
349
  MaxSpotPriceAsPercentageOfOptimalOnDemandPrice?: number;
350
+ /**
351
+ * The minimum and maximum amount of memory per vCPU for an instance type, in GiB.
352
+ Default: No minimum or maximum limits
353
+ */
100
354
  MemoryGiBPerVCpu?: MemoryGiBPerVCpuRequest;
355
+ /**
356
+ * The minimum and maximum instance memory size for an instance type, in MiB.
357
+ */
101
358
  MemoryMiB: MemoryMiBRequest;
359
+ /**
360
+ * The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
361
+ Default: No minimum or maximum limits
362
+ */
102
363
  NetworkBandwidthGbps?: NetworkBandwidthGbpsRequest;
364
+ /**
365
+ * The minimum and maximum number of network interfaces for an instance type.
366
+ Default: No minimum or maximum limits
367
+ */
103
368
  NetworkInterfaceCount?: NetworkInterfaceCountRequest;
369
+ /**
370
+ * [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.
371
+ The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
372
+ To turn off price protection, specify a high value, such as ``999999``.
373
+ 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.
374
+ Default: ``20``
375
+ */
104
376
  OnDemandMaxPricePercentageOverLowestPrice?: number;
377
+ /**
378
+ * Indicates whether instance types must provide On-Demand Instance hibernation support.
379
+ Default: ``false``
380
+ */
105
381
  RequireHibernateSupport?: boolean;
382
+ /**
383
+ * [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.
384
+ The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
385
+ To turn off price protection, specify a high value, such as ``999999``.
386
+ 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.
387
+ Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified.
388
+ Default: ``100``
389
+ */
106
390
  SpotMaxPricePercentageOverLowestPrice?: number;
391
+ /**
392
+ * The minimum and maximum total local storage size for an instance type, in GB.
393
+ Default: No minimum or maximum limits
394
+ */
107
395
  TotalLocalStorageGB?: TotalLocalStorageGBRequest;
396
+ /**
397
+ * The minimum and maximum number of vCPUs for an instance type.
398
+ */
108
399
  VCpuCount: VCpuCountRequest;
109
400
  };
110
401
  /**
111
402
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.InstancesDistribution`.
403
+ * Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy.
404
+ For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.
405
+ ``InstancesDistribution`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type.
112
406
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-instancesdistribution.html}
113
407
  */
114
408
  export type InstancesDistribution = {
409
+ /**
410
+ * 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.
411
+ The following lists the valid values:
412
+ + 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.
413
+ */
115
414
  OnDemandAllocationStrategy?: string;
415
+ /**
416
+ * 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.
417
+ 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.
418
+ Default: 0
419
+ An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.
420
+ */
116
421
  OnDemandBaseCapacity?: number;
422
+ /**
423
+ * 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.
424
+ Default: 100
425
+ An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.
426
+ */
117
427
  OnDemandPercentageAboveBaseCapacity?: number;
428
+ /**
429
+ * 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.
430
+ The following lists the valid values:
431
+ + 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.
432
+ */
118
433
  SpotAllocationStrategy?: string;
434
+ /**
435
+ * 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.
436
+ Default: 2
437
+ */
119
438
  SpotInstancePools?: number;
439
+ /**
440
+ * 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.
441
+ If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.
442
+ Valid Range: Minimum value of 0.001
443
+ */
120
444
  SpotMaxPrice?: string;
121
445
  };
122
446
  /**
123
447
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.LaunchTemplate`.
448
+ * Use this structure to specify the launch templates and instance types (overrides) for a mixed instances policy.
449
+ ``LaunchTemplate`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type.
124
450
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html}
125
451
  */
126
452
  export type LaunchTemplate = {
453
+ /**
454
+ * The launch template.
455
+ */
127
456
  LaunchTemplateSpecification: LaunchTemplateSpecification;
457
+ /**
458
+ * Any properties that you specify override the same properties in the launch template.
459
+ */
128
460
  Overrides?: LaunchTemplateOverrides[];
129
461
  };
130
462
  /**
131
463
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.LaunchTemplateOverrides`.
464
+ * Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances policy:
465
+ + Override the instance type that is specified in the launch template.
466
+ + Use multiple instance types.
467
+
468
+ Specify the instance types that you want, or define your instance requirements instead and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements. This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when fulfilling Spot and On-Demand capacities. You can view which instance types are matched before you apply the instance requirements to your Auto Scaling group.
469
+ After you define your instance requirements, you don't have to keep updating these settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance requirements of the Auto Scaling group to determine whether a new EC2 instance type can be used.
470
+ ``LaunchTemplateOverrides`` is a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type.
132
471
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html}
133
472
  */
134
473
  export type LaunchTemplateOverrides = {
474
+ /**
475
+ * 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.
476
+ 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.
477
+ If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.
478
+ */
135
479
  InstanceRequirements?: InstanceRequirements;
480
+ /**
481
+ * 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide*.
482
+ You can specify up to 40 instance types per Auto Scaling group.
483
+ */
136
484
  InstanceType?: string;
485
+ /**
486
+ * 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](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html) in the *Amazon EC2 Auto Scaling User Guide*.
487
+ 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.
488
+ */
137
489
  LaunchTemplateSpecification?: LaunchTemplateSpecification;
490
+ /**
491
+ * 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 instance weighting for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html) in the *Amazon EC2 Auto Scaling User Guide*. Value must be in the range of 1-999.
492
+ If you specify a value for ``WeightedCapacity`` for one instance type, you must specify a value for ``WeightedCapacity`` for all of them.
493
+ 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.
494
+ */
138
495
  WeightedCapacity?: string;
139
496
  };
140
497
  /**
141
498
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.LaunchTemplateSpecification`.
499
+ * Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group.
500
+ You must specify the following:
501
+ + The ID or the name of the launch template, but not both.
502
+ + The version of the launch template.
503
+
504
+ ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types.
505
+ For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*.
506
+ For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource.
142
507
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplatespecification.html}
143
508
  */
144
509
  export type LaunchTemplateSpecification = {
510
+ /**
511
+ * The ID of the launch template.
512
+ You must specify the ``LaunchTemplateID`` or the ``LaunchTemplateName``, but not both.
513
+ */
145
514
  LaunchTemplateId?: string;
515
+ /**
516
+ * The name of the launch template.
517
+ You must specify the ``LaunchTemplateName`` or the ``LaunchTemplateID``, but not both.
518
+ */
146
519
  LaunchTemplateName?: string;
520
+ /**
521
+ * The version number of the launch template.
522
+ Specifying ``$Latest`` or ``$Default`` for the template version number is not supported. However, you can specify ``LatestVersionNumber`` or ``DefaultVersionNumber`` using the ``Fn::GetAtt`` intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).
523
+ For an example of using the ``Fn::GetAtt`` function, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource.
524
+ */
147
525
  Version: string;
148
526
  };
149
527
  /**
150
528
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.LifecycleHookSpecification`.
529
+ * ``LifecycleHookSpecification`` specifies a lifecycle hook for the ``LifecycleHookSpecificationList`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. A lifecycle hook specifies actions to perform when Amazon EC2 Auto Scaling launches or terminates instances.
530
+ For more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#aws-resource-as-lifecyclehook--examples) section of the ``AWS::AutoScaling::LifecycleHook`` resource.
151
531
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-lifecyclehookspecification.html}
152
532
  */
153
533
  export type LifecycleHookSpecification = {
534
+ /**
535
+ * The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ``ABANDON``.
536
+ Valid values: ``CONTINUE`` | ``ABANDON``
537
+ */
154
538
  DefaultResult?: string;
539
+ /**
540
+ * The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from ``30`` to ``7200`` seconds. The default value is ``3600`` seconds (1 hour).
541
+ */
155
542
  HeartbeatTimeout?: number;
543
+ /**
544
+ * The name of the lifecycle hook.
545
+ */
156
546
  LifecycleHookName: string;
547
+ /**
548
+ * The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
549
+ + To create a lifecycle hook for scale-out events, specify ``autoscaling:EC2_INSTANCE_LAUNCHING``.
550
+ + To create a lifecycle hook for scale-in events, specify ``autoscaling:EC2_INSTANCE_TERMINATING``.
551
+ */
157
552
  LifecycleTransition: string;
553
+ /**
554
+ * Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
555
+ */
158
556
  NotificationMetadata?: string;
557
+ /**
558
+ * The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.
559
+ */
159
560
  NotificationTargetARN?: string;
561
+ /**
562
+ * The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Configure a notification target for a lifecycle hook](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html#lifecycle-hook-notification-target) in the *Amazon EC2 Auto Scaling User Guide*.
563
+ Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
564
+ */
160
565
  RoleARN?: string;
161
566
  };
162
567
  /**
163
568
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.MemoryGiBPerVCpuRequest`.
569
+ * ``MemoryGiBPerVCpuRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum amount of memory per vCPU for an instance type, in GiB.
164
570
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-memorygibpervcpurequest.html}
165
571
  */
166
572
  export type MemoryGiBPerVCpuRequest = {
573
+ /**
574
+ * The memory maximum in GiB.
575
+ */
167
576
  Max?: number;
577
+ /**
578
+ * The memory minimum in GiB.
579
+ */
168
580
  Min?: number;
169
581
  };
170
582
  /**
171
583
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.MemoryMiBRequest`.
584
+ * ``MemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum instance memory size for an instance type, in MiB.
172
585
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-memorymibrequest.html}
173
586
  */
174
587
  export type MemoryMiBRequest = {
588
+ /**
589
+ * The memory maximum in MiB.
590
+ */
175
591
  Max?: number;
592
+ /**
593
+ * The memory minimum in MiB.
594
+ */
176
595
  Min?: number;
177
596
  };
178
597
  /**
179
598
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.MetricsCollection`.
599
+ * ``MetricsCollection`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource that describes the group metrics that an Amazon EC2 Auto Scaling group sends to Amazon CloudWatch. These metrics describe the group rather than any of its instances.
600
+ For more information, see [Monitor CloudWatch metrics for your Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource.
180
601
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-metricscollection.html}
181
602
  */
182
603
  export type MetricsCollection = {
604
+ /**
605
+ * The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is ``1Minute``.
606
+ */
183
607
  Granularity: string;
608
+ /**
609
+ * Identifies the metrics to enable.
610
+ You can specify one or more of the following metrics:
611
+ + ``GroupMinSize``
612
+ + ``GroupMaxSize``
613
+ + ``GroupDesiredCapacity``
614
+ + ``GroupInServiceInstances``
615
+ + ``GroupPendingInstances``
616
+ + ``GroupStandbyInstances``
617
+ + ``GroupTerminatingInstances``
618
+ + ``GroupTotalInstances``
619
+ + ``GroupInServiceCapacity``
620
+ + ``GroupPendingCapacity``
621
+ + ``GroupStandbyCapacity``
622
+ + ``GroupTerminatingCapacity``
623
+ + ``GroupTotalCapacity``
624
+ + ``WarmPoolDesiredCapacity``
625
+ + ``WarmPoolWarmedCapacity``
626
+ + ``WarmPoolPendingCapacity``
627
+ + ``WarmPoolTerminatingCapacity``
628
+ + ``WarmPoolTotalCapacity``
629
+ + ``GroupAndWarmPoolDesiredCapacity``
630
+ + ``GroupAndWarmPoolTotalCapacity``
631
+
632
+ If you specify ``Granularity`` and don't specify any metrics, all metrics are enabled.
633
+ For more information, see [Auto Scaling group metrics](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics) in the *Amazon EC2 Auto Scaling User Guide*.
634
+ */
184
635
  Metrics?: string[];
185
636
  };
186
637
  /**
187
638
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.MixedInstancesPolicy`.
639
+ * Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.
640
+ 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](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.
641
+ You can create a mixed instances policy for new and existing Auto Scaling groups. You must use a launch template to configure the policy. You cannot use a launch configuration.
642
+ There are key differences between Spot Instances and On-Demand Instances:
643
+ + The price for Spot Instances varies based on demand
644
+ + Amazon EC2 can terminate an individual Spot Instance as the availability of, or price for, Spot Instances changes
645
+
646
+ When a Spot Instance is terminated, Amazon EC2 Auto Scaling group attempts to launch a replacement instance to maintain the desired capacity for the group.
647
+ ``MixedInstancesPolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.
188
648
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html}
189
649
  */
190
650
  export type MixedInstancesPolicy = {
651
+ /**
652
+ * The instances distribution.
653
+ */
191
654
  InstancesDistribution?: InstancesDistribution;
655
+ /**
656
+ * One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.
657
+ */
192
658
  LaunchTemplate: LaunchTemplate;
193
659
  };
194
660
  /**
195
661
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.NetworkBandwidthGbpsRequest`.
662
+ * ``NetworkBandwidthGbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum network bandwidth for an instance type, in Gbps.
663
+ Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide for Linux Instances*.
196
664
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-networkbandwidthgbpsrequest.html}
197
665
  */
198
666
  export type NetworkBandwidthGbpsRequest = {
667
+ /**
668
+ * The maximum amount of network bandwidth, in gigabits per second (Gbps).
669
+ */
199
670
  Max?: number;
671
+ /**
672
+ * The minimum amount of network bandwidth, in gigabits per second (Gbps).
673
+ */
200
674
  Min?: number;
201
675
  };
202
676
  /**
203
677
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.NetworkInterfaceCountRequest`.
678
+ * ``NetworkInterfaceCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of network interfaces for an instance type.
204
679
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-networkinterfacecountrequest.html}
205
680
  */
206
681
  export type NetworkInterfaceCountRequest = {
682
+ /**
683
+ * The maximum number of network interfaces.
684
+ */
207
685
  Max?: number;
686
+ /**
687
+ * The minimum number of network interfaces.
688
+ */
208
689
  Min?: number;
209
690
  };
210
691
  /**
211
692
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.NotificationConfiguration`.
693
+ * A structure that specifies an Amazon SNS notification configuration for the ``NotificationConfigurations`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.
694
+ For an example template snippet, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html).
695
+ For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*.
212
696
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-notificationconfiguration.html}
213
697
  */
214
698
  export type NotificationConfiguration = {
699
+ /**
700
+ * A list of event types that send a notification. Event types can include any of the following types.
701
+ *Allowed values*:
702
+ + ``autoscaling:EC2_INSTANCE_LAUNCH``
703
+ + ``autoscaling:EC2_INSTANCE_LAUNCH_ERROR``
704
+ + ``autoscaling:EC2_INSTANCE_TERMINATE``
705
+ + ``autoscaling:EC2_INSTANCE_TERMINATE_ERROR``
706
+ + ``autoscaling:TEST_NOTIFICATION``
707
+ */
215
708
  NotificationTypes?: string[];
709
+ /**
710
+ * The Amazon Resource Name (ARN) of the Amazon SNS topic.
711
+ */
216
712
  TopicARN: string | string[];
217
713
  };
218
714
  /**
219
715
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.TagProperty`.
716
+ * A structure that specifies a tag for the ``Tags`` property of [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.
717
+ For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource.
718
+ CloudFormation adds the following tags to all Auto Scaling groups and associated instances:
719
+ + aws:cloudformation:stack-name
720
+ + aws:cloudformation:stack-id
721
+ + aws:cloudformation:logical-id
220
722
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-tagproperty.html}
221
723
  */
222
724
  export type TagProperty = {
725
+ /**
726
+ * The tag key.
727
+ */
223
728
  Key: string;
729
+ /**
730
+ * Set to ``true`` if you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set to ``false`` if you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group.
731
+ */
224
732
  PropagateAtLaunch: boolean;
733
+ /**
734
+ * The tag value.
735
+ */
225
736
  Value: string;
226
737
  };
227
738
  /**
228
739
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.TotalLocalStorageGBRequest`.
740
+ * ``TotalLocalStorageGBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total local storage size for an instance type, in GB.
229
741
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-totallocalstoragegbrequest.html}
230
742
  */
231
743
  export type TotalLocalStorageGBRequest = {
744
+ /**
745
+ * The storage maximum in GB.
746
+ */
232
747
  Max?: number;
748
+ /**
749
+ * The storage minimum in GB.
750
+ */
233
751
  Min?: number;
234
752
  };
235
753
  /**
236
754
  * Type definition for `AWS::AutoScaling::AutoScalingGroup.VCpuCountRequest`.
755
+ * ``VCpuCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of vCPUs for an instance type.
237
756
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-vcpucountrequest.html}
238
757
  */
239
758
  export type VCpuCountRequest = {
759
+ /**
760
+ * The maximum number of vCPUs.
761
+ */
240
762
  Max?: number;
763
+ /**
764
+ * The minimum number of vCPUs.
765
+ */
241
766
  Min?: number;
242
767
  };
243
768
  /**
244
- * Resource Type definition for AWS::AutoScaling::AutoScalingGroup
769
+ * 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.
770
+ For more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling User Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html).
771
+ Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) and [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*.
245
772
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html}
246
773
  */
247
774
  export declare class AutoScalingAutoScalingGroup extends $Resource<"AWS::AutoScaling::AutoScalingGroup", AutoScalingAutoScalingGroupProperties, Record<string, never>> {