-
Notifications
You must be signed in to change notification settings - Fork 626
/
types.go
5556 lines (4833 loc) · 246 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"
)
// An object representing a container instance or task attachment.
type Attachment struct {
// Details of the attachment.
//
// For elastic network interfaces, this includes the network interface ID, the MAC
// address, the subnet ID, and the private IPv4 address.
//
// For Service Connect services, this includes portName , clientAliases ,
// discoveryName , and ingressPortOverride .
//
// For Elastic Block Storage, this includes roleArn , deleteOnTermination ,
// volumeName , volumeId , and statusReason (only when the attachment fails to
// create or attach).
Details []KeyValuePair
// The unique identifier for the attachment.
Id *string
// The status of the attachment. Valid values are PRECREATED , CREATED , ATTACHING
// , ATTACHED , DETACHING , DETACHED , DELETED , and FAILED .
Status *string
// The type of the attachment, such as ElasticNetworkInterface , Service Connect ,
// and AmazonElasticBlockStorage .
Type *string
noSmithyDocumentSerde
}
// An object representing a change in state for a task attachment.
type AttachmentStateChange struct {
// The Amazon Resource Name (ARN) of the attachment.
//
// This member is required.
AttachmentArn *string
// The status of the attachment.
//
// This member is required.
Status *string
noSmithyDocumentSerde
}
// An attribute is a name-value pair that's associated with an Amazon ECS object.
// Use attributes to extend the Amazon ECS data model by adding custom metadata to
// your resources. For more information, see [Attributes]in the Amazon Elastic Container
// Service Developer Guide.
//
// [Attributes]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes
type Attribute struct {
// The name of the attribute. The name must contain between 1 and 128 characters.
// The name may contain letters (uppercase and lowercase), numbers, hyphens (-),
// underscores (_), forward slashes (/), back slashes (\), or periods (.).
//
// This member is required.
Name *string
// The ID of the target. You can specify the short form ID for a resource or the
// full Amazon Resource Name (ARN).
TargetId *string
// The type of the target to attach the attribute with. This parameter is required
// if you use the short form ID for a resource instead of the full ARN.
TargetType TargetType
// The value of the attribute. The value must contain between 1 and 128
// characters. It can contain letters (uppercase and lowercase), numbers, hyphens
// (-), underscores (_), periods (.), at signs (@), forward slashes (/), back
// slashes (\), colons (:), or spaces. The value can't start or end with a space.
Value *string
noSmithyDocumentSerde
}
// The details of the Auto Scaling group for the capacity provider.
type AutoScalingGroupProvider struct {
// The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the
// Auto Scaling group name.
//
// This member is required.
AutoScalingGroupArn *string
// The managed draining option for the Auto Scaling group capacity provider. When
// you enable this, Amazon ECS manages and gracefully drains the EC2 container
// instances that are in the Auto Scaling group capacity provider.
ManagedDraining ManagedDraining
// The managed scaling settings for the Auto Scaling group capacity provider.
ManagedScaling *ManagedScaling
// The managed termination protection setting to use for the Auto Scaling group
// capacity provider. This determines whether the Auto Scaling group has managed
// termination protection. The default is off.
//
// When using managed termination protection, managed scaling must also be used
// otherwise managed termination protection doesn't work.
//
// When managed termination protection is on, Amazon ECS prevents the Amazon EC2
// instances in an Auto Scaling group that contain tasks from being terminated
// during a scale-in action. The Auto Scaling group and each instance in the Auto
// Scaling group must have instance protection from scale-in actions on as well.
// For more information, see [Instance Protection]in the Auto Scaling User Guide.
//
// When managed termination protection is off, your Amazon EC2 instances aren't
// protected from termination when the Auto Scaling group scales in.
//
// [Instance Protection]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
ManagedTerminationProtection ManagedTerminationProtection
noSmithyDocumentSerde
}
// The details of the Auto Scaling group capacity provider to update.
type AutoScalingGroupProviderUpdate struct {
// The managed draining option for the Auto Scaling group capacity provider. When
// you enable this, Amazon ECS manages and gracefully drains the EC2 container
// instances that are in the Auto Scaling group capacity provider.
ManagedDraining ManagedDraining
// The managed scaling settings for the Auto Scaling group capacity provider.
ManagedScaling *ManagedScaling
// The managed termination protection setting to use for the Auto Scaling group
// capacity provider. This determines whether the Auto Scaling group has managed
// termination protection.
//
// When using managed termination protection, managed scaling must also be used
// otherwise managed termination protection doesn't work.
//
// When managed termination protection is on, Amazon ECS prevents the Amazon EC2
// instances in an Auto Scaling group that contain tasks from being terminated
// during a scale-in action. The Auto Scaling group and each instance in the Auto
// Scaling group must have instance protection from scale-in actions on. For more
// information, see [Instance Protection]in the Auto Scaling User Guide.
//
// When managed termination protection is off, your Amazon EC2 instances aren't
// protected from termination when the Auto Scaling group scales in.
//
// [Instance Protection]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
ManagedTerminationProtection ManagedTerminationProtection
noSmithyDocumentSerde
}
// An object representing the networking details for a task or service. For
// example
// awsvpcConfiguration={subnets=["subnet-12344321"],securityGroups=["sg-12344321"]}
type AwsVpcConfiguration struct {
// The IDs of the subnets associated with the task or service. There's a limit of
// 16 subnets that can be specified per AwsVpcConfiguration .
//
// All specified subnets must be from the same VPC.
//
// This member is required.
Subnets []string
// Whether the task's elastic network interface receives a public IP address. The
// default value is DISABLED .
AssignPublicIp AssignPublicIp
// The IDs of the security groups associated with the task or service. If you
// don't specify a security group, the default security group for the VPC is used.
// There's a limit of 5 security groups that can be specified per
// AwsVpcConfiguration .
//
// All specified security groups must be from the same VPC.
SecurityGroups []string
noSmithyDocumentSerde
}
// The details for a capacity provider.
type CapacityProvider struct {
// The Auto Scaling group settings for the capacity provider.
AutoScalingGroupProvider *AutoScalingGroupProvider
// The Amazon Resource Name (ARN) that identifies the capacity provider.
CapacityProviderArn *string
// The name of the capacity provider.
Name *string
// The current status of the capacity provider. Only capacity providers in an
// ACTIVE state can be used in a cluster. When a capacity provider is successfully
// deleted, it has an INACTIVE status.
Status CapacityProviderStatus
// The metadata that you apply to the capacity provider to help you categorize and
// organize it. Each tag consists of a key and an optional value. You define both.
//
// The following basic restrictions apply to tags:
//
// - Maximum number of tags per resource - 50
//
// - For each resource, each tag key must be unique, and each tag key can have
// only one value.
//
// - Maximum key length - 128 Unicode characters in UTF-8
//
// - Maximum value length - 256 Unicode characters in UTF-8
//
// - If your tagging schema is used across multiple services and resources,
// remember that other services may have restrictions on allowed characters.
// Generally allowed characters are: letters, numbers, and spaces representable in
// UTF-8, and the following characters: + - = . _ : / @.
//
// - Tag keys and values are case-sensitive.
//
// - Do not use aws: , AWS: , or any upper or lowercase combination of such as a
// prefix for either keys or values as it is reserved for Amazon Web Services use.
// You cannot edit or delete tag keys or values with this prefix. Tags with this
// prefix do not count against your tags per resource limit.
Tags []Tag
// The update status of the capacity provider. The following are the possible
// states that is returned.
//
// DELETE_IN_PROGRESS The capacity provider is in the process of being deleted.
//
// DELETE_COMPLETE The capacity provider was successfully deleted and has an
// INACTIVE status.
//
// DELETE_FAILED The capacity provider can't be deleted. The update status reason
// provides further details about why the delete failed.
UpdateStatus CapacityProviderUpdateStatus
// The update status reason. This provides further details about the update status
// for the capacity provider.
UpdateStatusReason *string
noSmithyDocumentSerde
}
// The details of a capacity provider strategy. A capacity provider strategy can
// be set when using the RunTaskor CreateCluster APIs or as the default capacity provider strategy for
// a cluster with the CreateClusterAPI.
//
// Only capacity providers that are already associated with a cluster and have an
// ACTIVE or UPDATING status can be used in a capacity provider strategy. The PutClusterCapacityProviders API
// is used to associate a capacity provider with a cluster.
//
// If specifying a capacity provider that uses an Auto Scaling group, the capacity
// provider must already be created. New Auto Scaling group capacity providers can
// be created with the CreateCapacityProviderAPI operation.
//
// To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
// capacity providers. The Fargate capacity providers are available to all accounts
// and only need to be associated with a cluster to be used in a capacity provider
// strategy.
//
// With FARGATE_SPOT , you can run interruption tolerant tasks at a rate that's
// discounted compared to the FARGATE price. FARGATE_SPOT runs tasks on spare
// compute capacity. When Amazon Web Services needs the capacity back, your tasks
// are interrupted with a two-minute warning. FARGATE_SPOT only supports Linux
// tasks with the X86_64 architecture on platform version 1.3.0 or later.
//
// A capacity provider strategy may contain a maximum of 6 capacity providers.
type CapacityProviderStrategyItem struct {
// The short name of the capacity provider.
//
// This member is required.
CapacityProvider *string
// The base value designates how many tasks, at a minimum, to run on the specified
// capacity provider. Only one capacity provider in a capacity provider strategy
// can have a base defined. If no value is specified, the default value of 0 is
// used.
Base int32
// The weight value designates the relative percentage of the total number of
// tasks launched that should use the specified capacity provider. The weight
// value is taken into consideration after the base value, if defined, is
// satisfied.
//
// If no weight value is specified, the default value of 0 is used. When multiple
// capacity providers are specified within a capacity provider strategy, at least
// one of the capacity providers must have a weight value greater than zero and any
// capacity providers with a weight of 0 can't be used to place tasks. If you
// specify multiple capacity providers in a strategy that all have a weight of 0 ,
// any RunTask or CreateService actions using the capacity provider strategy will
// fail.
//
// An example scenario for using weights is defining a strategy that contains two
// capacity providers and both have a weight of 1 , then when the base is
// satisfied, the tasks will be split evenly across the two capacity providers.
// Using that same logic, if you specify a weight of 1 for capacityProviderA and a
// weight of 4 for capacityProviderB, then for every one task that's run using
// capacityProviderA, four tasks would use capacityProviderB.
Weight int32
noSmithyDocumentSerde
}
// A regional grouping of one or more container instances where you can run task
// requests. Each account receives a default cluster the first time you use the
// Amazon ECS service, but you may also create other clusters. Clusters may contain
// more than one instance type simultaneously.
type Cluster struct {
// The number of services that are running on the cluster in an ACTIVE state. You
// can view these services with ListServices.
ActiveServicesCount int32
// The resources attached to a cluster. When using a capacity provider with a
// cluster, the capacity provider and associated resources are returned as cluster
// attachments.
Attachments []Attachment
// The status of the capacity providers associated with the cluster. The following
// are the states that are returned.
//
// UPDATE_IN_PROGRESS The available capacity providers for the cluster are
// updating.
//
// UPDATE_COMPLETE The capacity providers have successfully updated.
//
// UPDATE_FAILED The capacity provider updates failed.
AttachmentsStatus *string
// The capacity providers associated with the cluster.
CapacityProviders []string
// The Amazon Resource Name (ARN) that identifies the cluster. For more
// information about the ARN format, see [Amazon Resource Name (ARN)]in the Amazon ECS Developer Guide.
//
// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids
ClusterArn *string
// A user-generated string that you use to identify your cluster.
ClusterName *string
// The execute command configuration for the cluster.
Configuration *ClusterConfiguration
// The default capacity provider strategy for the cluster. When services or tasks
// are run in the cluster with no launch type or capacity provider strategy
// specified, the default capacity provider strategy is used.
DefaultCapacityProviderStrategy []CapacityProviderStrategyItem
// The number of tasks in the cluster that are in the PENDING state.
PendingTasksCount int32
// The number of container instances registered into the cluster. This includes
// container instances in both ACTIVE and DRAINING status.
RegisteredContainerInstancesCount int32
// The number of tasks in the cluster that are in the RUNNING state.
RunningTasksCount int32
// Use this parameter to set a default Service Connect namespace. After you set a
// default Service Connect namespace, any new services with Service Connect turned
// on that are created in the cluster are added as client services in the
// namespace. This setting only applies to new services that set the enabled
// parameter to true in the ServiceConnectConfiguration . You can set the namespace
// of each service individually in the ServiceConnectConfiguration to override
// this default parameter.
//
// Tasks that run in a namespace can use short names to connect to services in the
// namespace. Tasks can connect to services across all of the clusters in the
// namespace. Tasks connect through a managed proxy container that collects logs
// and metrics for increased visibility. Only the tasks that Amazon ECS services
// create are supported with Service Connect. For more information, see [Service Connect]in the
// Amazon Elastic Container Service Developer Guide.
//
// [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html
ServiceConnectDefaults *ClusterServiceConnectDefaults
// The settings for the cluster. This parameter indicates whether CloudWatch
// Container Insights is on or off for a cluster.
Settings []ClusterSetting
// Additional information about your clusters that are separated by launch type.
// They include the following:
//
// - runningEC2TasksCount
//
// - RunningFargateTasksCount
//
// - pendingEC2TasksCount
//
// - pendingFargateTasksCount
//
// - activeEC2ServiceCount
//
// - activeFargateServiceCount
//
// - drainingEC2ServiceCount
//
// - drainingFargateServiceCount
Statistics []KeyValuePair
// The status of the cluster. The following are the possible states that are
// returned.
//
// ACTIVE The cluster is ready to accept tasks and if applicable you can register
// container instances with the cluster.
//
// PROVISIONING The cluster has capacity providers that are associated with it and
// the resources needed for the capacity provider are being created.
//
// DEPROVISIONING The cluster has capacity providers that are associated with it
// and the resources needed for the capacity provider are being deleted.
//
// FAILED The cluster has capacity providers that are associated with it and the
// resources needed for the capacity provider have failed to create.
//
// INACTIVE The cluster has been deleted. Clusters with an INACTIVE status may
// remain discoverable in your account for a period of time. However, this behavior
// is subject to change in the future. We don't recommend that you rely on INACTIVE
// clusters persisting.
Status *string
// The metadata that you apply to the cluster to help you categorize and organize
// them. Each tag consists of a key and an optional value. You define both.
//
// The following basic restrictions apply to tags:
//
// - Maximum number of tags per resource - 50
//
// - For each resource, each tag key must be unique, and each tag key can have
// only one value.
//
// - Maximum key length - 128 Unicode characters in UTF-8
//
// - Maximum value length - 256 Unicode characters in UTF-8
//
// - If your tagging schema is used across multiple services and resources,
// remember that other services may have restrictions on allowed characters.
// Generally allowed characters are: letters, numbers, and spaces representable in
// UTF-8, and the following characters: + - = . _ : / @.
//
// - Tag keys and values are case-sensitive.
//
// - Do not use aws: , AWS: , or any upper or lowercase combination of such as a
// prefix for either keys or values as it is reserved for Amazon Web Services use.
// You cannot edit or delete tag keys or values with this prefix. Tags with this
// prefix do not count against your tags per resource limit.
Tags []Tag
noSmithyDocumentSerde
}
// The execute command and managed storage configuration for the cluster.
type ClusterConfiguration struct {
// The details of the execute command configuration.
ExecuteCommandConfiguration *ExecuteCommandConfiguration
// The details of the managed storage configuration.
ManagedStorageConfiguration *ManagedStorageConfiguration
noSmithyDocumentSerde
}
// Use this parameter to set a default Service Connect namespace. After you set a
// default Service Connect namespace, any new services with Service Connect turned
// on that are created in the cluster are added as client services in the
// namespace. This setting only applies to new services that set the enabled
// parameter to true in the ServiceConnectConfiguration . You can set the namespace
// of each service individually in the ServiceConnectConfiguration to override
// this default parameter.
//
// Tasks that run in a namespace can use short names to connect to services in the
// namespace. Tasks can connect to services across all of the clusters in the
// namespace. Tasks connect through a managed proxy container that collects logs
// and metrics for increased visibility. Only the tasks that Amazon ECS services
// create are supported with Service Connect. For more information, see [Service Connect]in the
// Amazon Elastic Container Service Developer Guide.
//
// [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html
type ClusterServiceConnectDefaults struct {
// The namespace name or full Amazon Resource Name (ARN) of the Cloud Map
// namespace. When you create a service and don't specify a Service Connect
// configuration, this namespace is used.
Namespace *string
noSmithyDocumentSerde
}
// Use this parameter to set a default Service Connect namespace. After you set a
// default Service Connect namespace, any new services with Service Connect turned
// on that are created in the cluster are added as client services in the
// namespace. This setting only applies to new services that set the enabled
// parameter to true in the ServiceConnectConfiguration . You can set the namespace
// of each service individually in the ServiceConnectConfiguration to override
// this default parameter.
//
// Tasks that run in a namespace can use short names to connect to services in the
// namespace. Tasks can connect to services across all of the clusters in the
// namespace. Tasks connect through a managed proxy container that collects logs
// and metrics for increased visibility. Only the tasks that Amazon ECS services
// create are supported with Service Connect. For more information, see [Service Connect]in the
// Amazon Elastic Container Service Developer Guide.
//
// [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html
type ClusterServiceConnectDefaultsRequest struct {
// The namespace name or full Amazon Resource Name (ARN) of the Cloud Map
// namespace that's used when you create a service and don't specify a Service
// Connect configuration. The namespace name can include up to 1024 characters. The
// name is case-sensitive. The name can't include hyphens (-), tilde (~), greater
// than (>), less than (<), or slash (/).
//
// If you enter an existing namespace name or ARN, then that namespace will be
// used. Any namespace type is supported. The namespace must be in this account and
// this Amazon Web Services Region.
//
// If you enter a new name, a Cloud Map namespace will be created. Amazon ECS
// creates a Cloud Map namespace with the "API calls" method of instance discovery
// only. This instance discovery method is the "HTTP" namespace type in the Command
// Line Interface. Other types of instance discovery aren't used by Service
// Connect.
//
// If you update the cluster with an empty string "" for the namespace name, the
// cluster configuration for Service Connect is removed. Note that the namespace
// will remain in Cloud Map and must be deleted separately.
//
// For more information about Cloud Map, see [Working with Services] in the Cloud Map Developer Guide.
//
// [Working with Services]: https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html
//
// This member is required.
Namespace *string
noSmithyDocumentSerde
}
// The settings to use when creating a cluster. This parameter is used to turn on
// CloudWatch Container Insights for a cluster.
type ClusterSetting struct {
// The name of the cluster setting. The value is containerInsights .
Name ClusterSettingName
// The value to set for the cluster setting. The supported values are enabled and
// disabled .
//
// If you set name to containerInsights and value to enabled , CloudWatch Container
// Insights will be on for the cluster, otherwise it will be off unless the
// containerInsights account setting is turned on. If a cluster value is specified,
// it will override the containerInsights value set with [PutAccountSetting] or [PutAccountSettingDefault].
//
// [PutAccountSettingDefault]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html
// [PutAccountSetting]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html
Value *string
noSmithyDocumentSerde
}
// A Docker container that's part of a task.
type Container struct {
// The Amazon Resource Name (ARN) of the container.
ContainerArn *string
// The number of CPU units set for the container. The value is 0 if no value was
// specified in the container definition when the task definition was registered.
Cpu *string
// The exit code returned from the container.
ExitCode *int32
// The IDs of each GPU assigned to the container.
GpuIds []string
// The health status of the container. If health checks aren't configured for this
// container in its task definition, then it reports the health status as UNKNOWN .
HealthStatus HealthStatus
// The image used for the container.
Image *string
// The container image manifest digest.
ImageDigest *string
// The last known status of the container.
LastStatus *string
// The details of any Amazon ECS managed agents associated with the container.
ManagedAgents []ManagedAgent
// The hard limit (in MiB) of memory set for the container.
Memory *string
// The soft limit (in MiB) of memory set for the container.
MemoryReservation *string
// The name of the container.
Name *string
// The network bindings associated with the container.
NetworkBindings []NetworkBinding
// The network interfaces associated with the container.
NetworkInterfaces []NetworkInterface
// A short (255 max characters) human-readable string to provide additional
// details about a running or stopped container.
Reason *string
// The ID of the Docker container.
RuntimeId *string
// The ARN of the task.
TaskArn *string
noSmithyDocumentSerde
}
// Container definitions are used in task definitions to describe the different
// containers that are launched as part of a task.
type ContainerDefinition struct {
// The command that's passed to the container. This parameter maps to Cmd in the [Create a container]
// section of the [Docker Remote API]and the COMMAND parameter to [docker run]. For more information, see [https://docs.docker.com/engine/reference/builder/#cmd]. If
// there are multiple arguments, each argument is a separated string in the array.
//
// [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration
// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/
// [https://docs.docker.com/engine/reference/builder/#cmd]: https://docs.docker.com/engine/reference/builder/#cmd
Command []string
// The number of cpu units reserved for the container. This parameter maps to
// CpuShares in the [Create a container] section of the [Docker Remote API] and the --cpu-shares option to [docker run].
//
// This field is optional for tasks using the Fargate launch type, and the only
// requirement is that the total amount of CPU reserved for all containers within a
// task be lower than the task-level cpu value.
//
// You can determine the number of CPU units that are available per EC2 instance
// type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances]detail page
// by 1,024.
//
// Linux containers share unallocated CPU units with other containers on the
// container instance with the same ratio as their allocated amount. For example,
// if you run a single-container task on a single-core instance type with 512 CPU
// units specified for that container, and that's the only task running on the
// container instance, that container could use the full 1,024 CPU unit share at
// any given time. However, if you launched another copy of the same task on that
// container instance, each task is guaranteed a minimum of 512 CPU units when
// needed. Moreover, each container could float to higher CPU usage if the other
// container was not using it. If both tasks were 100% active all of the time, they
// would be limited to 512 CPU units.
//
// On Linux container instances, the Docker daemon on the container instance uses
// the CPU value to calculate the relative CPU share ratios for running containers.
// For more information, see [CPU share constraint]in the Docker documentation. The minimum valid CPU
// share value that the Linux kernel allows is 2. However, the CPU parameter isn't
// required, and you can use CPU values below 2 in your container definitions. For
// CPU values below 2 (including null), the behavior varies based on your Amazon
// ECS container agent version:
//
// - Agent versions less than or equal to 1.1.0: Null and zero CPU values are
// passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU
// values of 1 are passed to Docker as 1, which the Linux kernel converts to two
// CPU shares.
//
// - Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values
// of 1 are passed to Docker as 2.
//
// On Windows container instances, the CPU limit is enforced as an absolute limit,
// or a quota. Windows containers only have access to the specified amount of CPU
// that's described in the task definition. A null or zero CPU value is passed to
// Docker as 0 , which Windows interprets as 1% of one CPU.
//
// [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration
// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
// [CPU share constraint]: https://docs.docker.com/engine/reference/run/#cpu-share-constraint
// [Amazon EC2 Instances]: http://aws.amazon.com/ec2/instance-types/
// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/
Cpu int32
// A list of ARNs in SSM or Amazon S3 to a credential spec ( CredSpec ) file that
// configures the container for Active Directory authentication. We recommend that
// you use this parameter instead of the dockerSecurityOptions . The maximum number
// of ARNs is 1.
//
// There are two formats for each ARN.
//
// credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to
// provide a CredSpec with an additional section for a secret in Secrets Manager.
// You provide the login credentials to the domain in the secret.
//
// Each task that runs on any container instance can join different domains.
//
// You can use this format without joining the container instance to a domain.
//
// credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a
// single domain.
//
// You must join the container instance to the domain before you start any tasks
// that use this task definition.
//
// In both formats, replace MyARN with the ARN in SSM or Amazon S3.
//
// If you provide a credentialspecdomainless:MyARN , the credspec must provide a
// ARN in Secrets Manager for a secret containing the username, password, and the
// domain to connect to. For better security, the instance isn't joined to the
// domain for domainless authentication. Other applications on the instance can't
// use the domainless credentials. You can use this parameter to run tasks on the
// same instance, even it the tasks need to join different domains. For more
// information, see [Using gMSAs for Windows Containers]and [Using gMSAs for Linux Containers].
//
// [Using gMSAs for Windows Containers]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html
// [Using gMSAs for Linux Containers]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html
CredentialSpecs []string
// The dependencies defined for container startup and shutdown. A container can
// contain multiple dependencies on other containers in a task definition. When a
// dependency is defined for container startup, for container shutdown it is
// reversed.
//
// For tasks using the EC2 launch type, the container instances require at least
// version 1.26.0 of the container agent to turn on container dependencies.
// However, we recommend using the latest container agent version. For information
// about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent]in
// the Amazon Elastic Container Service Developer Guide. If you're using an Amazon
// ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
// ecs-init package. If your container instances are launched from version 20190301
// or later, then they contain the required versions of the container agent and
// ecs-init . For more information, see [Amazon ECS-optimized Linux AMI] in the Amazon Elastic Container Service
// Developer Guide.
//
// For tasks using the Fargate launch type, the task or service requires the
// following platforms:
//
// - Linux platform version 1.3.0 or later.
//
// - Windows platform version 1.0.0 or later.
//
// [Updating the Amazon ECS Container Agent]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html
// [Amazon ECS-optimized Linux AMI]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html
DependsOn []ContainerDependency
// When this parameter is true, networking is off within the container. This
// parameter maps to NetworkDisabled in the [Create a container] section of the [Docker Remote API].
//
// This parameter is not supported for Windows containers.
//
// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/
DisableNetworking *bool
// A list of DNS search domains that are presented to the container. This
// parameter maps to DnsSearch in the [Create a container] section of the [Docker Remote API] and the --dns-search option
// to [docker run].
//
// This parameter is not supported for Windows containers.
//
// [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration
// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/
DnsSearchDomains []string
// A list of DNS servers that are presented to the container. This parameter maps
// to Dns in the [Create a container] section of the [Docker Remote API] and the --dns option to [docker run].
//
// This parameter is not supported for Windows containers.
//
// [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration
// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/
DnsServers []string
// A key/value map of labels to add to the container. This parameter maps to Labels
// in the [Create a container]section of the [Docker Remote API] and the --label option to [docker run]. This parameter requires
// version 1.18 of the Docker Remote API or greater on your container instance. To
// check the Docker Remote API version on your container instance, log in to your
// container instance and run the following command: sudo docker version --format
// '{{.Server.APIVersion}}'
//
// [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration
// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/
DockerLabels map[string]string
// A list of strings to provide custom configuration for multiple security
// systems. For more information about valid values, see [Docker Run Security Configuration]. This field isn't valid
// for containers in tasks using the Fargate launch type.
//
// For Linux tasks on EC2, this parameter can be used to reference custom labels
// for SELinux and AppArmor multi-level security systems.
//
// For any tasks on EC2, this parameter can be used to reference a credential spec
// file that configures a container for Active Directory authentication. For more
// information, see [Using gMSAs for Windows Containers]and [Using gMSAs for Linux Containers] in the Amazon Elastic Container Service Developer Guide.
//
// This parameter maps to SecurityOpt in the [Create a container] section of the [Docker Remote API] and the
// --security-opt option to [docker run].
//
// The Amazon ECS container agent running on a container instance must register
// with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment
// variables before containers placed on that instance can use these security
// options. For more information, see [Amazon ECS Container Agent Configuration]in the Amazon Elastic Container Service
// Developer Guide.
//
// For more information about valid values, see [Docker Run Security Configuration].
//
// Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" |
// "credentialspec:CredentialSpecFilePath"
//
// [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration
// [Docker Run Security Configuration]: https://docs.docker.com/engine/reference/run/#security-configuration
// [Using gMSAs for Windows Containers]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html
// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
// [Using gMSAs for Linux Containers]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html
// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/
// [Amazon ECS Container Agent Configuration]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html
DockerSecurityOptions []string
// Early versions of the Amazon ECS container agent don't properly handle
// entryPoint parameters. If you have problems using entryPoint , update your
// container agent or enter your commands and arguments as command array items
// instead.
//
// The entry point that's passed to the container. This parameter maps to
// Entrypoint in the [Create a container] section of the [Docker Remote API] and the --entrypoint option to [docker run]. For more
// information, see [https://docs.docker.com/engine/reference/builder/#entrypoint].
//
// [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration
// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
// [https://docs.docker.com/engine/reference/builder/#entrypoint]: https://docs.docker.com/engine/reference/builder/#entrypoint
// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/
EntryPoint []string
// The environment variables to pass to a container. This parameter maps to Env in
// the [Create a container]section of the [Docker Remote API] and the --env option to [docker run].
//
// We don't recommend that you use plaintext environment variables for sensitive
// information, such as credential data.
//
// [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration
// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/
Environment []KeyValuePair
// A list of files containing the environment variables to pass to a container.
// This parameter maps to the --env-file option to [docker run].
//
// You can specify up to ten environment files. The file must have a .env file
// extension. Each line in an environment file contains an environment variable in
// VARIABLE=VALUE format. Lines beginning with # are treated as comments and are
// ignored. For more information about the environment variable file syntax, see [Declare default environment variables in file].
//
// If there are environment variables specified using the environment parameter in
// a container definition, they take precedence over the variables contained within
// an environment file. If multiple environment files are specified that contain
// the same variable, they're processed from the top down. We recommend that you
// use unique variable names. For more information, see [Specifying Environment Variables]in the Amazon Elastic
// Container Service Developer Guide.
//
// [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration
// [Declare default environment variables in file]: https://docs.docker.com/compose/env-file/
// [Specifying Environment Variables]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html
EnvironmentFiles []EnvironmentFile
// If the essential parameter of a container is marked as true , and that container
// fails or stops for any reason, all other containers that are part of the task
// are stopped. If the essential parameter of a container is marked as false , its
// failure doesn't affect the rest of the containers in a task. If this parameter
// is omitted, a container is assumed to be essential.
//
// All tasks must have at least one essential container. If you have an
// application that's composed of multiple containers, group containers that are
// used for a common purpose into components, and separate the different components
// into multiple task definitions. For more information, see [Application Architecture]in the Amazon Elastic
// Container Service Developer Guide.
//
// [Application Architecture]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html
Essential *bool
// A list of hostnames and IP address mappings to append to the /etc/hosts file on
// the container. This parameter maps to ExtraHosts in the [Create a container] section of the [Docker Remote API] and
// the --add-host option to [docker run].
//
// This parameter isn't supported for Windows containers or tasks that use the
// awsvpc network mode.
//
// [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration
// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/
ExtraHosts []HostEntry
// The FireLens configuration for the container. This is used to specify and
// configure a log router for container logs. For more information, see [Custom Log Routing]in the
// Amazon Elastic Container Service Developer Guide.
//
// [Custom Log Routing]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html
FirelensConfiguration *FirelensConfiguration
// The container health check command and associated configuration parameters for
// the container. This parameter maps to HealthCheck in the [Create a container] section of the [Docker Remote API] and
// the HEALTHCHECK parameter of [docker run].
//
// [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration
// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/
HealthCheck *HealthCheck
// The hostname to use for your container. This parameter maps to Hostname in the [Create a container]
// section of the [Docker Remote API]and the --hostname option to [docker run].
//
// The hostname parameter is not supported if you're using the awsvpc network mode.
//
// [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration
// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/
Hostname *string
// The image used to start a container. This string is passed directly to the
// Docker daemon. By default, images in the Docker Hub registry are available.
// Other repositories are specified with either repository-url/image:tag or
// repository-url/image@digest . Up to 255 letters (uppercase and lowercase),
// numbers, hyphens, underscores, colons, periods, forward slashes, and number
// signs are allowed. This parameter maps to Image in the [Create a container] section of the [Docker Remote API] and the
// IMAGE parameter of [docker run].
//
// - When a new task starts, the Amazon ECS container agent pulls the latest
// version of the specified image and tag for the container to use. However,
// subsequent updates to a repository image aren't propagated to already running
// tasks.
//
// - Images in Amazon ECR repositories can be specified by either using the full
// registry/repository:tag or registry/repository@digest . For example,
// 012345678910.dkr.ecr..amazonaws.com/:latest or
// 012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
// .
//
// - Images in official repositories on Docker Hub use a single name (for
// example, ubuntu or mongo ).
//
// - Images in other repositories on Docker Hub are qualified with an
// organization name (for example, amazon/amazon-ecs-agent ).
//
// - Images in other online repositories are qualified further by a domain name
// (for example, quay.io/assemblyline/ubuntu ).
//
// [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration
// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/
Image *string
// When this parameter is true , you can deploy containerized applications that
// require stdin or a tty to be allocated. This parameter maps to OpenStdin in the [Create a container]
// section of the [Docker Remote API]and the --interactive option to [docker run].
//
// [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration
// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/
Interactive *bool
// The links parameter allows containers to communicate with each other without
// the need for port mappings. This parameter is only supported if the network mode
// of a task definition is bridge . The name:internalName construct is analogous
// to name:alias in Docker links. Up to 255 letters (uppercase and lowercase),
// numbers, underscores, and hyphens are allowed. For more information about
// linking Docker containers, go to [Legacy container links]in the Docker documentation. This parameter
// maps to Links in the [Create a container] section of the [Docker Remote API] and the --link option to [docker run].
//
// This parameter is not supported for Windows containers.
//
// Containers that are collocated on a single container instance may be able to
// communicate with each other without requiring links or host port mappings.
// Network isolation is achieved on the container instance using security groups
// and VPC settings.
//
// [Legacy container links]: https://docs.docker.com/network/links/
// [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration
// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate
// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/
Links []string
// Linux-specific modifications that are applied to the container, such as Linux
// kernel capabilities. For more information see KernelCapabilities.
//
// This parameter is not supported for Windows containers.
LinuxParameters *LinuxParameters
// The log configuration specification for the container.
//