-
Notifications
You must be signed in to change notification settings - Fork 597
/
types.go
3200 lines (2690 loc) · 121 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// Specifies the minimum and maximum for the AcceleratorCount object when you
// specify InstanceRequirementsfor an Auto Scaling group.
type AcceleratorCountRequest struct {
// The maximum value.
Max *int32
// The minimum value.
Min *int32
noSmithyDocumentSerde
}
// Specifies the minimum and maximum for the AcceleratorTotalMemoryMiB object when
// you specify InstanceRequirementsfor an Auto Scaling group.
type AcceleratorTotalMemoryMiBRequest struct {
// The memory maximum in MiB.
Max *int32
// The memory minimum in MiB.
Min *int32
noSmithyDocumentSerde
}
// Describes scaling activity, which is a long-running process that represents a
// change to your Auto Scaling group, such as changing its size or replacing an
// instance.
type Activity struct {
// The ID of the activity.
//
// This member is required.
ActivityId *string
// The name of the Auto Scaling group.
//
// This member is required.
AutoScalingGroupName *string
// The reason the activity began.
//
// This member is required.
Cause *string
// The start time of the activity.
//
// This member is required.
StartTime *time.Time
// The current status of the activity.
//
// This member is required.
StatusCode ScalingActivityStatusCode
// The Amazon Resource Name (ARN) of the Auto Scaling group.
AutoScalingGroupARN *string
// The state of the Auto Scaling group, which is either InService or Deleted .
AutoScalingGroupState *string
// A friendly, more verbose description of the activity.
Description *string
// The details about the activity.
Details *string
// The end time of the activity.
EndTime *time.Time
// A value between 0 and 100 that indicates the progress of the activity.
Progress *int32
// A friendly, more verbose description of the activity status.
StatusMessage *string
noSmithyDocumentSerde
}
// Describes a policy adjustment type.
type AdjustmentType struct {
// The policy adjustment type. The valid values are ChangeInCapacity ,
// ExactCapacity , and PercentChangeInCapacity .
AdjustmentType *string
noSmithyDocumentSerde
}
// Describes an alarm.
type Alarm struct {
// The Amazon Resource Name (ARN) of the alarm.
AlarmARN *string
// The name of the alarm.
AlarmName *string
noSmithyDocumentSerde
}
// Specifies the CloudWatch alarm specification to use in an instance refresh.
type AlarmSpecification struct {
// The names of one or more CloudWatch alarms to monitor for the instance refresh.
// You can specify up to 10 alarms.
Alarms []string
noSmithyDocumentSerde
}
// Describes an Auto Scaling group.
type AutoScalingGroup struct {
// The name of the Auto Scaling group.
//
// This member is required.
AutoScalingGroupName *string
// One or more Availability Zones for the group.
//
// This member is required.
AvailabilityZones []string
// The date and time the group was created.
//
// This member is required.
CreatedTime *time.Time
// The duration of the default cooldown period, in seconds.
//
// This member is required.
DefaultCooldown *int32
// The desired size of the group.
//
// This member is required.
DesiredCapacity *int32
// A comma-separated value string of one or more health check types.
//
// This member is required.
HealthCheckType *string
// The maximum size of the group.
//
// This member is required.
MaxSize *int32
// The minimum size of the group.
//
// This member is required.
MinSize *int32
// The Amazon Resource Name (ARN) of the Auto Scaling group.
AutoScalingGroupARN *string
// Indicates whether Capacity Rebalancing is enabled.
CapacityRebalance *bool
// Reserved.
Context *string
// The duration of the default instance warmup, in seconds.
DefaultInstanceWarmup *int32
// The unit of measurement for the value specified for desired capacity. Amazon
// EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type
// selection only.
DesiredCapacityType *string
// The metrics enabled for the group.
EnabledMetrics []EnabledMetric
// The duration of the health check grace period, in seconds.
HealthCheckGracePeriod *int32
// An instance maintenance policy.
InstanceMaintenancePolicy *InstanceMaintenancePolicy
// The EC2 instances associated with the group.
Instances []Instance
// The name of the associated launch configuration.
LaunchConfigurationName *string
// The launch template for the group.
LaunchTemplate *LaunchTemplateSpecification
// One or more load balancers associated with the group.
LoadBalancerNames []string
// The maximum amount of time, in seconds, that an instance can be in service.
//
// Valid Range: Minimum value of 0.
MaxInstanceLifetime *int32
// The mixed instances policy for the group.
MixedInstancesPolicy *MixedInstancesPolicy
// Indicates whether newly launched instances are protected from termination by
// Amazon EC2 Auto Scaling when scaling in.
NewInstancesProtectedFromScaleIn *bool
// The name of the placement group into which to launch your instances, if any.
PlacementGroup *string
// The predicted capacity of the group when it has a predictive scaling policy.
PredictedCapacity *int32
// The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling
// group uses to call other Amazon Web Services on your behalf.
ServiceLinkedRoleARN *string
// The current state of the group when the DeleteAutoScalingGroup operation is in progress.
Status *string
// The suspended processes associated with the group.
SuspendedProcesses []SuspendedProcess
// The tags for the group.
Tags []TagDescription
// The Amazon Resource Names (ARN) of the target groups for your load balancer.
TargetGroupARNs []string
// The termination policies for the group.
TerminationPolicies []string
// The traffic sources associated with this Auto Scaling group.
TrafficSources []TrafficSourceIdentifier
// One or more subnet IDs, if applicable, separated by commas.
VPCZoneIdentifier *string
// The warm pool for the group.
WarmPoolConfiguration *WarmPoolConfiguration
// The current size of the warm pool.
WarmPoolSize *int32
noSmithyDocumentSerde
}
// Describes an EC2 instance associated with an Auto Scaling group.
type AutoScalingInstanceDetails struct {
// The name of the Auto Scaling group for the instance.
//
// This member is required.
AutoScalingGroupName *string
// The Availability Zone for the instance.
//
// This member is required.
AvailabilityZone *string
// The last reported health status of this instance. Healthy means that the
// instance is healthy and should remain in service. Unhealthy means that the
// instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace
// it.
//
// This member is required.
HealthStatus *string
// The ID of the instance.
//
// This member is required.
InstanceId *string
// The lifecycle state for the instance. The Quarantined state is not used. For
// information about lifecycle states, see [Instance lifecycle]in the Amazon EC2 Auto Scaling User
// Guide.
//
// Valid values: Pending | Pending:Wait | Pending:Proceed | Quarantined | InService
// | Terminating | Terminating:Wait | Terminating:Proceed | Terminated | Detaching
// | Detached | EnteringStandby | Standby | Warmed:Pending | Warmed:Pending:Wait |
// Warmed:Pending:Proceed | Warmed:Terminating | Warmed:Terminating:Wait |
// Warmed:Terminating:Proceed | Warmed:Terminated | Warmed:Stopped | Warmed:Running
//
// [Instance lifecycle]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html
//
// This member is required.
LifecycleState *string
// Indicates whether the instance is protected from termination by Amazon EC2 Auto
// Scaling when scaling in.
//
// This member is required.
ProtectedFromScaleIn *bool
// The instance type of the EC2 instance.
InstanceType *string
// The launch configuration used to launch the instance. This value is not
// available if you attached the instance to the Auto Scaling group.
LaunchConfigurationName *string
// The launch template for the instance.
LaunchTemplate *LaunchTemplateSpecification
// The number of capacity units contributed by the instance based on its instance
// type.
//
// Valid Range: Minimum value of 1. Maximum value of 999.
WeightedCapacity *string
noSmithyDocumentSerde
}
// Specifies the minimum and maximum for the BaselineEbsBandwidthMbps object when
// you specify InstanceRequirementsfor an Auto Scaling group.
type BaselineEbsBandwidthMbpsRequest struct {
// The maximum value in Mbps.
Max *int32
// The minimum value in Mbps.
Min *int32
noSmithyDocumentSerde
}
// Describes a block device mapping.
type BlockDeviceMapping struct {
// The device name assigned to the volume (for example, /dev/sdh or xvdh ). For
// more information, see [Device naming on Linux instances]in the Amazon EC2 User Guide for Linux Instances.
//
// To define a block device mapping, set the device name and exactly one of the
// following properties: Ebs , NoDevice , or VirtualName .
//
// [Device naming on Linux instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html
//
// This member is required.
DeviceName *string
// Information to attach an EBS volume to an instance at launch.
Ebs *Ebs
// Setting this value to true prevents a volume that is included in the block
// device mapping of the AMI from being mapped to the specified device name at
// launch.
//
// If NoDevice is true for the root device, instances might fail the EC2 health
// check. In that case, Amazon EC2 Auto Scaling launches replacement instances.
NoDevice *bool
// The name of the instance store volume (virtual device) to attach to an instance
// at launch. The name must be in the form ephemeralX where X is a number starting
// from zero (0), for example, ephemeral0 .
VirtualName *string
noSmithyDocumentSerde
}
// A GetPredictiveScalingForecast call returns the capacity forecast for a
// predictive scaling policy. This structure includes the data points for that
// capacity forecast, along with the timestamps of those data points.
type CapacityForecast struct {
// The timestamps for the data points, in UTC format.
//
// This member is required.
Timestamps []time.Time
// The values of the data points.
//
// This member is required.
Values []float64
noSmithyDocumentSerde
}
// Represents a CloudWatch metric of your choosing for a target tracking scaling
// policy to use with Amazon EC2 Auto Scaling.
//
// To create your customized metric specification:
//
// - Add values for each required property from CloudWatch. You can use an
// existing metric, or a new metric that you create. To use your own metric, you
// must first publish the metric to CloudWatch. For more information, see [Publish custom metrics]in the
// Amazon CloudWatch User Guide.
//
// - Choose a metric that changes proportionally with capacity. The value of the
// metric should increase or decrease in inverse proportion to the number of
// capacity units. That is, the value of the metric should decrease when capacity
// increases.
//
// For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts].
//
// Each individual service provides information about the metrics, namespace, and
// dimensions they use. For more information, see [Amazon Web Services services that publish CloudWatch metrics]in the Amazon CloudWatch User
// Guide.
//
// [Amazon Web Services services that publish CloudWatch metrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html
// [Amazon CloudWatch concepts]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html
// [Publish custom metrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html
type CustomizedMetricSpecification struct {
// The dimensions of the metric.
//
// Conditional: If you published your metric with dimensions, you must specify the
// same dimensions in your scaling policy.
Dimensions []MetricDimension
// The name of the metric. To get the exact metric name, namespace, and
// dimensions, inspect the [Metric]object that is returned by a call to [ListMetrics].
//
// [ListMetrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html
// [Metric]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html
MetricName *string
// The metrics to include in the target tracking scaling policy, as a metric data
// query. This can include both raw metric and metric math expressions.
Metrics []TargetTrackingMetricDataQuery
// The namespace of the metric.
Namespace *string
// The statistic of the metric.
Statistic MetricStatistic
// The unit of the metric. For a complete list of the units that CloudWatch
// supports, see the [MetricDatum]data type in the Amazon CloudWatch API Reference.
//
// [MetricDatum]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html
Unit *string
noSmithyDocumentSerde
}
// Describes the desired configuration for an instance refresh.
//
// If you specify a desired configuration, you must specify either a LaunchTemplate
// or a MixedInstancesPolicy .
type DesiredConfiguration struct {
// 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.
//
// [Launch templates]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html
LaunchTemplate *LaunchTemplateSpecification
// 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.
//
// [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
MixedInstancesPolicy *MixedInstancesPolicy
noSmithyDocumentSerde
}
// Describes information used to set up an Amazon EBS volume specified in a block
// device mapping.
type Ebs struct {
// Indicates whether the volume is deleted on instance termination. For Amazon EC2
// Auto Scaling, the default value is true .
DeleteOnTermination *bool
// Specifies whether the volume should be encrypted. Encrypted EBS volumes can
// only be attached to instances that support Amazon EBS encryption. For more
// information, see [Supported instance types]. If your AMI uses encrypted volumes, you can also only launch
// it on supported instance types.
//
// If you are creating a volume from a snapshot, you cannot create an unencrypted
// volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when
// using a launch configuration.
//
// If you enable encryption by default, the EBS volumes that you create are always
// encrypted, either using the Amazon Web Services managed KMS key or a
// customer-managed KMS key, regardless of whether the snapshot was encrypted.
//
// For more information, see [Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes] in the Amazon EC2 Auto Scaling User Guide.
//
// [Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-data-protection.html#encryption
// [Supported instance types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances
Encrypted *bool
// The number of input/output (I/O) operations per second (IOPS) to provision for
// the volume. For gp3 and io1 volumes, this represents the number of IOPS that
// are provisioned for the volume. For gp2 volumes, this represents the baseline
// performance of the volume and the rate at which the volume accumulates I/O
// credits for bursting.
//
// The following are the supported values for each volume type:
//
// - gp3 : 3,000-16,000 IOPS
//
// - io1 : 100-64,000 IOPS
//
// For io1 volumes, we guarantee 64,000 IOPS only for [Instances built on the Nitro System]. Other instance families
// guarantee performance up to 32,000 IOPS.
//
// Iops is supported when the volume type is gp3 or io1 and required only when the
// volume type is io1 . (Not used with standard , gp2 , st1 , or sc1 volumes.)
//
// [Instances built on the Nitro System]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances
Iops *int32
// The snapshot ID of the volume to use.
//
// You must specify either a VolumeSize or a SnapshotId .
SnapshotId *string
// The throughput (MiBps) to provision for a gp3 volume.
Throughput *int32
// The volume size, in GiBs. The following are the supported volumes sizes for
// each volume type:
//
// - gp2 and gp3 : 1-16,384
//
// - io1 : 4-16,384
//
// - st1 and sc1 : 125-16,384
//
// - standard : 1-1,024
//
// You must specify either a SnapshotId or a VolumeSize . If you specify both
// SnapshotId and VolumeSize , the volume size must be equal or greater than the
// size of the snapshot.
VolumeSize *int32
// The volume type. For more information, see [Amazon EBS volume types] in the Amazon EC2 User Guide for
// Linux Instances.
//
// Valid values: standard | io1 | gp2 | st1 | sc1 | gp3
//
// [Amazon EBS volume types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
VolumeType *string
noSmithyDocumentSerde
}
// Describes an enabled Auto Scaling group metric.
type EnabledMetric struct {
// The granularity of the metric. The only valid value is 1Minute .
Granularity *string
// One of the following metrics:
//
// - GroupMinSize
//
// - GroupMaxSize
//
// - GroupDesiredCapacity
//
// - GroupInServiceInstances
//
// - GroupPendingInstances
//
// - GroupStandbyInstances
//
// - GroupTerminatingInstances
//
// - GroupTotalInstances
//
// - GroupInServiceCapacity
//
// - GroupPendingCapacity
//
// - GroupStandbyCapacity
//
// - GroupTerminatingCapacity
//
// - GroupTotalCapacity
//
// - WarmPoolDesiredCapacity
//
// - WarmPoolWarmedCapacity
//
// - WarmPoolPendingCapacity
//
// - WarmPoolTerminatingCapacity
//
// - WarmPoolTotalCapacity
//
// - GroupAndWarmPoolDesiredCapacity
//
// - GroupAndWarmPoolTotalCapacity
//
// For more information, see [Auto Scaling group metrics] in the Amazon EC2 Auto Scaling User Guide.
//
// [Auto Scaling group metrics]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics
Metric *string
noSmithyDocumentSerde
}
// Describes a scheduled action that could not be created, updated, or deleted.
type FailedScheduledUpdateGroupActionRequest struct {
// The name of the scheduled action.
//
// This member is required.
ScheduledActionName *string
// The error code.
ErrorCode *string
// The error message accompanying the error code.
ErrorMessage *string
noSmithyDocumentSerde
}
// Describes a filter that is used to return a more specific list of results from
// a describe operation.
//
// If you specify multiple filters, the filters are automatically logically joined
// with an AND , and the request returns only the results that match all of the
// specified filters.
//
// For more information, see [Tag Auto Scaling groups and instances] in the Amazon EC2 Auto Scaling User Guide.
//
// [Tag Auto Scaling groups and instances]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html
type Filter struct {
// The name of the filter.
//
// The valid values for Name depend on which API operation you're using with the
// filter (DescribeAutoScalingGroups or DescribeTags).
//
// DescribeAutoScalingGroups
//
// Valid values for Name include the following:
//
// - tag-key - Accepts tag keys. The results only include information about the
// Auto Scaling groups associated with these tag keys.
//
// - tag-value - Accepts tag values. The results only include information about
// the Auto Scaling groups associated with these tag values.
//
// - tag: - Accepts the key/value combination of the tag. Use the tag key in the
// filter name and the tag value as the filter value. The results only include
// information about the Auto Scaling groups associated with the specified
// key/value combination.
//
// DescribeTags
//
// Valid values for Name include the following:
//
// - auto-scaling-group - Accepts the names of Auto Scaling groups. The results
// only include information about the tags associated with these Auto Scaling
// groups.
//
// - key - Accepts tag keys. The results only include information about the tags
// associated with these tag keys.
//
// - value - Accepts tag values. The results only include information about the
// tags associated with these tag values.
//
// - propagate-at-launch - Accepts a Boolean value, which specifies whether tags
// propagate to instances at launch. The results only include information about the
// tags associated with the specified Boolean value.
Name *string
// One or more filter values. Filter values are case-sensitive.
//
// If you specify multiple values for a filter, the values are automatically
// logically joined with an OR , and the request returns all results that match any
// of the specified values. For example, specify "tag:environment" for the filter
// name and "production,development" for the filter values to find Auto Scaling
// groups with the tag "environment=production" or "environment=development".
Values []string
noSmithyDocumentSerde
}
// Describes an EC2 instance.
type Instance struct {
// The Availability Zone in which the instance is running.
//
// This member is required.
AvailabilityZone *string
// The last reported health status of the instance. Healthy means that the
// instance is healthy and should remain in service. Unhealthy means that the
// instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and
// replace it.
//
// This member is required.
HealthStatus *string
// The ID of the instance.
//
// This member is required.
InstanceId *string
// A description of the current lifecycle state. The Quarantined state is not
// used. For information about lifecycle states, see [Instance lifecycle]in the Amazon EC2 Auto
// Scaling User Guide.
//
// [Instance lifecycle]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html
//
// This member is required.
LifecycleState LifecycleState
// Indicates whether the instance is protected from termination by Amazon EC2 Auto
// Scaling when scaling in.
//
// This member is required.
ProtectedFromScaleIn *bool
// The instance type of the EC2 instance.
InstanceType *string
// The launch configuration associated with the instance.
LaunchConfigurationName *string
// The launch template for the instance.
LaunchTemplate *LaunchTemplateSpecification
// The number of capacity units contributed by the instance based on its instance
// type.
//
// Valid Range: Minimum value of 1. Maximum value of 999.
WeightedCapacity *string
noSmithyDocumentSerde
}
// Describes an instance maintenance policy.
//
// For more information, see [Set instance maintenance policy] in the Amazon EC2 Auto Scaling User Guide.
//
// [Set instance maintenance policy]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html
type InstanceMaintenancePolicy struct {
// Specifies the upper threshold as a percentage of the desired capacity of the
// Auto Scaling group. It represents the maximum percentage of the group that can
// be in service and healthy, or pending, to support your workload when replacing
// instances. Value range is 100 to 200. To clear a previously set value, specify a
// value of -1 .
//
// Both MinHealthyPercentage and MaxHealthyPercentage must be specified, and the
// difference between them cannot be greater than 100. A large range increases the
// number of instances that can be replaced at the same time.
MaxHealthyPercentage *int32
// 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 .
MinHealthyPercentage *int32
noSmithyDocumentSerde
}
// The metadata options for the instances. For more information, see [Configuring the Instance Metadata Options] in the
// Amazon EC2 Auto Scaling User Guide.
//
// [Configuring the Instance Metadata Options]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds
type InstanceMetadataOptions struct {
// This parameter enables or disables the HTTP metadata endpoint on your
// instances. If the parameter is not specified, the default state is enabled .
//
// If you specify a value of disabled , you will not be able to access your
// instance metadata.
HttpEndpoint InstanceMetadataEndpointState
// The desired HTTP PUT response hop limit for instance metadata requests. The
// larger the number, the further instance metadata requests can travel.
//
// Default: 1
HttpPutResponseHopLimit *int32
// The state of token usage for your instance metadata requests. If the parameter
// is not specified in the request, the default state is optional .
//
// If the state is optional , you can choose to retrieve instance metadata with or
// without a signed token header on your request. If you retrieve the IAM role
// credentials without a token, the version 1.0 role credentials are returned. If
// you retrieve the IAM role credentials using a valid signed token, the version
// 2.0 role credentials are returned.
//
// If the state is required , you must send a signed token header with any instance
// metadata retrieval requests. In this state, retrieving the IAM role credentials
// always returns the version 2.0 credentials; the version 1.0 credentials are not
// available.
HttpTokens InstanceMetadataHttpTokensState
noSmithyDocumentSerde
}
// Describes whether detailed monitoring is enabled for the Auto Scaling instances.
type InstanceMonitoring struct {
// If true , detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
Enabled *bool
noSmithyDocumentSerde
}
// Describes an instance refresh for an Auto Scaling group.
type InstanceRefresh struct {
// The name of the Auto Scaling group.
AutoScalingGroupName *string
// Describes the desired configuration for the instance refresh.
DesiredConfiguration *DesiredConfiguration
// The date and time at which the instance refresh ended.
EndTime *time.Time
// The instance refresh ID.
InstanceRefreshId *string
// 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.
InstancesToUpdate *int32
// 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.
PercentageComplete *int32
// The preferences for an instance refresh.
Preferences *RefreshPreferences
// Additional progress details for an Auto Scaling group that has a warm pool.
ProgressDetails *InstanceRefreshProgressDetails
// The rollback details.
RollbackDetails *RollbackDetails
// The date and time at which the instance refresh began.
StartTime *time.Time
// 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.
Status InstanceRefreshStatus
// The explanation for the specific status assigned to this operation.
StatusReason *string
noSmithyDocumentSerde
}
// Reports progress on replacing instances that are in the Auto Scaling group.
type InstanceRefreshLivePoolProgress struct {
// The number of instances remaining to update.
InstancesToUpdate *int32
// 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.
PercentageComplete *int32
noSmithyDocumentSerde
}
// 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).
type InstanceRefreshProgressDetails struct {
// Reports progress on replacing instances that are in the Auto Scaling group.
LivePoolProgress *InstanceRefreshLivePoolProgress
// Reports progress on replacing instances that are in the warm pool.
WarmPoolProgress *InstanceRefreshWarmPoolProgress
noSmithyDocumentSerde
}
// Reports progress on replacing instances that are in the warm pool.
type InstanceRefreshWarmPoolProgress struct {
// The number of instances remaining to update.
InstancesToUpdate *int32
// 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.
PercentageComplete *int32
noSmithyDocumentSerde
}
// 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.
//
// 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.
//
// 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:
//
// - AllowedInstanceTypes - The instance types to include in the list. All other
// instance types are ignored, even if they match your specified attributes.
//
// - ExcludedInstanceTypes - The instance types to exclude from the list, even if
// they match your specified attributes.
//
// You must specify VCpuCount and MemoryMiB . All other attributes are optional.
// Any unspecified optional attribute is set to its default.
//
// For more information, see [Creating an Auto Scaling group using attribute-based instance type selection] 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]in the Amazon EC2 User Guide for Linux Instances.
//
// [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
// [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
type InstanceRequirements struct {
// The minimum and maximum instance memory size for an instance type, in MiB.
//
// This member is required.
MemoryMiB *MemoryMiBRequest
// The minimum and maximum number of vCPUs for an instance type.
//
// This member is required.
VCpuCount *VCpuCountRequest
// 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
AcceleratorCount *AcceleratorCountRequest
// Indicates whether instance types must have accelerators by specific
// manufacturers.
//
// - For instance types with NVIDIA devices, specify nvidia .
//
// - For instance types with AMD devices, specify amd .
//
// - For instance types with Amazon Web Services devices, specify
// amazon-web-services .
//
// - For instance types with Xilinx devices, specify xilinx .
//
// Default: Any manufacturer
AcceleratorManufacturers []AcceleratorManufacturer
// Lists the accelerators that must be on an instance type.