@aws-sdk/client-ecs 3.994.0 → 3.995.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/README.md +1 -15
- package/dist-cjs/index.js +164 -164
- package/dist-cjs/models/errors.js +86 -86
- package/dist-cjs/schemas/schemas_0.js +5 -5
- package/dist-es/models/enums.js +156 -156
- package/dist-es/models/errors.js +68 -68
- package/dist-es/schemas/schemas_0.js +5 -5
- package/dist-es/waiters/waitForServicesInactive.js +2 -2
- package/dist-es/waiters/waitForServicesStable.js +2 -2
- package/dist-es/waiters/waitForTasksRunning.js +2 -2
- package/dist-es/waiters/waitForTasksStopped.js +2 -2
- package/dist-types/ECS.d.ts +1 -15
- package/dist-types/ECSClient.d.ts +1 -15
- package/dist-types/commands/CreateCapacityProviderCommand.d.ts +4 -16
- package/dist-types/commands/CreateClusterCommand.d.ts +3 -20
- package/dist-types/commands/CreateExpressGatewayServiceCommand.d.ts +4 -18
- package/dist-types/commands/CreateServiceCommand.d.ts +4 -236
- package/dist-types/commands/CreateTaskSetCommand.d.ts +6 -25
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +12 -18
- package/dist-types/commands/DeleteAttributesCommand.d.ts +2 -7
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +3 -21
- package/dist-types/commands/DeleteClusterCommand.d.ts +7 -30
- package/dist-types/commands/DeleteExpressGatewayServiceCommand.d.ts +5 -19
- package/dist-types/commands/DeleteServiceCommand.d.ts +4 -30
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +3 -27
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +6 -16
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +3 -21
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +3 -25
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +34 -39
- package/dist-types/commands/DescribeClustersCommand.d.ts +3 -10
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +3 -9
- package/dist-types/commands/DescribeExpressGatewayServiceCommand.d.ts +3 -14
- package/dist-types/commands/DescribeServiceDeploymentsCommand.d.ts +44 -13
- package/dist-types/commands/DescribeServiceRevisionsCommand.d.ts +44 -14
- package/dist-types/commands/DescribeServicesCommand.d.ts +2 -7
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +3 -15
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +5 -16
- package/dist-types/commands/DescribeTasksCommand.d.ts +3 -12
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +2 -8
- package/dist-types/commands/ExecuteCommandCommand.d.ts +4 -32
- package/dist-types/commands/GetTaskProtectionCommand.d.ts +2 -7
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +9 -14
- package/dist-types/commands/ListAttributesCommand.d.ts +2 -11
- package/dist-types/commands/ListClustersCommand.d.ts +2 -7
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +3 -11
- package/dist-types/commands/ListServiceDeploymentsCommand.d.ts +4 -15
- package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +3 -13
- package/dist-types/commands/ListServicesCommand.d.ts +3 -9
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -7
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +13 -24
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +13 -20
- package/dist-types/commands/ListTasksCommand.d.ts +14 -23
- package/dist-types/commands/PutAccountSettingCommand.d.ts +12 -22
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +3 -9
- package/dist-types/commands/PutAttributesCommand.d.ts +4 -14
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +4 -29
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +3 -13
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +3 -26
- package/dist-types/commands/RunTaskCommand.d.ts +6 -75
- package/dist-types/commands/StartTaskCommand.d.ts +3 -23
- package/dist-types/commands/StopServiceDeploymentCommand.d.ts +5 -25
- package/dist-types/commands/StopTaskCommand.d.ts +3 -25
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +3 -12
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +2 -8
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +3 -12
- package/dist-types/commands/TagResourceCommand.d.ts +3 -11
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -7
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +3 -10
- package/dist-types/commands/UpdateClusterCommand.d.ts +2 -7
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +2 -7
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +6 -41
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +3 -56
- package/dist-types/commands/UpdateExpressGatewayServiceCommand.d.ts +5 -19
- package/dist-types/commands/UpdateServiceCommand.d.ts +14 -146
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +6 -19
- package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +15 -47
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +6 -17
- package/dist-types/index.d.ts +1 -15
- package/dist-types/models/enums.d.ts +338 -338
- package/dist-types/models/errors.d.ts +74 -128
- package/dist-types/models/models_0.d.ts +3435 -9819
- package/dist-types/ts3.4/models/enums.d.ts +222 -222
- package/dist-types/ts3.4/models/errors.d.ts +61 -61
- package/dist-types/ts3.4/models/models_0.d.ts +1055 -1055
- package/package.json +3 -3
|
@@ -2910,7 +2910,7 @@ var FirelensConfigurationOptionsMap = 128 | 0;
|
|
|
2910
2910
|
var LogConfigurationOptionsMap = 128 | 0;
|
|
2911
2911
|
var StringMap = 128 | 0;
|
|
2912
2912
|
export var CreateCapacityProvider$ = [9, n0, _CCP,
|
|
2913
|
-
|
|
2913
|
+
2, () => CreateCapacityProviderRequest$, () => CreateCapacityProviderResponse$
|
|
2914
2914
|
];
|
|
2915
2915
|
export var CreateCluster$ = [9, n0, _CCr,
|
|
2916
2916
|
0, () => CreateClusterRequest$, () => CreateClusterResponse$
|
|
@@ -2931,22 +2931,22 @@ export var DeleteAttributes$ = [9, n0, _DAe,
|
|
|
2931
2931
|
0, () => DeleteAttributesRequest$, () => DeleteAttributesResponse$
|
|
2932
2932
|
];
|
|
2933
2933
|
export var DeleteCapacityProvider$ = [9, n0, _DCP,
|
|
2934
|
-
|
|
2934
|
+
2, () => DeleteCapacityProviderRequest$, () => DeleteCapacityProviderResponse$
|
|
2935
2935
|
];
|
|
2936
2936
|
export var DeleteCluster$ = [9, n0, _DCel,
|
|
2937
|
-
|
|
2937
|
+
2, () => DeleteClusterRequest$, () => DeleteClusterResponse$
|
|
2938
2938
|
];
|
|
2939
2939
|
export var DeleteExpressGatewayService$ = [9, n0, _DEGS,
|
|
2940
2940
|
0, () => DeleteExpressGatewayServiceRequest$, () => DeleteExpressGatewayServiceResponse$
|
|
2941
2941
|
];
|
|
2942
2942
|
export var DeleteService$ = [9, n0, _DS,
|
|
2943
|
-
|
|
2943
|
+
2, () => DeleteServiceRequest$, () => DeleteServiceResponse$
|
|
2944
2944
|
];
|
|
2945
2945
|
export var DeleteTaskDefinitions$ = [9, n0, _DTD,
|
|
2946
2946
|
0, () => DeleteTaskDefinitionsRequest$, () => DeleteTaskDefinitionsResponse$
|
|
2947
2947
|
];
|
|
2948
2948
|
export var DeleteTaskSet$ = [9, n0, _DTS,
|
|
2949
|
-
|
|
2949
|
+
2, () => DeleteTaskSetRequest$, () => DeleteTaskSetResponse$
|
|
2950
2950
|
];
|
|
2951
2951
|
export var DeregisterContainerInstance$ = [9, n0, _DCI,
|
|
2952
2952
|
0, () => DeregisterContainerInstanceRequest$, () => DeregisterContainerInstanceResponse$
|
|
@@ -42,11 +42,11 @@ const checkState = async (client, input) => {
|
|
|
42
42
|
return { state: WaiterState.RETRY, reason };
|
|
43
43
|
};
|
|
44
44
|
export const waitForServicesInactive = async (params, input) => {
|
|
45
|
-
const serviceDefaults = { minDelay: 15, maxDelay:
|
|
45
|
+
const serviceDefaults = { minDelay: 15, maxDelay: 600 };
|
|
46
46
|
return createWaiter({ ...serviceDefaults, ...params }, input, checkState);
|
|
47
47
|
};
|
|
48
48
|
export const waitUntilServicesInactive = async (params, input) => {
|
|
49
|
-
const serviceDefaults = { minDelay: 15, maxDelay:
|
|
49
|
+
const serviceDefaults = { minDelay: 15, maxDelay: 600 };
|
|
50
50
|
const result = await createWaiter({ ...serviceDefaults, ...params }, input, checkState);
|
|
51
51
|
return checkExceptions(result);
|
|
52
52
|
};
|
|
@@ -69,11 +69,11 @@ const checkState = async (client, input) => {
|
|
|
69
69
|
return { state: WaiterState.RETRY, reason };
|
|
70
70
|
};
|
|
71
71
|
export const waitForServicesStable = async (params, input) => {
|
|
72
|
-
const serviceDefaults = { minDelay: 15, maxDelay:
|
|
72
|
+
const serviceDefaults = { minDelay: 15, maxDelay: 600 };
|
|
73
73
|
return createWaiter({ ...serviceDefaults, ...params }, input, checkState);
|
|
74
74
|
};
|
|
75
75
|
export const waitUntilServicesStable = async (params, input) => {
|
|
76
|
-
const serviceDefaults = { minDelay: 15, maxDelay:
|
|
76
|
+
const serviceDefaults = { minDelay: 15, maxDelay: 600 };
|
|
77
77
|
const result = await createWaiter({ ...serviceDefaults, ...params }, input, checkState);
|
|
78
78
|
return checkExceptions(result);
|
|
79
79
|
};
|
|
@@ -59,11 +59,11 @@ const checkState = async (client, input) => {
|
|
|
59
59
|
return { state: WaiterState.RETRY, reason };
|
|
60
60
|
};
|
|
61
61
|
export const waitForTasksRunning = async (params, input) => {
|
|
62
|
-
const serviceDefaults = { minDelay: 6, maxDelay:
|
|
62
|
+
const serviceDefaults = { minDelay: 6, maxDelay: 600 };
|
|
63
63
|
return createWaiter({ ...serviceDefaults, ...params }, input, checkState);
|
|
64
64
|
};
|
|
65
65
|
export const waitUntilTasksRunning = async (params, input) => {
|
|
66
|
-
const serviceDefaults = { minDelay: 6, maxDelay:
|
|
66
|
+
const serviceDefaults = { minDelay: 6, maxDelay: 600 };
|
|
67
67
|
const result = await createWaiter({ ...serviceDefaults, ...params }, input, checkState);
|
|
68
68
|
return checkExceptions(result);
|
|
69
69
|
};
|
|
@@ -29,11 +29,11 @@ const checkState = async (client, input) => {
|
|
|
29
29
|
return { state: WaiterState.RETRY, reason };
|
|
30
30
|
};
|
|
31
31
|
export const waitForTasksStopped = async (params, input) => {
|
|
32
|
-
const serviceDefaults = { minDelay: 6, maxDelay:
|
|
32
|
+
const serviceDefaults = { minDelay: 6, maxDelay: 600 };
|
|
33
33
|
return createWaiter({ ...serviceDefaults, ...params }, input, checkState);
|
|
34
34
|
};
|
|
35
35
|
export const waitUntilTasksStopped = async (params, input) => {
|
|
36
|
-
const serviceDefaults = { minDelay: 6, maxDelay:
|
|
36
|
+
const serviceDefaults = { minDelay: 6, maxDelay: 600 };
|
|
37
37
|
const result = await createWaiter({ ...serviceDefaults, ...params }, input, checkState);
|
|
38
38
|
return checkExceptions(result);
|
|
39
39
|
};
|
package/dist-types/ECS.d.ts
CHANGED
|
@@ -553,21 +553,7 @@ export interface ECS {
|
|
|
553
553
|
waitUntilTasksStopped(args: DescribeTasksCommandInput, waiterConfig: number | Omit<WaiterConfiguration<ECS>, "client">): Promise<WaiterResult>;
|
|
554
554
|
}
|
|
555
555
|
/**
|
|
556
|
-
* <fullname>Amazon Elastic Container Service</fullname>
|
|
557
|
-
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container
|
|
558
|
-
* management service. It makes it easy to run, stop, and manage Docker containers. You can
|
|
559
|
-
* host your cluster on a serverless infrastructure that's managed by Amazon ECS by
|
|
560
|
-
* launching your services or tasks on Fargate. For more control, you can host your
|
|
561
|
-
* tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External
|
|
562
|
-
* (on-premises) instances that you manage.</p>
|
|
563
|
-
* <p>Amazon ECS makes it easy to launch and stop container-based applications with simple
|
|
564
|
-
* API calls. This makes it easy to get the state of your cluster from a centralized
|
|
565
|
-
* service, and gives you access to many familiar Amazon EC2 features.</p>
|
|
566
|
-
* <p>You can use Amazon ECS to schedule the placement of containers across your cluster
|
|
567
|
-
* based on your resource needs, isolation policies, and availability requirements. With
|
|
568
|
-
* Amazon ECS, you don't need to operate your own cluster management and configuration
|
|
569
|
-
* management systems. You also don't need to worry about scaling your management
|
|
570
|
-
* infrastructure. </p>
|
|
556
|
+
* <fullname>Amazon Elastic Container Service</fullname> <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p> <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.</p> <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your own cluster management and configuration management systems. You also don't need to worry about scaling your management infrastructure. </p>
|
|
571
557
|
* @public
|
|
572
558
|
*/
|
|
573
559
|
export declare class ECS extends ECSClient implements ECS {
|
|
@@ -233,21 +233,7 @@ export type ECSClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHa
|
|
|
233
233
|
export interface ECSClientResolvedConfig extends ECSClientResolvedConfigType {
|
|
234
234
|
}
|
|
235
235
|
/**
|
|
236
|
-
* <fullname>Amazon Elastic Container Service</fullname>
|
|
237
|
-
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container
|
|
238
|
-
* management service. It makes it easy to run, stop, and manage Docker containers. You can
|
|
239
|
-
* host your cluster on a serverless infrastructure that's managed by Amazon ECS by
|
|
240
|
-
* launching your services or tasks on Fargate. For more control, you can host your
|
|
241
|
-
* tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External
|
|
242
|
-
* (on-premises) instances that you manage.</p>
|
|
243
|
-
* <p>Amazon ECS makes it easy to launch and stop container-based applications with simple
|
|
244
|
-
* API calls. This makes it easy to get the state of your cluster from a centralized
|
|
245
|
-
* service, and gives you access to many familiar Amazon EC2 features.</p>
|
|
246
|
-
* <p>You can use Amazon ECS to schedule the placement of containers across your cluster
|
|
247
|
-
* based on your resource needs, isolation policies, and availability requirements. With
|
|
248
|
-
* Amazon ECS, you don't need to operate your own cluster management and configuration
|
|
249
|
-
* management systems. You also don't need to worry about scaling your management
|
|
250
|
-
* infrastructure. </p>
|
|
236
|
+
* <fullname>Amazon Elastic Container Service</fullname> <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p> <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.</p> <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your own cluster management and configuration management systems. You also don't need to worry about scaling your management infrastructure. </p>
|
|
251
237
|
* @public
|
|
252
238
|
*/
|
|
253
239
|
export declare class ECSClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ECSClientResolvedConfig> {
|
|
@@ -27,10 +27,7 @@ declare const CreateCapacityProviderCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a capacity provider. Capacity providers are associated with a cluster and are
|
|
31
|
-
* used in capacity provider strategies to facilitate cluster auto scaling. You can create
|
|
32
|
-
* capacity providers for Amazon ECS Managed Instances and EC2 instances. Fargate has the
|
|
33
|
-
* predefined <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers.</p>
|
|
30
|
+
* <p>Creates a capacity provider. Capacity providers are associated with a cluster and are used in capacity provider strategies to facilitate cluster auto scaling. You can create capacity providers for Amazon ECS Managed Instances and EC2 instances. Fargate has the predefined <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers.</p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -288,18 +285,13 @@ declare const CreateCapacityProviderCommand_base: {
|
|
|
288
285
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
289
286
|
*
|
|
290
287
|
* @throws {@link ClientException} (client fault)
|
|
291
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
292
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
293
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
288
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
294
289
|
*
|
|
295
290
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
296
291
|
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
297
292
|
*
|
|
298
293
|
* @throws {@link InvalidParameterException} (client fault)
|
|
299
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
300
|
-
* request.</p>
|
|
301
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
302
|
-
* service event messages</a>. </p>
|
|
294
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
303
295
|
*
|
|
304
296
|
* @throws {@link LimitExceededException} (client fault)
|
|
305
297
|
* <p>The limit for the resource was exceeded.</p>
|
|
@@ -311,11 +303,7 @@ declare const CreateCapacityProviderCommand_base: {
|
|
|
311
303
|
* <p>The specified task isn't supported in this Region.</p>
|
|
312
304
|
*
|
|
313
305
|
* @throws {@link UpdateInProgressException} (client fault)
|
|
314
|
-
* <p>There's already a current Amazon ECS container agent update in progress on the
|
|
315
|
-
* container instance that's specified. If the container agent becomes disconnected while
|
|
316
|
-
* it's in a transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the
|
|
317
|
-
* update process can get stuck in that state. However, when the agent reconnects, it
|
|
318
|
-
* resumes where it stopped previously.</p>
|
|
306
|
+
* <p>There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.</p>
|
|
319
307
|
*
|
|
320
308
|
* @throws {@link ECSServiceException}
|
|
321
309
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
@@ -27,19 +27,7 @@ declare const CreateClusterCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a new Amazon ECS cluster. By default, your account receives a
|
|
31
|
-
* <code>default</code> cluster when you launch your first container instance. However,
|
|
32
|
-
* you can create your own cluster with a unique name.</p>
|
|
33
|
-
* <note>
|
|
34
|
-
* <p>When you call the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html">CreateCluster</a>
|
|
35
|
-
* API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for
|
|
36
|
-
* your account. This is so that it can manage required resources in other Amazon Web
|
|
37
|
-
* Services services on your behalf. However, if the user that makes the
|
|
38
|
-
* call doesn't have permissions to create the service-linked role, it isn't created.
|
|
39
|
-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using
|
|
40
|
-
* service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic
|
|
41
|
-
* Container Service Developer Guide</i>.</p>
|
|
42
|
-
* </note>
|
|
30
|
+
* <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when you launch your first container instance. However, you can create your own cluster with a unique name.</p> <note> <p>When you call the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html">CreateCluster</a> API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. 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 <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note>
|
|
43
31
|
* @example
|
|
44
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
45
33
|
* ```javascript
|
|
@@ -178,15 +166,10 @@ declare const CreateClusterCommand_base: {
|
|
|
178
166
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
179
167
|
*
|
|
180
168
|
* @throws {@link ClientException} (client fault)
|
|
181
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
182
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
183
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
169
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
184
170
|
*
|
|
185
171
|
* @throws {@link InvalidParameterException} (client fault)
|
|
186
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
187
|
-
* request.</p>
|
|
188
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
189
|
-
* service event messages</a>. </p>
|
|
172
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
190
173
|
*
|
|
191
174
|
* @throws {@link NamespaceNotFoundException} (client fault)
|
|
192
175
|
* <p>The specified namespace wasn't found.</p>
|
|
@@ -27,15 +27,7 @@ declare const CreateExpressGatewayServiceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates an Express service that simplifies deploying containerized web applications on
|
|
31
|
-
* Amazon ECS with managed Amazon Web Services infrastructure. This operation provisions and configures
|
|
32
|
-
* Application Load Balancers, target groups, security groups, and auto-scaling policies
|
|
33
|
-
* automatically.</p>
|
|
34
|
-
* <p>Specify a primary container configuration with your application image and basic
|
|
35
|
-
* settings. Amazon ECS creates the necessary Amazon Web Services resources for traffic distribution, health
|
|
36
|
-
* monitoring, network access control, and capacity management.</p>
|
|
37
|
-
* <p>Provide an execution role for task operations and an infrastructure role for managing
|
|
38
|
-
* Amazon Web Services resources on your behalf.</p>
|
|
30
|
+
* <p>Creates an Express service that simplifies deploying containerized web applications on Amazon ECS with managed Amazon Web Services infrastructure. This operation provisions and configures Application Load Balancers, target groups, security groups, and auto-scaling policies automatically.</p> <p>Specify a primary container configuration with your application image and basic settings. Amazon ECS creates the necessary Amazon Web Services resources for traffic distribution, health monitoring, network access control, and capacity management.</p> <p>Provide an execution role for task operations and an infrastructure role for managing Amazon Web Services resources on your behalf.</p>
|
|
39
31
|
* @example
|
|
40
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
33
|
* ```javascript
|
|
@@ -193,22 +185,16 @@ declare const CreateExpressGatewayServiceCommand_base: {
|
|
|
193
185
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
194
186
|
*
|
|
195
187
|
* @throws {@link ClientException} (client fault)
|
|
196
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
197
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
198
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
188
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
199
189
|
*
|
|
200
190
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
201
191
|
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
202
192
|
*
|
|
203
193
|
* @throws {@link InvalidParameterException} (client fault)
|
|
204
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
205
|
-
* request.</p>
|
|
206
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
207
|
-
* service event messages</a>. </p>
|
|
194
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
208
195
|
*
|
|
209
196
|
* @throws {@link PlatformTaskDefinitionIncompatibilityException} (client fault)
|
|
210
|
-
* <p>The specified platform version doesn't satisfy the required capabilities of the task
|
|
211
|
-
* definition.</p>
|
|
197
|
+
* <p>The specified platform version doesn't satisfy the required capabilities of the task definition.</p>
|
|
212
198
|
*
|
|
213
199
|
* @throws {@link PlatformUnknownException} (client fault)
|
|
214
200
|
* <p>The specified platform version doesn't exist.</p>
|
|
@@ -27,233 +27,7 @@ declare const CreateServiceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Runs and maintains your desired number of tasks from a specified task definition. If
|
|
31
|
-
* the number of tasks running in a service drops below the <code>desiredCount</code>,
|
|
32
|
-
* Amazon ECS runs another copy of the task in the specified cluster. To update an existing
|
|
33
|
-
* service, use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p>
|
|
34
|
-
* <note>
|
|
35
|
-
* <p>On March 21, 2024, a change was made to resolve the task definition revision
|
|
36
|
-
* before authorization. When a task definition revision is not specified,
|
|
37
|
-
* authorization will occur using the latest revision of a task definition.</p>
|
|
38
|
-
* </note>
|
|
39
|
-
* <note>
|
|
40
|
-
* <p>Amazon Elastic Inference (EI) is no longer available to customers.</p>
|
|
41
|
-
* </note>
|
|
42
|
-
* <p>In addition to maintaining the desired count of tasks in your service, you can
|
|
43
|
-
* optionally run your service behind one or more load balancers. The load balancers
|
|
44
|
-
* distribute traffic across the tasks that are associated with the service. For more
|
|
45
|
-
* 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
|
|
46
|
-
* Container Service Developer Guide</i>.</p>
|
|
47
|
-
* <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when
|
|
48
|
-
* creating or updating a service. <code>volumeConfigurations</code> is only supported for
|
|
49
|
-
* REPLICA service and not DAEMON service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic
|
|
50
|
-
* Container Service Developer Guide</i>.</p>
|
|
51
|
-
* <p>Tasks for services that don't use a load balancer are considered healthy if they're in
|
|
52
|
-
* the <code>RUNNING</code> state. Tasks for services that use a load balancer are
|
|
53
|
-
* considered healthy if they're in the <code>RUNNING</code> state and are reported as
|
|
54
|
-
* healthy by the load balancer.</p>
|
|
55
|
-
* <p>There are two service scheduler strategies available:</p>
|
|
56
|
-
* <ul>
|
|
57
|
-
* <li>
|
|
58
|
-
* <p>
|
|
59
|
-
* <code>REPLICA</code> - The replica scheduling strategy places and maintains
|
|
60
|
-
* your desired number of tasks across your cluster. By default, the service
|
|
61
|
-
* scheduler spreads tasks across Availability Zones. You can use task placement
|
|
62
|
-
* strategies and constraints to customize task placement decisions. For more
|
|
63
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the
|
|
64
|
-
* <i>Amazon Elastic Container Service Developer
|
|
65
|
-
* Guide</i>.</p>
|
|
66
|
-
* </li>
|
|
67
|
-
* <li>
|
|
68
|
-
* <p>
|
|
69
|
-
* <code>DAEMON</code> - The daemon scheduling strategy deploys exactly one task
|
|
70
|
-
* on each active container instance that meets all of the task placement
|
|
71
|
-
* constraints that you specify in your cluster. The service scheduler also
|
|
72
|
-
* evaluates the task placement constraints for running tasks. It also stops tasks
|
|
73
|
-
* that don't meet the placement constraints. When using this strategy, you don't
|
|
74
|
-
* need to specify a desired number of tasks, a task placement strategy, or use
|
|
75
|
-
* Service Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Amazon ECS services</a> in the <i>Amazon Elastic Container
|
|
76
|
-
* Service Developer Guide</i>.</p>
|
|
77
|
-
* </li>
|
|
78
|
-
* </ul>
|
|
79
|
-
* <p>The deployment controller is the mechanism that determines how tasks are deployed for
|
|
80
|
-
* your service. The valid options are:</p>
|
|
81
|
-
* <ul>
|
|
82
|
-
* <li>
|
|
83
|
-
* <p>ECS</p>
|
|
84
|
-
* <p> When you create a service which uses the <code>ECS</code> deployment
|
|
85
|
-
* controller, you can choose between the following deployment strategies (which
|
|
86
|
-
* you can set in the “<code>strategy</code>” field in
|
|
87
|
-
* “<code>deploymentConfiguration</code>”): :</p>
|
|
88
|
-
* <ul>
|
|
89
|
-
* <li>
|
|
90
|
-
* <p>
|
|
91
|
-
* <code>ROLLING</code>: When you create a service which uses the
|
|
92
|
-
* <i>rolling update</i> (<code>ROLLING</code>)
|
|
93
|
-
* deployment strategy, the Amazon ECS service scheduler replaces the
|
|
94
|
-
* currently running tasks with new tasks. The number of tasks that Amazon
|
|
95
|
-
* ECS adds or removes from the service during a rolling update is
|
|
96
|
-
* controlled by the service deployment configuration. For more
|
|
97
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html">Deploy Amazon ECS services by replacing
|
|
98
|
-
* tasks</a> in the <i>Amazon Elastic Container Service
|
|
99
|
-
* Developer Guide</i>.</p>
|
|
100
|
-
* <p>Rolling update deployments are best suited for the following
|
|
101
|
-
* scenarios:</p>
|
|
102
|
-
* <ul>
|
|
103
|
-
* <li>
|
|
104
|
-
* <p>Gradual service updates: You need to update your service
|
|
105
|
-
* incrementally without taking the entire service offline at
|
|
106
|
-
* once.</p>
|
|
107
|
-
* </li>
|
|
108
|
-
* <li>
|
|
109
|
-
* <p>Limited resource requirements: You want to avoid the
|
|
110
|
-
* additional resource costs of running two complete environments
|
|
111
|
-
* simultaneously (as required by blue/green deployments).</p>
|
|
112
|
-
* </li>
|
|
113
|
-
* <li>
|
|
114
|
-
* <p>Acceptable deployment time: Your application can tolerate a
|
|
115
|
-
* longer deployment process, as rolling updates replace tasks one
|
|
116
|
-
* by one.</p>
|
|
117
|
-
* </li>
|
|
118
|
-
* <li>
|
|
119
|
-
* <p>No need for instant roll back: Your service can tolerate a
|
|
120
|
-
* rollback process that takes minutes rather than seconds.</p>
|
|
121
|
-
* </li>
|
|
122
|
-
* <li>
|
|
123
|
-
* <p>Simple deployment process: You prefer a straightforward
|
|
124
|
-
* deployment approach without the complexity of managing multiple
|
|
125
|
-
* environments, target groups, and listeners.</p>
|
|
126
|
-
* </li>
|
|
127
|
-
* <li>
|
|
128
|
-
* <p>No load balancer requirement: Your service doesn't use or
|
|
129
|
-
* require a load balancer, Application Load Balancer, Network Load
|
|
130
|
-
* Balancer, or Service Connect (which are required for blue/green
|
|
131
|
-
* deployments).</p>
|
|
132
|
-
* </li>
|
|
133
|
-
* <li>
|
|
134
|
-
* <p>Stateful applications: Your application maintains state that
|
|
135
|
-
* makes it difficult to run two parallel environments.</p>
|
|
136
|
-
* </li>
|
|
137
|
-
* <li>
|
|
138
|
-
* <p>Cost sensitivity: You want to minimize deployment costs by not
|
|
139
|
-
* running duplicate environments during deployment.</p>
|
|
140
|
-
* </li>
|
|
141
|
-
* </ul>
|
|
142
|
-
* <p>Rolling updates are the default deployment strategy for services and
|
|
143
|
-
* provide a balance between deployment safety and resource efficiency for
|
|
144
|
-
* many common application scenarios.</p>
|
|
145
|
-
* </li>
|
|
146
|
-
* <li>
|
|
147
|
-
* <p>
|
|
148
|
-
* <code>BLUE_GREEN</code>: A <i>blue/green</i> deployment
|
|
149
|
-
* strategy (<code>BLUE_GREEN</code>) is a release methodology that reduces
|
|
150
|
-
* downtime and risk by running two identical production environments
|
|
151
|
-
* called blue and green. With Amazon ECS blue/green deployments, you can
|
|
152
|
-
* validate new service revisions before directing production traffic to
|
|
153
|
-
* them. This approach provides a safer way to deploy changes with the
|
|
154
|
-
* ability to quickly roll back if needed. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-blue-green.html">Amazon ECS blue/green deployments</a> in
|
|
155
|
-
* the <i>Amazon Elastic Container Service Developer
|
|
156
|
-
* Guide</i>.</p>
|
|
157
|
-
* <p>Amazon ECS blue/green deployments are best suited for the following
|
|
158
|
-
* scenarios:</p>
|
|
159
|
-
* <ul>
|
|
160
|
-
* <li>
|
|
161
|
-
* <p>Service validation: When you need to validate new service
|
|
162
|
-
* revisions before directing production traffic to them</p>
|
|
163
|
-
* </li>
|
|
164
|
-
* <li>
|
|
165
|
-
* <p>Zero downtime: When your service requires zero-downtime
|
|
166
|
-
* deployments</p>
|
|
167
|
-
* </li>
|
|
168
|
-
* <li>
|
|
169
|
-
* <p>Instant roll back: When you need the ability to quickly roll
|
|
170
|
-
* back if issues are detected</p>
|
|
171
|
-
* </li>
|
|
172
|
-
* <li>
|
|
173
|
-
* <p>Load balancer requirement: When your service uses Application
|
|
174
|
-
* Load Balancer, Network Load Balancer, or Service Connect</p>
|
|
175
|
-
* </li>
|
|
176
|
-
* </ul>
|
|
177
|
-
* </li>
|
|
178
|
-
* <li>
|
|
179
|
-
* <p>
|
|
180
|
-
* <code>LINEAR</code>: A <i>linear</i> deployment strategy
|
|
181
|
-
* (<code>LINEAR</code>) gradually shifts traffic from the current
|
|
182
|
-
* production environment to a new environment in equal percentage
|
|
183
|
-
* increments. With Amazon ECS linear deployments, you can control the pace
|
|
184
|
-
* of traffic shifting and validate new service revisions with increasing
|
|
185
|
-
* amounts of production traffic.</p>
|
|
186
|
-
* <p>Linear deployments are best suited for the following scenarios:</p>
|
|
187
|
-
* <ul>
|
|
188
|
-
* <li>
|
|
189
|
-
* <p>Gradual validation: When you want to gradually validate your
|
|
190
|
-
* new service version with increasing traffic</p>
|
|
191
|
-
* </li>
|
|
192
|
-
* <li>
|
|
193
|
-
* <p>Performance monitoring: When you need time to monitor metrics
|
|
194
|
-
* and performance during the deployment</p>
|
|
195
|
-
* </li>
|
|
196
|
-
* <li>
|
|
197
|
-
* <p>Risk minimization: When you want to minimize risk by exposing
|
|
198
|
-
* the new version to production traffic incrementally</p>
|
|
199
|
-
* </li>
|
|
200
|
-
* <li>
|
|
201
|
-
* <p>Load balancer requirement: When your service uses Application
|
|
202
|
-
* Load Balancer or Service Connect</p>
|
|
203
|
-
* </li>
|
|
204
|
-
* </ul>
|
|
205
|
-
* </li>
|
|
206
|
-
* <li>
|
|
207
|
-
* <p>
|
|
208
|
-
* <code>CANARY</code>: A <i>canary</i> deployment strategy
|
|
209
|
-
* (<code>CANARY</code>) shifts a small percentage of traffic to the
|
|
210
|
-
* new service revision first, then shifts the remaining traffic all at
|
|
211
|
-
* once after a specified time period. This allows you to test the new
|
|
212
|
-
* version with a subset of users before full deployment.</p>
|
|
213
|
-
* <p>Canary deployments are best suited for the following scenarios:</p>
|
|
214
|
-
* <ul>
|
|
215
|
-
* <li>
|
|
216
|
-
* <p>Feature testing: When you want to test new features with a
|
|
217
|
-
* small subset of users before full rollout</p>
|
|
218
|
-
* </li>
|
|
219
|
-
* <li>
|
|
220
|
-
* <p>Production validation: When you need to validate performance
|
|
221
|
-
* and functionality with real production traffic</p>
|
|
222
|
-
* </li>
|
|
223
|
-
* <li>
|
|
224
|
-
* <p>Blast radius control: When you want to minimize blast radius
|
|
225
|
-
* if issues are discovered in the new version</p>
|
|
226
|
-
* </li>
|
|
227
|
-
* <li>
|
|
228
|
-
* <p>Load balancer requirement: When your service uses Application
|
|
229
|
-
* Load Balancer or Service Connect</p>
|
|
230
|
-
* </li>
|
|
231
|
-
* </ul>
|
|
232
|
-
* </li>
|
|
233
|
-
* </ul>
|
|
234
|
-
* </li>
|
|
235
|
-
* <li>
|
|
236
|
-
* <p>External</p>
|
|
237
|
-
* <p>Use a third-party deployment controller.</p>
|
|
238
|
-
* </li>
|
|
239
|
-
* <li>
|
|
240
|
-
* <p>Blue/green deployment (powered by CodeDeploy)</p>
|
|
241
|
-
* <p>CodeDeploy installs an updated version of the application as a new
|
|
242
|
-
* replacement task set and reroutes production traffic from the original
|
|
243
|
-
* application task set to the replacement task set. The original task set is
|
|
244
|
-
* terminated after a successful deployment. Use this deployment controller to
|
|
245
|
-
* verify a new deployment of a service before sending production traffic to
|
|
246
|
-
* it.</p>
|
|
247
|
-
* </li>
|
|
248
|
-
* </ul>
|
|
249
|
-
* <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you
|
|
250
|
-
* can specify only parameters that aren't controlled at the task set level. The only
|
|
251
|
-
* required parameter is the service name. You control your services using the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>. 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
|
|
252
|
-
* Service Developer Guide</i>.</p>
|
|
253
|
-
* <p>When the service scheduler launches new tasks, it determines task placement. For
|
|
254
|
-
* information about task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS task placement</a> in the <i>Amazon Elastic Container Service
|
|
255
|
-
* Developer Guide</i>
|
|
256
|
-
* </p>
|
|
30
|
+
* <p>Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the <code>desiredCount</code>, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p> <note> <p>On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.</p> </note> <note> <p>Amazon Elastic Inference (EI) is no longer available to customers.</p> </note> <p>In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For 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> <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. <code>volumeConfigurations</code> is only supported for REPLICA service and not DAEMON service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>Tasks for services that don't use a load balancer are considered healthy if they're in the <code>RUNNING</code> state. Tasks for services that use a load balancer are considered healthy if they're in the <code>RUNNING</code> state and are reported as healthy by the load balancer.</p> <p>There are two service scheduler strategies available:</p> <ul> <li> <p> <code>REPLICA</code> - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. 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> </li> <li> <p> <code>DAEMON</code> - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Amazon ECS services</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </li> </ul> <p>The deployment controller is the mechanism that determines how tasks are deployed for your service. The valid options are:</p> <ul> <li> <p>ECS</p> <p> When you create a service which uses the <code>ECS</code> deployment controller, you can choose between the following deployment strategies (which you can set in the “<code>strategy</code>” field in “<code>deploymentConfiguration</code>”): :</p> <ul> <li> <p> <code>ROLLING</code>: When you create a service which uses the <i>rolling update</i> (<code>ROLLING</code>) deployment strategy, the Amazon ECS service scheduler replaces the currently running tasks with new tasks. The number of tasks that Amazon ECS adds or removes from the service during a rolling update is controlled by the service deployment configuration. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html">Deploy Amazon ECS services by replacing tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>Rolling update deployments are best suited for the following scenarios:</p> <ul> <li> <p>Gradual service updates: You need to update your service incrementally without taking the entire service offline at once.</p> </li> <li> <p>Limited resource requirements: You want to avoid the additional resource costs of running two complete environments simultaneously (as required by blue/green deployments).</p> </li> <li> <p>Acceptable deployment time: Your application can tolerate a longer deployment process, as rolling updates replace tasks one by one.</p> </li> <li> <p>No need for instant roll back: Your service can tolerate a rollback process that takes minutes rather than seconds.</p> </li> <li> <p>Simple deployment process: You prefer a straightforward deployment approach without the complexity of managing multiple environments, target groups, and listeners.</p> </li> <li> <p>No load balancer requirement: Your service doesn't use or require a load balancer, Application Load Balancer, Network Load Balancer, or Service Connect (which are required for blue/green deployments).</p> </li> <li> <p>Stateful applications: Your application maintains state that makes it difficult to run two parallel environments.</p> </li> <li> <p>Cost sensitivity: You want to minimize deployment costs by not running duplicate environments during deployment.</p> </li> </ul> <p>Rolling updates are the default deployment strategy for services and provide a balance between deployment safety and resource efficiency for many common application scenarios.</p> </li> <li> <p> <code>BLUE_GREEN</code>: A <i>blue/green</i> deployment strategy (<code>BLUE_GREEN</code>) is a release methodology that reduces downtime and risk by running two identical production environments called blue and green. With Amazon ECS blue/green deployments, you can validate new service revisions before directing production traffic to them. This approach provides a safer way to deploy changes with the ability to quickly roll back if needed. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-blue-green.html">Amazon ECS blue/green deployments</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>Amazon ECS blue/green deployments are best suited for the following scenarios:</p> <ul> <li> <p>Service validation: When you need to validate new service revisions before directing production traffic to them</p> </li> <li> <p>Zero downtime: When your service requires zero-downtime deployments</p> </li> <li> <p>Instant roll back: When you need the ability to quickly roll back if issues are detected</p> </li> <li> <p>Load balancer requirement: When your service uses Application Load Balancer, Network Load Balancer, or Service Connect</p> </li> </ul> </li> <li> <p> <code>LINEAR</code>: A <i>linear</i> deployment strategy (<code>LINEAR</code>) gradually shifts traffic from the current production environment to a new environment in equal percentage increments. With Amazon ECS linear deployments, you can control the pace of traffic shifting and validate new service revisions with increasing amounts of production traffic.</p> <p>Linear deployments are best suited for the following scenarios:</p> <ul> <li> <p>Gradual validation: When you want to gradually validate your new service version with increasing traffic</p> </li> <li> <p>Performance monitoring: When you need time to monitor metrics and performance during the deployment</p> </li> <li> <p>Risk minimization: When you want to minimize risk by exposing the new version to production traffic incrementally</p> </li> <li> <p>Load balancer requirement: When your service uses Application Load Balancer or Service Connect</p> </li> </ul> </li> <li> <p> <code>CANARY</code>: A <i>canary</i> deployment strategy (<code>CANARY</code>) shifts a small percentage of traffic to the new service revision first, then shifts the remaining traffic all at once after a specified time period. This allows you to test the new version with a subset of users before full deployment.</p> <p>Canary deployments are best suited for the following scenarios:</p> <ul> <li> <p>Feature testing: When you want to test new features with a small subset of users before full rollout</p> </li> <li> <p>Production validation: When you need to validate performance and functionality with real production traffic</p> </li> <li> <p>Blast radius control: When you want to minimize blast radius if issues are discovered in the new version</p> </li> <li> <p>Load balancer requirement: When your service uses Application Load Balancer or Service Connect</p> </li> </ul> </li> </ul> </li> <li> <p>External</p> <p>Use a third-party deployment controller.</p> </li> <li> <p>Blue/green deployment (powered by CodeDeploy)</p> <p>CodeDeploy installs an updated version of the application as a new replacement task set and reroutes production traffic from the original application task set to the replacement task set. The original task set is terminated after a successful deployment. Use this deployment controller to verify a new deployment of a service before sending production traffic to it.</p> </li> </ul> <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>. 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> <p>When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS task placement</a> in the <i>Amazon Elastic Container Service Developer Guide</i> </p>
|
|
257
31
|
* @example
|
|
258
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
259
33
|
* ```javascript
|
|
@@ -813,25 +587,19 @@ declare const CreateServiceCommand_base: {
|
|
|
813
587
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
814
588
|
*
|
|
815
589
|
* @throws {@link ClientException} (client fault)
|
|
816
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
817
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
818
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
590
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
819
591
|
*
|
|
820
592
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
821
593
|
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
822
594
|
*
|
|
823
595
|
* @throws {@link InvalidParameterException} (client fault)
|
|
824
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
825
|
-
* request.</p>
|
|
826
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
827
|
-
* service event messages</a>. </p>
|
|
596
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
828
597
|
*
|
|
829
598
|
* @throws {@link NamespaceNotFoundException} (client fault)
|
|
830
599
|
* <p>The specified namespace wasn't found.</p>
|
|
831
600
|
*
|
|
832
601
|
* @throws {@link PlatformTaskDefinitionIncompatibilityException} (client fault)
|
|
833
|
-
* <p>The specified platform version doesn't satisfy the required capabilities of the task
|
|
834
|
-
* definition.</p>
|
|
602
|
+
* <p>The specified platform version doesn't satisfy the required capabilities of the task definition.</p>
|
|
835
603
|
*
|
|
836
604
|
* @throws {@link PlatformUnknownException} (client fault)
|
|
837
605
|
* <p>The specified platform version doesn't exist.</p>
|