@aws-sdk/client-ecs 3.222.0 → 3.223.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/dist-cjs/endpoint/ruleset.js +1 -1
- package/dist-es/endpoint/ruleset.js +1 -1
- package/dist-types/ECS.d.ts +20 -30
- package/dist-types/commands/CreateClusterCommand.d.ts +1 -2
- package/dist-types/commands/CreateServiceCommand.d.ts +6 -8
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +1 -2
- package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +5 -5
- package/dist-types/commands/PutAttributesCommand.d.ts +1 -2
- package/dist-types/commands/RunTaskCommand.d.ts +1 -2
- package/dist-types/commands/StartTaskCommand.d.ts +1 -2
- package/dist-types/commands/StopTaskCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +2 -4
- package/dist-types/commands/UpdateServiceCommand.d.ts +1 -2
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +172 -183
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/package.json +3 -4
package/dist-types/ECS.d.ts
CHANGED
|
@@ -93,8 +93,7 @@ export declare class ECS extends ECSClient {
|
|
|
93
93
|
* required resources in other Amazon Web Services services on your behalf. However, if the IAM user
|
|
94
94
|
* that makes the call doesn't have permissions to create the service-linked role, it
|
|
95
95
|
* isn't created. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using
|
|
96
|
-
* service-linked roles for Amazon ECS</a> in the
|
|
97
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
96
|
+
* service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
98
97
|
* </note>
|
|
99
98
|
*/
|
|
100
99
|
createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise<CreateClusterCommandOutput>;
|
|
@@ -108,8 +107,7 @@ export declare class ECS extends ECSClient {
|
|
|
108
107
|
* <p>In addition to maintaining the desired count of tasks in your service, you can
|
|
109
108
|
* optionally run your service behind one or more load balancers. The load balancers
|
|
110
109
|
* distribute traffic across the tasks that are associated with the service. For more
|
|
111
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load balancing</a> in the
|
|
112
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
110
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
113
111
|
* <p>Tasks for services that don't use a load balancer are considered healthy if they're in
|
|
114
112
|
* the <code>RUNNING</code> state. Tasks for services that use a load balancer are
|
|
115
113
|
* considered healthy if they're in the <code>RUNNING</code> state and are reported as
|
|
@@ -122,8 +120,7 @@ export declare class ECS extends ECSClient {
|
|
|
122
120
|
* maintains your desired number of tasks across your cluster. By default, the
|
|
123
121
|
* service scheduler spreads tasks across Availability Zones. You can use task
|
|
124
122
|
* placement strategies and constraints to customize task placement decisions. For
|
|
125
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the
|
|
126
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
123
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
127
124
|
* </li>
|
|
128
125
|
* <li>
|
|
129
126
|
* <p>
|
|
@@ -133,8 +130,7 @@ export declare class ECS extends ECSClient {
|
|
|
133
130
|
* evaluates the task placement constraints for running tasks. It also stops tasks
|
|
134
131
|
* that don't meet the placement constraints. When using this strategy, you don't
|
|
135
132
|
* need to specify a desired number of tasks, a task placement strategy, or use
|
|
136
|
-
* Service Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the
|
|
137
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
133
|
+
* Service Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
138
134
|
* </li>
|
|
139
135
|
* </ul>
|
|
140
136
|
* <p>You can optionally specify a deployment configuration for your service. The deployment
|
|
@@ -178,8 +174,9 @@ export declare class ECS extends ECSClient {
|
|
|
178
174
|
* <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you
|
|
179
175
|
* can specify only parameters that aren't controlled at the task set level. The only
|
|
180
176
|
* required parameter is the service name. You control your services using the <a>CreateTaskSet</a> operation. 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>
|
|
181
|
-
* <p>When the service scheduler launches new tasks, it determines task placement. For
|
|
182
|
-
* about task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS
|
|
177
|
+
* <p>When the service scheduler launches new tasks, it determines task placement. For
|
|
178
|
+
* information about task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS
|
|
179
|
+
* task placement</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
183
180
|
*/
|
|
184
181
|
createService(args: CreateServiceCommandInput, options?: __HttpHandlerOptions): Promise<CreateServiceCommandOutput>;
|
|
185
182
|
createService(args: CreateServiceCommandInput, cb: (err: any, data?: CreateServiceCommandOutput) => void): void;
|
|
@@ -415,8 +412,7 @@ export declare class ECS extends ECSClient {
|
|
|
415
412
|
/**
|
|
416
413
|
* <p>Returns a list of container instances in a specified cluster. You can filter the
|
|
417
414
|
* results of a <code>ListContainerInstances</code> operation with cluster query language
|
|
418
|
-
* statements inside the <code>filter</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the
|
|
419
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
415
|
+
* statements inside the <code>filter</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
420
416
|
*/
|
|
421
417
|
listContainerInstances(args: ListContainerInstancesCommandInput, options?: __HttpHandlerOptions): Promise<ListContainerInstancesCommandOutput>;
|
|
422
418
|
listContainerInstances(args: ListContainerInstancesCommandInput, cb: (err: any, data?: ListContainerInstancesCommandOutput) => void): void;
|
|
@@ -429,11 +425,11 @@ export declare class ECS extends ECSClient {
|
|
|
429
425
|
listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void;
|
|
430
426
|
listServices(args: ListServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicesCommandOutput) => void): void;
|
|
431
427
|
/**
|
|
432
|
-
* <p>This operation lists all of the services that are associated with a Cloud Map
|
|
433
|
-
* might include services in different clusters. In contrast,
|
|
434
|
-
*
|
|
435
|
-
* services in a single cluster by various parameters, use
|
|
436
|
-
*
|
|
428
|
+
* <p>This operation lists all of the services that are associated with a Cloud Map
|
|
429
|
+
* namespace. This list might include services in different clusters. In contrast,
|
|
430
|
+
* <code>ListServices</code> can only list services in one cluster at a time. If you
|
|
431
|
+
* need to filter the list of services in a single cluster by various parameters, use
|
|
432
|
+
* <code>ListServices</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
437
433
|
*/
|
|
438
434
|
listServicesByNamespace(args: ListServicesByNamespaceCommandInput, options?: __HttpHandlerOptions): Promise<ListServicesByNamespaceCommandOutput>;
|
|
439
435
|
listServicesByNamespace(args: ListServicesByNamespaceCommandInput, cb: (err: any, data?: ListServicesByNamespaceCommandOutput) => void): void;
|
|
@@ -515,8 +511,7 @@ export declare class ECS extends ECSClient {
|
|
|
515
511
|
* <p>Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist,
|
|
516
512
|
* it's created. If the attribute exists, its value is replaced with the specified value.
|
|
517
513
|
* To delete an attribute, use <a>DeleteAttributes</a>. For more information,
|
|
518
|
-
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes">Attributes</a> in the
|
|
519
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
514
|
+
* 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>
|
|
520
515
|
*/
|
|
521
516
|
putAttributes(args: PutAttributesCommandInput, options?: __HttpHandlerOptions): Promise<PutAttributesCommandOutput>;
|
|
522
517
|
putAttributes(args: PutAttributesCommandInput, cb: (err: any, data?: PutAttributesCommandOutput) => void): void;
|
|
@@ -577,8 +572,7 @@ export declare class ECS extends ECSClient {
|
|
|
577
572
|
* <p>Starts a new task using the specified task definition.</p>
|
|
578
573
|
* <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places
|
|
579
574
|
* tasks using placement constraints and placement strategies. For more information, see
|
|
580
|
-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the
|
|
581
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
575
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
582
576
|
* <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or
|
|
583
577
|
* place tasks manually on specific container instances.</p>
|
|
584
578
|
* <p>The Amazon ECS API follows an eventual consistency model. This is because of the
|
|
@@ -611,8 +605,7 @@ export declare class ECS extends ECSClient {
|
|
|
611
605
|
* <p>Starts a new task from the specified task definition on the specified container
|
|
612
606
|
* instance or instances.</p>
|
|
613
607
|
* <p>Alternatively, you can use <a>RunTask</a> to place tasks for you. For more
|
|
614
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the
|
|
615
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
608
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
616
609
|
*/
|
|
617
610
|
startTask(args: StartTaskCommandInput, options?: __HttpHandlerOptions): Promise<StartTaskCommandOutput>;
|
|
618
611
|
startTask(args: StartTaskCommandInput, cb: (err: any, data?: StartTaskCommandOutput) => void): void;
|
|
@@ -629,7 +622,7 @@ export declare class ECS extends ECSClient {
|
|
|
629
622
|
* <p>The default 30-second timeout can be configured on the Amazon ECS container agent with
|
|
630
623
|
* the <code>ECS_CONTAINER_STOP_TIMEOUT</code> variable. For more information, see
|
|
631
624
|
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html">Amazon ECS Container Agent Configuration</a> in the
|
|
632
|
-
*
|
|
625
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
633
626
|
* </note>
|
|
634
627
|
*/
|
|
635
628
|
stopTask(args: StopTaskCommandInput, options?: __HttpHandlerOptions): Promise<StopTaskCommandOutput>;
|
|
@@ -705,8 +698,7 @@ export declare class ECS extends ECSClient {
|
|
|
705
698
|
* using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent,
|
|
706
699
|
* you can update the <code>ecs-init</code> package. This updates the agent. For more
|
|
707
700
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html">Updating the
|
|
708
|
-
* Amazon ECS container agent</a> in the
|
|
709
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
701
|
+
* Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
710
702
|
* </note>
|
|
711
703
|
* <note>
|
|
712
704
|
* <p>Agent updates with the <code>UpdateContainerAgent</code> API operation do not
|
|
@@ -715,8 +707,7 @@ export declare class ECS extends ECSClient {
|
|
|
715
707
|
* </note>
|
|
716
708
|
* <p>The <code>UpdateContainerAgent</code> API requires an Amazon ECS-optimized AMI or Amazon
|
|
717
709
|
* Linux AMI with the <code>ecs-init</code> service installed and running. For help
|
|
718
|
-
* updating the Amazon ECS container agent on other operating systems, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually updating the Amazon ECS container agent</a> in the
|
|
719
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
710
|
+
* updating the Amazon ECS container agent on other operating systems, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually updating the Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
720
711
|
*/
|
|
721
712
|
updateContainerAgent(args: UpdateContainerAgentCommandInput, options?: __HttpHandlerOptions): Promise<UpdateContainerAgentCommandOutput>;
|
|
722
713
|
updateContainerAgent(args: UpdateContainerAgentCommandInput, cb: (err: any, data?: UpdateContainerAgentCommandOutput) => void): void;
|
|
@@ -886,8 +877,7 @@ export declare class ECS extends ECSClient {
|
|
|
886
877
|
* <p>You must have a service-linked role when you update any of the following service
|
|
887
878
|
* properties. If you specified a custom IAM role when you created the service, Amazon ECS
|
|
888
879
|
* automatically replaces the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Service.html#ECS-Type-Service-roleArn">roleARN</a> associated with the service with the ARN of your
|
|
889
|
-
* service-linked role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Service-linked roles</a> in the
|
|
890
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
880
|
+
* service-linked role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Service-linked roles</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
891
881
|
* <ul>
|
|
892
882
|
* <li>
|
|
893
883
|
* <p>
|
|
@@ -17,8 +17,7 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
|
|
|
17
17
|
* required resources in other Amazon Web Services services on your behalf. However, if the IAM user
|
|
18
18
|
* that makes the call doesn't have permissions to create the service-linked role, it
|
|
19
19
|
* isn't created. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using
|
|
20
|
-
* service-linked roles for Amazon ECS</a> in the
|
|
21
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
20
|
+
* service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
22
21
|
* </note>
|
|
23
22
|
* @example
|
|
24
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -15,8 +15,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
|
|
|
15
15
|
* <p>In addition to maintaining the desired count of tasks in your service, you can
|
|
16
16
|
* optionally run your service behind one or more load balancers. The load balancers
|
|
17
17
|
* distribute traffic across the tasks that are associated with the service. For more
|
|
18
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load balancing</a> in the
|
|
19
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
18
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
20
19
|
* <p>Tasks for services that don't use a load balancer are considered healthy if they're in
|
|
21
20
|
* the <code>RUNNING</code> state. Tasks for services that use a load balancer are
|
|
22
21
|
* considered healthy if they're in the <code>RUNNING</code> state and are reported as
|
|
@@ -29,8 +28,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
|
|
|
29
28
|
* maintains your desired number of tasks across your cluster. By default, the
|
|
30
29
|
* service scheduler spreads tasks across Availability Zones. You can use task
|
|
31
30
|
* placement strategies and constraints to customize task placement decisions. For
|
|
32
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the
|
|
33
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
31
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
34
32
|
* </li>
|
|
35
33
|
* <li>
|
|
36
34
|
* <p>
|
|
@@ -40,8 +38,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
|
|
|
40
38
|
* evaluates the task placement constraints for running tasks. It also stops tasks
|
|
41
39
|
* that don't meet the placement constraints. When using this strategy, you don't
|
|
42
40
|
* need to specify a desired number of tasks, a task placement strategy, or use
|
|
43
|
-
* Service Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the
|
|
44
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
41
|
+
* Service Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
45
42
|
* </li>
|
|
46
43
|
* </ul>
|
|
47
44
|
* <p>You can optionally specify a deployment configuration for your service. The deployment
|
|
@@ -85,8 +82,9 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
|
|
|
85
82
|
* <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you
|
|
86
83
|
* can specify only parameters that aren't controlled at the task set level. The only
|
|
87
84
|
* required parameter is the service name. You control your services using the <a>CreateTaskSet</a> operation. 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>
|
|
88
|
-
* <p>When the service scheduler launches new tasks, it determines task placement. For
|
|
89
|
-
* about task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS
|
|
85
|
+
* <p>When the service scheduler launches new tasks, it determines task placement. For
|
|
86
|
+
* information about task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS
|
|
87
|
+
* task placement</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
90
88
|
* @example
|
|
91
89
|
* Use a bare-bones client and the command you need to make an API call.
|
|
92
90
|
* ```javascript
|
|
@@ -10,8 +10,7 @@ export interface ListContainerInstancesCommandOutput extends ListContainerInstan
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns a list of container instances in a specified cluster. You can filter the
|
|
12
12
|
* results of a <code>ListContainerInstances</code> operation with cluster query language
|
|
13
|
-
* statements inside the <code>filter</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the
|
|
14
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
13
|
+
* statements inside the <code>filter</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
15
14
|
* @example
|
|
16
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
16
|
* ```javascript
|
|
@@ -8,11 +8,11 @@ export interface ListServicesByNamespaceCommandInput extends ListServicesByNames
|
|
|
8
8
|
export interface ListServicesByNamespaceCommandOutput extends ListServicesByNamespaceResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>This operation lists all of the services that are associated with a Cloud Map
|
|
12
|
-
* might include services in different clusters. In contrast,
|
|
13
|
-
*
|
|
14
|
-
* services in a single cluster by various parameters, use
|
|
15
|
-
*
|
|
11
|
+
* <p>This operation lists all of the services that are associated with a Cloud Map
|
|
12
|
+
* namespace. This list might include services in different clusters. In contrast,
|
|
13
|
+
* <code>ListServices</code> can only list services in one cluster at a time. If you
|
|
14
|
+
* need to filter the list of services in a single cluster by various parameters, use
|
|
15
|
+
* <code>ListServices</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
18
|
* ```javascript
|
|
@@ -11,8 +11,7 @@ export interface PutAttributesCommandOutput extends PutAttributesResponse, __Met
|
|
|
11
11
|
* <p>Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist,
|
|
12
12
|
* it's created. If the attribute exists, its value is replaced with the specified value.
|
|
13
13
|
* To delete an attribute, use <a>DeleteAttributes</a>. For more information,
|
|
14
|
-
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes">Attributes</a> in the
|
|
15
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
14
|
+
* 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>
|
|
16
15
|
* @example
|
|
17
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
17
|
* ```javascript
|
|
@@ -11,8 +11,7 @@ export interface RunTaskCommandOutput extends RunTaskResponse, __MetadataBearer
|
|
|
11
11
|
* <p>Starts a new task using the specified task definition.</p>
|
|
12
12
|
* <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places
|
|
13
13
|
* tasks using placement constraints and placement strategies. For more information, see
|
|
14
|
-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the
|
|
15
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
14
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
16
15
|
* <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or
|
|
17
16
|
* place tasks manually on specific container instances.</p>
|
|
18
17
|
* <p>The Amazon ECS API follows an eventual consistency model. This is because of the
|
|
@@ -11,8 +11,7 @@ export interface StartTaskCommandOutput extends StartTaskResponse, __MetadataBea
|
|
|
11
11
|
* <p>Starts a new task from the specified task definition on the specified container
|
|
12
12
|
* instance or instances.</p>
|
|
13
13
|
* <p>Alternatively, you can use <a>RunTask</a> to place tasks for you. For more
|
|
14
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the
|
|
15
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
14
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
16
15
|
* @example
|
|
17
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
17
|
* ```javascript
|
|
@@ -19,7 +19,7 @@ export interface StopTaskCommandOutput extends StopTaskResponse, __MetadataBeare
|
|
|
19
19
|
* <p>The default 30-second timeout can be configured on the Amazon ECS container agent with
|
|
20
20
|
* the <code>ECS_CONTAINER_STOP_TIMEOUT</code> variable. For more information, see
|
|
21
21
|
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html">Amazon ECS Container Agent Configuration</a> in the
|
|
22
|
-
*
|
|
22
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
23
23
|
* </note>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -17,8 +17,7 @@ export interface UpdateContainerAgentCommandOutput extends UpdateContainerAgentR
|
|
|
17
17
|
* using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent,
|
|
18
18
|
* you can update the <code>ecs-init</code> package. This updates the agent. For more
|
|
19
19
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html">Updating the
|
|
20
|
-
* Amazon ECS container agent</a> in the
|
|
21
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
20
|
+
* Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
22
21
|
* </note>
|
|
23
22
|
* <note>
|
|
24
23
|
* <p>Agent updates with the <code>UpdateContainerAgent</code> API operation do not
|
|
@@ -27,8 +26,7 @@ export interface UpdateContainerAgentCommandOutput extends UpdateContainerAgentR
|
|
|
27
26
|
* </note>
|
|
28
27
|
* <p>The <code>UpdateContainerAgent</code> API requires an Amazon ECS-optimized AMI or Amazon
|
|
29
28
|
* Linux AMI with the <code>ecs-init</code> service installed and running. For help
|
|
30
|
-
* updating the Amazon ECS container agent on other operating systems, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually updating the Amazon ECS container agent</a> in the
|
|
31
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
29
|
+
* updating the Amazon ECS container agent on other operating systems, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually updating the Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
32
30
|
* @example
|
|
33
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
32
|
* ```javascript
|
|
@@ -118,8 +118,7 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
|
|
|
118
118
|
* <p>You must have a service-linked role when you update any of the following service
|
|
119
119
|
* properties. If you specified a custom IAM role when you created the service, Amazon ECS
|
|
120
120
|
* automatically replaces the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Service.html#ECS-Type-Service-roleArn">roleARN</a> associated with the service with the ARN of your
|
|
121
|
-
* service-linked role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Service-linked roles</a> in the
|
|
122
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
121
|
+
* service-linked role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Service-linked roles</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
123
122
|
* <ul>
|
|
124
123
|
* <li>
|
|
125
124
|
* <p>
|
|
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
|
|
|
12
12
|
defaultSigningName: string;
|
|
13
13
|
};
|
|
14
14
|
export interface EndpointParameters extends __EndpointParameters {
|
|
15
|
-
Region
|
|
15
|
+
Region: string;
|
|
16
16
|
UseDualStack?: boolean;
|
|
17
17
|
UseFIPS?: boolean;
|
|
18
18
|
Endpoint?: string;
|
|
@@ -520,20 +520,22 @@ export interface CapacityProviderStrategyItem {
|
|
|
520
520
|
*/
|
|
521
521
|
export interface ClusterServiceConnectDefaultsRequest {
|
|
522
522
|
/**
|
|
523
|
-
* <p>The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service
|
|
524
|
-
*
|
|
525
|
-
* name is case-sensitive. The
|
|
523
|
+
* <p>The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify
|
|
524
|
+
* a Service Connect configuration. The namespace name can include up to 1024 characters.
|
|
525
|
+
* The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than
|
|
526
526
|
* (>), less than (<), or slash (/).</p>
|
|
527
|
-
* <p>If you enter an existing namespace name or ARN, then that namespace will be used.
|
|
528
|
-
* namespace type is supported. The namespace must be in this account and this Amazon Web Services
|
|
527
|
+
* <p>If you enter an existing namespace name or ARN, then that namespace will be used.
|
|
528
|
+
* Any namespace type is supported. The namespace must be in this account and this Amazon Web Services
|
|
529
|
+
* Region.</p>
|
|
529
530
|
* <p>If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a
|
|
530
531
|
* Cloud Map namespace with the "API calls" method of instance discovery only. This instance
|
|
531
|
-
* discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of
|
|
532
|
-
*
|
|
532
|
+
* discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance
|
|
533
|
+
* discovery aren't used by Service Connect.</p>
|
|
533
534
|
* <p>If you update the service with an empty string <code>""</code> for the namespace name,
|
|
534
535
|
* the cluster configuration for Service Connect is removed. Note that the namespace will
|
|
535
536
|
* remain in Cloud Map and must be deleted separately.</p>
|
|
536
|
-
* <p>For more information about Cloud Map, see <a href="https://docs.aws.amazon.com/">Working
|
|
537
|
+
* <p>For more information about Cloud Map, see <a href="https://docs.aws.amazon.com/">Working
|
|
538
|
+
* with Services</a> in the <i>Cloud Map Developer Guide</i>.</p>
|
|
537
539
|
*/
|
|
538
540
|
namespace: string | undefined;
|
|
539
541
|
}
|
|
@@ -713,8 +715,8 @@ export interface Attachment {
|
|
|
713
715
|
*/
|
|
714
716
|
export interface ClusterServiceConnectDefaults {
|
|
715
717
|
/**
|
|
716
|
-
* <p>The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service
|
|
717
|
-
*
|
|
718
|
+
* <p>The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a
|
|
719
|
+
* Service Connect configuration, this namespace is used.</p>
|
|
718
720
|
*/
|
|
719
721
|
namespace?: string;
|
|
720
722
|
}
|
|
@@ -1119,7 +1121,7 @@ export interface LoadBalancer {
|
|
|
1119
1121
|
* the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1120
1122
|
* <p>For services using the <code>CODE_DEPLOY</code> deployment controller, you're required
|
|
1121
1123
|
* 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
|
-
*
|
|
1124
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1123
1125
|
* <important>
|
|
1124
1126
|
* <p>If your service's task definition uses the <code>awsvpc</code> network mode, you
|
|
1125
1127
|
* must choose <code>ip</code> as the target type, not <code>instance</code>. Do this
|
|
@@ -1203,7 +1205,7 @@ export declare enum PlacementConstraintType {
|
|
|
1203
1205
|
/**
|
|
1204
1206
|
* <p>An object representing a constraint on task placement. For more information, see
|
|
1205
1207
|
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html">Task placement constraints</a> in the
|
|
1206
|
-
*
|
|
1208
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1207
1209
|
* <note>
|
|
1208
1210
|
* <p>If you're using the Fargate launch type, task placement constraints
|
|
1209
1211
|
* aren't supported.</p>
|
|
@@ -1220,8 +1222,7 @@ export interface PlacementConstraint {
|
|
|
1220
1222
|
/**
|
|
1221
1223
|
* <p>A cluster query language expression to apply to the constraint. The expression can
|
|
1222
1224
|
* have a maximum length of 2000 characters. You can't specify an expression if the
|
|
1223
|
-
* constraint type is <code>distinctInstance</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster query language</a> in the
|
|
1224
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1225
|
+
* constraint type is <code>distinctInstance</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster query language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1225
1226
|
*/
|
|
1226
1227
|
expression?: string;
|
|
1227
1228
|
}
|
|
@@ -1232,7 +1233,7 @@ export declare enum PlacementStrategyType {
|
|
|
1232
1233
|
}
|
|
1233
1234
|
/**
|
|
1234
1235
|
* <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
|
|
1235
|
-
*
|
|
1236
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1236
1237
|
*/
|
|
1237
1238
|
export interface PlacementStrategy {
|
|
1238
1239
|
/**
|
|
@@ -1341,7 +1342,7 @@ export interface Secret {
|
|
|
1341
1342
|
* <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment variable before
|
|
1342
1343
|
* containers placed on that instance can use these log configuration options. For
|
|
1343
1344
|
* 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
|
|
1344
|
-
*
|
|
1345
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1345
1346
|
* </li>
|
|
1346
1347
|
* <li>
|
|
1347
1348
|
* <p>For tasks that are on Fargate, because you don't have access to the
|
|
@@ -1385,8 +1386,8 @@ export interface LogConfiguration {
|
|
|
1385
1386
|
secretOptions?: Secret[];
|
|
1386
1387
|
}
|
|
1387
1388
|
/**
|
|
1388
|
-
* <p>Each alias ("endpoint") is a fully-qualified name and port number that other
|
|
1389
|
-
*
|
|
1389
|
+
* <p>Each alias ("endpoint") is a fully-qualified name and port number that other tasks
|
|
1390
|
+
* ("clients") can use to connect to this service.</p>
|
|
1390
1391
|
* <p>Each name and port mapping must be unique within the namespace.</p>
|
|
1391
1392
|
* <p>Tasks that run in a namespace can use short names to connect
|
|
1392
1393
|
* to services in the namespace. Tasks can connect to services across all of the clusters in the namespace.
|
|
@@ -1397,29 +1398,23 @@ export interface LogConfiguration {
|
|
|
1397
1398
|
*/
|
|
1398
1399
|
export interface ServiceConnectClientAlias {
|
|
1399
1400
|
/**
|
|
1400
|
-
* <p>The listening port number for the Service Connect proxy. This port is
|
|
1401
|
-
*
|
|
1402
|
-
* <p>To avoid changing your applications in client Amazon ECS services, set this
|
|
1403
|
-
*
|
|
1404
|
-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1401
|
+
* <p>The listening port number for the Service Connect proxy. This port is available
|
|
1402
|
+
* inside of all of the tasks within the same namespace.</p>
|
|
1403
|
+
* <p>To avoid changing your applications in client Amazon ECS services, set this to the same
|
|
1404
|
+
* port that the client application uses by default. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1405
1405
|
*/
|
|
1406
1406
|
port: number | undefined;
|
|
1407
1407
|
/**
|
|
1408
|
-
* <p>The <code>dnsName</code> is the name that you use in the applications
|
|
1409
|
-
*
|
|
1410
|
-
* The name
|
|
1411
|
-
*
|
|
1412
|
-
*
|
|
1413
|
-
*
|
|
1414
|
-
* <p>
|
|
1415
|
-
* the
|
|
1416
|
-
*
|
|
1417
|
-
*
|
|
1418
|
-
* <p>To avoid changing your applications in client Amazon ECS services, set this
|
|
1419
|
-
* to the same name that the client application uses by default. For example, a few common names
|
|
1420
|
-
* are <code>database</code>, <code>db</code>, or the lowercase name of a database,
|
|
1421
|
-
* such as <code>mysql</code> or <code>redis</code>.
|
|
1422
|
-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1408
|
+
* <p>The <code>dnsName</code> is the name that you use in the applications of client tasks
|
|
1409
|
+
* to connect to this service. The name must be a valid DNS name but doesn't need to be
|
|
1410
|
+
* fully-qualified. The name can include up to 127 characters. The name can include
|
|
1411
|
+
* lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name
|
|
1412
|
+
* can't start with a hyphen.</p>
|
|
1413
|
+
* <p>If this parameter isn't specified, the default value of <code>discoveryName.namespace</code> is used. If the <code>discoveryName</code> isn't specified, the port mapping name from the task definition is used in <code>portName.namespace</code>.</p>
|
|
1414
|
+
* <p>To avoid changing your applications in client Amazon ECS services, set this to the same
|
|
1415
|
+
* name that the client application uses by default. For example, a few common names are
|
|
1416
|
+
* <code>database</code>, <code>db</code>, or the lowercase name of a database, such as
|
|
1417
|
+
* <code>mysql</code> or <code>redis</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1423
1418
|
*/
|
|
1424
1419
|
dnsName?: string;
|
|
1425
1420
|
}
|
|
@@ -1428,44 +1423,45 @@ export interface ServiceConnectClientAlias {
|
|
|
1428
1423
|
*/
|
|
1429
1424
|
export interface ServiceConnectService {
|
|
1430
1425
|
/**
|
|
1431
|
-
* <p>The <code>portName</code> must match the name of one of the
|
|
1432
|
-
*
|
|
1433
|
-
* definition of this Amazon ECS service.</p>
|
|
1426
|
+
* <p>The <code>portName</code> must match the name of one of the <code>portMappings</code>
|
|
1427
|
+
* from all the containers in the task definition of this Amazon ECS service.</p>
|
|
1434
1428
|
*/
|
|
1435
1429
|
portName: string | undefined;
|
|
1436
1430
|
/**
|
|
1437
1431
|
* <p>The <code>discoveryName</code> is the name of the new Cloud Map service that Amazon ECS creates
|
|
1438
|
-
* for this Amazon ECS service. This must be unique within the Cloud Map namespace.
|
|
1439
|
-
* numbers, underscores (_), and hyphens (-).
|
|
1440
|
-
*
|
|
1432
|
+
* for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters,
|
|
1433
|
+
* numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.</p>
|
|
1434
|
+
* <p>If this parameter isn't specified, the default value of <code>discoveryName.namespace</code> is used. If the <code>discoveryName</code> isn't specified, the port mapping name from the task definition is used in <code>portName.namespace</code>.</p>
|
|
1441
1435
|
*/
|
|
1442
1436
|
discoveryName?: string;
|
|
1443
1437
|
/**
|
|
1444
1438
|
* <p>The list of client aliases for this Service Connect service. You use these to assign
|
|
1445
|
-
* names that can be used by client applications. The maximum number of client aliases
|
|
1446
|
-
*
|
|
1439
|
+
* names that can be used by client applications. The maximum number of client aliases that
|
|
1440
|
+
* you can have in this list is 1.</p>
|
|
1447
1441
|
* <p>Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS
|
|
1448
1442
|
* tasks ("clients") can use to connect to this service.</p>
|
|
1449
1443
|
* <p>Each name and port mapping must be unique within the namespace.</p>
|
|
1450
|
-
* <p>For each <code>ServiceConnectService</code>, you must provide at least one
|
|
1444
|
+
* <p>For each <code>ServiceConnectService</code>, you must provide at least one
|
|
1445
|
+
* <code>clientAlias</code> with one <code>port</code>.</p>
|
|
1451
1446
|
*/
|
|
1452
1447
|
clientAliases?: ServiceConnectClientAlias[];
|
|
1453
1448
|
/**
|
|
1454
1449
|
* <p>The port number for the Service Connect proxy to listen on.</p>
|
|
1455
1450
|
* <p>Use the value of this field to bypass the proxy for traffic on the port number
|
|
1456
|
-
* specified in the named <code>portMapping</code> in the task definition of this
|
|
1457
|
-
* then use it in your VPC security groups to allow traffic into the proxy
|
|
1458
|
-
* this Amazon ECS service.</p>
|
|
1459
|
-
* <p>In <code>awsvpc</code> mode and Fargate, the default value is the container port
|
|
1460
|
-
* <code>portMapping</code> in the task
|
|
1461
|
-
* the default value is the ephemeral port of the
|
|
1451
|
+
* specified in the named <code>portMapping</code> in the task definition of this
|
|
1452
|
+
* application, and then use it in your VPC security groups to allow traffic into the proxy
|
|
1453
|
+
* for this Amazon ECS service.</p>
|
|
1454
|
+
* <p>In <code>awsvpc</code> mode and Fargate, the default value is the container port
|
|
1455
|
+
* number. The container port number is in the <code>portMapping</code> in the task
|
|
1456
|
+
* definition. In bridge mode, the default value is the ephemeral port of the
|
|
1457
|
+
* Service Connect proxy.</p>
|
|
1462
1458
|
*/
|
|
1463
1459
|
ingressPortOverride?: number;
|
|
1464
1460
|
}
|
|
1465
1461
|
/**
|
|
1466
|
-
* <p>The Service Connect configuration of your Amazon ECS service. The configuration for
|
|
1467
|
-
*
|
|
1468
|
-
*
|
|
1462
|
+
* <p>The Service Connect configuration of your Amazon ECS service. The configuration for this
|
|
1463
|
+
* service to discover and connect to services, and be discovered by, and connected from,
|
|
1464
|
+
* other services within a namespace.</p>
|
|
1469
1465
|
* <p>Tasks that run in a namespace can use short names to connect
|
|
1470
1466
|
* to services in the namespace. Tasks can connect to services across all of the clusters in the namespace.
|
|
1471
1467
|
* Tasks connect through a managed proxy container
|
|
@@ -1479,23 +1475,23 @@ export interface ServiceConnectConfiguration {
|
|
|
1479
1475
|
*/
|
|
1480
1476
|
enabled: boolean | undefined;
|
|
1481
1477
|
/**
|
|
1482
|
-
* <p>The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The
|
|
1483
|
-
*
|
|
1484
|
-
*
|
|
1485
|
-
*
|
|
1478
|
+
* <p>The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in
|
|
1479
|
+
* the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't
|
|
1480
|
+
* affect Service Connect. For more information about Cloud Map, see <a href="https://docs.aws.amazon.com/">Working with Services</a> in the
|
|
1481
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
1486
1482
|
*/
|
|
1487
1483
|
namespace?: string;
|
|
1488
1484
|
/**
|
|
1489
|
-
* <p>The list of Service Connect service objects. These are names and aliases (also known
|
|
1490
|
-
* that are used by other Amazon ECS services to connect to this service.
|
|
1491
|
-
*
|
|
1492
|
-
* <p>This field is not required for a "client" Amazon ECS service that's a member of a
|
|
1493
|
-
*
|
|
1494
|
-
*
|
|
1495
|
-
*
|
|
1496
|
-
* <p>An object selects a port from the task definition, assigns a name for the
|
|
1497
|
-
*
|
|
1498
|
-
*
|
|
1485
|
+
* <p>The list of Service Connect service objects. These are names and aliases (also known
|
|
1486
|
+
* as endpoints) that are used by other Amazon ECS services to connect to this service.
|
|
1487
|
+
* </p>
|
|
1488
|
+
* <p>This field is not required for a "client" Amazon ECS service that's a member of a namespace
|
|
1489
|
+
* only to connect to other services within the namespace. An example of this would be a
|
|
1490
|
+
* frontend application that accepts incoming requests from either a load balancer that's
|
|
1491
|
+
* attached to the service or by other means.</p>
|
|
1492
|
+
* <p>An object selects a port from the task definition, assigns a name for the Cloud Map
|
|
1493
|
+
* service, and a list of aliases (endpoints) and ports for client applications to refer to
|
|
1494
|
+
* this service.</p>
|
|
1499
1495
|
*/
|
|
1500
1496
|
services?: ServiceConnectService[];
|
|
1501
1497
|
/**
|
|
@@ -1528,7 +1524,7 @@ export interface ServiceConnectConfiguration {
|
|
|
1528
1524
|
* <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment variable before
|
|
1529
1525
|
* containers placed on that instance can use these log configuration options. For
|
|
1530
1526
|
* 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
|
|
1531
|
-
*
|
|
1527
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1532
1528
|
* </li>
|
|
1533
1529
|
* <li>
|
|
1534
1530
|
* <p>For tasks that are on Fargate, because you don't have access to the
|
|
@@ -1605,13 +1601,12 @@ export interface CreateServiceRequest {
|
|
|
1605
1601
|
taskDefinition?: string;
|
|
1606
1602
|
/**
|
|
1607
1603
|
* <p>A load balancer object representing the load balancers to use with your service. For
|
|
1608
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load balancing</a> in the
|
|
1609
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1604
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1610
1605
|
* <p>If the service uses the rolling update (<code>ECS</code>) deployment controller and
|
|
1611
1606
|
* using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach
|
|
1612
1607
|
* to the service. The service-linked role is required for services that use multiple
|
|
1613
1608
|
* 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
|
|
1614
|
-
*
|
|
1609
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1615
1610
|
* <p>If the service uses the <code>CODE_DEPLOY</code> deployment controller, the service is
|
|
1616
1611
|
* required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you
|
|
1617
1612
|
* specify two target groups (referred to as a <code>targetGroupPair</code>). During a
|
|
@@ -1714,8 +1709,7 @@ export interface CreateServiceRequest {
|
|
|
1714
1709
|
* service is configured to use service discovery, an external deployment controller,
|
|
1715
1710
|
* multiple target groups, or Elastic Inference accelerators in which case you don't
|
|
1716
1711
|
* specify a role here. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using
|
|
1717
|
-
* service-linked roles for Amazon ECS</a> in the
|
|
1718
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1712
|
+
* service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1719
1713
|
* </important>
|
|
1720
1714
|
* <p>If your specified role has a path other than <code>/</code>, then you must either
|
|
1721
1715
|
* specify the full role ARN (this is recommended) or prefix the role name with the path.
|
|
@@ -1754,8 +1748,8 @@ export interface CreateServiceRequest {
|
|
|
1754
1748
|
* service is configured to use a load balancer. If your service has a load balancer
|
|
1755
1749
|
* defined and you don't specify a health check grace period value, the default value of
|
|
1756
1750
|
* <code>0</code> is used.</p>
|
|
1757
|
-
* <p>If you do not use an Elastic Load Balancing, we recommend that you use the <code>startPeriod</code> in
|
|
1758
|
-
* task definition health check parameters. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html">Health
|
|
1751
|
+
* <p>If you do not use an Elastic Load Balancing, we recommend that you use the <code>startPeriod</code> in
|
|
1752
|
+
* the task definition health check parameters. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html">Health
|
|
1759
1753
|
* check</a>.</p>
|
|
1760
1754
|
* <p>If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you
|
|
1761
1755
|
* can specify a health check grace period of up to
|
|
@@ -1875,28 +1869,27 @@ export declare enum DeploymentRolloutState {
|
|
|
1875
1869
|
IN_PROGRESS = "IN_PROGRESS"
|
|
1876
1870
|
}
|
|
1877
1871
|
/**
|
|
1878
|
-
* <p>The Service Connect resource. Each configuration maps a discovery name to a
|
|
1879
|
-
* The data is stored in Cloud Map as part of the
|
|
1880
|
-
* for each discovery name of this Amazon ECS service.</p>
|
|
1881
|
-
* <p>A task can resolve the <code>dnsName</code> for each of the
|
|
1882
|
-
*
|
|
1883
|
-
*
|
|
1884
|
-
* <code>
|
|
1885
|
-
* that service for the list of <code>clientAliases</code> that you can use.</p>
|
|
1872
|
+
* <p>The Service Connect resource. Each configuration maps a discovery name to a
|
|
1873
|
+
* Cloud Map service name. The data is stored in Cloud Map as part of the
|
|
1874
|
+
* Service Connect configuration for each discovery name of this Amazon ECS service.</p>
|
|
1875
|
+
* <p>A task can resolve the <code>dnsName</code> for each of the <code>clientAliases</code>
|
|
1876
|
+
* of a service. However a task can't resolve the discovery names. If you want to connect
|
|
1877
|
+
* to a service, refer to the <code>ServiceConnectConfiguration</code> of that service for
|
|
1878
|
+
* the list of <code>clientAliases</code> that you can use.</p>
|
|
1886
1879
|
*/
|
|
1887
1880
|
export interface ServiceConnectServiceResource {
|
|
1888
1881
|
/**
|
|
1889
1882
|
* <p>The discovery name of this Service Connect resource.</p>
|
|
1890
1883
|
* <p>The <code>discoveryName</code> is the name of the new Cloud Map service that Amazon ECS creates
|
|
1891
|
-
* for this Amazon ECS service. This must be unique within the Cloud Map namespace.
|
|
1892
|
-
* numbers, underscores (_), and hyphens (-).
|
|
1893
|
-
*
|
|
1884
|
+
* for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters,
|
|
1885
|
+
* numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.</p>
|
|
1886
|
+
* <p>If this parameter isn't specified, the default value of <code>discoveryName.namespace</code> is used. If the <code>discoveryName</code> isn't specified, the port mapping name from the task definition is used in <code>portName.namespace</code>.</p>
|
|
1894
1887
|
*/
|
|
1895
1888
|
discoveryName?: string;
|
|
1896
1889
|
/**
|
|
1897
|
-
* <p>The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name
|
|
1898
|
-
*
|
|
1899
|
-
*
|
|
1890
|
+
* <p>The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this
|
|
1891
|
+
* Service Connect resource. You can use this ARN in other integrations with Cloud Map.
|
|
1892
|
+
* However, Service Connect can't ensure connectivity outside of Amazon ECS.</p>
|
|
1900
1893
|
*/
|
|
1901
1894
|
discoveryArn?: string;
|
|
1902
1895
|
}
|
|
@@ -1979,8 +1972,7 @@ export interface Deployment {
|
|
|
1979
1972
|
/**
|
|
1980
1973
|
* <p>The platform version that your tasks in the service run on. A platform version is only
|
|
1981
1974
|
* specified for tasks using the Fargate launch type. If one isn't specified,
|
|
1982
|
-
* 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
|
|
1983
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1975
|
+
* 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 <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
1984
1976
|
*/
|
|
1985
1977
|
platformVersion?: string;
|
|
1986
1978
|
/**
|
|
@@ -2015,9 +2007,9 @@ export interface Deployment {
|
|
|
2015
2007
|
*/
|
|
2016
2008
|
rolloutStateReason?: string;
|
|
2017
2009
|
/**
|
|
2018
|
-
* <p>The details of the Service Connect configuration that's used by this deployment.
|
|
2019
|
-
* configuration between multiple deployments when troubleshooting issues with
|
|
2020
|
-
* deployments.</p>
|
|
2010
|
+
* <p>The details of the Service Connect configuration that's used by this deployment.
|
|
2011
|
+
* Compare the configuration between multiple deployments when troubleshooting issues with
|
|
2012
|
+
* new deployments.</p>
|
|
2021
2013
|
* <p>The configuration for this service to discover and connect to
|
|
2022
2014
|
* services, and be discovered by, and connected from, other services within a namespace.</p>
|
|
2023
2015
|
* <p>Tasks that run in a namespace can use short names to connect
|
|
@@ -2029,8 +2021,8 @@ export interface Deployment {
|
|
|
2029
2021
|
*/
|
|
2030
2022
|
serviceConnectConfiguration?: ServiceConnectConfiguration;
|
|
2031
2023
|
/**
|
|
2032
|
-
* <p>The list of Service Connect resources that are associated with this deployment.
|
|
2033
|
-
*
|
|
2024
|
+
* <p>The list of Service Connect resources that are associated with this deployment. Each
|
|
2025
|
+
* list entry maps a discovery name to a Cloud Map service name.</p>
|
|
2034
2026
|
*/
|
|
2035
2027
|
serviceConnectResources?: ServiceConnectServiceResource[];
|
|
2036
2028
|
}
|
|
@@ -2174,8 +2166,7 @@ export interface TaskSet {
|
|
|
2174
2166
|
capacityProviderStrategy?: CapacityProviderStrategyItem[];
|
|
2175
2167
|
/**
|
|
2176
2168
|
* <p>The Fargate platform version where the tasks in the task set are running. A platform
|
|
2177
|
-
* 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
|
|
2178
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2169
|
+
* 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 <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2179
2170
|
*/
|
|
2180
2171
|
platformVersion?: string;
|
|
2181
2172
|
/**
|
|
@@ -3135,7 +3126,7 @@ export interface ContainerInstance {
|
|
|
3135
3126
|
* The <code>DRAINING</code> indicates that new tasks aren't placed on the container
|
|
3136
3127
|
* instance and any service tasks running on the container instance are removed if
|
|
3137
3128
|
* 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
|
|
3138
|
-
*
|
|
3129
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
3139
3130
|
*/
|
|
3140
3131
|
status?: string;
|
|
3141
3132
|
/**
|
|
@@ -3252,11 +3243,12 @@ export declare enum ContainerCondition {
|
|
|
3252
3243
|
* to use container dependencies. However, we recommend using the latest container agent
|
|
3253
3244
|
* version. For information about checking your agent version and updating to the latest
|
|
3254
3245
|
* version, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html">Updating the Amazon ECS
|
|
3255
|
-
* Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using
|
|
3256
|
-
*
|
|
3257
|
-
*
|
|
3258
|
-
*
|
|
3259
|
-
*
|
|
3246
|
+
* Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using an Amazon ECS-optimized Linux AMI,
|
|
3247
|
+
* your instance needs at least version 1.26.0-1 of the <code>ecs-init</code> package. If
|
|
3248
|
+
* your container instances are launched from version <code>20190301</code> or later, then
|
|
3249
|
+
* they contain the required versions of the container agent and <code>ecs-init</code>. For
|
|
3250
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html">Amazon ECS-optimized Linux AMI</a>
|
|
3251
|
+
* in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
3260
3252
|
* <note>
|
|
3261
3253
|
* <p>For tasks that use the Fargate launch type, the task or service
|
|
3262
3254
|
* requires the following platforms:</p>
|
|
@@ -3386,7 +3378,7 @@ export interface FirelensConfiguration {
|
|
|
3386
3378
|
* <code>"options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}</code>.
|
|
3387
3379
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef">Creating
|
|
3388
3380
|
* a task definition that uses a FireLens configuration</a> in the
|
|
3389
|
-
*
|
|
3381
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
3390
3382
|
* <note>
|
|
3391
3383
|
* <p>Tasks hosted on Fargate only support the <code>file</code> configuration file
|
|
3392
3384
|
* type.</p>
|
|
@@ -3793,21 +3785,22 @@ export interface PortMapping {
|
|
|
3793
3785
|
*/
|
|
3794
3786
|
protocol?: TransportProtocol | string;
|
|
3795
3787
|
/**
|
|
3796
|
-
* <p>The name that's used for the port mapping. This parameter only applies to
|
|
3797
|
-
* This parameter is the name that you use in the
|
|
3798
|
-
*
|
|
3799
|
-
* numbers, underscores (_), and
|
|
3800
|
-
*
|
|
3788
|
+
* <p>The name that's used for the port mapping. This parameter only applies to
|
|
3789
|
+
* Service Connect. This parameter is the name that you use in the
|
|
3790
|
+
* <code>serviceConnectConfiguration</code> of a service. The name can include up to 64
|
|
3791
|
+
* characters. The characters can include lowercase letters, numbers, underscores (_), and
|
|
3792
|
+
* hyphens (-). The name can't start with a hyphen.</p>
|
|
3793
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
3801
3794
|
*/
|
|
3802
3795
|
name?: string;
|
|
3803
3796
|
/**
|
|
3804
3797
|
* <p>The application protocol that's used for the port mapping. This parameter only applies
|
|
3805
|
-
* to Service Connect. We recommend that you set this parameter to be consistent with
|
|
3806
|
-
*
|
|
3807
|
-
*
|
|
3808
|
-
*
|
|
3809
|
-
*
|
|
3810
|
-
*
|
|
3798
|
+
* to Service Connect. We recommend that you set this parameter to be consistent with the
|
|
3799
|
+
* protocol that your application uses. If you set this parameter, Amazon ECS adds
|
|
3800
|
+
* protocol-specific connection handling to the Service Connect proxy. If you set this
|
|
3801
|
+
* parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.</p>
|
|
3802
|
+
* <p>If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't
|
|
3803
|
+
* add protocol-specific telemetry for TCP.</p>
|
|
3811
3804
|
* <p>Tasks that run in a namespace can use short names to connect
|
|
3812
3805
|
* to services in the namespace. Tasks can connect to services across all of the clusters in the namespace.
|
|
3813
3806
|
* Tasks connect through a managed proxy container
|
|
@@ -3841,8 +3834,7 @@ export declare enum ResourceType {
|
|
|
3841
3834
|
* <p>The type and amount of a resource to assign to a container. The supported resource
|
|
3842
3835
|
* 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
|
|
3843
3836
|
* GPUs on Amazon ECS</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html">Working with
|
|
3844
|
-
* Amazon Elastic Inference on Amazon ECS</a> in the
|
|
3845
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>
|
|
3837
|
+
* Amazon Elastic Inference on Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>
|
|
3846
3838
|
* </p>
|
|
3847
3839
|
*/
|
|
3848
3840
|
export interface ResourceRequirement {
|
|
@@ -4256,11 +4248,12 @@ export interface ContainerDefinition {
|
|
|
4256
4248
|
* least version 1.26.0 of the container agent to turn on container dependencies. However,
|
|
4257
4249
|
* we recommend using the latest container agent version. For information about checking
|
|
4258
4250
|
* 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
|
|
4259
|
-
* Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using
|
|
4260
|
-
*
|
|
4261
|
-
*
|
|
4262
|
-
*
|
|
4263
|
-
*
|
|
4251
|
+
* Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using an Amazon ECS-optimized Linux AMI,
|
|
4252
|
+
* your instance needs at least version 1.26.0-1 of the <code>ecs-init</code> package. If
|
|
4253
|
+
* your container instances are launched from version <code>20190301</code> or later, then
|
|
4254
|
+
* they contain the required versions of the container agent and <code>ecs-init</code>. For
|
|
4255
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html">Amazon ECS-optimized Linux AMI</a>
|
|
4256
|
+
* in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4264
4257
|
* <p>For tasks using the Fargate launch type, the task or service requires
|
|
4265
4258
|
* the following platforms:</p>
|
|
4266
4259
|
* <ul>
|
|
@@ -4300,11 +4293,12 @@ export interface ContainerDefinition {
|
|
|
4300
4293
|
* timeout value. However, we recommend using the latest container agent version. For
|
|
4301
4294
|
* information about checking your agent version and updating to the latest version, see
|
|
4302
4295
|
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html">Updating the Amazon ECS
|
|
4303
|
-
* Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using
|
|
4304
|
-
*
|
|
4305
|
-
*
|
|
4306
|
-
*
|
|
4307
|
-
*
|
|
4296
|
+
* Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using an Amazon ECS-optimized Linux AMI,
|
|
4297
|
+
* your instance needs at least version <code>1.26.0-1</code> of the <code>ecs-init</code>
|
|
4298
|
+
* package. If your container instances are launched from version <code>20190301</code> or
|
|
4299
|
+
* later, then they contain the required versions of the container agent and
|
|
4300
|
+
* <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>
|
|
4301
|
+
* in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4308
4302
|
*/
|
|
4309
4303
|
startTimeout?: number;
|
|
4310
4304
|
/**
|
|
@@ -4330,13 +4324,11 @@ export interface ContainerDefinition {
|
|
|
4330
4324
|
* containers and 30 seconds on Windows containers are used. Your container instances
|
|
4331
4325
|
* require at least version 1.26.0 of the container agent to use a container stop timeout
|
|
4332
4326
|
* value. However, we recommend using the latest container agent version. For information
|
|
4333
|
-
* 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
|
|
4334
|
-
*
|
|
4335
|
-
*
|
|
4336
|
-
*
|
|
4337
|
-
*
|
|
4338
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html">Amazon ECS-optimized Linux AMI</a>
|
|
4339
|
-
* in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4327
|
+
* 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 <i>Amazon Elastic Container Service Developer Guide</i>. If you're using
|
|
4328
|
+
* an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
|
|
4329
|
+
* <code>ecs-init</code> package. If your container instances are launched from version
|
|
4330
|
+
* <code>20190301</code> or later, then they contain the required versions of the
|
|
4331
|
+
* 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>
|
|
4340
4332
|
*/
|
|
4341
4333
|
stopTimeout?: number;
|
|
4342
4334
|
/**
|
|
@@ -4511,10 +4503,10 @@ export interface ContainerDefinition {
|
|
|
4511
4503
|
*/
|
|
4512
4504
|
dockerLabels?: Record<string, string>;
|
|
4513
4505
|
/**
|
|
4514
|
-
* <p>A list of <code>ulimits</code> to set in the container. If a <code>ulimit</code> value
|
|
4515
|
-
* in a task definition, it overrides the default values set by Docker. This
|
|
4516
|
-
* to <code>Ulimits</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section
|
|
4517
|
-
* <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
|
|
4506
|
+
* <p>A list of <code>ulimits</code> to set in the container. If a <code>ulimit</code> value
|
|
4507
|
+
* is specified in a task definition, it overrides the default values set by Docker. This
|
|
4508
|
+
* parameter maps to <code>Ulimits</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section
|
|
4509
|
+
* of the <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
|
|
4518
4510
|
* in the <a>Ulimit</a> data type.</p>
|
|
4519
4511
|
* <p>Amazon ECS tasks hosted on Fargate use the default
|
|
4520
4512
|
* resource limit values set by the operating system with the exception of
|
|
@@ -4650,7 +4642,7 @@ export declare enum TaskDefinitionPlacementConstraintType {
|
|
|
4650
4642
|
/**
|
|
4651
4643
|
* <p>An object representing a constraint on task placement in the task definition. For more
|
|
4652
4644
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html">Task placement constraints</a> in the
|
|
4653
|
-
*
|
|
4645
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4654
4646
|
* <note>
|
|
4655
4647
|
* <p>Task placement constraints aren't supported for tasks run on Fargate.</p>
|
|
4656
4648
|
* </note>
|
|
@@ -4663,8 +4655,7 @@ export interface TaskDefinitionPlacementConstraint {
|
|
|
4663
4655
|
type?: TaskDefinitionPlacementConstraintType | string;
|
|
4664
4656
|
/**
|
|
4665
4657
|
* <p>A cluster query language expression to apply to the constraint. For more information,
|
|
4666
|
-
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster query language</a> in the
|
|
4667
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4658
|
+
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster query language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4668
4659
|
*/
|
|
4669
4660
|
expression?: string;
|
|
4670
4661
|
}
|
|
@@ -4861,7 +4852,7 @@ export declare enum EFSTransitEncryption {
|
|
|
4861
4852
|
/**
|
|
4862
4853
|
* <p>This parameter is specified when you're using an Amazon Elastic File System file system for task
|
|
4863
4854
|
* storage. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html">Amazon EFS volumes</a> in the
|
|
4864
|
-
*
|
|
4855
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4865
4856
|
*/
|
|
4866
4857
|
export interface EFSVolumeConfiguration {
|
|
4867
4858
|
/**
|
|
@@ -4958,9 +4949,10 @@ export interface HostVolumeProperties {
|
|
|
4958
4949
|
sourcePath?: string;
|
|
4959
4950
|
}
|
|
4960
4951
|
/**
|
|
4961
|
-
* <p>A data volume that's used in a task definition. For tasks that use the Amazon Elastic File System
|
|
4962
|
-
*
|
|
4963
|
-
*
|
|
4952
|
+
* <p>A data volume that's used in a task definition. For tasks that use the Amazon Elastic File System
|
|
4953
|
+
* (Amazon EFS), specify an <code>efsVolumeConfiguration</code>. For Windows tasks that use
|
|
4954
|
+
* Amazon FSx for Windows File Server file system, specify a
|
|
4955
|
+
* <code>fsxWindowsFileServerVolumeConfiguration</code>. For tasks that use a Docker
|
|
4964
4956
|
* volume, specify a <code>DockerVolumeConfiguration</code>. For tasks that use a bind
|
|
4965
4957
|
* mount host volume, specify a <code>host</code> and optional <code>sourcePath</code>. For
|
|
4966
4958
|
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html">Using Data Volumes in
|
|
@@ -5091,8 +5083,7 @@ export interface TaskDefinition {
|
|
|
5091
5083
|
*/
|
|
5092
5084
|
revision?: number;
|
|
5093
5085
|
/**
|
|
5094
|
-
* <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
|
|
5095
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
5086
|
+
* <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 <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
5096
5087
|
* <note>
|
|
5097
5088
|
* <p>The <code>host</code> and <code>sourcePath</code> parameters aren't supported for
|
|
5098
5089
|
* tasks run on Fargate. </p>
|
|
@@ -5783,8 +5774,7 @@ export interface ContainerOverride {
|
|
|
5783
5774
|
* <p>Details on an Elastic Inference accelerator task override. This parameter is used to
|
|
5784
5775
|
* override the Elastic Inference accelerator specified in the task definition. For more
|
|
5785
5776
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html">Working with Amazon
|
|
5786
|
-
* Elastic Inference on Amazon ECS</a> in the
|
|
5787
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
5777
|
+
* Elastic Inference on Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
5788
5778
|
*/
|
|
5789
5779
|
export interface InferenceAcceleratorOverride {
|
|
5790
5780
|
/**
|
|
@@ -6041,8 +6031,7 @@ export interface Task {
|
|
|
6041
6031
|
/**
|
|
6042
6032
|
* <p>The platform version where your task runs on. A platform version is only specified for
|
|
6043
6033
|
* tasks that use the Fargate launch type. If you didn't specify one, the
|
|
6044
|
-
* <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
|
|
6045
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
6034
|
+
* <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 <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
6046
6035
|
*/
|
|
6047
6036
|
platformVersion?: string;
|
|
6048
6037
|
/**
|
|
@@ -6252,7 +6241,8 @@ export interface DiscoverPollEndpointResponse {
|
|
|
6252
6241
|
*/
|
|
6253
6242
|
telemetryEndpoint?: string;
|
|
6254
6243
|
/**
|
|
6255
|
-
* <p>The endpoint for the Amazon ECS agent to poll for Service Connect configuration.
|
|
6244
|
+
* <p>The endpoint for the Amazon ECS agent to poll for Service Connect configuration.
|
|
6245
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
6256
6246
|
*/
|
|
6257
6247
|
serviceConnectEndpoint?: string;
|
|
6258
6248
|
}
|
|
@@ -6599,8 +6589,7 @@ export interface ListContainerInstancesRequest {
|
|
|
6599
6589
|
cluster?: string;
|
|
6600
6590
|
/**
|
|
6601
6591
|
* <p>You can filter the results of a <code>ListContainerInstances</code> operation with
|
|
6602
|
-
* cluster query language statements. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the
|
|
6603
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
6592
|
+
* cluster query language statements. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
6604
6593
|
*/
|
|
6605
6594
|
filter?: string;
|
|
6606
6595
|
/**
|
|
@@ -6717,22 +6706,25 @@ export interface ListServicesByNamespaceRequest {
|
|
|
6717
6706
|
*/
|
|
6718
6707
|
namespace: string | undefined;
|
|
6719
6708
|
/**
|
|
6720
|
-
* <p>The <code>nextToken</code> value that's returned from a
|
|
6721
|
-
*
|
|
6722
|
-
*
|
|
6723
|
-
*
|
|
6709
|
+
* <p>The <code>nextToken</code> value that's returned from a
|
|
6710
|
+
* <code>ListServicesByNamespace</code> request. It indicates that more results are
|
|
6711
|
+
* available to fulfill the request and further calls are needed. If
|
|
6712
|
+
* <code>maxResults</code> is returned, it is possible the number of results is less
|
|
6713
|
+
* than <code>maxResults</code>.</p>
|
|
6724
6714
|
*/
|
|
6725
6715
|
nextToken?: string;
|
|
6726
6716
|
/**
|
|
6727
|
-
* <p>The maximum number of service results that <code>ListServicesByNamespace</code>
|
|
6728
|
-
* paginated output. When this parameter is used,
|
|
6729
|
-
*
|
|
6730
|
-
*
|
|
6731
|
-
*
|
|
6732
|
-
*
|
|
6733
|
-
*
|
|
6734
|
-
*
|
|
6735
|
-
*
|
|
6717
|
+
* <p>The maximum number of service results that <code>ListServicesByNamespace</code>
|
|
6718
|
+
* returns in paginated output. When this parameter is used,
|
|
6719
|
+
* <code>ListServicesByNamespace</code> only returns <code>maxResults</code> results in
|
|
6720
|
+
* a single page along with a <code>nextToken</code> response element. The remaining
|
|
6721
|
+
* results of the initial request can be seen by sending another
|
|
6722
|
+
* <code>ListServicesByNamespace</code> request with the returned
|
|
6723
|
+
* <code>nextToken</code> value. This value can be between 1 and
|
|
6724
|
+
* 100. If this parameter isn't used, then
|
|
6725
|
+
* <code>ListServicesByNamespace</code> returns up to
|
|
6726
|
+
* 10 results and a <code>nextToken</code>
|
|
6727
|
+
* value if applicable.</p>
|
|
6736
6728
|
*/
|
|
6737
6729
|
maxResults?: number;
|
|
6738
6730
|
}
|
|
@@ -6743,11 +6735,11 @@ export interface ListServicesByNamespaceResponse {
|
|
|
6743
6735
|
*/
|
|
6744
6736
|
serviceArns?: string[];
|
|
6745
6737
|
/**
|
|
6746
|
-
* <p>The <code>nextToken</code> value to include in a future
|
|
6747
|
-
*
|
|
6748
|
-
*
|
|
6749
|
-
* results. When there are no more results
|
|
6750
|
-
* return, this value is <code>null</code>.</p>
|
|
6738
|
+
* <p>The <code>nextToken</code> value to include in a future
|
|
6739
|
+
* <code>ListServicesByNamespace</code> request. When the results of a
|
|
6740
|
+
* <code>ListServicesByNamespace</code> request exceed <code>maxResults</code>, this
|
|
6741
|
+
* value can be used to retrieve the next page of results. When there are no more results
|
|
6742
|
+
* to return, this value is <code>null</code>.</p>
|
|
6751
6743
|
*/
|
|
6752
6744
|
nextToken?: string;
|
|
6753
6745
|
}
|
|
@@ -7513,8 +7505,7 @@ export interface RegisterTaskDefinitionRequest {
|
|
|
7513
7505
|
* <code>1.26.0-1</code> of the <code>ecs-init</code> package to use a proxy
|
|
7514
7506
|
* configuration. If your container instances are launched from the Amazon ECS-optimized
|
|
7515
7507
|
* AMI version <code>20190301</code> or later, then they contain the required versions of
|
|
7516
|
-
* the container agent and <code>ecs-init</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-ami-versions.html">Amazon ECS-optimized AMI versions</a> in the
|
|
7517
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
7508
|
+
* the container agent and <code>ecs-init</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-ami-versions.html">Amazon ECS-optimized AMI versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
7518
7509
|
*/
|
|
7519
7510
|
proxyConfiguration?: ProxyConfiguration;
|
|
7520
7511
|
/**
|
|
@@ -7775,7 +7766,7 @@ export interface StartTaskRequest {
|
|
|
7775
7766
|
containerInstances: string[] | undefined;
|
|
7776
7767
|
/**
|
|
7777
7768
|
* <p>Specifies whether to use Amazon ECS managed tags for the task. For more information, see
|
|
7778
|
-
*
|
|
7769
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your Amazon ECS
|
|
7779
7770
|
* Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
7780
7771
|
*/
|
|
7781
7772
|
enableECSManagedTags?: boolean;
|
|
@@ -8448,14 +8439,12 @@ export interface UpdateServiceRequest {
|
|
|
8448
8439
|
* <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html">CreateDeployment</a>
|
|
8449
8440
|
* </code> through CodeDeploy. Note that multiple target groups
|
|
8450
8441
|
* 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
|
|
8451
|
-
* multiple target groups with a service</a> in the
|
|
8452
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>. </p>
|
|
8442
|
+
* multiple target groups with a service</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. </p>
|
|
8453
8443
|
* <p>For services that use the external deployment controller, you can add, update, or
|
|
8454
8444
|
* remove load balancers by using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>.
|
|
8455
8445
|
* Note that multiple target groups are not supported for external deployments. For more
|
|
8456
8446
|
* information see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html">Register
|
|
8457
|
-
* multiple target groups with a service</a> in the
|
|
8458
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>. </p>
|
|
8447
|
+
* multiple target groups with a service</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. </p>
|
|
8459
8448
|
* <p>You can remove existing <code>loadBalancers</code> by passing an empty list.</p>
|
|
8460
8449
|
*/
|
|
8461
8450
|
loadBalancers?: LoadBalancer[];
|
|
@@ -27,7 +27,7 @@ export declare const resolveClientEndpointParameters: <T>(
|
|
|
27
27
|
defaultSigningName: string;
|
|
28
28
|
};
|
|
29
29
|
export interface EndpointParameters extends __EndpointParameters {
|
|
30
|
-
Region
|
|
30
|
+
Region: string;
|
|
31
31
|
UseDualStack?: boolean;
|
|
32
32
|
UseFIPS?: boolean;
|
|
33
33
|
Endpoint?: string;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-ecs",
|
|
3
3
|
"description": "AWS SDK for JavaScript Ecs Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.223.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -19,9 +19,9 @@
|
|
|
19
19
|
"dependencies": {
|
|
20
20
|
"@aws-crypto/sha256-browser": "2.0.0",
|
|
21
21
|
"@aws-crypto/sha256-js": "2.0.0",
|
|
22
|
-
"@aws-sdk/client-sts": "3.
|
|
22
|
+
"@aws-sdk/client-sts": "3.223.0",
|
|
23
23
|
"@aws-sdk/config-resolver": "3.222.0",
|
|
24
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/credential-provider-node": "3.223.0",
|
|
25
25
|
"@aws-sdk/fetch-http-handler": "3.222.0",
|
|
26
26
|
"@aws-sdk/hash-node": "3.222.0",
|
|
27
27
|
"@aws-sdk/invalid-dependency": "3.222.0",
|
|
@@ -47,7 +47,6 @@
|
|
|
47
47
|
"@aws-sdk/util-defaults-mode-browser": "3.222.0",
|
|
48
48
|
"@aws-sdk/util-defaults-mode-node": "3.222.0",
|
|
49
49
|
"@aws-sdk/util-endpoints": "3.222.0",
|
|
50
|
-
"@aws-sdk/util-retry": "3.222.0",
|
|
51
50
|
"@aws-sdk/util-user-agent-browser": "3.222.0",
|
|
52
51
|
"@aws-sdk/util-user-agent-node": "3.222.0",
|
|
53
52
|
"@aws-sdk/util-utf8-browser": "3.188.0",
|