@aws-sdk/client-ecs 3.112.0 → 3.118.1
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 +24 -0
- package/README.md +4 -4
- package/dist-cjs/waiters/index.js +1 -0
- package/dist-cjs/waiters/waitForServicesStable.js +84 -0
- package/dist-es/waiters/index.js +1 -0
- package/dist-es/waiters/waitForServicesStable.js +130 -0
- package/dist-types/ECS.d.ts +52 -52
- package/dist-types/ECSClient.d.ts +4 -4
- package/dist-types/commands/CreateClusterCommand.d.ts +1 -1
- package/dist-types/commands/CreateServiceCommand.d.ts +7 -6
- package/dist-types/commands/CreateTaskSetCommand.d.ts +2 -2
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTasksCommand.d.ts +1 -0
- package/dist-types/commands/ExecuteCommandCommand.d.ts +4 -0
- package/dist-types/commands/PutAccountSettingCommand.d.ts +3 -3
- package/dist-types/commands/RunTaskCommand.d.ts +5 -5
- package/dist-types/commands/UpdateServiceCommand.d.ts +24 -30
- package/dist-types/models/models_0.d.ts +220 -183
- package/dist-types/ts3.4/waiters/index.d.ts +1 -0
- package/dist-types/ts3.4/waiters/waitForServicesStable.d.ts +7 -0
- package/dist-types/waiters/index.d.ts +1 -0
- package/dist-types/waiters/waitForServicesStable.d.ts +14 -0
- package/package.json +7 -7
|
@@ -41,7 +41,7 @@ export declare enum ManagedScalingStatus {
|
|
|
41
41
|
* <p>When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of
|
|
42
42
|
* the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS
|
|
43
43
|
* managed CloudWatch metric with the specified <code>targetCapacity</code> value as the target
|
|
44
|
-
* 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
|
|
44
|
+
* 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>
|
|
45
45
|
* <p>If managed scaling is disabled, the user must manage the scaling of the Auto Scaling
|
|
46
46
|
* group.</p>
|
|
47
47
|
*/
|
|
@@ -734,7 +734,8 @@ export declare namespace Attachment {
|
|
|
734
734
|
*/
|
|
735
735
|
export interface Cluster {
|
|
736
736
|
/**
|
|
737
|
-
* <p>The Amazon Resource Name (ARN) that identifies the cluster.
|
|
737
|
+
* <p>The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN
|
|
738
|
+
* format, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids">Amazon Resource Name (ARN)</a> in the <i>Amazon ECS Developer Guide</i>.</p>
|
|
738
739
|
*/
|
|
739
740
|
clusterArn?: string;
|
|
740
741
|
/**
|
|
@@ -881,7 +882,8 @@ export interface Cluster {
|
|
|
881
882
|
defaultCapacityProviderStrategy?: CapacityProviderStrategyItem[];
|
|
882
883
|
/**
|
|
883
884
|
* <p>The resources attached to a cluster. When using a capacity provider with a cluster,
|
|
884
|
-
* the
|
|
885
|
+
* the capacity provider and associated resources are returned as cluster
|
|
886
|
+
* attachments.</p>
|
|
885
887
|
*/
|
|
886
888
|
attachments?: Attachment[];
|
|
887
889
|
/**
|
|
@@ -890,8 +892,7 @@ export interface Cluster {
|
|
|
890
892
|
* <dl>
|
|
891
893
|
* <dt>UPDATE_IN_PROGRESS</dt>
|
|
892
894
|
* <dd>
|
|
893
|
-
* <p>The available capacity providers for the cluster are updating
|
|
894
|
-
* when the Auto Scaling plan is provisioning or deprovisioning.</p>
|
|
895
|
+
* <p>The available capacity providers for the cluster are updating.</p>
|
|
895
896
|
* </dd>
|
|
896
897
|
* <dt>UPDATE_COMPLETE</dt>
|
|
897
898
|
* <dd>
|
|
@@ -942,14 +943,13 @@ export declare class ClusterNotFoundException extends __BaseException {
|
|
|
942
943
|
* <p>The <b>deployment circuit breaker</b> determines whether a
|
|
943
944
|
* service deployment will fail if the service can't reach a steady state. If enabled, a
|
|
944
945
|
* service deployment will transition to a failed state and stop launching new tasks. You
|
|
945
|
-
* can also configure Amazon ECS to roll back your service to the last completed deployment
|
|
946
|
-
* failure. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html">Rolling
|
|
946
|
+
* can also configure Amazon ECS to roll back your service to the last completed deployment
|
|
947
|
+
* after a failure. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html">Rolling
|
|
947
948
|
* update</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
948
949
|
*/
|
|
949
950
|
export interface DeploymentCircuitBreaker {
|
|
950
951
|
/**
|
|
951
|
-
* <p>Determines whether to use the deployment circuit breaker logic for the
|
|
952
|
-
* service.</p>
|
|
952
|
+
* <p>Determines whether to use the deployment circuit breaker logic for the service.</p>
|
|
953
953
|
*/
|
|
954
954
|
enable: boolean | undefined;
|
|
955
955
|
/**
|
|
@@ -984,17 +984,17 @@ export interface DeploymentConfiguration {
|
|
|
984
984
|
deploymentCircuitBreaker?: DeploymentCircuitBreaker;
|
|
985
985
|
/**
|
|
986
986
|
* <p>If a service is using the rolling update (<code>ECS</code>) deployment type, the
|
|
987
|
-
* <
|
|
988
|
-
*
|
|
989
|
-
* <code>PENDING</code> state during a deployment, as a percentage of the
|
|
990
|
-
*
|
|
991
|
-
*
|
|
992
|
-
*
|
|
993
|
-
*
|
|
994
|
-
*
|
|
995
|
-
*
|
|
996
|
-
*
|
|
997
|
-
* <p>If a service is using the blue/green (<code>CODE_DEPLOY</code>) or
|
|
987
|
+
* <code>maximumPercent</code> parameter represents an upper limit on the number of
|
|
988
|
+
* your service's tasks that are allowed in the <code>RUNNING</code> or
|
|
989
|
+
* <code>PENDING</code> state during a deployment, as a percentage of the
|
|
990
|
+
* <code>desiredCount</code> (rounded down to the nearest integer). This parameter
|
|
991
|
+
* enables you to define the deployment batch size. For example, if your service is using
|
|
992
|
+
* the <code>REPLICA</code> service scheduler and has a <code>desiredCount</code> of four
|
|
993
|
+
* tasks and a <code>maximumPercent</code> value of 200%, the scheduler may start four new
|
|
994
|
+
* tasks before stopping the four older tasks (provided that the cluster resources required
|
|
995
|
+
* to do this are available). The default <code>maximumPercent</code> value for a service
|
|
996
|
+
* using the <code>REPLICA</code> service scheduler is 200%.</p>
|
|
997
|
+
* <p>If a service is using either the blue/green (<code>CODE_DEPLOY</code>) or
|
|
998
998
|
* <code>EXTERNAL</code> deployment types and tasks that use the EC2
|
|
999
999
|
* launch type, the <b>maximum percent</b> value is set to the
|
|
1000
1000
|
* default value and is used to define the upper limit on the number of the tasks in the
|
|
@@ -1006,27 +1006,61 @@ export interface DeploymentConfiguration {
|
|
|
1006
1006
|
maximumPercent?: number;
|
|
1007
1007
|
/**
|
|
1008
1008
|
* <p>If a service is using the rolling update (<code>ECS</code>) deployment type, the
|
|
1009
|
-
* <
|
|
1010
|
-
*
|
|
1011
|
-
*
|
|
1012
|
-
*
|
|
1013
|
-
*
|
|
1014
|
-
*
|
|
1015
|
-
*
|
|
1016
|
-
*
|
|
1017
|
-
*
|
|
1018
|
-
*
|
|
1019
|
-
*
|
|
1020
|
-
*
|
|
1021
|
-
*
|
|
1022
|
-
*
|
|
1023
|
-
*
|
|
1024
|
-
*
|
|
1025
|
-
*
|
|
1026
|
-
*
|
|
1027
|
-
*
|
|
1028
|
-
*
|
|
1029
|
-
*
|
|
1009
|
+
* <code>minimumHealthyPercent</code> represents a lower limit on the number of your
|
|
1010
|
+
* service's tasks that must remain in the <code>RUNNING</code> state during a deployment,
|
|
1011
|
+
* as a percentage of the <code>desiredCount</code> (rounded up to the nearest integer).
|
|
1012
|
+
* This parameter enables you to deploy without using additional cluster capacity. For
|
|
1013
|
+
* example, if your service has a <code>desiredCount</code> of four tasks and a
|
|
1014
|
+
* <code>minimumHealthyPercent</code> of 50%, the service scheduler may stop two
|
|
1015
|
+
* existing tasks to free up cluster capacity before starting two new tasks. </p>
|
|
1016
|
+
* <p>For services that <i>do not</i> use a load balancer, the following
|
|
1017
|
+
* should be noted:</p>
|
|
1018
|
+
* <ul>
|
|
1019
|
+
* <li>
|
|
1020
|
+
* <p>A service is considered healthy if all essential containers within the tasks
|
|
1021
|
+
* in the service pass their health checks.</p>
|
|
1022
|
+
* </li>
|
|
1023
|
+
* <li>
|
|
1024
|
+
* <p>If a task has no essential containers with a health check defined, the service
|
|
1025
|
+
* scheduler will wait for 40 seconds after a task reaches a <code>RUNNING</code>
|
|
1026
|
+
* state before the task is counted towards the minimum healthy percent
|
|
1027
|
+
* total.</p>
|
|
1028
|
+
* </li>
|
|
1029
|
+
* <li>
|
|
1030
|
+
* <p>If a task has one or more essential containers with a health check defined,
|
|
1031
|
+
* the service scheduler will wait for the task to reach a healthy status before
|
|
1032
|
+
* counting it towards the minimum healthy percent total. A task is considered
|
|
1033
|
+
* healthy when all essential containers within the task have passed their health
|
|
1034
|
+
* checks. The amount of time the service scheduler can wait for is determined by
|
|
1035
|
+
* the container health check settings. </p>
|
|
1036
|
+
* </li>
|
|
1037
|
+
* </ul>
|
|
1038
|
+
* <p>For services are that <i>do</i> use a load balancer, the following
|
|
1039
|
+
* should be noted:</p>
|
|
1040
|
+
* <ul>
|
|
1041
|
+
* <li>
|
|
1042
|
+
* <p>If a task has no essential containers with a health check defined, the service
|
|
1043
|
+
* scheduler will wait for the load balancer target group health check to return a
|
|
1044
|
+
* healthy status before counting the task towards the minimum healthy percent
|
|
1045
|
+
* total.</p>
|
|
1046
|
+
* </li>
|
|
1047
|
+
* <li>
|
|
1048
|
+
* <p>If a task has an essential container with a health check defined, the service
|
|
1049
|
+
* scheduler will wait for both the task to reach a healthy status and the load
|
|
1050
|
+
* balancer target group health check to return a healthy status before counting
|
|
1051
|
+
* the task towards the minimum healthy percent total.</p>
|
|
1052
|
+
* </li>
|
|
1053
|
+
* </ul>
|
|
1054
|
+
* <p>If a service is using either the blue/green (<code>CODE_DEPLOY</code>) or
|
|
1055
|
+
* <code>EXTERNAL</code> deployment types and is running tasks that use the
|
|
1056
|
+
* EC2 launch type, the <b>minimum healthy
|
|
1057
|
+
* percent</b> value is set to the default value and is used to define the lower
|
|
1058
|
+
* limit on the number of the tasks in the service that remain in the <code>RUNNING</code>
|
|
1059
|
+
* state while the container instances are in the <code>DRAINING</code> state. If a service
|
|
1060
|
+
* is using either the blue/green (<code>CODE_DEPLOY</code>) or <code>EXTERNAL</code>
|
|
1061
|
+
* deployment types and is running tasks that use the Fargate launch type,
|
|
1062
|
+
* the minimum healthy percent value is not used, although it is returned when describing
|
|
1063
|
+
* your service.</p>
|
|
1030
1064
|
*/
|
|
1031
1065
|
minimumHealthyPercent?: number;
|
|
1032
1066
|
}
|
|
@@ -1042,7 +1076,7 @@ export declare enum DeploymentControllerType {
|
|
|
1042
1076
|
EXTERNAL = "EXTERNAL"
|
|
1043
1077
|
}
|
|
1044
1078
|
/**
|
|
1045
|
-
* <p>The deployment controller to use for the service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS
|
|
1079
|
+
* <p>The deployment controller to use for the service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1046
1080
|
*/
|
|
1047
1081
|
export interface DeploymentController {
|
|
1048
1082
|
/**
|
|
@@ -1088,14 +1122,14 @@ export declare enum LaunchType {
|
|
|
1088
1122
|
* <p>The load balancer configuration to use with a service or task set.</p>
|
|
1089
1123
|
* <p>For specific notes and restrictions regarding the use of load balancers with services
|
|
1090
1124
|
* and task sets, see the CreateService and CreateTaskSet actions.</p>
|
|
1091
|
-
* <p>When you add, update, or remove a load balancer configuration, Amazon ECS starts a new
|
|
1092
|
-
* with the updated Elastic Load Balancing configuration. This causes tasks to register to and
|
|
1093
|
-
* from load balancers.</p>
|
|
1125
|
+
* <p>When you add, update, or remove a load balancer configuration, Amazon ECS starts a new
|
|
1126
|
+
* deployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and
|
|
1127
|
+
* deregister from load balancers.</p>
|
|
1094
1128
|
* <p>We recommend that you verify this on a test environment before you update the Elastic Load Balancing
|
|
1095
1129
|
* configuration. </p>
|
|
1096
1130
|
* <p>A service-linked role is required for services that use multiple target groups. For
|
|
1097
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">
|
|
1098
|
-
* roles</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1131
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using
|
|
1132
|
+
* service-linked roles</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1099
1133
|
*/
|
|
1100
1134
|
export interface LoadBalancer {
|
|
1101
1135
|
/**
|
|
@@ -1104,10 +1138,10 @@ export interface LoadBalancer {
|
|
|
1104
1138
|
* <p>A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a
|
|
1105
1139
|
* Classic Load Balancer, omit the target group ARN.</p>
|
|
1106
1140
|
* <p>For services using the <code>ECS</code> deployment controller, you can specify one or
|
|
1107
|
-
* multiple target groups. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html">Registering
|
|
1141
|
+
* 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
|
|
1108
1142
|
* the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1109
1143
|
* <p>For services using the <code>CODE_DEPLOY</code> deployment controller, you're required
|
|
1110
|
-
* 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/
|
|
1144
|
+
* 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
|
|
1111
1145
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1112
1146
|
* <important>
|
|
1113
1147
|
* <p>If your service's task definition uses the <code>awsvpc</code> network mode, you
|
|
@@ -1209,7 +1243,7 @@ export declare enum PlacementConstraintType {
|
|
|
1209
1243
|
}
|
|
1210
1244
|
/**
|
|
1211
1245
|
* <p>An object representing a constraint on task placement. For more information, see
|
|
1212
|
-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html">Task
|
|
1246
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html">Task placement constraints</a> in the
|
|
1213
1247
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1214
1248
|
* <note>
|
|
1215
1249
|
* <p>If you're using the Fargate launch type, task placement constraints
|
|
@@ -1244,7 +1278,7 @@ export declare enum PlacementStrategyType {
|
|
|
1244
1278
|
SPREAD = "spread"
|
|
1245
1279
|
}
|
|
1246
1280
|
/**
|
|
1247
|
-
* <p>The task placement strategy for a task or service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html">Task
|
|
1281
|
+
* <p>The task placement strategy for a task or service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html">Task placement strategies</a> in the
|
|
1248
1282
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1249
1283
|
*/
|
|
1250
1284
|
export interface PlacementStrategy {
|
|
@@ -1286,8 +1320,8 @@ export declare enum SchedulingStrategy {
|
|
|
1286
1320
|
}
|
|
1287
1321
|
/**
|
|
1288
1322
|
* <p>The details for the service registry.</p>
|
|
1289
|
-
* <p>Each service may be associated with one service registry. Multiple service registries
|
|
1290
|
-
* each service are not supported.</p>
|
|
1323
|
+
* <p>Each service may be associated with one service registry. Multiple service registries
|
|
1324
|
+
* for each service are not supported.</p>
|
|
1291
1325
|
* <p>When you add, update, or remove the service registries configuration, Amazon ECS starts a
|
|
1292
1326
|
* new deployment. New tasks are registered and deregistered to the updated service
|
|
1293
1327
|
* registry configuration.</p>
|
|
@@ -1355,7 +1389,7 @@ export interface CreateServiceRequest {
|
|
|
1355
1389
|
taskDefinition?: string;
|
|
1356
1390
|
/**
|
|
1357
1391
|
* <p>A load balancer object representing the load balancers to use with your service. For
|
|
1358
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service
|
|
1392
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load balancing</a> in the
|
|
1359
1393
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1360
1394
|
* <p>If the service uses the rolling update (<code>ECS</code>) deployment controller and
|
|
1361
1395
|
* using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach
|
|
@@ -1371,8 +1405,8 @@ export interface CreateServiceRequest {
|
|
|
1371
1405
|
* also have up to two listeners: a required listener for production traffic and an
|
|
1372
1406
|
* optional listener that you can use to perform validation tests with Lambda functions
|
|
1373
1407
|
* before routing production traffic to it.</p>
|
|
1374
|
-
* <p>If you use the <code>CODE_DEPLOY</code> deployment controller, these values can be
|
|
1375
|
-
* when updating the service.</p>
|
|
1408
|
+
* <p>If you use the <code>CODE_DEPLOY</code> deployment controller, these values can be
|
|
1409
|
+
* changed when updating the service.</p>
|
|
1376
1410
|
* <p>For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,
|
|
1377
1411
|
* the container name, and the container port to access from the load balancer. The
|
|
1378
1412
|
* container name must be as it appears in a container definition. The load balancer name
|
|
@@ -1381,9 +1415,9 @@ export interface CreateServiceRequest {
|
|
|
1381
1415
|
* target group that's specified here.</p>
|
|
1382
1416
|
* <p>For Classic Load Balancers, this object must contain the load balancer name, the container name , and
|
|
1383
1417
|
* the container port to access from the load balancer. The container name must be as it
|
|
1384
|
-
* appears in a container definition. The target group ARN parameter must be omitted.
|
|
1385
|
-
* a task from this service is placed on a container instance, the container instance
|
|
1386
|
-
* registered with the load balancer that's specified here.</p>
|
|
1418
|
+
* appears in a container definition. The target group ARN parameter must be omitted.
|
|
1419
|
+
* When a task from this service is placed on a container instance, the container instance
|
|
1420
|
+
* is registered with the load balancer that's specified here.</p>
|
|
1387
1421
|
* <p>Services with tasks that use the <code>awsvpc</code> network mode (for example, those
|
|
1388
1422
|
* with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers
|
|
1389
1423
|
* aren't supported. Also, when you create any target groups for these services, you must
|
|
@@ -1504,7 +1538,9 @@ export interface CreateServiceRequest {
|
|
|
1504
1538
|
* service is configured to use a load balancer. If your service has a load balancer
|
|
1505
1539
|
* defined and you don't specify a health check grace period value, the default value of
|
|
1506
1540
|
* <code>0</code> is used.</p>
|
|
1507
|
-
* <p>If you do not use an Elastic Load Balancing, we recomend that you use the <code>startPeriod</code> in
|
|
1541
|
+
* <p>If you do not use an Elastic Load Balancing, we recomend that you use the <code>startPeriod</code> in
|
|
1542
|
+
* the task definition healtch check parameters. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html">Health
|
|
1543
|
+
* check</a>.</p>
|
|
1508
1544
|
* <p>If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you
|
|
1509
1545
|
* can specify a health check grace period of up to
|
|
1510
1546
|
* 2,147,483,647
|
|
@@ -1589,8 +1625,8 @@ export interface CreateServiceRequest {
|
|
|
1589
1625
|
tags?: Tag[];
|
|
1590
1626
|
/**
|
|
1591
1627
|
* <p>Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For
|
|
1592
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging
|
|
1593
|
-
*
|
|
1628
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging your Amazon ECS
|
|
1629
|
+
* resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1594
1630
|
*/
|
|
1595
1631
|
enableECSManagedTags?: boolean;
|
|
1596
1632
|
/**
|
|
@@ -1997,7 +2033,8 @@ export declare namespace TaskSet {
|
|
|
1997
2033
|
*/
|
|
1998
2034
|
export interface Service {
|
|
1999
2035
|
/**
|
|
2000
|
-
* <p>The ARN that identifies the service.
|
|
2036
|
+
* <p>The ARN that identifies the service. For more information about the ARN format,
|
|
2037
|
+
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids">Amazon Resource Name (ARN)</a> in the <i>Amazon ECS Developer Guide</i>.</p>
|
|
2001
2038
|
*/
|
|
2002
2039
|
serviceArn?: string;
|
|
2003
2040
|
/**
|
|
@@ -2132,11 +2169,11 @@ export interface Service {
|
|
|
2132
2169
|
* </li>
|
|
2133
2170
|
* <li>
|
|
2134
2171
|
* <p>
|
|
2135
|
-
* <code>DAEMON</code>-The daemon scheduling strategy deploys exactly one
|
|
2136
|
-
* active container instance. This task meets all of the task
|
|
2137
|
-
* that you specify in your cluster. The service scheduler
|
|
2138
|
-
* placement constraints for running tasks. It stop tasks
|
|
2139
|
-
* placement constraints.</p>
|
|
2172
|
+
* <code>DAEMON</code>-The daemon scheduling strategy deploys exactly one
|
|
2173
|
+
* task on each active container instance. This task meets all of the task
|
|
2174
|
+
* placement constraints that you specify in your cluster. The service scheduler
|
|
2175
|
+
* also evaluates the task placement constraints for running tasks. It stop tasks
|
|
2176
|
+
* that don't meet the placement constraints.</p>
|
|
2140
2177
|
* <note>
|
|
2141
2178
|
* <p>Fargate tasks don't support the <code>DAEMON</code>
|
|
2142
2179
|
* scheduling strategy.</p>
|
|
@@ -2305,12 +2342,12 @@ export interface CreateTaskSetRequest {
|
|
|
2305
2342
|
/**
|
|
2306
2343
|
* <p>The details of the service discovery registries to assign to this task set. For more
|
|
2307
2344
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html">Service
|
|
2308
|
-
*
|
|
2345
|
+
* discovery</a>.</p>
|
|
2309
2346
|
*/
|
|
2310
2347
|
serviceRegistries?: ServiceRegistry[];
|
|
2311
2348
|
/**
|
|
2312
2349
|
* <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
|
|
2313
|
-
*
|
|
2350
|
+
* launch types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2314
2351
|
* <p>If a <code>launchType</code> is specified, the <code>capacityProviderStrategy</code>
|
|
2315
2352
|
* parameter must be omitted.</p>
|
|
2316
2353
|
*/
|
|
@@ -2510,8 +2547,8 @@ export declare enum TargetType {
|
|
|
2510
2547
|
CONTAINER_INSTANCE = "container-instance"
|
|
2511
2548
|
}
|
|
2512
2549
|
/**
|
|
2513
|
-
* <p>An attribute is a name-value pair that's associated with an Amazon ECS object. Use
|
|
2514
|
-
* to extend the Amazon ECS data model by adding custom metadata to your resources.
|
|
2550
|
+
* <p>An attribute is a name-value pair that's associated with an Amazon ECS object. Use
|
|
2551
|
+
* attributes to extend the Amazon ECS data model by adding custom metadata to your resources.
|
|
2515
2552
|
* 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>
|
|
2516
2553
|
*/
|
|
2517
2554
|
export interface Attribute {
|
|
@@ -2768,8 +2805,8 @@ export interface DeregisterContainerInstanceRequest {
|
|
|
2768
2805
|
*/
|
|
2769
2806
|
cluster?: string;
|
|
2770
2807
|
/**
|
|
2771
|
-
* <p>The container instance ID or full ARN of the container instance to deregister.
|
|
2772
|
-
*
|
|
2808
|
+
* <p>The container instance ID or full ARN of the container instance to deregister. For
|
|
2809
|
+
* more information about the ARN format, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids">Amazon Resource Name (ARN)</a> in the <i>Amazon ECS Developer Guide</i>.</p>
|
|
2773
2810
|
*/
|
|
2774
2811
|
containerInstance: string | undefined;
|
|
2775
2812
|
/**
|
|
@@ -2917,12 +2954,13 @@ export declare namespace VersionInfo {
|
|
|
2917
2954
|
const filterSensitiveLog: (obj: VersionInfo) => any;
|
|
2918
2955
|
}
|
|
2919
2956
|
/**
|
|
2920
|
-
* <p>An EC2 instance that's running the Amazon ECS agent and has been registered
|
|
2921
|
-
* cluster.</p>
|
|
2957
|
+
* <p>An Amazon EC2 or External instance that's running the Amazon ECS agent and has been registered
|
|
2958
|
+
* with a cluster.</p>
|
|
2922
2959
|
*/
|
|
2923
2960
|
export interface ContainerInstance {
|
|
2924
2961
|
/**
|
|
2925
|
-
* <p>The Amazon Resource Name (ARN) of the container instance.
|
|
2962
|
+
* <p>The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format,
|
|
2963
|
+
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids">Amazon Resource Name (ARN)</a> in the <i>Amazon ECS Developer Guide</i>.</p>
|
|
2926
2964
|
*/
|
|
2927
2965
|
containerInstanceArn?: string;
|
|
2928
2966
|
/**
|
|
@@ -2983,7 +3021,7 @@ export interface ContainerInstance {
|
|
|
2983
3021
|
* <p>The <code>ACTIVE</code> status indicates that the container instance can accept tasks.
|
|
2984
3022
|
* The <code>DRAINING</code> indicates that new tasks aren't placed on the container
|
|
2985
3023
|
* instance and any service tasks running on the container instance are removed if
|
|
2986
|
-
* possible. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html">Container
|
|
3024
|
+
* 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
|
|
2987
3025
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2988
3026
|
*/
|
|
2989
3027
|
status?: string;
|
|
@@ -2992,10 +3030,9 @@ export interface ContainerInstance {
|
|
|
2992
3030
|
*/
|
|
2993
3031
|
statusReason?: string;
|
|
2994
3032
|
/**
|
|
2995
|
-
* <p>This parameter returns <code>true</code> if the agent is connected to Amazon ECS.
|
|
2996
|
-
*
|
|
2997
|
-
*
|
|
2998
|
-
* requests.</p>
|
|
3033
|
+
* <p>This parameter returns <code>true</code> if the agent is connected to Amazon ECS. An
|
|
3034
|
+
* instance with an agent that may be unhealthy or stopped return <code>false</code>. Only
|
|
3035
|
+
* instances connected to an agent can accept task placement requests.</p>
|
|
2999
3036
|
*/
|
|
3000
3037
|
agentConnected?: boolean;
|
|
3001
3038
|
/**
|
|
@@ -3024,8 +3061,8 @@ export interface ContainerInstance {
|
|
|
3024
3061
|
*/
|
|
3025
3062
|
registeredAt?: Date;
|
|
3026
3063
|
/**
|
|
3027
|
-
* <p>The resources attached to a container instance, such as elastic network
|
|
3028
|
-
*
|
|
3064
|
+
* <p>The resources attached to a container instance, such as an elastic network
|
|
3065
|
+
* interface.</p>
|
|
3029
3066
|
*/
|
|
3030
3067
|
attachments?: Attachment[];
|
|
3031
3068
|
/**
|
|
@@ -3255,7 +3292,7 @@ export declare enum FirelensConfigurationType {
|
|
|
3255
3292
|
}
|
|
3256
3293
|
/**
|
|
3257
3294
|
* <p>The FireLens configuration for the container. This is used to specify and configure a
|
|
3258
|
-
* log router for container logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html">Custom
|
|
3295
|
+
* log router for container logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html">Custom log routing</a>
|
|
3259
3296
|
* in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
3260
3297
|
*/
|
|
3261
3298
|
export interface FirelensConfiguration {
|
|
@@ -3271,7 +3308,7 @@ export interface FirelensConfiguration {
|
|
|
3271
3308
|
* specified, the syntax to use is
|
|
3272
3309
|
* <code>"options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}</code>.
|
|
3273
3310
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef">Creating
|
|
3274
|
-
* a
|
|
3311
|
+
* a task definition that uses a FireLens configuration</a> in the
|
|
3275
3312
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
3276
3313
|
* <note>
|
|
3277
3314
|
* <p>Tasks hosted on Fargate only support the <code>file</code> configuration file
|
|
@@ -3292,12 +3329,11 @@ export declare namespace FirelensConfiguration {
|
|
|
3292
3329
|
* container image (such as those specified in a parent image or from the image's
|
|
3293
3330
|
* Dockerfile).</p>
|
|
3294
3331
|
* <note>
|
|
3295
|
-
* <p>The Amazon ECS container agent only monitors and reports on the health
|
|
3296
|
-
*
|
|
3297
|
-
*
|
|
3298
|
-
* specified in
|
|
3299
|
-
*
|
|
3300
|
-
* checks that exist in the container image.</p>
|
|
3332
|
+
* <p>The Amazon ECS container agent only monitors and reports on the health checks specified
|
|
3333
|
+
* in the task definition. Amazon ECS does not monitor Docker health checks that are
|
|
3334
|
+
* embedded in a container image and not specified in the container definition. Health
|
|
3335
|
+
* check parameters that are specified in a container definition override any Docker
|
|
3336
|
+
* health checks that exist in the container image.</p>
|
|
3301
3337
|
* </note>
|
|
3302
3338
|
* <p>You can view the health status of both individual containers and a task with the
|
|
3303
3339
|
* DescribeTasks API operation or when viewing the task details in the console.</p>
|
|
@@ -3349,12 +3385,13 @@ export declare namespace FirelensConfiguration {
|
|
|
3349
3385
|
* <li>
|
|
3350
3386
|
* <p>Container health checks require version 1.17.0 or greater of the Amazon ECS
|
|
3351
3387
|
* container agent. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html">Updating the
|
|
3352
|
-
* Amazon ECS
|
|
3388
|
+
* Amazon ECS container agent</a>.</p>
|
|
3353
3389
|
* </li>
|
|
3354
3390
|
* <li>
|
|
3355
3391
|
* <p>Container health checks are supported for Fargate tasks if
|
|
3356
|
-
* you're using platform version 1.1.0 or greater. For more
|
|
3357
|
-
*
|
|
3392
|
+
* you're using platform version <code>1.1.0</code> or greater. For more
|
|
3393
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate
|
|
3394
|
+
* platform versions</a>.</p>
|
|
3358
3395
|
* </li>
|
|
3359
3396
|
* <li>
|
|
3360
3397
|
* <p>Container health checks aren't supported for tasks that are part of a service
|
|
@@ -3640,7 +3677,7 @@ export declare enum LogDriver {
|
|
|
3640
3677
|
* </li>
|
|
3641
3678
|
* </ul>
|
|
3642
3679
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html">Specifying
|
|
3643
|
-
*
|
|
3680
|
+
* sensitive data</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
3644
3681
|
*/
|
|
3645
3682
|
export interface Secret {
|
|
3646
3683
|
/**
|
|
@@ -3648,13 +3685,15 @@ export interface Secret {
|
|
|
3648
3685
|
*/
|
|
3649
3686
|
name: string | undefined;
|
|
3650
3687
|
/**
|
|
3651
|
-
* <p>The secret to expose to the container. The supported values are either the full ARN
|
|
3652
|
-
* the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter
|
|
3653
|
-
*
|
|
3688
|
+
* <p>The secret to expose to the container. The supported values are either the full ARN
|
|
3689
|
+
* of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter
|
|
3690
|
+
* Store.</p>
|
|
3691
|
+
* <p>For information about the require Identity and Access Management permissions, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam">Required IAM permissions for Amazon ECS secrets</a> (for Secrets Manager) or <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html">Required IAM permissions for Amazon ECS secrets</a> (for Systems Manager Parameter
|
|
3692
|
+
* store) in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
3654
3693
|
* <note>
|
|
3655
3694
|
* <p>If the SSM Parameter Store parameter exists in the same Region as the task
|
|
3656
|
-
* you're launching, then you can use either the full ARN or name of the parameter.
|
|
3657
|
-
* the parameter exists in a different Region, then the full ARN must be
|
|
3695
|
+
* you're launching, then you can use either the full ARN or name of the parameter.
|
|
3696
|
+
* If the parameter exists in a different Region, then the full ARN must be
|
|
3658
3697
|
* specified.</p>
|
|
3659
3698
|
* </note>
|
|
3660
3699
|
*/
|
|
@@ -3735,7 +3774,7 @@ export interface LogConfiguration {
|
|
|
3735
3774
|
options?: Record<string, string>;
|
|
3736
3775
|
/**
|
|
3737
3776
|
* <p>The secrets to pass to the log configuration. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html">Specifying
|
|
3738
|
-
*
|
|
3777
|
+
* sensitive data</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
3739
3778
|
*/
|
|
3740
3779
|
secretOptions?: Secret[];
|
|
3741
3780
|
}
|
|
@@ -3856,9 +3895,9 @@ export interface RepositoryCredentials {
|
|
|
3856
3895
|
* credentials.</p>
|
|
3857
3896
|
* <note>
|
|
3858
3897
|
* <p>When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same
|
|
3859
|
-
* Region as the task that you're launching then you can use either the full ARN or
|
|
3860
|
-
* name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN
|
|
3861
|
-
* secret.</p>
|
|
3898
|
+
* Region as the task that you're launching then you can use either the full ARN or
|
|
3899
|
+
* the name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN
|
|
3900
|
+
* of the secret.</p>
|
|
3862
3901
|
* </note>
|
|
3863
3902
|
*/
|
|
3864
3903
|
credentialsParameter: string | undefined;
|
|
@@ -4139,12 +4178,10 @@ export interface ContainerDefinition {
|
|
|
4139
4178
|
* <code>memoryReservation</code>, then that value is subtracted from the available
|
|
4140
4179
|
* memory resources for the container instance where the container is placed. Otherwise,
|
|
4141
4180
|
* the value of <code>memory</code> is used.</p>
|
|
4142
|
-
* <p>The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of
|
|
4143
|
-
*
|
|
4144
|
-
*
|
|
4145
|
-
*
|
|
4146
|
-
* of memory for a container, so you should not specify fewer than 4 MiB of
|
|
4147
|
-
* memory for your containers.</p>
|
|
4181
|
+
* <p>The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a
|
|
4182
|
+
* container. So, don't specify less than 6 MiB of memory for your containers. </p>
|
|
4183
|
+
* <p>The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a
|
|
4184
|
+
* container. So, don't specify less than 4 MiB of memory for your containers.</p>
|
|
4148
4185
|
*/
|
|
4149
4186
|
memory?: number;
|
|
4150
4187
|
/**
|
|
@@ -4388,15 +4425,15 @@ export interface ContainerDefinition {
|
|
|
4388
4425
|
* <code>stopTimeout</code> parameter or the <code>ECS_CONTAINER_STOP_TIMEOUT</code>
|
|
4389
4426
|
* agent configuration variable are set, then the default values of 30 seconds for Linux
|
|
4390
4427
|
* containers and 30 seconds on Windows containers are used. Your container instances
|
|
4391
|
-
* require at least version 1.26.0 of the container agent to use a container stop
|
|
4392
|
-
*
|
|
4393
|
-
*
|
|
4394
|
-
* <
|
|
4395
|
-
*
|
|
4396
|
-
*
|
|
4397
|
-
*
|
|
4398
|
-
*
|
|
4399
|
-
*
|
|
4428
|
+
* require at least version 1.26.0 of the container agent to use a container stop timeout
|
|
4429
|
+
* value. However, we recommend using the latest container agent version. For information
|
|
4430
|
+
* about checking 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 Container Agent</a> in the
|
|
4431
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>. If you're using an Amazon ECS-optimized Linux AMI, your
|
|
4432
|
+
* instance needs at least version 1.26.0-1 of the <code>ecs-init</code> package. If your
|
|
4433
|
+
* container instances are launched from version <code>20190301</code> or later, then they
|
|
4434
|
+
* contain the required versions of the container agent and <code>ecs-init</code>. For more
|
|
4435
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html">Amazon ECS-optimized Linux AMI</a>
|
|
4436
|
+
* in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4400
4437
|
*/
|
|
4401
4438
|
stopTimeout?: number;
|
|
4402
4439
|
/**
|
|
@@ -4667,9 +4704,9 @@ export declare namespace ContainerDefinition {
|
|
|
4667
4704
|
* tasks hosted on Fargate. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html">Fargate task
|
|
4668
4705
|
* storage</a> in the <i>Amazon ECS User Guide for Fargate</i>.</p>
|
|
4669
4706
|
* <note>
|
|
4670
|
-
* <p>This parameter is only supported for tasks hosted on Fargate using
|
|
4671
|
-
* platform version <code>1.4.0</code> or later. This parameter is not supported
|
|
4672
|
-
* Windows containers on Fargate.</p>
|
|
4707
|
+
* <p>This parameter is only supported for tasks hosted on Fargate using
|
|
4708
|
+
* Linux platform version <code>1.4.0</code> or later. This parameter is not supported
|
|
4709
|
+
* for Windows containers on Fargate.</p>
|
|
4673
4710
|
* </note>
|
|
4674
4711
|
*/
|
|
4675
4712
|
export interface EphemeralStorage {
|
|
@@ -4851,8 +4888,9 @@ export declare enum OSFamily {
|
|
|
4851
4888
|
export interface RuntimePlatform {
|
|
4852
4889
|
/**
|
|
4853
4890
|
* <p>The CPU architecture.</p>
|
|
4854
|
-
* <p>You can run your Linux tasks on an ARM-based platform by setting the value
|
|
4855
|
-
*
|
|
4891
|
+
* <p>You can run your Linux tasks on an ARM-based platform by setting the value to
|
|
4892
|
+
* <code>ARM64</code>. This option is avaiable for tasks that run on Linux Amazon EC2
|
|
4893
|
+
* instance or Linux containers on Fargate.</p>
|
|
4856
4894
|
*/
|
|
4857
4895
|
cpuArchitecture?: CPUArchitecture | string;
|
|
4858
4896
|
/**
|
|
@@ -4943,7 +4981,7 @@ export interface EFSAuthorizationConfig {
|
|
|
4943
4981
|
* to <code>/</code> which will enforce the path set on the EFS access point. If an access
|
|
4944
4982
|
* point is used, transit encryption must be enabled in the
|
|
4945
4983
|
* <code>EFSVolumeConfiguration</code>. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html">Working with Amazon
|
|
4946
|
-
* EFS
|
|
4984
|
+
* EFS access points</a> in the <i>Amazon Elastic File System User Guide</i>.</p>
|
|
4947
4985
|
*/
|
|
4948
4986
|
accessPointId?: string;
|
|
4949
4987
|
/**
|
|
@@ -4951,7 +4989,7 @@ export interface EFSAuthorizationConfig {
|
|
|
4951
4989
|
* mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the
|
|
4952
4990
|
* <code>EFSVolumeConfiguration</code>. If this parameter is omitted, the default value
|
|
4953
4991
|
* 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
|
|
4954
|
-
* Amazon EFS
|
|
4992
|
+
* Amazon EFS access points</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4955
4993
|
*/
|
|
4956
4994
|
iam?: EFSAuthorizationConfigIAM | string;
|
|
4957
4995
|
}
|
|
@@ -4967,7 +5005,7 @@ export declare enum EFSTransitEncryption {
|
|
|
4967
5005
|
}
|
|
4968
5006
|
/**
|
|
4969
5007
|
* <p>This parameter is specified when you're using an Amazon Elastic File System file system for task
|
|
4970
|
-
* storage. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html">Amazon EFS
|
|
5008
|
+
* storage. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html">Amazon EFS volumes</a> in the
|
|
4971
5009
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4972
5010
|
*/
|
|
4973
5011
|
export interface EFSVolumeConfiguration {
|
|
@@ -4987,18 +5025,18 @@ export interface EFSVolumeConfiguration {
|
|
|
4987
5025
|
*/
|
|
4988
5026
|
rootDirectory?: string;
|
|
4989
5027
|
/**
|
|
4990
|
-
* <p>Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS
|
|
4991
|
-
*
|
|
4992
|
-
*
|
|
4993
|
-
*
|
|
5028
|
+
* <p>Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host
|
|
5029
|
+
* and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is
|
|
5030
|
+
* used. If this parameter is omitted, the default value of <code>DISABLED</code> is used.
|
|
5031
|
+
* For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html">Encrypting data in transit</a> in
|
|
4994
5032
|
* the <i>Amazon Elastic File System User Guide</i>.</p>
|
|
4995
5033
|
*/
|
|
4996
5034
|
transitEncryption?: EFSTransitEncryption | string;
|
|
4997
5035
|
/**
|
|
4998
5036
|
* <p>The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS
|
|
4999
5037
|
* server. If you do not specify a transit encryption port, it will use the port selection
|
|
5000
|
-
* strategy that the Amazon EFS mount helper uses. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html">EFS
|
|
5001
|
-
*
|
|
5038
|
+
* strategy that the Amazon EFS mount helper uses. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html">EFS mount
|
|
5039
|
+
* helper</a> in the <i>Amazon Elastic File System User Guide</i>.</p>
|
|
5002
5040
|
*/
|
|
5003
5041
|
transitEncryptionPort?: number;
|
|
5004
5042
|
/**
|
|
@@ -5013,16 +5051,16 @@ export declare namespace EFSVolumeConfiguration {
|
|
|
5013
5051
|
const filterSensitiveLog: (obj: EFSVolumeConfiguration) => any;
|
|
5014
5052
|
}
|
|
5015
5053
|
/**
|
|
5016
|
-
* <p>The authorization configuration details for Amazon FSx for Windows File Server file system. See <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FSxWindowsFileServerVolumeConfiguration.html">FSxWindowsFileServerVolumeConfiguration</a> in the <i>Amazon
|
|
5017
|
-
*
|
|
5054
|
+
* <p>The authorization configuration details for Amazon FSx for Windows File Server file system. See <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FSxWindowsFileServerVolumeConfiguration.html">FSxWindowsFileServerVolumeConfiguration</a> in the <i>Amazon ECS API
|
|
5055
|
+
* Reference</i>.</p>
|
|
5018
5056
|
* <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>
|
|
5019
5057
|
* in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
5020
5058
|
*/
|
|
5021
5059
|
export interface FSxWindowsFileServerAuthorizationConfig {
|
|
5022
5060
|
/**
|
|
5023
5061
|
* <p>The authorization credential option to use. The authorization credential options can
|
|
5024
|
-
* be provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM
|
|
5025
|
-
*
|
|
5062
|
+
* be provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store
|
|
5063
|
+
* parameter. The ARN refers to the stored credentials.</p>
|
|
5026
5064
|
*/
|
|
5027
5065
|
credentialsParameter: string | undefined;
|
|
5028
5066
|
/**
|
|
@@ -5040,7 +5078,7 @@ export declare namespace FSxWindowsFileServerAuthorizationConfig {
|
|
|
5040
5078
|
/**
|
|
5041
5079
|
* <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
|
|
5042
5080
|
* storage.</p>
|
|
5043
|
-
* <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
|
|
5081
|
+
* <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>
|
|
5044
5082
|
* in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
5045
5083
|
*/
|
|
5046
5084
|
export interface FSxWindowsFileServerVolumeConfiguration {
|
|
@@ -6475,8 +6513,8 @@ export declare namespace DescribeTaskSetsResponse {
|
|
|
6475
6513
|
}
|
|
6476
6514
|
export interface DiscoverPollEndpointRequest {
|
|
6477
6515
|
/**
|
|
6478
|
-
* <p>The container instance ID or full ARN of the container instance.
|
|
6479
|
-
*
|
|
6516
|
+
* <p>The container instance ID or full ARN of the container instance. For more
|
|
6517
|
+
* information about the ARN format, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids">Amazon Resource Name (ARN)</a> in the <i>Amazon ECS Developer Guide</i>.</p>
|
|
6480
6518
|
*/
|
|
6481
6519
|
containerInstance?: string;
|
|
6482
6520
|
/**
|
|
@@ -6546,9 +6584,8 @@ export interface Session {
|
|
|
6546
6584
|
*/
|
|
6547
6585
|
sessionId?: string;
|
|
6548
6586
|
/**
|
|
6549
|
-
* <p>A URL
|
|
6550
|
-
*
|
|
6551
|
-
* uses to send commands and receive output from the container.</p>
|
|
6587
|
+
* <p>A URL to the managed agent on the container that the SSM Session Manager client uses
|
|
6588
|
+
* to send commands and receive output from the container.</p>
|
|
6552
6589
|
*/
|
|
6553
6590
|
streamUrl?: string;
|
|
6554
6591
|
/**
|
|
@@ -6603,18 +6640,18 @@ export declare namespace ExecuteCommandResponse {
|
|
|
6603
6640
|
* configuration issues:</p>
|
|
6604
6641
|
* <ul>
|
|
6605
6642
|
* <li>
|
|
6606
|
-
*
|
|
6607
|
-
*
|
|
6643
|
+
* <p>Incorrect IAM permissions</p>
|
|
6644
|
+
* </li>
|
|
6608
6645
|
* <li>
|
|
6609
|
-
*
|
|
6610
|
-
*
|
|
6646
|
+
* <p>The SSM agent is not installed or is not running</p>
|
|
6647
|
+
* </li>
|
|
6611
6648
|
* <li>
|
|
6612
|
-
*
|
|
6613
|
-
*
|
|
6649
|
+
* <p> There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for
|
|
6650
|
+
* for Systems Manager Session Manager</p>
|
|
6651
|
+
* </li>
|
|
6614
6652
|
* </ul>
|
|
6615
|
-
*
|
|
6616
|
-
*
|
|
6617
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
6653
|
+
* <p>For information about how to troubleshoot the issues, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html">Troubleshooting issues with ECS
|
|
6654
|
+
* Exec</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
6618
6655
|
*/
|
|
6619
6656
|
export declare class TargetNotConnectedException extends __BaseException {
|
|
6620
6657
|
readonly name: "TargetNotConnectedException";
|
|
@@ -7273,9 +7310,9 @@ export interface PutAccountSettingRequest {
|
|
|
7273
7310
|
*/
|
|
7274
7311
|
value: string | undefined;
|
|
7275
7312
|
/**
|
|
7276
|
-
* <p>The ARN of the principal, which can be an IAM user, IAM role, or the root user. If
|
|
7277
|
-
* specify the root user, it modifies the account setting for all IAM users, IAM roles,
|
|
7278
|
-
* the root user of the account unless an IAM user or role explicitly overrides these
|
|
7313
|
+
* <p>The ARN of the principal, which can be an IAM user, IAM role, or the root user. If
|
|
7314
|
+
* you specify the root user, it modifies the account setting for all IAM users, IAM roles,
|
|
7315
|
+
* and the root user of the account unless an IAM user or role explicitly overrides these
|
|
7279
7316
|
* settings. If this field is omitted, the setting is changed only for the authenticated
|
|
7280
7317
|
* user.</p>
|
|
7281
7318
|
* <note>
|
|
@@ -7912,9 +7949,9 @@ export interface RunTaskRequest {
|
|
|
7912
7949
|
*/
|
|
7913
7950
|
enableECSManagedTags?: boolean;
|
|
7914
7951
|
/**
|
|
7915
|
-
* <p>Determines whether to use the execute command functionality for the containers in
|
|
7916
|
-
*
|
|
7917
|
-
*
|
|
7952
|
+
* <p>Determines whether to use the execute command functionality for the containers in this
|
|
7953
|
+
* task. If <code>true</code>, this enables execute command functionality on all containers
|
|
7954
|
+
* in the task.</p>
|
|
7918
7955
|
* <p>If <code>true</code>, then the task definition must have a task role, or you must
|
|
7919
7956
|
* provide one as an override.</p>
|
|
7920
7957
|
*/
|
|
@@ -8048,22 +8085,22 @@ export interface RunTaskRequest {
|
|
|
8048
8085
|
* <p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or
|
|
8049
8086
|
* full ARN of the task definition to run. If a <code>revision</code> isn't specified,
|
|
8050
8087
|
* the latest <code>ACTIVE</code> revision is used.</p>
|
|
8051
|
-
* <p>When you create an IAM policy for run-task, you can set the resource to be the latest
|
|
8052
|
-
*
|
|
8053
|
-
*
|
|
8054
|
-
*
|
|
8055
|
-
*
|
|
8088
|
+
* <p>When you create an IAM policy for run-task, you can set the resource to be the latest
|
|
8089
|
+
* task definition revision, or a specific revision.</p>
|
|
8090
|
+
* <p>The full ARN value must match the value that you specified as the
|
|
8091
|
+
* <code>Resource</code> of the IAM principal's permissions policy.</p>
|
|
8092
|
+
* <p>When you specify the policy resource as the latest task definition version (by setting
|
|
8093
|
+
* the <code>Resource</code> in the policy to
|
|
8056
8094
|
* <code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName</code>),
|
|
8057
8095
|
* then set this value to
|
|
8058
8096
|
* <code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName</code>.</p>
|
|
8059
|
-
* <p>When you specify the policy resource as a specific task definition version (by setting
|
|
8060
|
-
*
|
|
8097
|
+
* <p>When you specify the policy resource as a specific task definition version (by setting
|
|
8098
|
+
* the <code>Resource</code> in the policy to
|
|
8061
8099
|
* <code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1</code> or
|
|
8062
8100
|
* <code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*</code>),
|
|
8063
8101
|
* then set this value to
|
|
8064
8102
|
* <code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1</code>.</p>
|
|
8065
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-resources">Policy Resources for Amazon ECS</a> in the Amazon Elastic Container Service
|
|
8066
|
-
* developer Guide.</p>
|
|
8103
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-resources">Policy Resources for Amazon ECS</a> in the Amazon Elastic Container Service developer Guide.</p>
|
|
8067
8104
|
*/
|
|
8068
8105
|
taskDefinition: string | undefined;
|
|
8069
8106
|
}
|
|
@@ -8910,8 +8947,8 @@ export interface UpdateServiceRequest {
|
|
|
8910
8947
|
*/
|
|
8911
8948
|
enableExecuteCommand?: boolean;
|
|
8912
8949
|
/**
|
|
8913
|
-
* <p>Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For
|
|
8914
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your Amazon ECS
|
|
8950
|
+
* <p>Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For
|
|
8951
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your Amazon ECS
|
|
8915
8952
|
* Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
8916
8953
|
* <p>Only tasks launched after the update will reflect the update. To update the tags on
|
|
8917
8954
|
* all tasks, set <code>forceNewDeployment</code> to <code>true</code>, so that Amazon ECS
|
|
@@ -8922,21 +8959,21 @@ export interface UpdateServiceRequest {
|
|
|
8922
8959
|
* <p>A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the
|
|
8923
8960
|
* container name, and the container port to access from the load balancer. The container
|
|
8924
8961
|
* name is as it appears in a container definition.</p>
|
|
8925
|
-
* <p>When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks
|
|
8926
|
-
* the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks
|
|
8927
|
-
* running.</p>
|
|
8928
|
-
* <p>For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target
|
|
8929
|
-
* You can update from a single target group to multiple target groups and from
|
|
8930
|
-
* target groups to a single target group.</p>
|
|
8931
|
-
* <p>For services that use blue/green deployments, you can update Elastic Load Balancing target groups by
|
|
8932
|
-
*
|
|
8962
|
+
* <p>When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks
|
|
8963
|
+
* with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks
|
|
8964
|
+
* are running.</p>
|
|
8965
|
+
* <p>For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target
|
|
8966
|
+
* groups. You can update from a single target group to multiple target groups and from
|
|
8967
|
+
* multiple target groups to a single target group.</p>
|
|
8968
|
+
* <p>For services that use blue/green deployments, you can update Elastic Load Balancing target groups by
|
|
8969
|
+
* using <code>
|
|
8933
8970
|
* <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html">CreateDeployment</a>
|
|
8934
8971
|
* </code> through CodeDeploy. Note that multiple target groups
|
|
8935
8972
|
* are not supported for blue/green deployments. For more information see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html">Register
|
|
8936
8973
|
* multiple target groups with a service</a> in the
|
|
8937
8974
|
* <i>Amazon Elastic Container Service Developer Guide</i>. </p>
|
|
8938
|
-
* <p>For services that use the external deployment controller, you can add, update, or
|
|
8939
|
-
* load balancers by using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>.
|
|
8975
|
+
* <p>For services that use the external deployment controller, you can add, update, or
|
|
8976
|
+
* remove load balancers by using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>.
|
|
8940
8977
|
* Note that multiple target groups are not supported for external deployments. For more
|
|
8941
8978
|
* information see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html">Register
|
|
8942
8979
|
* multiple target groups with a service</a> in the
|
|
@@ -8956,9 +8993,9 @@ export interface UpdateServiceRequest {
|
|
|
8956
8993
|
* <p>The details for the service discovery registries to assign to this service. For more
|
|
8957
8994
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html">Service
|
|
8958
8995
|
* Discovery</a>.</p>
|
|
8959
|
-
* <p>When you add, update, or remove the service registries configuration, Amazon ECS starts new
|
|
8960
|
-
* with the updated service registries configuration, and then stops the old tasks
|
|
8961
|
-
* new tasks are running.</p>
|
|
8996
|
+
* <p>When you add, update, or remove the service registries configuration, Amazon ECS starts new
|
|
8997
|
+
* tasks with the updated service registries configuration, and then stops the old tasks
|
|
8998
|
+
* when the new tasks are running.</p>
|
|
8962
8999
|
* <p>You can remove existing <code>serviceRegistries</code> by passing an empty
|
|
8963
9000
|
* list.</p>
|
|
8964
9001
|
*/
|