@aws-sdk/client-ecs 3.40.0 → 3.41.0
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.
- package/CHANGELOG.md +11 -0
- package/README.md +7 -7
- package/dist-cjs/endpoints.js +8 -0
- package/dist-cjs/models/models_0.js +29 -5
- package/dist-cjs/protocols/Aws_json1_1.js +33 -0
- package/dist-es/endpoints.js +8 -0
- package/dist-es/models/models_0.js +20 -0
- package/dist-es/protocols/Aws_json1_1.js +33 -0
- package/dist-types/ECS.d.ts +147 -152
- package/dist-types/ECSClient.d.ts +7 -7
- package/dist-types/commands/CreateCapacityProviderCommand.d.ts +5 -5
- package/dist-types/commands/CreateClusterCommand.d.ts +5 -5
- package/dist-types/commands/CreateServiceCommand.d.ts +52 -51
- package/dist-types/commands/CreateTaskSetCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAttributesCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +4 -4
- package/dist-types/commands/DeleteClusterCommand.d.ts +5 -6
- package/dist-types/commands/DeleteServiceCommand.d.ts +2 -2
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +8 -7
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +8 -9
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeClustersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeServicesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTasksCommand.d.ts +1 -1
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +2 -3
- package/dist-types/commands/ExecuteCommandCommand.d.ts +1 -1
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +1 -1
- package/dist-types/commands/ListAttributesCommand.d.ts +4 -4
- package/dist-types/commands/ListClustersCommand.d.ts +1 -1
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +1 -1
- package/dist-types/commands/ListServicesCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +7 -7
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +1 -1
- package/dist-types/commands/ListTasksCommand.d.ts +1 -1
- package/dist-types/commands/PutAccountSettingCommand.d.ts +6 -6
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +1 -1
- package/dist-types/commands/PutAttributesCommand.d.ts +3 -3
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +7 -7
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +3 -4
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +2 -2
- package/dist-types/commands/RunTaskCommand.d.ts +6 -6
- package/dist-types/commands/StartTaskCommand.d.ts +1 -1
- package/dist-types/commands/StopTaskCommand.d.ts +1 -1
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +2 -3
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +2 -3
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +2 -3
- package/dist-types/commands/TagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +1 -1
- package/dist-types/commands/UpdateClusterCommand.d.ts +1 -1
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +4 -4
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +6 -6
- package/dist-types/commands/UpdateServiceCommand.d.ts +16 -16
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +1034 -948
- package/dist-types/ts3.4/models/models_0.d.ts +38 -0
- package/package.json +4 -4
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
|
|
2
2
|
/**
|
|
3
|
-
* <p>You
|
|
3
|
+
* <p>You don't have authorization to perform the requested action.</p>
|
|
4
4
|
*/
|
|
5
5
|
export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
|
|
6
6
|
name: "AccessDeniedException";
|
|
@@ -22,9 +22,9 @@ export declare enum AgentUpdateStatus {
|
|
|
22
22
|
UPDATING = "UPDATING"
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
|
-
* <p>These errors are usually caused by a client action
|
|
26
|
-
* resource on behalf of a user that doesn't have permissions to use the
|
|
27
|
-
* resource,
|
|
25
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
26
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
27
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
28
28
|
*/
|
|
29
29
|
export interface ClientException extends __SmithyException, $MetadataBearer {
|
|
30
30
|
name: "ClientException";
|
|
@@ -44,31 +44,31 @@ export declare enum ManagedScalingStatus {
|
|
|
44
44
|
/**
|
|
45
45
|
* <p>The managed scaling settings for the Auto Scaling group capacity provider.</p>
|
|
46
46
|
* <p>When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of
|
|
47
|
-
* the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an
|
|
48
|
-
*
|
|
49
|
-
*
|
|
47
|
+
* the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS
|
|
48
|
+
* managed CloudWatch metric with the specified <code>targetCapacity</code> value as the target
|
|
49
|
+
* value for the metric. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html#asg-capacity-providers-managed-scaling">Using Managed Scaling</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
50
50
|
* <p>If managed scaling is disabled, the user must manage the scaling of the Auto Scaling
|
|
51
51
|
* group.</p>
|
|
52
52
|
*/
|
|
53
53
|
export interface ManagedScaling {
|
|
54
54
|
/**
|
|
55
|
-
* <p>
|
|
55
|
+
* <p>Determines whether to enable managed scaling for the capacity provider.</p>
|
|
56
56
|
*/
|
|
57
57
|
status?: ManagedScalingStatus | string;
|
|
58
58
|
/**
|
|
59
59
|
* <p>The target capacity value for the capacity provider. The specified value must be
|
|
60
60
|
* greater than <code>0</code> and less than or equal to <code>100</code>. A value of
|
|
61
|
-
* <code>100</code>
|
|
62
|
-
* completely
|
|
61
|
+
* <code>100</code> results in the Amazon EC2 instances in your Auto Scaling group being
|
|
62
|
+
* completely used.</p>
|
|
63
63
|
*/
|
|
64
64
|
targetCapacity?: number;
|
|
65
65
|
/**
|
|
66
|
-
* <p>The minimum number of container instances that Amazon ECS
|
|
66
|
+
* <p>The minimum number of container instances that Amazon ECS scales in or scales out at one
|
|
67
67
|
* time. If this parameter is omitted, the default value of <code>1</code> is used.</p>
|
|
68
68
|
*/
|
|
69
69
|
minimumScalingStepSize?: number;
|
|
70
70
|
/**
|
|
71
|
-
* <p>The maximum number of container instances that Amazon ECS
|
|
71
|
+
* <p>The maximum number of container instances that Amazon ECS scales in or scales out at one
|
|
72
72
|
* time. If this parameter is omitted, the default value of <code>10000</code> is
|
|
73
73
|
* used.</p>
|
|
74
74
|
*/
|
|
@@ -108,14 +108,14 @@ export interface AutoScalingGroupProvider {
|
|
|
108
108
|
* protection.</p>
|
|
109
109
|
* <important>
|
|
110
110
|
* <p>When using managed termination protection, managed scaling must also be used
|
|
111
|
-
* otherwise managed termination protection
|
|
111
|
+
* otherwise managed termination protection doesn't work.</p>
|
|
112
112
|
* </important>
|
|
113
113
|
* <p>When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in
|
|
114
114
|
* an Auto Scaling group that contain tasks from being terminated during a scale-in action.
|
|
115
115
|
* The Auto Scaling group and each instance in the Auto Scaling group must have instance
|
|
116
116
|
* protection from scale-in actions enabled as well. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection">Instance Protection</a> in the <i>Auto Scaling User Guide</i>.</p>
|
|
117
|
-
* <p>When managed termination protection is disabled, your Amazon EC2 instances
|
|
118
|
-
*
|
|
117
|
+
* <p>When managed termination protection is disabled, your Amazon EC2 instances aren't protected
|
|
118
|
+
* from termination when the Auto Scaling group scales in.</p>
|
|
119
119
|
*/
|
|
120
120
|
managedTerminationProtection?: ManagedTerminationProtection | string;
|
|
121
121
|
}
|
|
@@ -127,7 +127,7 @@ export declare namespace AutoScalingGroupProvider {
|
|
|
127
127
|
}
|
|
128
128
|
/**
|
|
129
129
|
* <p>The metadata that you apply to a resource to help you categorize and organize them.
|
|
130
|
-
* Each tag consists of a key and an optional value
|
|
130
|
+
* Each tag consists of a key and an optional value. You define them.</p>
|
|
131
131
|
* <p>The following basic restrictions apply to tags:</p>
|
|
132
132
|
* <ul>
|
|
133
133
|
* <li>
|
|
@@ -180,9 +180,10 @@ export declare namespace Tag {
|
|
|
180
180
|
}
|
|
181
181
|
export interface CreateCapacityProviderRequest {
|
|
182
182
|
/**
|
|
183
|
-
* <p>The name of the capacity provider. Up to 255 characters are allowed
|
|
184
|
-
* (upper and lowercase), numbers, underscores, and hyphens.
|
|
185
|
-
* with "<code>aws</code>", "<code>ecs</code>", or
|
|
183
|
+
* <p>The name of the capacity provider. Up to 255 characters are allowed. They include
|
|
184
|
+
* letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-).
|
|
185
|
+
* The name can't be prefixed with "<code>aws</code>", "<code>ecs</code>", or
|
|
186
|
+
* "<code>fargate</code>".</p>
|
|
186
187
|
*/
|
|
187
188
|
name: string | undefined;
|
|
188
189
|
/**
|
|
@@ -190,10 +191,10 @@ export interface CreateCapacityProviderRequest {
|
|
|
190
191
|
*/
|
|
191
192
|
autoScalingGroupProvider: AutoScalingGroupProvider | undefined;
|
|
192
193
|
/**
|
|
193
|
-
* <p>The metadata that you apply to the capacity provider to
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
*
|
|
194
|
+
* <p>The metadata that you apply to the capacity provider to categorize and organize them
|
|
195
|
+
* more conveniently. Each tag consists of a key and an optional value. You define both of
|
|
196
|
+
* them.</p>
|
|
197
|
+
* <p>The following basic restrictions apply to tags:</p>
|
|
197
198
|
* <ul>
|
|
198
199
|
* <li>
|
|
199
200
|
* <p>Maximum number of tags per resource - 50</p>
|
|
@@ -246,7 +247,7 @@ export declare enum CapacityProviderUpdateStatus {
|
|
|
246
247
|
UPDATE_IN_PROGRESS = "UPDATE_IN_PROGRESS"
|
|
247
248
|
}
|
|
248
249
|
/**
|
|
249
|
-
* <p>The details
|
|
250
|
+
* <p>The details for a capacity provider.</p>
|
|
250
251
|
*/
|
|
251
252
|
export interface CapacityProvider {
|
|
252
253
|
/**
|
|
@@ -260,7 +261,7 @@ export interface CapacityProvider {
|
|
|
260
261
|
/**
|
|
261
262
|
* <p>The current status of the capacity provider. Only capacity providers in an
|
|
262
263
|
* <code>ACTIVE</code> state can be used in a cluster. When a capacity provider is
|
|
263
|
-
* successfully deleted, it
|
|
264
|
+
* successfully deleted, it has an <code>INACTIVE</code> status.</p>
|
|
264
265
|
*/
|
|
265
266
|
status?: CapacityProviderStatus | string;
|
|
266
267
|
/**
|
|
@@ -269,7 +270,7 @@ export interface CapacityProvider {
|
|
|
269
270
|
autoScalingGroupProvider?: AutoScalingGroupProvider;
|
|
270
271
|
/**
|
|
271
272
|
* <p>The update status of the capacity provider. The following are the possible states that
|
|
272
|
-
*
|
|
273
|
+
* is returned.</p>
|
|
273
274
|
* <dl>
|
|
274
275
|
* <dt>DELETE_IN_PROGRESS</dt>
|
|
275
276
|
* <dd>
|
|
@@ -277,13 +278,13 @@ export interface CapacityProvider {
|
|
|
277
278
|
* </dd>
|
|
278
279
|
* <dt>DELETE_COMPLETE</dt>
|
|
279
280
|
* <dd>
|
|
280
|
-
* <p>The capacity provider
|
|
281
|
+
* <p>The capacity provider was successfully deleted and has an
|
|
281
282
|
* <code>INACTIVE</code> status.</p>
|
|
282
283
|
* </dd>
|
|
283
284
|
* <dt>DELETE_FAILED</dt>
|
|
284
285
|
* <dd>
|
|
285
|
-
* <p>The capacity provider
|
|
286
|
-
*
|
|
286
|
+
* <p>The capacity provider can't be deleted. The update status reason provides
|
|
287
|
+
* further details about why the delete failed.</p>
|
|
287
288
|
* </dd>
|
|
288
289
|
* </dl>
|
|
289
290
|
*/
|
|
@@ -295,9 +296,8 @@ export interface CapacityProvider {
|
|
|
295
296
|
updateStatusReason?: string;
|
|
296
297
|
/**
|
|
297
298
|
* <p>The metadata that you apply to the capacity provider to help you categorize and
|
|
298
|
-
* organize it. Each tag consists of a key and an optional value
|
|
299
|
-
*
|
|
300
|
-
* <p>The following basic restrictions apply to tags:</p>
|
|
299
|
+
* organize it. Each tag consists of a key and an optional value. You define both.</p>
|
|
300
|
+
* <p>The following basic restrictions apply to tags:</p>
|
|
301
301
|
* <ul>
|
|
302
302
|
* <li>
|
|
303
303
|
* <p>Maximum number of tags per resource - 50</p>
|
|
@@ -350,7 +350,7 @@ export declare namespace CreateCapacityProviderResponse {
|
|
|
350
350
|
const filterSensitiveLog: (obj: CreateCapacityProviderResponse) => any;
|
|
351
351
|
}
|
|
352
352
|
/**
|
|
353
|
-
* <p>The specified parameter
|
|
353
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
354
354
|
* request.</p>
|
|
355
355
|
*/
|
|
356
356
|
export interface InvalidParameterException extends __SmithyException, $MetadataBearer {
|
|
@@ -365,7 +365,7 @@ export declare namespace InvalidParameterException {
|
|
|
365
365
|
const filterSensitiveLog: (obj: InvalidParameterException) => any;
|
|
366
366
|
}
|
|
367
367
|
/**
|
|
368
|
-
* <p>The limit for the resource
|
|
368
|
+
* <p>The limit for the resource was exceeded.</p>
|
|
369
369
|
*/
|
|
370
370
|
export interface LimitExceededException extends __SmithyException, $MetadataBearer {
|
|
371
371
|
name: "LimitExceededException";
|
|
@@ -393,8 +393,8 @@ export declare namespace ServerException {
|
|
|
393
393
|
const filterSensitiveLog: (obj: ServerException) => any;
|
|
394
394
|
}
|
|
395
395
|
/**
|
|
396
|
-
* <p>There
|
|
397
|
-
*
|
|
396
|
+
* <p>There's already a current Amazon ECS container agent update in progress on the container
|
|
397
|
+
* instance that's specified. If the container agent becomes disconnected while it's in a
|
|
398
398
|
* transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update
|
|
399
399
|
* process can get stuck in that state. However, when the agent reconnects, it resumes
|
|
400
400
|
* where it stopped previously.</p>
|
|
@@ -423,7 +423,7 @@ export interface ExecuteCommandLogConfiguration {
|
|
|
423
423
|
*/
|
|
424
424
|
cloudWatchLogGroupName?: string;
|
|
425
425
|
/**
|
|
426
|
-
* <p>
|
|
426
|
+
* <p>Determines whether to enable encryption on the CloudWatch logs. If not specified,
|
|
427
427
|
* encryption will be disabled.</p>
|
|
428
428
|
*/
|
|
429
429
|
cloudWatchEncryptionEnabled?: boolean;
|
|
@@ -435,8 +435,8 @@ export interface ExecuteCommandLogConfiguration {
|
|
|
435
435
|
*/
|
|
436
436
|
s3BucketName?: string;
|
|
437
437
|
/**
|
|
438
|
-
* <p>
|
|
439
|
-
*
|
|
438
|
+
* <p>Determines whether to use encryption on the S3 logs. If not specified, encryption is
|
|
439
|
+
* not used.</p>
|
|
440
440
|
*/
|
|
441
441
|
s3EncryptionEnabled?: boolean;
|
|
442
442
|
/**
|
|
@@ -531,7 +531,7 @@ export declare namespace ClusterConfiguration {
|
|
|
531
531
|
* <code>FARGATE_SPOT</code> capacity providers. The Fargate capacity providers are
|
|
532
532
|
* available to all accounts and only need to be associated with a cluster to be used in a
|
|
533
533
|
* capacity provider strategy.</p>
|
|
534
|
-
*
|
|
534
|
+
* <p>A capacity provider strategy may contain a maximum of 6 capacity providers.</p>
|
|
535
535
|
*/
|
|
536
536
|
export interface CapacityProviderStrategyItem {
|
|
537
537
|
/**
|
|
@@ -546,16 +546,16 @@ export interface CapacityProviderStrategyItem {
|
|
|
546
546
|
* <p>If no <code>weight</code> value is specified, the default value of <code>0</code> is
|
|
547
547
|
* used. When multiple capacity providers are specified within a capacity provider
|
|
548
548
|
* strategy, at least one of the capacity providers must have a weight value greater than
|
|
549
|
-
* zero and any capacity providers with a weight of <code>0</code>
|
|
550
|
-
*
|
|
551
|
-
*
|
|
552
|
-
*
|
|
549
|
+
* zero and any capacity providers with a weight of <code>0</code> can't be used to place
|
|
550
|
+
* tasks. If you specify multiple capacity providers in a strategy that all have a weight
|
|
551
|
+
* of <code>0</code>, any <code>RunTask</code> or <code>CreateService</code> actions using
|
|
552
|
+
* the capacity provider strategy will fail.</p>
|
|
553
553
|
* <p>An example scenario for using weights is defining a strategy that contains two
|
|
554
554
|
* capacity providers and both have a weight of <code>1</code>, then when the
|
|
555
555
|
* <code>base</code> is satisfied, the tasks will be split evenly across the two
|
|
556
556
|
* capacity providers. Using that same logic, if you specify a weight of <code>1</code> for
|
|
557
557
|
* <i>capacityProviderA</i> and a weight of <code>4</code> for
|
|
558
|
-
* <i>capacityProviderB</i>, then for every one task that
|
|
558
|
+
* <i>capacityProviderB</i>, then for every one task that's run using
|
|
559
559
|
* <i>capacityProviderA</i>, four tasks would use
|
|
560
560
|
* <i>capacityProviderB</i>.</p>
|
|
561
561
|
*/
|
|
@@ -605,13 +605,13 @@ export declare namespace ClusterSetting {
|
|
|
605
605
|
}
|
|
606
606
|
export interface CreateClusterRequest {
|
|
607
607
|
/**
|
|
608
|
-
* <p>The name of your cluster. If you
|
|
609
|
-
* cluster named <code>default</code>. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. </p>
|
|
608
|
+
* <p>The name of your cluster. If you don't specify a name for your cluster, you create a
|
|
609
|
+
* cluster that's named <code>default</code>. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. </p>
|
|
610
610
|
*/
|
|
611
611
|
clusterName?: string;
|
|
612
612
|
/**
|
|
613
613
|
* <p>The metadata that you apply to the cluster to help you categorize and organize them.
|
|
614
|
-
* Each tag consists of a key and an optional value
|
|
614
|
+
* Each tag consists of a key and an optional value. You define both.</p>
|
|
615
615
|
* <p>The following basic restrictions apply to tags:</p>
|
|
616
616
|
* <ul>
|
|
617
617
|
* <li>
|
|
@@ -647,13 +647,14 @@ export interface CreateClusterRequest {
|
|
|
647
647
|
tags?: Tag[];
|
|
648
648
|
/**
|
|
649
649
|
* <p>The setting to use when creating a cluster. This parameter is used to enable CloudWatch
|
|
650
|
-
* Container Insights for a cluster. If this value is specified, it
|
|
650
|
+
* Container Insights for a cluster. If this value is specified, it overrides the
|
|
651
651
|
* <code>containerInsights</code> value set with <a>PutAccountSetting</a> or
|
|
652
652
|
* <a>PutAccountSettingDefault</a>.</p>
|
|
653
653
|
*/
|
|
654
654
|
settings?: ClusterSetting[];
|
|
655
655
|
/**
|
|
656
|
-
* <p>The
|
|
656
|
+
* <p>The
|
|
657
|
+
* execute command configuration for the cluster.</p>
|
|
657
658
|
*/
|
|
658
659
|
configuration?: ClusterConfiguration;
|
|
659
660
|
/**
|
|
@@ -663,8 +664,9 @@ export interface CreateClusterRequest {
|
|
|
663
664
|
* strategy when calling the <a>CreateService</a> or <a>RunTask</a>
|
|
664
665
|
* actions.</p>
|
|
665
666
|
* <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity
|
|
666
|
-
* provider must
|
|
667
|
-
*
|
|
667
|
+
* provider must be created but not associated with another cluster. New Auto Scaling group
|
|
668
|
+
* capacity providers can be created with the <a>CreateCapacityProvider</a> API
|
|
669
|
+
* operation.</p>
|
|
668
670
|
* <p>To use a Fargate capacity provider, specify either the <code>FARGATE</code> or
|
|
669
671
|
* <code>FARGATE_SPOT</code> capacity providers. The Fargate capacity providers are
|
|
670
672
|
* available to all accounts and only need to be associated with a cluster to be
|
|
@@ -674,13 +676,13 @@ export interface CreateClusterRequest {
|
|
|
674
676
|
*/
|
|
675
677
|
capacityProviders?: string[];
|
|
676
678
|
/**
|
|
677
|
-
* <p>The capacity provider strategy to set as the default for the cluster.
|
|
678
|
-
* capacity provider strategy is set for a cluster, when
|
|
679
|
+
* <p>The capacity provider strategy to set as the default for the cluster. After a default
|
|
680
|
+
* capacity provider strategy is set for a cluster, when you call the <a>RunTask</a> or <a>CreateService</a> APIs with no capacity
|
|
679
681
|
* provider strategy or launch type specified, the default capacity provider strategy for
|
|
680
682
|
* the cluster is used.</p>
|
|
681
|
-
* <p>If a default capacity provider strategy
|
|
682
|
-
* it can be defined later with the <a>PutClusterCapacityProviders</a>
|
|
683
|
-
* operation.</p>
|
|
683
|
+
* <p>If a default capacity provider strategy isn't defined for a cluster when it was
|
|
684
|
+
* created, it can be defined later with the <a>PutClusterCapacityProviders</a>
|
|
685
|
+
* API operation.</p>
|
|
684
686
|
*/
|
|
685
687
|
defaultCapacityProviderStrategy?: CapacityProviderStrategyItem[];
|
|
686
688
|
}
|
|
@@ -742,7 +744,7 @@ export declare namespace Attachment {
|
|
|
742
744
|
const filterSensitiveLog: (obj: Attachment) => any;
|
|
743
745
|
}
|
|
744
746
|
/**
|
|
745
|
-
* <p>A regional grouping of one or more container instances
|
|
747
|
+
* <p>A regional grouping of one or more container instances where you can run task
|
|
746
748
|
* requests. Each account receives a default cluster the first time you use the Amazon ECS
|
|
747
749
|
* service, but you may also create other clusters. Clusters may contain more than one
|
|
748
750
|
* instance type simultaneously.</p>
|
|
@@ -761,7 +763,7 @@ export interface Cluster {
|
|
|
761
763
|
*/
|
|
762
764
|
configuration?: ClusterConfiguration;
|
|
763
765
|
/**
|
|
764
|
-
* <p>The status of the cluster. The following are the possible states that
|
|
766
|
+
* <p>The status of the cluster. The following are the possible states that are
|
|
765
767
|
* returned.</p>
|
|
766
768
|
* <dl>
|
|
767
769
|
* <dt>ACTIVE</dt>
|
|
@@ -771,25 +773,25 @@ export interface Cluster {
|
|
|
771
773
|
* </dd>
|
|
772
774
|
* <dt>PROVISIONING</dt>
|
|
773
775
|
* <dd>
|
|
774
|
-
* <p>The cluster has capacity providers associated with it and the
|
|
775
|
-
* needed for the capacity provider are being created.</p>
|
|
776
|
+
* <p>The cluster has capacity providers that are associated with it and the
|
|
777
|
+
* resources needed for the capacity provider are being created.</p>
|
|
776
778
|
* </dd>
|
|
777
779
|
* <dt>DEPROVISIONING</dt>
|
|
778
780
|
* <dd>
|
|
779
|
-
* <p>The cluster has capacity providers associated with it and the
|
|
780
|
-
* needed for the capacity provider are being deleted.</p>
|
|
781
|
+
* <p>The cluster has capacity providers that are associated with it and the
|
|
782
|
+
* resources needed for the capacity provider are being deleted.</p>
|
|
781
783
|
* </dd>
|
|
782
784
|
* <dt>FAILED</dt>
|
|
783
785
|
* <dd>
|
|
784
|
-
* <p>The cluster has capacity providers associated with it and the
|
|
785
|
-
* needed for the capacity provider have failed to create.</p>
|
|
786
|
+
* <p>The cluster has capacity providers that are associated with it and the
|
|
787
|
+
* resources needed for the capacity provider have failed to create.</p>
|
|
786
788
|
* </dd>
|
|
787
789
|
* <dt>INACTIVE</dt>
|
|
788
790
|
* <dd>
|
|
789
791
|
* <p>The cluster has been deleted. Clusters with an <code>INACTIVE</code>
|
|
790
792
|
* status may remain discoverable in your account for a period of time.
|
|
791
|
-
* However, this behavior is subject to change in the future
|
|
792
|
-
* rely on <code>INACTIVE</code> clusters persisting.</p>
|
|
793
|
+
* However, this behavior is subject to change in the future. We don't
|
|
794
|
+
* recommend that you rely on <code>INACTIVE</code> clusters persisting.</p>
|
|
793
795
|
* </dd>
|
|
794
796
|
* </dl>
|
|
795
797
|
*/
|
|
@@ -813,8 +815,8 @@ export interface Cluster {
|
|
|
813
815
|
*/
|
|
814
816
|
activeServicesCount?: number;
|
|
815
817
|
/**
|
|
816
|
-
* <p>Additional information about your clusters that are separated by launch type
|
|
817
|
-
*
|
|
818
|
+
* <p>Additional information about your clusters that are separated by launch type. They
|
|
819
|
+
* include the following:</p>
|
|
818
820
|
* <ul>
|
|
819
821
|
* <li>
|
|
820
822
|
* <p>runningEC2TasksCount</p>
|
|
@@ -845,7 +847,7 @@ export interface Cluster {
|
|
|
845
847
|
statistics?: KeyValuePair[];
|
|
846
848
|
/**
|
|
847
849
|
* <p>The metadata that you apply to the cluster to help you categorize and organize them.
|
|
848
|
-
* Each tag consists of a key and an optional value
|
|
850
|
+
* Each tag consists of a key and an optional value. You define both.</p>
|
|
849
851
|
* <p>The following basic restrictions apply to tags:</p>
|
|
850
852
|
* <ul>
|
|
851
853
|
* <li>
|
|
@@ -896,12 +898,12 @@ export interface Cluster {
|
|
|
896
898
|
defaultCapacityProviderStrategy?: CapacityProviderStrategyItem[];
|
|
897
899
|
/**
|
|
898
900
|
* <p>The resources attached to a cluster. When using a capacity provider with a cluster,
|
|
899
|
-
* the Auto Scaling plan that
|
|
901
|
+
* the Auto Scaling plan that's created is returned as a cluster attachment.</p>
|
|
900
902
|
*/
|
|
901
903
|
attachments?: Attachment[];
|
|
902
904
|
/**
|
|
903
905
|
* <p>The status of the capacity providers associated with the cluster. The following are
|
|
904
|
-
* the states that
|
|
906
|
+
* the states that are returned.</p>
|
|
905
907
|
* <dl>
|
|
906
908
|
* <dt>UPDATE_IN_PROGRESS</dt>
|
|
907
909
|
* <dd>
|
|
@@ -939,8 +941,7 @@ export declare namespace CreateClusterResponse {
|
|
|
939
941
|
const filterSensitiveLog: (obj: CreateClusterResponse) => any;
|
|
940
942
|
}
|
|
941
943
|
/**
|
|
942
|
-
* <p>The specified cluster
|
|
943
|
-
* <a>ListClusters</a>. Amazon ECS clusters are Region-specific.</p>
|
|
944
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
944
945
|
*/
|
|
945
946
|
export interface ClusterNotFoundException extends __SmithyException, $MetadataBearer {
|
|
946
947
|
name: "ClusterNotFoundException";
|
|
@@ -956,7 +957,7 @@ export declare namespace ClusterNotFoundException {
|
|
|
956
957
|
/**
|
|
957
958
|
* <note>
|
|
958
959
|
* <p>The deployment circuit breaker can only be used for services using the rolling
|
|
959
|
-
* update (<code>ECS</code>) deployment type that
|
|
960
|
+
* update (<code>ECS</code>) deployment type that aren't behind a Classic Load Balancer.</p>
|
|
960
961
|
* </note>
|
|
961
962
|
* <p>The <b>deployment circuit breaker</b> determines whether a
|
|
962
963
|
* service deployment will fail if the service can't reach a steady state. If enabled, a
|
|
@@ -967,13 +968,14 @@ export declare namespace ClusterNotFoundException {
|
|
|
967
968
|
*/
|
|
968
969
|
export interface DeploymentCircuitBreaker {
|
|
969
970
|
/**
|
|
970
|
-
* <p>
|
|
971
|
+
* <p>Determines whether to enable the deployment circuit breaker logic for the
|
|
972
|
+
* service.</p>
|
|
971
973
|
*/
|
|
972
974
|
enable: boolean | undefined;
|
|
973
975
|
/**
|
|
974
|
-
* <p>
|
|
975
|
-
* rollback is enabled, when a service deployment fails, the service is rolled
|
|
976
|
-
* last deployment that completed successfully.</p>
|
|
976
|
+
* <p>Determines whether to enable Amazon ECS to roll back the service if a service deployment
|
|
977
|
+
* fails. If rollback is enabled, when a service deployment fails, the service is rolled
|
|
978
|
+
* back to the last deployment that completed successfully.</p>
|
|
977
979
|
*/
|
|
978
980
|
rollback: boolean | undefined;
|
|
979
981
|
}
|
|
@@ -1033,10 +1035,10 @@ export interface DeploymentConfiguration {
|
|
|
1033
1035
|
* if your service has a desired number of four tasks and a minimum healthy percent of 50%,
|
|
1034
1036
|
* the scheduler may stop two existing tasks to free up cluster capacity before starting
|
|
1035
1037
|
* two new tasks. Tasks for services that <i>do not</i> use a load balancer
|
|
1036
|
-
* are considered healthy if they
|
|
1037
|
-
* that <i>do</i> use a load balancer are considered healthy if they
|
|
1038
|
-
* the <code>RUNNING</code> state and they
|
|
1039
|
-
*
|
|
1038
|
+
* are considered healthy if they're in the <code>RUNNING</code> state; tasks for services
|
|
1039
|
+
* that <i>do</i> use a load balancer are considered healthy if they're in
|
|
1040
|
+
* the <code>RUNNING</code> state and they're reported as healthy by the load balancer. The
|
|
1041
|
+
* default value for minimum healthy percent is 100%.</p>
|
|
1040
1042
|
* <p>If a service is using the blue/green (<code>CODE_DEPLOY</code>) or
|
|
1041
1043
|
* <code>EXTERNAL</code> deployment types and tasks that use the EC2
|
|
1042
1044
|
* launch type, the <b>minimum healthy percent</b> value is set
|
|
@@ -1111,21 +1113,21 @@ export interface LoadBalancer {
|
|
|
1111
1113
|
/**
|
|
1112
1114
|
* <p>The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or
|
|
1113
1115
|
* task set.</p>
|
|
1114
|
-
* <p>A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you
|
|
1115
|
-
* Classic Load Balancer the target group ARN
|
|
1116
|
+
* <p>A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a
|
|
1117
|
+
* Classic Load Balancer, omit the target group ARN.</p>
|
|
1116
1118
|
* <p>For services using the <code>ECS</code> deployment controller, you can specify one or
|
|
1117
1119
|
* multiple target groups. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html">Registering Multiple Target Groups with a Service</a> in
|
|
1118
1120
|
* the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1119
|
-
* <p>For services using the <code>CODE_DEPLOY</code> deployment controller, you
|
|
1120
|
-
*
|
|
1121
|
-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html">Blue/Green Deployment with CodeDeploy</a> in the
|
|
1121
|
+
* <p>For services using the <code>CODE_DEPLOY</code> deployment controller, you're required
|
|
1122
|
+
* to define two target groups for the load balancer. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html">Blue/Green Deployment with CodeDeploy</a> in the
|
|
1122
1123
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1123
1124
|
* <important>
|
|
1124
|
-
* <p>If your service's task definition uses the <code>awsvpc</code> network mode
|
|
1125
|
-
*
|
|
1126
|
-
*
|
|
1127
|
-
*
|
|
1128
|
-
*
|
|
1125
|
+
* <p>If your service's task definition uses the <code>awsvpc</code> network mode, you
|
|
1126
|
+
* must choose <code>ip</code> as the target type, not <code>instance</code>. Do this
|
|
1127
|
+
* when creating your target groups because tasks that use the <code>awsvpc</code>
|
|
1128
|
+
* network mode are associated with an elastic network interface, not an Amazon EC2
|
|
1129
|
+
* instance. This network mode is required for the Fargate launch
|
|
1130
|
+
* type.</p>
|
|
1129
1131
|
* </important>
|
|
1130
1132
|
*/
|
|
1131
1133
|
targetGroupArn?: string;
|
|
@@ -1144,7 +1146,7 @@ export interface LoadBalancer {
|
|
|
1144
1146
|
* <p>The port on the container to associate with the load balancer. This port must
|
|
1145
1147
|
* correspond to a <code>containerPort</code> in the task definition the tasks in the
|
|
1146
1148
|
* service are using. For tasks that use the EC2 launch type, the container
|
|
1147
|
-
* instance they
|
|
1149
|
+
* instance they're launched on must allow ingress traffic on the <code>hostPort</code> of
|
|
1148
1150
|
* the port mapping.</p>
|
|
1149
1151
|
*/
|
|
1150
1152
|
containerPort?: number;
|
|
@@ -1164,7 +1166,7 @@ export declare enum AssignPublicIp {
|
|
|
1164
1166
|
*/
|
|
1165
1167
|
export interface AwsVpcConfiguration {
|
|
1166
1168
|
/**
|
|
1167
|
-
* <p>The IDs of the subnets associated with the task or service. There
|
|
1169
|
+
* <p>The IDs of the subnets associated with the task or service. There's a limit of 16
|
|
1168
1170
|
* subnets that can be specified per <code>AwsVpcConfiguration</code>.</p>
|
|
1169
1171
|
*
|
|
1170
1172
|
* <note>
|
|
@@ -1173,8 +1175,8 @@ export interface AwsVpcConfiguration {
|
|
|
1173
1175
|
*/
|
|
1174
1176
|
subnets: string[] | undefined;
|
|
1175
1177
|
/**
|
|
1176
|
-
* <p>The IDs of the security groups associated with the task or service. If you
|
|
1177
|
-
* specify a security group, the default security group for the VPC is used. There
|
|
1178
|
+
* <p>The IDs of the security groups associated with the task or service. If you don't
|
|
1179
|
+
* specify a security group, the default security group for the VPC is used. There's a
|
|
1178
1180
|
* limit of 5 security groups that can be specified per
|
|
1179
1181
|
* <code>AwsVpcConfiguration</code>.</p>
|
|
1180
1182
|
*
|
|
@@ -1200,7 +1202,7 @@ export declare namespace AwsVpcConfiguration {
|
|
|
1200
1202
|
*/
|
|
1201
1203
|
export interface NetworkConfiguration {
|
|
1202
1204
|
/**
|
|
1203
|
-
* <p>The VPC subnets and security groups associated with a task.</p>
|
|
1205
|
+
* <p>The VPC subnets and security groups that are associated with a task.</p>
|
|
1204
1206
|
* <note>
|
|
1205
1207
|
* <p>All specified subnets and security groups must be from the same VPC.</p>
|
|
1206
1208
|
* </note>
|
|
@@ -1222,8 +1224,8 @@ export declare enum PlacementConstraintType {
|
|
|
1222
1224
|
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html">Task Placement Constraints</a> in the
|
|
1223
1225
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1224
1226
|
* <note>
|
|
1225
|
-
* <p>If you
|
|
1226
|
-
*
|
|
1227
|
+
* <p>If you're using the Fargate launch type, task placement constraints
|
|
1228
|
+
* aren't supported.</p>
|
|
1227
1229
|
* </note>
|
|
1228
1230
|
*/
|
|
1229
1231
|
export interface PlacementConstraint {
|
|
@@ -1263,15 +1265,15 @@ export interface PlacementStrategy {
|
|
|
1263
1265
|
* places tasks on available candidates. The <code>spread</code> placement strategy spreads
|
|
1264
1266
|
* placement across available candidates evenly based on the <code>field</code> parameter.
|
|
1265
1267
|
* The <code>binpack</code> strategy places tasks on available candidates that have the
|
|
1266
|
-
* least available amount of the resource that
|
|
1268
|
+
* least available amount of the resource that's specified with the <code>field</code>
|
|
1267
1269
|
* parameter. For example, if you binpack on memory, a task is placed on the instance with
|
|
1268
|
-
* the least amount of remaining memory
|
|
1270
|
+
* the least amount of remaining memory but still enough to run the task.</p>
|
|
1269
1271
|
*/
|
|
1270
1272
|
type?: PlacementStrategyType | string;
|
|
1271
1273
|
/**
|
|
1272
1274
|
* <p>The field to apply the placement strategy against. For the <code>spread</code>
|
|
1273
1275
|
* placement strategy, valid values are <code>instanceId</code> (or <code>host</code>,
|
|
1274
|
-
* which has the same effect), or any platform or custom attribute that
|
|
1276
|
+
* which has the same effect), or any platform or custom attribute that's applied to a
|
|
1275
1277
|
* container instance, such as <code>attribute:ecs.availability-zone</code>. For the
|
|
1276
1278
|
* <code>binpack</code> placement strategy, valid values are <code>cpu</code> and
|
|
1277
1279
|
* <code>memory</code>. For the <code>random</code> placement strategy, this field is
|
|
@@ -1294,7 +1296,7 @@ export declare enum SchedulingStrategy {
|
|
|
1294
1296
|
REPLICA = "REPLICA"
|
|
1295
1297
|
}
|
|
1296
1298
|
/**
|
|
1297
|
-
* <p>
|
|
1299
|
+
* <p>The details for the service registry.</p>
|
|
1298
1300
|
*/
|
|
1299
1301
|
export interface ServiceRegistry {
|
|
1300
1302
|
/**
|
|
@@ -1304,30 +1306,30 @@ export interface ServiceRegistry {
|
|
|
1304
1306
|
registryArn?: string;
|
|
1305
1307
|
/**
|
|
1306
1308
|
* <p>The port value used if your service discovery service specified an SRV record. This
|
|
1307
|
-
* field
|
|
1309
|
+
* field might be used if both the <code>awsvpc</code> network mode and SRV records are
|
|
1308
1310
|
* used.</p>
|
|
1309
1311
|
*/
|
|
1310
1312
|
port?: number;
|
|
1311
1313
|
/**
|
|
1312
|
-
* <p>The container name value
|
|
1313
|
-
*
|
|
1314
|
-
* uses the <code>bridge</code> or <code>host</code> network mode, you must
|
|
1315
|
-
*
|
|
1316
|
-
* definition. If the task definition that your service task specifies uses the
|
|
1314
|
+
* <p>The container name value to be used for your service discovery service. It's already
|
|
1315
|
+
* specified in the task definition. If the task definition that your service task
|
|
1316
|
+
* specifies uses the <code>bridge</code> or <code>host</code> network mode, you must
|
|
1317
|
+
* specify a <code>containerName</code> and <code>containerPort</code> combination from the
|
|
1318
|
+
* task definition. If the task definition that your service task specifies uses the
|
|
1317
1319
|
* <code>awsvpc</code> network mode and a type SRV DNS record is used, you must specify
|
|
1318
1320
|
* either a <code>containerName</code> and <code>containerPort</code> combination or a
|
|
1319
|
-
* <code>port</code> value,
|
|
1321
|
+
* <code>port</code> value. However, you can't specify both.</p>
|
|
1320
1322
|
*/
|
|
1321
1323
|
containerName?: string;
|
|
1322
1324
|
/**
|
|
1323
|
-
* <p>The port value
|
|
1324
|
-
*
|
|
1325
|
+
* <p>The port value to be used for your service discovery service. It's already specified
|
|
1326
|
+
* in the task definition. If the task definition your service task specifies uses the
|
|
1325
1327
|
* <code>bridge</code> or <code>host</code> network mode, you must specify a
|
|
1326
1328
|
* <code>containerName</code> and <code>containerPort</code> combination from the task
|
|
1327
1329
|
* definition. If the task definition your service task specifies uses the
|
|
1328
1330
|
* <code>awsvpc</code> network mode and a type SRV DNS record is used, you must specify
|
|
1329
1331
|
* either a <code>containerName</code> and <code>containerPort</code> combination or a
|
|
1330
|
-
* <code>port</code> value,
|
|
1332
|
+
* <code>port</code> value. However, you can't specify both.</p>
|
|
1331
1333
|
*/
|
|
1332
1334
|
containerPort?: number;
|
|
1333
1335
|
}
|
|
@@ -1339,7 +1341,7 @@ export declare namespace ServiceRegistry {
|
|
|
1339
1341
|
}
|
|
1340
1342
|
export interface CreateServiceRequest {
|
|
1341
1343
|
/**
|
|
1342
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the cluster
|
|
1344
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on.
|
|
1343
1345
|
* If you do not specify a cluster, the default cluster is assumed.</p>
|
|
1344
1346
|
*/
|
|
1345
1347
|
cluster?: string;
|
|
@@ -1351,50 +1353,51 @@ export interface CreateServiceRequest {
|
|
|
1351
1353
|
serviceName: string | undefined;
|
|
1352
1354
|
/**
|
|
1353
1355
|
* <p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or
|
|
1354
|
-
* full ARN of the task definition to run in your service. If a <code>revision</code>
|
|
1355
|
-
*
|
|
1356
|
-
* <p>A task definition must be specified if the service
|
|
1357
|
-
* <code>
|
|
1356
|
+
* full ARN of the task definition to run in your service. If a <code>revision</code>
|
|
1357
|
+
* isn't specified, the latest <code>ACTIVE</code> revision is used.</p>
|
|
1358
|
+
* <p>A task definition must be specified if the service uses either the <code>ECS</code> or
|
|
1359
|
+
* <code>CODE_DEPLOY</code> deployment controllers.</p>
|
|
1358
1360
|
*/
|
|
1359
1361
|
taskDefinition?: string;
|
|
1360
1362
|
/**
|
|
1361
1363
|
* <p>A load balancer object representing the load balancers to use with your service. For
|
|
1362
1364
|
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service Load Balancing</a> in the
|
|
1363
1365
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1364
|
-
* <p>If the service
|
|
1365
|
-
*
|
|
1366
|
-
*
|
|
1367
|
-
*
|
|
1366
|
+
* <p>If the service uses the rolling update (<code>ECS</code>) deployment controller and
|
|
1367
|
+
* using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach
|
|
1368
|
+
* to the service. The service-linked role is required for services that use multiple
|
|
1369
|
+
* target groups. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using service-linked roles for Amazon ECS</a> in the
|
|
1368
1370
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1369
|
-
* <p>If the service
|
|
1370
|
-
*
|
|
1371
|
-
*
|
|
1372
|
-
*
|
|
1373
|
-
* <code>PRIMARY</code
|
|
1374
|
-
* the other target group with the replacement task set. The load balancer can
|
|
1375
|
-
* to two listeners: a required listener for production traffic and an
|
|
1376
|
-
* that
|
|
1377
|
-
* traffic to it.</p>
|
|
1371
|
+
* <p>If the service uses the <code>CODE_DEPLOY</code> deployment controller, the service is
|
|
1372
|
+
* required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you
|
|
1373
|
+
* specify two target groups (referred to as a <code>targetGroupPair</code>). During a
|
|
1374
|
+
* deployment, CodeDeploy determines which task set in your service has the status
|
|
1375
|
+
* <code>PRIMARY</code>, and it associates one target group with it. Then, it also
|
|
1376
|
+
* associates the other target group with the replacement task set. The load balancer can
|
|
1377
|
+
* also have up to two listeners: a required listener for production traffic and an
|
|
1378
|
+
* optional listener that you can use to perform validation tests with Lambda functions
|
|
1379
|
+
* before routing production traffic to it.</p>
|
|
1378
1380
|
* <p>After you create a service using the <code>ECS</code> deployment controller, the load
|
|
1379
|
-
* balancer name or target group ARN, container name, and container port specified
|
|
1380
|
-
* service definition are immutable. If you
|
|
1381
|
+
* balancer name or target group ARN, container name, and container port that's specified
|
|
1382
|
+
* in the service definition are immutable. If you use the <code>CODE_DEPLOY</code>
|
|
1381
1383
|
* deployment controller, these values can be changed when updating the service.</p>
|
|
1382
1384
|
* <p>For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,
|
|
1383
|
-
* the container name
|
|
1384
|
-
*
|
|
1385
|
-
* task from this service is placed on a container
|
|
1386
|
-
* port combination is registered as a target in the
|
|
1387
|
-
*
|
|
1388
|
-
*
|
|
1389
|
-
*
|
|
1390
|
-
*
|
|
1391
|
-
*
|
|
1385
|
+
* the container name, and the container port to access from the load balancer. The
|
|
1386
|
+
* container name must be as it appears in a container definition. The load balancer name
|
|
1387
|
+
* parameter must be omitted. When a task from this service is placed on a container
|
|
1388
|
+
* instance, the container instance and port combination is registered as a target in the
|
|
1389
|
+
* target group that's specified here.</p>
|
|
1390
|
+
* <p>For Classic Load Balancers, this object must contain the load balancer name, the container name , and
|
|
1391
|
+
* the container port to access from the load balancer. The container name must be as it
|
|
1392
|
+
* appears in a container definition. The target group ARN parameter must be omitted. When
|
|
1393
|
+
* a task from this service is placed on a container instance, the container instance is
|
|
1394
|
+
* registered with the load balancer that's specified here.</p>
|
|
1392
1395
|
* <p>Services with tasks that use the <code>awsvpc</code> network mode (for example, those
|
|
1393
|
-
* with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers
|
|
1394
|
-
*
|
|
1395
|
-
* choose <code>ip</code> as the target type, not <code>instance</code
|
|
1396
|
-
* use the <code>awsvpc</code> network mode are associated with an elastic
|
|
1397
|
-
* interface, not an Amazon EC2 instance.</p>
|
|
1396
|
+
* with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers
|
|
1397
|
+
* aren't supported. Also, when you create any target groups for these services, you must
|
|
1398
|
+
* choose <code>ip</code> as the target type, not <code>instance</code>. This is because
|
|
1399
|
+
* tasks that use the <code>awsvpc</code> network mode are associated with an elastic
|
|
1400
|
+
* network interface, not an Amazon EC2 instance.</p>
|
|
1398
1401
|
*/
|
|
1399
1402
|
loadBalancers?: LoadBalancer[];
|
|
1400
1403
|
/**
|
|
@@ -1403,25 +1406,25 @@ export interface CreateServiceRequest {
|
|
|
1403
1406
|
* discovery</a>.</p>
|
|
1404
1407
|
* <note>
|
|
1405
1408
|
* <p>Each service may be associated with one service registry. Multiple service
|
|
1406
|
-
* registries
|
|
1409
|
+
* registries for each service isn't supported.</p>
|
|
1407
1410
|
* </note>
|
|
1408
1411
|
*/
|
|
1409
1412
|
serviceRegistries?: ServiceRegistry[];
|
|
1410
1413
|
/**
|
|
1411
1414
|
* <p>The number of instantiations of the specified task definition to place and keep
|
|
1412
1415
|
* running on your cluster.</p>
|
|
1413
|
-
* <p>This is required if <code>schedulingStrategy</code> is <code>REPLICA</code> or
|
|
1414
|
-
* specified. If <code>schedulingStrategy</code> is <code>DAEMON</code> then this
|
|
1416
|
+
* <p>This is required if <code>schedulingStrategy</code> is <code>REPLICA</code> or isn't
|
|
1417
|
+
* specified. If <code>schedulingStrategy</code> is <code>DAEMON</code> then this isn't
|
|
1415
1418
|
* required.</p>
|
|
1416
1419
|
*/
|
|
1417
1420
|
desiredCount?: number;
|
|
1418
1421
|
/**
|
|
1419
|
-
* <p>
|
|
1420
|
-
*
|
|
1422
|
+
* <p>An identifier that you provide to ensure the idempotency of the request. It must be
|
|
1423
|
+
* unique and is case sensitive. Up to 32 ASCII characters are allowed.</p>
|
|
1421
1424
|
*/
|
|
1422
1425
|
clientToken?: string;
|
|
1423
1426
|
/**
|
|
1424
|
-
* <p>The infrastructure
|
|
1427
|
+
* <p>The infrastructure that you run your service on. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html">Amazon ECS
|
|
1425
1428
|
* launch types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1426
1429
|
* <p>The <code>FARGATE</code> launch type runs your tasks on Fargate On-Demand
|
|
1427
1430
|
* infrastructure.</p>
|
|
@@ -1432,7 +1435,7 @@ export interface CreateServiceRequest {
|
|
|
1432
1435
|
* </note>
|
|
1433
1436
|
* <p>The <code>EC2</code> launch type runs your tasks on Amazon EC2 instances registered to your
|
|
1434
1437
|
* cluster.</p>
|
|
1435
|
-
* <p>The <code>EXTERNAL</code> launch type runs your tasks on your on-
|
|
1438
|
+
* <p>The <code>EXTERNAL</code> launch type runs your tasks on your on-premises server or
|
|
1436
1439
|
* virtual machine (VM) capacity registered to your cluster.</p>
|
|
1437
1440
|
* <p>A service can use either a launch type or a capacity provider strategy. If a
|
|
1438
1441
|
* <code>launchType</code> is specified, the <code>capacityProviderStrategy</code>
|
|
@@ -1451,24 +1454,24 @@ export interface CreateServiceRequest {
|
|
|
1451
1454
|
/**
|
|
1452
1455
|
* <p>The platform version that your tasks in the service are running on. A platform version
|
|
1453
1456
|
* is specified only for tasks using the Fargate launch type. If one isn't
|
|
1454
|
-
* specified, the <code>LATEST</code> platform version is used
|
|
1455
|
-
*
|
|
1457
|
+
* specified, the <code>LATEST</code> platform version is used. For more information, see
|
|
1458
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate platform
|
|
1456
1459
|
* versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1457
1460
|
*/
|
|
1458
1461
|
platformVersion?: string;
|
|
1459
1462
|
/**
|
|
1460
1463
|
* <p>The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your
|
|
1461
1464
|
* load balancer on your behalf. This parameter is only permitted if you are using a load
|
|
1462
|
-
* balancer with your service and your task definition
|
|
1465
|
+
* balancer with your service and your task definition doesn't use the <code>awsvpc</code>
|
|
1463
1466
|
* network mode. If you specify the <code>role</code> parameter, you must also specify a
|
|
1464
1467
|
* load balancer object with the <code>loadBalancers</code> parameter.</p>
|
|
1465
1468
|
* <important>
|
|
1466
1469
|
* <p>If your account has already created the Amazon ECS service-linked role, that role is
|
|
1467
|
-
* used
|
|
1468
|
-
*
|
|
1469
|
-
*
|
|
1470
|
-
*
|
|
1471
|
-
*
|
|
1470
|
+
* used for your service unless you specify a role here. The service-linked role is
|
|
1471
|
+
* required if your task definition uses the <code>awsvpc</code> network mode or if the
|
|
1472
|
+
* service is configured to use service discovery, an external deployment controller,
|
|
1473
|
+
* multiple target groups, or Elastic Inference accelerators in which case you don't
|
|
1474
|
+
* specify a role here. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using
|
|
1472
1475
|
* service-linked roles for Amazon ECS</a> in the
|
|
1473
1476
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1474
1477
|
* </important>
|
|
@@ -1486,34 +1489,36 @@ export interface CreateServiceRequest {
|
|
|
1486
1489
|
deploymentConfiguration?: DeploymentConfiguration;
|
|
1487
1490
|
/**
|
|
1488
1491
|
* <p>An array of placement constraint objects to use for tasks in your service. You can
|
|
1489
|
-
* specify a maximum of 10 constraints
|
|
1490
|
-
* task definition and those specified at runtime
|
|
1492
|
+
* specify a maximum of 10 constraints for each task. This limit includes constraints in
|
|
1493
|
+
* the task definition and those specified at runtime.</p>
|
|
1491
1494
|
*/
|
|
1492
1495
|
placementConstraints?: PlacementConstraint[];
|
|
1493
1496
|
/**
|
|
1494
1497
|
* <p>The placement strategy objects to use for tasks in your service. You can specify a
|
|
1495
|
-
* maximum of 5 strategy rules
|
|
1498
|
+
* maximum of 5 strategy rules for each service.</p>
|
|
1496
1499
|
*/
|
|
1497
1500
|
placementStrategy?: PlacementStrategy[];
|
|
1498
1501
|
/**
|
|
1499
1502
|
* <p>The network configuration for the service. This parameter is required for task
|
|
1500
1503
|
* definitions that use the <code>awsvpc</code> network mode to receive their own elastic
|
|
1501
|
-
* network interface, and it
|
|
1502
|
-
*
|
|
1504
|
+
* network interface, and it isn't supported for other network modes. For more information,
|
|
1505
|
+
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html">Task networking</a>
|
|
1503
1506
|
* in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1504
1507
|
*/
|
|
1505
1508
|
networkConfiguration?: NetworkConfiguration;
|
|
1506
1509
|
/**
|
|
1507
|
-
* <p>The period of time, in seconds, that the Amazon ECS service scheduler
|
|
1508
|
-
*
|
|
1509
|
-
*
|
|
1510
|
-
*
|
|
1511
|
-
*
|
|
1510
|
+
* <p>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy
|
|
1511
|
+
* Elastic Load Balancing target health checks after a task has first started. This is only used when your
|
|
1512
|
+
* service is configured to use a load balancer. If your service has a load balancer
|
|
1513
|
+
* defined and you don't specify a health check grace period value, the default value of
|
|
1514
|
+
* <code>0</code> is used.</p>
|
|
1512
1515
|
* <p>If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you
|
|
1513
|
-
* can specify a health check grace period of up to
|
|
1514
|
-
*
|
|
1515
|
-
*
|
|
1516
|
-
*
|
|
1516
|
+
* can specify a health check grace period of up to
|
|
1517
|
+
* 2,147,483,647
|
|
1518
|
+
* seconds (about 69 years). During that time, the Amazon ECS service
|
|
1519
|
+
* scheduler ignores health check status. This grace period can prevent the service
|
|
1520
|
+
* scheduler from marking tasks as unhealthy and stopping them before they have time to
|
|
1521
|
+
* come up.</p>
|
|
1517
1522
|
*/
|
|
1518
1523
|
healthCheckGracePeriodSeconds?: number;
|
|
1519
1524
|
/**
|
|
@@ -1526,9 +1531,8 @@ export interface CreateServiceRequest {
|
|
|
1526
1531
|
* maintains the desired number of tasks across your cluster. By default, the
|
|
1527
1532
|
* service scheduler spreads tasks across Availability Zones. You can use task
|
|
1528
1533
|
* placement strategies and constraints to customize task placement decisions. This
|
|
1529
|
-
* scheduler strategy is required if the service
|
|
1530
|
-
*
|
|
1531
|
-
* types.</p>
|
|
1534
|
+
* scheduler strategy is required if the service uses the <code>CODE_DEPLOY</code>
|
|
1535
|
+
* or <code>EXTERNAL</code> deployment controller types.</p>
|
|
1532
1536
|
* </li>
|
|
1533
1537
|
* <li>
|
|
1534
1538
|
* <p>
|
|
@@ -1536,7 +1540,7 @@ export interface CreateServiceRequest {
|
|
|
1536
1540
|
* task on each active container instance that meets all of the task placement
|
|
1537
1541
|
* constraints that you specify in your cluster. The service scheduler also
|
|
1538
1542
|
* evaluates the task placement constraints for running tasks and will stop tasks
|
|
1539
|
-
* that
|
|
1543
|
+
* that don't meet the placement constraints. When you're using this strategy, you
|
|
1540
1544
|
* don't need to specify a desired number of tasks, a task placement strategy, or
|
|
1541
1545
|
* use Service Auto Scaling policies.</p>
|
|
1542
1546
|
* <note>
|
|
@@ -1557,7 +1561,7 @@ export interface CreateServiceRequest {
|
|
|
1557
1561
|
* <p>The metadata that you apply to the service to help you categorize and organize them.
|
|
1558
1562
|
* Each tag consists of a key and an optional value, both of which you define. When a
|
|
1559
1563
|
* service is deleted, the tags are deleted as well.</p>
|
|
1560
|
-
*
|
|
1564
|
+
* <p>The following basic restrictions apply to tags:</p>
|
|
1561
1565
|
* <ul>
|
|
1562
1566
|
* <li>
|
|
1563
1567
|
* <p>Maximum number of tags per resource - 50</p>
|
|
@@ -1598,14 +1602,14 @@ export interface CreateServiceRequest {
|
|
|
1598
1602
|
enableECSManagedTags?: boolean;
|
|
1599
1603
|
/**
|
|
1600
1604
|
* <p>Specifies whether to propagate the tags from the task definition or the service to the
|
|
1601
|
-
* tasks in the service. If no value is specified, the tags
|
|
1605
|
+
* tasks in the service. If no value is specified, the tags aren't propagated. Tags can
|
|
1602
1606
|
* only be propagated to the tasks within the service during service creation. To add tags
|
|
1603
|
-
* to a task after service creation or task creation, use the <a>TagResource</a>
|
|
1604
|
-
* action.</p>
|
|
1607
|
+
* to a task after service creation or task creation, use the <a>TagResource</a>
|
|
1608
|
+
* API action.</p>
|
|
1605
1609
|
*/
|
|
1606
1610
|
propagateTags?: PropagateTags | string;
|
|
1607
1611
|
/**
|
|
1608
|
-
* <p>
|
|
1612
|
+
* <p>Determines whether the execute command functionality is enabled for the service. If
|
|
1609
1613
|
* <code>true</code>, this enables execute command functionality on all containers in
|
|
1610
1614
|
* the service tasks.</p>
|
|
1611
1615
|
*/
|
|
@@ -1632,7 +1636,7 @@ export interface Deployment {
|
|
|
1632
1636
|
*/
|
|
1633
1637
|
id?: string;
|
|
1634
1638
|
/**
|
|
1635
|
-
* <p>The status of the deployment. The following describes each state
|
|
1639
|
+
* <p>The status of the deployment. The following describes each state.</p>
|
|
1636
1640
|
* <dl>
|
|
1637
1641
|
* <dt>PRIMARY</dt>
|
|
1638
1642
|
* <dd>
|
|
@@ -1682,11 +1686,11 @@ export interface Deployment {
|
|
|
1682
1686
|
*/
|
|
1683
1687
|
failedTasks?: number;
|
|
1684
1688
|
/**
|
|
1685
|
-
* <p>The Unix timestamp for when the service deployment was created.</p>
|
|
1689
|
+
* <p>The Unix timestamp for the time when the service deployment was created.</p>
|
|
1686
1690
|
*/
|
|
1687
1691
|
createdAt?: Date;
|
|
1688
1692
|
/**
|
|
1689
|
-
* <p>The Unix timestamp for when the service deployment was last updated.</p>
|
|
1693
|
+
* <p>The Unix timestamp for the time when the service deployment was last updated.</p>
|
|
1690
1694
|
*/
|
|
1691
1695
|
updatedAt?: Date;
|
|
1692
1696
|
/**
|
|
@@ -1699,16 +1703,18 @@ export interface Deployment {
|
|
|
1699
1703
|
*/
|
|
1700
1704
|
launchType?: LaunchType | string;
|
|
1701
1705
|
/**
|
|
1702
|
-
* <p>The platform version
|
|
1703
|
-
*
|
|
1704
|
-
*
|
|
1705
|
-
*
|
|
1706
|
-
* Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1706
|
+
* <p>The platform version that your tasks in the service run on. A platform version is only
|
|
1707
|
+
* specified for tasks using the Fargate launch type. If one isn't specified,
|
|
1708
|
+
* the <code>LATEST</code> platform version is used. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform Versions</a> in the
|
|
1709
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1707
1710
|
*/
|
|
1708
1711
|
platformVersion?: string;
|
|
1709
1712
|
/**
|
|
1710
|
-
* <p>The operating system
|
|
1711
|
-
*
|
|
1713
|
+
* <p>The operating system that your tasks in the service, or tasks are running on. A
|
|
1714
|
+
* platform family is specified only for tasks using the Fargate launch type. </p>
|
|
1715
|
+
* <p> All tasks that run as part of this service must use the same
|
|
1716
|
+
* <code>platformFamily</code> value as the service, for example, <code>
|
|
1717
|
+
* LINUX.</code>.</p>
|
|
1712
1718
|
*/
|
|
1713
1719
|
platformFamily?: string;
|
|
1714
1720
|
/**
|
|
@@ -1719,15 +1725,15 @@ export interface Deployment {
|
|
|
1719
1725
|
/**
|
|
1720
1726
|
* <note>
|
|
1721
1727
|
* <p>The <code>rolloutState</code> of a service is only returned for services that use
|
|
1722
|
-
* the rolling update (<code>ECS</code>) deployment type that
|
|
1728
|
+
* the rolling update (<code>ECS</code>) deployment type that aren't behind a
|
|
1723
1729
|
* Classic Load Balancer.</p>
|
|
1724
1730
|
* </note>
|
|
1725
1731
|
* <p>The rollout state of the deployment. When a service deployment is started, it begins
|
|
1726
1732
|
* in an <code>IN_PROGRESS</code> state. When the service reaches a steady state, the
|
|
1727
|
-
* deployment
|
|
1728
|
-
*
|
|
1729
|
-
* <code>FAILED</code> state. A deployment in <code>FAILED</code> state
|
|
1730
|
-
* new tasks. For more information, see <a>DeploymentCircuitBreaker</a>.</p>
|
|
1733
|
+
* deployment transitions to a <code>COMPLETED</code> state. If the service fails to reach
|
|
1734
|
+
* a steady state and circuit breaker is enabled, the deployment transitions to a
|
|
1735
|
+
* <code>FAILED</code> state. A deployment in <code>FAILED</code> state doesn't launch
|
|
1736
|
+
* any new tasks. For more information, see <a>DeploymentCircuitBreaker</a>.</p>
|
|
1731
1737
|
*/
|
|
1732
1738
|
rolloutState?: DeploymentRolloutState | string;
|
|
1733
1739
|
/**
|
|
@@ -1742,15 +1748,15 @@ export declare namespace Deployment {
|
|
|
1742
1748
|
const filterSensitiveLog: (obj: Deployment) => any;
|
|
1743
1749
|
}
|
|
1744
1750
|
/**
|
|
1745
|
-
* <p>
|
|
1751
|
+
* <p>The details for an event that's associated with a service.</p>
|
|
1746
1752
|
*/
|
|
1747
1753
|
export interface ServiceEvent {
|
|
1748
1754
|
/**
|
|
1749
|
-
* <p>The ID string
|
|
1755
|
+
* <p>The ID string for the event.</p>
|
|
1750
1756
|
*/
|
|
1751
1757
|
id?: string;
|
|
1752
1758
|
/**
|
|
1753
|
-
* <p>The Unix timestamp for when the event was triggered.</p>
|
|
1759
|
+
* <p>The Unix timestamp for the time when the event was triggered.</p>
|
|
1754
1760
|
*/
|
|
1755
1761
|
createdAt?: Date;
|
|
1756
1762
|
/**
|
|
@@ -1816,14 +1822,14 @@ export interface TaskSet {
|
|
|
1816
1822
|
*/
|
|
1817
1823
|
clusterArn?: string;
|
|
1818
1824
|
/**
|
|
1819
|
-
* <p>The tag specified when a task set is started. If
|
|
1820
|
-
*
|
|
1821
|
-
*
|
|
1825
|
+
* <p>The tag specified when a task set is started. If an CodeDeploy deployment created the task
|
|
1826
|
+
* set, the <code>startedBy</code> parameter is <code>CODE_DEPLOY</code>. If an external
|
|
1827
|
+
* deployment created the task set, the startedBy field isn't used.</p>
|
|
1822
1828
|
*/
|
|
1823
1829
|
startedBy?: string;
|
|
1824
1830
|
/**
|
|
1825
1831
|
* <p>The external ID associated with the task set.</p>
|
|
1826
|
-
* <p>If
|
|
1832
|
+
* <p>If an CodeDeploy deployment created a task set, the <code>externalId</code> parameter
|
|
1827
1833
|
* contains the CodeDeploy deployment ID.</p>
|
|
1828
1834
|
* <p>If a task set is created for an external deployment and is associated with a service
|
|
1829
1835
|
* discovery registry, the <code>externalId</code> parameter contains the
|
|
@@ -1831,7 +1837,7 @@ export interface TaskSet {
|
|
|
1831
1837
|
*/
|
|
1832
1838
|
externalId?: string;
|
|
1833
1839
|
/**
|
|
1834
|
-
* <p>The status of the task set. The following describes each state
|
|
1840
|
+
* <p>The status of the task set. The following describes each state.</p>
|
|
1835
1841
|
* <dl>
|
|
1836
1842
|
* <dt>PRIMARY</dt>
|
|
1837
1843
|
* <dd>
|
|
@@ -1839,18 +1845,18 @@ export interface TaskSet {
|
|
|
1839
1845
|
* </dd>
|
|
1840
1846
|
* <dt>ACTIVE</dt>
|
|
1841
1847
|
* <dd>
|
|
1842
|
-
* <p>The task set
|
|
1848
|
+
* <p>The task set isn't serving production traffic.</p>
|
|
1843
1849
|
* </dd>
|
|
1844
1850
|
* <dt>DRAINING</dt>
|
|
1845
1851
|
* <dd>
|
|
1846
|
-
* <p>The tasks in the task set are being stopped and their corresponding
|
|
1852
|
+
* <p>The tasks in the task set are being stopped, and their corresponding
|
|
1847
1853
|
* targets are being deregistered from their target group.</p>
|
|
1848
1854
|
* </dd>
|
|
1849
1855
|
* </dl>
|
|
1850
1856
|
*/
|
|
1851
1857
|
status?: string;
|
|
1852
1858
|
/**
|
|
1853
|
-
* <p>The task definition the task set is using.</p>
|
|
1859
|
+
* <p>The task definition that the task set is using.</p>
|
|
1854
1860
|
*/
|
|
1855
1861
|
taskDefinition?: string;
|
|
1856
1862
|
/**
|
|
@@ -1864,7 +1870,7 @@ export interface TaskSet {
|
|
|
1864
1870
|
* <p>The number of tasks in the task set that are in the <code>PENDING</code> status during
|
|
1865
1871
|
* a deployment. A task in the <code>PENDING</code> state is preparing to enter the
|
|
1866
1872
|
* <code>RUNNING</code> state. A task set enters the <code>PENDING</code> status when
|
|
1867
|
-
* it launches for the first time or when it
|
|
1873
|
+
* it launches for the first time or when it's restarted after being in the
|
|
1868
1874
|
* <code>STOPPED</code> state.</p>
|
|
1869
1875
|
*/
|
|
1870
1876
|
pendingCount?: number;
|
|
@@ -1875,11 +1881,11 @@ export interface TaskSet {
|
|
|
1875
1881
|
*/
|
|
1876
1882
|
runningCount?: number;
|
|
1877
1883
|
/**
|
|
1878
|
-
* <p>The Unix timestamp for when the task set was created.</p>
|
|
1884
|
+
* <p>The Unix timestamp for the time when the task set was created.</p>
|
|
1879
1885
|
*/
|
|
1880
1886
|
createdAt?: Date;
|
|
1881
1887
|
/**
|
|
1882
|
-
* <p>The Unix timestamp for when the task set was last updated.</p>
|
|
1888
|
+
* <p>The Unix timestamp for the time when the task set was last updated.</p>
|
|
1883
1889
|
*/
|
|
1884
1890
|
updatedAt?: Date;
|
|
1885
1891
|
/**
|
|
@@ -1888,18 +1894,18 @@ export interface TaskSet {
|
|
|
1888
1894
|
*/
|
|
1889
1895
|
launchType?: LaunchType | string;
|
|
1890
1896
|
/**
|
|
1891
|
-
* <p>The capacity provider strategy associated with the task set.</p>
|
|
1897
|
+
* <p>The capacity provider strategy that are associated with the task set.</p>
|
|
1892
1898
|
*/
|
|
1893
1899
|
capacityProviderStrategy?: CapacityProviderStrategyItem[];
|
|
1894
1900
|
/**
|
|
1895
|
-
* <p>The Fargate platform version
|
|
1896
|
-
*
|
|
1897
|
-
*
|
|
1898
|
-
* versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1901
|
+
* <p>The Fargate platform version where the tasks in the task set are running. A platform
|
|
1902
|
+
* version is only specified for tasks run on Fargate. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate platform versions</a> in the
|
|
1903
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1899
1904
|
*/
|
|
1900
1905
|
platformVersion?: string;
|
|
1901
1906
|
/**
|
|
1902
|
-
* <p>The operating system
|
|
1907
|
+
* <p>The operating system that your tasks in the set are running on. A platform family is
|
|
1908
|
+
* specified only for tasks that use the Fargate launch type. </p>
|
|
1903
1909
|
* <p> All tasks in the set must have the same value.</p>
|
|
1904
1910
|
*/
|
|
1905
1911
|
platformFamily?: string;
|
|
@@ -1908,23 +1914,23 @@ export interface TaskSet {
|
|
|
1908
1914
|
*/
|
|
1909
1915
|
networkConfiguration?: NetworkConfiguration;
|
|
1910
1916
|
/**
|
|
1911
|
-
* <p>Details on a load balancer that
|
|
1917
|
+
* <p>Details on a load balancer that are used with a task set.</p>
|
|
1912
1918
|
*/
|
|
1913
1919
|
loadBalancers?: LoadBalancer[];
|
|
1914
1920
|
/**
|
|
1915
|
-
* <p>The details
|
|
1921
|
+
* <p>The details for the service discovery registries to assign to this task set. For more
|
|
1916
1922
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html">Service
|
|
1917
1923
|
* discovery</a>.</p>
|
|
1918
1924
|
*/
|
|
1919
1925
|
serviceRegistries?: ServiceRegistry[];
|
|
1920
1926
|
/**
|
|
1921
|
-
* <p>A floating-point percentage of
|
|
1927
|
+
* <p>A floating-point percentage of your desired number of tasks to place and keep running
|
|
1922
1928
|
* in the task set.</p>
|
|
1923
1929
|
*/
|
|
1924
1930
|
scale?: Scale;
|
|
1925
1931
|
/**
|
|
1926
|
-
* <p>The stability status
|
|
1927
|
-
* If the following conditions are met, the task set
|
|
1932
|
+
* <p>The stability status. This indicates whether the task set has reached a steady state.
|
|
1933
|
+
* If the following conditions are met, the task set sre in
|
|
1928
1934
|
* <code>STEADY_STATE</code>:</p>
|
|
1929
1935
|
* <ul>
|
|
1930
1936
|
* <li>
|
|
@@ -1935,25 +1941,26 @@ export interface TaskSet {
|
|
|
1935
1941
|
* <p>The <code>pendingCount</code> is <code>0</code>.</p>
|
|
1936
1942
|
* </li>
|
|
1937
1943
|
* <li>
|
|
1938
|
-
* <p>There are no tasks running on container instances in the
|
|
1939
|
-
*
|
|
1944
|
+
* <p>There are no tasks that are running on container instances in the
|
|
1945
|
+
* <code>DRAINING</code> status.</p>
|
|
1940
1946
|
* </li>
|
|
1941
1947
|
* <li>
|
|
1942
1948
|
* <p>All tasks are reporting a healthy status from the load balancers, service
|
|
1943
1949
|
* discovery, and container health checks.</p>
|
|
1944
1950
|
* </li>
|
|
1945
1951
|
* </ul>
|
|
1946
|
-
* <p>If any of those conditions
|
|
1952
|
+
* <p>If any of those conditions aren't met, the stability status returns
|
|
1947
1953
|
* <code>STABILIZING</code>.</p>
|
|
1948
1954
|
*/
|
|
1949
1955
|
stabilityStatus?: StabilityStatus | string;
|
|
1950
1956
|
/**
|
|
1951
|
-
* <p>The Unix timestamp for when the task set stability status was
|
|
1957
|
+
* <p>The Unix timestamp for the time when the task set stability status was
|
|
1958
|
+
* retrieved.</p>
|
|
1952
1959
|
*/
|
|
1953
1960
|
stabilityStatusAt?: Date;
|
|
1954
1961
|
/**
|
|
1955
1962
|
* <p>The metadata that you apply to the task set to help you categorize and organize them.
|
|
1956
|
-
* Each tag consists of a key and an optional value
|
|
1963
|
+
* Each tag consists of a key and an optional value. You define both.</p>
|
|
1957
1964
|
* <p>The following basic restrictions apply to tags:</p>
|
|
1958
1965
|
* <ul>
|
|
1959
1966
|
* <li>
|
|
@@ -2004,7 +2011,7 @@ export interface Service {
|
|
|
2004
2011
|
serviceArn?: string;
|
|
2005
2012
|
/**
|
|
2006
2013
|
* <p>The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within
|
|
2007
|
-
* a cluster,
|
|
2014
|
+
* a cluster. However, you can have similarly named services in multiple clusters within a
|
|
2008
2015
|
* Region or across multiple Regions.</p>
|
|
2009
2016
|
*/
|
|
2010
2017
|
serviceName?: string;
|
|
@@ -2013,13 +2020,13 @@ export interface Service {
|
|
|
2013
2020
|
*/
|
|
2014
2021
|
clusterArn?: string;
|
|
2015
2022
|
/**
|
|
2016
|
-
* <p>A list of Elastic Load Balancing load balancer objects
|
|
2017
|
-
* container name
|
|
2018
|
-
*
|
|
2023
|
+
* <p>A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the
|
|
2024
|
+
* container name, and the container port to access from the load balancer. The container
|
|
2025
|
+
* name is as it appears in a container definition.</p>
|
|
2019
2026
|
*/
|
|
2020
2027
|
loadBalancers?: LoadBalancer[];
|
|
2021
2028
|
/**
|
|
2022
|
-
* <p>The details
|
|
2029
|
+
* <p>The details for the service discovery registries to assign to this service. For more
|
|
2023
2030
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html">Service
|
|
2024
2031
|
* Discovery</a>.</p>
|
|
2025
2032
|
*/
|
|
@@ -2048,21 +2055,23 @@ export interface Service {
|
|
|
2048
2055
|
*/
|
|
2049
2056
|
launchType?: LaunchType | string;
|
|
2050
2057
|
/**
|
|
2051
|
-
* <p>The capacity provider strategy the service
|
|
2052
|
-
*
|
|
2058
|
+
* <p>The capacity provider strategy the service uses. When using the DescribeServices API,
|
|
2059
|
+
* this field is omitted if the service was created using a launch type.</p>
|
|
2053
2060
|
*/
|
|
2054
2061
|
capacityProviderStrategy?: CapacityProviderStrategyItem[];
|
|
2055
2062
|
/**
|
|
2056
|
-
* <p>The platform version
|
|
2057
|
-
*
|
|
2058
|
-
*
|
|
2059
|
-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform
|
|
2063
|
+
* <p>The platform version to run your service on. A platform version is only specified for
|
|
2064
|
+
* tasks that are hosted on Fargate. If one isn't specified, the <code>LATEST</code>
|
|
2065
|
+
* platform version is used. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform
|
|
2060
2066
|
* Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2061
2067
|
*/
|
|
2062
2068
|
platformVersion?: string;
|
|
2063
2069
|
/**
|
|
2064
|
-
* <p>The operating system
|
|
2065
|
-
*
|
|
2070
|
+
* <p>The operating system that your tasks in the service run on. A platform family is
|
|
2071
|
+
* specified only for tasks using the Fargate launch type. </p>
|
|
2072
|
+
* <p> All tasks that run as part of this service must use the same
|
|
2073
|
+
* <code>platformFamily</code> value as the service (for example,
|
|
2074
|
+
* <code>LINUX</code>).</p>
|
|
2066
2075
|
*/
|
|
2067
2076
|
platformFamily?: string;
|
|
2068
2077
|
/**
|
|
@@ -2087,8 +2096,8 @@ export interface Service {
|
|
|
2087
2096
|
*/
|
|
2088
2097
|
deployments?: Deployment[];
|
|
2089
2098
|
/**
|
|
2090
|
-
* <p>The ARN of the IAM role associated with the service
|
|
2091
|
-
* agent to register container instances with an Elastic Load Balancing load balancer.</p>
|
|
2099
|
+
* <p>The ARN of the IAM role that's associated with the service. It allows the Amazon ECS
|
|
2100
|
+
* container agent to register container instances with an Elastic Load Balancing load balancer.</p>
|
|
2092
2101
|
*/
|
|
2093
2102
|
roleArn?: string;
|
|
2094
2103
|
/**
|
|
@@ -2097,7 +2106,7 @@ export interface Service {
|
|
|
2097
2106
|
*/
|
|
2098
2107
|
events?: ServiceEvent[];
|
|
2099
2108
|
/**
|
|
2100
|
-
* <p>The Unix timestamp for when the service was created.</p>
|
|
2109
|
+
* <p>The Unix timestamp for the time when the service was created.</p>
|
|
2101
2110
|
*/
|
|
2102
2111
|
createdAt?: Date;
|
|
2103
2112
|
/**
|
|
@@ -2120,7 +2129,7 @@ export interface Service {
|
|
|
2120
2129
|
healthCheckGracePeriodSeconds?: number;
|
|
2121
2130
|
/**
|
|
2122
2131
|
* <p>The scheduling strategy to use for the service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Services</a>.</p>
|
|
2123
|
-
* <p>There are two service scheduler strategies available
|
|
2132
|
+
* <p>There are two service scheduler strategies available.</p>
|
|
2124
2133
|
* <ul>
|
|
2125
2134
|
* <li>
|
|
2126
2135
|
* <p>
|
|
@@ -2133,12 +2142,14 @@ export interface Service {
|
|
|
2133
2142
|
* <li>
|
|
2134
2143
|
* <p>
|
|
2135
2144
|
* <code>DAEMON</code>-The daemon scheduling strategy deploys exactly one
|
|
2136
|
-
* task on each active container
|
|
2137
|
-
*
|
|
2138
|
-
*
|
|
2139
|
-
*
|
|
2145
|
+
* task on each active container
|
|
2146
|
+
* instance.
|
|
2147
|
+
* This taskmeets all of the task placement constraints that you
|
|
2148
|
+
* specify in your cluster. The service scheduler also evaluates the task placement
|
|
2149
|
+
* constraints for running tasks. It stop tasks that don't meet the placement
|
|
2150
|
+
* constraints.</p>
|
|
2140
2151
|
* <note>
|
|
2141
|
-
* <p>Fargate tasks
|
|
2152
|
+
* <p>Fargate tasks don't support the <code>DAEMON</code>
|
|
2142
2153
|
* scheduling strategy.</p>
|
|
2143
2154
|
* </note>
|
|
2144
2155
|
* </li>
|
|
@@ -2147,13 +2158,14 @@ export interface Service {
|
|
|
2147
2158
|
schedulingStrategy?: SchedulingStrategy | string;
|
|
2148
2159
|
/**
|
|
2149
2160
|
* <p>The deployment controller type the service is using. When using the DescribeServices
|
|
2150
|
-
* API, this field is omitted if the service
|
|
2161
|
+
* API, this field is omitted if the service uses the <code>ECS</code> deployment
|
|
2151
2162
|
* controller type.</p>
|
|
2152
2163
|
*/
|
|
2153
2164
|
deploymentController?: DeploymentController;
|
|
2154
2165
|
/**
|
|
2155
2166
|
* <p>The metadata that you apply to the service to help you categorize and organize them.
|
|
2156
|
-
* Each tag consists of a key and an optional value
|
|
2167
|
+
* Each tag consists of a key and an optional value. You define bot the key and
|
|
2168
|
+
* value.</p>
|
|
2157
2169
|
* <p>The following basic restrictions apply to tags:</p>
|
|
2158
2170
|
* <ul>
|
|
2159
2171
|
* <li>
|
|
@@ -2192,18 +2204,18 @@ export interface Service {
|
|
|
2192
2204
|
*/
|
|
2193
2205
|
createdBy?: string;
|
|
2194
2206
|
/**
|
|
2195
|
-
* <p>
|
|
2207
|
+
* <p>Determines whether to enable Amazon ECS managed tags for the tasks in the service. For more
|
|
2196
2208
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your Amazon ECS
|
|
2197
2209
|
* Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2198
2210
|
*/
|
|
2199
2211
|
enableECSManagedTags?: boolean;
|
|
2200
2212
|
/**
|
|
2201
|
-
* <p>
|
|
2202
|
-
* task. If no value is specified, the tags
|
|
2213
|
+
* <p>Determines whether to propagate the tags from the task definition or the service to
|
|
2214
|
+
* the task. If no value is specified, the tags aren't propagated.</p>
|
|
2203
2215
|
*/
|
|
2204
2216
|
propagateTags?: PropagateTags | string;
|
|
2205
2217
|
/**
|
|
2206
|
-
* <p>
|
|
2218
|
+
* <p>Determines whether the execute command functionality is enabled for the service. If
|
|
2207
2219
|
* <code>true</code>, the execute command functionality is enabled for all containers
|
|
2208
2220
|
* in tasks as part of the service.</p>
|
|
2209
2221
|
*/
|
|
@@ -2219,12 +2231,12 @@ export interface CreateServiceResponse {
|
|
|
2219
2231
|
/**
|
|
2220
2232
|
* <p>The full description of your service following the create call.</p>
|
|
2221
2233
|
* <p>A service will return either a <code>capacityProviderStrategy</code> or
|
|
2222
|
-
* <code>launchType</code> parameter, but not both, depending
|
|
2223
|
-
*
|
|
2234
|
+
* <code>launchType</code> parameter, but not both, depending where one was specified
|
|
2235
|
+
* when it was created.</p>
|
|
2224
2236
|
* <p>If a service is using the <code>ECS</code> deployment controller, the
|
|
2225
2237
|
* <code>deploymentController</code> and <code>taskSets</code> parameters will not be
|
|
2226
2238
|
* returned.</p>
|
|
2227
|
-
* <p>
|
|
2239
|
+
* <p>if the service uses the <code>CODE_DEPLOY</code> deployment controller, the
|
|
2228
2240
|
* <code>deploymentController</code>, <code>taskSets</code> and
|
|
2229
2241
|
* <code>deployments</code> parameters will be returned, however the
|
|
2230
2242
|
* <code>deployments</code> parameter will be an empty list.</p>
|
|
@@ -2238,8 +2250,8 @@ export declare namespace CreateServiceResponse {
|
|
|
2238
2250
|
const filterSensitiveLog: (obj: CreateServiceResponse) => any;
|
|
2239
2251
|
}
|
|
2240
2252
|
/**
|
|
2241
|
-
* <p>The specified platform version
|
|
2242
|
-
*
|
|
2253
|
+
* <p>The specified platform version doesn't satisfy the required capabilities of the task
|
|
2254
|
+
* definition.</p>
|
|
2243
2255
|
*/
|
|
2244
2256
|
export interface PlatformTaskDefinitionIncompatibilityException extends __SmithyException, $MetadataBearer {
|
|
2245
2257
|
name: "PlatformTaskDefinitionIncompatibilityException";
|
|
@@ -2253,7 +2265,7 @@ export declare namespace PlatformTaskDefinitionIncompatibilityException {
|
|
|
2253
2265
|
const filterSensitiveLog: (obj: PlatformTaskDefinitionIncompatibilityException) => any;
|
|
2254
2266
|
}
|
|
2255
2267
|
/**
|
|
2256
|
-
* <p>The specified platform version
|
|
2268
|
+
* <p>The specified platform version doesn't exist.</p>
|
|
2257
2269
|
*/
|
|
2258
2270
|
export interface PlatformUnknownException extends __SmithyException, $MetadataBearer {
|
|
2259
2271
|
name: "PlatformUnknownException";
|
|
@@ -2267,7 +2279,7 @@ export declare namespace PlatformUnknownException {
|
|
|
2267
2279
|
const filterSensitiveLog: (obj: PlatformUnknownException) => any;
|
|
2268
2280
|
}
|
|
2269
2281
|
/**
|
|
2270
|
-
* <p>The specified task
|
|
2282
|
+
* <p>The specified task isn't supported in this Region.</p>
|
|
2271
2283
|
*/
|
|
2272
2284
|
export interface UnsupportedFeatureException extends __SmithyException, $MetadataBearer {
|
|
2273
2285
|
name: "UnsupportedFeatureException";
|
|
@@ -2317,8 +2329,8 @@ export interface CreateTaskSetRequest {
|
|
|
2317
2329
|
*/
|
|
2318
2330
|
serviceRegistries?: ServiceRegistry[];
|
|
2319
2331
|
/**
|
|
2320
|
-
* <p>The launch type that new tasks in the task set
|
|
2321
|
-
*
|
|
2332
|
+
* <p>The launch type that new tasks in the task set uses. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html">Amazon ECS
|
|
2333
|
+
* Launch Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2322
2334
|
* <p>If a <code>launchType</code> is specified, the <code>capacityProviderStrategy</code>
|
|
2323
2335
|
* parameter must be omitted.</p>
|
|
2324
2336
|
*/
|
|
@@ -2346,9 +2358,9 @@ export interface CreateTaskSetRequest {
|
|
|
2346
2358
|
*/
|
|
2347
2359
|
capacityProviderStrategy?: CapacityProviderStrategyItem[];
|
|
2348
2360
|
/**
|
|
2349
|
-
* <p>The platform version that the tasks in the task set
|
|
2361
|
+
* <p>The platform version that the tasks in the task set uses. A platform version is
|
|
2350
2362
|
* specified only for tasks using the Fargate launch type. If one isn't
|
|
2351
|
-
* specified, the <code>LATEST</code> platform version is used
|
|
2363
|
+
* specified, the <code>LATEST</code> platform version is used.</p>
|
|
2352
2364
|
*/
|
|
2353
2365
|
platformVersion?: string;
|
|
2354
2366
|
/**
|
|
@@ -2357,15 +2369,15 @@ export interface CreateTaskSetRequest {
|
|
|
2357
2369
|
*/
|
|
2358
2370
|
scale?: Scale;
|
|
2359
2371
|
/**
|
|
2360
|
-
* <p>
|
|
2361
|
-
*
|
|
2372
|
+
* <p>The identifier that you provide to ensure the idempotency of the request. It's case
|
|
2373
|
+
* sensitive and must be unique. It can be up to 32 ASCII characters are allowed.</p>
|
|
2362
2374
|
*/
|
|
2363
2375
|
clientToken?: string;
|
|
2364
2376
|
/**
|
|
2365
2377
|
* <p>The metadata that you apply to the task set to help you categorize and organize them.
|
|
2366
|
-
* Each tag consists of a key and an optional value
|
|
2367
|
-
*
|
|
2368
|
-
*
|
|
2378
|
+
* Each tag consists of a key and an optional value. You define both. When a service is
|
|
2379
|
+
* deleted, the tags are deleted.</p>
|
|
2380
|
+
* <p>The following basic restrictions apply to tags:</p>
|
|
2369
2381
|
* <ul>
|
|
2370
2382
|
* <li>
|
|
2371
2383
|
* <p>Maximum number of tags per resource - 50</p>
|
|
@@ -2421,8 +2433,8 @@ export declare namespace CreateTaskSetResponse {
|
|
|
2421
2433
|
const filterSensitiveLog: (obj: CreateTaskSetResponse) => any;
|
|
2422
2434
|
}
|
|
2423
2435
|
/**
|
|
2424
|
-
* <p>The specified service
|
|
2425
|
-
*
|
|
2436
|
+
* <p>The specified service isn't active. You can't update a service that's inactive. If you
|
|
2437
|
+
* have previously deleted a service, you can re-create it with <a>CreateService</a>.</p>
|
|
2426
2438
|
*/
|
|
2427
2439
|
export interface ServiceNotActiveException extends __SmithyException, $MetadataBearer {
|
|
2428
2440
|
name: "ServiceNotActiveException";
|
|
@@ -2436,9 +2448,8 @@ export declare namespace ServiceNotActiveException {
|
|
|
2436
2448
|
const filterSensitiveLog: (obj: ServiceNotActiveException) => any;
|
|
2437
2449
|
}
|
|
2438
2450
|
/**
|
|
2439
|
-
* <p>The specified service
|
|
2440
|
-
*
|
|
2441
|
-
* Region-specific.</p>
|
|
2451
|
+
* <p>The specified service wasn't found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster specific and Region
|
|
2452
|
+
* specific.</p>
|
|
2442
2453
|
*/
|
|
2443
2454
|
export interface ServiceNotFoundException extends __SmithyException, $MetadataBearer {
|
|
2444
2455
|
name: "ServiceNotFoundException";
|
|
@@ -2460,7 +2471,7 @@ export declare enum SettingName {
|
|
|
2460
2471
|
}
|
|
2461
2472
|
export interface DeleteAccountSettingRequest {
|
|
2462
2473
|
/**
|
|
2463
|
-
* <p>The resource name
|
|
2474
|
+
* <p>The resource name to disable the account setting for. If
|
|
2464
2475
|
* <code>serviceLongArnFormat</code> is specified, the ARN for your Amazon ECS services is
|
|
2465
2476
|
* affected. If <code>taskLongArnFormat</code> is specified, the ARN and resource ID for
|
|
2466
2477
|
* your Amazon ECS tasks is affected. If <code>containerInstanceLongArnFormat</code> is
|
|
@@ -2470,11 +2481,11 @@ export interface DeleteAccountSettingRequest {
|
|
|
2470
2481
|
*/
|
|
2471
2482
|
name: SettingName | string | undefined;
|
|
2472
2483
|
/**
|
|
2473
|
-
* <p>The ARN of the principal
|
|
2474
|
-
* specify the root user, it disables the account setting for all IAM
|
|
2475
|
-
* the root user of the account unless an IAM user or role explicitly
|
|
2476
|
-
* settings. If this field is omitted, the setting is changed only for the
|
|
2477
|
-
* user.</p>
|
|
2484
|
+
* <p>The Amazon Resource Name (ARN) of the principal. It can be an IAM user, IAM role, or
|
|
2485
|
+
* the root user. If you specify the root user, it disables the account setting for all IAM
|
|
2486
|
+
* users, IAM roles, and the root user of the account unless an IAM user or role explicitly
|
|
2487
|
+
* overrides these settings. If this field is omitted, the setting is changed only for the
|
|
2488
|
+
* authenticated user.</p>
|
|
2478
2489
|
*/
|
|
2479
2490
|
principalArn?: string;
|
|
2480
2491
|
}
|
|
@@ -2493,12 +2504,13 @@ export interface Setting {
|
|
|
2493
2504
|
*/
|
|
2494
2505
|
name?: SettingName | string;
|
|
2495
2506
|
/**
|
|
2496
|
-
* <p>
|
|
2507
|
+
* <p>Determines whether the account setting is enabled or disabled for the specified
|
|
2508
|
+
* resource.</p>
|
|
2497
2509
|
*/
|
|
2498
2510
|
value?: string;
|
|
2499
2511
|
/**
|
|
2500
|
-
* <p>The ARN of the principal
|
|
2501
|
-
*
|
|
2512
|
+
* <p>The ARN of the principal. It can be an IAM user, IAM role, or the root user. If this
|
|
2513
|
+
* field is omitted, the authenticated user is assumed.</p>
|
|
2502
2514
|
*/
|
|
2503
2515
|
principalArn?: string;
|
|
2504
2516
|
}
|
|
@@ -2524,27 +2536,27 @@ export declare enum TargetType {
|
|
|
2524
2536
|
CONTAINER_INSTANCE = "container-instance"
|
|
2525
2537
|
}
|
|
2526
2538
|
/**
|
|
2527
|
-
* <p>An attribute is a name-value pair associated with an Amazon ECS object. Attributes
|
|
2528
|
-
* you to extend the Amazon ECS data model by adding custom metadata to your resources.
|
|
2529
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2539
|
+
* <p>An attribute is a name-value pair that's associated with an Amazon ECS object. Attributes
|
|
2540
|
+
* enable you to extend the Amazon ECS data model by adding custom metadata to your resources.
|
|
2541
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2530
2542
|
*/
|
|
2531
2543
|
export interface Attribute {
|
|
2532
2544
|
/**
|
|
2533
2545
|
* <p>The name of the attribute. The <code>name</code> must contain between 1 and 128
|
|
2534
|
-
* characters
|
|
2535
|
-
* underscores, forward slashes, back slashes, or periods.</p>
|
|
2546
|
+
* characters. The name may contain letters (uppercase and lowercase), numbers, hyphens
|
|
2547
|
+
* (-), underscores (_), forward slashes (/), back slashes (\), or periods (.).</p>
|
|
2536
2548
|
*/
|
|
2537
2549
|
name: string | undefined;
|
|
2538
2550
|
/**
|
|
2539
2551
|
* <p>The value of the attribute. The <code>value</code> must contain between 1 and 128
|
|
2540
|
-
* characters
|
|
2541
|
-
* underscores, periods, at signs (@), forward slashes, back slashes
|
|
2542
|
-
* The value
|
|
2552
|
+
* characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-),
|
|
2553
|
+
* underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\),
|
|
2554
|
+
* colons (:), or spaces. The value can't can't start or end with a space.</p>
|
|
2543
2555
|
*/
|
|
2544
2556
|
value?: string;
|
|
2545
2557
|
/**
|
|
2546
|
-
* <p>The type of the target
|
|
2547
|
-
*
|
|
2558
|
+
* <p>The type of the target to attach the attribute with. This parameter is required if you
|
|
2559
|
+
* use the short form ID for a resource instead of the full ARN.</p>
|
|
2548
2560
|
*/
|
|
2549
2561
|
targetType?: TargetType | string;
|
|
2550
2562
|
/**
|
|
@@ -2566,8 +2578,8 @@ export interface DeleteAttributesRequest {
|
|
|
2566
2578
|
*/
|
|
2567
2579
|
cluster?: string;
|
|
2568
2580
|
/**
|
|
2569
|
-
* <p>The attributes to delete from your resource. You can specify up to 10 attributes
|
|
2570
|
-
* request. For custom attributes, specify the attribute name and target ID, but
|
|
2581
|
+
* <p>The attributes to delete from your resource. You can specify up to 10 attributes for
|
|
2582
|
+
* each request. For custom attributes, specify the attribute name and target ID, but don't
|
|
2571
2583
|
* specify the value. If you specify the target ID using the short form, you must also
|
|
2572
2584
|
* specify the target type.</p>
|
|
2573
2585
|
*/
|
|
@@ -2592,8 +2604,8 @@ export declare namespace DeleteAttributesResponse {
|
|
|
2592
2604
|
const filterSensitiveLog: (obj: DeleteAttributesResponse) => any;
|
|
2593
2605
|
}
|
|
2594
2606
|
/**
|
|
2595
|
-
* <p>The specified target
|
|
2596
|
-
*
|
|
2607
|
+
* <p>The specified target wasn't found. You can view your available container instances
|
|
2608
|
+
* with <a>ListContainerInstances</a>. Amazon ECS container instances are
|
|
2597
2609
|
* cluster-specific and Region-specific.</p>
|
|
2598
2610
|
*/
|
|
2599
2611
|
export interface TargetNotFoundException extends __SmithyException, $MetadataBearer {
|
|
@@ -2632,7 +2644,7 @@ export declare namespace DeleteCapacityProviderResponse {
|
|
|
2632
2644
|
const filterSensitiveLog: (obj: DeleteCapacityProviderResponse) => any;
|
|
2633
2645
|
}
|
|
2634
2646
|
/**
|
|
2635
|
-
* <p>You
|
|
2647
|
+
* <p>You can't delete a cluster that has registered container instances. First, deregister
|
|
2636
2648
|
* the container instances before you can delete the cluster. For more information, see
|
|
2637
2649
|
* <a>DeregisterContainerInstance</a>.</p>
|
|
2638
2650
|
*/
|
|
@@ -2648,9 +2660,9 @@ export declare namespace ClusterContainsContainerInstancesException {
|
|
|
2648
2660
|
const filterSensitiveLog: (obj: ClusterContainsContainerInstancesException) => any;
|
|
2649
2661
|
}
|
|
2650
2662
|
/**
|
|
2651
|
-
* <p>You
|
|
2652
|
-
*
|
|
2653
|
-
*
|
|
2663
|
+
* <p>You can't delete a cluster that contains services. First, update the service to reduce
|
|
2664
|
+
* its desired task count to 0, and then delete the service. For more information, see
|
|
2665
|
+
* <a>UpdateService</a> and <a>DeleteService</a>.</p>
|
|
2654
2666
|
*/
|
|
2655
2667
|
export interface ClusterContainsServicesException extends __SmithyException, $MetadataBearer {
|
|
2656
2668
|
name: "ClusterContainsServicesException";
|
|
@@ -2664,7 +2676,7 @@ export declare namespace ClusterContainsServicesException {
|
|
|
2664
2676
|
const filterSensitiveLog: (obj: ClusterContainsServicesException) => any;
|
|
2665
2677
|
}
|
|
2666
2678
|
/**
|
|
2667
|
-
* <p>You
|
|
2679
|
+
* <p>You can't delete a cluster that has active tasks.</p>
|
|
2668
2680
|
*/
|
|
2669
2681
|
export interface ClusterContainsTasksException extends __SmithyException, $MetadataBearer {
|
|
2670
2682
|
name: "ClusterContainsTasksException";
|
|
@@ -2712,9 +2724,9 @@ export interface DeleteServiceRequest {
|
|
|
2712
2724
|
*/
|
|
2713
2725
|
service: string | undefined;
|
|
2714
2726
|
/**
|
|
2715
|
-
* <p>If <code>true</code>, allows you to delete a service even if it
|
|
2716
|
-
*
|
|
2717
|
-
*
|
|
2727
|
+
* <p>If <code>true</code>, allows you to delete a service even if it wasn't scaled down to
|
|
2728
|
+
* zero tasks. It's only necessary to use this if the service uses the <code>REPLICA</code>
|
|
2729
|
+
* scheduling strategy.</p>
|
|
2718
2730
|
*/
|
|
2719
2731
|
force?: boolean;
|
|
2720
2732
|
}
|
|
@@ -2739,7 +2751,7 @@ export declare namespace DeleteServiceResponse {
|
|
|
2739
2751
|
export interface DeleteTaskSetRequest {
|
|
2740
2752
|
/**
|
|
2741
2753
|
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task
|
|
2742
|
-
* set
|
|
2754
|
+
* set found in to delete.</p>
|
|
2743
2755
|
*/
|
|
2744
2756
|
cluster: string | undefined;
|
|
2745
2757
|
/**
|
|
@@ -2752,8 +2764,8 @@ export interface DeleteTaskSetRequest {
|
|
|
2752
2764
|
*/
|
|
2753
2765
|
taskSet: string | undefined;
|
|
2754
2766
|
/**
|
|
2755
|
-
* <p>If <code>true</code>,
|
|
2756
|
-
*
|
|
2767
|
+
* <p>If <code>true</code>, you can delete a task set even if it hasn't been scaled down to
|
|
2768
|
+
* zero.</p>
|
|
2757
2769
|
*/
|
|
2758
2770
|
force?: boolean;
|
|
2759
2771
|
}
|
|
@@ -2776,9 +2788,8 @@ export declare namespace DeleteTaskSetResponse {
|
|
|
2776
2788
|
const filterSensitiveLog: (obj: DeleteTaskSetResponse) => any;
|
|
2777
2789
|
}
|
|
2778
2790
|
/**
|
|
2779
|
-
* <p>The specified task set
|
|
2780
|
-
*
|
|
2781
|
-
* and Region.</p>
|
|
2791
|
+
* <p>The specified task set wasn't found. You can view your available task sets with <a>DescribeTaskSets</a>. Task sets are specific to each cluster, service and
|
|
2792
|
+
* Region.</p>
|
|
2782
2793
|
*/
|
|
2783
2794
|
export interface TaskSetNotFoundException extends __SmithyException, $MetadataBearer {
|
|
2784
2795
|
name: "TaskSetNotFoundException";
|
|
@@ -2803,12 +2814,12 @@ export interface DeregisterContainerInstanceRequest {
|
|
|
2803
2814
|
*/
|
|
2804
2815
|
containerInstance: string | undefined;
|
|
2805
2816
|
/**
|
|
2806
|
-
* <p>Forces the
|
|
2817
|
+
* <p>Forces the container instance to be deregistered. If you have tasks running on the
|
|
2807
2818
|
* container instance when you deregister it with the <code>force</code> option, these
|
|
2808
2819
|
* tasks remain running until you terminate the instance or the tasks stop through some
|
|
2809
|
-
* other means, but they
|
|
2810
|
-
*
|
|
2811
|
-
*
|
|
2820
|
+
* other means, but they're orphaned (no longer monitored or accounted for by Amazon ECS). If an
|
|
2821
|
+
* orphaned task on your container instance is part of an Amazon ECS service, then the service
|
|
2822
|
+
* scheduler starts another copy of that task, on a different container instance if
|
|
2812
2823
|
* possible. </p>
|
|
2813
2824
|
* <p>Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer
|
|
2814
2825
|
* target group are deregistered. They begin connection draining according to the settings
|
|
@@ -2822,6 +2833,64 @@ export declare namespace DeregisterContainerInstanceRequest {
|
|
|
2822
2833
|
*/
|
|
2823
2834
|
const filterSensitiveLog: (obj: DeregisterContainerInstanceRequest) => any;
|
|
2824
2835
|
}
|
|
2836
|
+
export declare enum InstanceHealthCheckState {
|
|
2837
|
+
IMPAIRED = "IMPAIRED",
|
|
2838
|
+
INITIALIZING = "INITIALIZING",
|
|
2839
|
+
INSUFFICIENT_DATA = "INSUFFICIENT_DATA",
|
|
2840
|
+
OK = "OK"
|
|
2841
|
+
}
|
|
2842
|
+
export declare enum InstanceHealthCheckType {
|
|
2843
|
+
CONTAINER_RUNTIME = "CONTAINER_RUNTIME"
|
|
2844
|
+
}
|
|
2845
|
+
/**
|
|
2846
|
+
* <p>An object representing the result of a container instance health status check.</p>
|
|
2847
|
+
*/
|
|
2848
|
+
export interface InstanceHealthCheckResult {
|
|
2849
|
+
/**
|
|
2850
|
+
* <p>The type of container instance health status that was verified.</p>
|
|
2851
|
+
*/
|
|
2852
|
+
type?: InstanceHealthCheckType | string;
|
|
2853
|
+
/**
|
|
2854
|
+
* <p>The container instance health status.</p>
|
|
2855
|
+
*/
|
|
2856
|
+
status?: InstanceHealthCheckState | string;
|
|
2857
|
+
/**
|
|
2858
|
+
* <p>The Unix timestamp for when the container instance health status was last
|
|
2859
|
+
* updated.</p>
|
|
2860
|
+
*/
|
|
2861
|
+
lastUpdated?: Date;
|
|
2862
|
+
/**
|
|
2863
|
+
* <p>The Unix timestamp for when the container instance health status last changed.</p>
|
|
2864
|
+
*/
|
|
2865
|
+
lastStatusChange?: Date;
|
|
2866
|
+
}
|
|
2867
|
+
export declare namespace InstanceHealthCheckResult {
|
|
2868
|
+
/**
|
|
2869
|
+
* @internal
|
|
2870
|
+
*/
|
|
2871
|
+
const filterSensitiveLog: (obj: InstanceHealthCheckResult) => any;
|
|
2872
|
+
}
|
|
2873
|
+
/**
|
|
2874
|
+
* <p>An object representing the health status of the container instance.</p>
|
|
2875
|
+
*/
|
|
2876
|
+
export interface ContainerInstanceHealthStatus {
|
|
2877
|
+
/**
|
|
2878
|
+
* <p>The overall health status of the container instance. This is an aggregate status of
|
|
2879
|
+
* all container instance health checks.</p>
|
|
2880
|
+
*/
|
|
2881
|
+
overallStatus?: InstanceHealthCheckState | string;
|
|
2882
|
+
/**
|
|
2883
|
+
* <p>An array of objects representing the details of the container instance health
|
|
2884
|
+
* status.</p>
|
|
2885
|
+
*/
|
|
2886
|
+
details?: InstanceHealthCheckResult[];
|
|
2887
|
+
}
|
|
2888
|
+
export declare namespace ContainerInstanceHealthStatus {
|
|
2889
|
+
/**
|
|
2890
|
+
* @internal
|
|
2891
|
+
*/
|
|
2892
|
+
const filterSensitiveLog: (obj: ContainerInstanceHealthStatus) => any;
|
|
2893
|
+
}
|
|
2825
2894
|
/**
|
|
2826
2895
|
* <p>Describes the resources available for a container instance.</p>
|
|
2827
2896
|
*/
|
|
@@ -2832,7 +2901,7 @@ export interface Resource {
|
|
|
2832
2901
|
*/
|
|
2833
2902
|
name?: string;
|
|
2834
2903
|
/**
|
|
2835
|
-
* <p>The type of the resource
|
|
2904
|
+
* <p>The type of the resource. Valid values: <code>INTEGER</code>, <code>DOUBLE</code>,
|
|
2836
2905
|
* <code>LONG</code>, or <code>STRINGSET</code>.</p>
|
|
2837
2906
|
*/
|
|
2838
2907
|
type?: string;
|
|
@@ -2878,7 +2947,7 @@ export interface VersionInfo {
|
|
|
2878
2947
|
*/
|
|
2879
2948
|
agentHash?: string;
|
|
2880
2949
|
/**
|
|
2881
|
-
* <p>The Docker version running on the container instance.</p>
|
|
2950
|
+
* <p>The Docker version that's running on the container instance.</p>
|
|
2882
2951
|
*/
|
|
2883
2952
|
dockerVersion?: string;
|
|
2884
2953
|
}
|
|
@@ -2889,7 +2958,7 @@ export declare namespace VersionInfo {
|
|
|
2889
2958
|
const filterSensitiveLog: (obj: VersionInfo) => any;
|
|
2890
2959
|
}
|
|
2891
2960
|
/**
|
|
2892
|
-
* <p>An EC2 instance that
|
|
2961
|
+
* <p>An EC2 instance that's running the Amazon ECS agent and has been registered with a
|
|
2893
2962
|
* cluster.</p>
|
|
2894
2963
|
*/
|
|
2895
2964
|
export interface ContainerInstance {
|
|
@@ -2903,13 +2972,13 @@ export interface ContainerInstance {
|
|
|
2903
2972
|
*/
|
|
2904
2973
|
ec2InstanceId?: string;
|
|
2905
2974
|
/**
|
|
2906
|
-
* <p>The capacity provider associated with the container instance.</p>
|
|
2975
|
+
* <p>The capacity provider that's associated with the container instance.</p>
|
|
2907
2976
|
*/
|
|
2908
2977
|
capacityProviderName?: string;
|
|
2909
2978
|
/**
|
|
2910
2979
|
* <p>The version counter for the container instance. Every time a container instance
|
|
2911
2980
|
* experiences a change that triggers a CloudWatch event, the version counter is
|
|
2912
|
-
* incremented. If you
|
|
2981
|
+
* incremented. If you're replicating your Amazon ECS container instance state with CloudWatch
|
|
2913
2982
|
* Events, you can compare the version of a container instance reported by the Amazon ECS APIs
|
|
2914
2983
|
* with the version reported in CloudWatch Events for the container instance (inside the
|
|
2915
2984
|
* <code>detail</code> object) to verify that the version in your event stream is
|
|
@@ -2923,12 +2992,11 @@ export interface ContainerInstance {
|
|
|
2923
2992
|
versionInfo?: VersionInfo;
|
|
2924
2993
|
/**
|
|
2925
2994
|
* <p>For CPU and memory resource types, this parameter describes the remaining CPU and
|
|
2926
|
-
* memory that
|
|
2927
|
-
*
|
|
2928
|
-
*
|
|
2929
|
-
*
|
|
2930
|
-
*
|
|
2931
|
-
* for new tasks.</p>
|
|
2995
|
+
* memory that wasn't already allocated to tasks and is therefore available for new tasks.
|
|
2996
|
+
* For port resource types, this parameter describes the ports that were reserved by the
|
|
2997
|
+
* Amazon ECS container agent (at instance registration time) and any task containers that have
|
|
2998
|
+
* reserved port mappings on the host (with the <code>host</code> or <code>bridge</code>
|
|
2999
|
+
* network mode). Any port that's not specified here is available for new tasks.</p>
|
|
2932
3000
|
*/
|
|
2933
3001
|
remainingResources?: Resource[];
|
|
2934
3002
|
/**
|
|
@@ -2954,7 +3022,7 @@ export interface ContainerInstance {
|
|
|
2954
3022
|
* network interface is deprovisioned. The instance then transitions to an
|
|
2955
3023
|
* <code>INACTIVE</code> status.</p>
|
|
2956
3024
|
* <p>The <code>ACTIVE</code> status indicates that the container instance can accept tasks.
|
|
2957
|
-
* The <code>DRAINING</code> indicates that new tasks
|
|
3025
|
+
* The <code>DRAINING</code> indicates that new tasks aren't placed on the container
|
|
2958
3026
|
* instance and any service tasks running on the container instance are removed if
|
|
2959
3027
|
* possible. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html">Container Instance Draining</a> in the
|
|
2960
3028
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
@@ -2982,8 +3050,8 @@ export interface ContainerInstance {
|
|
|
2982
3050
|
*/
|
|
2983
3051
|
pendingTasksCount?: number;
|
|
2984
3052
|
/**
|
|
2985
|
-
* <p>The status of the most recent agent update. If an update
|
|
2986
|
-
*
|
|
3053
|
+
* <p>The status of the most recent agent update. If an update wasn't ever requested, this
|
|
3054
|
+
* value is <code>NULL</code>.</p>
|
|
2987
3055
|
*/
|
|
2988
3056
|
agentUpdateStatus?: AgentUpdateStatus | string;
|
|
2989
3057
|
/**
|
|
@@ -2993,7 +3061,7 @@ export interface ContainerInstance {
|
|
|
2993
3061
|
*/
|
|
2994
3062
|
attributes?: Attribute[];
|
|
2995
3063
|
/**
|
|
2996
|
-
* <p>The Unix timestamp for when the container instance was registered.</p>
|
|
3064
|
+
* <p>The Unix timestamp for the time when the container instance was registered.</p>
|
|
2997
3065
|
*/
|
|
2998
3066
|
registeredAt?: Date;
|
|
2999
3067
|
/**
|
|
@@ -3003,9 +3071,8 @@ export interface ContainerInstance {
|
|
|
3003
3071
|
attachments?: Attachment[];
|
|
3004
3072
|
/**
|
|
3005
3073
|
* <p>The metadata that you apply to the container instance to help you categorize and
|
|
3006
|
-
* organize them. Each tag consists of a key and an optional value
|
|
3007
|
-
*
|
|
3008
|
-
* <p>The following basic restrictions apply to tags:</p>
|
|
3074
|
+
* organize them. Each tag consists of a key and an optional value. You define both.</p>
|
|
3075
|
+
* <p>The following basic restrictions apply to tags:</p>
|
|
3009
3076
|
* <ul>
|
|
3010
3077
|
* <li>
|
|
3011
3078
|
* <p>Maximum number of tags per resource - 50</p>
|
|
@@ -3038,6 +3105,10 @@ export interface ContainerInstance {
|
|
|
3038
3105
|
* </ul>
|
|
3039
3106
|
*/
|
|
3040
3107
|
tags?: Tag[];
|
|
3108
|
+
/**
|
|
3109
|
+
* <p>An object representing the health status of the container instance.</p>
|
|
3110
|
+
*/
|
|
3111
|
+
healthStatus?: ContainerInstanceHealthStatus;
|
|
3041
3112
|
}
|
|
3042
3113
|
export declare namespace ContainerInstance {
|
|
3043
3114
|
/**
|
|
@@ -3090,21 +3161,20 @@ export declare enum ContainerCondition {
|
|
|
3090
3161
|
* to enable container dependencies. However, we recommend using the latest container agent
|
|
3091
3162
|
* version. For information about checking your agent version and updating to the latest
|
|
3092
3163
|
* version, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html">Updating the Amazon ECS
|
|
3093
|
-
* Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you
|
|
3094
|
-
*
|
|
3164
|
+
* Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using
|
|
3165
|
+
* an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
|
|
3095
3166
|
* <code>ecs-init</code> package. If your container instances are launched from version
|
|
3096
3167
|
* <code>20190301</code> or later, then they contain the required versions of the
|
|
3097
3168
|
* container agent and <code>ecs-init</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
3098
3169
|
* <note>
|
|
3099
|
-
* <p>For tasks
|
|
3170
|
+
* <p>For tasks that use the Fargate launch type, the task or service
|
|
3171
|
+
* requires the following platforms:</p>
|
|
3100
3172
|
* <ul>
|
|
3101
3173
|
* <li>
|
|
3102
|
-
* <p>Linux platform
|
|
3103
|
-
* version <code>1.3.0</code> or later.</p>
|
|
3174
|
+
* <p>Linux platform version <code>1.3.0</code> or later.</p>
|
|
3104
3175
|
* </li>
|
|
3105
3176
|
* <li>
|
|
3106
|
-
* <p>Windows platform
|
|
3107
|
-
* version <code>1.0.0</code> or later.</p>
|
|
3177
|
+
* <p>Windows platform version <code>1.0.0</code> or later.</p>
|
|
3108
3178
|
* </li>
|
|
3109
3179
|
* </ul>
|
|
3110
3180
|
* </note>
|
|
@@ -3129,13 +3199,13 @@ export interface ContainerDependency {
|
|
|
3129
3199
|
* <code>COMPLETE</code> - This condition validates that a dependent
|
|
3130
3200
|
* container runs to completion (exits) before permitting other containers to
|
|
3131
3201
|
* start. This can be useful for nonessential containers that run a script and then
|
|
3132
|
-
* exit. This condition
|
|
3202
|
+
* exit. This condition can't be set on an essential container.</p>
|
|
3133
3203
|
* </li>
|
|
3134
3204
|
* <li>
|
|
3135
3205
|
* <p>
|
|
3136
3206
|
* <code>SUCCESS</code> - This condition is the same as
|
|
3137
3207
|
* <code>COMPLETE</code>, but it also requires that the container exits with a
|
|
3138
|
-
* <code>zero</code> status. This condition
|
|
3208
|
+
* <code>zero</code> status. This condition can't be set on an essential
|
|
3139
3209
|
* container.</p>
|
|
3140
3210
|
* </li>
|
|
3141
3211
|
* <li>
|
|
@@ -3163,24 +3233,23 @@ export declare enum EnvironmentFileType {
|
|
|
3163
3233
|
* specify up to ten environment files. The file must have a <code>.env</code> file
|
|
3164
3234
|
* extension. Each line in an environment file should contain an environment variable in
|
|
3165
3235
|
* <code>VARIABLE=VALUE</code> format. Lines beginning with <code>#</code> are treated
|
|
3166
|
-
* as comments and are ignored. For more information
|
|
3236
|
+
* as comments and are ignored. For more information about the environment variable file
|
|
3167
3237
|
* syntax, see <a href="https://docs.docker.com/compose/env-file/">Declare default
|
|
3168
3238
|
* environment variables in file</a>.</p>
|
|
3169
3239
|
* <p>If there are environment variables specified using the <code>environment</code>
|
|
3170
3240
|
* parameter in a container definition, they take precedence over the variables contained
|
|
3171
3241
|
* within an environment file. If multiple environment files are specified that contain the
|
|
3172
|
-
* same variable, they
|
|
3242
|
+
* same variable, they're processed from the top down. We recommend that you use unique
|
|
3173
3243
|
* variable names. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html">Specifying environment
|
|
3174
3244
|
* variables</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
3175
|
-
* <p>This parameter is only supported for tasks hosted on Fargate using the
|
|
3245
|
+
* <p>This parameter is only supported for tasks hosted on Fargate using the
|
|
3246
|
+
* following platform versions:</p>
|
|
3176
3247
|
* <ul>
|
|
3177
3248
|
* <li>
|
|
3178
|
-
* <p>Linux platform
|
|
3179
|
-
* version <code>1.4.0</code> or later.</p>
|
|
3249
|
+
* <p>Linux platform version <code>1.4.0</code> or later.</p>
|
|
3180
3250
|
* </li>
|
|
3181
3251
|
* <li>
|
|
3182
|
-
* <p>Windows platform
|
|
3183
|
-
* version <code>1.0.0</code> or later.</p>
|
|
3252
|
+
* <p>Windows platform version <code>1.0.0</code> or later.</p>
|
|
3184
3253
|
* </li>
|
|
3185
3254
|
* </ul>
|
|
3186
3255
|
*/
|
|
@@ -3282,7 +3351,7 @@ export declare namespace FirelensConfiguration {
|
|
|
3282
3351
|
* <li>
|
|
3283
3352
|
* <p>
|
|
3284
3353
|
* <code>UNKNOWN</code>-The container health check is being evaluated or
|
|
3285
|
-
* there
|
|
3354
|
+
* there's no container health check defined.</p>
|
|
3286
3355
|
* </li>
|
|
3287
3356
|
* </ul>
|
|
3288
3357
|
* <p>The following describes the possible <code>healthStatus</code> values for a task. The
|
|
@@ -3318,13 +3387,13 @@ export declare namespace FirelensConfiguration {
|
|
|
3318
3387
|
* Amazon ECS Container Agent</a>.</p>
|
|
3319
3388
|
* </li>
|
|
3320
3389
|
* <li>
|
|
3321
|
-
* <p>Container health checks are supported for Fargate tasks if
|
|
3322
|
-
*
|
|
3390
|
+
* <p>Container health checks are supported for Fargate tasks if
|
|
3391
|
+
* you're using platform version 1.1.0 or greater. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate
|
|
3323
3392
|
* Platform Versions</a>.</p>
|
|
3324
3393
|
* </li>
|
|
3325
3394
|
* <li>
|
|
3326
|
-
* <p>Container health checks
|
|
3327
|
-
* that
|
|
3395
|
+
* <p>Container health checks aren't supported for tasks that are part of a service
|
|
3396
|
+
* that's configured to use a Classic Load Balancer.</p>
|
|
3328
3397
|
* </li>
|
|
3329
3398
|
* </ul>
|
|
3330
3399
|
*/
|
|
@@ -3334,11 +3403,12 @@ export interface HealthCheck {
|
|
|
3334
3403
|
* healthy. The string array must start with <code>CMD</code> to execute the command
|
|
3335
3404
|
* arguments directly, or <code>CMD-SHELL</code> to run the command with the container's
|
|
3336
3405
|
* default shell. </p>
|
|
3337
|
-
* <p> When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs,
|
|
3406
|
+
* <p> When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list
|
|
3407
|
+
* of commands in brackets.</p>
|
|
3338
3408
|
* <p>
|
|
3339
3409
|
* <code>[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]</code>
|
|
3340
3410
|
* </p>
|
|
3341
|
-
* <p>You
|
|
3411
|
+
* <p>You don't need to include the brackets when you use the Amazon Web Services Management Console.</p>
|
|
3342
3412
|
* <p>
|
|
3343
3413
|
* <code> "CMD-SHELL", "curl -f http://localhost/ || exit 1" </code>
|
|
3344
3414
|
* </p>
|
|
@@ -3364,9 +3434,9 @@ export interface HealthCheck {
|
|
|
3364
3434
|
*/
|
|
3365
3435
|
retries?: number;
|
|
3366
3436
|
/**
|
|
3367
|
-
* <p>The optional grace period
|
|
3368
|
-
*
|
|
3369
|
-
*
|
|
3437
|
+
* <p>The optional grace period to provide containers time to bootstrap before failed health
|
|
3438
|
+
* checks count towards the maximum number of retries. You can specify between 0 and 300
|
|
3439
|
+
* seconds. By default, the <code>startPeriod</code> is disabled.</p>
|
|
3370
3440
|
* <note>
|
|
3371
3441
|
* <p>If a health check succeeds within the <code>startPeriod</code>, then the container
|
|
3372
3442
|
* is considered healthy and any subsequent failures count toward the maximum number of
|
|
@@ -3383,10 +3453,10 @@ export declare namespace HealthCheck {
|
|
|
3383
3453
|
}
|
|
3384
3454
|
/**
|
|
3385
3455
|
* <p>The Linux capabilities for the container that are added to or dropped from the default
|
|
3386
|
-
* configuration provided by Docker. For more information
|
|
3387
|
-
* the non-default available capabilities, see <a href="https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities">Runtime privilege and Linux capabilities</a> in the <i>Docker run
|
|
3388
|
-
* reference</i>. For more detailed information
|
|
3389
|
-
* the <a href="http://man7.org/linux/man-pages/man7/capabilities.7.html">capabilities(7)</a> Linux manual page.</p>
|
|
3456
|
+
* configuration provided by Docker. For more information about the default capabilities
|
|
3457
|
+
* and the non-default available capabilities, see <a href="https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities">Runtime privilege and Linux capabilities</a> in the <i>Docker run
|
|
3458
|
+
* reference</i>. For more detailed information about these Linux capabilities,
|
|
3459
|
+
* see the <a href="http://man7.org/linux/man-pages/man7/capabilities.7.html">capabilities(7)</a> Linux manual page.</p>
|
|
3390
3460
|
*/
|
|
3391
3461
|
export interface KernelCapabilities {
|
|
3392
3462
|
/**
|
|
@@ -3514,8 +3584,8 @@ export interface LinuxParameters {
|
|
|
3514
3584
|
* <code>Devices</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the
|
|
3515
3585
|
* <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the <code>--device</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>.</p>
|
|
3516
3586
|
* <note>
|
|
3517
|
-
* <p>If you
|
|
3518
|
-
* <code>devices</code> parameter
|
|
3587
|
+
* <p>If you're using tasks that use the Fargate launch type, the
|
|
3588
|
+
* <code>devices</code> parameter isn't supported.</p>
|
|
3519
3589
|
* </note>
|
|
3520
3590
|
*/
|
|
3521
3591
|
devices?: Device[];
|
|
@@ -3539,8 +3609,8 @@ export interface LinuxParameters {
|
|
|
3539
3609
|
* <p>The container path, mount options, and size (in MiB) of the tmpfs mount. This
|
|
3540
3610
|
* parameter maps to the <code>--tmpfs</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>.</p>
|
|
3541
3611
|
* <note>
|
|
3542
|
-
* <p>If you
|
|
3543
|
-
* <code>tmpfs</code> parameter
|
|
3612
|
+
* <p>If you're using tasks that use the Fargate launch type, the
|
|
3613
|
+
* <code>tmpfs</code> parameter isn't supported.</p>
|
|
3544
3614
|
* </note>
|
|
3545
3615
|
*/
|
|
3546
3616
|
tmpfs?: Tmpfs[];
|
|
@@ -3554,8 +3624,8 @@ export interface LinuxParameters {
|
|
|
3554
3624
|
* configuration for the container instance it is running on. A <code>maxSwap</code> value
|
|
3555
3625
|
* must be set for the <code>swappiness</code> parameter to be used.</p>
|
|
3556
3626
|
* <note>
|
|
3557
|
-
* <p>If you
|
|
3558
|
-
* <code>maxSwap</code> parameter
|
|
3627
|
+
* <p>If you're using tasks that use the Fargate launch type, the
|
|
3628
|
+
* <code>maxSwap</code> parameter isn't supported.</p>
|
|
3559
3629
|
* </note>
|
|
3560
3630
|
*/
|
|
3561
3631
|
maxSwap?: number;
|
|
@@ -3569,8 +3639,8 @@ export interface LinuxParameters {
|
|
|
3569
3639
|
* <code>maxSwap</code> then this parameter is ignored. This parameter maps to the
|
|
3570
3640
|
* <code>--memory-swappiness</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>.</p>
|
|
3571
3641
|
* <note>
|
|
3572
|
-
* <p>If you
|
|
3573
|
-
* <code>swappiness</code> parameter
|
|
3642
|
+
* <p>If you're using tasks that use the Fargate launch type, the
|
|
3643
|
+
* <code>swappiness</code> parameter isn't supported.</p>
|
|
3574
3644
|
* </note>
|
|
3575
3645
|
*/
|
|
3576
3646
|
swappiness?: number;
|
|
@@ -3616,9 +3686,10 @@ export interface Secret {
|
|
|
3616
3686
|
* <p>The secret to expose to the container. The supported values are either the full ARN of
|
|
3617
3687
|
* the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.</p>
|
|
3618
3688
|
* <note>
|
|
3619
|
-
* <p>If the SSM Parameter Store parameter exists in the same Region as the task
|
|
3620
|
-
*
|
|
3621
|
-
* parameter exists in a different Region, then the full ARN must be
|
|
3689
|
+
* <p>If the SSM Parameter Store parameter exists in the same Region as the task
|
|
3690
|
+
* you're launching, then you can use either the full ARN or name of the parameter. If
|
|
3691
|
+
* the parameter exists in a different Region, then the full ARN must be
|
|
3692
|
+
* specified.</p>
|
|
3622
3693
|
* </note>
|
|
3623
3694
|
*/
|
|
3624
3695
|
valueFrom: string | undefined;
|
|
@@ -3636,13 +3707,13 @@ export declare namespace Secret {
|
|
|
3636
3707
|
* <code>docker
|
|
3637
3708
|
* run</code>
|
|
3638
3709
|
* </a>.</p>
|
|
3639
|
-
* <p>By default, containers use the same logging driver that the Docker daemon uses
|
|
3640
|
-
*
|
|
3710
|
+
* <p>By default, containers use the same logging driver that the Docker daemon uses.
|
|
3711
|
+
* However, the container might use a different logging driver than the Docker daemon by
|
|
3641
3712
|
* specifying a log driver configuration in the container definition. For more information
|
|
3642
|
-
*
|
|
3713
|
+
* about the options for different supported log drivers, see <a href="https://docs.docker.com/engine/admin/logging/overview/">Configure logging
|
|
3643
3714
|
* drivers</a> in the Docker documentation.</p>
|
|
3644
|
-
* <p>
|
|
3645
|
-
* containers
|
|
3715
|
+
* <p>Understand the following when specifying a log configuration for your
|
|
3716
|
+
* containers.</p>
|
|
3646
3717
|
* <ul>
|
|
3647
3718
|
* <li>
|
|
3648
3719
|
* <p>Amazon ECS currently supports a subset of the logging drivers available to the
|
|
@@ -3654,17 +3725,17 @@ export declare namespace Secret {
|
|
|
3654
3725
|
* your container instance.</p>
|
|
3655
3726
|
* </li>
|
|
3656
3727
|
* <li>
|
|
3657
|
-
* <p>For tasks hosted on Amazon EC2 instances, the Amazon ECS container agent must
|
|
3658
|
-
* the available logging drivers with the
|
|
3728
|
+
* <p>For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must
|
|
3729
|
+
* register the available logging drivers with the
|
|
3659
3730
|
* <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment variable before
|
|
3660
3731
|
* containers placed on that instance can use these log configuration options. For
|
|
3661
3732
|
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html">Amazon ECS container agent configuration</a> in the
|
|
3662
3733
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
3663
3734
|
* </li>
|
|
3664
3735
|
* <li>
|
|
3665
|
-
* <p>For tasks on Fargate, because you
|
|
3666
|
-
* infrastructure your tasks are hosted on, any additional software
|
|
3667
|
-
*
|
|
3736
|
+
* <p>For tasks that are on Fargate, because you don't have access to the
|
|
3737
|
+
* underlying infrastructure your tasks are hosted on, any additional software
|
|
3738
|
+
* needed must be installed outside of the task. For example, the Fluentd output
|
|
3668
3739
|
* aggregators or a remote host running Logstash to send Gelf logs to.</p>
|
|
3669
3740
|
* </li>
|
|
3670
3741
|
* </ul>
|
|
@@ -3683,12 +3754,11 @@ export interface LogConfiguration {
|
|
|
3683
3754
|
* the awslogs log driver</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
3684
3755
|
* <p>For more information about using the <code>awsfirelens</code> log driver, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html">Custom log routing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
3685
3756
|
* <note>
|
|
3686
|
-
* <p>If you have a custom driver that
|
|
3687
|
-
* agent project that
|
|
3757
|
+
* <p>If you have a custom driver that isn't listed, you can fork the Amazon ECS container
|
|
3758
|
+
* agent project that's <a href="https://github.com/aws/amazon-ecs-agent">available
|
|
3688
3759
|
* on GitHub</a> and customize it to work with that driver. We encourage you to
|
|
3689
3760
|
* submit pull requests for changes that you would like to have included. However, we
|
|
3690
|
-
*
|
|
3691
|
-
* software.</p>
|
|
3761
|
+
* don't currently provide support for running modified copies of this software.</p>
|
|
3692
3762
|
* </note>
|
|
3693
3763
|
*/
|
|
3694
3764
|
logDriver: LogDriver | string | undefined;
|
|
@@ -3712,7 +3782,7 @@ export declare namespace LogConfiguration {
|
|
|
3712
3782
|
const filterSensitiveLog: (obj: LogConfiguration) => any;
|
|
3713
3783
|
}
|
|
3714
3784
|
/**
|
|
3715
|
-
* <p>Details
|
|
3785
|
+
* <p>Details for a volume mount point that's used in a container definition.</p>
|
|
3716
3786
|
*/
|
|
3717
3787
|
export interface MountPoint {
|
|
3718
3788
|
/**
|
|
@@ -3745,13 +3815,13 @@ export declare enum TransportProtocol {
|
|
|
3745
3815
|
* <p>Port mappings allow containers to access ports on the host container instance to send
|
|
3746
3816
|
* or receive traffic. Port mappings are specified as part of the container
|
|
3747
3817
|
* definition.</p>
|
|
3748
|
-
* <p>If you
|
|
3749
|
-
*
|
|
3750
|
-
* <code>
|
|
3751
|
-
*
|
|
3818
|
+
* <p>If you use containers in a task with the <code>awsvpc</code> or <code>host</code>
|
|
3819
|
+
* network mode, specify the exposed ports using <code>containerPort</code>. The
|
|
3820
|
+
* <code>hostPort</code> can be left blank or it must be the same value as the
|
|
3821
|
+
* <code>containerPort</code>.</p>
|
|
3752
3822
|
* <note>
|
|
3753
|
-
* <p>You
|
|
3754
|
-
*
|
|
3823
|
+
* <p>You can't expose the same container port for multiple protocols. If you attempt
|
|
3824
|
+
* this, an error is returned.</p>
|
|
3755
3825
|
* </note>
|
|
3756
3826
|
* <p>After a task reaches the <code>RUNNING</code> status, manual and automatic host and
|
|
3757
3827
|
* container port assignments are visible in the <code>networkBindings</code> section of
|
|
@@ -3759,26 +3829,25 @@ export declare enum TransportProtocol {
|
|
|
3759
3829
|
*/
|
|
3760
3830
|
export interface PortMapping {
|
|
3761
3831
|
/**
|
|
3762
|
-
* <p>The port number on the container that
|
|
3832
|
+
* <p>The port number on the container that's bound to the user-specified or automatically
|
|
3763
3833
|
* assigned host port.</p>
|
|
3764
|
-
* <p>If you
|
|
3765
|
-
*
|
|
3766
|
-
*
|
|
3767
|
-
*
|
|
3768
|
-
*
|
|
3769
|
-
*
|
|
3770
|
-
*
|
|
3771
|
-
* count toward the 100 reserved ports limit of a container instance.</p>
|
|
3834
|
+
* <p>If you use containers in a task with the <code>awsvpc</code> or <code>host</code>
|
|
3835
|
+
* network mode, specify the exposed ports using <code>containerPort</code>.</p>
|
|
3836
|
+
* <p>If you use containers in a task with the <code>bridge</code> network mode and you
|
|
3837
|
+
* specify a container port and not a host port, your container automatically receives a
|
|
3838
|
+
* host port in the ephemeral port range. For more information, see <code>hostPort</code>.
|
|
3839
|
+
* Port mappings that are automatically assigned in this way do not count toward the 100
|
|
3840
|
+
* reserved ports limit of a container instance.</p>
|
|
3772
3841
|
*/
|
|
3773
3842
|
containerPort?: number;
|
|
3774
3843
|
/**
|
|
3775
3844
|
* <p>The port number on the container instance to reserve for your container.</p>
|
|
3776
|
-
* <p>If you
|
|
3777
|
-
*
|
|
3778
|
-
*
|
|
3779
|
-
* <p>If you
|
|
3780
|
-
*
|
|
3781
|
-
*
|
|
3845
|
+
* <p>If you use containers in a task with the <code>awsvpc</code> or <code>host</code>
|
|
3846
|
+
* network mode, the <code>hostPort</code> can either be left blank or set to the same
|
|
3847
|
+
* value as the <code>containerPort</code>.</p>
|
|
3848
|
+
* <p>If you use containers in a task with the <code>bridge</code> network mode, you can
|
|
3849
|
+
* specify a non-reserved host port for your container port mapping, or you can omit the
|
|
3850
|
+
* <code>hostPort</code> (or set it to <code>0</code>) while specifying a
|
|
3782
3851
|
* <code>containerPort</code> and your container automatically receives a port in the
|
|
3783
3852
|
* ephemeral port range for your container instance operating system and Docker
|
|
3784
3853
|
* version.</p>
|
|
@@ -3794,12 +3863,12 @@ export interface PortMapping {
|
|
|
3794
3863
|
* </note>
|
|
3795
3864
|
* <p>The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the
|
|
3796
3865
|
* Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in
|
|
3797
|
-
* a running task is also reserved while the task is running
|
|
3798
|
-
* port is released
|
|
3866
|
+
* a running task is also reserved while the task is running. That is, after a task stops,
|
|
3867
|
+
* the host port is released. The current reserved ports are displayed in the
|
|
3799
3868
|
* <code>remainingResources</code> of <a>DescribeContainerInstances</a>
|
|
3800
|
-
* output. A container instance can have up to 100 reserved ports at a time
|
|
3801
|
-
* default reserved ports. Automatically assigned ports
|
|
3802
|
-
* ports
|
|
3869
|
+
* output. A container instance can have up to 100 reserved ports at a time. This number
|
|
3870
|
+
* includes the default reserved ports. Automatically assigned ports aren't included in the
|
|
3871
|
+
* 100 reserved ports quota.</p>
|
|
3803
3872
|
*/
|
|
3804
3873
|
hostPort?: number;
|
|
3805
3874
|
/**
|
|
@@ -3822,10 +3891,10 @@ export interface RepositoryCredentials {
|
|
|
3822
3891
|
* <p>The Amazon Resource Name (ARN) of the secret containing the private repository
|
|
3823
3892
|
* credentials.</p>
|
|
3824
3893
|
* <note>
|
|
3825
|
-
* <p>When you
|
|
3826
|
-
*
|
|
3827
|
-
*
|
|
3828
|
-
*
|
|
3894
|
+
* <p>When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same
|
|
3895
|
+
* Region as the task that you're launching then you can use either the full ARN or the
|
|
3896
|
+
* name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN of the
|
|
3897
|
+
* secret.</p>
|
|
3829
3898
|
* </note>
|
|
3830
3899
|
*/
|
|
3831
3900
|
credentialsParameter: string | undefined;
|
|
@@ -3843,7 +3912,8 @@ export declare enum ResourceType {
|
|
|
3843
3912
|
/**
|
|
3844
3913
|
* <p>The type and amount of a resource to assign to a container. The supported resource
|
|
3845
3914
|
* types are GPUs and Elastic Inference accelerators. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html">Working with
|
|
3846
|
-
* GPUs on Amazon ECS</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html">Working with
|
|
3915
|
+
* GPUs on Amazon ECS</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html">Working with
|
|
3916
|
+
* Amazon Elastic Inference on Amazon ECS</a> in the
|
|
3847
3917
|
* <i>Amazon Elastic Container Service Developer Guide</i>
|
|
3848
3918
|
* </p>
|
|
3849
3919
|
*/
|
|
@@ -3851,12 +3921,12 @@ export interface ResourceRequirement {
|
|
|
3851
3921
|
/**
|
|
3852
3922
|
* <p>The value for the specified resource type.</p>
|
|
3853
3923
|
* <p>If the <code>GPU</code> type is used, the value is the number of physical
|
|
3854
|
-
* <code>GPUs</code> the Amazon ECS container agent
|
|
3855
|
-
*
|
|
3856
|
-
* available GPUs on the container instance the task is launched on.</p>
|
|
3857
|
-
* <p>If the <code>InferenceAccelerator</code> type is used, the <code>value</code>
|
|
3858
|
-
*
|
|
3859
|
-
*
|
|
3924
|
+
* <code>GPUs</code> the Amazon ECS container agent reserves for the container. The number
|
|
3925
|
+
* of GPUs that's reserved for all containers in a task can't exceed the number of
|
|
3926
|
+
* available GPUs on the container instance that the task is launched on.</p>
|
|
3927
|
+
* <p>If the <code>InferenceAccelerator</code> type is used, the <code>value</code> matches
|
|
3928
|
+
* the <code>deviceName</code> for an <a>InferenceAccelerator</a> specified in a
|
|
3929
|
+
* task definition.</p>
|
|
3860
3930
|
*/
|
|
3861
3931
|
value: string | undefined;
|
|
3862
3932
|
/**
|
|
@@ -3875,34 +3945,34 @@ export declare namespace ResourceRequirement {
|
|
|
3875
3945
|
* <p>A list of namespaced kernel parameters to set in the container. This parameter maps to
|
|
3876
3946
|
* <code>Sysctls</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the
|
|
3877
3947
|
* <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the <code>--sysctl</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>.</p>
|
|
3878
|
-
* <p>
|
|
3879
|
-
* parameters for multiple containers in a single task
|
|
3880
|
-
* <code>awsvpc</code> or <code>host</code> network mode for the following
|
|
3881
|
-
* reasons
|
|
3948
|
+
* <p>We don't recommend that you specify network-related <code>systemControls</code>
|
|
3949
|
+
* parameters for multiple containers in a single task. This task also uses either the
|
|
3950
|
+
* <code>awsvpc</code> or <code>host</code> network mode. It does it for the following
|
|
3951
|
+
* reasons.</p>
|
|
3882
3952
|
* <ul>
|
|
3883
3953
|
* <li>
|
|
3884
3954
|
* <p>For tasks that use the <code>awsvpc</code> network mode, if you set
|
|
3885
3955
|
* <code>systemControls</code> for any container, it applies to all containers
|
|
3886
3956
|
* in the task. If you set different <code>systemControls</code> for multiple
|
|
3887
|
-
* containers in a single task, the container that
|
|
3957
|
+
* containers in a single task, the container that's started last determines which
|
|
3888
3958
|
* <code>systemControls</code> take effect.</p>
|
|
3889
3959
|
* </li>
|
|
3890
3960
|
* <li>
|
|
3891
3961
|
* <p>For tasks that use the <code>host</code> network mode, the
|
|
3892
3962
|
* <code>systemControls</code> parameter applies to the container instance's
|
|
3893
|
-
* kernel parameter
|
|
3963
|
+
* kernel parameter and that of all containers of any tasks running on that
|
|
3894
3964
|
* container instance.</p>
|
|
3895
3965
|
* </li>
|
|
3896
3966
|
* </ul>
|
|
3897
3967
|
*/
|
|
3898
3968
|
export interface SystemControl {
|
|
3899
3969
|
/**
|
|
3900
|
-
* <p>The namespaced kernel parameter
|
|
3970
|
+
* <p>The namespaced kernel parameter to set a <code>value</code> for.</p>
|
|
3901
3971
|
*/
|
|
3902
3972
|
namespace?: string;
|
|
3903
3973
|
/**
|
|
3904
|
-
* <p>The value for the namespaced kernel parameter specified in
|
|
3905
|
-
*
|
|
3974
|
+
* <p>The value for the namespaced kernel parameter that's specified in
|
|
3975
|
+
* <code>namespace</code>.</p>
|
|
3906
3976
|
*/
|
|
3907
3977
|
value?: string;
|
|
3908
3978
|
}
|
|
@@ -3964,8 +4034,8 @@ export declare namespace Ulimit {
|
|
|
3964
4034
|
*/
|
|
3965
4035
|
export interface VolumeFrom {
|
|
3966
4036
|
/**
|
|
3967
|
-
* <p>The name of another container within the same task definition
|
|
3968
|
-
*
|
|
4037
|
+
* <p>The name of another container within the same task definition to mount volumes
|
|
4038
|
+
* from.</p>
|
|
3969
4039
|
*/
|
|
3970
4040
|
sourceContainer?: string;
|
|
3971
4041
|
/**
|
|
@@ -3987,7 +4057,7 @@ export declare namespace VolumeFrom {
|
|
|
3987
4057
|
*/
|
|
3988
4058
|
export interface ContainerDefinition {
|
|
3989
4059
|
/**
|
|
3990
|
-
* <p>The name of a container. If you
|
|
4060
|
+
* <p>The name of a container. If you're linking multiple containers together in a task
|
|
3991
4061
|
* definition, the <code>name</code> of one container can be entered in the
|
|
3992
4062
|
* <code>links</code> of another container to connect the containers.
|
|
3993
4063
|
* Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to <code>name</code> in the
|
|
@@ -3998,7 +4068,7 @@ export interface ContainerDefinition {
|
|
|
3998
4068
|
name?: string;
|
|
3999
4069
|
/**
|
|
4000
4070
|
* <p>The image used to start a container. This string is passed directly to the Docker
|
|
4001
|
-
* daemon.
|
|
4071
|
+
* daemon. By default, images in the Docker Hub registry are available. Other repositories
|
|
4002
4072
|
* are specified with either <code>
|
|
4003
4073
|
* <i>repository-url</i>/<i>image</i>:<i>tag</i>
|
|
4004
4074
|
* </code> or <code>
|
|
@@ -4011,8 +4081,7 @@ export interface ContainerDefinition {
|
|
|
4011
4081
|
* <li>
|
|
4012
4082
|
* <p>When a new task starts, the Amazon ECS container agent pulls the latest version of
|
|
4013
4083
|
* the specified image and tag for the container to use. However, subsequent
|
|
4014
|
-
* updates to a repository image
|
|
4015
|
-
* tasks.</p>
|
|
4084
|
+
* updates to a repository image aren't propagated to already running tasks.</p>
|
|
4016
4085
|
* </li>
|
|
4017
4086
|
* <li>
|
|
4018
4087
|
* <p>Images in Amazon ECR repositories can be specified by either using the full
|
|
@@ -4057,17 +4126,17 @@ export interface ContainerDefinition {
|
|
|
4057
4126
|
* <p>Linux containers share unallocated CPU units with other containers on the container
|
|
4058
4127
|
* instance with the same ratio as their allocated amount. For example, if you run a
|
|
4059
4128
|
* single-container task on a single-core instance type with 512 CPU units specified for
|
|
4060
|
-
* that container, and that
|
|
4129
|
+
* that container, and that's the only task running on the container instance, that
|
|
4061
4130
|
* container could use the full 1,024 CPU unit share at any given time. However, if you
|
|
4062
|
-
* launched another copy of the same task on that container instance, each task
|
|
4063
|
-
* guaranteed a minimum of 512 CPU units when needed,
|
|
4064
|
-
* higher CPU usage if the other container was not using it
|
|
4131
|
+
* launched another copy of the same task on that container instance, each task is
|
|
4132
|
+
* guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float
|
|
4133
|
+
* to higher CPU usage if the other container was not using it. If both tasks were 100%
|
|
4065
4134
|
* active all of the time, they would be limited to 512 CPU units.</p>
|
|
4066
4135
|
* <p>On Linux container instances, the Docker daemon on the container instance uses the CPU
|
|
4067
4136
|
* value to calculate the relative CPU share ratios for running containers. For more
|
|
4068
4137
|
* information, see <a href="https://docs.docker.com/engine/reference/run/#cpu-share-constraint">CPU share
|
|
4069
4138
|
* constraint</a> in the Docker documentation. The minimum valid CPU share value
|
|
4070
|
-
* that the Linux kernel allows is 2. However, the CPU parameter
|
|
4139
|
+
* that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you
|
|
4071
4140
|
* can use CPU values below 2 in your container definitions. For CPU values below 2
|
|
4072
4141
|
* (including null), the behavior varies based on your Amazon ECS container agent
|
|
4073
4142
|
* version:</p>
|
|
@@ -4086,7 +4155,7 @@ export interface ContainerDefinition {
|
|
|
4086
4155
|
* </li>
|
|
4087
4156
|
* </ul>
|
|
4088
4157
|
* <p>On Windows container instances, the CPU limit is enforced as an absolute limit, or a
|
|
4089
|
-
* quota. Windows containers only have access to the specified amount of CPU that
|
|
4158
|
+
* quota. Windows containers only have access to the specified amount of CPU that's
|
|
4090
4159
|
* described in the task definition. A null or zero CPU value is passed to Docker as
|
|
4091
4160
|
* <code>0</code>, which Windows interprets as 1% of one CPU.</p>
|
|
4092
4161
|
*/
|
|
@@ -4104,10 +4173,10 @@ export interface ContainerDefinition {
|
|
|
4104
4173
|
* <code>memory</code> and <code>memoryReservation</code> value, <code>memory</code>
|
|
4105
4174
|
* must be greater than <code>memoryReservation</code>. If you specify
|
|
4106
4175
|
* <code>memoryReservation</code>, then that value is subtracted from the available
|
|
4107
|
-
* memory resources for the container instance
|
|
4176
|
+
* memory resources for the container instance where the container is placed. Otherwise,
|
|
4108
4177
|
* the value of <code>memory</code> is used.</p>
|
|
4109
|
-
* <p>The Docker daemon reserves a minimum of 4 MiB of memory for a container,
|
|
4110
|
-
*
|
|
4178
|
+
* <p>The Docker daemon reserves a minimum of 4 MiB of memory for a container. Therefore, we
|
|
4179
|
+
* recommend that you specify fewer than 4 MiB of memory for your containers.</p>
|
|
4111
4180
|
*/
|
|
4112
4181
|
memory?: number;
|
|
4113
4182
|
/**
|
|
@@ -4123,7 +4192,7 @@ export interface ContainerDefinition {
|
|
|
4123
4192
|
* definition. If you specify both, <code>memory</code> must be greater than
|
|
4124
4193
|
* <code>memoryReservation</code>. If you specify <code>memoryReservation</code>, then
|
|
4125
4194
|
* that value is subtracted from the available memory resources for the container instance
|
|
4126
|
-
*
|
|
4195
|
+
* where the container is placed. Otherwise, the value of <code>memory</code> is
|
|
4127
4196
|
* used.</p>
|
|
4128
4197
|
* <p>For example, if your container normally uses 128 MiB of memory, but occasionally
|
|
4129
4198
|
* bursts to 256 MiB of memory for short periods of time, you can set a
|
|
@@ -4131,8 +4200,8 @@ export interface ContainerDefinition {
|
|
|
4131
4200
|
* 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory
|
|
4132
4201
|
* from the remaining resources on the container instance, but also allow the container to
|
|
4133
4202
|
* consume more memory resources when needed.</p>
|
|
4134
|
-
* <p>The Docker daemon reserves a minimum of 4 MiB of memory for a container,
|
|
4135
|
-
*
|
|
4203
|
+
* <p>The Docker daemon reserves a minimum of 4 MiB of memory for a container. Therefore, we
|
|
4204
|
+
* recommend that you specify fewer than 4 MiB of memory for your containers. </p>
|
|
4136
4205
|
*/
|
|
4137
4206
|
memoryReservation?: number;
|
|
4138
4207
|
/**
|
|
@@ -4146,10 +4215,10 @@ export interface ContainerDefinition {
|
|
|
4146
4215
|
* <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the
|
|
4147
4216
|
* <code>--link</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
4148
4217
|
* run</a>.</p>
|
|
4149
|
-
*
|
|
4218
|
+
* <note>
|
|
4150
4219
|
* <p>This parameter is not supported for Windows containers.</p>
|
|
4151
4220
|
* </note>
|
|
4152
|
-
*
|
|
4221
|
+
* <important>
|
|
4153
4222
|
* <p>Containers that are collocated on a single container instance may be able to
|
|
4154
4223
|
* communicate with each other without requiring links or host port mappings. Network
|
|
4155
4224
|
* isolation is achieved on the container instance using security groups and VPC
|
|
@@ -4160,12 +4229,12 @@ export interface ContainerDefinition {
|
|
|
4160
4229
|
/**
|
|
4161
4230
|
* <p>The list of port mappings for the container. Port mappings allow containers to access
|
|
4162
4231
|
* ports on the host container instance to send or receive traffic.</p>
|
|
4163
|
-
* <p>For task definitions that use the <code>awsvpc</code> network mode,
|
|
4164
|
-
*
|
|
4165
|
-
*
|
|
4232
|
+
* <p>For task definitions that use the <code>awsvpc</code> network mode, only specify the
|
|
4233
|
+
* <code>containerPort</code>. The <code>hostPort</code> can be left blank or it must
|
|
4234
|
+
* be the same value as the <code>containerPort</code>.</p>
|
|
4166
4235
|
* <p>Port mappings on Windows use the <code>NetNAT</code> gateway address rather than
|
|
4167
|
-
* <code>localhost</code>. There
|
|
4168
|
-
*
|
|
4236
|
+
* <code>localhost</code>. There's no loopback for port mappings on Windows, so you
|
|
4237
|
+
* can't access a container's mapped port from the host itself. </p>
|
|
4169
4238
|
* <p>This parameter maps to <code>PortBindings</code> in the
|
|
4170
4239
|
* <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the
|
|
4171
4240
|
* <code>--publish</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
@@ -4187,33 +4256,33 @@ export interface ContainerDefinition {
|
|
|
4187
4256
|
* <p>If the <code>essential</code> parameter of a container is marked as <code>true</code>,
|
|
4188
4257
|
* and that container fails or stops for any reason, all other containers that are part of
|
|
4189
4258
|
* the task are stopped. If the <code>essential</code> parameter of a container is marked
|
|
4190
|
-
* as <code>false</code>,
|
|
4191
|
-
*
|
|
4192
|
-
* <p>All tasks must have at least one essential container. If you have an application
|
|
4193
|
-
*
|
|
4194
|
-
*
|
|
4259
|
+
* as <code>false</code>, its failure doesn't affect the rest of the containers in a task.
|
|
4260
|
+
* If this parameter is omitted, a container is assumed to be essential.</p>
|
|
4261
|
+
* <p>All tasks must have at least one essential container. If you have an application
|
|
4262
|
+
* that's composed of multiple containers, group containers that are used for a common
|
|
4263
|
+
* purpose into components, and separate the different components into multiple task
|
|
4195
4264
|
* definitions. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html">Application
|
|
4196
4265
|
* Architecture</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4197
4266
|
*/
|
|
4198
4267
|
essential?: boolean;
|
|
4199
4268
|
/**
|
|
4200
4269
|
* <important>
|
|
4201
|
-
* <p>Early versions of the Amazon ECS container agent
|
|
4270
|
+
* <p>Early versions of the Amazon ECS container agent don't properly handle
|
|
4202
4271
|
* <code>entryPoint</code> parameters. If you have problems using
|
|
4203
4272
|
* <code>entryPoint</code>, update your container agent or enter your commands and
|
|
4204
4273
|
* arguments as <code>command</code> array items instead.</p>
|
|
4205
4274
|
* </important>
|
|
4206
|
-
* <p>The entry point that
|
|
4275
|
+
* <p>The entry point that's passed to the container. This parameter maps to
|
|
4207
4276
|
* <code>Entrypoint</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the
|
|
4208
4277
|
* <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the <code>--entrypoint</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>. For more information, see <a href="https://docs.docker.com/engine/reference/builder/#entrypoint">https://docs.docker.com/engine/reference/builder/#entrypoint</a>.</p>
|
|
4209
4278
|
*/
|
|
4210
4279
|
entryPoint?: string[];
|
|
4211
4280
|
/**
|
|
4212
|
-
* <p>The command that
|
|
4213
|
-
*
|
|
4281
|
+
* <p>The command that's passed to the container. This parameter maps to <code>Cmd</code> in
|
|
4282
|
+
* the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the
|
|
4214
4283
|
* <code>COMMAND</code> parameter to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
4215
4284
|
* run</a>. For more information, see <a href="https://docs.docker.com/engine/reference/builder/#cmd">https://docs.docker.com/engine/reference/builder/#cmd</a>. If there are multiple arguments, each
|
|
4216
|
-
* argument
|
|
4285
|
+
* argument is a separated string in the array.</p>
|
|
4217
4286
|
*/
|
|
4218
4287
|
command?: string[];
|
|
4219
4288
|
/**
|
|
@@ -4221,7 +4290,7 @@ export interface ContainerDefinition {
|
|
|
4221
4290
|
* <code>Env</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the
|
|
4222
4291
|
* <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the <code>--env</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>.</p>
|
|
4223
4292
|
* <important>
|
|
4224
|
-
* <p>We
|
|
4293
|
+
* <p>We don't recommend that you use plaintext environment variables for sensitive
|
|
4225
4294
|
* information, such as credential data.</p>
|
|
4226
4295
|
* </important>
|
|
4227
4296
|
*/
|
|
@@ -4230,15 +4299,15 @@ export interface ContainerDefinition {
|
|
|
4230
4299
|
* <p>A list of files containing the environment variables to pass to a container. This
|
|
4231
4300
|
* parameter maps to the <code>--env-file</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>.</p>
|
|
4232
4301
|
* <p>You can specify up to ten environment files. The file must have a <code>.env</code>
|
|
4233
|
-
* file extension. Each line in an environment file
|
|
4234
|
-
*
|
|
4235
|
-
* as comments and are ignored. For more information
|
|
4302
|
+
* file extension. Each line in an environment file contains an environment variable in
|
|
4303
|
+
* <code>VARIABLE=VALUE</code> format. Lines beginning with <code>#</code> are treated
|
|
4304
|
+
* as comments and are ignored. For more information about the environment variable file
|
|
4236
4305
|
* syntax, see <a href="https://docs.docker.com/compose/env-file/">Declare default
|
|
4237
4306
|
* environment variables in file</a>.</p>
|
|
4238
4307
|
* <p>If there are environment variables specified using the <code>environment</code>
|
|
4239
4308
|
* parameter in a container definition, they take precedence over the variables contained
|
|
4240
4309
|
* within an environment file. If multiple environment files are specified that contain the
|
|
4241
|
-
* same variable, they
|
|
4310
|
+
* same variable, they're processed from the top down. We recommend that you use unique
|
|
4242
4311
|
* variable names. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html">Specifying Environment
|
|
4243
4312
|
* Variables</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4244
4313
|
*/
|
|
@@ -4248,8 +4317,8 @@ export interface ContainerDefinition {
|
|
|
4248
4317
|
* <p>This parameter maps to <code>Volumes</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a>
|
|
4249
4318
|
* section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the <code>--volume</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>.</p>
|
|
4250
4319
|
* <p>Windows containers can mount whole directories on the same drive as
|
|
4251
|
-
* <code>$env:ProgramData</code>. Windows containers
|
|
4252
|
-
* different drive, and mount point
|
|
4320
|
+
* <code>$env:ProgramData</code>. Windows containers can't mount directories on a
|
|
4321
|
+
* different drive, and mount point can't be across drives.</p>
|
|
4253
4322
|
*/
|
|
4254
4323
|
mountPoints?: MountPoint[];
|
|
4255
4324
|
/**
|
|
@@ -4279,20 +4348,19 @@ export interface ContainerDefinition {
|
|
|
4279
4348
|
* least version 1.26.0 of the container agent to enable container dependencies. However,
|
|
4280
4349
|
* we recommend using the latest container agent version. For information about checking
|
|
4281
4350
|
* your agent version and updating to the latest version, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html">Updating the Amazon ECS
|
|
4282
|
-
* Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you
|
|
4283
|
-
*
|
|
4351
|
+
* Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using
|
|
4352
|
+
* an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
|
|
4284
4353
|
* <code>ecs-init</code> package. If your container instances are launched from version
|
|
4285
4354
|
* <code>20190301</code> or later, then they contain the required versions of the
|
|
4286
4355
|
* container agent and <code>ecs-init</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4287
|
-
* <p>For tasks using the Fargate launch type, the task or service requires
|
|
4356
|
+
* <p>For tasks using the Fargate launch type, the task or service requires
|
|
4357
|
+
* the following platforms:</p>
|
|
4288
4358
|
* <ul>
|
|
4289
4359
|
* <li>
|
|
4290
|
-
* <p>Linux platform
|
|
4291
|
-
* version <code>1.3.0</code> or later.</p>
|
|
4360
|
+
* <p>Linux platform version <code>1.3.0</code> or later.</p>
|
|
4292
4361
|
* </li>
|
|
4293
4362
|
* <li>
|
|
4294
|
-
* <p>Windows platform
|
|
4295
|
-
* version <code>1.0.0</code> or later.</p>
|
|
4363
|
+
* <p>Windows platform version <code>1.0.0</code> or later.</p>
|
|
4296
4364
|
* </li>
|
|
4297
4365
|
* </ul>
|
|
4298
4366
|
*/
|
|
@@ -4302,22 +4370,21 @@ export interface ContainerDefinition {
|
|
|
4302
4370
|
* container. For example, you specify two containers in a task definition with containerA
|
|
4303
4371
|
* having a dependency on containerB reaching a <code>COMPLETE</code>,
|
|
4304
4372
|
* <code>SUCCESS</code>, or <code>HEALTHY</code> status. If a <code>startTimeout</code>
|
|
4305
|
-
* value is specified for containerB and it
|
|
4306
|
-
* time then containerA
|
|
4307
|
-
*
|
|
4373
|
+
* value is specified for containerB and it doesn't reach the desired status within that
|
|
4374
|
+
* time then containerA gives up and not start. This results in the task transitioning to a
|
|
4375
|
+
* <code>STOPPED</code> state.</p>
|
|
4308
4376
|
* <note>
|
|
4309
4377
|
* <p>When the <code>ECS_CONTAINER_START_TIMEOUT</code> container agent configuration
|
|
4310
|
-
* variable is used, it
|
|
4378
|
+
* variable is used, it's enforced independently from this start timeout value.</p>
|
|
4311
4379
|
* </note>
|
|
4312
|
-
* <p>For tasks using the Fargate launch type, the task or service requires
|
|
4380
|
+
* <p>For tasks using the Fargate launch type, the task or service requires
|
|
4381
|
+
* the following platforms:</p>
|
|
4313
4382
|
* <ul>
|
|
4314
4383
|
* <li>
|
|
4315
|
-
* <p>Linux platform
|
|
4316
|
-
* version <code>1.3.0</code> or later.</p>
|
|
4384
|
+
* <p>Linux platform version <code>1.3.0</code> or later.</p>
|
|
4317
4385
|
* </li>
|
|
4318
4386
|
* <li>
|
|
4319
|
-
* <p>Windows platform
|
|
4320
|
-
* version <code>1.0.0</code> or later.</p>
|
|
4387
|
+
* <p>Windows platform version <code>1.0.0</code> or later.</p>
|
|
4321
4388
|
* </li>
|
|
4322
4389
|
* </ul>
|
|
4323
4390
|
* <p>For tasks using the EC2 launch type, your container instances require at
|
|
@@ -4325,9 +4392,9 @@ export interface ContainerDefinition {
|
|
|
4325
4392
|
* timeout value. However, we recommend using the latest container agent version. For
|
|
4326
4393
|
* information about checking your agent version and updating to the latest version, see
|
|
4327
4394
|
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html">Updating the Amazon ECS
|
|
4328
|
-
* Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you
|
|
4329
|
-
*
|
|
4330
|
-
*
|
|
4395
|
+
* Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using
|
|
4396
|
+
* an Amazon ECS-optimized Linux AMI, your instance needs at least version <code>1.26.0-1</code> of the
|
|
4397
|
+
* <code>ecs-init</code> package. If your container instances are launched from version
|
|
4331
4398
|
* <code>20190301</code> or later, then they contain the required versions of the
|
|
4332
4399
|
* container agent and <code>ecs-init</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4333
4400
|
*/
|
|
@@ -4335,22 +4402,21 @@ export interface ContainerDefinition {
|
|
|
4335
4402
|
/**
|
|
4336
4403
|
* <p>Time duration (in seconds) to wait before the container is forcefully killed if it
|
|
4337
4404
|
* doesn't exit normally on its own.</p>
|
|
4338
|
-
* <p>For tasks using the Fargate launch type, the task or service requires
|
|
4405
|
+
* <p>For tasks using the Fargate launch type, the task or service requires
|
|
4406
|
+
* the following platforms:</p>
|
|
4339
4407
|
* <ul>
|
|
4340
4408
|
* <li>
|
|
4341
|
-
* <p>Linux platform
|
|
4342
|
-
* version <code>1.3.0</code> or later.</p>
|
|
4409
|
+
* <p>Linux platform version <code>1.3.0</code> or later.</p>
|
|
4343
4410
|
* </li>
|
|
4344
4411
|
* <li>
|
|
4345
|
-
* <p>Windows platform
|
|
4346
|
-
* version <code>1.0.0</code> or later.</p>
|
|
4412
|
+
* <p>Windows platform version <code>1.0.0</code> or later.</p>
|
|
4347
4413
|
* </li>
|
|
4348
4414
|
* </ul>
|
|
4349
|
-
* <p>The max stop timeout value is 120 seconds and if the
|
|
4350
|
-
*
|
|
4351
|
-
* <p>For tasks
|
|
4352
|
-
* parameter
|
|
4353
|
-
* variable <code>ECS_CONTAINER_STOP_TIMEOUT</code> is used
|
|
4415
|
+
* <p>The max stop timeout value is 120 seconds and if the parameter is not specified, the
|
|
4416
|
+
* default value of 30 seconds is used.</p>
|
|
4417
|
+
* <p>For tasks that use the EC2 launch type, if the <code>stopTimeout</code>
|
|
4418
|
+
* parameter isn't specified, the value set for the Amazon ECS container agent configuration
|
|
4419
|
+
* variable <code>ECS_CONTAINER_STOP_TIMEOUT</code> is used. If neither the
|
|
4354
4420
|
* <code>stopTimeout</code> parameter or the <code>ECS_CONTAINER_STOP_TIMEOUT</code>
|
|
4355
4421
|
* agent configuration variable are set, then the default values of 30 seconds for Linux
|
|
4356
4422
|
* containers and 30 seconds on Windows containers are used. Your container instances
|
|
@@ -4358,8 +4424,8 @@ export interface ContainerDefinition {
|
|
|
4358
4424
|
* timeout value. However, we recommend using the latest container agent version. For
|
|
4359
4425
|
* information about checking your agent version and updating to the latest version, see
|
|
4360
4426
|
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html">Updating the Amazon ECS
|
|
4361
|
-
* Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you
|
|
4362
|
-
*
|
|
4427
|
+
* Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using
|
|
4428
|
+
* an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
|
|
4363
4429
|
* <code>ecs-init</code> package. If your container instances are launched from version
|
|
4364
4430
|
* <code>20190301</code> or later, then they contain the required versions of the
|
|
4365
4431
|
* container agent and <code>ecs-init</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
@@ -4371,7 +4437,7 @@ export interface ContainerDefinition {
|
|
|
4371
4437
|
* <code>--hostname</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
4372
4438
|
* run</a>.</p>
|
|
4373
4439
|
* <note>
|
|
4374
|
-
* <p>The <code>hostname</code> parameter is not supported if you
|
|
4440
|
+
* <p>The <code>hostname</code> parameter is not supported if you're using the
|
|
4375
4441
|
* <code>awsvpc</code> network mode.</p>
|
|
4376
4442
|
* </note>
|
|
4377
4443
|
*/
|
|
@@ -4382,9 +4448,9 @@ export interface ContainerDefinition {
|
|
|
4382
4448
|
* <code>--user</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
4383
4449
|
* run</a>.</p>
|
|
4384
4450
|
* <important>
|
|
4385
|
-
* <p>When running tasks using the <code>host</code> network mode,
|
|
4386
|
-
*
|
|
4387
|
-
*
|
|
4451
|
+
* <p>When running tasks using the <code>host</code> network mode, don't run containers
|
|
4452
|
+
* using the root user (UID 0). We recommend using a non-root user for better
|
|
4453
|
+
* security.</p>
|
|
4388
4454
|
* </important>
|
|
4389
4455
|
* <p>You can specify the <code>user</code> using the following formats. If specifying a UID
|
|
4390
4456
|
* or GID, you must specify it as a positive integer.</p>
|
|
@@ -4420,14 +4486,14 @@ export interface ContainerDefinition {
|
|
|
4420
4486
|
* </p>
|
|
4421
4487
|
* </li>
|
|
4422
4488
|
* </ul>
|
|
4423
|
-
*
|
|
4489
|
+
* <note>
|
|
4424
4490
|
* <p>This parameter is not supported for Windows containers.</p>
|
|
4425
4491
|
* </note>
|
|
4426
4492
|
*/
|
|
4427
4493
|
user?: string;
|
|
4428
4494
|
/**
|
|
4429
|
-
* <p>The working directory
|
|
4430
|
-
*
|
|
4495
|
+
* <p>The working directory to run commands inside the container in. This parameter maps to
|
|
4496
|
+
* <code>WorkingDir</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the
|
|
4431
4497
|
* <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the <code>--workdir</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>.</p>
|
|
4432
4498
|
*/
|
|
4433
4499
|
workingDirectory?: string;
|
|
@@ -4435,7 +4501,7 @@ export interface ContainerDefinition {
|
|
|
4435
4501
|
* <p>When this parameter is true, networking is disabled within the container. This
|
|
4436
4502
|
* parameter maps to <code>NetworkDisabled</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a>
|
|
4437
4503
|
* section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a>.</p>
|
|
4438
|
-
*
|
|
4504
|
+
* <note>
|
|
4439
4505
|
* <p>This parameter is not supported for Windows containers.</p>
|
|
4440
4506
|
* </note>
|
|
4441
4507
|
*/
|
|
@@ -4445,7 +4511,7 @@ export interface ContainerDefinition {
|
|
|
4445
4511
|
* container instance (similar to the <code>root</code> user). This parameter maps to
|
|
4446
4512
|
* <code>Privileged</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the
|
|
4447
4513
|
* <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the <code>--privileged</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>.</p>
|
|
4448
|
-
*
|
|
4514
|
+
* <note>
|
|
4449
4515
|
* <p>This parameter is not supported for Windows containers or tasks run on Fargate.</p>
|
|
4450
4516
|
* </note>
|
|
4451
4517
|
*/
|
|
@@ -4456,7 +4522,7 @@ export interface ContainerDefinition {
|
|
|
4456
4522
|
* <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the
|
|
4457
4523
|
* <code>--read-only</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
4458
4524
|
* run</a>.</p>
|
|
4459
|
-
*
|
|
4525
|
+
* <note>
|
|
4460
4526
|
* <p>This parameter is not supported for Windows containers.</p>
|
|
4461
4527
|
* </note>
|
|
4462
4528
|
*/
|
|
@@ -4465,7 +4531,7 @@ export interface ContainerDefinition {
|
|
|
4465
4531
|
* <p>A list of DNS servers that are presented to the container. This parameter maps to
|
|
4466
4532
|
* <code>Dns</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the
|
|
4467
4533
|
* <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the <code>--dns</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>.</p>
|
|
4468
|
-
*
|
|
4534
|
+
* <note>
|
|
4469
4535
|
* <p>This parameter is not supported for Windows containers.</p>
|
|
4470
4536
|
* </note>
|
|
4471
4537
|
*/
|
|
@@ -4474,7 +4540,7 @@ export interface ContainerDefinition {
|
|
|
4474
4540
|
* <p>A list of DNS search domains that are presented to the container. This parameter maps
|
|
4475
4541
|
* to <code>DnsSearch</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the
|
|
4476
4542
|
* <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the <code>--dns-search</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>.</p>
|
|
4477
|
-
*
|
|
4543
|
+
* <note>
|
|
4478
4544
|
* <p>This parameter is not supported for Windows containers.</p>
|
|
4479
4545
|
* </note>
|
|
4480
4546
|
*/
|
|
@@ -4486,14 +4552,14 @@ export interface ContainerDefinition {
|
|
|
4486
4552
|
* <code>--add-host</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
4487
4553
|
* run</a>.</p>
|
|
4488
4554
|
* <note>
|
|
4489
|
-
* <p>This parameter
|
|
4555
|
+
* <p>This parameter isn't supported for Windows containers or tasks that use the
|
|
4490
4556
|
* <code>awsvpc</code> network mode.</p>
|
|
4491
4557
|
* </note>
|
|
4492
4558
|
*/
|
|
4493
4559
|
extraHosts?: HostEntry[];
|
|
4494
4560
|
/**
|
|
4495
4561
|
* <p>A list of strings to provide custom labels for SELinux and AppArmor multi-level
|
|
4496
|
-
* security systems. This field
|
|
4562
|
+
* security systems. This field isn't valid for containers in tasks using the
|
|
4497
4563
|
* Fargate launch type.</p>
|
|
4498
4564
|
* <p>With Windows containers, this parameter can be used to reference a credential spec
|
|
4499
4565
|
* file when configuring a container for Active Directory authentication. For more
|
|
@@ -4517,10 +4583,10 @@ export interface ContainerDefinition {
|
|
|
4517
4583
|
*/
|
|
4518
4584
|
dockerSecurityOptions?: string[];
|
|
4519
4585
|
/**
|
|
4520
|
-
* <p>When this parameter is <code>true</code>,
|
|
4521
|
-
*
|
|
4522
|
-
*
|
|
4523
|
-
*
|
|
4586
|
+
* <p>When this parameter is <code>true</code>, you can deploy containerized applications
|
|
4587
|
+
* that require <code>stdin</code> or a <code>tty</code> to be allocated. This parameter
|
|
4588
|
+
* maps to <code>OpenStdin</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the
|
|
4589
|
+
* <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the <code>--interactive</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>.</p>
|
|
4524
4590
|
*/
|
|
4525
4591
|
interactive?: boolean;
|
|
4526
4592
|
/**
|
|
@@ -4540,8 +4606,8 @@ export interface ContainerDefinition {
|
|
|
4540
4606
|
};
|
|
4541
4607
|
/**
|
|
4542
4608
|
* <p>A list of <code>ulimits</code> to set in the container. If a ulimit value is specified
|
|
4543
|
-
* in a task definition, it
|
|
4544
|
-
*
|
|
4609
|
+
* in a task definition, it overrides the default values set by Docker. This parameter maps
|
|
4610
|
+
* to <code>Ulimits</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the
|
|
4545
4611
|
* <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the <code>--ulimit</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>. Valid naming values are displayed
|
|
4546
4612
|
* in the <a>Ulimit</a> data type.</p>
|
|
4547
4613
|
* <p>Amazon ECS tasks hosted on Fargate use the default
|
|
@@ -4553,7 +4619,7 @@ export interface ContainerDefinition {
|
|
|
4553
4619
|
* is <code>4096</code>.</p>
|
|
4554
4620
|
* <p>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: <code>sudo docker version --format '{{.Server.APIVersion}}'</code>
|
|
4555
4621
|
* </p>
|
|
4556
|
-
*
|
|
4622
|
+
* <note>
|
|
4557
4623
|
* <p>This parameter is not supported for Windows containers.</p>
|
|
4558
4624
|
* </note>
|
|
4559
4625
|
*/
|
|
@@ -4564,12 +4630,12 @@ export interface ContainerDefinition {
|
|
|
4564
4630
|
* <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the
|
|
4565
4631
|
* <code>--log-driver</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
4566
4632
|
* run</a>. By default, containers use the same logging driver that the Docker
|
|
4567
|
-
* daemon uses. However the container
|
|
4633
|
+
* daemon uses. However the container can use a different logging driver than the Docker
|
|
4568
4634
|
* daemon by specifying a log driver with this parameter in the container definition. To
|
|
4569
4635
|
* use a different logging driver for a container, the log system must be configured
|
|
4570
4636
|
* properly on the container instance (or on a different log server for remote logging
|
|
4571
|
-
* options). For more information
|
|
4572
|
-
*
|
|
4637
|
+
* options). For more information about the options for different supported log drivers,
|
|
4638
|
+
* see <a href="https://docs.docker.com/engine/admin/logging/overview/">Configure
|
|
4573
4639
|
* logging drivers</a> in the Docker documentation.</p>
|
|
4574
4640
|
* <note>
|
|
4575
4641
|
* <p>Amazon ECS currently supports a subset of the logging drivers available to the Docker
|
|
@@ -4601,10 +4667,10 @@ export interface ContainerDefinition {
|
|
|
4601
4667
|
* <code>Sysctls</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the
|
|
4602
4668
|
* <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the <code>--sysctl</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>.</p>
|
|
4603
4669
|
* <note>
|
|
4604
|
-
* <p>
|
|
4670
|
+
* <p>We don't recommended that you specify network-related <code>systemControls</code>
|
|
4605
4671
|
* parameters for multiple containers in a single task that also uses either the
|
|
4606
4672
|
* <code>awsvpc</code> or <code>host</code> network modes. For tasks that use the
|
|
4607
|
-
* <code>awsvpc</code> network mode, the container that
|
|
4673
|
+
* <code>awsvpc</code> network mode, the container that's started last determines
|
|
4608
4674
|
* which <code>systemControls</code> parameters take effect. For tasks that use the
|
|
4609
4675
|
* <code>host</code> network mode, it changes the container instance's namespaced
|
|
4610
4676
|
* kernel parameters as well as the containers.</p>
|
|
@@ -4635,15 +4701,14 @@ export declare namespace ContainerDefinition {
|
|
|
4635
4701
|
* tasks hosted on Fargate. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html">Fargate task
|
|
4636
4702
|
* storage</a> in the <i>Amazon ECS User Guide for Fargate</i>.</p>
|
|
4637
4703
|
* <note>
|
|
4638
|
-
* <p>This parameter is only supported for tasks hosted on Fargate using
|
|
4704
|
+
* <p>This parameter is only supported for tasks hosted on Fargate using
|
|
4705
|
+
* the following platform versions:</p>
|
|
4639
4706
|
* <ul>
|
|
4640
4707
|
* <li>
|
|
4641
|
-
* <p>Linux platform
|
|
4642
|
-
* version <code>1.4.0</code> or later.</p>
|
|
4708
|
+
* <p>Linux platform version <code>1.4.0</code> or later.</p>
|
|
4643
4709
|
* </li>
|
|
4644
4710
|
* <li>
|
|
4645
|
-
* <p>Windows platform
|
|
4646
|
-
* version <code>1.0.0</code> or later.</p>
|
|
4711
|
+
* <p>Windows platform version <code>1.0.0</code> or later.</p>
|
|
4647
4712
|
* </li>
|
|
4648
4713
|
* </ul>
|
|
4649
4714
|
* </note>
|
|
@@ -4663,9 +4728,8 @@ export declare namespace EphemeralStorage {
|
|
|
4663
4728
|
const filterSensitiveLog: (obj: EphemeralStorage) => any;
|
|
4664
4729
|
}
|
|
4665
4730
|
/**
|
|
4666
|
-
* <p>Details on
|
|
4667
|
-
* Amazon
|
|
4668
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4731
|
+
* <p>Details on an Elastic Inference accelerator. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html">Working with Amazon Elastic Inference on
|
|
4732
|
+
* Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4669
4733
|
*/
|
|
4670
4734
|
export interface InferenceAccelerator {
|
|
4671
4735
|
/**
|
|
@@ -4707,7 +4771,7 @@ export declare enum TaskDefinitionPlacementConstraintType {
|
|
|
4707
4771
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html">Task placement constraints</a> in the
|
|
4708
4772
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4709
4773
|
* <note>
|
|
4710
|
-
* <p>Task placement constraints
|
|
4774
|
+
* <p>Task placement constraints aren't supported for tasks run on Fargate.</p>
|
|
4711
4775
|
* </note>
|
|
4712
4776
|
*/
|
|
4713
4777
|
export interface TaskDefinitionPlacementConstraint {
|
|
@@ -4734,10 +4798,10 @@ export declare enum ProxyConfigurationType {
|
|
|
4734
4798
|
}
|
|
4735
4799
|
/**
|
|
4736
4800
|
* <p>The configuration details for the App Mesh proxy.</p>
|
|
4737
|
-
* <p>For tasks
|
|
4738
|
-
* least version 1.26.0 of the container agent and at least version 1.26.0-1 of the
|
|
4801
|
+
* <p>For tasks that use the EC2 launch type, the container instances require
|
|
4802
|
+
* at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the
|
|
4739
4803
|
* <code>ecs-init</code> package to enable a proxy configuration. If your container
|
|
4740
|
-
* instances are launched from the Amazon ECS
|
|
4804
|
+
* instances are launched from the Amazon ECS optimized AMI version <code>20190301</code> or
|
|
4741
4805
|
* later, then they contain the required versions of the container agent and
|
|
4742
4806
|
* <code>ecs-init</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html">Amazon ECS-optimized Linux AMI</a>
|
|
4743
4807
|
* </p>
|
|
@@ -4849,8 +4913,8 @@ export declare enum Scope {
|
|
|
4849
4913
|
TASK = "task"
|
|
4850
4914
|
}
|
|
4851
4915
|
/**
|
|
4852
|
-
* <p>This parameter is specified when you
|
|
4853
|
-
* supported when you
|
|
4916
|
+
* <p>This parameter is specified when you're using Docker volumes. Docker volumes are only
|
|
4917
|
+
* supported when you're using the EC2 launch type. Windows containers only
|
|
4854
4918
|
* support the use of the <code>local</code> driver. To use bind mounts, specify a
|
|
4855
4919
|
* <code>host</code> instead.</p>
|
|
4856
4920
|
*/
|
|
@@ -4863,8 +4927,8 @@ export interface DockerVolumeConfiguration {
|
|
|
4863
4927
|
*/
|
|
4864
4928
|
scope?: Scope | string;
|
|
4865
4929
|
/**
|
|
4866
|
-
* <p>If this value is <code>true</code>, the Docker volume is created if it
|
|
4867
|
-
*
|
|
4930
|
+
* <p>If this value is <code>true</code>, the Docker volume is created if it doesn't already
|
|
4931
|
+
* exist.</p>
|
|
4868
4932
|
* <note>
|
|
4869
4933
|
* <p>This field is only used if the <code>scope</code> is <code>shared</code>.</p>
|
|
4870
4934
|
* </note>
|
|
@@ -4925,7 +4989,7 @@ export interface EFSAuthorizationConfig {
|
|
|
4925
4989
|
*/
|
|
4926
4990
|
accessPointId?: string;
|
|
4927
4991
|
/**
|
|
4928
|
-
* <p>
|
|
4992
|
+
* <p>Determines whether to use the Amazon ECS task IAM role defined in a task definition when
|
|
4929
4993
|
* mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the
|
|
4930
4994
|
* <code>EFSVolumeConfiguration</code>. If this parameter is omitted, the default value
|
|
4931
4995
|
* of <code>DISABLED</code> is used. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints">Using
|
|
@@ -4944,7 +5008,7 @@ export declare enum EFSTransitEncryption {
|
|
|
4944
5008
|
ENABLED = "ENABLED"
|
|
4945
5009
|
}
|
|
4946
5010
|
/**
|
|
4947
|
-
* <p>This parameter is specified when you
|
|
5011
|
+
* <p>This parameter is specified when you're using an Amazon Elastic File System file system for task
|
|
4948
5012
|
* storage. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html">Amazon EFS Volumes</a> in the
|
|
4949
5013
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4950
5014
|
*/
|
|
@@ -4965,10 +5029,10 @@ export interface EFSVolumeConfiguration {
|
|
|
4965
5029
|
*/
|
|
4966
5030
|
rootDirectory?: string;
|
|
4967
5031
|
/**
|
|
4968
|
-
* <p>
|
|
4969
|
-
* and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization
|
|
4970
|
-
* used. If this parameter is omitted, the default value of <code>DISABLED</code> is
|
|
4971
|
-
* For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html">Encrypting Data in Transit</a> in
|
|
5032
|
+
* <p>Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS
|
|
5033
|
+
* host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization
|
|
5034
|
+
* is used. If this parameter is omitted, the default value of <code>DISABLED</code> is
|
|
5035
|
+
* used. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html">Encrypting Data in Transit</a> in
|
|
4972
5036
|
* the <i>Amazon Elastic File System User Guide</i>.</p>
|
|
4973
5037
|
*/
|
|
4974
5038
|
transitEncryption?: EFSTransitEncryption | string;
|
|
@@ -5016,7 +5080,7 @@ export declare namespace FSxWindowsFileServerAuthorizationConfig {
|
|
|
5016
5080
|
const filterSensitiveLog: (obj: FSxWindowsFileServerAuthorizationConfig) => any;
|
|
5017
5081
|
}
|
|
5018
5082
|
/**
|
|
5019
|
-
* <p>This parameter is specified when you
|
|
5083
|
+
* <p>This parameter is specified when you're using <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html">Amazon FSx for Windows File Server</a> file system for task
|
|
5020
5084
|
* storage.</p>
|
|
5021
5085
|
* <p>For more information and the input format, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html">Amazon FSx for Windows File Server Volumes</a>
|
|
5022
5086
|
* in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
@@ -5048,14 +5112,14 @@ export declare namespace FSxWindowsFileServerVolumeConfiguration {
|
|
|
5048
5112
|
export interface HostVolumeProperties {
|
|
5049
5113
|
/**
|
|
5050
5114
|
* <p>When the <code>host</code> parameter is used, specify a <code>sourcePath</code> to
|
|
5051
|
-
* declare the path on the host container instance that
|
|
5115
|
+
* declare the path on the host container instance that's presented to the container. If
|
|
5052
5116
|
* this parameter is empty, then the Docker daemon has assigned a host path for you. If the
|
|
5053
5117
|
* <code>host</code> parameter contains a <code>sourcePath</code> file location, then
|
|
5054
5118
|
* the data volume persists at the specified location on the host container instance until
|
|
5055
|
-
* you delete it manually. If the <code>sourcePath</code> value
|
|
5119
|
+
* you delete it manually. If the <code>sourcePath</code> value doesn't exist on the host
|
|
5056
5120
|
* container instance, the Docker daemon creates it. If the location does exist, the
|
|
5057
5121
|
* contents of the source path folder are exported.</p>
|
|
5058
|
-
* <p>If you
|
|
5122
|
+
* <p>If you're using the Fargate launch type, the <code>sourcePath</code>
|
|
5059
5123
|
* parameter is not supported.</p>
|
|
5060
5124
|
*/
|
|
5061
5125
|
sourcePath?: string;
|
|
@@ -5067,9 +5131,9 @@ export declare namespace HostVolumeProperties {
|
|
|
5067
5131
|
const filterSensitiveLog: (obj: HostVolumeProperties) => any;
|
|
5068
5132
|
}
|
|
5069
5133
|
/**
|
|
5070
|
-
* <p>A data volume used in a task definition. For tasks that use the Amazon Elastic
|
|
5071
|
-
* System (Amazon EFS), specify an <code>efsVolumeConfiguration</code>. For Windows
|
|
5072
|
-
* that use Amazon FSx for Windows File Server file system, specify a
|
|
5134
|
+
* <p>A data volume that's used in a task definition. For tasks that use the Amazon Elastic
|
|
5135
|
+
* File System (Amazon EFS), specify an <code>efsVolumeConfiguration</code>. For Windows
|
|
5136
|
+
* tasks that use Amazon FSx for Windows File Server file system, specify a
|
|
5073
5137
|
* <code>fsxWindowsFileServerVolumeConfiguration</code>. For tasks that use a Docker
|
|
5074
5138
|
* volume, specify a <code>DockerVolumeConfiguration</code>. For tasks that use a bind
|
|
5075
5139
|
* mount host volume, specify a <code>host</code> and optional <code>sourcePath</code>. For
|
|
@@ -5084,35 +5148,35 @@ export interface Volume {
|
|
|
5084
5148
|
*/
|
|
5085
5149
|
name?: string;
|
|
5086
5150
|
/**
|
|
5087
|
-
* <p>This parameter is specified when you
|
|
5088
|
-
*
|
|
5089
|
-
*
|
|
5090
|
-
*
|
|
5091
|
-
*
|
|
5092
|
-
*
|
|
5151
|
+
* <p>This parameter is specified when you use bind mount host volumes. The contents of the
|
|
5152
|
+
* <code>host</code> parameter determine whether your bind mount host volume persists
|
|
5153
|
+
* on the host container instance and where it's stored. If the <code>host</code> parameter
|
|
5154
|
+
* is empty, then the Docker daemon assigns a host path for your data volume. However, the
|
|
5155
|
+
* data isn't guaranteed to persist after the containers that are associated with it stop
|
|
5156
|
+
* running.</p>
|
|
5093
5157
|
* <p>Windows containers can mount whole directories on the same drive as
|
|
5094
|
-
* <code>$env:ProgramData</code>. Windows containers
|
|
5095
|
-
* different drive, and mount point
|
|
5158
|
+
* <code>$env:ProgramData</code>. Windows containers can't mount directories on a
|
|
5159
|
+
* different drive, and mount point can't be across drives. For example, you can mount
|
|
5096
5160
|
* <code>C:\my\path:C:\my\path</code> and <code>D:\:D:\</code>, but not
|
|
5097
5161
|
* <code>D:\my\path:C:\my\path</code> or <code>D:\:C:\my\path</code>.</p>
|
|
5098
5162
|
*/
|
|
5099
5163
|
host?: HostVolumeProperties;
|
|
5100
5164
|
/**
|
|
5101
|
-
* <p>This parameter is specified when you
|
|
5165
|
+
* <p>This parameter is specified when you use Docker volumes.</p>
|
|
5102
5166
|
* <p>Windows containers only support the use of the <code>local</code> driver. To use bind
|
|
5103
5167
|
* mounts, specify the <code>host</code> parameter instead.</p>
|
|
5104
5168
|
* <note>
|
|
5105
|
-
* <p>Docker volumes
|
|
5169
|
+
* <p>Docker volumes aren't supported by tasks run on Fargate.</p>
|
|
5106
5170
|
* </note>
|
|
5107
5171
|
*/
|
|
5108
5172
|
dockerVolumeConfiguration?: DockerVolumeConfiguration;
|
|
5109
5173
|
/**
|
|
5110
|
-
* <p>This parameter is specified when you
|
|
5174
|
+
* <p>This parameter is specified when you use an Amazon Elastic File System file system for task
|
|
5111
5175
|
* storage.</p>
|
|
5112
5176
|
*/
|
|
5113
5177
|
efsVolumeConfiguration?: EFSVolumeConfiguration;
|
|
5114
5178
|
/**
|
|
5115
|
-
* <p>This parameter is specified when you
|
|
5179
|
+
* <p>This parameter is specified when you use Amazon FSx for Windows File Server file system for task
|
|
5116
5180
|
* storage.</p>
|
|
5117
5181
|
*/
|
|
5118
5182
|
fsxWindowsFileServerVolumeConfiguration?: FSxWindowsFileServerVolumeConfiguration;
|
|
@@ -5142,8 +5206,9 @@ export interface TaskDefinition {
|
|
|
5142
5206
|
*/
|
|
5143
5207
|
containerDefinitions?: ContainerDefinition[];
|
|
5144
5208
|
/**
|
|
5145
|
-
* <p>The name of a family that this task definition is registered to. Up to 255
|
|
5146
|
-
* (uppercase and lowercase), numbers, hyphens, and
|
|
5209
|
+
* <p>The name of a family that this task definition is registered to. Up to 255 characters
|
|
5210
|
+
* are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and
|
|
5211
|
+
* underscores (_) are allowed.</p>
|
|
5147
5212
|
* <p>A family groups multiple versions of a task definition. Amazon ECS gives the first task
|
|
5148
5213
|
* definition that you registered to a family a revision number of 1. Amazon ECS gives
|
|
5149
5214
|
* sequential revision numbers to each task definition that you add.</p>
|
|
@@ -5155,8 +5220,7 @@ export interface TaskDefinition {
|
|
|
5155
5220
|
* Task Role</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
5156
5221
|
* <p>IAM roles for tasks on Windows require that the <code>-EnableTaskIAMRole</code> option
|
|
5157
5222
|
* is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some
|
|
5158
|
-
* configuration code
|
|
5159
|
-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html">Windows IAM roles
|
|
5223
|
+
* configuration code to use the feature. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html">Windows IAM roles
|
|
5160
5224
|
* for tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
5161
5225
|
*/
|
|
5162
5226
|
taskRoleArn?: string;
|
|
@@ -5202,15 +5266,15 @@ export interface TaskDefinition {
|
|
|
5202
5266
|
* <p>The revision of the task in a particular family. The revision is a version number of a
|
|
5203
5267
|
* task definition in a family. When you register a task definition for the first time, the
|
|
5204
5268
|
* revision is <code>1</code>. Each time that you register a new revision of a task
|
|
5205
|
-
* definition in the same family, the revision value always increases by one
|
|
5206
|
-
*
|
|
5269
|
+
* definition in the same family, the revision value always increases by one. This is even
|
|
5270
|
+
* if you deregistered previous revisions in this family.</p>
|
|
5207
5271
|
*/
|
|
5208
5272
|
revision?: number;
|
|
5209
5273
|
/**
|
|
5210
5274
|
* <p>The list of data volume definitions for the task. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html">Using data volumes in tasks</a> in the
|
|
5211
5275
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
5212
5276
|
* <note>
|
|
5213
|
-
* <p>The <code>host</code> and <code>sourcePath</code> parameters
|
|
5277
|
+
* <p>The <code>host</code> and <code>sourcePath</code> parameters aren't supported for
|
|
5214
5278
|
* tasks run on Fargate.</p>
|
|
5215
5279
|
* </note>
|
|
5216
5280
|
*/
|
|
@@ -5222,19 +5286,19 @@ export interface TaskDefinition {
|
|
|
5222
5286
|
/**
|
|
5223
5287
|
* <p>The container instance attributes required by your task. When an Amazon EC2 instance is
|
|
5224
5288
|
* registered to your cluster, the Amazon ECS container agent assigns some standard attributes
|
|
5225
|
-
* to the instance. You can apply custom attributes
|
|
5226
|
-
* Amazon ECS console or the <a>PutAttributes</a> API. These attributes are
|
|
5227
|
-
*
|
|
5228
|
-
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
5289
|
+
* to the instance. You can apply custom attributes. These are specified as key-value pairs
|
|
5290
|
+
* using the Amazon ECS console or the <a>PutAttributes</a> API. These attributes are
|
|
5291
|
+
* used when determining task placement for tasks hosted on Amazon EC2 instances. For more
|
|
5292
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
5229
5293
|
* <note>
|
|
5230
|
-
* <p>This parameter
|
|
5294
|
+
* <p>This parameter isn't supported for tasks run on Fargate.</p>
|
|
5231
5295
|
* </note>
|
|
5232
5296
|
*/
|
|
5233
5297
|
requiresAttributes?: Attribute[];
|
|
5234
5298
|
/**
|
|
5235
5299
|
* <p>An array of placement constraint objects to use for tasks.</p>
|
|
5236
5300
|
* <note>
|
|
5237
|
-
* <p>This parameter
|
|
5301
|
+
* <p>This parameter isn't supported for tasks run on Fargate.</p>
|
|
5238
5302
|
* </note>
|
|
5239
5303
|
*/
|
|
5240
5304
|
placementConstraints?: TaskDefinitionPlacementConstraint[];
|
|
@@ -5245,8 +5309,10 @@ export interface TaskDefinition {
|
|
|
5245
5309
|
*/
|
|
5246
5310
|
compatibilities?: (Compatibility | string)[];
|
|
5247
5311
|
/**
|
|
5248
|
-
* <p>The operating system
|
|
5249
|
-
*
|
|
5312
|
+
* <p>The operating system that your task definitions are running on. A platform family is
|
|
5313
|
+
* specified only for tasks using the Fargate launch type. </p>
|
|
5314
|
+
* <p>When you specify a task in a service, this value must match the
|
|
5315
|
+
* <code>runtimePlatform</code> value of the service.</p>
|
|
5250
5316
|
*/
|
|
5251
5317
|
runtimePlatform?: RuntimePlatform;
|
|
5252
5318
|
/**
|
|
@@ -5255,10 +5321,12 @@ export interface TaskDefinition {
|
|
|
5255
5321
|
*/
|
|
5256
5322
|
requiresCompatibilities?: (Compatibility | string)[];
|
|
5257
5323
|
/**
|
|
5258
|
-
* <p>The number of <code>cpu</code> units used by the task. If you
|
|
5259
|
-
*
|
|
5260
|
-
*
|
|
5261
|
-
* determines your range of valid values for the <code>memory</code> parameter
|
|
5324
|
+
* <p>The number of <code>cpu</code> units used by the task. If you use the EC2 launch type,
|
|
5325
|
+
* this field is optional. Any value can be used. If you use the Fargate launch type, this
|
|
5326
|
+
* field is required. You must use one of the following values. The value that you choose
|
|
5327
|
+
* determines your range of valid values for the <code>memory</code> parameter.</p>
|
|
5328
|
+
* <p>The CPU units cannot be less than 1 vCPU when you use Windows containers on
|
|
5329
|
+
* Fargate.</p>
|
|
5262
5330
|
* <ul>
|
|
5263
5331
|
* <li>
|
|
5264
5332
|
* <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p>
|
|
@@ -5280,15 +5348,15 @@ export interface TaskDefinition {
|
|
|
5280
5348
|
cpu?: string;
|
|
5281
5349
|
/**
|
|
5282
5350
|
* <p>The amount (in MiB) of memory used by the task.</p>
|
|
5283
|
-
* <p>If your tasks
|
|
5284
|
-
*
|
|
5285
|
-
*
|
|
5286
|
-
*
|
|
5287
|
-
*
|
|
5288
|
-
* <p>If your tasks
|
|
5289
|
-
*
|
|
5290
|
-
* <code>cpu</code> parameter
|
|
5291
|
-
*
|
|
5351
|
+
* <p>If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory
|
|
5352
|
+
* value or a container-level memory value. This field is optional and any value can be
|
|
5353
|
+
* used. If a task-level memory value is specified, the container-level memory value is
|
|
5354
|
+
* optional. For more information regarding container-level memory and memory reservation,
|
|
5355
|
+
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html">ContainerDefinition</a>.</p>
|
|
5356
|
+
* <p>If your tasks runs on Fargate, this field is required. You must use one of the
|
|
5357
|
+
* following values. The value you choose determines your range of valid values for the
|
|
5358
|
+
* <code>cpu</code> parameter.</p>
|
|
5359
|
+
* <ul>
|
|
5292
5360
|
* <li>
|
|
5293
5361
|
* <p>512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available <code>cpu</code> values: 256 (.25 vCPU)</p>
|
|
5294
5362
|
* </li>
|
|
@@ -5308,7 +5376,7 @@ export interface TaskDefinition {
|
|
|
5308
5376
|
*/
|
|
5309
5377
|
memory?: string;
|
|
5310
5378
|
/**
|
|
5311
|
-
* <p>The Elastic Inference accelerator associated with the task.</p>
|
|
5379
|
+
* <p>The Elastic Inference accelerator that's associated with the task.</p>
|
|
5312
5380
|
*/
|
|
5313
5381
|
inferenceAccelerators?: InferenceAccelerator[];
|
|
5314
5382
|
/**
|
|
@@ -5369,17 +5437,17 @@ export interface TaskDefinition {
|
|
|
5369
5437
|
* <p>The configuration details for the App Mesh proxy.</p>
|
|
5370
5438
|
* <p>Your Amazon ECS container instances require at least version 1.26.0 of the container agent
|
|
5371
5439
|
* and at least version 1.26.0-1 of the <code>ecs-init</code> package to enable a proxy
|
|
5372
|
-
* configuration. If your container instances are launched from the Amazon ECS
|
|
5373
|
-
* version <code>20190301</code> or later,
|
|
5440
|
+
* configuration. If your container instances are launched from the Amazon ECS optimized AMI
|
|
5441
|
+
* version <code>20190301</code> or later, they contain the required versions of the
|
|
5374
5442
|
* container agent and <code>ecs-init</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
5375
5443
|
*/
|
|
5376
5444
|
proxyConfiguration?: ProxyConfiguration;
|
|
5377
5445
|
/**
|
|
5378
|
-
* <p>The Unix timestamp for when the task definition was registered.</p>
|
|
5446
|
+
* <p>The Unix timestamp for the time when the task definition was registered.</p>
|
|
5379
5447
|
*/
|
|
5380
5448
|
registeredAt?: Date;
|
|
5381
5449
|
/**
|
|
5382
|
-
* <p>The Unix timestamp for when the task definition was deregistered.</p>
|
|
5450
|
+
* <p>The Unix timestamp for the time when the task definition was deregistered.</p>
|
|
5383
5451
|
*/
|
|
5384
5452
|
deregisteredAt?: Date;
|
|
5385
5453
|
/**
|
|
@@ -5421,7 +5489,7 @@ export interface DescribeCapacityProvidersRequest {
|
|
|
5421
5489
|
/**
|
|
5422
5490
|
* <p>Specifies whether or not you want to see the resource tags for the capacity provider.
|
|
5423
5491
|
* If <code>TAGS</code> is specified, the tags are included in the response. If this field
|
|
5424
|
-
* is omitted, tags
|
|
5492
|
+
* is omitted, tags aren't included in the response.</p>
|
|
5425
5493
|
*/
|
|
5426
5494
|
include?: (CapacityProviderField | string)[];
|
|
5427
5495
|
/**
|
|
@@ -5518,8 +5586,8 @@ export interface DescribeClustersRequest {
|
|
|
5518
5586
|
*/
|
|
5519
5587
|
clusters?: string[];
|
|
5520
5588
|
/**
|
|
5521
|
-
* <p>
|
|
5522
|
-
* field is omitted, this information isn't included.</p>
|
|
5589
|
+
* <p>Determines whether to include additional information about the clusters in the
|
|
5590
|
+
* response. If this field is omitted, this information isn't included.</p>
|
|
5523
5591
|
* <p>If <code>ATTACHMENTS</code> is specified, the attachments for the container instances
|
|
5524
5592
|
* or tasks within the cluster are included.</p>
|
|
5525
5593
|
* <p>If <code>SETTINGS</code> is specified, the settings for the cluster are
|
|
@@ -5556,6 +5624,7 @@ export declare namespace DescribeClustersResponse {
|
|
|
5556
5624
|
const filterSensitiveLog: (obj: DescribeClustersResponse) => any;
|
|
5557
5625
|
}
|
|
5558
5626
|
export declare enum ContainerInstanceField {
|
|
5627
|
+
CONTAINER_INSTANCE_HEALTH = "CONTAINER_INSTANCE_HEALTH",
|
|
5559
5628
|
TAGS = "TAGS"
|
|
5560
5629
|
}
|
|
5561
5630
|
export interface DescribeContainerInstancesRequest {
|
|
@@ -5572,8 +5641,10 @@ export interface DescribeContainerInstancesRequest {
|
|
|
5572
5641
|
containerInstances: string[] | undefined;
|
|
5573
5642
|
/**
|
|
5574
5643
|
* <p>Specifies whether you want to see the resource tags for the container instance. If
|
|
5575
|
-
* <code>TAGS</code> is specified, the tags are included in the response. If
|
|
5576
|
-
*
|
|
5644
|
+
* <code>TAGS</code> is specified, the tags are included in the response. If
|
|
5645
|
+
* <code>CONTAINER_INSTANCE_HEALTH</code> is specified, the container instance health
|
|
5646
|
+
* is included in the response. If this field is omitted, tags and container instance
|
|
5647
|
+
* health status aren't included in the response.</p>
|
|
5577
5648
|
*/
|
|
5578
5649
|
include?: (ContainerInstanceField | string)[];
|
|
5579
5650
|
}
|
|
@@ -5615,9 +5686,9 @@ export interface DescribeServicesRequest {
|
|
|
5615
5686
|
*/
|
|
5616
5687
|
services: string[] | undefined;
|
|
5617
5688
|
/**
|
|
5618
|
-
* <p>
|
|
5689
|
+
* <p>Determines whether you want to see the resource tags for the service. If
|
|
5619
5690
|
* <code>TAGS</code> is specified, the tags are included in the response. If this field
|
|
5620
|
-
* is omitted, tags
|
|
5691
|
+
* is omitted, tags aren't included in the response.</p>
|
|
5621
5692
|
*/
|
|
5622
5693
|
include?: (ServiceField | string)[];
|
|
5623
5694
|
}
|
|
@@ -5655,9 +5726,9 @@ export interface DescribeTaskDefinitionRequest {
|
|
|
5655
5726
|
*/
|
|
5656
5727
|
taskDefinition: string | undefined;
|
|
5657
5728
|
/**
|
|
5658
|
-
* <p>
|
|
5729
|
+
* <p>Determines whether to see the resource tags for the task definition. If
|
|
5659
5730
|
* <code>TAGS</code> is specified, the tags are included in the response. If this field
|
|
5660
|
-
* is omitted, tags
|
|
5731
|
+
* is omitted, tags aren't included in the response.</p>
|
|
5661
5732
|
*/
|
|
5662
5733
|
include?: (TaskDefinitionField | string)[];
|
|
5663
5734
|
}
|
|
@@ -5673,10 +5744,9 @@ export interface DescribeTaskDefinitionResponse {
|
|
|
5673
5744
|
*/
|
|
5674
5745
|
taskDefinition?: TaskDefinition;
|
|
5675
5746
|
/**
|
|
5676
|
-
* <p>The metadata that
|
|
5677
|
-
*
|
|
5678
|
-
*
|
|
5679
|
-
* <p>The following basic restrictions apply to tags:</p>
|
|
5747
|
+
* <p>The metadata that's applied to the task definition to help you categorize and organize
|
|
5748
|
+
* them. Each tag consists of a key and an optional value. You define both.</p>
|
|
5749
|
+
* <p>The following basic restrictions apply to tags:</p>
|
|
5680
5750
|
* <ul>
|
|
5681
5751
|
* <li>
|
|
5682
5752
|
* <p>Maximum number of tags per resource - 50</p>
|
|
@@ -5732,8 +5802,8 @@ export interface DescribeTasksRequest {
|
|
|
5732
5802
|
tasks: string[] | undefined;
|
|
5733
5803
|
/**
|
|
5734
5804
|
* <p>Specifies whether you want to see the resource tags for the task. If <code>TAGS</code>
|
|
5735
|
-
* is specified, the tags are included in the response. If this field is omitted, tags
|
|
5736
|
-
*
|
|
5805
|
+
* is specified, the tags are included in the response. If this field is omitted, tags
|
|
5806
|
+
* aren't included in the response.</p>
|
|
5737
5807
|
*/
|
|
5738
5808
|
include?: (TaskField | string)[];
|
|
5739
5809
|
}
|
|
@@ -5760,7 +5830,7 @@ export declare enum ManagedAgentName {
|
|
|
5760
5830
|
*/
|
|
5761
5831
|
export interface ManagedAgent {
|
|
5762
5832
|
/**
|
|
5763
|
-
* <p>The Unix timestamp for when the managed agent was last started.</p>
|
|
5833
|
+
* <p>The Unix timestamp for the time when the managed agent was last started.</p>
|
|
5764
5834
|
*/
|
|
5765
5835
|
lastStartedAt?: Date;
|
|
5766
5836
|
/**
|
|
@@ -5795,11 +5865,11 @@ export interface NetworkBinding {
|
|
|
5795
5865
|
*/
|
|
5796
5866
|
bindIP?: string;
|
|
5797
5867
|
/**
|
|
5798
|
-
* <p>The port number on the container that
|
|
5868
|
+
* <p>The port number on the container that's used with the network binding.</p>
|
|
5799
5869
|
*/
|
|
5800
5870
|
containerPort?: number;
|
|
5801
5871
|
/**
|
|
5802
|
-
* <p>The port number on the host that
|
|
5872
|
+
* <p>The port number on the host that's used with the network binding.</p>
|
|
5803
5873
|
*/
|
|
5804
5874
|
hostPort?: number;
|
|
5805
5875
|
/**
|
|
@@ -5838,7 +5908,7 @@ export declare namespace NetworkInterface {
|
|
|
5838
5908
|
const filterSensitiveLog: (obj: NetworkInterface) => any;
|
|
5839
5909
|
}
|
|
5840
5910
|
/**
|
|
5841
|
-
* <p>A Docker container that
|
|
5911
|
+
* <p>A Docker container that's part of a task.</p>
|
|
5842
5912
|
*/
|
|
5843
5913
|
export interface Container {
|
|
5844
5914
|
/**
|
|
@@ -5891,7 +5961,7 @@ export interface Container {
|
|
|
5891
5961
|
*/
|
|
5892
5962
|
networkInterfaces?: NetworkInterface[];
|
|
5893
5963
|
/**
|
|
5894
|
-
* <p>The health status of the container. If health checks
|
|
5964
|
+
* <p>The health status of the container. If health checks aren't configured for this
|
|
5895
5965
|
* container in its task definition, then it reports the health status as
|
|
5896
5966
|
* <code>UNKNOWN</code>.</p>
|
|
5897
5967
|
*/
|
|
@@ -5901,8 +5971,8 @@ export interface Container {
|
|
|
5901
5971
|
*/
|
|
5902
5972
|
managedAgents?: ManagedAgent[];
|
|
5903
5973
|
/**
|
|
5904
|
-
* <p>The number of CPU units set for the container. The value
|
|
5905
|
-
*
|
|
5974
|
+
* <p>The number of CPU units set for the container. The value is <code>0</code> if no value
|
|
5975
|
+
* was specified in the container definition when the task definition was
|
|
5906
5976
|
* registered.</p>
|
|
5907
5977
|
*/
|
|
5908
5978
|
cpu?: string;
|
|
@@ -5926,10 +5996,10 @@ export declare namespace Container {
|
|
|
5926
5996
|
const filterSensitiveLog: (obj: Container) => any;
|
|
5927
5997
|
}
|
|
5928
5998
|
/**
|
|
5929
|
-
* <p>The overrides that
|
|
5930
|
-
*
|
|
5931
|
-
*
|
|
5932
|
-
*
|
|
5999
|
+
* <p>The overrides that are sent to a container. An empty container override can be passed
|
|
6000
|
+
* in. An example of an empty container override is <code>{"containerOverrides": [ ]
|
|
6001
|
+
* }</code>. If a non-empty container override is specified, the <code>name</code>
|
|
6002
|
+
* parameter must be included.</p>
|
|
5933
6003
|
*/
|
|
5934
6004
|
export interface ContainerOverride {
|
|
5935
6005
|
/**
|
|
@@ -5985,8 +6055,9 @@ export declare namespace ContainerOverride {
|
|
|
5985
6055
|
/**
|
|
5986
6056
|
* <p>Details on an Elastic Inference accelerator task override. This parameter is used to
|
|
5987
6057
|
* override the Elastic Inference accelerator specified in the task definition. For more
|
|
5988
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html">Working with Amazon
|
|
5989
|
-
*
|
|
6058
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html">Working with Amazon
|
|
6059
|
+
* Elastic Inference on Amazon ECS</a> in the
|
|
6060
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
5990
6061
|
*/
|
|
5991
6062
|
export interface InferenceAcceleratorOverride {
|
|
5992
6063
|
/**
|
|
@@ -6006,11 +6077,11 @@ export declare namespace InferenceAcceleratorOverride {
|
|
|
6006
6077
|
const filterSensitiveLog: (obj: InferenceAcceleratorOverride) => any;
|
|
6007
6078
|
}
|
|
6008
6079
|
/**
|
|
6009
|
-
* <p>The overrides associated with a task.</p>
|
|
6080
|
+
* <p>The overrides that are associated with a task.</p>
|
|
6010
6081
|
*/
|
|
6011
6082
|
export interface TaskOverride {
|
|
6012
6083
|
/**
|
|
6013
|
-
* <p>One or more container overrides sent to a task.</p>
|
|
6084
|
+
* <p>One or more container overrides that are sent to a task.</p>
|
|
6014
6085
|
*/
|
|
6015
6086
|
containerOverrides?: ContainerOverride[];
|
|
6016
6087
|
/**
|
|
@@ -6022,8 +6093,8 @@ export interface TaskOverride {
|
|
|
6022
6093
|
*/
|
|
6023
6094
|
inferenceAcceleratorOverrides?: InferenceAcceleratorOverride[];
|
|
6024
6095
|
/**
|
|
6025
|
-
* <p>The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more
|
|
6026
|
-
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html">Amazon ECS task
|
|
6096
|
+
* <p>The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more
|
|
6097
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html">Amazon ECS task
|
|
6027
6098
|
* execution IAM role</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
6028
6099
|
*/
|
|
6029
6100
|
executionRoleArn?: string;
|
|
@@ -6032,8 +6103,8 @@ export interface TaskOverride {
|
|
|
6032
6103
|
*/
|
|
6033
6104
|
memory?: string;
|
|
6034
6105
|
/**
|
|
6035
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers
|
|
6036
|
-
* this task are granted the permissions that are specified in this role. For more
|
|
6106
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers
|
|
6107
|
+
* in this task are granted the permissions that are specified in this role. For more
|
|
6037
6108
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM Role for Tasks</a>
|
|
6038
6109
|
* in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
6039
6110
|
*/
|
|
@@ -6041,15 +6112,14 @@ export interface TaskOverride {
|
|
|
6041
6112
|
/**
|
|
6042
6113
|
* <p>The ephemeral storage setting override for the task.</p>
|
|
6043
6114
|
* <note>
|
|
6044
|
-
* <p>This parameter is only supported for tasks hosted on Fargate
|
|
6115
|
+
* <p>This parameter is only supported for tasks hosted on Fargate that
|
|
6116
|
+
* use the following platform versions:</p>
|
|
6045
6117
|
* <ul>
|
|
6046
6118
|
* <li>
|
|
6047
|
-
* <p>Linux platform
|
|
6048
|
-
* version <code>1.4.0</code> or later.</p>
|
|
6119
|
+
* <p>Linux platform version <code>1.4.0</code> or later.</p>
|
|
6049
6120
|
* </li>
|
|
6050
6121
|
* <li>
|
|
6051
|
-
* <p>Windows platform
|
|
6052
|
-
* version <code>1.0.0</code> or later.</p>
|
|
6122
|
+
* <p>Windows platform version <code>1.0.0</code> or later.</p>
|
|
6053
6123
|
* </li>
|
|
6054
6124
|
* </ul>
|
|
6055
6125
|
* </note>
|
|
@@ -6072,7 +6142,7 @@ export declare enum TaskStopCode {
|
|
|
6072
6142
|
*/
|
|
6073
6143
|
export interface Task {
|
|
6074
6144
|
/**
|
|
6075
|
-
* <p>The Elastic Network Adapter associated with the task if the task uses the
|
|
6145
|
+
* <p>The Elastic Network Adapter that's associated with the task if the task uses the
|
|
6076
6146
|
* <code>awsvpc</code> network mode.</p>
|
|
6077
6147
|
*/
|
|
6078
6148
|
attachments?: Attachment[];
|
|
@@ -6081,11 +6151,11 @@ export interface Task {
|
|
|
6081
6151
|
*/
|
|
6082
6152
|
attributes?: Attribute[];
|
|
6083
6153
|
/**
|
|
6084
|
-
* <p>The
|
|
6154
|
+
* <p>The Availability Zone for the task.</p>
|
|
6085
6155
|
*/
|
|
6086
6156
|
availabilityZone?: string;
|
|
6087
6157
|
/**
|
|
6088
|
-
* <p>The capacity provider associated with the task.</p>
|
|
6158
|
+
* <p>The capacity provider that's associated with the task.</p>
|
|
6089
6159
|
*/
|
|
6090
6160
|
capacityProviderName?: string;
|
|
6091
6161
|
/**
|
|
@@ -6097,7 +6167,7 @@ export interface Task {
|
|
|
6097
6167
|
*/
|
|
6098
6168
|
connectivity?: Connectivity | string;
|
|
6099
6169
|
/**
|
|
6100
|
-
* <p>The Unix timestamp for when the task last went into <code>CONNECTED</code>
|
|
6170
|
+
* <p>The Unix timestamp for the time when the task last went into <code>CONNECTED</code>
|
|
6101
6171
|
* status.</p>
|
|
6102
6172
|
*/
|
|
6103
6173
|
connectivityAt?: Date;
|
|
@@ -6106,22 +6176,24 @@ export interface Task {
|
|
|
6106
6176
|
*/
|
|
6107
6177
|
containerInstanceArn?: string;
|
|
6108
6178
|
/**
|
|
6109
|
-
* <p>The containers associated with the task.</p>
|
|
6179
|
+
* <p>The containers that's associated with the task.</p>
|
|
6110
6180
|
*/
|
|
6111
6181
|
containers?: Container[];
|
|
6112
6182
|
/**
|
|
6113
6183
|
* <p>The number of CPU units used by the task as expressed in a task definition. It can be
|
|
6114
|
-
* expressed as an integer using CPU units
|
|
6115
|
-
* expressed as a string using vCPUs
|
|
6116
|
-
* vcpu</code
|
|
6117
|
-
* the task definition is registered.</p>
|
|
6118
|
-
* <p>If you
|
|
6119
|
-
*
|
|
6120
|
-
*
|
|
6121
|
-
* <p>If you
|
|
6122
|
-
*
|
|
6123
|
-
*
|
|
6124
|
-
*
|
|
6184
|
+
* expressed as an integer using CPU units (for example, <code>1024</code>). It can also be
|
|
6185
|
+
* expressed as a string using vCPUs (for example, <code>1 vCPU</code> or <code>1
|
|
6186
|
+
* vcpu</code>). String values are converted to an integer that indicates the CPU units
|
|
6187
|
+
* when the task definition is registered.</p>
|
|
6188
|
+
* <p>If you use the EC2 launch type, this field is optional. Supported values
|
|
6189
|
+
* are between <code>128</code> CPU units (<code>0.125</code> vCPUs) and <code>10240</code>
|
|
6190
|
+
* CPU units (<code>10</code> vCPUs).</p>
|
|
6191
|
+
* <p>If you use the Fargate launch type, this field is required. You must use
|
|
6192
|
+
* one of the following values. These values determine the range of supported values for
|
|
6193
|
+
* the <code>memory</code> parameter:</p>
|
|
6194
|
+
* <p>The CPU units cannot be less than 1 vCPU when you use Windows containers on
|
|
6195
|
+
* Fargate.</p>
|
|
6196
|
+
* <ul>
|
|
6125
6197
|
* <li>
|
|
6126
6198
|
* <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p>
|
|
6127
6199
|
* </li>
|
|
@@ -6141,8 +6213,8 @@ export interface Task {
|
|
|
6141
6213
|
*/
|
|
6142
6214
|
cpu?: string;
|
|
6143
6215
|
/**
|
|
6144
|
-
* <p>The Unix timestamp for when the task was created
|
|
6145
|
-
*
|
|
6216
|
+
* <p>The Unix timestamp for the time when the task was created. More specifically, it's for
|
|
6217
|
+
* the time when the task entered the <code>PENDING</code> state.</p>
|
|
6146
6218
|
*/
|
|
6147
6219
|
createdAt?: Date;
|
|
6148
6220
|
/**
|
|
@@ -6151,60 +6223,60 @@ export interface Task {
|
|
|
6151
6223
|
*/
|
|
6152
6224
|
desiredStatus?: string;
|
|
6153
6225
|
/**
|
|
6154
|
-
* <p>
|
|
6155
|
-
* <code>true</code>,
|
|
6226
|
+
* <p>Determines whether execute command functionality is enabled for this task. If
|
|
6227
|
+
* <code>true</code>, execute command functionality is enabled on all the containers in
|
|
6156
6228
|
* the task.</p>
|
|
6157
6229
|
*/
|
|
6158
6230
|
enableExecuteCommand?: boolean;
|
|
6159
6231
|
/**
|
|
6160
|
-
* <p>The Unix timestamp for when the task execution stopped.</p>
|
|
6232
|
+
* <p>The Unix timestamp for the time when the task execution stopped.</p>
|
|
6161
6233
|
*/
|
|
6162
6234
|
executionStoppedAt?: Date;
|
|
6163
6235
|
/**
|
|
6164
|
-
* <p>The name of the task group associated with the task.</p>
|
|
6236
|
+
* <p>The name of the task group that's associated with the task.</p>
|
|
6165
6237
|
*/
|
|
6166
6238
|
group?: string;
|
|
6167
6239
|
/**
|
|
6168
|
-
* <p>The health status for the task
|
|
6240
|
+
* <p>The health status for the task. It's determined by the health of the essential
|
|
6169
6241
|
* containers in the task. If all essential containers in the task are reporting as
|
|
6170
|
-
* <code>HEALTHY</code>,
|
|
6171
|
-
*
|
|
6172
|
-
* <code>UNKNOWN</code>,
|
|
6173
|
-
* <code>UNKNOWN</code
|
|
6242
|
+
* <code>HEALTHY</code>, the task status also reports as <code>HEALTHY</code>. If any
|
|
6243
|
+
* essential containers in the task are reporting as <code>UNHEALTHY</code> or
|
|
6244
|
+
* <code>UNKNOWN</code>, the task status also reports as <code>UNHEALTHY</code> or
|
|
6245
|
+
* <code>UNKNOWN</code>.</p>
|
|
6174
6246
|
* <note>
|
|
6175
|
-
* <p>The Amazon ECS container agent
|
|
6176
|
-
* are embedded in a container image
|
|
6177
|
-
*
|
|
6178
|
-
* parameters that are specified in a container definition
|
|
6179
|
-
* checks that
|
|
6247
|
+
* <p>The Amazon ECS container agent doesn't monitor or report on Docker health checks that
|
|
6248
|
+
* are embedded in a container image and not specified in the container definition. For
|
|
6249
|
+
* example, this includes those specified in a parent image or from the image's
|
|
6250
|
+
* Dockerfile. Health check parameters that are specified in a container definition
|
|
6251
|
+
* override any Docker health checks that are found in the container image.</p>
|
|
6180
6252
|
* </note>
|
|
6181
6253
|
*/
|
|
6182
6254
|
healthStatus?: HealthStatus | string;
|
|
6183
6255
|
/**
|
|
6184
|
-
* <p>The Elastic Inference accelerator associated with the task.</p>
|
|
6256
|
+
* <p>The Elastic Inference accelerator that's associated with the task.</p>
|
|
6185
6257
|
*/
|
|
6186
6258
|
inferenceAccelerators?: InferenceAccelerator[];
|
|
6187
6259
|
/**
|
|
6188
|
-
* <p>The last known status
|
|
6260
|
+
* <p>The last known status for the task. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html">Task
|
|
6189
6261
|
* Lifecycle</a>.</p>
|
|
6190
6262
|
*/
|
|
6191
6263
|
lastStatus?: string;
|
|
6192
6264
|
/**
|
|
6193
|
-
* <p>The infrastructure
|
|
6265
|
+
* <p>The infrastructure where your task runs on. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html">Amazon ECS
|
|
6194
6266
|
* launch types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
6195
6267
|
*/
|
|
6196
6268
|
launchType?: LaunchType | string;
|
|
6197
6269
|
/**
|
|
6198
|
-
* <p>The amount of memory (in MiB)
|
|
6199
|
-
* can be expressed as an integer using MiB
|
|
6200
|
-
* expressed as a string using GB
|
|
6201
|
-
*
|
|
6270
|
+
* <p>The amount of memory (in MiB) that the task uses as expressed in a task definition. It
|
|
6271
|
+
* can be expressed as an integer using MiB (for example, <code>1024</code>). If it's
|
|
6272
|
+
* expressed as a string using GB (for example, <code>1GB</code> or <code>1 GB</code>),
|
|
6273
|
+
* it's converted to an integer indicating the MiB when the task definition is
|
|
6202
6274
|
* registered.</p>
|
|
6203
|
-
* <p>If you
|
|
6204
|
-
* <p>If you
|
|
6205
|
-
*
|
|
6206
|
-
* for the <code>cpu</code> parameter
|
|
6207
|
-
*
|
|
6275
|
+
* <p>If you use the EC2 launch type, this field is optional.</p>
|
|
6276
|
+
* <p>If you use the Fargate launch type, this field is required. You must use
|
|
6277
|
+
* one of the following values. The value that you choose determines the range of supported
|
|
6278
|
+
* values for the <code>cpu</code> parameter.</p>
|
|
6279
|
+
* <ul>
|
|
6208
6280
|
* <li>
|
|
6209
6281
|
* <p>512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available <code>cpu</code> values: 256 (.25 vCPU)</p>
|
|
6210
6282
|
* </li>
|
|
@@ -6228,45 +6300,48 @@ export interface Task {
|
|
|
6228
6300
|
*/
|
|
6229
6301
|
overrides?: TaskOverride;
|
|
6230
6302
|
/**
|
|
6231
|
-
* <p>The platform version
|
|
6232
|
-
*
|
|
6233
|
-
*
|
|
6234
|
-
*
|
|
6235
|
-
* Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
6303
|
+
* <p>The platform version where your task runs on. A platform version is only specified for
|
|
6304
|
+
* tasks that use the Fargate launch type. If you didn't specify one, the
|
|
6305
|
+
* <code>LATEST</code> platform version is used. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform Versions</a> in the
|
|
6306
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
6236
6307
|
*/
|
|
6237
6308
|
platformVersion?: string;
|
|
6238
6309
|
/**
|
|
6239
|
-
* <p>The operating system
|
|
6240
|
-
*
|
|
6310
|
+
* <p>The operating system that your tasks are running on. A platform family is specified
|
|
6311
|
+
* only for tasks that use the Fargate launch type. </p>
|
|
6312
|
+
* <p> All tasks that run as part of this service must use the same
|
|
6313
|
+
* <code>platformFamily</code> value as the service (for example,
|
|
6314
|
+
* <code>LINUX.</code>).</p>
|
|
6241
6315
|
*/
|
|
6242
6316
|
platformFamily?: string;
|
|
6243
6317
|
/**
|
|
6244
|
-
* <p>The Unix timestamp for when the container image pull began.</p>
|
|
6318
|
+
* <p>The Unix timestamp for the time when the container image pull began.</p>
|
|
6245
6319
|
*/
|
|
6246
6320
|
pullStartedAt?: Date;
|
|
6247
6321
|
/**
|
|
6248
|
-
* <p>The Unix timestamp for when the container image pull completed.</p>
|
|
6322
|
+
* <p>The Unix timestamp for the time when the container image pull completed.</p>
|
|
6249
6323
|
*/
|
|
6250
6324
|
pullStoppedAt?: Date;
|
|
6251
6325
|
/**
|
|
6252
|
-
* <p>The Unix timestamp for when the task started
|
|
6253
|
-
*
|
|
6326
|
+
* <p>The Unix timestamp for the time when the task started. More specifically, it's for the
|
|
6327
|
+
* time when the task transitioned from the <code>PENDING</code> state to the
|
|
6328
|
+
* <code>RUNNING</code> state.</p>
|
|
6254
6329
|
*/
|
|
6255
6330
|
startedAt?: Date;
|
|
6256
6331
|
/**
|
|
6257
|
-
* <p>The tag specified when a task is started. If
|
|
6258
|
-
*
|
|
6259
|
-
* starts it.</p>
|
|
6332
|
+
* <p>The tag specified when a task is started. If an Amazon ECS service started the task, the
|
|
6333
|
+
* <code>startedBy</code> parameter contains the deployment ID of that service.</p>
|
|
6260
6334
|
*/
|
|
6261
6335
|
startedBy?: string;
|
|
6262
6336
|
/**
|
|
6263
|
-
* <p>The stop code indicating why a task was stopped. The <code>stoppedReason</code>
|
|
6337
|
+
* <p>The stop code indicating why a task was stopped. The <code>stoppedReason</code> might
|
|
6264
6338
|
* contain additional details.</p>
|
|
6265
6339
|
*/
|
|
6266
6340
|
stopCode?: TaskStopCode | string;
|
|
6267
6341
|
/**
|
|
6268
|
-
* <p>The Unix timestamp for when the task was stopped
|
|
6269
|
-
*
|
|
6342
|
+
* <p>The Unix timestamp for the time when the task was stopped. More specifically, it's for
|
|
6343
|
+
* the time when the task transitioned from the <code>RUNNING</code> state to the
|
|
6344
|
+
* <code>STOPPED</code> state.</p>
|
|
6270
6345
|
*/
|
|
6271
6346
|
stoppedAt?: Date;
|
|
6272
6347
|
/**
|
|
@@ -6274,13 +6349,15 @@ export interface Task {
|
|
|
6274
6349
|
*/
|
|
6275
6350
|
stoppedReason?: string;
|
|
6276
6351
|
/**
|
|
6277
|
-
* <p>The Unix timestamp for when the task stops
|
|
6278
|
-
*
|
|
6352
|
+
* <p>The Unix timestamp for the time when the task stops. More specifically, it's for the
|
|
6353
|
+
* time when the task transitions from the <code>RUNNING</code> state to
|
|
6354
|
+
* <code>STOPPED</code>.</p>
|
|
6279
6355
|
*/
|
|
6280
6356
|
stoppingAt?: Date;
|
|
6281
6357
|
/**
|
|
6282
|
-
* <p>The metadata that you apply to the task to help you categorize and organize
|
|
6283
|
-
* tag consists of a key and an optional value
|
|
6358
|
+
* <p>The metadata that you apply to the task to help you categorize and organize the task.
|
|
6359
|
+
* Each tag consists of a key and an optional value. You define both the key and
|
|
6360
|
+
* value.</p>
|
|
6284
6361
|
* <p>The following basic restrictions apply to tags:</p>
|
|
6285
6362
|
* <ul>
|
|
6286
6363
|
* <li>
|
|
@@ -6323,9 +6400,9 @@ export interface Task {
|
|
|
6323
6400
|
*/
|
|
6324
6401
|
taskDefinitionArn?: string;
|
|
6325
6402
|
/**
|
|
6326
|
-
* <p>The version counter for the task. Every time a task experiences a change that
|
|
6327
|
-
*
|
|
6328
|
-
*
|
|
6403
|
+
* <p>The version counter for the task. Every time a task experiences a change that starts a
|
|
6404
|
+
* CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state
|
|
6405
|
+
* with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API
|
|
6329
6406
|
* actions with the version reported in CloudWatch Events for the task (inside the
|
|
6330
6407
|
* <code>detail</code> object) to verify that the version in your event stream is
|
|
6331
6408
|
* current.</p>
|
|
@@ -6378,7 +6455,7 @@ export interface DescribeTaskSetsRequest {
|
|
|
6378
6455
|
taskSets?: string[];
|
|
6379
6456
|
/**
|
|
6380
6457
|
* <p>Specifies whether to see the resource tags for the task set. If <code>TAGS</code> is
|
|
6381
|
-
* specified, the tags are included in the response. If this field is omitted, tags
|
|
6458
|
+
* specified, the tags are included in the response. If this field is omitted, tags aren't
|
|
6382
6459
|
* included in the response.</p>
|
|
6383
6460
|
*/
|
|
6384
6461
|
include?: (TaskSetField | string)[];
|
|
@@ -6412,8 +6489,8 @@ export interface DiscoverPollEndpointRequest {
|
|
|
6412
6489
|
*/
|
|
6413
6490
|
containerInstance?: string;
|
|
6414
6491
|
/**
|
|
6415
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the cluster
|
|
6416
|
-
*
|
|
6492
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs
|
|
6493
|
+
* to.</p>
|
|
6417
6494
|
*/
|
|
6418
6495
|
cluster?: string;
|
|
6419
6496
|
}
|
|
@@ -6470,7 +6547,7 @@ export declare namespace ExecuteCommandRequest {
|
|
|
6470
6547
|
const filterSensitiveLog: (obj: ExecuteCommandRequest) => any;
|
|
6471
6548
|
}
|
|
6472
6549
|
/**
|
|
6473
|
-
* <p>The details
|
|
6550
|
+
* <p>The details for the execute command session.</p>
|
|
6474
6551
|
*/
|
|
6475
6552
|
export interface Session {
|
|
6476
6553
|
/**
|
|
@@ -6478,12 +6555,14 @@ export interface Session {
|
|
|
6478
6555
|
*/
|
|
6479
6556
|
sessionId?: string;
|
|
6480
6557
|
/**
|
|
6481
|
-
* <p>A URL
|
|
6482
|
-
*
|
|
6558
|
+
* <p>A URL
|
|
6559
|
+
* back
|
|
6560
|
+
* to managed agent on the container that the SSM Session Manager client
|
|
6561
|
+
* uses to send commands and receive output from the container.</p>
|
|
6483
6562
|
*/
|
|
6484
6563
|
streamUrl?: string;
|
|
6485
6564
|
/**
|
|
6486
|
-
* <p>An encrypted token value containing session and caller information.
|
|
6565
|
+
* <p>An encrypted token value containing session and caller information. It's used to
|
|
6487
6566
|
* authenticate the connection to the container.</p>
|
|
6488
6567
|
*/
|
|
6489
6568
|
tokenValue?: string;
|
|
@@ -6508,9 +6587,9 @@ export interface ExecuteCommandResponse {
|
|
|
6508
6587
|
*/
|
|
6509
6588
|
containerName?: string;
|
|
6510
6589
|
/**
|
|
6511
|
-
* <p>
|
|
6512
|
-
* supports initiating interactive sessions, so you must specify <code>true</code> for
|
|
6513
|
-
* value.</p>
|
|
6590
|
+
* <p>Determines whether the execute command session is running in interactive mode. Amazon ECS
|
|
6591
|
+
* only supports initiating interactive sessions, so you must specify <code>true</code> for
|
|
6592
|
+
* this value.</p>
|
|
6514
6593
|
*/
|
|
6515
6594
|
interactive?: boolean;
|
|
6516
6595
|
/**
|
|
@@ -6530,7 +6609,7 @@ export declare namespace ExecuteCommandResponse {
|
|
|
6530
6609
|
const filterSensitiveLog: (obj: ExecuteCommandResponse) => any;
|
|
6531
6610
|
}
|
|
6532
6611
|
/**
|
|
6533
|
-
* <p>The target container
|
|
6612
|
+
* <p>The target container isn't properly configured with the execute command agent or the
|
|
6534
6613
|
* container is no longer active or running.</p>
|
|
6535
6614
|
*/
|
|
6536
6615
|
export interface TargetNotConnectedException extends __SmithyException, $MetadataBearer {
|
|
@@ -6550,8 +6629,8 @@ export interface ListAccountSettingsRequest {
|
|
|
6550
6629
|
*/
|
|
6551
6630
|
name?: SettingName | string;
|
|
6552
6631
|
/**
|
|
6553
|
-
* <p>The value of the account settings
|
|
6554
|
-
*
|
|
6632
|
+
* <p>The value of the account settings to filter results with. You must also specify an
|
|
6633
|
+
* account setting name to use this parameter.</p>
|
|
6555
6634
|
*/
|
|
6556
6635
|
value?: string;
|
|
6557
6636
|
/**
|
|
@@ -6565,18 +6644,18 @@ export interface ListAccountSettingsRequest {
|
|
|
6565
6644
|
*/
|
|
6566
6645
|
principalArn?: string;
|
|
6567
6646
|
/**
|
|
6568
|
-
* <p>
|
|
6647
|
+
* <p>Determines whether to return the effective settings. If <code>true</code>, the account
|
|
6569
6648
|
* settings for the root user or the default setting for the <code>principalArn</code> are
|
|
6570
6649
|
* returned. If <code>false</code>, the account settings for the <code>principalArn</code>
|
|
6571
|
-
* are returned if they
|
|
6650
|
+
* are returned if they're set. Otherwise, no account settings are returned.</p>
|
|
6572
6651
|
*/
|
|
6573
6652
|
effectiveSettings?: boolean;
|
|
6574
6653
|
/**
|
|
6575
6654
|
* <p>The <code>nextToken</code> value returned from a <code>ListAccountSettings</code>
|
|
6576
6655
|
* request indicating that more results are available to fulfill the request and further
|
|
6577
|
-
* calls will be needed. If <code>maxResults</code> was provided, it
|
|
6656
|
+
* calls will be needed. If <code>maxResults</code> was provided, it's possible the number
|
|
6578
6657
|
* of results to be fewer than <code>maxResults</code>.</p>
|
|
6579
|
-
*
|
|
6658
|
+
* <note>
|
|
6580
6659
|
* <p>This token should be treated as an opaque identifier that is only used to
|
|
6581
6660
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
6582
6661
|
* </note>
|
|
@@ -6590,7 +6669,7 @@ export interface ListAccountSettingsRequest {
|
|
|
6590
6669
|
* of the initial request can be seen by sending another <code>ListAccountSettings</code>
|
|
6591
6670
|
* request with the returned <code>nextToken</code> value. This value can be between
|
|
6592
6671
|
* 1 and 10. If this
|
|
6593
|
-
* parameter
|
|
6672
|
+
* parameter isn't used, then <code>ListAccountSettings</code> returns up to
|
|
6594
6673
|
* 10 results and a <code>nextToken</code> value
|
|
6595
6674
|
* if applicable.</p>
|
|
6596
6675
|
*/
|
|
@@ -6629,37 +6708,37 @@ export interface ListAttributesRequest {
|
|
|
6629
6708
|
*/
|
|
6630
6709
|
cluster?: string;
|
|
6631
6710
|
/**
|
|
6632
|
-
* <p>The type of the target
|
|
6711
|
+
* <p>The type of the target to list attributes with.</p>
|
|
6633
6712
|
*/
|
|
6634
6713
|
targetType: TargetType | string | undefined;
|
|
6635
6714
|
/**
|
|
6636
|
-
* <p>The name of the attribute
|
|
6715
|
+
* <p>The name of the attribute to filter the results with. </p>
|
|
6637
6716
|
*/
|
|
6638
6717
|
attributeName?: string;
|
|
6639
6718
|
/**
|
|
6640
|
-
* <p>The value of the attribute
|
|
6641
|
-
*
|
|
6719
|
+
* <p>The value of the attribute to filter results with. You must also specify an attribute
|
|
6720
|
+
* name to use this parameter.</p>
|
|
6642
6721
|
*/
|
|
6643
6722
|
attributeValue?: string;
|
|
6644
6723
|
/**
|
|
6645
6724
|
* <p>The <code>nextToken</code> value returned from a <code>ListAttributes</code> request
|
|
6646
|
-
* indicating that more results are available to fulfill the request and further calls
|
|
6647
|
-
*
|
|
6648
|
-
*
|
|
6649
|
-
*
|
|
6725
|
+
* indicating that more results are available to fulfill the request and further calls are
|
|
6726
|
+
* needed. If <code>maxResults</code> was provided, it's possible the number of results to
|
|
6727
|
+
* be fewer than <code>maxResults</code>.</p>
|
|
6728
|
+
* <note>
|
|
6650
6729
|
* <p>This token should be treated as an opaque identifier that is only used to
|
|
6651
6730
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
6652
6731
|
* </note>
|
|
6653
6732
|
*/
|
|
6654
6733
|
nextToken?: string;
|
|
6655
6734
|
/**
|
|
6656
|
-
* <p>The maximum number of cluster results
|
|
6735
|
+
* <p>The maximum number of cluster results that <code>ListAttributes</code> returned in
|
|
6657
6736
|
* paginated output. When this parameter is used, <code>ListAttributes</code> only returns
|
|
6658
6737
|
* <code>maxResults</code> results in a single page along with a <code>nextToken</code>
|
|
6659
6738
|
* response element. The remaining results of the initial request can be seen by sending
|
|
6660
6739
|
* another <code>ListAttributes</code> request with the returned <code>nextToken</code>
|
|
6661
6740
|
* value. This value can be between 1 and 100. If this
|
|
6662
|
-
* parameter
|
|
6741
|
+
* parameter isn't used, then <code>ListAttributes</code> returns up to
|
|
6663
6742
|
* 100 results and a <code>nextToken</code> value if applicable.</p>
|
|
6664
6743
|
*/
|
|
6665
6744
|
maxResults?: number;
|
|
@@ -6693,24 +6772,24 @@ export declare namespace ListAttributesResponse {
|
|
|
6693
6772
|
export interface ListClustersRequest {
|
|
6694
6773
|
/**
|
|
6695
6774
|
* <p>The <code>nextToken</code> value returned from a <code>ListClusters</code> request
|
|
6696
|
-
* indicating that more results are available to fulfill the request and further calls
|
|
6697
|
-
*
|
|
6698
|
-
*
|
|
6699
|
-
*
|
|
6775
|
+
* indicating that more results are available to fulfill the request and further calls are
|
|
6776
|
+
* needed. If <code>maxResults</code> was provided, it's possible the number of results to
|
|
6777
|
+
* be fewer than <code>maxResults</code>.</p>
|
|
6778
|
+
* <note>
|
|
6700
6779
|
* <p>This token should be treated as an opaque identifier that is only used to
|
|
6701
6780
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
6702
6781
|
* </note>
|
|
6703
6782
|
*/
|
|
6704
6783
|
nextToken?: string;
|
|
6705
6784
|
/**
|
|
6706
|
-
* <p>The maximum number of cluster results
|
|
6785
|
+
* <p>The maximum number of cluster results that <code>ListClusters</code> returned in
|
|
6707
6786
|
* paginated output. When this parameter is used, <code>ListClusters</code> only returns
|
|
6708
6787
|
* <code>maxResults</code> results in a single page along with a <code>nextToken</code>
|
|
6709
6788
|
* response element. The remaining results of the initial request can be seen by sending
|
|
6710
6789
|
* another <code>ListClusters</code> request with the returned <code>nextToken</code>
|
|
6711
6790
|
* value. This value can be between 1 and 100. If this
|
|
6712
|
-
* parameter
|
|
6713
|
-
*
|
|
6791
|
+
* parameter isn't used, then <code>ListClusters</code> returns up to 100
|
|
6792
|
+
* results and a <code>nextToken</code> value if applicable.</p>
|
|
6714
6793
|
*/
|
|
6715
6794
|
maxResults?: number;
|
|
6716
6795
|
}
|
|
@@ -6722,7 +6801,7 @@ export declare namespace ListClustersRequest {
|
|
|
6722
6801
|
}
|
|
6723
6802
|
export interface ListClustersResponse {
|
|
6724
6803
|
/**
|
|
6725
|
-
* <p>The list of full Amazon Resource Name (ARN) entries for each cluster associated with your
|
|
6804
|
+
* <p>The list of full Amazon Resource Name (ARN) entries for each cluster that's associated with your
|
|
6726
6805
|
* account.</p>
|
|
6727
6806
|
*/
|
|
6728
6807
|
clusterArns?: string[];
|
|
@@ -6763,31 +6842,32 @@ export interface ListContainerInstancesRequest {
|
|
|
6763
6842
|
/**
|
|
6764
6843
|
* <p>The <code>nextToken</code> value returned from a <code>ListContainerInstances</code>
|
|
6765
6844
|
* request indicating that more results are available to fulfill the request and further
|
|
6766
|
-
* calls
|
|
6767
|
-
*
|
|
6768
|
-
*
|
|
6845
|
+
* calls are needed. If <code>maxResults</code> was provided, it's possible the number of
|
|
6846
|
+
* results to be fewer than <code>maxResults</code>.</p>
|
|
6847
|
+
* <note>
|
|
6769
6848
|
* <p>This token should be treated as an opaque identifier that is only used to
|
|
6770
6849
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
6771
6850
|
* </note>
|
|
6772
6851
|
*/
|
|
6773
6852
|
nextToken?: string;
|
|
6774
6853
|
/**
|
|
6775
|
-
* <p>The maximum number of container instance results
|
|
6776
|
-
* <code>ListContainerInstances</code> in paginated output. When this
|
|
6777
|
-
* used, <code>ListContainerInstances</code> only returns
|
|
6778
|
-
*
|
|
6779
|
-
* results of the initial request can be seen by sending
|
|
6780
|
-
*
|
|
6781
|
-
*
|
|
6782
|
-
* parameter
|
|
6783
|
-
*
|
|
6854
|
+
* <p>The maximum number of container instance results that
|
|
6855
|
+
* <code>ListContainerInstances</code> returned in paginated output. When this
|
|
6856
|
+
* parameter is used, <code>ListContainerInstances</code> only returns
|
|
6857
|
+
* <code>maxResults</code> results in a single page along with a <code>nextToken</code>
|
|
6858
|
+
* response element. The remaining results of the initial request can be seen by sending
|
|
6859
|
+
* another <code>ListContainerInstances</code> request with the returned
|
|
6860
|
+
* <code>nextToken</code> value. This value can be between 1 and
|
|
6861
|
+
* 100. If this parameter isn't used, then
|
|
6862
|
+
* <code>ListContainerInstances</code> returns up to 100 results and
|
|
6863
|
+
* a <code>nextToken</code> value if applicable.</p>
|
|
6784
6864
|
*/
|
|
6785
6865
|
maxResults?: number;
|
|
6786
6866
|
/**
|
|
6787
6867
|
* <p>Filters the container instances by status. For example, if you specify the
|
|
6788
6868
|
* <code>DRAINING</code> status, the results include only container instances that have
|
|
6789
6869
|
* been set to <code>DRAINING</code> using <a>UpdateContainerInstancesState</a>.
|
|
6790
|
-
* If you
|
|
6870
|
+
* If you don't specify this parameter, the default is to include container instances set
|
|
6791
6871
|
* to all states other than <code>INACTIVE</code>.</p>
|
|
6792
6872
|
*/
|
|
6793
6873
|
status?: ContainerInstanceStatus | string;
|
|
@@ -6830,20 +6910,20 @@ export interface ListServicesRequest {
|
|
|
6830
6910
|
* indicating that more results are available to fulfill the request and further calls will
|
|
6831
6911
|
* be needed. If <code>maxResults</code> was provided, it is possible the number of results
|
|
6832
6912
|
* to be fewer than <code>maxResults</code>.</p>
|
|
6833
|
-
*
|
|
6913
|
+
* <note>
|
|
6834
6914
|
* <p>This token should be treated as an opaque identifier that is only used to
|
|
6835
6915
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
6836
6916
|
* </note>
|
|
6837
6917
|
*/
|
|
6838
6918
|
nextToken?: string;
|
|
6839
6919
|
/**
|
|
6840
|
-
* <p>The maximum number of service results
|
|
6920
|
+
* <p>The maximum number of service results that <code>ListServices</code> returned in
|
|
6841
6921
|
* paginated output. When this parameter is used, <code>ListServices</code> only returns
|
|
6842
6922
|
* <code>maxResults</code> results in a single page along with a <code>nextToken</code>
|
|
6843
6923
|
* response element. The remaining results of the initial request can be seen by sending
|
|
6844
6924
|
* another <code>ListServices</code> request with the returned <code>nextToken</code>
|
|
6845
6925
|
* value. This value can be between 1 and 100. If
|
|
6846
|
-
* this parameter
|
|
6926
|
+
* this parameter isn't used, then <code>ListServices</code> returns up to
|
|
6847
6927
|
* 10 results and a <code>nextToken</code> value if
|
|
6848
6928
|
* applicable.</p>
|
|
6849
6929
|
*/
|
|
@@ -6866,7 +6946,7 @@ export declare namespace ListServicesRequest {
|
|
|
6866
6946
|
}
|
|
6867
6947
|
export interface ListServicesResponse {
|
|
6868
6948
|
/**
|
|
6869
|
-
* <p>The list of full ARN entries for each service associated with the specified
|
|
6949
|
+
* <p>The list of full ARN entries for each service that's associated with the specified
|
|
6870
6950
|
* cluster.</p>
|
|
6871
6951
|
*/
|
|
6872
6952
|
serviceArns?: string[];
|
|
@@ -6887,7 +6967,7 @@ export declare namespace ListServicesResponse {
|
|
|
6887
6967
|
}
|
|
6888
6968
|
export interface ListTagsForResourceRequest {
|
|
6889
6969
|
/**
|
|
6890
|
-
* <p>The Amazon Resource Name (ARN) that identifies the resource
|
|
6970
|
+
* <p>The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the
|
|
6891
6971
|
* supported resources are Amazon ECS tasks, services, task definitions, clusters, and container
|
|
6892
6972
|
* instances.</p>
|
|
6893
6973
|
*/
|
|
@@ -6918,15 +6998,15 @@ export declare enum TaskDefinitionFamilyStatus {
|
|
|
6918
6998
|
}
|
|
6919
6999
|
export interface ListTaskDefinitionFamiliesRequest {
|
|
6920
7000
|
/**
|
|
6921
|
-
* <p>The <code>familyPrefix</code> is a string that
|
|
7001
|
+
* <p>The <code>familyPrefix</code> is a string that's used to filter the results of
|
|
6922
7002
|
* <code>ListTaskDefinitionFamilies</code>. If you specify a <code>familyPrefix</code>,
|
|
6923
7003
|
* only task definition family names that begin with the <code>familyPrefix</code> string
|
|
6924
7004
|
* are returned.</p>
|
|
6925
7005
|
*/
|
|
6926
7006
|
familyPrefix?: string;
|
|
6927
7007
|
/**
|
|
6928
|
-
* <p>The task definition family status
|
|
6929
|
-
* <code>ListTaskDefinitionFamilies</code> results. By default, both
|
|
7008
|
+
* <p>The task definition family status to filter the
|
|
7009
|
+
* <code>ListTaskDefinitionFamilies</code> results with. By default, both
|
|
6930
7010
|
* <code>ACTIVE</code> and <code>INACTIVE</code> task definition families are listed.
|
|
6931
7011
|
* If this parameter is set to <code>ACTIVE</code>, only task definition families that have
|
|
6932
7012
|
* an <code>ACTIVE</code> task definition revision are returned. If this parameter is set
|
|
@@ -6942,21 +7022,21 @@ export interface ListTaskDefinitionFamiliesRequest {
|
|
|
6942
7022
|
* available to fulfill the request and further calls will be needed. If
|
|
6943
7023
|
* <code>maxResults</code> was provided, it is possible the number of results to be
|
|
6944
7024
|
* fewer than <code>maxResults</code>.</p>
|
|
6945
|
-
*
|
|
7025
|
+
* <note>
|
|
6946
7026
|
* <p>This token should be treated as an opaque identifier that is only used to
|
|
6947
7027
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
6948
7028
|
* </note>
|
|
6949
7029
|
*/
|
|
6950
7030
|
nextToken?: string;
|
|
6951
7031
|
/**
|
|
6952
|
-
* <p>The maximum number of task definition family results
|
|
6953
|
-
* <code>ListTaskDefinitionFamilies</code> in paginated output. When this
|
|
6954
|
-
* used, <code>ListTaskDefinitions</code> only returns <code>maxResults</code>
|
|
6955
|
-
* single page along with a <code>nextToken</code> response element. The
|
|
6956
|
-
* of the initial request can be seen by sending another
|
|
7032
|
+
* <p>The maximum number of task definition family results that
|
|
7033
|
+
* <code>ListTaskDefinitionFamilies</code> returned in paginated output. When this
|
|
7034
|
+
* parameter is used, <code>ListTaskDefinitions</code> only returns <code>maxResults</code>
|
|
7035
|
+
* results in a single page along with a <code>nextToken</code> response element. The
|
|
7036
|
+
* remaining results of the initial request can be seen by sending another
|
|
6957
7037
|
* <code>ListTaskDefinitionFamilies</code> request with the returned
|
|
6958
7038
|
* <code>nextToken</code> value. This value can be between 1 and
|
|
6959
|
-
* 100. If this parameter
|
|
7039
|
+
* 100. If this parameter isn't used, then
|
|
6960
7040
|
* <code>ListTaskDefinitionFamilies</code> returns up to 100 results
|
|
6961
7041
|
* and a <code>nextToken</code> value if applicable.</p>
|
|
6962
7042
|
*/
|
|
@@ -6995,27 +7075,27 @@ export declare enum SortOrder {
|
|
|
6995
7075
|
}
|
|
6996
7076
|
export interface ListTaskDefinitionsRequest {
|
|
6997
7077
|
/**
|
|
6998
|
-
* <p>The full family name
|
|
6999
|
-
*
|
|
7000
|
-
*
|
|
7078
|
+
* <p>The full family name to filter the <code>ListTaskDefinitions</code> results with.
|
|
7079
|
+
* Specifying a <code>familyPrefix</code> limits the listed task definitions to task
|
|
7080
|
+
* definition revisions that belong to that family.</p>
|
|
7001
7081
|
*/
|
|
7002
7082
|
familyPrefix?: string;
|
|
7003
7083
|
/**
|
|
7004
|
-
* <p>The task definition status
|
|
7005
|
-
*
|
|
7006
|
-
*
|
|
7084
|
+
* <p>The task definition status to filter the <code>ListTaskDefinitions</code> results
|
|
7085
|
+
* with. By default, only <code>ACTIVE</code> task definitions are listed. By setting this
|
|
7086
|
+
* parameter to <code>INACTIVE</code>, you can view task definitions that are
|
|
7007
7087
|
* <code>INACTIVE</code> as long as an active task or service still references them. If
|
|
7008
7088
|
* you paginate the resulting output, be sure to keep the <code>status</code> value
|
|
7009
7089
|
* constant in each subsequent request.</p>
|
|
7010
7090
|
*/
|
|
7011
7091
|
status?: TaskDefinitionStatus | string;
|
|
7012
7092
|
/**
|
|
7013
|
-
* <p>The order
|
|
7014
|
-
* <code>DESC</code>. By default (<code>ASC</code>)
|
|
7093
|
+
* <p>The order to sort the results in. Valid values are <code>ASC</code> and
|
|
7094
|
+
* <code>DESC</code>. By default, (<code>ASC</code>) task definitions are listed
|
|
7015
7095
|
* lexicographically by family name and in ascending numerical order by revision so that
|
|
7016
7096
|
* the newest task definitions in a family are listed last. Setting this parameter to
|
|
7017
|
-
* <code>DESC</code> reverses the sort order on family name and revision
|
|
7018
|
-
* newest task definitions in a family are listed first.</p>
|
|
7097
|
+
* <code>DESC</code> reverses the sort order on family name and revision. This is so
|
|
7098
|
+
* that the newest task definitions in a family are listed first.</p>
|
|
7019
7099
|
*/
|
|
7020
7100
|
sort?: SortOrder | string;
|
|
7021
7101
|
/**
|
|
@@ -7023,20 +7103,20 @@ export interface ListTaskDefinitionsRequest {
|
|
|
7023
7103
|
* request indicating that more results are available to fulfill the request and further
|
|
7024
7104
|
* calls will be needed. If <code>maxResults</code> was provided, it is possible the number
|
|
7025
7105
|
* of results to be fewer than <code>maxResults</code>.</p>
|
|
7026
|
-
*
|
|
7106
|
+
* <note>
|
|
7027
7107
|
* <p>This token should be treated as an opaque identifier that is only used to
|
|
7028
7108
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
7029
7109
|
* </note>
|
|
7030
7110
|
*/
|
|
7031
7111
|
nextToken?: string;
|
|
7032
7112
|
/**
|
|
7033
|
-
* <p>The maximum number of task definition results
|
|
7034
|
-
*
|
|
7113
|
+
* <p>The maximum number of task definition results that <code>ListTaskDefinitions</code>
|
|
7114
|
+
* returned in paginated output. When this parameter is used,
|
|
7035
7115
|
* <code>ListTaskDefinitions</code> only returns <code>maxResults</code> results in a
|
|
7036
7116
|
* single page along with a <code>nextToken</code> response element. The remaining results
|
|
7037
7117
|
* of the initial request can be seen by sending another <code>ListTaskDefinitions</code>
|
|
7038
7118
|
* request with the returned <code>nextToken</code> value. This value can be between
|
|
7039
|
-
* 1 and 100. If this parameter
|
|
7119
|
+
* 1 and 100. If this parameter isn't used, then
|
|
7040
7120
|
* <code>ListTaskDefinitions</code> returns up to 100 results and a
|
|
7041
7121
|
* <code>nextToken</code> value if applicable.</p>
|
|
7042
7122
|
*/
|
|
@@ -7096,27 +7176,27 @@ export interface ListTasksRequest {
|
|
|
7096
7176
|
/**
|
|
7097
7177
|
* <p>The <code>nextToken</code> value returned from a <code>ListTasks</code> request
|
|
7098
7178
|
* indicating that more results are available to fulfill the request and further calls will
|
|
7099
|
-
* be needed. If <code>maxResults</code> was provided, it
|
|
7179
|
+
* be needed. If <code>maxResults</code> was provided, it's possible the number of results
|
|
7100
7180
|
* to be fewer than <code>maxResults</code>.</p>
|
|
7101
|
-
*
|
|
7181
|
+
* <note>
|
|
7102
7182
|
* <p>This token should be treated as an opaque identifier that is only used to
|
|
7103
7183
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
7104
7184
|
* </note>
|
|
7105
7185
|
*/
|
|
7106
7186
|
nextToken?: string;
|
|
7107
7187
|
/**
|
|
7108
|
-
* <p>The maximum number of task results
|
|
7188
|
+
* <p>The maximum number of task results that <code>ListTasks</code> returned in paginated
|
|
7109
7189
|
* output. When this parameter is used, <code>ListTasks</code> only returns
|
|
7110
7190
|
* <code>maxResults</code> results in a single page along with a <code>nextToken</code>
|
|
7111
7191
|
* response element. The remaining results of the initial request can be seen by sending
|
|
7112
7192
|
* another <code>ListTasks</code> request with the returned <code>nextToken</code> value.
|
|
7113
|
-
* This value can be between 1 and 100. If this parameter
|
|
7114
|
-
*
|
|
7115
|
-
*
|
|
7193
|
+
* This value can be between 1 and 100. If this parameter
|
|
7194
|
+
* isn't used, then <code>ListTasks</code> returns up to 100 results and
|
|
7195
|
+
* a <code>nextToken</code> value if applicable.</p>
|
|
7116
7196
|
*/
|
|
7117
7197
|
maxResults?: number;
|
|
7118
7198
|
/**
|
|
7119
|
-
* <p>The <code>startedBy</code> value
|
|
7199
|
+
* <p>The <code>startedBy</code> value to filter the task results with. Specifying a
|
|
7120
7200
|
* <code>startedBy</code> value limits the results to tasks that were started with that
|
|
7121
7201
|
* value.</p>
|
|
7122
7202
|
*/
|
|
@@ -7131,12 +7211,12 @@ export interface ListTasksRequest {
|
|
|
7131
7211
|
* <p>The task desired status to use when filtering the <code>ListTasks</code> results.
|
|
7132
7212
|
* Specifying a <code>desiredStatus</code> of <code>STOPPED</code> limits the results to
|
|
7133
7213
|
* tasks that Amazon ECS has set the desired status to <code>STOPPED</code>. This can be useful
|
|
7134
|
-
* for debugging tasks that
|
|
7214
|
+
* for debugging tasks that aren't starting properly or have died or finished. The default
|
|
7135
7215
|
* status filter is <code>RUNNING</code>, which shows tasks that Amazon ECS has set the desired
|
|
7136
7216
|
* status to <code>RUNNING</code>.</p>
|
|
7137
7217
|
* <note>
|
|
7138
7218
|
* <p>Although you can filter results based on a desired status of <code>PENDING</code>,
|
|
7139
|
-
* this
|
|
7219
|
+
* this doesn't return any results. Amazon ECS never sets the desired status of a task to
|
|
7140
7220
|
* that value (only a task's <code>lastStatus</code> may have a value of
|
|
7141
7221
|
* <code>PENDING</code>).</p>
|
|
7142
7222
|
* </note>
|
|
@@ -7259,9 +7339,9 @@ export declare namespace PutAccountSettingDefaultResponse {
|
|
|
7259
7339
|
const filterSensitiveLog: (obj: PutAccountSettingDefaultResponse) => any;
|
|
7260
7340
|
}
|
|
7261
7341
|
/**
|
|
7262
|
-
* <p>You can apply up to 10 custom attributes
|
|
7263
|
-
* a resource with <a>ListAttributes</a>. You can remove existing
|
|
7264
|
-
* a resource with <a>DeleteAttributes</a>.</p>
|
|
7342
|
+
* <p>You can apply up to 10 custom attributes for each resource. You can view the
|
|
7343
|
+
* attributes of a resource with <a>ListAttributes</a>. You can remove existing
|
|
7344
|
+
* attributes on a resource with <a>DeleteAttributes</a>.</p>
|
|
7265
7345
|
*/
|
|
7266
7346
|
export interface AttributeLimitExceededException extends __SmithyException, $MetadataBearer {
|
|
7267
7347
|
name: "AttributeLimitExceededException";
|
|
@@ -7282,7 +7362,7 @@ export interface PutAttributesRequest {
|
|
|
7282
7362
|
cluster?: string;
|
|
7283
7363
|
/**
|
|
7284
7364
|
* <p>The attributes to apply to your resource. You can specify up to 10 custom attributes
|
|
7285
|
-
*
|
|
7365
|
+
* for each resource. You can specify up to 10 attributes in a single call.</p>
|
|
7286
7366
|
*/
|
|
7287
7367
|
attributes: Attribute[] | undefined;
|
|
7288
7368
|
}
|
|
@@ -7307,7 +7387,7 @@ export declare namespace PutAttributesResponse {
|
|
|
7307
7387
|
export interface PutClusterCapacityProvidersRequest {
|
|
7308
7388
|
/**
|
|
7309
7389
|
* <p>The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider
|
|
7310
|
-
* settings for. If you
|
|
7390
|
+
* settings for. If you don't specify a cluster, the default cluster is assumed.</p>
|
|
7311
7391
|
*/
|
|
7312
7392
|
cluster: string | undefined;
|
|
7313
7393
|
/**
|
|
@@ -7359,7 +7439,7 @@ export declare namespace PutClusterCapacityProvidersResponse {
|
|
|
7359
7439
|
const filterSensitiveLog: (obj: PutClusterCapacityProvidersResponse) => any;
|
|
7360
7440
|
}
|
|
7361
7441
|
/**
|
|
7362
|
-
* <p>The specified resource is in-use and
|
|
7442
|
+
* <p>The specified resource is in-use and can't be removed.</p>
|
|
7363
7443
|
*/
|
|
7364
7444
|
export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
|
|
7365
7445
|
name: "ResourceInUseException";
|
|
@@ -7381,13 +7461,13 @@ export declare enum PlatformDeviceType {
|
|
|
7381
7461
|
*/
|
|
7382
7462
|
export interface PlatformDevice {
|
|
7383
7463
|
/**
|
|
7384
|
-
* <p>The ID for the
|
|
7464
|
+
* <p>The ID for the GPUs on the container instance. The available GPU IDs can also be
|
|
7385
7465
|
* obtained on the container instance in the
|
|
7386
7466
|
* <code>/var/lib/ecs/gpu/nvidia_gpu_info.json</code> file.</p>
|
|
7387
7467
|
*/
|
|
7388
7468
|
id: string | undefined;
|
|
7389
7469
|
/**
|
|
7390
|
-
* <p>The type of device that
|
|
7470
|
+
* <p>The type of device that's available on the container instance. The only supported
|
|
7391
7471
|
* value is <code>GPU</code>.</p>
|
|
7392
7472
|
*/
|
|
7393
7473
|
type: PlatformDeviceType | string | undefined;
|
|
@@ -7400,8 +7480,8 @@ export declare namespace PlatformDevice {
|
|
|
7400
7480
|
}
|
|
7401
7481
|
export interface RegisterContainerInstanceRequest {
|
|
7402
7482
|
/**
|
|
7403
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the cluster
|
|
7404
|
-
*
|
|
7483
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance
|
|
7484
|
+
* with. If you do not specify a cluster, the default cluster is assumed.</p>
|
|
7405
7485
|
*/
|
|
7406
7486
|
cluster?: string;
|
|
7407
7487
|
/**
|
|
@@ -7423,8 +7503,8 @@ export interface RegisterContainerInstanceRequest {
|
|
|
7423
7503
|
*/
|
|
7424
7504
|
totalResources?: Resource[];
|
|
7425
7505
|
/**
|
|
7426
|
-
* <p>The version information for the Amazon ECS container agent and Docker daemon
|
|
7427
|
-
* container instance.</p>
|
|
7506
|
+
* <p>The version information for the Amazon ECS container agent and Docker daemon that runs on
|
|
7507
|
+
* the container instance.</p>
|
|
7428
7508
|
*/
|
|
7429
7509
|
versionInfo?: VersionInfo;
|
|
7430
7510
|
/**
|
|
@@ -7442,9 +7522,8 @@ export interface RegisterContainerInstanceRequest {
|
|
|
7442
7522
|
platformDevices?: PlatformDevice[];
|
|
7443
7523
|
/**
|
|
7444
7524
|
* <p>The metadata that you apply to the container instance to help you categorize and
|
|
7445
|
-
* organize them. Each tag consists of a key and an optional value
|
|
7446
|
-
*
|
|
7447
|
-
* <p>The following basic restrictions apply to tags:</p>
|
|
7525
|
+
* organize them. Each tag consists of a key and an optional value. You define both.</p>
|
|
7526
|
+
* <p>The following basic restrictions apply to tags:</p>
|
|
7448
7527
|
* <ul>
|
|
7449
7528
|
* <li>
|
|
7450
7529
|
* <p>Maximum number of tags per resource - 50</p>
|
|
@@ -7498,9 +7577,9 @@ export declare namespace RegisterContainerInstanceResponse {
|
|
|
7498
7577
|
}
|
|
7499
7578
|
export interface RegisterTaskDefinitionRequest {
|
|
7500
7579
|
/**
|
|
7501
|
-
* <p>You must specify a <code>family</code> for a task definition
|
|
7502
|
-
*
|
|
7503
|
-
*
|
|
7580
|
+
* <p>You must specify a <code>family</code> for a task definition. You can use it track
|
|
7581
|
+
* multiple versions of the same task definition. The <code>family</code> is used as a name
|
|
7582
|
+
* for your task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.</p>
|
|
7504
7583
|
*/
|
|
7505
7584
|
family: string | undefined;
|
|
7506
7585
|
/**
|
|
@@ -7554,18 +7633,18 @@ export interface RegisterTaskDefinitionRequest {
|
|
|
7554
7633
|
*/
|
|
7555
7634
|
containerDefinitions: ContainerDefinition[] | undefined;
|
|
7556
7635
|
/**
|
|
7557
|
-
* <p>A list of volume definitions in JSON format that containers in your task
|
|
7636
|
+
* <p>A list of volume definitions in JSON format that containers in your task might
|
|
7558
7637
|
* use.</p>
|
|
7559
7638
|
*/
|
|
7560
7639
|
volumes?: Volume[];
|
|
7561
7640
|
/**
|
|
7562
7641
|
* <p>An array of placement constraint objects to use for the task. You can specify a
|
|
7563
|
-
* maximum of 10 constraints
|
|
7564
|
-
* definition and those specified at runtime
|
|
7642
|
+
* maximum of 10 constraints for each task. This limit includes constraints in the task
|
|
7643
|
+
* definition and those specified at runtime.</p>
|
|
7565
7644
|
*/
|
|
7566
7645
|
placementConstraints?: TaskDefinitionPlacementConstraint[];
|
|
7567
7646
|
/**
|
|
7568
|
-
* <p>The task launch type that Amazon ECS
|
|
7647
|
+
* <p>The task launch type that Amazon ECS validates the task definition against. A client
|
|
7569
7648
|
* exception is returned if the task definition doesn't validate against the
|
|
7570
7649
|
* compatibilities specified. If no value is specified, the parameter is omitted from the
|
|
7571
7650
|
* response.</p>
|
|
@@ -7573,21 +7652,23 @@ export interface RegisterTaskDefinitionRequest {
|
|
|
7573
7652
|
requiresCompatibilities?: (Compatibility | string)[];
|
|
7574
7653
|
/**
|
|
7575
7654
|
* <p>The number of CPU units used by the task. It can be expressed as an integer using CPU
|
|
7576
|
-
* units
|
|
7577
|
-
* vCPU</code> or <code>1 vcpu</code
|
|
7655
|
+
* units (for example, <code>1024</code>) or as a string using vCPUs (for example, <code>1
|
|
7656
|
+
* vCPU</code> or <code>1 vcpu</code>) in a task definition. String values are
|
|
7578
7657
|
* converted to an integer indicating the CPU units when the task definition is
|
|
7579
7658
|
* registered.</p>
|
|
7580
7659
|
* <note>
|
|
7581
7660
|
* <p>Task-level CPU and memory parameters are ignored for Windows containers. We
|
|
7582
7661
|
* recommend specifying container-level resources for Windows containers.</p>
|
|
7583
7662
|
* </note>
|
|
7584
|
-
* <p>If you
|
|
7663
|
+
* <p>If you're using the EC2 launch type, this field is optional. Supported
|
|
7585
7664
|
* values are between <code>128</code> CPU units (<code>0.125</code> vCPUs) and
|
|
7586
7665
|
* <code>10240</code> CPU units (<code>10</code> vCPUs).</p>
|
|
7587
|
-
* <p>If you
|
|
7666
|
+
* <p>If you're using the Fargate launch type, this field is required and you
|
|
7588
7667
|
* must use one of the following values, which determines your range of supported values
|
|
7589
7668
|
* for the <code>memory</code> parameter:</p>
|
|
7590
|
-
*
|
|
7669
|
+
* <p>The CPU units cannot be less than 1 vCPU when you use Windows containers on
|
|
7670
|
+
* Fargate.</p>
|
|
7671
|
+
* <ul>
|
|
7591
7672
|
* <li>
|
|
7592
7673
|
* <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p>
|
|
7593
7674
|
* </li>
|
|
@@ -7608,8 +7689,8 @@ export interface RegisterTaskDefinitionRequest {
|
|
|
7608
7689
|
cpu?: string;
|
|
7609
7690
|
/**
|
|
7610
7691
|
* <p>The amount of memory (in MiB) used by the task. It can be expressed as an integer
|
|
7611
|
-
* using MiB
|
|
7612
|
-
* <code>1GB</code> or <code>1 GB</code
|
|
7692
|
+
* using MiB (for example ,<code>1024</code>) or as a string using GB (for example,
|
|
7693
|
+
* <code>1GB</code> or <code>1 GB</code>) in a task definition. String values are
|
|
7613
7694
|
* converted to an integer indicating the MiB when the task definition is
|
|
7614
7695
|
* registered.</p>
|
|
7615
7696
|
* <note>
|
|
@@ -7618,9 +7699,11 @@ export interface RegisterTaskDefinitionRequest {
|
|
|
7618
7699
|
* </note>
|
|
7619
7700
|
* <p>If using the EC2 launch type, this field is optional.</p>
|
|
7620
7701
|
* <p>If using the Fargate launch type, this field is required and you must
|
|
7621
|
-
* use one of the following values
|
|
7622
|
-
* <code>cpu</code> parameter
|
|
7623
|
-
*
|
|
7702
|
+
* use one of the following values. This determines your range of supported values for the
|
|
7703
|
+
* <code>cpu</code> parameter.</p>
|
|
7704
|
+
* <p>The CPU units cannot be less than 1 vCPU when you use Windows containers on
|
|
7705
|
+
* Fargate.</p>
|
|
7706
|
+
* <ul>
|
|
7624
7707
|
* <li>
|
|
7625
7708
|
* <p>512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available <code>cpu</code> values: 256 (.25 vCPU)</p>
|
|
7626
7709
|
* </li>
|
|
@@ -7641,7 +7724,7 @@ export interface RegisterTaskDefinitionRequest {
|
|
|
7641
7724
|
memory?: string;
|
|
7642
7725
|
/**
|
|
7643
7726
|
* <p>The metadata that you apply to the task definition to help you categorize and organize
|
|
7644
|
-
* them. Each tag consists of a key and an optional value
|
|
7727
|
+
* them. Each tag consists of a key and an optional value. You define both of them.</p>
|
|
7645
7728
|
* <p>The following basic restrictions apply to tags:</p>
|
|
7646
7729
|
* <ul>
|
|
7647
7730
|
* <li>
|
|
@@ -7750,23 +7833,24 @@ export interface RegisterTaskDefinitionRequest {
|
|
|
7750
7833
|
* tasks hosted on Fargate. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html">Fargate task
|
|
7751
7834
|
* storage</a> in the <i>Amazon ECS User Guide for Fargate</i>.</p>
|
|
7752
7835
|
* <note>
|
|
7753
|
-
* <p>This parameter is only supported for tasks hosted on Fargate using
|
|
7836
|
+
* <p>This parameter is only supported for tasks hosted on Fargate using
|
|
7837
|
+
* the following platform versions:</p>
|
|
7754
7838
|
* <ul>
|
|
7755
7839
|
* <li>
|
|
7756
|
-
* <p>Linux platform
|
|
7757
|
-
* version <code>1.4.0</code> or later.</p>
|
|
7840
|
+
* <p>Linux platform version <code>1.4.0</code> or later.</p>
|
|
7758
7841
|
* </li>
|
|
7759
7842
|
* <li>
|
|
7760
|
-
* <p>Windows platform
|
|
7761
|
-
* version <code>1.0.0</code> or later.</p>
|
|
7843
|
+
* <p>Windows platform version <code>1.0.0</code> or later.</p>
|
|
7762
7844
|
* </li>
|
|
7763
7845
|
* </ul>
|
|
7764
7846
|
* </note>
|
|
7765
7847
|
*/
|
|
7766
7848
|
ephemeralStorage?: EphemeralStorage;
|
|
7767
7849
|
/**
|
|
7768
|
-
* <p>The operating system
|
|
7769
|
-
*
|
|
7850
|
+
* <p>The operating system that your tasks definitions run on. A platform family is
|
|
7851
|
+
* specified only for tasks using the Fargate launch type. </p>
|
|
7852
|
+
* <p>When you specify a task definition in a service, this value must match the
|
|
7853
|
+
* <code>runtimePlatform</code> value of the service.</p>
|
|
7770
7854
|
*/
|
|
7771
7855
|
runtimePlatform?: RuntimePlatform;
|
|
7772
7856
|
}
|
|
@@ -7793,7 +7877,7 @@ export declare namespace RegisterTaskDefinitionResponse {
|
|
|
7793
7877
|
const filterSensitiveLog: (obj: RegisterTaskDefinitionResponse) => any;
|
|
7794
7878
|
}
|
|
7795
7879
|
/**
|
|
7796
|
-
* <p>Your Amazon Web Services account
|
|
7880
|
+
* <p>Your Amazon Web Services account was blocked. For more information, contact <a href="http://aws.amazon.com/contact-us/">
|
|
7797
7881
|
* Amazon Web Services Support</a>.</p>
|
|
7798
7882
|
*/
|
|
7799
7883
|
export interface BlockedException extends __SmithyException, $MetadataBearer {
|
|
@@ -7814,18 +7898,19 @@ export interface RunTaskRequest {
|
|
|
7814
7898
|
* parameter must be omitted. If no <code>capacityProviderStrategy</code> or
|
|
7815
7899
|
* <code>launchType</code> is specified, the
|
|
7816
7900
|
* <code>defaultCapacityProviderStrategy</code> for the cluster is used.</p>
|
|
7817
|
-
* <p>When you use cluster auto scaling, you must specify
|
|
7901
|
+
* <p>When you use cluster auto scaling, you must specify
|
|
7902
|
+
* <code>capacityProviderStrategy</code> and not <code>launchType</code>. </p>
|
|
7818
7903
|
* <p>A capacity provider strategy may contain a maximum of 6 capacity providers.</p>
|
|
7819
7904
|
*/
|
|
7820
7905
|
capacityProviderStrategy?: CapacityProviderStrategyItem[];
|
|
7821
7906
|
/**
|
|
7822
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the cluster
|
|
7907
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster to run your task on.
|
|
7823
7908
|
* If you do not specify a cluster, the default cluster is assumed.</p>
|
|
7824
7909
|
*/
|
|
7825
7910
|
cluster?: string;
|
|
7826
7911
|
/**
|
|
7827
7912
|
* <p>The number of instantiations of the specified task to place on your cluster. You can
|
|
7828
|
-
* specify up to 10 tasks
|
|
7913
|
+
* specify up to 10 tasks for each call.</p>
|
|
7829
7914
|
*/
|
|
7830
7915
|
count?: number;
|
|
7831
7916
|
/**
|
|
@@ -7835,9 +7920,9 @@ export interface RunTaskRequest {
|
|
|
7835
7920
|
*/
|
|
7836
7921
|
enableECSManagedTags?: boolean;
|
|
7837
7922
|
/**
|
|
7838
|
-
* <p>
|
|
7839
|
-
* task. If <code>true</code>, this enables execute command functionality on all
|
|
7840
|
-
* in the task.</p>
|
|
7923
|
+
* <p>Determines whether to enable the execute command functionality for the containers in
|
|
7924
|
+
* this task. If <code>true</code>, this enables execute command functionality on all
|
|
7925
|
+
* containers in the task.</p>
|
|
7841
7926
|
*/
|
|
7842
7927
|
enableExecuteCommand?: boolean;
|
|
7843
7928
|
/**
|
|
@@ -7846,8 +7931,8 @@ export interface RunTaskRequest {
|
|
|
7846
7931
|
*/
|
|
7847
7932
|
group?: string;
|
|
7848
7933
|
/**
|
|
7849
|
-
* <p>The infrastructure
|
|
7850
|
-
*
|
|
7934
|
+
* <p>The infrastructure to run your standalone task on. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html">Amazon ECS
|
|
7935
|
+
* launch types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
7851
7936
|
* <p>The <code>FARGATE</code> launch type runs your tasks on Fargate On-Demand
|
|
7852
7937
|
* infrastructure.</p>
|
|
7853
7938
|
* <note>
|
|
@@ -7857,26 +7942,27 @@ export interface RunTaskRequest {
|
|
|
7857
7942
|
* </note>
|
|
7858
7943
|
* <p>The <code>EC2</code> launch type runs your tasks on Amazon EC2 instances registered to your
|
|
7859
7944
|
* cluster.</p>
|
|
7860
|
-
* <p>The <code>EXTERNAL</code> launch type runs your tasks on your on-
|
|
7945
|
+
* <p>The <code>EXTERNAL</code> launch type runs your tasks on your on-premises server or
|
|
7861
7946
|
* virtual machine (VM) capacity registered to your cluster.</p>
|
|
7862
7947
|
* <p>A task can use either a launch type or a capacity provider strategy. If a
|
|
7863
7948
|
* <code>launchType</code> is specified, the <code>capacityProviderStrategy</code>
|
|
7864
7949
|
* parameter must be omitted.</p>
|
|
7865
|
-
* <p>When you use cluster auto scaling, you must specify
|
|
7950
|
+
* <p>When you use cluster auto scaling, you must specify
|
|
7951
|
+
* <code>capacityProviderStrategy</code> and not <code>launchType</code>. </p>
|
|
7866
7952
|
*/
|
|
7867
7953
|
launchType?: LaunchType | string;
|
|
7868
7954
|
/**
|
|
7869
7955
|
* <p>The network configuration for the task. This parameter is required for task
|
|
7870
7956
|
* definitions that use the <code>awsvpc</code> network mode to receive their own elastic
|
|
7871
|
-
* network interface, and it
|
|
7872
|
-
*
|
|
7957
|
+
* network interface, and it isn't supported for other network modes. For more information,
|
|
7958
|
+
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html">Task networking</a>
|
|
7873
7959
|
* in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
7874
7960
|
*/
|
|
7875
7961
|
networkConfiguration?: NetworkConfiguration;
|
|
7876
7962
|
/**
|
|
7877
7963
|
* <p>A list of container overrides in JSON format that specify the name of a container in
|
|
7878
7964
|
* the specified task definition and the overrides it should receive. You can override the
|
|
7879
|
-
* default command for a container (that
|
|
7965
|
+
* default command for a container (that's specified in the task definition or Docker
|
|
7880
7966
|
* image) with a <code>command</code> override. You can also override existing environment
|
|
7881
7967
|
* variables (that are specified in the task definition or Docker image) on a container or
|
|
7882
7968
|
* add new environment variables to it with an <code>environment</code> override.</p>
|
|
@@ -7886,25 +7972,25 @@ export interface RunTaskRequest {
|
|
|
7886
7972
|
overrides?: TaskOverride;
|
|
7887
7973
|
/**
|
|
7888
7974
|
* <p>An array of placement constraint objects to use for the task. You can specify up to 10
|
|
7889
|
-
* constraints
|
|
7890
|
-
* at runtime).</p>
|
|
7975
|
+
* constraints for each task (including constraints in the task definition and those
|
|
7976
|
+
* specified at runtime).</p>
|
|
7891
7977
|
*/
|
|
7892
7978
|
placementConstraints?: PlacementConstraint[];
|
|
7893
7979
|
/**
|
|
7894
7980
|
* <p>The placement strategy objects to use for the task. You can specify a maximum of 5
|
|
7895
|
-
* strategy rules
|
|
7981
|
+
* strategy rules for each task.</p>
|
|
7896
7982
|
*/
|
|
7897
7983
|
placementStrategy?: PlacementStrategy[];
|
|
7898
7984
|
/**
|
|
7899
|
-
* <p>The platform version the task
|
|
7900
|
-
*
|
|
7901
|
-
* platform version is used
|
|
7902
|
-
*
|
|
7985
|
+
* <p>The platform version the task uses. A platform version is only specified for tasks
|
|
7986
|
+
* hosted on Fargate. If one isn't specified, the <code>LATEST</code>
|
|
7987
|
+
* platform version is used. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate platform
|
|
7988
|
+
* versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
7903
7989
|
*/
|
|
7904
7990
|
platformVersion?: string;
|
|
7905
7991
|
/**
|
|
7906
7992
|
* <p>Specifies whether to propagate the tags from the task definition to the task. If no
|
|
7907
|
-
* value is specified, the tags
|
|
7993
|
+
* value is specified, the tags aren't propagated. Tags can only be propagated to the task
|
|
7908
7994
|
* during task creation. To add tags to a task after task creation, use the <a>TagResource</a> API action.</p>
|
|
7909
7995
|
* <note>
|
|
7910
7996
|
* <p>An error will be received if you specify the <code>SERVICE</code> option when
|
|
@@ -7923,7 +8009,7 @@ export interface RunTaskRequest {
|
|
|
7923
8009
|
* job to your task with the <code>startedBy</code> parameter. You can then identify which
|
|
7924
8010
|
* tasks belong to that job by filtering the results of a <a>ListTasks</a> call
|
|
7925
8011
|
* with the <code>startedBy</code> value. Up to 36 letters (uppercase and lowercase),
|
|
7926
|
-
* numbers, hyphens, and underscores are allowed.</p>
|
|
8012
|
+
* numbers, hyphens (-), and underscores (_) are allowed.</p>
|
|
7927
8013
|
* <p>If a task is started by an Amazon ECS service, then the <code>startedBy</code> parameter
|
|
7928
8014
|
* contains the deployment ID of the service that starts it.</p>
|
|
7929
8015
|
*/
|
|
@@ -7966,10 +8052,11 @@ export interface RunTaskRequest {
|
|
|
7966
8052
|
tags?: Tag[];
|
|
7967
8053
|
/**
|
|
7968
8054
|
* <p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or
|
|
7969
|
-
* full ARN of the task definition to run. If a <code>revision</code>
|
|
8055
|
+
* full ARN of the task definition to run. If a <code>revision</code> isn't specified,
|
|
7970
8056
|
* the latest <code>ACTIVE</code> revision is used.</p>
|
|
7971
|
-
* <p>The full ARN value must match the value that you specified
|
|
7972
|
-
*
|
|
8057
|
+
* <p>The full ARN value must match the value that you specified as the
|
|
8058
|
+
* <code>Resource</code> of the IAM principal's permissions policy. For example, if the
|
|
8059
|
+
* <code>Resource</code> is
|
|
7973
8060
|
* arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the
|
|
7974
8061
|
* <code>taskDefinition</code> ARN value must be
|
|
7975
8062
|
* <code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName</code>.</p>
|
|
@@ -8001,13 +8088,13 @@ export declare namespace RunTaskResponse {
|
|
|
8001
8088
|
}
|
|
8002
8089
|
export interface StartTaskRequest {
|
|
8003
8090
|
/**
|
|
8004
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the cluster
|
|
8091
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster where to start your task.
|
|
8005
8092
|
* If you do not specify a cluster, the default cluster is assumed.</p>
|
|
8006
8093
|
*/
|
|
8007
8094
|
cluster?: string;
|
|
8008
8095
|
/**
|
|
8009
|
-
* <p>The container instance IDs or full ARN entries for the container instances
|
|
8010
|
-
*
|
|
8096
|
+
* <p>The container instance IDs or full ARN entries for the container instances where you
|
|
8097
|
+
* would like to place your task. You can specify up to 10 container instances.</p>
|
|
8011
8098
|
*/
|
|
8012
8099
|
containerInstances: string[] | undefined;
|
|
8013
8100
|
/**
|
|
@@ -8034,8 +8121,8 @@ export interface StartTaskRequest {
|
|
|
8034
8121
|
networkConfiguration?: NetworkConfiguration;
|
|
8035
8122
|
/**
|
|
8036
8123
|
* <p>A list of container overrides in JSON format that specify the name of a container in
|
|
8037
|
-
* the specified task definition and the overrides it
|
|
8038
|
-
* default command for a container (that
|
|
8124
|
+
* the specified task definition and the overrides it receives. You can override the
|
|
8125
|
+
* default command for a container (that's specified in the task definition or Docker
|
|
8039
8126
|
* image) with a <code>command</code> override. You can also override existing environment
|
|
8040
8127
|
* variables (that are specified in the task definition or Docker image) on a container or
|
|
8041
8128
|
* add new environment variables to it with an <code>environment</code> override.</p>
|
|
@@ -8047,7 +8134,7 @@ export interface StartTaskRequest {
|
|
|
8047
8134
|
overrides?: TaskOverride;
|
|
8048
8135
|
/**
|
|
8049
8136
|
* <p>Specifies whether to propagate the tags from the task definition or the service to the
|
|
8050
|
-
* task. If no value is specified, the tags
|
|
8137
|
+
* task. If no value is specified, the tags aren't propagated.</p>
|
|
8051
8138
|
*/
|
|
8052
8139
|
propagateTags?: PropagateTags | string;
|
|
8053
8140
|
/**
|
|
@@ -8060,8 +8147,8 @@ export interface StartTaskRequest {
|
|
|
8060
8147
|
* job to your task with the <code>startedBy</code> parameter. You can then identify which
|
|
8061
8148
|
* tasks belong to that job by filtering the results of a <a>ListTasks</a> call
|
|
8062
8149
|
* with the <code>startedBy</code> value. Up to 36 letters (uppercase and lowercase),
|
|
8063
|
-
* numbers, hyphens, and underscores are allowed.</p>
|
|
8064
|
-
* <p>If a task is started by an Amazon ECS service,
|
|
8150
|
+
* numbers, hyphens (-), and underscores (_) are allowed.</p>
|
|
8151
|
+
* <p>If a task is started by an Amazon ECS service, the <code>startedBy</code> parameter
|
|
8065
8152
|
* contains the deployment ID of the service that starts it.</p>
|
|
8066
8153
|
*/
|
|
8067
8154
|
startedBy?: string;
|
|
@@ -8103,7 +8190,7 @@ export interface StartTaskRequest {
|
|
|
8103
8190
|
tags?: Tag[];
|
|
8104
8191
|
/**
|
|
8105
8192
|
* <p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or
|
|
8106
|
-
* full ARN of the task definition to start. If a <code>revision</code>
|
|
8193
|
+
* full ARN of the task definition to start. If a <code>revision</code> isn't specified,
|
|
8107
8194
|
* the latest <code>ACTIVE</code> revision is used.</p>
|
|
8108
8195
|
*/
|
|
8109
8196
|
taskDefinition: string | undefined;
|
|
@@ -8142,7 +8229,7 @@ export interface StopTaskRequest {
|
|
|
8142
8229
|
*/
|
|
8143
8230
|
task: string | undefined;
|
|
8144
8231
|
/**
|
|
8145
|
-
* <p>An optional message specified when a task is stopped. For example, if you
|
|
8232
|
+
* <p>An optional message specified when a task is stopped. For example, if you're using a
|
|
8146
8233
|
* custom scheduler, you can use this parameter to specify the reason for stopping the task
|
|
8147
8234
|
* here, and the message appears in subsequent <a>DescribeTasks</a> API
|
|
8148
8235
|
* operations on this task. Up to 255 characters are allowed in this message.</p>
|
|
@@ -8237,7 +8324,7 @@ export interface SubmitContainerStateChangeRequest {
|
|
|
8237
8324
|
*/
|
|
8238
8325
|
status?: string;
|
|
8239
8326
|
/**
|
|
8240
|
-
* <p>The exit code returned for the state change request.</p>
|
|
8327
|
+
* <p>The exit code that's returned for the state change request.</p>
|
|
8241
8328
|
*/
|
|
8242
8329
|
exitCode?: number;
|
|
8243
8330
|
/**
|
|
@@ -8268,7 +8355,7 @@ export declare namespace SubmitContainerStateChangeResponse {
|
|
|
8268
8355
|
const filterSensitiveLog: (obj: SubmitContainerStateChangeResponse) => any;
|
|
8269
8356
|
}
|
|
8270
8357
|
/**
|
|
8271
|
-
* <p>An object
|
|
8358
|
+
* <p>An object that represents a change in state for a container.</p>
|
|
8272
8359
|
*/
|
|
8273
8360
|
export interface ContainerStateChange {
|
|
8274
8361
|
/**
|
|
@@ -8289,7 +8376,7 @@ export interface ContainerStateChange {
|
|
|
8289
8376
|
*/
|
|
8290
8377
|
exitCode?: number;
|
|
8291
8378
|
/**
|
|
8292
|
-
* <p>Any network bindings associated with the container.</p>
|
|
8379
|
+
* <p>Any network bindings that are associated with the container.</p>
|
|
8293
8380
|
*/
|
|
8294
8381
|
networkBindings?: NetworkBinding[];
|
|
8295
8382
|
/**
|
|
@@ -8312,7 +8399,7 @@ export declare namespace ContainerStateChange {
|
|
|
8312
8399
|
*/
|
|
8313
8400
|
export interface ManagedAgentStateChange {
|
|
8314
8401
|
/**
|
|
8315
|
-
* <p>The name of the container associated with the managed agent.</p>
|
|
8402
|
+
* <p>The name of the container that's associated with the managed agent.</p>
|
|
8316
8403
|
*/
|
|
8317
8404
|
containerName: string | undefined;
|
|
8318
8405
|
/**
|
|
@@ -8352,7 +8439,7 @@ export interface SubmitTaskStateChangeRequest {
|
|
|
8352
8439
|
*/
|
|
8353
8440
|
reason?: string;
|
|
8354
8441
|
/**
|
|
8355
|
-
* <p>Any containers associated with the state change request.</p>
|
|
8442
|
+
* <p>Any containers that's associated with the state change request.</p>
|
|
8356
8443
|
*/
|
|
8357
8444
|
containers?: ContainerStateChange[];
|
|
8358
8445
|
/**
|
|
@@ -8360,19 +8447,19 @@ export interface SubmitTaskStateChangeRequest {
|
|
|
8360
8447
|
*/
|
|
8361
8448
|
attachments?: AttachmentStateChange[];
|
|
8362
8449
|
/**
|
|
8363
|
-
* <p>The details for the managed agent associated with the task.</p>
|
|
8450
|
+
* <p>The details for the managed agent that's associated with the task.</p>
|
|
8364
8451
|
*/
|
|
8365
8452
|
managedAgents?: ManagedAgentStateChange[];
|
|
8366
8453
|
/**
|
|
8367
|
-
* <p>The Unix timestamp for when the container image pull
|
|
8454
|
+
* <p>The Unix timestamp for the time when the container image pull started.</p>
|
|
8368
8455
|
*/
|
|
8369
8456
|
pullStartedAt?: Date;
|
|
8370
8457
|
/**
|
|
8371
|
-
* <p>The Unix timestamp for when the container image pull completed.</p>
|
|
8458
|
+
* <p>The Unix timestamp for the time when the container image pull completed.</p>
|
|
8372
8459
|
*/
|
|
8373
8460
|
pullStoppedAt?: Date;
|
|
8374
8461
|
/**
|
|
8375
|
-
* <p>The Unix timestamp for when the task execution stopped.</p>
|
|
8462
|
+
* <p>The Unix timestamp for the time when the task execution stopped.</p>
|
|
8376
8463
|
*/
|
|
8377
8464
|
executionStoppedAt?: Date;
|
|
8378
8465
|
}
|
|
@@ -8395,7 +8482,7 @@ export declare namespace SubmitTaskStateChangeResponse {
|
|
|
8395
8482
|
const filterSensitiveLog: (obj: SubmitTaskStateChangeResponse) => any;
|
|
8396
8483
|
}
|
|
8397
8484
|
/**
|
|
8398
|
-
* <p>The specified resource
|
|
8485
|
+
* <p>The specified resource wasn't found.</p>
|
|
8399
8486
|
*/
|
|
8400
8487
|
export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
|
|
8401
8488
|
name: "ResourceNotFoundException";
|
|
@@ -8410,8 +8497,8 @@ export declare namespace ResourceNotFoundException {
|
|
|
8410
8497
|
}
|
|
8411
8498
|
export interface TagResourceRequest {
|
|
8412
8499
|
/**
|
|
8413
|
-
* <p>The Amazon Resource Name (ARN) of the resource to
|
|
8414
|
-
*
|
|
8500
|
+
* <p>The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are
|
|
8501
|
+
* Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container
|
|
8415
8502
|
* instances.</p>
|
|
8416
8503
|
*/
|
|
8417
8504
|
resourceArn: string | undefined;
|
|
@@ -8467,9 +8554,9 @@ export declare namespace TagResourceResponse {
|
|
|
8467
8554
|
}
|
|
8468
8555
|
export interface UntagResourceRequest {
|
|
8469
8556
|
/**
|
|
8470
|
-
* <p>The Amazon Resource Name (ARN) of the resource
|
|
8471
|
-
*
|
|
8472
|
-
*
|
|
8557
|
+
* <p>The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, the supported resources
|
|
8558
|
+
* are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container
|
|
8559
|
+
* instances.</p>
|
|
8473
8560
|
*/
|
|
8474
8561
|
resourceArn: string | undefined;
|
|
8475
8562
|
/**
|
|
@@ -8505,14 +8592,14 @@ export interface AutoScalingGroupProviderUpdate {
|
|
|
8505
8592
|
* protection.</p>
|
|
8506
8593
|
* <important>
|
|
8507
8594
|
* <p>When using managed termination protection, managed scaling must also be used
|
|
8508
|
-
* otherwise managed termination protection
|
|
8595
|
+
* otherwise managed termination protection doesn't work.</p>
|
|
8509
8596
|
* </important>
|
|
8510
8597
|
* <p>When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in
|
|
8511
8598
|
* an Auto Scaling group that contain tasks from being terminated during a scale-in action.
|
|
8512
8599
|
* The Auto Scaling group and each instance in the Auto Scaling group must have instance
|
|
8513
|
-
* protection from scale-in actions enabled
|
|
8514
|
-
* <p>When managed termination protection is disabled, your Amazon EC2 instances
|
|
8515
|
-
*
|
|
8600
|
+
* protection from scale-in actions enabled. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection">Instance Protection</a> in the <i>Auto Scaling User Guide</i>.</p>
|
|
8601
|
+
* <p>When managed termination protection is disabled, your Amazon EC2 instances aren't protected
|
|
8602
|
+
* from termination when the Auto Scaling group scales in.</p>
|
|
8516
8603
|
*/
|
|
8517
8604
|
managedTerminationProtection?: ManagedTerminationProtection | string;
|
|
8518
8605
|
}
|
|
@@ -8528,7 +8615,7 @@ export interface UpdateCapacityProviderRequest {
|
|
|
8528
8615
|
*/
|
|
8529
8616
|
name: string | undefined;
|
|
8530
8617
|
/**
|
|
8531
|
-
* <p>An object
|
|
8618
|
+
* <p>An object that represent the parameters to update for the Auto Scaling group capacity
|
|
8532
8619
|
* provider.</p>
|
|
8533
8620
|
*/
|
|
8534
8621
|
autoScalingGroupProvider: AutoScalingGroupProviderUpdate | undefined;
|
|
@@ -8590,7 +8677,7 @@ export interface UpdateClusterSettingsRequest {
|
|
|
8590
8677
|
cluster: string | undefined;
|
|
8591
8678
|
/**
|
|
8592
8679
|
* <p>The setting to use by default for a cluster. This parameter is used to enable CloudWatch
|
|
8593
|
-
* Container Insights for a cluster. If this value is specified, it
|
|
8680
|
+
* Container Insights for a cluster. If this value is specified, it overrides the
|
|
8594
8681
|
* <code>containerInsights</code> value set with <a>PutAccountSetting</a> or
|
|
8595
8682
|
* <a>PutAccountSettingDefault</a>.</p>
|
|
8596
8683
|
*/
|
|
@@ -8615,10 +8702,10 @@ export declare namespace UpdateClusterSettingsResponse {
|
|
|
8615
8702
|
const filterSensitiveLog: (obj: UpdateClusterSettingsResponse) => any;
|
|
8616
8703
|
}
|
|
8617
8704
|
/**
|
|
8618
|
-
* <p>Amazon ECS
|
|
8619
|
-
* container instance and
|
|
8620
|
-
* could be because the agent running on the container instance is
|
|
8621
|
-
* version that
|
|
8705
|
+
* <p>Amazon ECS can't determine the current version of the Amazon ECS container agent on the
|
|
8706
|
+
* container instance and doesn't have enough information to proceed with an update. This
|
|
8707
|
+
* could be because the agent running on the container instance is a previous or custom
|
|
8708
|
+
* version that doesn't use our version information.</p>
|
|
8622
8709
|
*/
|
|
8623
8710
|
export interface MissingVersionException extends __SmithyException, $MetadataBearer {
|
|
8624
8711
|
name: "MissingVersionException";
|
|
@@ -8632,9 +8719,9 @@ export declare namespace MissingVersionException {
|
|
|
8632
8719
|
const filterSensitiveLog: (obj: MissingVersionException) => any;
|
|
8633
8720
|
}
|
|
8634
8721
|
/**
|
|
8635
|
-
* <p>There
|
|
8636
|
-
* agent is already running the latest version
|
|
8637
|
-
* path to the current version.</p>
|
|
8722
|
+
* <p>There's no update available for this Amazon ECS container agent. This might be because the
|
|
8723
|
+
* agent is already running the latest version or because it's so old that there's no
|
|
8724
|
+
* update path to the current version.</p>
|
|
8638
8725
|
*/
|
|
8639
8726
|
export interface NoUpdateAvailableException extends __SmithyException, $MetadataBearer {
|
|
8640
8727
|
name: "NoUpdateAvailableException";
|
|
@@ -8654,8 +8741,8 @@ export interface UpdateContainerAgentRequest {
|
|
|
8654
8741
|
*/
|
|
8655
8742
|
cluster?: string;
|
|
8656
8743
|
/**
|
|
8657
|
-
* <p>The container instance ID or full ARN entries for the container instance
|
|
8658
|
-
*
|
|
8744
|
+
* <p>The container instance ID or full ARN entries for the container instance where you
|
|
8745
|
+
* would like to update the Amazon ECS container agent.</p>
|
|
8659
8746
|
*/
|
|
8660
8747
|
containerInstance: string | undefined;
|
|
8661
8748
|
}
|
|
@@ -8667,7 +8754,7 @@ export declare namespace UpdateContainerAgentRequest {
|
|
|
8667
8754
|
}
|
|
8668
8755
|
export interface UpdateContainerAgentResponse {
|
|
8669
8756
|
/**
|
|
8670
|
-
* <p>The container instance
|
|
8757
|
+
* <p>The container instance that the container agent was updated for.</p>
|
|
8671
8758
|
*/
|
|
8672
8759
|
containerInstance?: ContainerInstance;
|
|
8673
8760
|
}
|
|
@@ -8688,13 +8775,12 @@ export interface UpdateContainerInstancesStateRequest {
|
|
|
8688
8775
|
*/
|
|
8689
8776
|
containerInstances: string[] | undefined;
|
|
8690
8777
|
/**
|
|
8691
|
-
* <p>The container instance state
|
|
8692
|
-
*
|
|
8693
|
-
*
|
|
8694
|
-
*
|
|
8695
|
-
* <code>
|
|
8696
|
-
*
|
|
8697
|
-
* will be unable to update the container instance state.</p>
|
|
8778
|
+
* <p>The container instance state to update the container instance with. The only valid
|
|
8779
|
+
* values for this action are <code>ACTIVE</code> and <code>DRAINING</code>. A container
|
|
8780
|
+
* instance can only be updated to <code>DRAINING</code> status once it has reached an
|
|
8781
|
+
* <code>ACTIVE</code> state. If a container instance is in <code>REGISTERING</code>,
|
|
8782
|
+
* <code>DEREGISTERING</code>, or <code>REGISTRATION_FAILED</code> state you can
|
|
8783
|
+
* describe the container instance but can't update the container instance state.</p>
|
|
8698
8784
|
*/
|
|
8699
8785
|
status: ContainerInstanceStatus | string | undefined;
|
|
8700
8786
|
}
|
|
@@ -8722,7 +8808,7 @@ export declare namespace UpdateContainerInstancesStateResponse {
|
|
|
8722
8808
|
}
|
|
8723
8809
|
export interface UpdateServiceRequest {
|
|
8724
8810
|
/**
|
|
8725
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that your service
|
|
8811
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that your service runs on.
|
|
8726
8812
|
* If you do not specify a cluster, the default cluster is assumed.</p>
|
|
8727
8813
|
*/
|
|
8728
8814
|
cluster?: string;
|
|
@@ -8745,11 +8831,11 @@ export interface UpdateServiceRequest {
|
|
|
8745
8831
|
taskDefinition?: string;
|
|
8746
8832
|
/**
|
|
8747
8833
|
* <p>The capacity provider strategy to update the service to use.</p>
|
|
8748
|
-
* <p>
|
|
8834
|
+
* <p>if the service uses the default capacity provider strategy for the cluster, the
|
|
8749
8835
|
* service can be updated to use one or more capacity providers as opposed to the default
|
|
8750
8836
|
* capacity provider strategy. However, when a service is using a capacity provider
|
|
8751
|
-
* strategy that
|
|
8752
|
-
*
|
|
8837
|
+
* strategy that's not the default capacity provider strategy, the service can't be updated
|
|
8838
|
+
* to use the cluster's default capacity provider strategy.</p>
|
|
8753
8839
|
* <p>A capacity provider strategy consists of one or more capacity providers along with the
|
|
8754
8840
|
* <code>base</code> and <code>weight</code> to assign to them. A capacity provider
|
|
8755
8841
|
* must be associated with the cluster to be used in a capacity provider strategy. The
|
|
@@ -8782,8 +8868,8 @@ export interface UpdateServiceRequest {
|
|
|
8782
8868
|
* unchanged. If this value is specified, it will override any existing placement
|
|
8783
8869
|
* constraints defined for the service. To remove all existing placement constraints,
|
|
8784
8870
|
* specify an empty array.</p>
|
|
8785
|
-
* <p>You can specify a maximum of 10 constraints
|
|
8786
|
-
* in the task definition and those specified at runtime
|
|
8871
|
+
* <p>You can specify a maximum of 10 constraints for each task. This limit includes
|
|
8872
|
+
* constraints in the task definition and those specified at runtime.</p>
|
|
8787
8873
|
*/
|
|
8788
8874
|
placementConstraints?: PlacementConstraint[];
|
|
8789
8875
|
/**
|
|
@@ -8791,34 +8877,34 @@ export interface UpdateServiceRequest {
|
|
|
8791
8877
|
* specified, the existing placement strategy for the service will remain unchanged. If
|
|
8792
8878
|
* this value is specified, it will override the existing placement strategy defined for
|
|
8793
8879
|
* the service. To remove an existing placement strategy, specify an empty object.</p>
|
|
8794
|
-
* <p>You can specify a maximum of five strategy rules
|
|
8880
|
+
* <p>You can specify a maximum of five strategy rules for each service.</p>
|
|
8795
8881
|
*/
|
|
8796
8882
|
placementStrategy?: PlacementStrategy[];
|
|
8797
8883
|
/**
|
|
8798
|
-
* <p>The platform version
|
|
8799
|
-
*
|
|
8800
|
-
*
|
|
8801
|
-
*
|
|
8884
|
+
* <p>The platform version that your tasks in the service run on. A platform version is only
|
|
8885
|
+
* specified for tasks using the Fargate launch type. If a platform version
|
|
8886
|
+
* is not specified, the <code>LATEST</code> platform version is used. For more
|
|
8887
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate Platform
|
|
8802
8888
|
* Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
8803
8889
|
*/
|
|
8804
8890
|
platformVersion?: string;
|
|
8805
8891
|
/**
|
|
8806
|
-
* <p>
|
|
8807
|
-
*
|
|
8808
|
-
* changes. For example, you can update a service's tasks to use a newer Docker
|
|
8809
|
-
* the same image/tag combination (<code>my_image:latest</code>) or to roll
|
|
8810
|
-
* onto a newer platform version.</p>
|
|
8892
|
+
* <p>Determines whether to force a new deployment of the service. By default, deployments
|
|
8893
|
+
* aren't forced. You can use this option to start a new deployment with no service
|
|
8894
|
+
* definition changes. For example, you can update a service's tasks to use a newer Docker
|
|
8895
|
+
* image with the same image/tag combination (<code>my_image:latest</code>) or to roll
|
|
8896
|
+
* Fargate tasks onto a newer platform version.</p>
|
|
8811
8897
|
*/
|
|
8812
8898
|
forceNewDeployment?: boolean;
|
|
8813
8899
|
/**
|
|
8814
|
-
* <p>The period of time, in seconds, that the Amazon ECS service scheduler
|
|
8815
|
-
*
|
|
8816
|
-
*
|
|
8817
|
-
*
|
|
8818
|
-
*
|
|
8819
|
-
*
|
|
8820
|
-
*
|
|
8821
|
-
*
|
|
8900
|
+
* <p>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy
|
|
8901
|
+
* Elastic Load Balancing target health checks after a task has first started. This is only valid if your
|
|
8902
|
+
* service is configured to use a load balancer. If your service's tasks take a while to
|
|
8903
|
+
* start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of
|
|
8904
|
+
* up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores
|
|
8905
|
+
* the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler
|
|
8906
|
+
* from marking tasks as unhealthy and stopping them before they have time to come
|
|
8907
|
+
* up.</p>
|
|
8822
8908
|
*/
|
|
8823
8909
|
healthCheckGracePeriodSeconds?: number;
|
|
8824
8910
|
/**
|
|
@@ -8884,11 +8970,11 @@ export declare namespace UpdateServicePrimaryTaskSetResponse {
|
|
|
8884
8970
|
export interface UpdateTaskSetRequest {
|
|
8885
8971
|
/**
|
|
8886
8972
|
* <p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task
|
|
8887
|
-
* set
|
|
8973
|
+
* set is found in.</p>
|
|
8888
8974
|
*/
|
|
8889
8975
|
cluster: string | undefined;
|
|
8890
8976
|
/**
|
|
8891
|
-
* <p>The short name or full Amazon Resource Name (ARN) of the service that the task set
|
|
8977
|
+
* <p>The short name or full Amazon Resource Name (ARN) of the service that the task set is found in.</p>
|
|
8892
8978
|
*/
|
|
8893
8979
|
service: string | undefined;
|
|
8894
8980
|
/**
|