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.
-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.
-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.
+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.
+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.
+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.
## Installing diff --git a/clients/client-ecs/src/ECS.ts b/clients/client-ecs/src/ECS.ts index 7cfc5480f946..3c94e7826d13 100644 --- a/clients/client-ecs/src/ECS.ts +++ b/clients/client-ecs/src/ECS.ts @@ -1242,18 +1242,17 @@ export interface ECS { /** *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.
- *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.
- *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.
+ *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.
+ *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.
+ *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.
* @public */ export class ECS extends ECSClient implements ECS {} diff --git a/clients/client-ecs/src/ECSClient.ts b/clients/client-ecs/src/ECSClient.ts index 909ce62972bc..a07f25972b58 100644 --- a/clients/client-ecs/src/ECSClient.ts +++ b/clients/client-ecs/src/ECSClient.ts @@ -520,18 +520,17 @@ export interface ECSClientResolvedConfig extends ECSClientResolvedConfigType {} /** *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.
- *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.
- *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.
+ *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.
+ *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.
+ *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.
* @public */ export class ECSClient extends __Client< diff --git a/clients/client-ecs/src/commands/CreateCapacityProviderCommand.ts b/clients/client-ecs/src/commands/CreateCapacityProviderCommand.ts index f9b457165e42..3e8426d94745 100644 --- a/clients/client-ecs/src/commands/CreateCapacityProviderCommand.ts +++ b/clients/client-ecs/src/commands/CreateCapacityProviderCommand.ts @@ -28,13 +28,11 @@ export interface CreateCapacityProviderCommandInput extends CreateCapacityProvid export interface CreateCapacityProviderCommandOutput extends CreateCapacityProviderResponse, __MetadataBearer {} /** - *Creates a new capacity provider. Capacity providers are associated with an Amazon ECS - * cluster and are used in capacity provider strategies to facilitate cluster auto - * scaling.
- *Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on
- * Fargate use the FARGATE and FARGATE_SPOT capacity providers.
- * These providers are available to all accounts in the Amazon Web Services Regions that Fargate
- * supports.
Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used + * in capacity provider strategies to facilitate cluster auto scaling.
+ *Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use
+ * the FARGATE and FARGATE_SPOT capacity providers. These providers are
+ * available to all accounts in the Amazon Web Services Regions that Fargate supports.
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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link LimitExceededException} (client fault) *The limit for the resource was exceeded.
@@ -126,11 +122,10 @@ export interface CreateCapacityProviderCommandOutput extends CreateCapacityProvi *These errors are usually caused by a server issue.
* * @throws {@link UpdateInProgressException} (client fault) - *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 PENDING or STAGING, the update
- * process can get stuck in that state. However, when the agent reconnects, it resumes
- * where it stopped previously.
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
+ * PENDING or STAGING, the update process can get stuck in that state.
+ * However, when the agent reconnects, it resumes where it stopped previously.
Base exception class for all service exceptions from ECS service.
diff --git a/clients/client-ecs/src/commands/CreateClusterCommand.ts b/clients/client-ecs/src/commands/CreateClusterCommand.ts index d58431f40925..ad826a1702e3 100644 --- a/clients/client-ecs/src/commands/CreateClusterCommand.ts +++ b/clients/client-ecs/src/commands/CreateClusterCommand.ts @@ -28,16 +28,16 @@ export interface CreateClusterCommandInput extends CreateClusterRequest {} export interface CreateClusterCommandOutput extends CreateClusterResponse, __MetadataBearer {} /** - *Creates a new Amazon ECS cluster. By default, your account receives a default
- * cluster when you launch your first container instance. However, you can create your own
- * cluster with a unique name.
Creates a new Amazon ECS cluster. By default, your account receives a default cluster when
+ * you launch your first container instance. However, you can create your own cluster with a unique
+ * name.
When you call the CreateCluster 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 Using - * service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
+ *When you call the CreateCluster 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 Using service-linked + * roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
*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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link NamespaceNotFoundException} (client fault) *The specified namespace wasn't found.
diff --git a/clients/client-ecs/src/commands/CreateServiceCommand.ts b/clients/client-ecs/src/commands/CreateServiceCommand.ts index 13089fe50406..415a45a8768d 100644 --- a/clients/client-ecs/src/commands/CreateServiceCommand.ts +++ b/clients/client-ecs/src/commands/CreateServiceCommand.ts @@ -28,92 +28,89 @@ export interface CreateServiceCommandInput extends CreateServiceRequest {} export interface CreateServiceCommandOutput extends CreateServiceResponse, __MetadataBearer {} /** - *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 desiredCount,
- * Amazon ECS runs another copy of the task in the specified cluster. To update an existing
- * service, see the UpdateService action.
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 desiredCount, Amazon ECS runs another copy of the
+ * task in the specified cluster. To update an existing service, use UpdateService.
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.
*Amazon Elastic Inference (EI) is no longer available to customers.
*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 Service load balancing in the Amazon Elastic Container Service Developer Guide.
- *You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or
- * updating a service. volumeConfigurations is only supported for REPLICA
- * service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
Tasks for services that don't use a load balancer are considered healthy if they're in
- * the RUNNING state. Tasks for services that use a load balancer are
- * considered healthy if they're in the RUNNING state and are reported as
- * healthy by the load balancer.
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 Service load + * balancing in the Amazon Elastic Container Service Developer Guide.
+ *You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a
+ * service. volumeConfigurations is only supported for REPLICA service and not DAEMON
+ * service. For more infomation, see Amazon EBS
+ * volumes in the Amazon Elastic Container Service Developer Guide.
Tasks for services that don't use a load balancer are considered healthy if they're in the
+ * RUNNING state. Tasks for services that use a load balancer are considered healthy if
+ * they're in the RUNNING state and are reported as healthy by the load balancer.
There are two service scheduler strategies available:
*
- * REPLICA - 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 Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
REPLICA - 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 Service
+ * scheduler concepts in the Amazon Elastic Container Service Developer Guide.
*
- * DAEMON - 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 Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
DAEMON - 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 Service
+ * scheduler concepts in the Amazon Elastic Container Service Developer Guide.
* You can optionally specify a deployment configuration for your service. The deployment
- * is initiated by changing properties. For example, the deployment might be initiated by
- * the task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for
- * minimumHealthyPercent is 100%. The default value for a daemon service
- * for minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy
- * percent represents a lower limit on the number of tasks in a service that must remain in
- * the RUNNING state during a deployment. Specifically, it represents it as a
- * percentage of your desired number of tasks (rounded up to the nearest integer). This
- * happens when any of your container instances are in the DRAINING state if
- * the service contains tasks using the EC2 launch type. Using this
- * parameter, you can deploy without using additional cluster capacity. For example, if you
- * set your service to have desired number of four tasks and a minimum healthy percent of
- * 50%, the scheduler might stop two existing tasks to free up cluster capacity before
- * starting two new tasks. If they're in the RUNNING state, tasks for services
- * that don't use a load balancer are considered healthy . If they're in the
- * RUNNING state and reported as healthy by the load balancer, tasks for
- * services that do use a load balancer are considered healthy . The
+ *
You can optionally specify a deployment configuration for your service. The deployment is initiated
+ * by changing properties. For example, the deployment might be initiated by the task definition or by
+ * your desired count of a service. You can use UpdateService. The default value for a replica service for
+ * minimumHealthyPercent is 100%. The default value for a daemon service for
+ * minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy percent represents
+ * a lower limit on the number of tasks in a service that must remain in the RUNNING state
+ * during a deployment. Specifically, it represents it as a percentage of your desired number of tasks
+ * (rounded up to the nearest integer). This happens when any of your container instances are in the
+ * DRAINING state if the service contains tasks using the EC2 launch type.
+ * Using this parameter, you can deploy without using additional cluster capacity. For example, if you set
+ * your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler
+ * might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in
+ * the RUNNING state, tasks for services that don't use a load balancer are considered
+ * healthy . If they're in the RUNNING state and reported as healthy by the load balancer,
+ * tasks for services that do use a load balancer are considered healthy . The
* default value for minimum healthy percent is 100%.
If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the
- * number of tasks in a service that are allowed in the RUNNING or
- * PENDING state during a deployment. Specifically, it represents it as a
- * percentage of the desired number of tasks (rounded down to the nearest integer). This
- * happens when any of your container instances are in the DRAINING state if
- * the service contains tasks using the EC2 launch type. Using this
- * parameter, you can define the deployment batch size. For example, if your service has a
- * desired number of four tasks and a maximum percent value of 200%, the scheduler may
- * start four new tasks before stopping the four older tasks (provided that the cluster
- * resources required to do this are available). The default value for maximum percent is
- * 200%.
If a service uses either the CODE_DEPLOY or EXTERNAL
- * deployment controller types and tasks that use the EC2 launch type, the
- * minimum healthy percent and maximum percent values are used only to define the lower and upper limit
- * on the number of the tasks in the service that remain in the RUNNING state.
- * This is while the container instances are in the DRAINING state. If the
- * tasks in the service use the Fargate launch type, the minimum healthy
- * percent and maximum percent values aren't used. This is the case even if they're
- * currently visible when describing your service.
When creating a service that uses the EXTERNAL 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 CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement. For - * information about task placement and task placement strategies, see Amazon ECS - * task placement in the Amazon Elastic Container Service Developer Guide + *
If a service uses the ECS deployment controller, the maximum
+ * percent parameter represents an upper limit on the number of tasks in a service that are
+ * allowed in the RUNNING or PENDING state during a deployment. Specifically, it
+ * represents it as a percentage of the desired number of tasks (rounded down to the nearest integer).
+ * This happens when any of your container instances are in the DRAINING state if the service
+ * contains tasks using the EC2 launch type. Using this parameter, you can define the
+ * deployment batch size. For example, if your service has a desired number of four tasks and a maximum
+ * percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks
+ * (provided that the cluster resources required to do this are available). The default value for maximum
+ * percent is 200%.
If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller
+ * types and tasks that use the EC2 launch type, the minimum healthy
+ * percent and maximum percent values are used only to
+ * define the lower and upper limit on the number of the tasks in the service that remain in the
+ * RUNNING state. This is while the container instances are in the DRAINING
+ * state. If the tasks in the service use the Fargate launch type, the minimum healthy
+ * percent and maximum percent values aren't used. This is the case even if they're currently visible when
+ * describing your service.
When creating a service that uses the EXTERNAL 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 CreateTaskSet. For more information, see Amazon ECS deployment
+ * types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement. For information about + * task placement and task placement strategies, see Amazon ECS task + * placement in the Amazon Elastic Container Service Developer Guide *
* @example * Use a bare-bones client and the command you need to make an API call. @@ -273,6 +270,13 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met * }, * }, * ], + * vpcLatticeConfigurations: [ // VpcLatticeConfigurations + * { // VpcLatticeConfiguration + * roleArn: "STRING_VALUE", // required + * targetGroupArn: "STRING_VALUE", // required + * portName: "STRING_VALUE", // required + * }, + * ], * }; * const command = new CreateServiceCommand(input); * const response = await client.send(command); @@ -507,6 +511,13 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met * // fargateEphemeralStorage: { * // kmsKeyId: "STRING_VALUE", * // }, + * // vpcLatticeConfigurations: [ // VpcLatticeConfigurations + * // { // VpcLatticeConfiguration + * // roleArn: "STRING_VALUE", // required + * // targetGroupArn: "STRING_VALUE", // required + * // portName: "STRING_VALUE", // required + * // }, + * // ], * // }, * // ], * // roleArn: "STRING_VALUE", @@ -562,17 +573,16 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met *You don't have authorization to perform the requested action.
* * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
* * @throws {@link InvalidParameterException} (client fault) - *The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link NamespaceNotFoundException} (client fault) *The specified namespace wasn't found.
diff --git a/clients/client-ecs/src/commands/CreateTaskSetCommand.ts b/clients/client-ecs/src/commands/CreateTaskSetCommand.ts index d568a327cc2d..d88414947b9f 100644 --- a/clients/client-ecs/src/commands/CreateTaskSetCommand.ts +++ b/clients/client-ecs/src/commands/CreateTaskSetCommand.ts @@ -28,15 +28,14 @@ export interface CreateTaskSetCommandInput extends CreateTaskSetRequest {} export interface CreateTaskSetCommandOutput extends CreateTaskSetResponse, __MetadataBearer {} /** - *Create a task set in the specified cluster and service. This is used when a service
- * uses the Create a task set in the specified cluster and service. This is used when a service uses the
+ * 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. For information about the maximum number of task sets and other quotas, see Amazon ECS
- * service quotas in the Amazon Elastic Container Service Developer Guide. For information about the maximum number of task sets and other quotas, see Amazon ECS service
+ * quotas in the Amazon Elastic Container Service Developer Guide. You don't have authorization to perform the requested action. 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. 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. The following list includes additional causes for the error: The The The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. The specified namespace wasn't found. These errors are usually caused by a server issue. The specified service isn't active. You can't update a service that's inactive. If you
- * have previously deleted a service, you can re-create it with CreateService. The specified service isn't active. You can't update a service that's inactive. If you have
+ * previously deleted a service, you can re-create it with CreateService. The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region
- * specific. The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific. The specified task isn't supported in this Region. Disables an account setting for a specified user, role, or the root user for an
- * account. Disables an account setting for a specified user, role, or the root user for an account. 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. 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. The following list includes additional causes for the error: The The The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. The specified target wasn't found. You can view your available container instances
- * with ListContainerInstances. Amazon ECS container instances are cluster-specific and
+ * The specified target wasn't found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and
* Region-specific. Deletes the specified capacity provider. The The Prior to a capacity provider being deleted, the capacity provider must be removed from
- * the capacity provider strategy from all services. The UpdateService
- * API can be used to remove a capacity provider from a service's capacity provider
- * strategy. When updating a service, the Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity
+ * provider strategy from all services. The UpdateService API can be used to
+ * remove a capacity provider from a service's capacity provider strategy. When updating a service, the
+ * 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. 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. The following list includes additional causes for the error: The The The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. Deletes the specified cluster. The cluster transitions to the You must deregister all container instances from this cluster before you may delete
- * it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance. Deletes the specified cluster. The cluster transitions to the You must deregister all container instances from this cluster before you may delete it. You can list
+ * the container instances in a cluster with ListContainerInstances
+ * and deregister them with DeregisterContainerInstance. 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. 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. The following list includes additional causes for the error: The The You can't delete a cluster that has registered container instances. First, deregister
- * the container instances before you can delete the cluster. For more information, see
- * DeregisterContainerInstance. You can't delete a cluster that has registered container instances. First, deregister the container
+ * instances before you can delete the cluster. For more information, see DeregisterContainerInstance. You can't delete a cluster that contains services. First, update the service to reduce
- * its desired task count to 0, and then delete the service. For more information, see
- * UpdateService and DeleteService. You can't delete a cluster that contains services. First, update the service to reduce its desired
+ * task count to 0, and then delete the service. For more information, see UpdateService and DeleteService. You can't delete a cluster that has active tasks. The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. 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 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
+ * Base exception class for all service exceptions from ECS service. Deletes a specified service within a cluster. You can delete a service if you have no
- * running tasks in it and the desired task count is zero. If the service is actively
- * maintaining tasks, you can't delete it, and you must update the service to a desired
- * task count of zero. For more information, see UpdateService. Deletes a specified service within a cluster. You can delete a service if you have no running tasks
+ * in it and the desired task count is zero. If the service is actively maintaining tasks, you can't
+ * delete it, and you must update the service to a desired task count of zero. For more information, see
+ * UpdateService. When you delete a service, if there are still running tasks that require cleanup,
- * the service status moves from When you delete a service, if there are still running tasks that require cleanup, the service
+ * status moves from If you attempt to create a new service with the same name as an existing service
- * in either If you attempt to create a new service with the same name as an existing service in either
+ * 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. 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. The following list includes additional causes for the error: The The The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region
- * specific. The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific. Base exception class for all service exceptions from ECS service. Deletes one or more task definitions. You must deregister a task definition revision before you delete it. For more
- * information, see DeregisterTaskDefinition. You must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition. When you delete a task definition revision, it is immediately transitions from the
- * You can't use a A task definition revision will stay in When you delete all EXTERNAL deployment controller type. For more information, see
- * Amazon ECS deployment
+ * EXTERNAL deployment controller type. For more information, see Amazon ECS deployment
* types in the Amazon Elastic Container Service Developer Guide.
*
*
@@ -198,8 +196,7 @@ export interface CreateTaskSetCommandOutput extends CreateTaskSetResponse, __Met
* RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
*
*
* @throws {@link InvalidParameterException} (client fault)
- * RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.FARGATE and FARGATE_SPOT capacity providers are
- * reserved and can't be deleted. You can disassociate them from a cluster using either PutCapacityProviderProviders or by deleting the
- * cluster.FARGATE and FARGATE_SPOT capacity providers are reserved and can't
+ * be deleted. You can disassociate them from a cluster using either PutCapacityProviderProviders or by deleting the cluster.forceNewDeployment option can be
- * used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity
- * provider are transitioned to use the capacity from the remaining capacity providers.
- * Only capacity providers that aren't associated with a cluster can be deleted. To remove
- * a capacity provider from a cluster, you can either use PutCapacityProviderProviders or delete the cluster.forceNewDeployment option can be used to ensure that any tasks using the Amazon EC2
+ * instance capacity provided by the capacity provider are transitioned to use the capacity from the
+ * remaining capacity providers. Only capacity providers that aren't associated with a cluster can be
+ * deleted. To remove a capacity provider from a cluster, you can either use PutCapacityProviderProviders or delete the cluster.
*
*
* @throws {@link InvalidParameterException} (client fault)
- * RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.INACTIVE
- * state. Clusters with an INACTIVE status might remain discoverable in your
- * account for a period of time. However, this behavior is subject to change in the future.
- * We don't recommend that you rely on INACTIVE clusters persisting.INACTIVE state. Clusters
+ * with an INACTIVE status might remain discoverable in your account for a period of time.
+ * However, this behavior is subject to change in the future. We don't recommend that you rely on
+ * INACTIVE clusters persisting.
*
*
* @throws {@link ClusterContainsContainerInstancesException} (client fault)
- * RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.PENDING or STAGING, the update
- * process can get stuck in that state. However, when the agent reconnects, it resumes
- * where it stopped previously.PENDING or STAGING, the update process can get stuck in that state.
+ * However, when the agent reconnects, it resumes where it stopped previously.ACTIVE to DRAINING, and the
- * service is no longer visible in the console or in the ListServices
- * API operation. After all tasks have transitioned to either STOPPING or
- * STOPPED status, the service status moves from DRAINING
- * to INACTIVE. Services in the DRAINING or
- * INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future,
- * INACTIVE services may be cleaned up and purged from Amazon ECS record
- * keeping, and DescribeServices calls on those services return a
- * ServiceNotFoundException error.ACTIVE to DRAINING, and the service is no longer
+ * visible in the console or in the ListServices API operation.
+ * After all tasks have transitioned to either STOPPING or STOPPED status,
+ * the service status moves from DRAINING to INACTIVE. Services in the
+ * DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services
+ * may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on
+ * those services return a ServiceNotFoundException error.ACTIVE or DRAINING status, you receive an
- * error.ACTIVE or DRAINING status, you receive an error.
*
*
@@ -363,15 +366,13 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
* RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.INACTIVE to DELETE_IN_PROGRESS. Existing tasks and
- * services that reference a DELETE_IN_PROGRESS task definition revision
- * continue to run without disruption. Existing services that reference a
- * DELETE_IN_PROGRESS task definition revision can still scale up or down
- * by modifying the service's desired count.DELETE_IN_PROGRESS task definition revision to run new
- * tasks or create new services. You also can't update an existing service to reference a
- * DELETE_IN_PROGRESS task definition revision.DELETE_IN_PROGRESS status until
- * all the associated tasks and services have been terminated.INACTIVE task definition revisions, the task
- * definition name is not displayed in the console and not returned in the API. If a task
- * definition revisions are in the DELETE_IN_PROGRESS state, the task
- * definition name is displayed in the console and returned in the API. The task definition
- * name is retained by Amazon ECS and the revision is incremented the next time you create a
- * task definition with that name.INACTIVE to DELETE_IN_PROGRESS. Existing tasks and services that
+ * reference a DELETE_IN_PROGRESS task definition revision continue to run without
+ * disruption. Existing services that reference a DELETE_IN_PROGRESS task definition revision
+ * can still scale up or down by modifying the service's desired count.
You can't use a DELETE_IN_PROGRESS task definition revision to run new tasks or create
+ * new services. You also can't update an existing service to reference a DELETE_IN_PROGRESS
+ * task definition revision.
A task definition revision will stay in DELETE_IN_PROGRESS status until all the
+ * associated tasks and services have been terminated.
When you delete all INACTIVE task definition revisions, the task definition name is not
+ * displayed in the console and not returned in the API. If a task definition revisions are in the
+ * DELETE_IN_PROGRESS state, the task definition name is displayed in the console and
+ * returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the
+ * next time you create a task definition with that name.
You don't have authorization to perform the requested action.
* * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
diff --git a/clients/client-ecs/src/commands/DeleteTaskSetCommand.ts b/clients/client-ecs/src/commands/DeleteTaskSetCommand.ts index bb25f23f669b..54e7f7059c2e 100644 --- a/clients/client-ecs/src/commands/DeleteTaskSetCommand.ts +++ b/clients/client-ecs/src/commands/DeleteTaskSetCommand.ts @@ -29,7 +29,8 @@ export interface DeleteTaskSetCommandOutput extends DeleteTaskSetResponse, __Met /** *Deletes a specified task set within a service. This is used when a service uses the
- * EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
EXTERNAL deployment controller type. For more information, see Amazon ECS deployment
+ * types in the Amazon Elastic Container Service Developer Guide.
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
@@ -126,17 +127,16 @@ export interface DeleteTaskSetCommandOutput extends DeleteTaskSetResponse, __Met
* You don't have authorization to perform the requested action.
* * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
* * @throws {@link InvalidParameterException} (client fault) - *The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
* * @throws {@link ServiceNotActiveException} (client fault) - *The specified service isn't active. You can't update a service that's inactive. If you - * have previously deleted a service, you can re-create it with CreateService.
+ *The specified service isn't active. You can't update a service that's inactive. If you have + * previously deleted a service, you can re-create it with CreateService.
* * @throws {@link ServiceNotFoundException} (client fault) - *The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region - * specific.
+ *The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
* * @throws {@link TaskSetNotFoundException} (client fault) - *The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and - * Region.
+ *The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.
* * @throws {@link UnsupportedFeatureException} (client fault) *The specified task isn't supported in this Region.
diff --git a/clients/client-ecs/src/commands/DeregisterContainerInstanceCommand.ts b/clients/client-ecs/src/commands/DeregisterContainerInstanceCommand.ts index 900168493c43..e54812e44afb 100644 --- a/clients/client-ecs/src/commands/DeregisterContainerInstanceCommand.ts +++ b/clients/client-ecs/src/commands/DeregisterContainerInstanceCommand.ts @@ -30,19 +30,18 @@ export interface DeregisterContainerInstanceCommandOutput __MetadataBearer {} /** - *Deregisters an Amazon ECS container instance from the specified cluster. This instance is - * no longer available to run tasks.
- *If you intend to use the container instance for some other purpose after - * deregistration, we recommend that you stop all of the tasks running on the container - * instance before deregistration. That prevents any orphaned tasks from consuming - * resources.
- *Deregistering a container instance removes the instance from a cluster, but it doesn't - * terminate the EC2 instance. If you are finished using the instance, be sure to terminate - * it in the Amazon EC2 console to stop billing.
+ *Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer + * available to run tasks.
+ *If you intend to use the container instance for some other purpose after deregistration, we recommend + * that you stop all of the tasks running on the container instance before deregistration. That prevents + * any orphaned tasks from consuming resources.
+ *Deregistering a container instance removes the instance from a cluster, but it doesn't terminate the + * EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to + * stop billing.
*If you terminate a running container instance, Amazon ECS automatically deregisters the - * instance from your cluster (stopped container instances or instances with - * disconnected agents aren't automatically deregistered when terminated).
+ *If you terminate a running container instance, Amazon ECS automatically deregisters the instance from + * your cluster (stopped container instances or instances with disconnected agents aren't + * automatically deregistered when terminated).
*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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
* * @throws {@link InvalidParameterException} (client fault) - *The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
diff --git a/clients/client-ecs/src/commands/DeregisterTaskDefinitionCommand.ts b/clients/client-ecs/src/commands/DeregisterTaskDefinitionCommand.ts index d1a2cffd4c9d..159e26221c3e 100644 --- a/clients/client-ecs/src/commands/DeregisterTaskDefinitionCommand.ts +++ b/clients/client-ecs/src/commands/DeregisterTaskDefinitionCommand.ts @@ -28,24 +28,23 @@ export interface DeregisterTaskDefinitionCommandInput extends DeregisterTaskDefi export interface DeregisterTaskDefinitionCommandOutput extends DeregisterTaskDefinitionResponse, __MetadataBearer {} /** - *Deregisters the specified task definition by family and revision. Upon deregistration,
- * the task definition is marked as INACTIVE. Existing tasks and services that
- * reference an INACTIVE task definition continue to run without disruption.
- * Existing services that reference an INACTIVE task definition can still
- * scale up or down by modifying the service's desired count. If you want to delete a task
- * definition revision, you must first deregister the task definition revision.
You can't use an INACTIVE task definition to run new tasks or create new
- * services, and you can't update an existing service to reference an INACTIVE
- * task definition. However, there may be up to a 10-minute window following deregistration
- * where these restrictions have not yet taken effect.
Deregisters the specified task definition by family and revision. Upon deregistration, the task
+ * definition is marked as INACTIVE. Existing tasks and services that reference an
+ * INACTIVE task definition continue to run without disruption. Existing services that
+ * reference an INACTIVE task definition can still scale up or down by modifying the
+ * service's desired count. If you want to delete a task definition revision, you must first deregister
+ * the task definition revision.
You can't use an INACTIVE task definition to run new tasks or create new services, and
+ * you can't update an existing service to reference an INACTIVE task definition. However,
+ * there may be up to a 10-minute window following deregistration where these restrictions have not yet
+ * taken effect.
At this time, INACTIVE task definitions remain discoverable in your
- * account indefinitely. However, this behavior is subject to change in the future. We
- * don't recommend that you rely on INACTIVE task definitions persisting
- * beyond the lifecycle of any associated tasks and services.
At this time, INACTIVE task definitions remain discoverable in your account
+ * indefinitely. However, this behavior is subject to change in the future. We don't recommend that
+ * you rely on INACTIVE task definitions persisting beyond the lifecycle of any
+ * associated tasks and services.
You must deregister a task definition revision before you delete it. For more - * information, see DeleteTaskDefinitions.
+ *You must deregister a task definition revision before you delete it. For more information, see DeleteTaskDefinitions.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -339,23 +338,21 @@ export interface DeregisterTaskDefinitionCommandOutput extends DeregisterTaskDef * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
diff --git a/clients/client-ecs/src/commands/DescribeCapacityProvidersCommand.ts b/clients/client-ecs/src/commands/DescribeCapacityProvidersCommand.ts index c2cdba02c44c..cdba7b7e189f 100644 --- a/clients/client-ecs/src/commands/DescribeCapacityProvidersCommand.ts +++ b/clients/client-ecs/src/commands/DescribeCapacityProvidersCommand.ts @@ -94,23 +94,21 @@ export interface DescribeCapacityProvidersCommandOutput extends DescribeCapacity * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
diff --git a/clients/client-ecs/src/commands/DescribeClustersCommand.ts b/clients/client-ecs/src/commands/DescribeClustersCommand.ts index 65a3cae0836a..7472aa263c37 100644 --- a/clients/client-ecs/src/commands/DescribeClustersCommand.ts +++ b/clients/client-ecs/src/commands/DescribeClustersCommand.ts @@ -137,23 +137,21 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse, * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
diff --git a/clients/client-ecs/src/commands/DescribeContainerInstancesCommand.ts b/clients/client-ecs/src/commands/DescribeContainerInstancesCommand.ts index 48efb587ce6e..08ac0787db7f 100644 --- a/clients/client-ecs/src/commands/DescribeContainerInstancesCommand.ts +++ b/clients/client-ecs/src/commands/DescribeContainerInstancesCommand.ts @@ -28,8 +28,8 @@ export interface DescribeContainerInstancesCommandInput extends DescribeContaine export interface DescribeContainerInstancesCommandOutput extends DescribeContainerInstancesResponse, __MetadataBearer {} /** - *Describes one or more container instances. Returns metadata about each container - * instance requested.
+ *Describes one or more container instances. Returns metadata about each container instance + * requested.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -148,17 +148,16 @@ export interface DescribeContainerInstancesCommandOutput extends DescribeContain * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
* * @throws {@link InvalidParameterException} (client fault) - *The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
diff --git a/clients/client-ecs/src/commands/DescribeServiceDeploymentsCommand.ts b/clients/client-ecs/src/commands/DescribeServiceDeploymentsCommand.ts index f1a55be5a23e..b8ab190a0781 100644 --- a/clients/client-ecs/src/commands/DescribeServiceDeploymentsCommand.ts +++ b/clients/client-ecs/src/commands/DescribeServiceDeploymentsCommand.ts @@ -127,17 +127,16 @@ export interface DescribeServiceDeploymentsCommandOutput extends DescribeService *You don't have authorization to perform the requested action.
* * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
* * @throws {@link InvalidParameterException} (client fault) - *The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
* * @throws {@link ServiceNotFoundException} (client fault) - *The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region - * specific.
+ *The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
* * @throws {@link UnsupportedFeatureException} (client fault) *The specified task isn't supported in this Region.
diff --git a/clients/client-ecs/src/commands/DescribeServiceRevisionsCommand.ts b/clients/client-ecs/src/commands/DescribeServiceRevisionsCommand.ts index c07f6dd2525d..22d230a76c76 100644 --- a/clients/client-ecs/src/commands/DescribeServiceRevisionsCommand.ts +++ b/clients/client-ecs/src/commands/DescribeServiceRevisionsCommand.ts @@ -170,6 +170,13 @@ export interface DescribeServiceRevisionsCommandOutput extends DescribeServiceRe * // kmsKeyId: "STRING_VALUE", * // }, * // createdAt: new Date("TIMESTAMP"), + * // vpcLatticeConfigurations: [ // VpcLatticeConfigurations + * // { // VpcLatticeConfiguration + * // roleArn: "STRING_VALUE", // required + * // targetGroupArn: "STRING_VALUE", // required + * // portName: "STRING_VALUE", // required + * // }, + * // ], * // }, * // ], * // failures: [ // Failures @@ -193,17 +200,16 @@ export interface DescribeServiceRevisionsCommandOutput extends DescribeServiceRe *You don't have authorization to perform the requested action.
* * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
* * @throws {@link InvalidParameterException} (client fault) - *The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
* * @throws {@link ServiceNotFoundException} (client fault) - *The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region - * specific.
+ *The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
* * @throws {@link UnsupportedFeatureException} (client fault) *The specified task isn't supported in this Region.
diff --git a/clients/client-ecs/src/commands/DescribeServicesCommand.ts b/clients/client-ecs/src/commands/DescribeServicesCommand.ts index cad71aa3d9ba..98647bf8842a 100644 --- a/clients/client-ecs/src/commands/DescribeServicesCommand.ts +++ b/clients/client-ecs/src/commands/DescribeServicesCommand.ts @@ -278,6 +278,13 @@ export interface DescribeServicesCommandOutput extends DescribeServicesResponse, * // fargateEphemeralStorage: { * // kmsKeyId: "STRING_VALUE", * // }, + * // vpcLatticeConfigurations: [ // VpcLatticeConfigurations + * // { // VpcLatticeConfiguration + * // roleArn: "STRING_VALUE", // required + * // targetGroupArn: "STRING_VALUE", // required + * // portName: "STRING_VALUE", // required + * // }, + * // ], * // }, * // ], * // roleArn: "STRING_VALUE", @@ -338,17 +345,16 @@ export interface DescribeServicesCommandOutput extends DescribeServicesResponse, * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
* * @throws {@link InvalidParameterException} (client fault) - *The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
diff --git a/clients/client-ecs/src/commands/DescribeTaskDefinitionCommand.ts b/clients/client-ecs/src/commands/DescribeTaskDefinitionCommand.ts index 3197cdbcac33..91e2bb426525 100644 --- a/clients/client-ecs/src/commands/DescribeTaskDefinitionCommand.ts +++ b/clients/client-ecs/src/commands/DescribeTaskDefinitionCommand.ts @@ -28,13 +28,12 @@ export interface DescribeTaskDefinitionCommandInput extends DescribeTaskDefiniti export interface DescribeTaskDefinitionCommandOutput extends DescribeTaskDefinitionResponse, __MetadataBearer {} /** - *Describes a task definition. You can specify a family and
- * revision to find information about a specific task definition, or you
- * can simply specify the family to find the latest ACTIVE revision in that
- * family.
Describes a task definition. You can specify a family and revision to find
+ * information about a specific task definition, or you can simply specify the family to find the latest
+ * ACTIVE revision in that family.
You can only describe INACTIVE task definitions while an active task
- * or service references them.
You can only describe INACTIVE task definitions while an active task or service
+ * references them.
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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
diff --git a/clients/client-ecs/src/commands/DescribeTaskSetsCommand.ts b/clients/client-ecs/src/commands/DescribeTaskSetsCommand.ts index 688bdf252f37..f4645703369b 100644 --- a/clients/client-ecs/src/commands/DescribeTaskSetsCommand.ts +++ b/clients/client-ecs/src/commands/DescribeTaskSetsCommand.ts @@ -28,9 +28,8 @@ export interface DescribeTaskSetsCommandInput extends DescribeTaskSetsRequest {} export interface DescribeTaskSetsCommandOutput extends DescribeTaskSetsResponse, __MetadataBearer {} /** - *Describes the task sets in the specified cluster and service. This is used when a
- * service uses the Describes the task sets in the specified cluster and service. This is used when a service uses the
+ * You don't have authorization to perform the requested action. 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. 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. The following list includes additional causes for the error: The The The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. The specified service isn't active. You can't update a service that's inactive. If you
- * have previously deleted a service, you can re-create it with CreateService. The specified service isn't active. You can't update a service that's inactive. If you have
+ * previously deleted a service, you can re-create it with CreateService. The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region
- * specific. The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific. The specified task isn't supported in this Region. Describes a specified task or tasks. Currently, stopped tasks appear in the returned results for at least one hour. If you have tasks with tags, and then delete the cluster, the tagged tasks are
- * returned in the response. If you create a new cluster with the same name as the deleted
- * cluster, the tagged tasks are not included in the response. If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the
+ * response. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are
+ * not included in the response. 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. 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. The following list includes additional causes for the error: The The The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. 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. 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. The following list includes additional causes for the error: The The Runs a command remotely on a container within a task. If you use a condition key in your IAM policy to refine the conditions for the
- * policy statement, for example limit the actions to a specific cluster, you receive an
- * For information about required permissions and considerations, see Using Amazon ECS
- * Exec for debugging in the Amazon ECS Developer Guide.
- * If you use a condition key in your IAM policy to refine the conditions for the policy statement,
+ * for example limit the actions to a specific cluster, you receive an For information about required permissions and considerations, see Using Amazon ECS Exec for debugging in the
+ * Amazon ECS Developer Guide. You don't have authorization to perform the requested action. 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. 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. The following list includes additional causes for the error: The The The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. The execute command cannot run. This error can be caused by any of the following
- * configuration issues: The execute command cannot run. This error can be caused by any of the following configuration
+ * issues: Incorrect IAM permissions The SSM agent is not installed or is not running There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for
- * Systems Manager Session Manager There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for Systems
+ * Manager Session Manager For information about how to troubleshoot the issues, see Troubleshooting issues with ECS
- * Exec in the Amazon Elastic Container Service Developer Guide. For information about how to troubleshoot the issues, see Troubleshooting issues with ECS Exec in
+ * the Amazon Elastic Container Service Developer Guide. Base exception class for all service exceptions from ECS service. You don't have authorization to perform the requested action. 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. 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. The following list includes additional causes for the error: The The The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. The specified resource wasn't found. 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. 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. The following list includes additional causes for the error: The The The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. Lists the attributes for Amazon ECS resources within a specified target type and cluster.
- * When you specify a target type and cluster, Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify
+ * a target type and cluster, The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. Base exception class for all service exceptions from ECS service. 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. 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. The following list includes additional causes for the error: The The The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. Returns a list of container instances in a specified cluster. You can filter the
- * results of a Returns a list of container instances in a specified cluster. You can filter the results of a
+ * 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. 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. The following list includes additional causes for the error: The The The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. You don't have authorization to perform the requested action. 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. 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. The following list includes additional causes for the error: The The The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region
- * specific. The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific. The specified task isn't supported in this Region. This operation lists all of the services that are associated with a Cloud Map
- * namespace. This list might include services in different clusters. In contrast,
- * This operation lists all of the services that are associated with a Cloud Map namespace. This list
+ * might include services in different clusters. In contrast, 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. 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. The following list includes additional causes for the error: The The The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. The specified namespace wasn't found. Returns a list of services. You can filter the results by cluster, launch type, and
- * scheduling strategy. Returns a list of services. You can filter the results by cluster, launch type, and scheduling
+ * strategy. 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. 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. The following list includes additional causes for the error: The The The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. 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. 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. The following list includes additional causes for the error: The The The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. Returns a list of task definition families that are registered to your account. This
- * list includes task definition families that no longer have any You can filter out task definition families that don't contain any Returns a list of task definition families that are registered to your account. This list includes
+ * task definition families that no longer have any You can filter out task definition families that don't contain any 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. 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. The following list includes additional causes for the error: The The The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. Returns a list of task definitions that are registered to your account. You can filter
- * the results by family name with the Returns a list of task definitions that are registered to your account. You can filter the results by
+ * family name with the 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. 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. The following list includes additional causes for the error: The The The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. Returns a list of tasks. You can filter the results by cluster, task definition
- * family, container instance, launch type, what IAM principal started the task, or by
- * the desired status of the task. Returns a list of tasks. You can filter the results by cluster, task definition family, container
+ * instance, launch type, what IAM principal started the task, or by the desired status of the
+ * task. Recently stopped tasks might appear in the returned results. 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. 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. The following list includes additional causes for the error: The The The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region
- * specific. The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific. Base exception class for all service exceptions from ECS service. Modifies an account setting. Account settings are set on a per-Region basis. If you change the root user account setting, the default settings are reset for users and
- * roles that do not have specified individual account settings. For more information, see
- * Account
- * Settings in the Amazon Elastic Container Service Developer Guide. If you change the root user account setting, the default settings are reset for users and roles that do
+ * not have specified individual account settings. For more information, see Account Settings in the
+ * Amazon Elastic Container Service Developer Guide. 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. 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. The following list includes additional causes for the error: The The The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. Modifies an account setting for all users on an account for whom no individual account
- * setting has been specified. Account settings are set on a per-Region basis. Modifies an account setting for all users on an account for whom no individual account setting has
+ * been specified. Account settings are set on a per-Region basis. 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. 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. The following list includes additional causes for the error: The The The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist,
- * it's created. If the attribute exists, its value is replaced with the specified value.
- * To delete an attribute, use DeleteAttributes. For more information,
- * see Attributes in the Amazon Elastic Container Service Developer Guide. Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, it's created. If
+ * the attribute exists, its value is replaced with the specified value. To delete an attribute, use
+ * DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide. You can apply up to 10 custom attributes for each resource. You can view the
- * attributes of a resource with ListAttributes. You can remove existing
- * attributes on a resource with DeleteAttributes. You can apply up to 10 custom attributes for each resource. You can view the attributes of a resource
+ * with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes. The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. The specified target wasn't found. You can view your available container instances
- * with ListContainerInstances. Amazon ECS container instances are cluster-specific and
+ * The specified target wasn't found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and
* Region-specific. Modifies the available capacity providers and the default capacity provider strategy
- * for a cluster. You must specify both the available capacity providers and a default capacity provider
- * strategy for the cluster. If the specified cluster has existing capacity providers
- * associated with it, you must specify all existing capacity providers in addition to any
- * new ones you want to add. Any existing capacity providers that are associated with a
- * cluster that are omitted from a PutClusterCapacityProviders API call
- * will be disassociated with the cluster. You can only disassociate an existing capacity
- * provider from a cluster if it's not being used by any existing tasks. When creating a service or running a task on a cluster, if no capacity provider or
- * launch type is specified, then the cluster's default capacity provider strategy is used.
- * We recommend that you define a default capacity provider strategy for your cluster.
- * However, you must specify an empty array ( Modifies the available capacity providers and the default capacity provider strategy for a
+ * cluster. You must specify both the available capacity providers and a default capacity provider strategy for
+ * the cluster. If the specified cluster has existing capacity providers associated with it, you must
+ * specify all existing capacity providers in addition to any new ones you want to add. Any existing
+ * capacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only
+ * disassociate an existing capacity provider from a cluster if it's not being used by any existing
+ * tasks. When creating a service or running a task on a cluster, if no capacity provider or launch type is
+ * specified, then the cluster's default capacity provider strategy is used. We recommend that you define
+ * a default capacity provider strategy for your cluster. However, you must specify an empty array
+ * ( 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. 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. The following list includes additional causes for the error: The The The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. The specified resource is in-use and can't be removed. These errors are usually caused by a server issue. 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 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
+ * Base exception class for all service exceptions from ECS service. This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent. Registers an EC2 instance into the specified cluster. This instance becomes available
- * to place containers on. Registers an EC2 instance into the specified cluster. This instance becomes available to place
+ * containers on. 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. 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. The following list includes additional causes for the error: The The The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. Registers a new task definition from the supplied You can specify a role for your task with the You can specify a Docker networking mode for the containers in your task definition
- * with the You can specify a role for your task with the You can specify a Docker networking mode for the containers in your task definition with the
+ * 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. 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. The following list includes additional causes for the error: The The The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. Amazon Elastic Inference (EI) is no longer available to customers. You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places
- * tasks using placement constraints and placement strategies. For more information, see
- * Scheduling Tasks in the Amazon Elastic Container Service Developer Guide. Alternatively, you can use You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or
- * updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. The Amazon ECS API follows an eventual consistency model. This is because of the
- * distributed nature of the system supporting the API. This means that the result of an
- * API command you run that affects your Amazon ECS resources might not be immediately visible
- * to all subsequent commands you run. Keep this in mind when you carry out an API command
- * that immediately follows a previous API command. You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using
+ * placement constraints and placement strategies. For more information, see Scheduling
+ * Tasks in the Amazon Elastic Container Service Developer Guide. Alternatively, you can use You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a
+ * service. For more infomation, see Amazon EBS
+ * volumes in the Amazon Elastic Container Service Developer Guide. The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the
+ * system supporting the API. This means that the result of an API command you run that affects your Amazon ECS
+ * resources might not be immediately visible to all subsequent commands you run. Keep this in mind when
+ * you carry out an API command that immediately follows a previous API command. To manage eventual consistency, you can do the following: Confirm the state of the resource before you run a command to modify it. Run
- * the DescribeTasks command using an exponential backoff algorithm to ensure that
- * you allow enough time for the previous command to propagate through the system.
- * To do this, run the DescribeTasks command repeatedly, starting with a couple of
- * seconds of wait time and increasing gradually up to five minutes of wait
- * time. Confirm the state of the resource before you run a command to modify it. Run the
+ * DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough
+ * time for the previous command to propagate through the system. To do this, run the
+ * DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing
+ * gradually up to five minutes of wait time. Add wait time between subsequent commands, even if the DescribeTasks command
- * returns an accurate response. Apply an exponential backoff algorithm starting
- * with a couple of seconds of wait time, and increase gradually up to about five
- * minutes of wait time. Add wait time between subsequent commands, even if the DescribeTasks command returns an
+ * accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of
+ * wait time, and increase gradually up to about five minutes of wait time.EXTERNAL deployment controller type. For more information,
- * see Amazon ECS Deployment
+ * EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment
* Types in the Amazon Elastic Container Service Developer Guide.
*
*
@@ -159,19 +157,17 @@ export interface DescribeTaskSetsCommandOutput extends DescribeTaskSetsResponse,
* RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
*
*
@@ -249,8 +248,7 @@ export interface DescribeTasksCommandOutput extends DescribeTasksResponse, __Met
* RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
*
*
diff --git a/clients/client-ecs/src/commands/ExecuteCommandCommand.ts b/clients/client-ecs/src/commands/ExecuteCommandCommand.ts
index 5f967859a528..7a357669843b 100644
--- a/clients/client-ecs/src/commands/ExecuteCommandCommand.ts
+++ b/clients/client-ecs/src/commands/ExecuteCommandCommand.ts
@@ -33,13 +33,11 @@ export interface ExecuteCommandCommandOutput extends ExecuteCommandResponse, __M
/**
* RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.AccessDeniedException when there is a mismatch between the condition
- * key value and the corresponding parameter value.AccessDeniedException
+ * when there is a mismatch between the condition key value and the corresponding parameter value.
*
*
@@ -98,15 +95,14 @@ export interface ExecuteCommandCommandOutput extends ExecuteCommandResponse, __M
* RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
*
- *
*
*
@@ -90,8 +89,7 @@ export interface GetTaskProtectionCommandOutput extends GetTaskProtectionRespons
* RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
*
*
* @throws {@link InvalidParameterException} (client fault)
- * RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.ListAttributes returns a list
- * of attribute objects, one for each attribute on each resource. You can filter the list
- * of results to a single attribute name to only return results that have that name. You
- * can also filter the results by attribute name and value. You can do this, for example,
- * to see which container instances in a cluster are running a Linux AMI
+ * ListAttributes returns a list of attribute objects, one for
+ * each attribute on each resource. You can filter the list of results to a single attribute name to only
+ * return results that have that name. You can also filter the results by attribute name and value. You
+ * can do this, for example, to see which container instances in a cluster are running a Linux AMI
* (ecs.os-type=linux).
*
*
* @throws {@link InvalidParameterException} (client fault)
- * RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.ListContainerInstances operation with cluster query language
- * statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.ListContainerInstances operation with cluster query language statements inside the
+ * filter parameter. For more information, see Cluster
+ * Query Language in the Amazon Elastic Container Service Developer Guide.
*
*
@@ -80,8 +80,7 @@ export interface ListContainerInstancesCommandOutput extends ListContainerInstan
* RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
*
*
* @throws {@link InvalidParameterException} (client fault)
- * RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.ListServices can only list services in one cluster at a time. If you
- * need to filter the list of services in a single cluster by various parameters, use
- * ListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.ListServices can only list
+ * services in one cluster at a time. If you need to filter the list of services in a single cluster by
+ * various parameters, use ListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
*
*
* @throws {@link InvalidParameterException} (client fault)
- * RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
*
*
@@ -79,8 +78,7 @@ export interface ListServicesCommandOutput extends ListServicesResponse, __Metad
* RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
*
*
@@ -76,8 +75,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
* RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.ACTIVE task
- * definition revisions.ACTIVE
- * task definition revisions by setting the status parameter to
- * ACTIVE. You can also filter the results with the
- * familyPrefix parameter.ACTIVE task definition revisions.ACTIVE task
+ * definition revisions by setting the status parameter to ACTIVE. You can also
+ * filter the results with the familyPrefix parameter.
*
*
* @throws {@link InvalidParameterException} (client fault)
- * RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.familyPrefix parameter or by status
- * with the status parameter.familyPrefix parameter or by status with the status
+ * parameter.
*
*
* @throws {@link InvalidParameterException} (client fault)
- * RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
*
*
@@ -85,15 +84,13 @@ export interface ListTasksCommandOutput extends ListTasksResponse, __MetadataBea
* RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
*
*
* @throws {@link InvalidParameterException} (client fault)
- * RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
*
*
* @throws {@link InvalidParameterException} (client fault)
- * RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.[]) to bypass defining a default
- * strategy.[]) to bypass defining a default strategy.
*
*
@@ -166,8 +163,7 @@ export interface PutClusterCapacityProvidersCommandOutput
* RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.PENDING or STAGING, the update
- * process can get stuck in that state. However, when the agent reconnects, it resumes
- * where it stopped previously.PENDING or STAGING, the update process can get stuck in that state.
+ * However, when the agent reconnects, it resumes where it stopped previously.
*
*
* @throws {@link InvalidParameterException} (client fault)
- * RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.family and
- * containerDefinitions. Optionally, you can add data volumes to your
- * containers with the volumes parameter. For more information about task
- * definition parameters and defaults, see Amazon ECS Task
+ * containerDefinitions. Optionally, you can add data volumes to your containers with the
+ * volumes parameter. For more information about task definition parameters and defaults,
+ * see Amazon ECS Task
* Definitions in the Amazon Elastic Container Service Developer Guide.taskRoleArn parameter. When
- * you specify a role for a task, its containers can then use the latest versions of the
- * CLI or SDKs to make API requests to the Amazon Web Services services that are specified in the
- * policy that's associated with the role. For more information, see IAM
- * Roles for Tasks in the Amazon Elastic Container Service Developer Guide.networkMode parameter. If you specify the awsvpc
- * network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with
- * the task definition. For more information, see Task Networking
- * in the Amazon Elastic Container Service Developer Guide.taskRoleArn parameter. When you specify a
+ * role for a task, its containers can then use the latest versions of the CLI or SDKs to make API
+ * requests to the Amazon Web Services services that are specified in the policy that's associated with the role. For
+ * more information, see IAM Roles for Tasks in the
+ * Amazon Elastic Container Service Developer Guide.networkMode parameter. If you specify the awsvpc network mode, the task
+ * is allocated an elastic network interface, and you must specify a NetworkConfiguration when
+ * you create a service or run a task with the task definition. For more information, see Task
+ * Networking in the Amazon Elastic Container Service Developer Guide.
*
*
* @throws {@link InvalidParameterException} (client fault)
- * RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.StartTask to use your own scheduler or
- * place tasks manually on specific container instances.StartTask to use your own scheduler or place tasks manually
+ * on specific container instances.
*
* @example
@@ -385,17 +383,16 @@ export interface RunTaskCommandOutput extends RunTaskResponse, __MetadataBearer
* Amazon Web Services Support.
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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The RunTask request could not be processed due to conflicts. The provided
- * clientToken is already in use with a different RunTask
- * request. The resourceIds are the existing task ARNs which are already
- * associated with the clientToken.
clientToken is already in use with a different RunTask request. The
+ * resourceIds are the existing task ARNs which are already associated with the
+ * clientToken.
* To fix this issue:
*Run RunTask with a unique clientToken.
Run RunTask with the clientToken and the original
- * set of parameters
Run RunTask with the clientToken and the original set of
+ * parameters
The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link PlatformTaskDefinitionIncompatibilityException} (client fault) *The specified platform version doesn't satisfy the required capabilities of the task diff --git a/clients/client-ecs/src/commands/StartTaskCommand.ts b/clients/client-ecs/src/commands/StartTaskCommand.ts index f1672c672037..6c749d9a438d 100644 --- a/clients/client-ecs/src/commands/StartTaskCommand.ts +++ b/clients/client-ecs/src/commands/StartTaskCommand.ts @@ -28,18 +28,20 @@ export interface StartTaskCommandInput extends StartTaskRequest {} export interface StartTaskCommandOutput extends StartTaskResponse, __MetadataBearer {} /** - *
Starts a new task from the specified task definition on the specified container - * instance or instances.
+ *Starts a new task from the specified task definition on the specified container instance or + * instances.
*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.
*Amazon Elastic Inference (EI) is no longer available to customers.
*Alternatively, you can useRunTask to place tasks for you. For more
- * information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or - * updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
+ *Alternatively, you can useRunTask to place tasks for you. For more information, see
+ * Scheduling
+ * Tasks in the Amazon Elastic Container Service Developer Guide.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a + * service. For more infomation, see Amazon EBS + * volumes in the Amazon Elastic Container Service Developer Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -332,17 +334,16 @@ export interface StartTaskCommandOutput extends StartTaskResponse, __MetadataBea * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
* * @throws {@link InvalidParameterException} (client fault) - *The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
diff --git a/clients/client-ecs/src/commands/StopTaskCommand.ts b/clients/client-ecs/src/commands/StopTaskCommand.ts index af3695ef64ac..c143c3d3bdf0 100644 --- a/clients/client-ecs/src/commands/StopTaskCommand.ts +++ b/clients/client-ecs/src/commands/StopTaskCommand.ts @@ -29,20 +29,18 @@ export interface StopTaskCommandOutput extends StopTaskResponse, __MetadataBeare /** *Stops a running task. Any tags associated with the task will be deleted.
- *When you call StopTask on a task, the equivalent of docker
- * stop is issued to the containers running in the task. This results in a
- * SIGTERM value and a default 30-second timeout, after which the
- * SIGKILL value is sent and the containers are forcibly stopped. If the
- * container handles the SIGTERM value gracefully and exits within 30 seconds
+ *
When you call StopTask on a task, the equivalent of docker stop is issued
+ * to the containers running in the task. This results in a SIGTERM value and a default
+ * 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly
+ * stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds
* from receiving it, no SIGKILL value is sent.
For Windows containers, POSIX signals do not work and runtime stops the container by
- * sending a CTRL_SHUTDOWN_EVENT. For more information, see Unable to react to graceful shutdown
- * of (Windows) container #25982 on GitHub.
For Windows containers, POSIX signals do not work and runtime stops the container by sending a
+ * CTRL_SHUTDOWN_EVENT. For more information, see Unable to react to graceful shutdown of (Windows)
+ * container #25982 on GitHub.
The default 30-second timeout can be configured on the Amazon ECS container agent with
- * the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see
- * Amazon ECS Container Agent Configuration in the
- * Amazon Elastic Container Service Developer Guide.
The default 30-second timeout can be configured on the Amazon ECS container agent with the
+ * ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS
+ * Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
* * @throws {@link InvalidParameterException} (client fault) - *The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
diff --git a/clients/client-ecs/src/commands/SubmitAttachmentStateChangesCommand.ts b/clients/client-ecs/src/commands/SubmitAttachmentStateChangesCommand.ts index 3002878208b8..8c2c77bfe299 100644 --- a/clients/client-ecs/src/commands/SubmitAttachmentStateChangesCommand.ts +++ b/clients/client-ecs/src/commands/SubmitAttachmentStateChangesCommand.ts @@ -70,23 +70,21 @@ export interface SubmitAttachmentStateChangesCommandOutput *You don't have authorization to perform the requested action.
* * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
diff --git a/clients/client-ecs/src/commands/SubmitContainerStateChangeCommand.ts b/clients/client-ecs/src/commands/SubmitContainerStateChangeCommand.ts index 80b800400f9a..27530e621fda 100644 --- a/clients/client-ecs/src/commands/SubmitContainerStateChangeCommand.ts +++ b/clients/client-ecs/src/commands/SubmitContainerStateChangeCommand.ts @@ -75,17 +75,16 @@ export interface SubmitContainerStateChangeCommandOutput extends SubmitContainer *You don't have authorization to perform the requested action.
* * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
You don't have authorization to perform the requested action.
* * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
diff --git a/clients/client-ecs/src/commands/TagResourceCommand.ts b/clients/client-ecs/src/commands/TagResourceCommand.ts index 9893a154eed9..d2e0293e3fc4 100644 --- a/clients/client-ecs/src/commands/TagResourceCommand.ts +++ b/clients/client-ecs/src/commands/TagResourceCommand.ts @@ -28,10 +28,9 @@ export interface TagResourceCommandInput extends TagResourceRequest {} export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {} /** - *Associates the specified tags to a resource with the specified
- * resourceArn. If existing tags on a resource aren't specified in the
- * request parameters, they aren't changed. When a resource is deleted, the tags that are
- * associated with that resource are deleted as well.
Associates the specified tags to a resource with the specified resourceArn. If existing
+ * tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is
+ * deleted, the tags that are associated with that resource are deleted as well.
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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
* * @throws {@link InvalidParameterException} (client fault) - *The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ResourceNotFoundException} (client fault) *The specified resource wasn't found.
diff --git a/clients/client-ecs/src/commands/UntagResourceCommand.ts b/clients/client-ecs/src/commands/UntagResourceCommand.ts index 83a624132d18..41b42f52db54 100644 --- a/clients/client-ecs/src/commands/UntagResourceCommand.ts +++ b/clients/client-ecs/src/commands/UntagResourceCommand.ts @@ -54,17 +54,16 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
* * @throws {@link InvalidParameterException} (client fault) - *The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ResourceNotFoundException} (client fault) *The specified resource wasn't found.
diff --git a/clients/client-ecs/src/commands/UpdateCapacityProviderCommand.ts b/clients/client-ecs/src/commands/UpdateCapacityProviderCommand.ts index e42cb88dc451..70d14b0bd742 100644 --- a/clients/client-ecs/src/commands/UpdateCapacityProviderCommand.ts +++ b/clients/client-ecs/src/commands/UpdateCapacityProviderCommand.ts @@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ECSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECSClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateCapacityProviderRequest, UpdateCapacityProviderResponse } from "../models/models_0"; +import { UpdateCapacityProviderRequest } from "../models/models_0"; +import { UpdateCapacityProviderResponse } from "../models/models_1"; import { de_UpdateCapacityProviderCommand, se_UpdateCapacityProviderCommand } from "../protocols/Aws_json1_1"; /** @@ -88,23 +89,21 @@ export interface UpdateCapacityProviderCommandOutput extends UpdateCapacityProvi * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
diff --git a/clients/client-ecs/src/commands/UpdateClusterCommand.ts b/clients/client-ecs/src/commands/UpdateClusterCommand.ts index 2b4ccea3ad13..b93d0b9cde7c 100644 --- a/clients/client-ecs/src/commands/UpdateClusterCommand.ts +++ b/clients/client-ecs/src/commands/UpdateClusterCommand.ts @@ -149,17 +149,16 @@ export interface UpdateClusterCommandOutput extends UpdateClusterResponse, __Met * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
* * @throws {@link InvalidParameterException} (client fault) - *The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link NamespaceNotFoundException} (client fault) *The specified namespace wasn't found.
diff --git a/clients/client-ecs/src/commands/UpdateClusterSettingsCommand.ts b/clients/client-ecs/src/commands/UpdateClusterSettingsCommand.ts index 06ffe09cb43c..af02d86bba2f 100644 --- a/clients/client-ecs/src/commands/UpdateClusterSettingsCommand.ts +++ b/clients/client-ecs/src/commands/UpdateClusterSettingsCommand.ts @@ -129,17 +129,16 @@ export interface UpdateClusterSettingsCommandOutput extends UpdateClusterSetting * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape. * * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
* * @throws {@link InvalidParameterException} (client fault) - *The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
diff --git a/clients/client-ecs/src/commands/UpdateContainerAgentCommand.ts b/clients/client-ecs/src/commands/UpdateContainerAgentCommand.ts index 0eb1dd6067f0..e2bf9f594dfb 100644 --- a/clients/client-ecs/src/commands/UpdateContainerAgentCommand.ts +++ b/clients/client-ecs/src/commands/UpdateContainerAgentCommand.ts @@ -28,25 +28,25 @@ export interface UpdateContainerAgentCommandInput extends UpdateContainerAgentRe export interface UpdateContainerAgentCommandOutput extends UpdateContainerAgentResponse, __MetadataBearer {} /** - *Updates the Amazon ECS container agent on a specified container instance. Updating the - * Amazon ECS container agent doesn't interrupt running tasks or services on the container - * instance. The process for updating the agent differs depending on whether your container - * instance was launched with the Amazon ECS-optimized AMI or another operating system.
+ *Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container + * agent doesn't interrupt running tasks or services on the container instance. The process for updating + * the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized + * AMI or another operating system.
*The UpdateContainerAgent API isn't supported for container instances
- * using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent,
- * you can update the ecs-init package. This updates the agent. For more
- * information, see Updating the
- * Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.
The UpdateContainerAgent API isn't supported for container instances using the
+ * Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the
+ * ecs-init package. This updates the agent. For more information, see Updating
+ * the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.
Agent updates with the UpdateContainerAgent API operation do not
- * apply to Windows container instances. We recommend that you launch new container
- * instances to update the agent version in your Windows clusters.
Agent updates with the UpdateContainerAgent API operation do not apply to Windows
+ * container instances. We recommend that you launch new container instances to update the agent
+ * version in your Windows clusters.
The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon
- * Linux AMI with the ecs-init service installed and running. For help
- * updating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.
The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon Linux AMI with
+ * the ecs-init service installed and running. For help updating the Amazon ECS container agent on
+ * other operating systems, see Manually updating
+ * the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.
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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
* * @throws {@link InvalidParameterException} (client fault) - *The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link MissingVersionException} (client fault) - *Amazon ECS can't determine the current version of the Amazon ECS container agent on the - * container instance and doesn't have enough information to proceed with an update. This - * could be because the agent running on the container instance is a previous or custom - * version that doesn't use our version information.
+ *Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and + * doesn't have enough information to proceed with an update. This could be because the agent running on + * the container instance is a previous or custom version that doesn't use our version information.
* * @throws {@link NoUpdateAvailableException} (client fault) - *There's no update available for this Amazon ECS container agent. This might be because the - * agent is already running the latest version or because it's so old that there's no - * update path to the current version.
+ *There's no update available for this Amazon ECS container agent. This might be because the agent is + * already running the latest version or because it's so old that there's no update path to the current + * version.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
* * @throws {@link UpdateInProgressException} (client fault) - *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 PENDING or STAGING, the update
- * process can get stuck in that state. However, when the agent reconnects, it resumes
- * where it stopped previously.
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
+ * PENDING or STAGING, the update process can get stuck in that state.
+ * However, when the agent reconnects, it resumes where it stopped previously.
Base exception class for all service exceptions from ECS service.
diff --git a/clients/client-ecs/src/commands/UpdateContainerInstancesStateCommand.ts b/clients/client-ecs/src/commands/UpdateContainerInstancesStateCommand.ts index e42969a0576b..291786de1369 100644 --- a/clients/client-ecs/src/commands/UpdateContainerInstancesStateCommand.ts +++ b/clients/client-ecs/src/commands/UpdateContainerInstancesStateCommand.ts @@ -34,54 +34,50 @@ export interface UpdateContainerInstancesStateCommandOutput /** *Modifies the status of an Amazon ECS container instance.
- *Once a container instance has reached an ACTIVE state, you can change the
- * status of a container instance to DRAINING to manually remove an instance
- * from a cluster, for example to perform system updates, update the Docker daemon, or
- * scale down the cluster size.
Once a container instance has reached an ACTIVE state, you can change the status of a
+ * container instance to DRAINING to manually remove an instance from a cluster, for example
+ * to perform system updates, update the Docker daemon, or scale down the cluster size.
A container instance can't be changed to DRAINING until it has
- * reached an ACTIVE status. If the instance is in any other status, an
- * error will be received.
A container instance can't be changed to DRAINING until it has reached an
+ * ACTIVE status. If the instance is in any other status, an error will be
+ * received.
When you set a container instance to DRAINING, Amazon ECS prevents new tasks
- * from being scheduled for placement on the container instance and replacement service
- * tasks are started on other container instances in the cluster if the resources are
- * available. Service tasks on the container instance that are in the PENDING
- * state are stopped immediately.
Service tasks on the container instance that are in the RUNNING state are
- * stopped and replaced according to the service's deployment configuration parameters,
- * minimumHealthyPercent and maximumPercent. You can change
- * the deployment configuration of your service using UpdateService.
When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being
+ * scheduled for placement on the container instance and replacement service tasks are started on other
+ * container instances in the cluster if the resources are available. Service tasks on the container
+ * instance that are in the PENDING state are stopped immediately.
Service tasks on the container instance that are in the RUNNING state are stopped and
+ * replaced according to the service's deployment configuration parameters,
+ * minimumHealthyPercent and maximumPercent. You can change the deployment
+ * configuration of your service using UpdateService.
If minimumHealthyPercent is below 100%, the scheduler can ignore
* desiredCount temporarily during task replacement. For example,
- * desiredCount is four tasks, a minimum of 50% allows the
- * scheduler to stop two existing tasks before starting two new tasks. If the
- * minimum is 100%, the service scheduler can't remove existing tasks until the
- * replacement tasks are considered healthy. Tasks for services that do not use a
- * load balancer are considered healthy if they're in the RUNNING
- * state. Tasks for services that use a load balancer are considered healthy if
- * they're in the RUNNING state and are reported as healthy by the
- * load balancer.
desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two
+ * existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler
+ * can't remove existing tasks until the replacement tasks are considered healthy. Tasks for
+ * services that do not use a load balancer are considered healthy if they're in the
+ * RUNNING state. Tasks for services that use a load balancer are considered
+ * healthy if they're in the RUNNING state and are reported as healthy by the load
+ * balancer.
* The maximumPercent parameter represents an upper limit on the
- * number of running tasks during task replacement. You can use this to define the
- * replacement batch size. For example, if desiredCount is four tasks,
- * a maximum of 200% starts four new tasks before stopping the four tasks to be
- * drained, provided that the cluster resources required to do this are available.
- * If the maximum is 100%, then replacement tasks can't start until the draining
- * tasks have stopped.
The maximumPercent parameter represents an upper limit on the number of running
+ * tasks during task replacement. You can use this to define the replacement batch size. For
+ * example, if desiredCount is four tasks, a maximum of 200% starts four new tasks
+ * before stopping the four tasks to be drained, provided that the cluster resources required to
+ * do this are available. If the maximum is 100%, then replacement tasks can't start until the
+ * draining tasks have stopped.
Any PENDING or RUNNING tasks that do not belong to a service
- * aren't affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING
- * tasks. You can verify this using ListTasks.
When a container instance has been drained, you can set a container instance to
- * ACTIVE status and once it has reached that status the Amazon ECS scheduler
- * can begin scheduling tasks on the instance again.
Any PENDING or RUNNING tasks that do not belong to a service aren't
+ * affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING tasks. You can
+ * verify this using ListTasks.
When a container instance has been drained, you can set a container instance to ACTIVE
+ * status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the
+ * instance again.
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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
* * @throws {@link InvalidParameterException} (client fault) - *The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link ServerException} (server fault) *These errors are usually caused by a server issue.
diff --git a/clients/client-ecs/src/commands/UpdateServiceCommand.ts b/clients/client-ecs/src/commands/UpdateServiceCommand.ts index 657fd836403e..21dcb7988661 100644 --- a/clients/client-ecs/src/commands/UpdateServiceCommand.ts +++ b/clients/client-ecs/src/commands/UpdateServiceCommand.ts @@ -32,117 +32,111 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met *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.
*For services using the rolling update (ECS) you can update the desired
- * count, deployment configuration, network configuration, load balancers, service
- * registries, enable ECS managed tags option, propagate tags option, task placement
- * constraints and strategies, and task definition. When you update any of these
- * parameters, Amazon ECS starts new tasks with the new configuration.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or
- * running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. You can update
- * your volume configurations and trigger a new deployment.
- * volumeConfigurations is only supported for REPLICA service and not
- * DAEMON service. If you leave volumeConfigurations
- * null, it doesn't trigger a new deployment. For more infomation on volumes,
- * see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
For services using the blue/green (CODE_DEPLOY) deployment controller,
- * only the desired count, deployment configuration, health check grace period, task
- * placement constraints and strategies, enable ECS managed tags option, and propagate tags
- * can be updated using this API. If the network configuration, platform version, task
- * definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more
- * information, see CreateDeployment in the CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired - * count, task placement constraints and strategies, health check grace period, enable ECS - * managed tags option, and propagate tags option, using this API. If the launch type, load - * balancer, network configuration, platform version, or task definition need to be - * updated, create a new task set For more information, see CreateTaskSet.
- *You can add to or subtract from the number of instantiations of a task definition in a
- * service by specifying the cluster that the service is running in and a new
- * desiredCount parameter.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or - * running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
- *If you have updated the container image of your application, you can create a new task - * definition with that image and deploy it to your service. The service scheduler uses the - * minimum healthy percent and maximum percent parameters (in the service's deployment - * configuration) to determine the deployment strategy.
+ *For services using the rolling update (ECS) you can update the desired count, deployment
+ * configuration, network configuration, load balancers, service registries, enable ECS managed tags
+ * option, propagate tags option, task placement constraints and strategies, and task definition. When you
+ * update any of these parameters, Amazon ECS starts new tasks with the new configuration.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a
+ * task, or when creating or updating a service. For more infomation, see Amazon EBS
+ * volumes in the Amazon Elastic Container Service Developer Guide. You can update your volume configurations and trigger a new
+ * deployment. volumeConfigurations is only supported for REPLICA service and not DAEMON
+ * service. If you leave volumeConfigurations
+ * null, it doesn't trigger a new deployment. For more infomation on volumes, see Amazon EBS
+ * volumes in the Amazon Elastic Container Service Developer Guide.
For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired
+ * count, deployment configuration, health check grace period, task placement constraints and strategies,
+ * enable ECS managed tags option, and propagate tags can be updated using this API. If the network
+ * configuration, platform version, task definition, or load balancer need to be updated, create a new
+ * CodeDeploy deployment. For more information, see CreateDeployment in the
+ * CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired count, task + * placement constraints and strategies, health check grace period, enable ECS managed tags option, and + * propagate tags option, using this API. If the launch type, load balancer, network configuration, + * platform version, or task definition need to be updated, create a new task set For more information, + * see CreateTaskSet.
+ *You can add to or subtract from the number of instantiations of a task definition in a service by
+ * specifying the cluster that the service is running in and a new desiredCount
+ * parameter.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a + * task, or when creating or updating a service. For more infomation, see Amazon EBS + * volumes in the Amazon Elastic Container Service Developer Guide.
+ *If you have updated the container image of your application, you can create a new task definition + * with that image and deploy it to your service. The service scheduler uses the minimum healthy percent + * and maximum percent parameters (in the service's deployment configuration) to determine the deployment + * strategy.
*If your updated Docker image uses the same tag as what is in the existing task
- * definition for your service (for example, my_image:latest), you don't
- * need to create a new revision of your task definition. You can update the service
- * using the forceNewDeployment option. The new tasks launched by the
- * deployment pull the current image/tag combination from your repository when they
- * start.
If your updated Docker image uses the same tag as what is in the existing task definition for
+ * your service (for example, my_image:latest), you don't need to create a new revision
+ * of your task definition. You can update the service using the forceNewDeployment
+ * option. The new tasks launched by the deployment pull the current image/tag combination from your
+ * repository when they start.
You can also update the deployment configuration of a service. When a deployment is
- * triggered by updating the task definition of a service, the service scheduler uses the
- * deployment configuration parameters, minimumHealthyPercent and
- * maximumPercent, to determine the deployment strategy.
You can also update the deployment configuration of a service. When a deployment is triggered by
+ * updating the task definition of a service, the service scheduler uses the deployment configuration
+ * parameters, minimumHealthyPercent and maximumPercent, to determine the
+ * deployment strategy.
If minimumHealthyPercent is below 100%, the scheduler can ignore
* desiredCount temporarily during a deployment. For example, if
- * desiredCount is four tasks, a minimum of 50% allows the
- * scheduler to stop two existing tasks before starting two new tasks. Tasks for
- * services that don't use a load balancer are considered healthy if they're in the
- * RUNNING state. Tasks for services that use a load balancer are
- * considered healthy if they're in the RUNNING state and are reported
- * as healthy by the load balancer.
desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two
+ * existing tasks before starting two new tasks. Tasks for services that don't use a load balancer
+ * are considered healthy if they're in the RUNNING state. Tasks for services that
+ * use a load balancer are considered healthy if they're in the RUNNING state and are
+ * reported as healthy by the load balancer.
* The maximumPercent parameter represents an upper limit on the
- * number of running tasks during a deployment. You can use it to define the
- * deployment batch size. For example, if desiredCount is four tasks,
- * a maximum of 200% starts four new tasks before stopping the four older tasks
- * (provided that the cluster resources required to do this are available).
The maximumPercent parameter represents an upper limit on the number of running
+ * tasks during a deployment. You can use it to define the deployment batch size. For example, if
+ * desiredCount is four tasks, a maximum of 200% starts four new tasks before
+ * stopping the four older tasks (provided that the cluster resources required to do this are
+ * available).
When UpdateService stops a task during a deployment, the equivalent
- * of docker stop is issued to the containers running in the task. This
- * results in a SIGTERM and a 30-second timeout. After this,
- * SIGKILL is sent and the containers are forcibly stopped. If the
- * container handles the SIGTERM gracefully and exits within 30 seconds from
- * receiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it determines task placement in your - * cluster with the following logic.
+ *When UpdateService stops a task during a deployment, the equivalent of docker stop
+ * is issued to the containers running in the task. This results in a SIGTERM and a 30-second
+ * timeout. After this, SIGKILL is sent and the containers are forcibly stopped. If the
+ * container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no
+ * SIGKILL is sent.
When the service scheduler launches new tasks, it determines task placement in your cluster with the + * following logic.
*Determine which of the container instances in your cluster can support your - * service's task definition. For example, they have the required CPU, memory, - * ports, and container instance attributes.
+ *Determine which of the container instances in your cluster can support your service's task + * definition. For example, they have the required CPU, memory, ports, and container instance + * attributes.
*By default, the service scheduler attempts to balance tasks across - * Availability Zones in this manner even though you can choose a different - * placement strategy.
+ *By default, the service scheduler attempts to balance tasks across Availability Zones in this + * manner even though you can choose a different placement strategy.
*Sort the valid container instances by the fewest number of running - * tasks for this service in the same Availability Zone as the instance. - * For example, if zone A has one running service task and zones B and C - * each have zero, valid container instances in either zone B or C are - * considered optimal for placement.
+ *Sort the valid container instances by the fewest number of running tasks for this + * service in the same Availability Zone as the instance. For example, if zone A has one + * running service task and zones B and C each have zero, valid container instances in + * either zone B or C are considered optimal for placement.
*Place the new service task on a valid container instance in an optimal - * Availability Zone (based on the previous steps), favoring container - * instances with the fewest number of running tasks for this - * service.
+ *Place the new service task on a valid container instance in an optimal Availability + * Zone (based on the previous steps), favoring container instances with the fewest number + * of running tasks for this service.
*When the service scheduler stops running tasks, it attempts to maintain balance across - * the Availability Zones in your cluster using the following logic:
+ *When the service scheduler stops running tasks, it attempts to maintain balance across the + * Availability Zones in your cluster using the following logic:
*Sort the container instances by the largest number of running tasks for this - * service in the same Availability Zone as the instance. For example, if zone A - * has one running service task and zones B and C each have two, container - * instances in either zone B or C are considered optimal for termination.
+ *Sort the container instances by the largest number of running tasks for this service in the + * same Availability Zone as the instance. For example, if zone A has one running service task and + * zones B and C each have two, container instances in either zone B or C are considered optimal + * for termination.
*Stop the task on a container instance in an optimal Availability Zone (based - * on the previous steps), favoring container instances with the largest number of - * running tasks for this service.
+ *Stop the task on a container instance in an optimal Availability Zone (based on the previous + * steps), favoring container instances with the largest number of running tasks for this + * service.
*For more information about the role see the For more information about the role see the CreateService request
- * parameter
+ * CreateService request parameter
* role
* .
You don't have authorization to perform the requested action.
* * @throws {@link ClientException} (client fault) - *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.
+ *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.
*The following list includes additional causes for the error:
*The RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.
The RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
* * @throws {@link InvalidParameterException} (client fault) - *The specified parameter isn't valid. Review the available parameters for the API - * request.
+ *The specified parameter isn't valid. Review the available parameters for the API request.
* * @throws {@link NamespaceNotFoundException} (client fault) *The specified namespace wasn't found.
@@ -634,12 +639,11 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met *These errors are usually caused by a server issue.
* * @throws {@link ServiceNotActiveException} (client fault) - *The specified service isn't active. You can't update a service that's inactive. If you - * have previously deleted a service, you can re-create it with CreateService.
+ *The specified service isn't active. You can't update a service that's inactive. If you have + * previously deleted a service, you can re-create it with CreateService.
* * @throws {@link ServiceNotFoundException} (client fault) - *The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region - * specific.
+ *The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
* * @throws {@link UnsupportedFeatureException} (client fault) *The specified task isn't supported in this Region.
diff --git a/clients/client-ecs/src/commands/UpdateServicePrimaryTaskSetCommand.ts b/clients/client-ecs/src/commands/UpdateServicePrimaryTaskSetCommand.ts index 22aa7575679d..c9c2e561423c 100644 --- a/clients/client-ecs/src/commands/UpdateServicePrimaryTaskSetCommand.ts +++ b/clients/client-ecs/src/commands/UpdateServicePrimaryTaskSetCommand.ts @@ -30,10 +30,9 @@ export interface UpdateServicePrimaryTaskSetCommandOutput __MetadataBearer {} /** - *Modifies which task set in a service is the primary task set. Any parameters that are
- * updated on the primary task set in a service will transition to the service. This is
- * used when a service uses the Modifies which task set in a service is the primary task set. Any parameters that are updated on the
+ * primary task set in a service will transition to the service. This is used when a service uses the
+ * You don't have authorization to perform the requested action. 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. 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. The following list includes additional causes for the error: The The The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. The specified service isn't active. You can't update a service that's inactive. If you
- * have previously deleted a service, you can re-create it with CreateService. The specified service isn't active. You can't update a service that's inactive. If you have
+ * previously deleted a service, you can re-create it with CreateService. The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region
- * specific. The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific. The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and
- * Region. The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region. The specified task isn't supported in this Region. Updates the protection status of a task. You can set Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the
- * You can specify a custom expiration period for task protection from 1 minute to up to
- * 2,880 minutes (48 hours). To specify the custom expiration period, set the
- * You can specify a custom expiration period for task protection from 1 minute to up to 2,880 minutes
+ * (48 hours). To specify the custom expiration period, set the To learn more about Amazon ECS task protection, see Task scale-in
* protection in the
* Amazon Elastic Container Service Developer Guide
* . This operation is only supported for tasks belonging to an Amazon ECS service. Invoking
- * this operation for a standalone task will result in an This operation is only supported for tasks belonging to an Amazon ECS service. Invoking this operation
+ * for a standalone task will result in an If you prefer to set task protection from within the container, we recommend using
- * the Task scale-in protection endpoint. If you prefer to set task protection from within the container, we recommend using the Task scale-in
+ * protection endpoint. You don't have authorization to perform the requested action. 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. 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. The following list includes additional causes for the error: The The The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. The specified resource wasn't found. Modifies a task set. This is used when a service uses the Modifies a task set. This is used when a service uses the You don't have authorization to perform the requested action. 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. 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. The following list includes additional causes for the error: The The The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific. The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. These errors are usually caused by a server issue. The specified service isn't active. You can't update a service that's inactive. If you
- * have previously deleted a service, you can re-create it with CreateService. The specified service isn't active. You can't update a service that's inactive. If you have
+ * previously deleted a service, you can re-create it with CreateService. The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region
- * specific. The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific. The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and
- * Region. The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region. The specified task isn't supported in this Region. 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. 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. 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. 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. 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. 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. 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. 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. The following list includes additional causes for the error: The The The managed scaling settings for the Auto Scaling group capacity provider. When managed scaling is turned on, Amazon ECS manages the scale-in and scale-out actions of
- * the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS
- * managed CloudWatch metric with the specified If managed scaling is off, the user must manage the scaling of the Auto Scaling
- * group. When managed scaling is turned on, Amazon ECS manages the scale-in and scale-out actions of the Auto
+ * Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS managed CloudWatch metric with
+ * the specified If managed scaling is off, the user must manage the scaling of the Auto Scaling group. The target capacity utilization as a percentage for the capacity provider. The
- * specified value must be greater than The target capacity utilization as a percentage for the capacity provider. The specified value must
+ * be greater than The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is omitted, the default
- * value of When additional capacity is required, Amazon ECS will scale up the minimum scaling step
- * size even if the actual demand is less than the minimum scaling step size. If you use a capacity provider with an Auto Scaling group configured with more than
- * one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum
- * scaling step size value and will ignore both the maximum scaling step size as well as
- * the capacity demand. The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is
+ * not affected by this parameter If this parameter is omitted, the default value of When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the
+ * actual demand is less than the minimum scaling step size. If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2
+ * instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value
+ * and will ignore both the maximum scaling step size as well as the capacity demand. The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is omitted, the default
- * value of The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is
+ * omitted, the default value of The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute
- * to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value
- * of The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics
+ * for Auto Scaling group. If this parameter is omitted, the default value of The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group
- * name. The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name. The managed termination protection setting to use for the Auto Scaling group capacity
- * provider. This determines whether the Auto Scaling group has managed termination
- * protection. The default is off. The managed termination protection setting to use for the Auto Scaling group capacity provider. This
+ * determines whether the Auto Scaling group has managed termination protection. The default is
+ * off. When using managed termination protection, managed scaling must also be used
- * otherwise managed termination protection doesn't work. When using managed termination protection, managed scaling must also be used otherwise managed
+ * termination protection doesn't work. When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an
- * Auto Scaling group that contain tasks from being terminated during a scale-in action.
- * The Auto Scaling group and each instance in the Auto Scaling group must have instance
- * protection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide. When managed termination protection is off, your Amazon EC2 instances aren't protected from
- * termination when the Auto Scaling group scales in. When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling
+ * group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and
+ * each instance in the Auto Scaling group must have instance protection from scale-in actions on as well.
+ * For more information, see Instance
+ * Protection in the Auto Scaling User Guide. When managed termination protection is off, your Amazon EC2 instances aren't protected from termination
+ * when the Auto Scaling group scales in. The metadata that you apply to a resource to help you categorize and organize them.
- * Each tag consists of a key and an optional value. You define them. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists
+ * of a key and an optional value. You define them. The following basic restrictions apply to tags: One part of a key-value pair that make up a tag. A One part of a key-value pair that make up a tag. A The optional part of a key-value pair that make up a tag. A The optional part of a key-value pair that make up a tag. A The name of the capacity provider. Up to 255 characters are allowed. They include
- * letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-).
- * The name can't be prefixed with " The name of the capacity provider. Up to 255 characters are allowed. They include letters (both upper
+ * and lowercase letters), numbers, underscores (_), and hyphens (-). The name can't be prefixed with
+ * " The metadata that you apply to the capacity provider to categorize and organize them
- * more conveniently. Each tag consists of a key and an optional value. You define both of
- * them. The metadata that you apply to the capacity provider to categorize and organize them more
+ * conveniently. Each tag consists of a key and an optional value. You define both of them. The following basic restrictions apply to tags: The current status of the capacity provider. Only capacity providers in an
- * The current status of the capacity provider. Only capacity providers in an The update status of the capacity provider. The following are the possible states that
- * is returned. The update status of the capacity provider. The following are the possible states that is
+ * returned. The capacity provider was successfully deleted and has an
- * The capacity provider was successfully deleted and has an The capacity provider can't be deleted. The update status reason provides
- * further details about why the delete failed. The capacity provider can't be deleted. The update status reason provides further details
+ * about why the delete failed. The update status reason. This provides further details about the update status for
- * the capacity provider. The update status reason. This provides further details about the update status for the capacity
+ * provider. The metadata that you apply to the capacity provider to help you categorize and
- * organize it. Each tag consists of a key and an optional value. You define both. The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag
+ * consists of a key and an optional value. You define both. The following basic restrictions apply to tags: The specified parameter isn't valid. Review the available parameters for the API
- * request. The specified parameter isn't valid. Review the available parameters for the API request. 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 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
+ * The log configuration for the results of the execute command actions. The logs can be
- * sent to CloudWatch Logs or an Amazon S3 bucket. The log configuration for the results of the execute command actions. The logs can be sent to
+ * CloudWatch Logs or an Amazon S3 bucket. Determines whether to use encryption on the CloudWatch logs. If not specified,
- * encryption will be off. Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be
+ * off. Determines whether to use encryption on the S3 logs. If not specified, encryption is
- * not used. Determines whether to use encryption on the S3 logs. If not specified, encryption is not used. Specify an Key Management Service key ID to encrypt the data between the local client
- * and the container. Specify an Key Management Service key ID to encrypt the data between the local client and the
+ * container. The log setting to use for redirecting logs for your execute command results. The
- * following log settings are available. The log setting to use for redirecting logs for your execute command results. The following log
+ * settings are available.
@@ -639,16 +630,15 @@ export interface ExecuteCommandConfiguration {
*
- * EXTERNAL deployment controller type. For more
- * information, see Amazon ECS Deployment
+ * EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment
* Types in the Amazon Elastic Container Service Developer Guide.
*
*
@@ -148,23 +146,20 @@ export interface UpdateServicePrimaryTaskSetCommandOutput
* RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.protectionEnabled to
- * true to protect your task from termination during scale-in events from
- * Service
+ * true to protect your task from termination during scale-in events from Service
* Autoscaling or deployments.protectionEnabled property making the task eligible for termination by
- * a subsequent scale-in event.expiresInMinutes property. The expiresInMinutes property
- * is always reset when you invoke this operation for a task that already has
- * protectionEnabled set to true. You can keep extending the
+ * protectionEnabled property making the task eligible for termination by a subsequent
+ * scale-in event.expiresInMinutes property.
+ * The expiresInMinutes property is always reset when you invoke this operation for a task
+ * that already has protectionEnabled set to true. You can keep extending the
* protection expiration period of a task by invoking this operation repeatedly.TASK_NOT_VALID
- * failure. For more information, see API failure
- * reasons.TASK_NOT_VALID failure. For more information,
+ * see API failure reasons.
*
*
@@ -118,8 +114,7 @@ export interface UpdateTaskProtectionCommandOutput extends UpdateTaskProtectionR
* RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.EXTERNAL
- * deployment controller type. For more information, see Amazon ECS Deployment
- * Types in the Amazon Elastic Container Service Developer Guide.EXTERNAL deployment controller
+ * type. For more information, see Amazon ECS Deployment Types in the
+ * Amazon Elastic Container Service Developer Guide.
*
*
@@ -148,23 +147,20 @@ export interface UpdateTaskSetCommandOutput extends UpdateTaskSetResponse, __Met
* RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.
*
* @public
@@ -103,12 +102,11 @@ export type ManagedScalingStatus = (typeof ManagedScalingStatus)[keyof typeof Ma
/**
* RunTask could not be processed because you use managed
- * scaling and there is a capacity error because the quota of tasks in the
- * PROVISIONING per cluster has been reached. For information
- * about the service quotas, see Amazon ECS
- * service quotas.RunTask could not be processed because you use managed scaling and there is
+ * a capacity error because the quota of tasks in the PROVISIONING per cluster has
+ * been reached. For information about the service quotas, see Amazon ECS service
+ * quotas.targetCapacity value as the target
- * value for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.targetCapacity value as the target value for the metric. For more
+ * information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.0 and less than or equal to
- * 100. For example, if you want the capacity provider to maintain 10%
- * spare capacity, then that means the utilization is 90%, so use a
- * targetCapacity of 90. The default value of
- * 100 percent results in the Amazon EC2 instances in your Auto Scaling group
- * being completely used.0 and less than or equal to 100. For example, if you want the
+ * capacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use a
+ * targetCapacity of 90. The default value of 100 percent
+ * results in the Amazon EC2 instances in your Auto Scaling group being completely used.1 is used.1 is
+ * used.10000 is used.10000 is used.300 seconds is used.300 seconds is
+ * used.
*
key is a general label
- * that acts like a category for more specific tag values.key is a general label that acts like
+ * a category for more specific tag values.value acts as
- * a descriptor within a tag category (key).value acts as a descriptor
+ * within a tag category (key).aws", "ecs", or
- * "fargate".aws", "ecs", or "fargate".
*
ACTIVE state can be used in a cluster. When a capacity provider is
- * successfully deleted, it has an INACTIVE status.ACTIVE state
+ * can be used in a cluster. When a capacity provider is successfully deleted, it has an
+ * INACTIVE status.
*
* @public
@@ -416,15 +410,15 @@ export interface CapacityProvider {
updateStatus?: CapacityProviderUpdateStatus | undefined;
/**
- * INACTIVE status.INACTIVE
+ * status.
*
PENDING or STAGING, the update
- * process can get stuck in that state. However, when the agent reconnects, it resumes
- * where it stopped previously.PENDING or STAGING, the update process can get stuck in that state.
+ * However, when the agent reconnects, it resumes where it stopped previously.
*
DEFAULT: The awslogs configuration in the task
- * definition is used. If no logging parameter is specified, it defaults to this
- * value. If no awslogs log driver is configured in the task
- * definition, the output won't be logged.DEFAULT: The awslogs configuration in the task definition is used.
+ * If no logging parameter is specified, it defaults to this value. If no awslogs log
+ * driver is configured in the task definition, the output won't be logged.
* OVERRIDE: Specify the logging details as a part of
- * logConfiguration. If the OVERRIDE logging option
- * is specified, the logConfiguration is required.
logConfiguration. If the OVERRIDE logging option is specified, the
+ * logConfiguration is required.
* The log configuration for the results of the execute command actions. The logs can be
- * sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is
- * specified, a logConfiguration must be provided.
The log configuration for the results of the execute command actions. The logs can be sent to
+ * CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a
+ * logConfiguration must be provided.
Specify a Amazon Web Services Key Management Service key ID to encrypt the managed storage.
+ *Specify a Key Management Service key ID to encrypt the managed storage.
* @public */ kmsKeyId?: string | undefined; @@ -701,27 +691,25 @@ export interface ClusterConfiguration { } /** - *The details of a capacity provider strategy. A capacity provider strategy can be set
- * when using the RunTaskor CreateCluster APIs or as
- * the default capacity provider strategy for a cluster with the CreateCluster API.
Only capacity providers that are already associated with a cluster and have an
- * ACTIVE or UPDATING status can be used in a capacity
- * provider strategy. The PutClusterCapacityProviders API is used to
- * associate a capacity provider with a cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity - * provider must already be created. New Auto Scaling group capacity providers can be - * created with the CreateClusterCapacityProvider API operation.
+ *The details of a capacity provider strategy. A capacity provider strategy can be set when using the
+ * RunTaskor
+ * CreateCluster APIs or as the default capacity provider strategy for a cluster with the
+ * CreateCluster API.
Only capacity providers that are already associated with a cluster and have an ACTIVE or
+ * UPDATING status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a
+ * cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already + * be created. New Auto Scaling group capacity providers can be created with the CreateClusterCapacityProvider API operation.
*To use a Fargate capacity provider, specify either the FARGATE or
- * FARGATE_SPOT capacity providers. The Fargate capacity providers are
- * available to all accounts and only need to be associated with a cluster to be used in a
- * capacity provider strategy.
With FARGATE_SPOT, you can run interruption tolerant tasks at a rate that's
- * discounted compared to the FARGATE price. FARGATE_SPOT runs
- * tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are
- * interrupted with a two-minute warning. FARGATE_SPOT supports Linux tasks
- * with the X86_64 architecture on platform version 1.3.0 or later.
- * FARGATE_SPOT supports Linux tasks with the ARM64 architecture on
- * platform version 1.4.0 or later.
FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all
+ * accounts and only need to be associated with a cluster to be used in a capacity provider
+ * strategy.
+ * With FARGATE_SPOT, you can run interruption tolerant tasks at a rate that's discounted
+ * compared to the FARGATE price. FARGATE_SPOT runs tasks on spare compute
+ * capacity. When Amazon Web Services needs the capacity back, your tasks are interrupted with a two-minute warning.
+ * FARGATE_SPOT supports Linux tasks with the X86_64 architecture on platform version
+ * 1.3.0 or later. FARGATE_SPOT supports Linux tasks with the ARM64 architecture on platform
+ * version 1.4.0 or later.
A capacity provider strategy may contain a maximum of 6 capacity providers.
* @public */ @@ -733,34 +721,31 @@ export interface CapacityProviderStrategyItem { capacityProvider: string | undefined; /** - *The weight value designates the relative percentage of the total
- * number of tasks launched that should use the specified capacity provider. The
- * weight value is taken into consideration after the base
- * value, if defined, is satisfied.
If no weight value is specified, the default value of 0 is
- * used. When multiple capacity providers are specified within a capacity provider
- * strategy, at least one of the capacity providers must have a weight value greater than
- * zero and any capacity providers with a weight of 0 can't be used to place
- * tasks. If you specify multiple capacity providers in a strategy that all have a weight
- * of 0, any RunTask or CreateService actions using
- * the capacity provider strategy will fail.
An example scenario for using weights is defining a strategy that contains two
- * capacity providers and both have a weight of 1, then when the
- * base is satisfied, the tasks will be split evenly across the two
- * capacity providers. Using that same logic, if you specify a weight of 1 for
- * capacityProviderA and a weight of 4 for
+ *
The weight value designates the relative percentage of the total number of tasks
+ * launched that should use the specified capacity provider. The weight value is taken into
+ * consideration after the base value, if defined, is satisfied.
If no weight value is specified, the default value of 0 is used. When
+ * multiple capacity providers are specified within a capacity provider strategy, at least one of the
+ * capacity providers must have a weight value greater than zero and any capacity providers with a weight
+ * of 0 can't be used to place tasks. If you specify multiple capacity providers in a
+ * strategy that all have a weight of 0, any RunTask or
+ * CreateService actions using the capacity provider strategy will fail.
An example scenario for using weights is defining a strategy that contains two capacity providers and
+ * both have a weight of 1, then when the base is satisfied, the tasks will be
+ * split evenly across the two capacity providers. Using that same logic, if you specify a weight of
+ * 1 for capacityProviderA and a weight of 4 for
* capacityProviderB, then for every one task that's run using
* capacityProviderA, four tasks would use
- * capacityProviderB.
The base value designates how many tasks, at a minimum, to run on
- * the specified capacity provider. Only one capacity provider in a capacity provider
- * strategy can have a base defined. If no value is specified, the
- * default value of 0 is used.
The base value designates how many tasks, at a minimum, to run on the specified
+ * capacity provider. Only one capacity provider in a capacity provider strategy can have a
+ * base defined. If no value is specified, the default value of 0 is
+ * used.
The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify - * a Service Connect configuration. The namespace name can include up to 1024 characters. - * The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than - * (>), less than (<), or slash (/).
- *If you enter an existing namespace name or ARN, then that namespace will be used. - * Any namespace type is supported. The namespace must be in this account and this Amazon Web Services - * Region.
- *If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a - * Cloud Map namespace with the "API calls" method of instance discovery only. This instance - * discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance - * discovery aren't used by Service Connect.
- *If you update the cluster with an empty string "" for the namespace name,
- * the cluster configuration for Service Connect is removed. Note that the namespace will
- * remain in Cloud Map and must be deleted separately.
For more information about Cloud Map, see Working with Services - * in the Cloud Map Developer Guide.
+ *The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify a + * Service Connect configuration. The namespace name can include up to 1024 characters. The name is + * case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), + * or slash (/).
+ *If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace + * type is supported. The namespace must be in this account and this Amazon Web Services Region.
+ *If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace + * with the "API calls" method of instance discovery only. This instance discovery method is the "HTTP" + * namespace type in the Command Line Interface. Other types of instance discovery aren't used by + * Service Connect.
+ *If you update the cluster with an empty string "" for the namespace name, the cluster
+ * configuration for Service Connect is removed. Note that the namespace will remain in Cloud Map and must
+ * be deleted separately.
For more information about Cloud Map, see Working with Services in the + * Cloud Map Developer Guide.
* @public */ namespace: string | undefined; @@ -818,8 +802,8 @@ export const ClusterSettingName = { export type ClusterSettingName = (typeof ClusterSettingName)[keyof typeof ClusterSettingName]; /** - *The settings to use when creating a cluster. This parameter is used to turn on CloudWatch - * Container Insights for a cluster.
+ *The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container + * Insights for a cluster.
* @public */ export interface ClusterSetting { @@ -830,13 +814,12 @@ export interface ClusterSetting { name?: ClusterSettingName | undefined; /** - *The value to set for the cluster setting. The supported values are
- * enabled and disabled.
If you set name to containerInsights and value
- * to enabled, CloudWatch Container Insights will be on for the cluster, otherwise
- * it will be off unless the containerInsights account setting is turned on.
- * If a cluster value is specified, it will override the containerInsights
- * value set with PutAccountSetting or PutAccountSettingDefault.
The value to set for the cluster setting. The supported values are enabled and
+ * disabled.
If you set name to containerInsights and value to
+ * enabled, CloudWatch Container Insights will be on for the cluster, otherwise it will be off
+ * unless the containerInsights account setting is turned on. If a cluster value is
+ * specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
The name of your cluster. If you don't specify a name for your cluster, you create a
- * cluster that's named default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
The name of your cluster. If you don't specify a name for your cluster, you create a cluster that's
+ * named default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
The metadata that you apply to the cluster to help you categorize and organize them. - * Each tag consists of a key and an optional value. You define both.
+ *The metadata that you apply to the cluster to help you categorize and organize them. Each tag + * consists of a key and an optional value. You define both.
*The following basic restrictions apply to tags:
*The setting to use when creating a cluster. This parameter is used to turn on CloudWatch
- * Container Insights for a cluster. If this value is specified, it overrides the
- * containerInsights value set with PutAccountSetting or
- * PutAccountSettingDefault.
The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights
+ * for a cluster. If this value is specified, it overrides the containerInsights value set
+ * with PutAccountSetting or PutAccountSettingDefault.
The short name of one or more capacity providers to associate with the cluster. A - * capacity provider must be associated with a cluster before it can be included as part of - * the default capacity provider strategy of the cluster or used in a capacity provider - * strategy when calling the CreateService or - * RunTask actions.
- *If specifying a capacity provider that uses an Auto Scaling group, the capacity - * provider must be created but not associated with another cluster. New Auto Scaling group - * capacity providers can be created with the CreateCapacityProvider API operation.
+ *The short name of one or more capacity providers to associate with the cluster. A capacity provider + * must be associated with a cluster before it can be included as part of the default capacity provider + * strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.
+ *If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be + * created but not associated with another cluster. New Auto Scaling group capacity providers can be + * created with the CreateCapacityProvider + * API operation.
*To use a Fargate capacity provider, specify either the FARGATE or
- * FARGATE_SPOT capacity providers. The Fargate capacity providers are
- * available to all accounts and only need to be associated with a cluster to be
- * used.
The PutCapacityProvider API operation is used to update the list of available - * capacity providers for a cluster after the cluster is created.
+ *FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all
+ * accounts and only need to be associated with a cluster to be used.
+ * The PutCapacityProvider API operation is used to update the list of available capacity + * providers for a cluster after the cluster is created.
* @public */ capacityProviders?: string[] | undefined; /** - *The capacity provider strategy to set as the default for the cluster. After a default - * capacity provider strategy is set for a cluster, when you call the CreateService or RunTask APIs with no - * capacity provider strategy or launch type specified, the default capacity provider - * strategy for the cluster is used.
- *If a default capacity provider strategy isn't defined for a cluster when it was - * created, it can be defined later with the PutClusterCapacityProviders - * API operation.
+ *The capacity provider strategy to set as the default for the cluster. After a default capacity + * provider strategy is set for a cluster, when you call the CreateService or RunTask APIs with + * no capacity provider strategy or launch type specified, the default capacity provider strategy for the + * cluster is used.
+ *If a default capacity provider strategy isn't defined for a cluster when it was created, it can be + * defined later with the PutClusterCapacityProviders API operation.
* @public */ defaultCapacityProviderStrategy?: CapacityProviderStrategyItem[] | undefined; @@ -961,15 +940,15 @@ export interface CreateClusterRequest { */ export interface KeyValuePair { /** - *The name of the key-value pair. For environment variables, this is the name of the - * environment variable.
+ *The name of the key-value pair. For environment variables, this is the name of the environment + * variable.
* @public */ name?: string | undefined; /** - *The value of the key-value pair. For environment variables, this is the value of the - * environment variable.
+ *The value of the key-value pair. For environment variables, this is the value of the environment + * variable.
* @public */ value?: string | undefined; @@ -994,25 +973,22 @@ export interface Attachment { type?: string | undefined; /** - * The status of the attachment. Valid values are PRECREATED,
- * CREATED, ATTACHING, ATTACHED,
- * DETACHING, DETACHED, DELETED, and
- * FAILED.
The status of the attachment. Valid values are PRECREATED, CREATED,
+ * ATTACHING, ATTACHED, DETACHING, DETACHED,
+ * DELETED, and FAILED.
Details of the attachment.
- *For elastic network interfaces, this includes the network interface ID, the MAC - * address, the subnet ID, and the private IPv4 address.
- *For Service Connect services, this includes portName,
- * clientAliases, discoveryName, and
- * ingressPortOverride.
For Elastic Block Storage, this includes roleArn,
- * deleteOnTermination, volumeName, volumeId,
- * and statusReason (only when the attachment fails to create or
- * attach).
For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet + * ID, and the private IPv4 address.
+ *For Service Connect services, this includes portName, clientAliases,
+ * discoveryName, and ingressPortOverride.
For Elastic Block Storage, this includes roleArn, deleteOnTermination,
+ * volumeName, volumeId, and statusReason (only when the
+ * attachment fails to create or attach).
The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a - * Service Connect configuration, this namespace is used.
+ *The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a Service Connect + * configuration, this namespace is used.
* @public */ namespace?: string | undefined; } /** - *A regional grouping of one or more container instances where you can run task - * requests. Each account receives a default cluster the first time you use the Amazon ECS - * service, but you may also create other clusters. Clusters may contain more than one - * instance type simultaneously.
+ *A regional grouping of one or more container instances where you can run task requests. Each account + * receives a default cluster the first time you use the Amazon ECS service, but you may also create other + * clusters. Clusters may contain more than one instance type simultaneously.
* @public */ export interface Cluster { /** - *The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN - * format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
+ *The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN) + * in the Amazon ECS Developer Guide.
* @public */ clusterArn?: string | undefined; @@ -1070,35 +1045,34 @@ export interface Cluster { configuration?: ClusterConfiguration | undefined; /** - *The status of the cluster. The following are the possible states that are - * returned.
+ *The status of the cluster. The following are the possible states that are returned.
*The cluster is ready to accept tasks and if applicable you can register - * container instances with the cluster.
+ *The cluster is ready to accept tasks and if applicable you can register container + * instances with the cluster.
*The cluster has capacity providers that are associated with it and the - * resources needed for the capacity provider are being created.
+ *The cluster has capacity providers that are associated with it and the resources needed + * for the capacity provider are being created.
*The cluster has capacity providers that are associated with it and the - * resources needed for the capacity provider are being deleted.
+ *The cluster has capacity providers that are associated with it and the resources needed + * for the capacity provider are being deleted.
*The cluster has capacity providers that are associated with it and the - * resources needed for the capacity provider have failed to create.
+ *The cluster has capacity providers that are associated with it and the resources needed + * for the capacity provider have failed to create.
*The cluster has been deleted. Clusters with an INACTIVE
- * status may remain discoverable in your account for a period of time.
- * However, this behavior is subject to change in the future. We don't
- * recommend that you rely on INACTIVE clusters persisting.
The cluster has been deleted. Clusters with an INACTIVE status may remain
+ * discoverable in your account for a period of time. However, this behavior is subject to
+ * change in the future. We don't recommend that you rely on INACTIVE clusters
+ * persisting.
The number of container instances registered into the cluster. This includes container
- * instances in both ACTIVE and DRAINING status.
The number of container instances registered into the cluster. This includes container instances in
+ * both ACTIVE and DRAINING status.
The number of services that are running on the cluster in an ACTIVE
- * state. You can view these services with PListServices.
The number of services that are running on the cluster in an ACTIVE state. You can view
+ * these services with PListServices.
Additional information about your clusters that are separated by launch type. They - * include the following:
+ *Additional information about your clusters that are separated by launch type. They include the + * following:
*runningEC2TasksCount
@@ -1165,8 +1139,8 @@ export interface Cluster { statistics?: KeyValuePair[] | undefined; /** - *The metadata that you apply to the cluster to help you categorize and organize them. - * Each tag consists of a key and an optional value. You define both.
+ *The metadata that you apply to the cluster to help you categorize and organize them. Each tag + * consists of a key and an optional value. You define both.
*The following basic restrictions apply to tags:
*The settings for the cluster. This parameter indicates whether CloudWatch Container Insights - * is on or off for a cluster.
+ *The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is on or off + * for a cluster.
* @public */ settings?: ClusterSetting[] | undefined; @@ -1216,24 +1190,23 @@ export interface Cluster { capacityProviders?: string[] | undefined; /** - *The default capacity provider strategy for the cluster. When services or tasks are run - * in the cluster with no launch type or capacity provider strategy specified, the default - * capacity provider strategy is used.
+ *The default capacity provider strategy for the cluster. When services or tasks are run in the cluster + * with no launch type or capacity provider strategy specified, the default capacity provider strategy is + * used.
* @public */ defaultCapacityProviderStrategy?: CapacityProviderStrategyItem[] | undefined; /** - *The resources attached to a cluster. When using a capacity provider with a cluster, - * the capacity provider and associated resources are returned as cluster - * attachments.
+ *The resources attached to a cluster. When using a capacity provider with a cluster, the capacity + * provider and associated resources are returned as cluster attachments.
* @public */ attachments?: Attachment[] | undefined; /** - *The status of the capacity providers associated with the cluster. The following are - * the states that are returned.
+ *The status of the capacity providers associated with the cluster. The following are the states that + * are returned.
*One of the methods which provide a way for you to quickly identify when a deployment - * has failed, and then to optionally roll back the failure to the last working - * deployment.
- *When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the - * rollback parameter to have Amazon ECS to roll back your service to the last completed - * deployment after a failure.
+ *One of the methods which provide a way for you to quickly identify when a deployment has failed, and + * then to optionally roll back the failure to the last working deployment.
+ *When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback + * parameter to have Amazon ECS to roll back your service to the last completed deployment after a + * failure.
*You can only use the DeploymentAlarms method to detect failures when the
- * DeploymentController is set to ECS (rolling
- * update).
For more information, see Rolling
- * update in the
+ * DeploymentController is set to ECS (rolling update).
For more information, see Rolling update in the + * * Amazon Elastic Container Service Developer Guide * .
* @public @@ -1345,16 +1316,15 @@ export interface DeploymentAlarms { alarmNames: string[] | undefined; /** - *Determines whether to configure Amazon ECS to roll back the service if a service deployment - * fails. If rollback is used, when a service deployment fails, the service is rolled back - * to the last deployment that completed successfully.
+ *Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If + * rollback is used, when a service deployment fails, the service is rolled back to the last deployment + * that completed successfully.
* @public */ rollback: boolean | undefined; /** - *Determines whether to use the CloudWatch alarm option in the service deployment - * process.
+ *Determines whether to use the CloudWatch alarm option in the service deployment process.
* @public */ enable: boolean | undefined; @@ -1362,17 +1332,17 @@ export interface DeploymentAlarms { /** *The deployment circuit breaker can only be used for services using the rolling
- * update (ECS) deployment type.
The deployment circuit breaker can only be used for services using the rolling update
+ * (ECS) deployment type.
The deployment circuit breaker determines whether a
- * service deployment will fail if the service can't reach a steady state. If it is turned
- * on, a service deployment will transition to a failed state and stop launching new tasks.
- * You can also configure Amazon ECS to roll back your service to the last completed deployment
- * after a failure. For more information, see Rolling
+ * The deployment circuit breaker determines whether a service
+ * deployment will fail if the service can't reach a steady state. If it is turned on, a service
+ * deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS
+ * to roll back your service to the last completed deployment after a failure. For more information, see
+ * Rolling
* update in the Amazon Elastic Container Service Developer Guide. For more information about API failure reasons, see API failure
- * reasons in the Amazon Elastic Container Service Developer Guide. For more information about API failure reasons, see API failure reasons in the
+ * Amazon Elastic Container Service Developer Guide. Determines whether to configure Amazon ECS to roll back the service if a service deployment
- * fails. If rollback is on, when a service deployment fails, the service is rolled back to
- * the last deployment that completed successfully. Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If
+ * rollback is on, when a service deployment fails, the service is rolled back to the last deployment that
+ * completed successfully. Optional deployment parameters that control how many tasks run during the deployment and the
- * failure detection methods. Optional deployment parameters that control how many tasks run during a deployment and the ordering
+ * of stopping and starting tasks. The deployment circuit breaker can only be used for services using the rolling
- * update ( The deployment circuit breaker can only be used for services using the rolling update
+ * ( The deployment circuit breaker determines whether a
- * service deployment will fail if the service can't reach a steady state. If you use the
- * deployment circuit breaker, a service deployment will transition to a failed state and
- * stop launching new tasks. If you use the rollback option, when a service deployment
- * fails, the service is rolled back to the last deployment that completed successfully.
- * For more information, see Rolling
- * update in the Amazon Elastic Container Service Developer
- * Guide
+ * The deployment circuit breaker determines whether a service
+ * deployment will fail if the service can't reach a steady state. If you use the deployment circuit
+ * breaker, a service deployment will transition to a failed state and stop launching new tasks. If you
+ * use the rollback option, when a service deployment fails, the service is rolled back to the last
+ * deployment that completed successfully. For more information, see Rolling update in the
+ * Amazon Elastic Container Service Developer Guide
* If a service is using the rolling update ( If a service is using either the blue/green (ECS) deployment type.ECS) deployment type.ECS) deployment type, the
- * maximumPercent parameter represents an upper limit on the number of
- * your service's tasks that are allowed in the RUNNING or
- * PENDING state during a deployment, as a percentage of the
- * desiredCount (rounded down to the nearest integer). This parameter
- * enables you to define the deployment batch size. For example, if your service is using
- * the REPLICA service scheduler and has a desiredCount of four
- * tasks and a maximumPercent value of 200%, the scheduler may start four new
- * tasks before stopping the four older tasks (provided that the cluster resources required
- * to do this are available). The default maximumPercent value for a service
- * using the REPLICA service scheduler is 200%.CODE_DEPLOY) or
- * EXTERNAL deployment types, and tasks in the service use the EC2
- * launch type, the maximum percent value is set to the
- * default value. The maximum percent value is used to define the upper limit on the number of the tasks in the
- * service that remain in the RUNNING state while the container instances are
- * in the DRAINING state.maximumPercent parameter represents an upper limit on the number of your service's
+ * tasks that are allowed in the RUNNING or PENDING state during a deployment,
+ * as a percentage of the desiredCount (rounded down to the nearest integer). This parameter
+ * enables you to define the deployment batch size. For example, if your service is using the
+ * REPLICA service scheduler and has a desiredCount of four tasks and a
+ * maximumPercent value of 200%, the scheduler may start four new tasks before stopping
+ * the four older tasks (provided that the cluster resources required to do this are available). The
+ * default maximumPercent value for a service using the REPLICA service
+ * scheduler is 200%.
If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL
+ * deployment types, and tasks in the service use the EC2 launch type, the maximum percent value is set to the default value. The maximum percent value is used to define the upper limit on the number of the tasks in
+ * the service that remain in the RUNNING state while the container instances are in the
+ * DRAINING state.
You can't specify a custom maximumPercent value for a service that uses either the blue/green (CODE_DEPLOY) or
- * EXTERNAL deployment types and has tasks that use the EC2 launch type.
You can't specify a custom maximumPercent value for a service that uses either the
+ * blue/green (CODE_DEPLOY) or EXTERNAL deployment types and has tasks that
+ * use the EC2 launch type.
If the tasks in the service use the - * Fargate launch type, the maximum percent value is not used, although it is - * returned when describing your service.
+ *If the tasks in the service use the Fargate launch type, the maximum percent value is + * not used, although it is returned when describing your service.
* @public */ maximumPercent?: number | undefined; /** *If a service is using the rolling update (ECS) deployment type, the
- * minimumHealthyPercent represents a lower limit on the number of your
- * service's tasks that must remain in the RUNNING state during a deployment,
- * as a percentage of the desiredCount (rounded up to the nearest integer).
- * This parameter enables you to deploy without using additional cluster capacity. For
- * example, if your service has a desiredCount of four tasks and a
- * minimumHealthyPercent of 50%, the service scheduler may stop two
+ * minimumHealthyPercent represents a lower limit on the number of your service's tasks
+ * that must remain in the RUNNING state during a deployment, as a percentage of the
+ * desiredCount (rounded up to the nearest integer). This parameter enables you to deploy
+ * without using additional cluster capacity. For example, if your service has a desiredCount
+ * of four tasks and a minimumHealthyPercent of 50%, the service scheduler may stop two
* existing tasks to free up cluster capacity before starting two new tasks.
For services that do not use a load balancer, the following - * should be noted:
+ *For services that do not use a load balancer, the following should be + * noted:
*A service is considered healthy if all essential containers within the tasks - * in the service pass their health checks.
+ *A service is considered healthy if all essential containers within the tasks in the service + * pass their health checks.
*If a task has no essential containers with a health check defined, the service
- * scheduler will wait for 40 seconds after a task reaches a RUNNING
- * state before the task is counted towards the minimum healthy percent
- * total.
If a task has no essential containers with a health check defined, the service scheduler will
+ * wait for 40 seconds after a task reaches a RUNNING state before the task is
+ * counted towards the minimum healthy percent total.
If a task has one or more essential containers with a health check defined, - * the service scheduler will wait for the task to reach a healthy status before - * counting it towards the minimum healthy percent total. A task is considered - * healthy when all essential containers within the task have passed their health - * checks. The amount of time the service scheduler can wait for is determined by - * the container health check settings.
+ *If a task has one or more essential containers with a health check defined, the service + * scheduler will wait for the task to reach a healthy status before counting it towards the + * minimum healthy percent total. A task is considered healthy when all essential containers + * within the task have passed their health checks. The amount of time the service scheduler can + * wait for is determined by the container health check settings.
*For services that do use a load balancer, the following should be - * noted:
+ *For services that do use a load balancer, the following should be noted:
*If a task has no essential containers with a health check defined, the service - * scheduler will wait for the load balancer target group health check to return a - * healthy status before counting the task towards the minimum healthy percent - * total.
+ *If a task has no essential containers with a health check defined, the service scheduler will + * wait for the load balancer target group health check to return a healthy status before counting + * the task towards the minimum healthy percent total.
*If a task has an essential container with a health check defined, the service - * scheduler will wait for both the task to reach a healthy status and the load - * balancer target group health check to return a healthy status before counting - * the task towards the minimum healthy percent total.
+ *If a task has an essential container with a health check defined, the service scheduler will + * wait for both the task to reach a healthy status and the load balancer target group health + * check to return a healthy status before counting the task towards the minimum healthy percent + * total.
*The default value for a replica service for minimumHealthyPercent is
- * 100%. The default minimumHealthyPercent value for a service using the
- * DAEMON service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the
- * APIs and 50% for the Amazon Web Services Management Console.
The minimum number of healthy tasks during a deployment is the
- * desiredCount multiplied by the minimumHealthyPercent/100,
- * rounded up to the nearest integer value.
If a service is using either the blue/green (CODE_DEPLOY) or
- * EXTERNAL deployment types and is running tasks that use the
- * EC2 launch type, the minimum healthy
- * percent value is set to the default value. The minimum healthy percent value is used to define the lower
- * limit on the number of the tasks in the service that remain in the RUNNING
- * state while the container instances are in the DRAINING state.
The default value for a replica service for minimumHealthyPercent is 100%. The default
+ * minimumHealthyPercent value for a service using the DAEMON service
+ * schedule is 0% for the CLI, the Amazon Web Services SDKs, and the APIs and 50% for the Amazon Web Services Management Console.
The minimum number of healthy tasks during a deployment is the desiredCount multiplied
+ * by the minimumHealthyPercent/100, rounded up to the nearest integer value.
If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL
+ * deployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value. The minimum healthy percent value is used to define the lower limit on the
+ * number of the tasks in the service that remain in the RUNNING state while the container
+ * instances are in the DRAINING state.
You can't specify a custom minimumHealthyPercent value for a service that uses either the blue/green (CODE_DEPLOY) or
- * EXTERNAL deployment types and has tasks that use the EC2 launch type.
You can't specify a custom minimumHealthyPercent value for a service that uses
+ * either the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and has
+ * tasks that use the EC2 launch type.
If a service
- * is using either the blue/green (CODE_DEPLOY) or EXTERNAL
- * deployment types and is running tasks that use the Fargate launch type,
- * the minimum healthy percent value is not used, although it is returned when describing
- * your service.
If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL
+ * deployment types and is running tasks that use the Fargate launch type, the minimum
+ * healthy percent value is not used, although it is returned when describing your service.
The deployment controller to use for the service. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
+ *The deployment controller to use for the service. For more information, see Amazon ECS deployment + * types in the Amazon Elastic Container Service Developer Guide.
* @public */ export interface DeploymentController { @@ -1550,23 +1506,23 @@ export interface DeploymentController { *The rolling update (ECS) deployment type involves replacing
- * the current running version of the container with the latest version. The
- * number of containers Amazon ECS adds or removes from the service during a rolling
- * update is controlled by adjusting the minimum and maximum number of healthy
- * tasks allowed during a service deployment, as specified in the DeploymentConfiguration.
The rolling update (ECS) deployment type involves replacing the current
+ * running version of the container with the latest version. The number of containers Amazon ECS
+ * adds or removes from the service during a rolling update is controlled by adjusting the
+ * minimum and maximum number of healthy tasks allowed during a service deployment, as
+ * specified in the DeploymentConfiguration.
The blue/green (CODE_DEPLOY) deployment type uses the
- * blue/green deployment model powered by CodeDeploy, which allows you to verify a
- * new deployment of a service before sending production traffic to it.
The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment
+ * model powered by CodeDeploy, which allows you to verify a new deployment of a service before
+ * sending production traffic to it.
The external (EXTERNAL) deployment type enables you to use
- * any third-party deployment controller for full control over the deployment
- * process for an Amazon ECS service.
The external (EXTERNAL) deployment type enables you to use any third-party
+ * deployment controller for full control over the deployment process for an Amazon ECS
+ * service.
The load balancer configuration to use with a service or task set.
- *When you add, update, or remove a load balancer configuration, Amazon ECS starts a new - * deployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and - * deregister from load balancers.
- *We recommend that you verify this on a test environment before you update the Elastic Load Balancing - * configuration.
- *A service-linked role is required for services that use multiple target groups. For - * more information, see Using - * service-linked roles in the Amazon Elastic Container Service Developer Guide.
+ *When you add, update, or remove a load balancer configuration, Amazon ECS starts a new deployment with the + * updated Elastic Load Balancing configuration. This causes tasks to register to and deregister from load + * balancers.
+ *We recommend that you verify this on a test environment before you update the Elastic Load Balancing configuration.
+ *A service-linked role is required for services that use multiple target groups. For more information, + * see Using service-linked roles in the Amazon Elastic Container Service Developer Guide.
* @public */ export interface LoadBalancer { /** - *The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or - * task set.
+ *The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
*A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
- *For services using the ECS deployment controller, you can specify one or
- * multiple target groups. For more information, see Registering multiple target groups with a service in
- * the Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY deployment controller, you're required
- * to define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the
- * Amazon Elastic Container Service Developer Guide.
For services using the ECS deployment controller, you can specify one or multiple target
+ * groups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY deployment controller, you're required to define two
+ * target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc network mode, you
- * must choose ip as the target type, not instance. Do this
- * when creating your target groups because tasks that use the awsvpc
- * network mode are associated with an elastic network interface, not an Amazon EC2
- * instance. This network mode is required for the Fargate launch
- * type.
If your service's task definition uses the awsvpc network mode, you must choose
+ * ip as the target type, not instance. Do this when creating your
+ * target groups because tasks that use the awsvpc network mode are associated with an
+ * elastic network interface, not an Amazon EC2 instance. This network mode is required for the
+ * Fargate launch type.
The name of the load balancer to associate with the service or task set.
- *If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be - * omitted.
+ *The name of the load balancer to associate with the Amazon ECS service or task set.
+ *If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
* @public */ loadBalancerName?: string | undefined; /** - *The name of the container (as it appears in a container definition) to associate with - * the load balancer.
- *You need to specify the container name when configuring the target group for an Amazon ECS - * load balancer.
+ *The name of the container (as it appears in a container definition) to associate with the load + * balancer.
+ *You need to specify the container name when configuring the target group for an Amazon ECS load + * balancer.
* @public */ containerName?: string | undefined; /** - *The port on the container to associate with the load balancer. This port must
- * correspond to a containerPort in the task definition the tasks in the
- * service are using. For tasks that use the EC2 launch type, the container
- * instance they're launched on must allow ingress traffic on the hostPort of
- * the port mapping.
The port on the container to associate with the load balancer. This port must correspond to a
+ * containerPort in the task definition the tasks in the service are using. For tasks
+ * that use the EC2 launch type, the container instance they're launched on must allow
+ * ingress traffic on the hostPort of the port mapping.
The IDs of the subnets associated with the task or service. There's a limit of 16
- * subnets that can be specified per awsvpcConfiguration.
The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be
+ * specified per awsvpcConfiguration.
All specified subnets must be from the same VPC.
*The IDs of the security groups associated with the task or service. If you don't
- * specify a security group, the default security group for the VPC is used. There's a
- * limit of 5 security groups that can be specified per
- * awsvpcConfiguration.
The IDs of the security groups associated with the task or service. If you don't specify a security
+ * group, the default security group for the VPC is used. There's a limit of 5 security groups that can be
+ * specified per awsvpcConfiguration.
All specified security groups must be from the same VPC.
*Whether the task's elastic network interface receives a public IP address. The default
- * value is DISABLED.
Whether the task's elastic network interface receives a public IP address. The default value is
+ * DISABLED.
An object representing a constraint on task placement. For more information, see - * Task placement constraints in the - * Amazon Elastic Container Service Developer Guide.
+ *An object representing a constraint on task placement. For more information, see Task + * placement constraints in the Amazon Elastic Container Service Developer Guide.
*If you're using the Fargate launch type, task placement constraints - * aren't supported.
+ *If you're using the Fargate launch type, task placement constraints aren't + * supported.
*The type of constraint. Use distinctInstance to ensure that each task in
- * a particular group is running on a different container instance. Use
- * memberOf to restrict the selection to a group of valid
- * candidates.
The type of constraint. Use distinctInstance to ensure that each task in a particular
+ * group is running on a different container instance. Use memberOf to restrict the selection
+ * to a group of valid candidates.
A cluster query language expression to apply to the constraint. The expression can
- * have a maximum length of 2000 characters. You can't specify an expression if the
- * constraint type is distinctInstance. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
A cluster query language expression to apply to the constraint. The expression can have a maximum
+ * length of 2000 characters. You can't specify an expression if the constraint type is
+ * distinctInstance. For more information, see Cluster
+ * query language in the Amazon Elastic Container Service Developer Guide.
The task placement strategy for a task or service. For more information, see Task placement strategies in the - * Amazon Elastic Container Service Developer Guide.
+ *The task placement strategy for a task or service. For more information, see Task + * placement strategies in the Amazon Elastic Container Service Developer Guide.
* @public */ export interface PlacementStrategy { /** - *The type of placement strategy. The random placement strategy randomly
- * places tasks on available candidates. The spread placement strategy spreads
- * placement across available candidates evenly based on the field parameter.
- * The binpack strategy places tasks on available candidates that have the
- * least available amount of the resource that's specified with the field
- * parameter. For example, if you binpack on memory, a task is placed on the instance with
- * the least amount of remaining memory but still enough to run the task.
The type of placement strategy. The random placement strategy randomly places tasks on
+ * available candidates. The spread placement strategy spreads placement across available
+ * candidates evenly based on the field parameter. The binpack strategy places
+ * tasks on available candidates that have the least available amount of the resource that's specified
+ * with the field parameter. For example, if you binpack on memory, a task is placed on the
+ * instance with the least amount of remaining memory but still enough to run the task.
The field to apply the placement strategy against. For the spread
- * placement strategy, valid values are instanceId (or host,
- * which has the same effect), or any platform or custom attribute that's applied to a
- * container instance, such as attribute:ecs.availability-zone. For the
- * binpack placement strategy, valid values are cpu and
- * memory. For the random placement strategy, this field is
- * not used.
The field to apply the placement strategy against. For the spread placement strategy,
+ * valid values are instanceId (or host, which has the same effect), or any
+ * platform or custom attribute that's applied to a container instance, such as
+ * attribute:ecs.availability-zone. For the binpack placement strategy,
+ * valid values are cpu and memory. For the random placement
+ * strategy, this field is not used.
An object representing the secret to expose to your container. Secrets can be exposed - * to a container in the following ways:
+ *An object representing the secret to expose to your container. Secrets can be exposed to a container + * in the following ways:
*To inject sensitive data into your containers as environment variables, use
- * the secrets container definition parameter.
To inject sensitive data into your containers as environment variables, use the
+ * secrets container definition parameter.
To reference sensitive information in the log configuration of a container,
- * use the secretOptions container definition parameter.
To reference sensitive information in the log configuration of a container, use the
+ * secretOptions container definition parameter.
For more information, see Specifying - * sensitive data in the Amazon Elastic Container Service Developer Guide.
+ *For more information, see Specifying sensitive + * data in the Amazon Elastic Container Service Developer Guide.
* @public */ export interface Secret { @@ -1880,17 +1824,15 @@ export interface Secret { name: string | undefined; /** - *The secret to expose to the container. The supported values are either the full ARN - * of the Secrets Manager secret or the full ARN of the parameter in the SSM - * Parameter Store.
- *For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or - * Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter - * store) in the Amazon Elastic Container Service Developer Guide.
+ *The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
+ *For information about the require Identity and Access Management permissions, see Required + * IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM + * permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the + * Amazon Elastic Container Service Developer Guide.
*If the SSM Parameter Store parameter exists in the same Region as the task - * you're launching, then you can use either the full ARN or name of the parameter. - * If the parameter exists in a different Region, then the full ARN must be - * specified.
+ *If the SSM Parameter Store parameter exists in the same Region as the task you're launching, + * then you can use either the full ARN or name of the parameter. If the parameter exists in a + * different Region, then the full ARN must be specified.
*The log configuration for the container. This parameter maps to LogConfig
- * in the docker container create command and the
- * --log-driver option to docker
- * run.
By default, containers use the same logging driver that the Docker daemon uses. - * However, the container might use a different logging driver than the Docker daemon by - * specifying a log driver configuration in the container definition.
- *Understand the following when specifying a log configuration for your - * containers.
+ *The log configuration for the container. This parameter maps to LogConfig in the docker
+ * container create command and the --log-driver option to docker run.
By default, containers use the same logging driver that the Docker daemon uses. However, the + * container might use a different logging driver than the Docker daemon by specifying a log driver + * configuration in the container definition.
+ *Understand the following when specifying a log configuration for your containers.
*Amazon ECS currently supports a subset of the logging drivers available to the - * Docker daemon. Additional log drivers may be available in future releases of the - * Amazon ECS container agent.
+ *Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. + * Additional log drivers may be available in future releases of the Amazon ECS container agent.
*For tasks on Fargate, the supported log drivers are awslogs,
* splunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are
- * awslogs, fluentd, gelf,
- * json-file, journald,syslog,
- * splunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs,
+ * fluentd, gelf, json-file,
+ * journald,syslog, splunk, and
+ * awsfirelens.
This parameter requires version 1.18 of the Docker Remote API or greater on - * your container instance.
+ *This parameter requires version 1.18 of the Docker Remote API or greater on your container + * instance.
*For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must
- * register the available logging drivers with the
- * ECS_AVAILABLE_LOGGING_DRIVERS environment variable before
- * containers placed on that instance can use these log configuration options. For
+ *
For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the
+ * available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS environment
+ * variable before containers placed on that instance can use these log configuration options. For
* more information, see Amazon ECS container agent configuration in the
* Amazon Elastic Container Service Developer Guide.
For tasks that are on Fargate, because you don't have access to the - * underlying infrastructure your tasks are hosted on, any additional software - * needed must be installed outside of the task. For example, the Fluentd output - * aggregators or a remote host running Logstash to send Gelf logs to.
+ *For tasks that are on Fargate, because you don't have access to the underlying + * infrastructure your tasks are hosted on, any additional software needed must be installed + * outside of the task. For example, the Fluentd output aggregators or a remote host running + * Logstash to send Gelf logs to.
*The log driver to use for the container.
- *For tasks on Fargate, the supported log drivers are awslogs,
- * splunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are
- * awslogs, fluentd, gelf,
- * json-file, journald, syslog,
- * splunk, and awsfirelens.
For more information about using the awslogs log driver, see Send
- * Amazon ECS logs to CloudWatch in the Amazon Elastic Container Service Developer Guide.
For more information about using the awsfirelens log driver, see Send
- * Amazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner.
For tasks on Fargate, the supported log drivers are awslogs, splunk, and
+ * awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs,
+ * fluentd, gelf, json-file, journald,
+ * syslog, splunk, and awsfirelens.
For more information about using the awslogs log driver, see Send Amazon ECS logs to CloudWatch in the
+ * Amazon Elastic Container Service Developer Guide.
For more information about using the awsfirelens log driver, see Send Amazon ECS logs to
+ * an Amazon Web Services service or Amazon Web Services Partner.
If you have a custom driver that isn't listed, you can fork the Amazon ECS container - * agent project that's available - * on GitHub and customize it to work with that driver. We encourage you to - * submit pull requests for changes that you would like to have included. However, we - * don't currently provide support for running modified copies of this software.
+ *If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project + * that's available on GitHub and + * customize it to work with that driver. We encourage you to submit pull requests for changes that + * you would like to have included. However, we don't currently provide support for running modified + * copies of this software.
*The configuration options to send to the log driver.
- *The options you can specify depend on the log driver. Some
- * of the options you can specify when you use the awslogs log driver to route logs to
- * Amazon CloudWatch include the following:
The options you can specify depend on the log driver. Some of the options you can specify when you
+ * use the awslogs log driver to route logs to Amazon CloudWatch include the following:
Required: No
- *Specify whether you want the log group to be
- * created automatically. If this option isn't
- * specified, it defaults to
- * false.
Specify whether you want the log group to be created automatically. If this option isn't
+ * specified, it defaults to false.
Your IAM policy must include the
- * logs:CreateLogGroup permission before
- * you attempt to use
- * awslogs-create-group.
Your IAM policy must include the logs:CreateLogGroup permission before
+ * you attempt to use awslogs-create-group.
Required: Yes
- *Specify the Amazon Web Services Region that the
- * awslogs log driver is to send your
- * Docker logs to. You can choose to send all of your
- * logs from clusters in different Regions to a
- * single region in CloudWatch Logs. This is so that they're
- * all visible in one location. Otherwise, you can
- * separate them by Region for more granularity. Make
- * sure that the specified log group exists in the
- * Region that you specify with this option.
Specify the Amazon Web Services Region that the awslogs log driver is to send your Docker
+ * logs to. You can choose to send all of your logs from clusters in different Regions to a
+ * single region in CloudWatch Logs. This is so that they're all visible in one location. Otherwise, you
+ * can separate them by Region for more granularity. Make sure that the specified log group
+ * exists in the Region that you specify with this option.
Required: Yes
- *Make sure to specify a log group that the
- * awslogs log driver sends its log
- * streams to.
Make sure to specify a log group that the awslogs log driver sends its log
+ * streams to.
Required: Yes, when - * using the Fargate launch - * type.Optional for - * the EC2 launch type, required for - * the Fargate launch - * type.
- *Use the awslogs-stream-prefix
- * option to associate a log stream with the
- * specified prefix, the container name, and the ID
- * of the Amazon ECS task that the container belongs to.
- * If you specify a prefix with this option, then the
- * log stream takes the format prefix-name/container-name/ecs-task-id.
If you don't specify a prefix - * with this option, then the log stream is named - * after the container ID that's assigned by the - * Docker daemon on the container instance. Because - * it's difficult to trace logs back to the container - * that sent them with just the Docker container ID - * (which is only available on the container - * instance), we recommend that you specify a prefix - * with this option.
- *For Amazon ECS services, you can use the service - * name as the prefix. Doing so, you can trace log - * streams to the service that the container belongs - * to, the name of the container that sent them, and - * the ID of the task that the container belongs - * to.
- *You must specify a - * stream-prefix for your logs to have your logs - * appear in the Log pane when using the Amazon ECS - * console.
+ *Required: Yes, when using the Fargate launch + * type.Optional for the EC2 launch type, required for the + * Fargate launch type.
+ *Use the awslogs-stream-prefix option to associate a log stream with the
+ * specified prefix, the container name, and the ID of the Amazon ECS task that the container
+ * belongs to. If you specify a prefix with this option, then the log stream takes the format
+ * prefix-name/container-name/ecs-task-id.
If you don't specify a prefix with this option, then the log stream is named after the + * container ID that's assigned by the Docker daemon on the container instance. Because it's + * difficult to trace logs back to the container that sent them with just the Docker container + * ID (which is only available on the container instance), we recommend that you specify a + * prefix with this option.
+ *For Amazon ECS services, you can use the service name as the prefix. Doing so, you can trace + * log streams to the service that the container belongs to, the name of the container that + * sent them, and the ID of the task that the container belongs to.
+ *You must specify a stream-prefix for your logs to have your logs appear in the Log pane + * when using the Amazon ECS console.
*Required: No
- *This option defines a multiline start pattern
- * in Python strftime format. A log
- * message consists of a line that matches the
- * pattern and any following lines that don’t match
- * the pattern. The matched line is the delimiter
- * between log messages.
One example of a use case for using this - * format is for parsing output such as a stack dump, - * which might otherwise be logged in multiple - * entries. The correct pattern allows it to be - * captured in a single entry.
+ *This option defines a multiline start pattern in Python strftime format. A
+ * log message consists of a line that matches the pattern and any following lines that don’t
+ * match the pattern. The matched line is the delimiter between log messages.
One example of a use case for using this format is for parsing output such as a stack + * dump, which might otherwise be logged in multiple entries. The correct pattern allows it to + * be captured in a single entry.
*For more information, see awslogs-datetime-format.
- *You cannot configure both the
- * awslogs-datetime-format and
- * awslogs-multiline-pattern
- * options.
You cannot configure both the awslogs-datetime-format and
+ * awslogs-multiline-pattern options.
Multiline logging performs regular - * expression parsing and matching of all log - * messages. This might have a negative impact on - * logging performance.
+ *Multiline logging performs regular expression parsing and matching of all log + * messages. This might have a negative impact on logging performance.
*Required: No
- *This option defines a multiline start pattern - * that uses a regular expression. A log message - * consists of a line that matches the pattern and - * any following lines that don’t match the pattern. - * The matched line is the delimiter between log - * messages.
+ *This option defines a multiline start pattern that uses a regular expression. A log + * message consists of a line that matches the pattern and any following lines that don’t + * match the pattern. The matched line is the delimiter between log messages.
*For more information, see awslogs-multiline-pattern.
- *This option is ignored if
- * awslogs-datetime-format is also
- * configured.
You cannot configure both the
- * awslogs-datetime-format and
- * awslogs-multiline-pattern
- * options.
This option is ignored if awslogs-datetime-format is also configured.
You cannot configure both the awslogs-datetime-format and
+ * awslogs-multiline-pattern options.
Multiline logging performs regular - * expression parsing and matching of all log - * messages. This might have a negative impact on - * logging performance.
+ *Multiline logging performs regular expression parsing and matching of all log + * messages. This might have a negative impact on logging performance.
*Required: No
- *Valid values: non-blocking |
- * blocking
+ *
Valid values: non-blocking | blocking
*
This option defines the delivery mode of log - * messages from the container to CloudWatch Logs. The delivery - * mode you choose affects application availability - * when the flow of logs from container to CloudWatch is - * interrupted.
- *If you use the blocking
- * mode and the flow of logs to CloudWatch is interrupted,
- * calls from container code to write to the
- * stdout and stderr
- * streams will block. The logging thread of the
- * application will block as a result. This may cause
- * the application to become unresponsive and lead to
- * container healthcheck failure.
If you use the non-blocking mode,
- * the container's logs are instead stored in an
- * in-memory intermediate buffer configured with the
- * max-buffer-size option. This prevents
- * the application from becoming unresponsive when
- * logs cannot be sent to CloudWatch. We recommend using this mode if you want to
- * ensure service availability and are okay with some
- * log loss. For more information, see Preventing log loss with non-blocking mode in the awslogs container log driver.
This option defines the delivery mode of log messages from the container to CloudWatch Logs. The + * delivery mode you choose affects application availability when the flow of logs from + * container to CloudWatch is interrupted.
+ *If you use the blocking mode and the flow of logs to CloudWatch is interrupted,
+ * calls from container code to write to the stdout and stderr
+ * streams will block. The logging thread of the application will block as a result. This may
+ * cause the application to become unresponsive and lead to container healthcheck failure.
If you use the non-blocking mode, the container's logs are instead stored in
+ * an in-memory intermediate buffer configured with the max-buffer-size option.
+ * This prevents the application from becoming unresponsive when logs cannot be sent to CloudWatch.
+ * We recommend using this mode if you want to ensure service availability and are okay with
+ * some log loss. For more information, see Preventing log loss with non-blocking mode in the awslogs container log
+ * driver.
Required: No
*Default value: 1m
*
When non-blocking mode is used,
- * the max-buffer-size log option
- * controls the size of the buffer that's used for
- * intermediate message storage. Make sure to specify
- * an adequate buffer size based on your application.
- * When the buffer fills up, further logs cannot be
- * stored. Logs that cannot be stored are lost.
- *
When non-blocking mode is used, the max-buffer-size log option
+ * controls the size of the buffer that's used for intermediate message storage. Make sure to
+ * specify an adequate buffer size based on your application. When the buffer fills up,
+ * further logs cannot be stored. Logs that cannot be stored are lost.
To route logs using the splunk log router, you need to specify a
- * splunk-token and a
- * splunk-url.
When you use the awsfirelens log router to route logs to an Amazon Web Services Service or
- * Amazon Web Services Partner Network destination for log storage and analytics, you can
- * set the log-driver-buffer-limit option to limit
- * the number of events that are buffered in memory, before
- * being sent to the log router container. It can help to
- * resolve potential log loss issue because high throughput
- * might result in memory running out for the buffer inside of
- * Docker.
Other options you can specify when using awsfirelens to route
- * logs depend on the destination. When you export logs to
- * Amazon Data Firehose, you can specify the Amazon Web Services Region with
- * region and a name for the log stream with
- * delivery_stream.
When you export logs to
- * Amazon Kinesis Data Streams, you can specify an Amazon Web Services Region with
- * region and a data stream name with
- * stream.
When you export logs to Amazon OpenSearch Service,
- * you can specify options like Name,
- * Host (OpenSearch Service endpoint without protocol), Port,
- * Index, Type,
+ * splunk-token and a splunk-url.
When you use the awsfirelens log router to route logs to an Amazon Web Services Service or Amazon Web Services Partner Network
+ * destination for log storage and analytics, you can set the log-driver-buffer-limit option
+ * to limit the number of events that are buffered in memory, before being sent to the log router
+ * container. It can help to resolve potential log loss issue because high throughput might result in
+ * memory running out for the buffer inside of Docker.
Other options you can specify when using awsfirelens to route logs depend on the
+ * destination. When you export logs to Amazon Data Firehose, you can specify the Amazon Web Services Region with
+ * region and a name for the log stream with delivery_stream.
When you export logs to Amazon Kinesis Data Streams, you can specify an Amazon Web Services Region with region and a
+ * data stream name with stream.
When you export logs to Amazon OpenSearch Service, you can specify options like Name, Host
+ * (OpenSearch Service endpoint without protocol), Port, Index, Type,
* Aws_auth, Aws_region, Suppress_Type_Name, and
* tls.
When you export logs to Amazon S3, you can
- * specify the bucket using the bucket option. You can also specify region,
- * total_file_size, upload_timeout,
- * and use_put_object as options.
When you export logs to Amazon S3, you can specify the bucket using the bucket option. You
+ * can also specify region, total_file_size, upload_timeout, and
+ * use_put_object as options.
This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '\{\{.Server.APIVersion\}\}'
*
The secrets to pass to the log configuration. For more information, see Specifying - * sensitive data in the Amazon Elastic Container Service Developer Guide.
+ *The secrets to pass to the log configuration. For more information, see Specifying sensitive + * data in the Amazon Elastic Container Service Developer Guide.
* @public */ secretOptions?: Secret[] | undefined; } /** - *Each alias ("endpoint") is a fully-qualified name and port number that other tasks - * ("clients") can use to connect to this service.
+ *Each alias ("endpoint") is a fully-qualified name and port number that other tasks ("clients") can + * use to connect to this service.
*Each name and port mapping must be unique within the namespace.
*Tasks that run in a namespace can use short names to connect * to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. @@ -2189,25 +2059,24 @@ export interface LogConfiguration { */ export interface ServiceConnectClientAlias { /** - *
The listening port number for the Service Connect proxy. This port is available - * inside of all of the tasks within the same namespace.
- *To avoid changing your applications in client Amazon ECS services, set this to the same - * port that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
+ *The listening port number for the Service Connect proxy. This port is available inside of all of the + * tasks within the same namespace.
+ *To avoid changing your applications in client Amazon ECS services, set this to the same port that the + * client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
* @public */ port: number | undefined; /** - *The dnsName is the name that you use in the applications of client tasks
- * to connect to this service. The name must be a valid DNS name but doesn't need to be
- * fully-qualified. The name can include up to 127 characters. The name can include
- * lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name
- * can't start with a hyphen.
The dnsName is the name that you use in the applications of client tasks to connect to
+ * this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can
+ * include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens
+ * (-), and periods (.). The name can't start with a hyphen.
If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
To avoid changing your applications in client Amazon ECS services, set this to the same
- * name that the client application uses by default. For example, a few common names are
- * database, db, or the lowercase name of a database, such as
- * mysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
To avoid changing your applications in client Amazon ECS services, set this to the same name that the
+ * client application uses by default. For example, a few common names are database,
+ * db, or the lowercase name of a database, such as mysql or
+ * redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
An object that represents the timeout configurations for Service Connect.
*If idleTimeout is set to a time that is less than
- * perRequestTimeout, the connection will close when the
- * idleTimeout is reached and not the
- * perRequestTimeout.
If idleTimeout is set to a time that is less than perRequestTimeout,
+ * the connection will close when the idleTimeout is reached and not the
+ * perRequestTimeout.
The amount of time in seconds a connection will stay active while idle. A value of
- * 0 can be set to disable idleTimeout.
The idleTimeout default for
- * HTTP/HTTP2/GRPC is 5 minutes.
The amount of time in seconds a connection will stay active while idle. A value of 0 can
+ * be set to disable idleTimeout.
The idleTimeout default for HTTP/HTTP2/GRPC is 5
+ * minutes.
The idleTimeout default for TCP is 1 hour.
The amount of time waiting for the upstream to respond with a complete response per
- * request. A value of 0 can be set to disable perRequestTimeout.
- * perRequestTimeout can only be set if Service Connect
- * appProtocol isn't TCP. Only idleTimeout is
- * allowed for TCP
+ *
The amount of time waiting for the upstream to respond with a complete response per request. A value
+ * of 0 can be set to disable perRequestTimeout. perRequestTimeout
+ * can only be set if Service Connect appProtocol isn't TCP. Only
+ * idleTimeout is allowed for TCP
* appProtocol.
The portName must match the name of one of the portMappings
- * from all the containers in the task definition of this Amazon ECS service.
The portName must match the name of one of the portMappings from all the
+ * containers in the task definition of this Amazon ECS service.
The list of client aliases for this Service Connect service. You use these to assign - * names that can be used by client applications. The maximum number of client aliases that - * you can have in this list is 1.
- *Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS - * tasks ("clients") can use to connect to this service.
+ *The list of client aliases for this Service Connect service. You use these to assign names that can + * be used by client applications. The maximum number of client aliases that you can have in this list is + * 1.
+ *Each alias ("endpoint") is a fully-qualified name and port number that other Amazon ECS tasks ("clients") + * can use to connect to this service.
*Each name and port mapping must be unique within the namespace.
- *For each ServiceConnectService, you must provide at least one
- * clientAlias with one port.
For each ServiceConnectService, you must provide at least one clientAlias
+ * with one port.
The port number for the Service Connect proxy to listen on.
- *Use the value of this field to bypass the proxy for traffic on the port number
- * specified in the named portMapping in the task definition of this
- * application, and then use it in your VPC security groups to allow traffic into the proxy
- * for this Amazon ECS service.
In awsvpc mode and Fargate, the default value is the container port
- * number. The container port number is in the portMapping in the task
- * definition. In bridge mode, the default value is the ephemeral port of the
- * Service Connect proxy.
Use the value of this field to bypass the proxy for traffic on the port number specified in the named
+ * portMapping in the task definition of this application, and then use it in your VPC
+ * security groups to allow traffic into the proxy for this Amazon ECS service.
In awsvpc mode and Fargate, the default value is the container port number. The
+ * container port number is in the portMapping in the task definition. In bridge mode, the
+ * default value is the ephemeral port of the Service Connect proxy.
A reference to an object that represents the configured timeouts for - * Service Connect.
+ *A reference to an object that represents the configured timeouts for Service Connect.
* @public */ timeout?: TimeoutConfiguration | undefined; /** - *A reference to an object that represents a Transport Layer Security (TLS) - * configuration.
+ *A reference to an object that represents a Transport Layer Security (TLS) configuration.
* @public */ tls?: ServiceConnectTlsConfiguration | undefined; } /** - *The Service Connect configuration of your Amazon ECS service. The configuration for this - * service to discover and connect to services, and be discovered by, and connected from, - * other services within a namespace.
+ *The Service Connect configuration of your Amazon ECS service. The configuration for this service to + * discover and connect to services, and be discovered by, and connected from, other services within a + * namespace.
*Tasks that run in a namespace can use short names to connect * to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. * Tasks connect through a managed proxy container @@ -2365,68 +2228,61 @@ export interface ServiceConnectConfiguration { enabled: boolean | undefined; /** - *
The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in - * the same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't - * affect Service Connect. For more information about Cloud Map, see Working - * with Services in the Cloud Map Developer Guide.
+ *The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services + * Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For + * more information about Cloud Map, see Working with Services in the + * Cloud Map Developer Guide.
* @public */ namespace?: string | undefined; /** - *The list of Service Connect service objects. These are names and aliases (also known - * as endpoints) that are used by other Amazon ECS services to connect to this service. - *
- *This field is not required for a "client" Amazon ECS service that's a member of a namespace - * only to connect to other services within the namespace. An example of this would be a - * frontend application that accepts incoming requests from either a load balancer that's - * attached to the service or by other means.
- *An object selects a port from the task definition, assigns a name for the Cloud Map - * service, and a list of aliases (endpoints) and ports for client applications to refer to - * this service.
+ *The list of Service Connect service objects. These are names and aliases (also known as endpoints) + * that are used by other Amazon ECS services to connect to this service.
+ *This field is not required for a "client" Amazon ECS service that's a member of a namespace only to + * connect to other services within the namespace. An example of this would be a frontend application that + * accepts incoming requests from either a load balancer that's attached to the service or by other + * means.
+ *An object selects a port from the task definition, assigns a name for the Cloud Map service, and a + * list of aliases (endpoints) and ports for client applications to refer to this service.
* @public */ services?: ServiceConnectService[] | undefined; /** - *The log configuration for the container. This parameter maps to LogConfig
- * in the docker container create command and the
- * --log-driver option to docker
- * run.
By default, containers use the same logging driver that the Docker daemon uses. - * However, the container might use a different logging driver than the Docker daemon by - * specifying a log driver configuration in the container definition.
- *Understand the following when specifying a log configuration for your - * containers.
+ *The log configuration for the container. This parameter maps to LogConfig in the docker
+ * container create command and the --log-driver option to docker run.
By default, containers use the same logging driver that the Docker daemon uses. However, the + * container might use a different logging driver than the Docker daemon by specifying a log driver + * configuration in the container definition.
+ *Understand the following when specifying a log configuration for your containers.
*Amazon ECS currently supports a subset of the logging drivers available to the - * Docker daemon. Additional log drivers may be available in future releases of the - * Amazon ECS container agent.
+ *Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. + * Additional log drivers may be available in future releases of the Amazon ECS container agent.
*For tasks on Fargate, the supported log drivers are awslogs,
* splunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are
- * awslogs, fluentd, gelf,
- * json-file, journald,syslog,
- * splunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs,
+ * fluentd, gelf, json-file,
+ * journald,syslog, splunk, and
+ * awsfirelens.
This parameter requires version 1.18 of the Docker Remote API or greater on - * your container instance.
+ *This parameter requires version 1.18 of the Docker Remote API or greater on your container + * instance.
*For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must
- * register the available logging drivers with the
- * ECS_AVAILABLE_LOGGING_DRIVERS environment variable before
- * containers placed on that instance can use these log configuration options. For
+ *
For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the
+ * available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS environment
+ * variable before containers placed on that instance can use these log configuration options. For
* more information, see Amazon ECS container agent configuration in the
* Amazon Elastic Container Service Developer Guide.
For tasks that are on Fargate, because you don't have access to the - * underlying infrastructure your tasks are hosted on, any additional software - * needed must be installed outside of the task. For example, the Fluentd output - * aggregators or a remote host running Logstash to send Gelf logs to.
+ *For tasks that are on Fargate, because you don't have access to the underlying + * infrastructure your tasks are hosted on, any additional software needed must be installed + * outside of the task. For example, the Fluentd output aggregators or a remote host running + * Logstash to send Gelf logs to.
*The details for the service registry.
- *Each service may be associated with one service registry. Multiple service registries - * for each service are not supported.
- *When you add, update, or remove the service registries configuration, Amazon ECS starts a - * new deployment. New tasks are registered and deregistered to the updated service - * registry configuration.
+ *Each service may be associated with one service registry. Multiple service registries for each + * service are not supported.
+ *When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. + * New tasks are registered and deregistered to the updated service registry configuration.
* @public */ export interface ServiceRegistry { /** - *The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is - * Cloud Map. For more information, see CreateService.
+ *The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more + * information, see CreateService.
* @public */ registryArn?: string | undefined; /** - *The port value used if your service discovery service specified an SRV record. This
- * field might be used if both the awsvpc network mode and SRV records are
- * used.
The port value used if your service discovery service specified an SRV record. This field might be
+ * used if both the awsvpc network mode and SRV records are used.
The container name value to be used for your service discovery service. It's already
- * specified in the task definition. If the task definition that your service task
- * specifies uses the bridge or host network mode, you must
- * specify a containerName and containerPort combination from the
- * task definition. If the task definition that your service task specifies uses the
- * awsvpc network mode and a type SRV DNS record is used, you must specify
- * either a containerName and containerPort combination or a
+ *
The container name value to be used for your service discovery service. It's already specified in the
+ * task definition. If the task definition that your service task specifies uses the bridge
+ * or host network mode, you must specify a containerName and
+ * containerPort combination from the task definition. If the task definition that your
+ * service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you
+ * must specify either a containerName and containerPort combination or a
* port value. However, you can't specify both.
The port value to be used for your service discovery service. It's already specified
- * in the task definition. If the task definition your service task specifies uses the
- * bridge or host network mode, you must specify a
- * containerName and containerPort combination from the task
- * definition. If the task definition your service task specifies uses the
- * awsvpc network mode and a type SRV DNS record is used, you must specify
- * either a containerName and containerPort combination or a
+ *
The port value to be used for your service discovery service. It's already specified in the task
+ * definition. If the task definition your service task specifies uses the bridge or
+ * host network mode, you must specify a containerName and
+ * containerPort combination from the task definition. If the task definition your
+ * service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you
+ * must specify either a containerName and containerPort combination or a
* port value. However, you can't specify both.
Determines whether to propagate the tags from the task definition to
the Amazon EBS
- * volume. Tags can only propagate to a SERVICE specified in
- *
ServiceVolumeConfiguration. If no value is specified, the tags aren't
- *
propagated.
Determines whether to propagate the tags from the task definition to
the Amazon EBS volume. Tags can only
+ * propagate to a SERVICE specified in
ServiceVolumeConfiguration. If no value
+ * is specified, the tags aren't
propagated.
Indicates whether the volume should be encrypted. If no value is specified, encryption
- * is turned on by default. This parameter maps 1:1 with the Encrypted
- * parameter of the CreateVolume API in
- * the Amazon EC2 API Reference.
Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on
+ * by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume
+ * API in the Amazon EC2 API Reference.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When
- * encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key
- * for Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId
- * parameter of the CreateVolume API in
- * the Amazon EC2 API Reference.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned
+ * on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This
+ * parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the
+ * Amazon EC2 API Reference.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an - * ID, alias, or ARN that is invalid, the action can appear to complete, but - * eventually fails.
+ *Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or + * ARN that is invalid, the action can appear to complete, but eventually fails.
*The volume type. This parameter maps 1:1 with the VolumeType parameter of
- * the CreateVolume API in the Amazon EC2 API Reference. For more
- * information, see Amazon EBS volume types in
- * the Amazon EC2 User Guide.
The volume type. This parameter maps 1:1 with the VolumeType parameter of the CreateVolume
+ * API in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types
+ * in the Amazon EC2 User Guide.
The following are the supported volume types.
*The size of the volume in GiB. You must specify either a volume size or a snapshot ID.
- * If you specify a snapshot ID, the snapshot size is used for the volume size by default.
- * You can optionally specify a volume size greater than or equal to the snapshot size.
- * This parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.
The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify
+ * a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a
+ * volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the
+ * Size parameter of the CreateVolume API in the
+ * Amazon EC2 API Reference.
The following are the supported volume size values for each volume type.
*The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot
- * ID or a volume size. This parameter maps 1:1 with the SnapshotId parameter
- * of the CreateVolume API in
- * the Amazon EC2 API Reference.
The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume
+ * size. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume
+ * API in the Amazon EC2 API Reference.
The number of I/O operations per second (IOPS). For gp3,
- * io1, and io2 volumes, this represents the number of IOPS that
- * are provisioned for the volume. For gp2 volumes, this represents the
- * baseline performance of the volume and the rate at which the volume accumulates I/O
- * credits for bursting.
The number of I/O operations per second (IOPS). For gp3, io1, and
+ * io2 volumes, this represents the number of IOPS that are provisioned for the volume.
+ * For gp2 volumes, this represents the baseline performance of the volume and the rate at
+ * which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type.
*io2: 100 - 256,000 IOPS
* This parameter is required for io1 and io2 volume types. The
- * default for gp3 volumes is 3,000 IOPS. This parameter is not
- * supported for st1, sc1, or standard volume
- * types.
This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.
This parameter is required for io1 and io2 volume types. The default for
+ * gp3 volumes is 3,000 IOPS. This parameter is not supported for
+ * st1, sc1, or standard volume types.
This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the
+ * Amazon EC2 API Reference.
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.
- * This parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter
+ * maps 1:1 with the Throughput parameter of the CreateVolume API in the
+ * Amazon EC2 API Reference.
This parameter is only supported for the gp3 volume type.
The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This
- * parameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.
The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps
+ * 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the
+ * Amazon EC2 API Reference.
The ARN of the IAM role to associate with this volume. This is the Amazon ECS
- * infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend
- * using the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM
- * policy with this role. For more information, see Amazon ECS
- * infrastructure IAM role in the Amazon ECS Developer
- * Guide.
The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role
+ * that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed
+ * AmazonECSInfrastructureRolePolicyForVolumes IAM policy with this role. For more
+ * information, see Amazon ECS infrastructure IAM
+ * role in the Amazon ECS Developer Guide.
The configuration for a volume specified in the task definition as a volume that is - * configured at launch time. Currently, the only supported volume type is an Amazon EBS - * volume.
+ *The configuration for a volume specified in the task definition as a volume that is configured at + * launch time. Currently, the only supported volume type is an Amazon EBS volume.
* @public */ export interface ServiceVolumeConfiguration { /** - *The name of the volume. This value must match the volume name from the
- * Volume object in the task definition.
The name of the volume. This value must match the volume name from the Volume object in
+ * the task definition.
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. - * These settings are used to create each Amazon EBS volume, with one volume created for each - * task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console - * once they are created.
+ *The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings + * are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS + * volumes are visible in your account in the Amazon EC2 console once they are created.
* @public */ managedEBSVolume?: ServiceManagedEBSVolumeConfiguration | undefined; } +/** + *The VPC Lattice configuration for your service that holds the information for the target group(s) + * Amazon ECS tasks will be registered to.
+ * @public + */ +export interface VpcLatticeConfiguration { + /** + *The ARN of the IAM role to associate with this VPC Lattice configuration. This is the Amazon ECS + * infrastructure IAM role that is used to manage your VPC Lattice infrastructure.
+ * @public + */ + roleArn: string | undefined; + + /** + *The full Amazon Resource Name (ARN) of the target group or groups associated with the VPC Lattice + * configuration that the Amazon ECS tasks will be registered to.
+ * @public + */ + targetGroupArn: string | undefined; + + /** + *The name of the port mapping to register in the VPC Lattice target group. This is the
+ * name of the portMapping you defined in your task definition.
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within - * a cluster, but you can have similarly named services in multiple clusters within a - * Region or across multiple Regions.
+ *The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but + * you can have similarly named services in multiple clusters within a Region or across multiple + * Regions.
* @public */ serviceName: string | undefined; /** - *The family and revision (family:revision) or
- * full ARN of the task definition to run in your service. If a revision
- * isn't specified, the latest ACTIVE revision is used.
The family and revision (family:revision) or full ARN of the
+ * task definition to run in your service. If a revision isn't specified, the latest
+ * ACTIVE revision is used.
A task definition must be specified if the service uses either the ECS or
* CODE_DEPLOY deployment controllers.
For more information about deployment types, see Amazon ECS deployment - * types.
+ *For more information about deployment types, see Amazon ECS deployment types.
* @public */ taskDefinition?: string | undefined; /** - *A load balancer object representing the load balancers to use with your service. For - * more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
- *If the service uses the rolling update (ECS) deployment controller and
- * using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach
- * to the service. The service-linked role is required for services that use multiple
- * target groups. For more information, see Using service-linked roles for Amazon ECS in the
- * Amazon Elastic Container Service Developer Guide.
If the service uses the CODE_DEPLOY deployment controller, the service is
- * required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you
- * specify two target groups (referred to as a targetGroupPair). During a
- * deployment, CodeDeploy determines which task set in your service has the status
- * PRIMARY, and it associates one target group with it. Then, it also
- * associates the other target group with the replacement task set. The load balancer can
- * also have up to two listeners: a required listener for production traffic and an
- * optional listener that you can use to perform validation tests with Lambda functions
- * before routing production traffic to it.
If you use the CODE_DEPLOY deployment controller, these values can be
- * changed when updating the service.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, - * the container name, and the container port to access from the load balancer. The - * container name must be as it appears in a container definition. The load balancer name - * parameter must be omitted. When a task from this service is placed on a container - * instance, the container instance and port combination is registered as a target in the - * target group that's specified here.
- *For Classic Load Balancers, this object must contain the load balancer name, the container name , and - * the container port to access from the load balancer. The container name must be as it - * appears in a container definition. The target group ARN parameter must be omitted. - * When a task from this service is placed on a container instance, the container instance - * is registered with the load balancer that's specified here.
- *Services with tasks that use the awsvpc network mode (for example, those
- * with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers
- * aren't supported. Also, when you create any target groups for these services, you must
- * choose ip as the target type, not instance. This is because
- * tasks that use the awsvpc network mode are associated with an elastic
- * network interface, not an Amazon EC2 instance.
A load balancer object representing the load balancers to use with your service. For more + * information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
+ *If the service uses the rolling update (ECS) deployment controller and using either an
+ * Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The
+ * service-linked role is required for services that use multiple target groups. For more information, see
+ * Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If the service uses the CODE_DEPLOY deployment controller, the service is required to
+ * use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups
+ * (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set
+ * in your service has the status PRIMARY, and it associates one target group with it. Then,
+ * it also associates the other target group with the replacement task set. The load balancer can also
+ * have up to two listeners: a required listener for production traffic and an optional listener that you
+ * can use to perform validation tests with Lambda functions before routing production traffic to
+ * it.
If you use the CODE_DEPLOY deployment controller, these values can be changed when
+ * updating the service.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container + * name, and the container port to access from the load balancer. The container name must be as it appears + * in a container definition. The load balancer name parameter must be omitted. When a task from this + * service is placed on a container instance, the container instance and port combination is registered as + * a target in the target group that's specified here.
+ *For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container + * port to access from the load balancer. The container name must be as it appears in a container + * definition. The target group ARN parameter must be omitted. When a task from this service is placed + * on a container instance, the container instance is registered with the load balancer that's specified + * here.
+ *Services with tasks that use the awsvpc network mode (for example, those with the
+ * Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers aren't supported. Also, when
+ * you create any target groups for these services, you must choose ip as the target type,
+ * not instance. This is because tasks that use the awsvpc network mode are
+ * associated with an elastic network interface, not an Amazon EC2 instance.
The details of the service discovery registry to associate with this service. For more
- * information, see Service
+ * The details of the service discovery registry to associate with this service. For more information,
+ * see Service
* discovery. Each service may be associated with one service registry. Multiple service
- * registries for each service isn't supported. Each service may be associated with one service registry. Multiple service registries for each
+ * service isn't supported. The number of instantiations of the specified task definition to place and keep
- * running in your service. This is required if The number of instantiations of the specified task definition to place and keep running in your
+ * service. This is required if The infrastructure that you run your service on. For more information, see Amazon ECS
- * launch types in the Amazon Elastic Container Service Developer Guide. The The infrastructure that you run your service on. For more information, see Amazon ECS launch
+ * types in the Amazon Elastic Container Service Developer Guide. The Fargate Spot infrastructure is available for use but a capacity provider
- * strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS
- * Developer Guide. Fargate Spot infrastructure is available for use but a capacity provider strategy must be used.
+ * For more information, see Fargate capacity providers in the Amazon ECS Developer Guide. The The A service can use either a launch type or a capacity provider strategy. If a
- * The A service can use either a launch type or a capacity provider strategy. If a The capacity provider strategy to use for the service. If a If a A capacity provider strategy may contain a maximum of 6 capacity providers. The platform version that your tasks in the service are running on. A platform version
- * is specified only for tasks using the Fargate launch type. If one isn't
- * specified, the The platform version that your tasks in the service are running on. A platform version is specified
+ * only for tasks using the Fargate launch type. If one isn't specified, the
+ * The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your
- * load balancer on your behalf. This parameter is only permitted if you are using a load
- * balancer with your service and your task definition doesn't use the The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on
+ * your behalf. This parameter is only permitted if you are using a load balancer with your service and
+ * your task definition doesn't use the If your account has already created the Amazon ECS service-linked role, that role is
- * used for your service unless you specify a role here. The service-linked role is
- * required if your task definition uses the If your account has already created the Amazon ECS service-linked role, that role is used for your
+ * service unless you specify a role here. The service-linked role is required if your task definition
+ * uses the If your specified role has a path other than If your specified role has a path other than Optional deployment parameters that control how many tasks run during the deployment and the
- * failure detection methods. Optional deployment parameters that control how many tasks run during the deployment and the ordering
+ * of stopping and starting tasks. An array of placement constraint objects to use for tasks in your service. You can
- * specify a maximum of 10 constraints for each task. This limit includes constraints in
- * the task definition and those specified at runtime. An array of placement constraint objects to use for tasks in your service. You can specify a maximum
+ * of 10 constraints for each task. This limit includes constraints in the task definition and those
+ * specified at runtime. The placement strategy objects to use for tasks in your service. You can specify a
- * maximum of 5 strategy rules for each service. The placement strategy objects to use for tasks in your service. You can specify a maximum of 5
+ * strategy rules for each service. The network configuration for the service. This parameter is required for task
- * definitions that use the The network configuration for the service. This parameter is required for task definitions that use
+ * the The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy
- * Elastic Load Balancing target health checks after a task has first started. This is only used when your
- * service is configured to use a load balancer. If your service has a load balancer
- * defined and you don't specify a health check grace period value, the default value of
- * If you do not use an Elastic Load Balancing, we recommend that you use the If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can
- * specify a health check grace period of up to 2,147,483,647 seconds (about 69 years).
- * During that time, the Amazon ECS service scheduler ignores health check status. This grace
- * period can prevent the service scheduler from marking tasks as unhealthy and stopping
- * them before they have time to come up. The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container
+ * health checks after a task has first started. If you don't specify a health check grace
+ * period value, the default value of If your service's tasks take a while to start and respond to health checks, you can specify a
+ * health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS
+ * service scheduler ignores health check status. This grace period can prevent the service scheduler from
+ * marking tasks as unhealthy and stopping them before they have time to come up.
- * schedulingStrategy is REPLICA or isn't
- * specified. If schedulingStrategy is DAEMON then this isn't
- * required.schedulingStrategy is REPLICA or isn't specified. If
+ * schedulingStrategy is DAEMON then this isn't required.FARGATE launch type runs your tasks on Fargate On-Demand
- * infrastructure.FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.EC2 launch type runs your tasks on Amazon EC2 instances registered to your
* cluster.EXTERNAL launch type runs your tasks on your on-premises server or
- * virtual machine (VM) capacity registered to your cluster.launchType is specified, the capacityProviderStrategy
- * parameter must be omitted.EXTERNAL launch type runs your tasks on your on-premises server or virtual machine
+ * (VM) capacity registered to your cluster.launchType
+ * is specified, the capacityProviderStrategy parameter must be omitted.capacityProviderStrategy is specified, the launchType
- * parameter must be omitted. If no capacityProviderStrategy or
- * launchType is specified, the
+ * capacityProviderStrategy is specified, the launchType parameter must
+ * be omitted. If no capacityProviderStrategy or launchType is specified, the
* defaultCapacityProviderStrategy for the cluster is used.LATEST platform version is used. For more information, see
- * Fargate platform
- * versions in the Amazon Elastic Container Service Developer Guide.LATEST platform version is used. For more information, see Fargate platform versions in
+ * the Amazon Elastic Container Service Developer Guide.awsvpc
- * network mode. If you specify the role parameter, you must also specify a
- * load balancer object with the loadBalancers parameter.awsvpc network mode. If you specify the
+ * role parameter, you must also specify a load balancer object with the
+ * loadBalancers parameter.awsvpc network mode or if the
- * service is configured to use service discovery, an external deployment controller,
- * multiple target groups, or Elastic Inference accelerators in which case you don't
- * specify a role here. For more information, see Using
- * service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.awsvpc network mode or if the service is configured to use service discovery,
+ * an external deployment controller, multiple target groups, or Elastic Inference accelerators in
+ * which case you don't specify a role here. For more information, see Using service-linked
+ * roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide./, then you must either
- * specify the full role ARN (this is recommended) or prefix the role name with the path.
- * For example, if a role with the name bar has a path of /foo/
- * then you would specify /foo/bar as the role name. For more information, see
- * Friendly names and paths in the IAM User
- * Guide./, then you must either specify the full
+ * role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the
+ * name bar has a path of /foo/ then you would specify /foo/bar as
+ * the role name. For more information, see Friendly names and
+ * paths in the IAM User Guide.awsvpc network mode to receive their own elastic
- * network interface, and it isn't supported for other network modes. For more information,
- * see Task networking
- * in the Amazon Elastic Container Service Developer Guide.awsvpc network mode to receive their own elastic network interface, and it isn't
+ * supported for other network modes. For more information, see Task networking in the
+ * Amazon Elastic Container Service Developer Guide.0 is used.startPeriod in
- * the task definition health check parameters. For more information, see Health
- * check.0 is used. If you don't use any of the health checks,
+ * then healthCheckGracePeriodSeconds is unused.
*
REPLICA-The replica scheduling strategy places and
- * maintains the 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. This
- * scheduler strategy is required if the service uses the CODE_DEPLOY
- * or EXTERNAL deployment controller types.REPLICA-The replica scheduling strategy places and maintains the 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. This scheduler strategy is required if the service uses the
+ * CODE_DEPLOY or EXTERNAL deployment controller types.
- * DAEMON-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 and will stop tasks
- * that don't meet the placement constraints. When you're using this strategy, you
- * don't need to specify a desired number of tasks, a task placement strategy, or
+ * DAEMON-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 and will stop tasks that don't meet the placement constraints. When you're using this
+ * strategy, you don't need to specify a desired number of tasks, a task placement strategy, or
* use Service Auto Scaling policies.
Tasks using the Fargate launch type or the
- * CODE_DEPLOY or EXTERNAL deployment controller
- * types don't support the DAEMON scheduling strategy.
Tasks using the Fargate launch type or the CODE_DEPLOY or
+ * EXTERNAL deployment controller types don't support the DAEMON
+ * scheduling strategy.
The deployment controller to use for the service. If no deployment controller is
- * specified, the default value of ECS is used.
The deployment controller to use for the service. If no deployment controller is specified, the
+ * default value of ECS is used.
The metadata that you apply to the service to help you categorize and organize them. - * Each tag consists of a key and an optional value, both of which you define. When a - * service is deleted, the tags are deleted as well.
+ *The metadata that you apply to the service to help you categorize and organize them. Each tag + * consists of a key and an optional value, both of which you define. When a service is deleted, the tags + * are deleted as well.
*The following basic restrictions apply to tags:
*Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For - * more information, see Tagging your Amazon ECS - * resources in the Amazon Elastic Container Service Developer Guide.
- *When you use Amazon ECS managed tags, you need to set the propagateTags
- * request parameter.
Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more + * information, see Tagging your Amazon ECS resources in the Amazon Elastic Container Service Developer Guide.
+ *When you use Amazon ECS managed tags, you need to set the propagateTags request
+ * parameter.
Specifies whether to propagate the tags from the task definition to the task. If no - * value is specified, the tags aren't propagated. Tags can only be propagated to the task - * during task creation. To add tags to a task after task creation, use the TagResource API action.
- *You must set this to a value other than NONE when you use Cost Explorer.
- * For more information, see Amazon ECS usage reports
- * in the Amazon Elastic Container Service Developer Guide.
Specifies whether to propagate the tags from the task definition to the task. If no value is + * specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To + * add tags to a task after task creation, use the TagResource API action.
+ *You must set this to a value other than NONE when you use Cost Explorer. For more
+ * information, see Amazon ECS usage reports in the Amazon Elastic Container Service Developer Guide.
The default is NONE.
Determines whether the execute command functionality is turned on for the service. If
- * true, this enables execute command functionality on all containers in
- * the service tasks.
true, this enables execute command functionality on all containers in the service
+ * tasks.
* @public
*/
enableExecuteCommand?: boolean | undefined;
@@ -3084,12 +2934,17 @@ export interface CreateServiceRequest {
serviceConnectConfiguration?: ServiceConnectConfiguration | undefined;
/**
- * The configuration for a volume specified in the task definition as a volume that is - * configured at launch time. Currently, the only supported volume type is an Amazon EBS - * volume.
+ *The configuration for a volume specified in the task definition as a volume that is configured at + * launch time. Currently, the only supported volume type is an Amazon EBS volume.
* @public */ volumeConfigurations?: ServiceVolumeConfiguration[] | undefined; + + /** + *The VPC Lattice configuration for the service being created.
+ * @public + */ + vpcLatticeConfigurations?: VpcLatticeConfiguration[] | undefined; } /** @@ -3098,8 +2953,7 @@ export interface CreateServiceRequest { */ export interface DeploymentEphemeralStorage { /** - *Specify an Amazon Web Services Key Management Service key ID to encrypt the ephemeral storage for - * deployment.
+ *Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.
* @public */ kmsKeyId?: string | undefined; @@ -3121,13 +2975,13 @@ export const DeploymentRolloutState = { export type DeploymentRolloutState = (typeof DeploymentRolloutState)[keyof typeof DeploymentRolloutState]; /** - *The Service Connect resource. Each configuration maps a discovery name to a - * Cloud Map service name. The data is stored in Cloud Map as part of the - * Service Connect configuration for each discovery name of this Amazon ECS service.
- *A task can resolve the dnsName for each of the clientAliases
- * of a service. However a task can't resolve the discovery names. If you want to connect
- * to a service, refer to the ServiceConnectConfiguration of that service for
- * the list of clientAliases that you can use.
The Service Connect resource. Each configuration maps a discovery name to a Cloud Map service name. + * The data is stored in Cloud Map as part of the Service Connect configuration for each discovery name + * of this Amazon ECS service.
+ *A task can resolve the dnsName for each of the clientAliases of a service.
+ * However a task can't resolve the discovery names. If you want to connect to a service, refer to the
+ * ServiceConnectConfiguration of that service for the list of clientAliases
+ * that you can use.
The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this - * Service Connect resource. You can use this ARN in other integrations with Cloud Map. - * However, Service Connect can't ensure connectivity outside of Amazon ECS.
+ * Service Connect resource. You can use this ARN in other integrations with Cloud Map. However, + * Service Connect can't ensure connectivity outside of Amazon ECS. * @public */ discoveryArn?: string | undefined; @@ -3171,8 +3025,8 @@ export interface Deployment { *A service deployment that still has running tasks, but are in the process
- * of being replaced with a new PRIMARY deployment.
A service deployment that still has running tasks, but are in the process of being
+ * replaced with a new PRIMARY deployment.
The most recent task definition that was specified for the tasks in the service to - * use.
+ *The most recent task definition that was specified for the tasks in the service to use.
* @public */ taskDefinition?: string | undefined; @@ -3198,27 +3051,24 @@ export interface Deployment { desiredCount?: number | undefined; /** - *The number of tasks in the deployment that are in the PENDING
- * status.
The number of tasks in the deployment that are in the PENDING status.
The number of tasks in the deployment that are in the RUNNING
- * status.
The number of tasks in the deployment that are in the RUNNING status.
The number of consecutively failed tasks in the deployment. A task is considered a
- * failure if the service scheduler can't launch the task, the task doesn't transition to a
- * RUNNING state, or if it fails any of its defined health checks and is
- * stopped.
The number of consecutively failed tasks in the deployment. A task is considered a failure if the
+ * service scheduler can't launch the task, the task doesn't transition to a RUNNING state,
+ * or if it fails any of its defined health checks and is stopped.
Once a service deployment has one or more successfully running tasks, the failed - * task count resets to zero and stops being evaluated.
+ *Once a service deployment has one or more successfully running tasks, the failed task count + * resets to zero and stops being evaluated.
*The launch type the tasks in the service are using. For more information, see Amazon ECS - * Launch Types in the Amazon Elastic Container Service Developer Guide.
+ *The launch type the tasks in the service are using. For more information, see Amazon ECS Launch + * Types in the Amazon Elastic Container Service Developer Guide.
* @public */ launchType?: LaunchType | undefined; /** - *The platform version that your tasks in the service run on. A platform version is only
- * specified for tasks using the Fargate launch type. If one isn't specified,
- * the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The platform version that your tasks in the service run on. A platform version is only specified for
+ * tasks using the Fargate launch type. If one isn't specified, the LATEST
+ * platform version is used. For more information, see Fargate Platform Versions in
+ * the Amazon Elastic Container Service Developer Guide.
The operating system that your tasks in the service, or tasks are running on. A - * platform family is specified only for tasks using the Fargate launch type.
- * All tasks that run as part of this service must use the same
- * platformFamily value as the service, for example,
- * LINUX..
The operating system that your tasks in the service, or tasks are running on. A platform family is + * specified only for tasks using the Fargate launch type.
+ * All tasks that run as part of this service must use the same platformFamily value as
+ * the service, for example, LINUX..
The rolloutState of a service is only returned for services that use
- * the rolling update (ECS) deployment type that aren't behind a
- * Classic Load Balancer.
The rolloutState of a service is only returned for services that use the rolling
+ * update (ECS) deployment type that aren't behind a Classic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins
- * in an IN_PROGRESS state. When the service reaches a steady state, the
- * deployment transitions to a COMPLETED state. If the service fails to reach
- * a steady state and circuit breaker is turned on, the deployment transitions to a
- * FAILED state. A deployment in FAILED state doesn't launch
- * any new tasks. For more information, see DeploymentCircuitBreaker.
The rollout state of the deployment. When a service deployment is started, it begins in an
+ * IN_PROGRESS state. When the service reaches a steady state, the deployment transitions
+ * to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is
+ * turned on, the deployment transitions to a FAILED state. A deployment in
+ * FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.
The details of the Service Connect configuration that's used by this deployment. - * Compare the configuration between multiple deployments when troubleshooting issues with - * new deployments.
+ *The details of the Service Connect configuration that's used by this deployment. Compare the + * configuration between multiple deployments when troubleshooting issues with new deployments.
*The configuration for this service to discover and connect to * services, and be discovered by, and connected from, other services within a namespace.
*Tasks that run in a namespace can use short names to connect @@ -3313,16 +3160,16 @@ export interface Deployment { serviceConnectConfiguration?: ServiceConnectConfiguration | undefined; /** - *
The list of Service Connect resources that are associated with this deployment. Each - * list entry maps a discovery name to a Cloud Map service name.
+ *The list of Service Connect resources that are associated with this deployment. Each list entry maps + * a discovery name to a Cloud Map service name.
* @public */ serviceConnectResources?: ServiceConnectServiceResource[] | undefined; /** - *The details of the volume that was configuredAtLaunch. You can configure
- * different settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. The name of the volume
- * must match the name from the task definition.
The details of the volume that was configuredAtLaunch. You can configure different
+ * settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the
+ * name from the task definition.
The VPC Lattice configuration for the service deployment.
+ * @public + */ + vpcLatticeConfigurations?: VpcLatticeConfiguration[] | undefined; } /** @@ -3372,14 +3225,14 @@ export const ScaleUnit = { export type ScaleUnit = (typeof ScaleUnit)[keyof typeof ScaleUnit]; /** - *A floating-point percentage of the desired number of tasks to place and keep running - * in the task set.
+ *A floating-point percentage of the desired number of tasks to place and keep running in the task + * set.
* @public */ export interface Scale { /** - *The value, specified as a percent total of a service's desiredCount, to
- * scale the task set. Accepted values are numbers between 0 and 100.
The value, specified as a percent total of a service's desiredCount, to scale the task
+ * set. Accepted values are numbers between 0 and 100.
Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL
- * deployment. An Amazon ECS task set includes details such as the desired number of tasks, how
- * many tasks are running, and whether the task set serves production traffic.
Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An
+ * Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and
+ * whether the task set serves production traffic.
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists - * in.
+ *The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
* @public */ clusterArn?: string | undefined; /** - *The tag specified when a task set is started. If an CodeDeploy deployment created the task
- * set, the startedBy parameter is CODE_DEPLOY. If an external
- * deployment created the task set, the startedBy field isn't used.
The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the
+ * startedBy parameter is CODE_DEPLOY. If an external deployment created the
+ * task set, the startedBy field isn't used.
The external ID associated with the task set.
- *If an CodeDeploy deployment created a task set, the externalId parameter
- * contains the CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service
- * discovery registry, the externalId parameter contains the
- * ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.
If an CodeDeploy deployment created a task set, the externalId parameter contains the CodeDeploy
+ * deployment ID.
If a task set is created for an external deployment and is associated with a service discovery
+ * registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID
+ * Cloud Map attribute.
The tasks in the task set are being stopped, and their corresponding - * targets are being deregistered from their target group.
+ *The tasks in the task set are being stopped, and their corresponding targets are being + * deregistered from their target group.
*The computed desired count for the task set. This is calculated by multiplying the
- * service's desiredCount by the task set's scale percentage. The
- * result is always rounded up. For example, if the computed desired count is 1.2, it
- * rounds up to 2 tasks.
The computed desired count for the task set. This is calculated by multiplying the service's
+ * desiredCount by the task set's scale percentage. The result is always
+ * rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.
The number of tasks in the task set that are in the PENDING status during
- * a deployment. A task in the PENDING state is preparing to enter the
- * RUNNING state. A task set enters the PENDING status when
- * it launches for the first time or when it's restarted after being in the
- * STOPPED state.
The number of tasks in the task set that are in the PENDING status during a deployment.
+ * A task in the PENDING state is preparing to enter the RUNNING state. A task
+ * set enters the PENDING status when it launches for the first time or when it's restarted
+ * after being in the STOPPED state.
The number of tasks in the task set that are in the RUNNING status during
- * a deployment. A task in the RUNNING state is running and ready for
- * use.
The number of tasks in the task set that are in the RUNNING status during a deployment.
+ * A task in the RUNNING state is running and ready for use.
The launch type the tasks in the task set are using. For more information, see Amazon ECS - * launch types in the Amazon Elastic Container Service Developer Guide.
+ *The launch type the tasks in the task set are using. For more information, see Amazon ECS launch + * types in the Amazon Elastic Container Service Developer Guide.
* @public */ launchType?: LaunchType | undefined; @@ -3536,15 +3385,16 @@ export interface TaskSet { capacityProviderStrategy?: CapacityProviderStrategyItem[] | undefined; /** - *The Fargate platform version where the tasks in the task set are running. A platform - * version is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
+ *The Fargate platform version where the tasks in the task set are running. A platform version is + * only specified for tasks run on Fargate. For more information, see Fargate platform versions in + * the Amazon Elastic Container Service Developer Guide.
* @public */ platformVersion?: string | undefined; /** - *The operating system that your tasks in the set are running on. A platform family is - * specified only for tasks that use the Fargate launch type.
+ *The operating system that your tasks in the set are running on. A platform family is specified only + * for tasks that use the Fargate launch type.
*All tasks in the set must have the same value.
* @public */ @@ -3563,57 +3413,53 @@ export interface TaskSet { loadBalancers?: LoadBalancer[] | undefined; /** - *The details for the service discovery registries to assign to this task set. For more
- * information, see Service
+ * The details for the service discovery registries to assign to this task set. For more information,
+ * see Service
* discovery. A floating-point percentage of your desired number of tasks to place and keep running
- * in the task set. A floating-point percentage of your desired number of tasks to place and keep running in the task
+ * set. The stability status. This indicates whether the task set has reached a steady state.
- * If the following conditions are met, the task set are in
- * The stability status. This indicates whether the task set has reached a steady state. If the
+ * following conditions are met, the task set are in The task The task The There are no tasks that are running on container instances in the
- * There are no tasks that are running on container instances in the All tasks are reporting a healthy status from the load balancers, service
- * discovery, and container health checks. All tasks are reporting a healthy status from the load balancers, service discovery, and
+ * container health checks. If any of those conditions aren't met, the stability status returns
- * If any of those conditions aren't met, the stability status returns The Unix timestamp for the time when the task set stability status was
- * retrieved. The Unix timestamp for the time when the task set stability status was retrieved. The metadata that you apply to the task set to help you categorize and organize them.
- * Each tag consists of a key and an optional value. You define both. The metadata that you apply to the task set to help you categorize and organize them. Each tag
+ * consists of a key and an optional value. You define both. The following basic restrictions apply to tags: The ARN that identifies the service. For more information about the ARN format,
- * see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide. The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN)
+ * in the Amazon ECS Developer Guide. The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within
- * a cluster. However, you can have similarly named services in multiple clusters within a
- * Region or across multiple Regions. The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster.
+ * However, you can have similarly named services in multiple clusters within a Region or across multiple
+ * Regions. A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the
- * container name, and the container port to access from the load balancer. The container
- * name is as it appears in a container definition. A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and
+ * the container port to access from the load balancer. The container name is as it appears in a container
+ * definition. The details for the service discovery registries to assign to this service. For more
- * information, see Service
+ * The details for the service discovery registries to assign to this service. For more information, see
+ * Service
* Discovery. The status of the service. The valid values are The status of the service. The valid values are The desired number of instantiations of the task definition to keep running on the
- * service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService. The desired number of instantiations of the task definition to keep running on the service. This
+ * value is specified when the service is created with CreateService , and it can be
+ * modified with UpdateService. The launch type the service is using. When using the DescribeServices API, this field
- * is omitted if the service was created using a capacity provider strategy. The launch type the service is using. When using the DescribeServices API, this field is omitted if
+ * the service was created using a capacity provider strategy. The capacity provider strategy the service uses. When using The capacity provider strategy the service uses. When using the DescribeServices API, this field is
+ * omitted if the service was created using a launch type. The platform version to run your service on. A platform version is only specified for
- * tasks that are hosted on Fargate. If one isn't specified, the The platform version to run your service on. A platform version is only specified for tasks that are
+ * hosted on Fargate. If one isn't specified, the The operating system that your tasks in the service run on. A platform family is
- * specified only for tasks using the Fargate launch type. All tasks that run as part of this service must use the same
- * The operating system that your tasks in the service run on. A platform family is specified only for
+ * tasks using the Fargate launch type. All tasks that run as part of this service must use the same The task definition to use for tasks in the service. This value is specified when the
- * service is created with CreateService, and it can be modified with
- * UpdateService. The task definition to use for tasks in the service. This value is specified when the service is
+ * created with CreateService, and it can be modified with UpdateService. Optional deployment parameters that control how many tasks run during the deployment
- * and the ordering of stopping and starting tasks. Optional deployment parameters that control how many tasks run during the deployment and the ordering
+ * of stopping and starting tasks. Information about a set of Amazon ECS tasks in either an CodeDeploy or an Information about a set of Amazon ECS tasks in either an CodeDeploy or an The ARN of the IAM role that's associated with the service. It allows the Amazon ECS
- * container agent to register container instances with an Elastic Load Balancing load balancer. The ARN of the IAM role that's associated with the service. It allows the Amazon ECS container agent
+ * to register container instances with an Elastic Load Balancing load balancer. The event stream for your service. A maximum of 100 of the latest events are
- * displayed. The event stream for your service. A maximum of 100 of the latest events are displayed. The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy
- * Elastic Load Balancing target health checks after a task has first started. The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target
+ * health checks after a task has first started.
- *
- * STEADY_STATE:STEADY_STATE:
*
- * runningCount is equal to the
- * computedDesiredCount.runningCount is equal to the computedDesiredCount.pendingCount is 0.DRAINING status.DRAINING
+ * status.STABILIZING.STABILIZING.
*
ACTIVE,
- * DRAINING, or INACTIVE.ACTIVE, DRAINING, or
+ * INACTIVE.DescribeServices,
- * this field is omitted if the service was created using a launch type.LATEST
- * platform version is used. For more information, see Fargate Platform
- * Versions in the Amazon Elastic Container Service Developer Guide.LATEST platform version is used. For more
+ * information, see Fargate Platform Versions in
+ * the Amazon Elastic Container Service Developer Guide.platformFamily value as the service (for example,
- * LINUX).platformFamily value as
+ * the service (for example, LINUX).EXTERNAL
- * deployment. An Amazon ECS task set includes details such as the desired number of tasks, how
- * many tasks are running, and whether the task set serves production traffic.EXTERNAL deployment. An
+ * Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and
+ * whether the task set serves production traffic.
*
REPLICA-The replica scheduling strategy places and
- * maintains the 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.REPLICA-The replica scheduling strategy places and maintains the 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.DAEMON-The daemon scheduling strategy deploys exactly one
- * task on each active container instance. This task 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 stop tasks
- * that don't meet the placement constraints.DAEMON-The daemon scheduling strategy deploys exactly one task on each
+ * active container instance. This task 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 stop tasks that don't meet the placement constraints.
Fargate tasks don't support the DAEMON
- * scheduling strategy.
Fargate tasks don't support the DAEMON scheduling
+ * strategy.
The metadata that you apply to the service to help you categorize and organize them. Each - * tag consists of a key and an optional value. You define both the key and value.
+ *The metadata that you apply to the service to help you categorize and organize them. Each tag + * consists of a key and an optional value. You define bot the key and value.
*The following basic restrictions apply to tags:
*Determines whether to use Amazon ECS managed tags for the tasks in the service. For more - * information, see Tagging Your Amazon ECS - * Resources in the Amazon Elastic Container Service Developer Guide.
+ *Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see + * Tagging Your + * Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
* @public */ enableECSManagedTags?: boolean | undefined; /** - *Determines whether to propagate the tags from the task definition or the service to - * the task. If no value is specified, the tags aren't propagated.
+ *Determines whether to propagate the tags from the task definition or the service to the task. If no + * value is specified, the tags aren't propagated.
* @public */ propagateTags?: PropagateTags | undefined; /** *Determines whether the execute command functionality is turned on for the service. If
- * true, the execute command functionality is turned on for all containers
- * in tasks as part of the service.
true, the execute command functionality is turned on for all containers in tasks as
+ * part of the service.
* @public
*/
enableExecuteCommand?: boolean | undefined;
@@ -3941,16 +3783,13 @@ export interface Service {
export interface CreateServiceResponse {
/**
* The full description of your service following the create call.
- *A service will return either a capacityProviderStrategy or
- * launchType parameter, but not both, depending where one was specified
- * when it was created.
A service will return either a capacityProviderStrategy or launchType
+ * parameter, but not both, depending where one was specified when it was created.
If a service is using the ECS deployment controller, the
- * deploymentController and taskSets parameters will not be
- * returned.
deploymentController and taskSets parameters will not be returned.
* if the service uses the CODE_DEPLOY deployment controller, the
- * deploymentController, taskSets and
- * deployments parameters will be returned, however the
- * deployments parameter will be an empty list.
deploymentController, taskSets and deployments parameters
+ * will be returned, however the deployments parameter will be an empty list.
* @public
*/
service?: Service | undefined;
@@ -4028,24 +3867,24 @@ export interface CreateTaskSetRequest {
service: string | undefined;
/**
- * The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the - * task set in.
+ *The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set + * in.
* @public */ cluster: string | undefined; /** - *An optional non-unique tag that identifies this task set in external systems. If the
- * task set is associated with a service discovery registry, the tasks in this task set
- * will have the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the provided
+ *
An optional non-unique tag that identifies this task set in external systems. If the task set is
+ * associated with a service discovery registry, the tasks in this task set will have the
+ * ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the provided
* value.
The task definition for the tasks in the task set to use. If a revision isn't
- * specified, the latest ACTIVE revision is used.
The task definition for the tasks in the task set to use. If a revision isn't specified, the latest
+ * ACTIVE revision is used.
A load balancer object representing the load balancer to use with the task set. The - * supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
+ *A load balancer object representing the load balancer to use with the task set. The supported load + * balancer types are either an Application Load Balancer or a Network Load Balancer.
* @public */ loadBalancers?: LoadBalancer[] | undefined; /** - *The details of the service discovery registries to assign to this task set. For more
- * information, see Service
+ * The details of the service discovery registries to assign to this task set. For more information, see
+ * Service
* discovery. The launch type that new tasks in the task set uses. For more information, see Amazon ECS
- * launch types in the Amazon Elastic Container Service Developer Guide. If a The launch type that new tasks in the task set uses. For more information, see Amazon ECS launch
+ * types in the Amazon Elastic Container Service Developer Guide. If a The capacity provider strategy to use for the task set. A capacity provider strategy consists of one or more capacity providers along with the
- * If a If a If specifying a capacity provider that uses an Auto Scaling group, the capacity
- * provider must already be created. New capacity providers can be created with the CreateCapacityProviderProviderAPI operation. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already
+ * be created. New capacity providers can be created with the CreateCapacityProviderProviderAPI operation. To use a Fargate capacity provider, specify either the The PutClusterCapacityProviders API operation is used to update the
- * list of available capacity providers for a cluster after the cluster is created.launchType is specified, the capacityProviderStrategy
- * parameter must be omitted.launchType is specified, the capacityProviderStrategy parameter must
+ * be omitted.base and weight to assign to them. A capacity provider
- * must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders
- * API is used to associate a capacity
- * provider with a cluster. Only capacity providers with an ACTIVE or
- * UPDATING status can be used.capacityProviderStrategy is specified, the launchType
- * parameter must be omitted. If no capacityProviderStrategy or
- * launchType is specified, the
+ * base and weight to assign to them. A capacity provider must be associated
+ * with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.
+ * Only capacity providers with an ACTIVE or UPDATING status can be used.capacityProviderStrategy is specified, the launchType parameter must
+ * be omitted. If no capacityProviderStrategy or launchType is specified, the
* defaultCapacityProviderStrategy for the cluster is used.FARGATE or
- * FARGATE_SPOT capacity providers. The Fargate capacity providers are
- * available to all accounts and only need to be associated with a cluster to be
- * used.FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all
+ * accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity + * providers for a cluster after the cluster is created.
* @public */ capacityProviderStrategy?: CapacityProviderStrategyItem[] | undefined; /** - *The platform version that the tasks in the task set uses. A platform version is
- * specified only for tasks using the Fargate launch type. If one isn't
- * specified, the LATEST platform version is used.
The platform version that the tasks in the task set uses. A platform version is specified only for
+ * tasks using the Fargate launch type. If one isn't specified, the LATEST
+ * platform version is used.
A floating-point percentage of the desired number of tasks to place and keep running - * in the task set.
+ *A floating-point percentage of the desired number of tasks to place and keep running in the task + * set.
* @public */ scale?: Scale | undefined; @@ -4127,9 +3962,9 @@ export interface CreateTaskSetRequest { clientToken?: string | undefined; /** - *The metadata that you apply to the task set to help you categorize and organize them. - * Each tag consists of a key and an optional value. You define both. When a service is - * deleted, the tags are deleted.
+ *The metadata that you apply to the task set to help you categorize and organize them. Each tag + * consists of a key and an optional value. You define both. When a service is deleted, the tags are + * deleted.
*The following basic restrictions apply to tags:
*Information about a set of Amazon ECS tasks in either an CodeDeploy or an
- * EXTERNAL deployment. A task set includes details such as the desired
- * number of tasks, how many tasks are running, and whether the task set serves production
- * traffic.
Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment.
+ * A task set includes details such as the desired number of tasks, how many tasks are running, and
+ * whether the task set serves production traffic.
The specified service isn't active. You can't update a service that's inactive. If you - * have previously deleted a service, you can re-create it with CreateService.
+ *The specified service isn't active. You can't update a service that's inactive. If you have + * previously deleted a service, you can re-create it with CreateService.
* @public */ export class ServiceNotActiveException extends __BaseException { @@ -4202,8 +4036,7 @@ export class ServiceNotActiveException extends __BaseException { } /** - *The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region - * specific.
+ *The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
* @public */ export class ServiceNotFoundException extends __BaseException { @@ -4248,22 +4081,21 @@ export type SettingName = (typeof SettingName)[keyof typeof SettingName]; */ export interface DeleteAccountSettingRequest { /** - *The resource name to disable the account setting for. If
- * serviceLongArnFormat is specified, the ARN for your Amazon ECS services is
- * affected. If taskLongArnFormat is specified, the ARN and resource ID for
- * your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is
- * specified, the ARN and resource ID for your Amazon ECS container instances is affected. If
- * awsvpcTrunking is specified, the ENI limit for your Amazon ECS container
- * instances is affected.
The resource name to disable the account setting for. If serviceLongArnFormat is
+ * specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is
+ * specified, the ARN and resource ID for your Amazon ECS tasks is affected. If
+ * containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS
+ * container instances is affected. If awsvpcTrunking is specified, the ENI limit for your
+ * Amazon ECS container instances is affected.
The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the - * root user. If you specify the root user, it disables the account setting for all users, roles, - * and the root user of the account unless a user or role explicitly overrides these settings. - * If this field is omitted, the setting is changed only for the authenticated user.
+ *The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the root user. If you + * specify the root user, it disables the account setting for all users, roles, and the root user of the account + * unless a user or role explicitly overrides these settings. If this field is omitted, the setting is + * changed only for the authenticated user.
* @public */ principalArn?: string | undefined; @@ -4301,8 +4133,8 @@ export interface Setting { value?: string | undefined; /** - *The ARN of the principal. It can be a user, role, or the root user. If this field is - * omitted, the authenticated user is assumed.
+ *The ARN of the principal. It can be a user, role, or the root user. If this field is omitted, the + * authenticated user is assumed.
* @public */ principalArn?: string | undefined; @@ -4310,9 +4142,9 @@ export interface Setting { /** *Indicates whether Amazon Web Services manages the account setting, or if the user manages it.
*
- * aws_managed account settings are read-only, as Amazon Web Services manages such on the
- * customer's behalf. Currently, the guardDutyActivate account setting is the
- * only one Amazon Web Services manages.
aws_managed account settings are read-only, as Amazon Web Services manages such on the customer's
+ * behalf. Currently, the guardDutyActivate account setting is the only one Amazon Web Services
+ * manages.
* @public
*/
type?: SettingType | undefined;
@@ -4343,39 +4175,38 @@ export const TargetType = {
export type TargetType = (typeof TargetType)[keyof typeof TargetType];
/**
- * An attribute is a name-value pair that's associated with an Amazon ECS object. Use - * attributes to extend the Amazon ECS data model by adding custom metadata to your resources. - * For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
+ *An attribute is a name-value pair that's associated with an Amazon ECS object. Use attributes to extend + * the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes + * in the Amazon Elastic Container Service Developer Guide.
* @public */ export interface Attribute { /** - *The name of the attribute. The name must contain between 1 and 128
- * characters. The name may contain letters (uppercase and lowercase), numbers, hyphens
- * (-), underscores (_), forward slashes (/), back slashes (\), or periods (.).
The name of the attribute. The name must contain between 1 and 128 characters. The name
+ * may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes
+ * (/), back slashes (\), or periods (.).
The value of the attribute. The value must contain between 1 and 128
- * characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-),
- * underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\),
- * colons (:), or spaces. The value can't start or end with a space.
The value of the attribute. The value must contain between 1 and 128 characters. It can
+ * contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs
+ * (@), forward slashes (/), back slashes (\), colons (:), or spaces. The value can't start or end with a
+ * space.
The type of the target to attach the attribute with. This parameter is required if you - * use the short form ID for a resource instead of the full ARN.
+ *The type of the target to attach the attribute with. This parameter is required if you use the short + * form ID for a resource instead of the full ARN.
* @public */ targetType?: TargetType | undefined; /** - *The ID of the target. You can specify the short form ID for a resource or the full - * Amazon Resource Name (ARN).
+ *The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
* @public */ targetId?: string | undefined; @@ -4386,17 +4217,16 @@ export interface Attribute { */ export interface DeleteAttributesRequest { /** - *The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete - * attributes. If you do not specify a cluster, the default cluster is assumed.
+ *The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. + * If you do not specify a cluster, the default cluster is assumed.
* @public */ cluster?: string | undefined; /** - *The attributes to delete from your resource. You can specify up to 10 attributes for - * each request. For custom attributes, specify the attribute name and target ID, but don't - * specify the value. If you specify the target ID using the short form, you must also - * specify the target type.
+ *The attributes to delete from your resource. You can specify up to 10 attributes for each request. + * For custom attributes, specify the attribute name and target ID, but don't specify the value. If you + * specify the target ID using the short form, you must also specify the target type.
* @public */ attributes: Attribute[] | undefined; @@ -4414,8 +4244,7 @@ export interface DeleteAttributesResponse { } /** - *The specified target wasn't found. You can view your available container instances - * with ListContainerInstances. Amazon ECS container instances are cluster-specific and + *
The specified target wasn't found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and * Region-specific.
* @public */ @@ -4458,9 +4287,8 @@ export interface DeleteCapacityProviderResponse { } /** - *You can't delete a cluster that has registered container instances. First, deregister - * the container instances before you can delete the cluster. For more information, see - * DeregisterContainerInstance.
+ *You can't delete a cluster that has registered container instances. First, deregister the container + * instances before you can delete the cluster. For more information, see DeregisterContainerInstance.
* @public */ export class ClusterContainsContainerInstancesException extends __BaseException { @@ -4480,9 +4308,8 @@ export class ClusterContainsContainerInstancesException extends __BaseException } /** - *You can't delete a cluster that contains services. First, update the service to reduce - * its desired task count to 0, and then delete the service. For more information, see - * UpdateService and DeleteService.
+ *You can't delete a cluster that contains services. First, update the service to reduce its desired + * task count to 0, and then delete the service. For more information, see UpdateService and DeleteService.
* @public */ export class ClusterContainsServicesException extends __BaseException { @@ -4561,9 +4388,9 @@ export interface DeleteServiceRequest { service: string | undefined; /** - *If true, allows you to delete a service even if it wasn't scaled down to
- * zero tasks. It's only necessary to use this if the service uses the REPLICA
- * scheduling strategy.
If true, allows you to delete a service even if it wasn't scaled down to zero tasks.
+ * It's only necessary to use this if the service uses the REPLICA scheduling
+ * strategy.
The family and revision (family:revision) or
- * full Amazon Resource Name (ARN) of the task definition to delete. You must specify a
- * revision.
The family and revision (family:revision) or full Amazon Resource Name (ARN) of
+ * the task definition to delete. You must specify a revision.
You can specify up to 10 task definitions as a comma separated list.
* @public */ @@ -4595,8 +4421,8 @@ export interface DeleteTaskDefinitionsRequest { } /** - *A failed resource. For a list of common causes, see API failure - * reasons in the Amazon Elastic Container Service Developer Guide.
+ *A failed resource. For a list of common causes, see API failure reasons in the + * Amazon Elastic Container Service Developer Guide.
* @public */ export interface Failure { @@ -4651,22 +4477,20 @@ export const ContainerCondition = { export type ContainerCondition = (typeof ContainerCondition)[keyof typeof ContainerCondition]; /** - *The dependencies defined for container startup and shutdown. A container can contain - * multiple dependencies. When a dependency is defined for container startup, for container - * shutdown it is reversed.
- *Your Amazon ECS container instances require at least version 1.26.0 of the container agent
- * to use container dependencies. However, we recommend using the latest container agent
- * version. For information about checking your agent version and updating to the latest
- * version, see Updating the Amazon ECS
- * Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,
- * your instance needs at least version 1.26.0-1 of the ecs-init package. If
- * your container instances are launched from version 20190301 or later, then
- * they contain the required versions of the container agent and ecs-init. For
- * more information, see Amazon ECS-optimized Linux AMI
- * in the Amazon Elastic Container Service Developer Guide.
The dependencies defined for container startup and shutdown. A container can contain multiple + * dependencies. When a dependency is defined for container startup, for container shutdown it is + * reversed.
+ *Your Amazon ECS container instances require at least version 1.26.0 of the container agent to use
+ * container dependencies. However, we recommend using the latest container agent version. For information
+ * about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container
+ * Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at
+ * least version 1.26.0-1 of the ecs-init package. If your container instances are launched
+ * from version 20190301 or later, then they contain the required versions of the container
+ * agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the
+ * Amazon Elastic Container Service Developer Guide.
For tasks that use the Fargate launch type, the task or service - * requires the following platforms:
+ *For tasks that use the Fargate launch type, the task or service requires the + * following platforms:
*Linux platform version 1.3.0 or later.
The dependency condition of the container. The following are the available conditions - * and their behavior:
+ *The dependency condition of the container. The following are the available conditions and their + * behavior:
*
- * START - This condition emulates the behavior of links and
- * volumes today. It validates that a dependent container is started before
- * permitting other containers to start.
START - This condition emulates the behavior of links and volumes today.
+ * It validates that a dependent container is started before permitting other containers to
+ * start.
*
- * COMPLETE - This condition validates that a dependent
- * container runs to completion (exits) before permitting other containers to
- * start. This can be useful for nonessential containers that run a script and then
- * exit. This condition can't be set on an essential container.
COMPLETE - This condition validates that a dependent container runs to
+ * completion (exits) before permitting other containers to start. This can be useful for
+ * nonessential containers that run a script and then exit. This condition can't be set on an
+ * essential container.
*
- * SUCCESS - This condition is the same as
- * COMPLETE, but it also requires that the container exits with a
- * zero status. This condition can't be set on an essential
- * container.
SUCCESS - This condition is the same as COMPLETE, but it also
+ * requires that the container exits with a zero status. This condition can't be set
+ * on an essential container.
*
- * HEALTHY - This condition validates that the dependent
- * container passes its Docker health check before permitting other containers to
- * start. This requires that the dependent container has health checks configured.
- * This condition is confirmed only at task startup.
HEALTHY - This condition validates that the dependent container passes its
+ * Docker health check before permitting other containers to start. This requires that the
+ * dependent container has health checks configured. This condition is confirmed only at task
+ * startup.
* A list of files containing the environment variables to pass to a container. You can
- * specify up to ten environment files. The file must have a .env file
- * extension. Each line in an environment file should contain an environment variable in
- * VARIABLE=VALUE format. Lines beginning with # are treated
- * as comments and are ignored.
If there are environment variables specified using the environment
- * parameter in a container definition, they take precedence over the variables contained
- * within an environment file. If multiple environment files are specified that contain the
- * same variable, they're processed from the top down. We recommend that you use unique
- * variable names. For more information, see Use a file to pass
- * environment variables to a container in the Amazon Elastic Container Service Developer Guide.
Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations - * apply.
+ *A list of files containing the environment variables to pass to a container. You can specify up to
+ * ten environment files. The file must have a .env file extension. Each line in an
+ * environment file should contain an environment variable in VARIABLE=VALUE format. Lines
+ * beginning with # are treated as comments and are ignored.
If there are environment variables specified using the environment parameter in a
+ * container definition, they take precedence over the variables contained within an environment file. If
+ * multiple environment files are specified that contain the same variable, they're processed from the top
+ * down. We recommend that you use unique variable names. For more information, see Use a file to
+ * pass environment variables to a container in the Amazon Elastic Container Service Developer Guide.
Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations apply.
*You must use the following platforms for the Fargate launch type:
*The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment - * variable file.
+ *The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable + * file.
* @public */ value: string | undefined; /** - *The file type to use. Environment files are objects in Amazon S3. The only supported value
- * is s3.
The file type to use. Environment files are objects in Amazon S3. The only supported value is
+ * s3.
Hostnames and IP address entries that are added to the /etc/hosts file of
- * a container via the extraHosts parameter of its ContainerDefinition.
Hostnames and IP address entries that are added to the /etc/hosts file of a container
+ * via the extraHosts parameter of its ContainerDefinition.
+ *
The FireLens configuration for the container. This is used to specify and configure a - * log router for container logs. For more information, see Custom log routing - * in the Amazon Elastic Container Service Developer Guide.
+ *The FireLens configuration for the container. This is used to specify and configure a log router for + * container logs. For more information, see Custom log routing in the + * Amazon Elastic Container Service Developer Guide.
* @public */ export interface FirelensConfiguration { /** - *The log router to use. The valid values are fluentd or
- * fluentbit.
The log router to use. The valid values are fluentd or fluentbit.
The options to use when configuring the log router. This field is optional and can be - * used to specify a custom configuration file or to add additional metadata, such as the - * task, task definition, cluster, and container instance details to the log event. If - * specified, the syntax to use is + *
The options to use when configuring the log router. This field is optional and can be used to specify
+ * a custom configuration file or to add additional metadata, such as the task, task definition, cluster,
+ * and container instance details to the log event. If specified, the syntax to use is
* "options":\{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"\}.
- * For more information, see Creating
- * a task definition that uses a FireLens configuration in the
- * Amazon Elastic Container Service Developer Guide.
Tasks hosted on Fargate only support the file configuration file
- * type.
Tasks hosted on Fargate only support the file configuration file type.
An object representing a container health check. Health check parameters that are
- * specified in a container definition override any Docker health checks that exist in the
- * container image (such as those specified in a parent image or from the image's
- * Dockerfile). This configuration maps to the HEALTHCHECK parameter of docker run.
An object representing a container health check. Health check parameters that are specified in a
+ * container definition override any Docker health checks that exist in the container image (such as those
+ * specified in a parent image or from the image's Dockerfile). This configuration maps to the
+ * HEALTHCHECK parameter of docker run.
The Amazon ECS container agent only monitors and reports on the health checks specified - * in the task definition. Amazon ECS does not monitor Docker health checks that are - * embedded in a container image and not specified in the container definition. Health - * check parameters that are specified in a container definition override any Docker - * health checks that exist in the container image.
+ *The Amazon ECS container agent only monitors and reports on the health checks specified in the task + * definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and + * not specified in the container definition. Health check parameters that are specified in a + * container definition override any Docker health checks that exist in the container image.
*You can view the health status of both individual containers and a task with the - * DescribeTasks API operation or when viewing the task details in the console.
- *The health check is designed to make sure that your containers survive agent restarts, - * upgrades, or temporary unavailability.
- *Amazon ECS performs health checks on containers with the default that launched the - * container instance or the task.
- *The following describes the possible healthStatus values for a
- * container:
You can view the health status of both individual containers and a task with the DescribeTasks API + * operation or when viewing the task details in the console.
+ *The health check is designed to make sure that your containers survive agent restarts, upgrades, or + * temporary unavailability.
+ *Amazon ECS performs health checks on containers with the default that launched the container instance or + * the task.
+ *The following describes the possible healthStatus values for a container:
- * HEALTHY-The container health check has passed
- * successfully.
HEALTHY-The container health check has passed successfully.
* @@ -4886,126 +4700,116 @@ export interface FirelensConfiguration { *
- * UNKNOWN-The container health check is being evaluated,
- * there's no container health check defined, or Amazon ECS doesn't have the health
- * status of the container.
UNKNOWN-The container health check is being evaluated, there's no
+ * container health check defined, or Amazon ECS doesn't have the health status of the
+ * container.
* The following describes the possible healthStatus values based on the
- * container health checker status of essential containers in the task with the following
- * priority order (high to low):
The following describes the possible healthStatus values based on the container health
+ * checker status of essential containers in the task with the following priority order (high to
+ * low):
- * UNHEALTHY-One or more essential containers have failed
- * their health check.
UNHEALTHY-One or more essential containers have failed their health
+ * check.
*
- * UNKNOWN-Any essential container running within the task is
- * in an UNKNOWN state and no other essential containers have an
- * UNHEALTHY state.
UNKNOWN-Any essential container running within the task is in an
+ * UNKNOWN state and no other essential containers have an UNHEALTHY
+ * state.
*
- * HEALTHY-All essential containers within the task have
- * passed their health checks.
HEALTHY-All essential containers within the task have passed their health
+ * checks.
* Consider the following task health example with 2 containers.
*If Container1 is UNHEALTHY and Container2 is
- * UNKNOWN, the task health is UNHEALTHY.
If Container1 is UNHEALTHY and Container2 is UNKNOWN, the task
+ * health is UNHEALTHY.
If Container1 is UNHEALTHY and Container2 is
- * HEALTHY, the task health is UNHEALTHY.
If Container1 is UNHEALTHY and Container2 is HEALTHY, the task
+ * health is UNHEALTHY.
If Container1 is HEALTHY and Container2 is UNKNOWN,
- * the task health is UNKNOWN.
If Container1 is HEALTHY and Container2 is UNKNOWN, the task health
+ * is UNKNOWN.
If Container1 is HEALTHY and Container2 is HEALTHY,
- * the task health is HEALTHY.
If Container1 is HEALTHY and Container2 is HEALTHY, the task health
+ * is HEALTHY.
Consider the following task health example with 3 containers.
*If Container1 is UNHEALTHY and Container2 is
- * UNKNOWN, and Container3 is UNKNOWN, the task health is
- * UNHEALTHY.
If Container1 is UNHEALTHY and Container2 is UNKNOWN, and
+ * Container3 is UNKNOWN, the task health is UNHEALTHY.
If Container1 is UNHEALTHY and Container2 is
- * UNKNOWN, and Container3 is HEALTHY, the task health is
- * UNHEALTHY.
If Container1 is UNHEALTHY and Container2 is UNKNOWN, and
+ * Container3 is HEALTHY, the task health is UNHEALTHY.
If Container1 is UNHEALTHY and Container2 is
- * HEALTHY, and Container3 is HEALTHY, the task health is
- * UNHEALTHY.
If Container1 is UNHEALTHY and Container2 is HEALTHY, and
+ * Container3 is HEALTHY, the task health is UNHEALTHY.
If Container1 is HEALTHY and Container2 is UNKNOWN,
- * and Container3 is HEALTHY, the task health is
- * UNKNOWN.
If Container1 is HEALTHY and Container2 is UNKNOWN, and Container3
+ * is HEALTHY, the task health is UNKNOWN.
If Container1 is HEALTHY and Container2 is UNKNOWN,
- * and Container3 is UNKNOWN, the task health is
- * UNKNOWN.
If Container1 is HEALTHY and Container2 is UNKNOWN, and Container3
+ * is UNKNOWN, the task health is UNKNOWN.
If Container1 is HEALTHY and Container2 is HEALTHY,
- * and Container3 is HEALTHY, the task health is
- * HEALTHY.
If Container1 is HEALTHY and Container2 is HEALTHY, and Container3
+ * is HEALTHY, the task health is HEALTHY.
If a task is run manually, and not as part of a service, the task will continue its - * lifecycle regardless of its health status. For tasks that are part of a service, if the - * task reports as unhealthy then the task will be stopped and the service scheduler will - * replace it.
+ *If a task is run manually, and not as part of a service, the task will continue its lifecycle + * regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy + * then the task will be stopped and the service scheduler will replace it.
*The following are notes about container health check support:
*If the Amazon ECS container agent becomes disconnected from the Amazon ECS service, this
- * won't cause a container to transition to an UNHEALTHY status. This
- * is by design, to ensure that containers remain running during agent restarts or
- * temporary unavailability. The health check status is the "last heard from"
- * response from the Amazon ECS agent, so if the container was considered
- * HEALTHY prior to the disconnect, that status will remain until
- * the agent reconnects and another health check occurs. There are no assumptions
- * made about the status of the container health checks.
If the Amazon ECS container agent becomes disconnected from the Amazon ECS service, this won't cause a
+ * container to transition to an UNHEALTHY status. This is by design, to ensure that
+ * containers remain running during agent restarts or temporary unavailability. The health check
+ * status is the "last heard from" response from the Amazon ECS agent, so if the container was
+ * considered HEALTHY prior to the disconnect, that status will remain until the
+ * agent reconnects and another health check occurs. There are no assumptions made about the
+ * status of the container health checks.
Container health checks require version 1.17.0 or greater of the
- * Amazon ECS container agent. For more information, see Updating the
- * Amazon ECS container agent.
Container health checks require version 1.17.0 or greater of the Amazon ECS container
+ * agent. For more information, see Updating the Amazon ECS container
+ * agent.
Container health checks are supported for Fargate tasks if
- * you're using platform version Container health checks are supported for Fargate tasks if you're using
+ * platform version 1.1.0 or greater. For more
- * information, see Fargate
+ * 1.1.0 or greater. For more information, see Fargate
* platform versions.
Container health checks aren't supported for tasks that are part of a service - * that's configured to use a Classic Load Balancer.
+ *Container health checks aren't supported for tasks that are part of a service that's + * configured to use a Classic Load Balancer.
*A string array representing the command that the container runs to determine if it is
- * healthy. The string array must start with CMD to run the command arguments
- * directly, or CMD-SHELL to run the command with the container's default
- * shell.
When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list - * of commands in double quotes and brackets.
+ *A string array representing the command that the container runs to determine if it is healthy. The
+ * string array must start with CMD to run the command arguments directly, or
+ * CMD-SHELL to run the command with the container's default shell.
When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in + * double quotes and brackets.
*
* [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
*
The time period in seconds between each health check execution. You may specify - * between 5 and 300 seconds. The default value is 30 seconds.
+ *The time period in seconds between each health check execution. You may specify between 5 and 300 + * seconds. The default value is 30 seconds.
* @public */ interval?: number | undefined; /** - *The time period in seconds to wait for a health check to succeed before it is - * considered a failure. You may specify between 2 and 60 seconds. The default value is - * 5.
+ *The time period in seconds to wait for a health check to succeed before it is considered a failure. + * You may specify between 2 and 60 seconds. The default value is 5.
* @public */ timeout?: number | undefined; /** - *The number of times to retry a failed health check before the container is considered - * unhealthy. You may specify between 1 and 10 retries. The default value is 3.
+ *The number of times to retry a failed health check before the container is considered unhealthy. You + * may specify between 1 and 10 retries. The default value is 3.
* @public */ retries?: number | undefined; /** - *The optional grace period to provide containers time to bootstrap before failed health
- * checks count towards the maximum number of retries. You can specify between 0 and 300
- * seconds. By default, the startPeriod is off.
The optional grace period to provide containers time to bootstrap before failed health checks count
+ * towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the
+ * startPeriod is off.
If a health check succeeds within the startPeriod, then the container
- * is considered healthy and any subsequent failures count toward the maximum number of
- * retries.
If a health check succeeds within the startPeriod, then the container is considered
+ * healthy and any subsequent failures count toward the maximum number of retries.
The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more detailed information about these Linux capabilities, - * see the capabilities(7) Linux manual page.
+ *The Linux capabilities to add or remove from the default Docker configuration for a container defined + * in the task definition. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual + * page.
* @public */ export interface KernelCapabilities { /** - *The Linux capabilities for the container that have been added to the default
- * configuration provided by Docker. This parameter maps to CapAdd in the docker container create command and the
- * --cap-add option to docker
- * run.
The Linux capabilities for the container that have been added to the default configuration provided
+ * by Docker. This parameter maps to CapAdd in the docker container create command and the
+ * --cap-add option to docker run.
Tasks launched on Fargate only support adding the SYS_PTRACE kernel
* capability.
Valid values: Valid values: The Linux capabilities for the container that have been removed from the default
- * configuration provided by Docker. This parameter maps to Valid values: The Linux capabilities for the container that have been removed from the default configuration
+ * provided by Docker. This parameter maps to Valid values: The explicit permissions to provide to the container for the device. By default, the
- * container has permissions for The explicit permissions to provide to the container for the device. By default, the container has
+ * permissions for The list of tmpfs volume mount options. Valid values: Valid values: The Linux capabilities for the container that are added to or dropped from the default
- * configuration provided by Docker. The Linux capabilities for the container that are added to or dropped from the default configuration
+ * provided by Docker. For tasks that use the Fargate launch type,
- * For tasks that use the Fargate launch type, Any host devices to expose to the container. This parameter maps to
- * Any host devices to expose to the container. This parameter maps to If you're using tasks that use the Fargate launch type, the
- * If you're using tasks that use the Fargate launch type, the Run an Run an The value for the size (in MiB) of the The value for the size (in MiB) of the If you are using tasks that use the Fargate launch type, the
* The container path, mount options, and size (in MiB) of the tmpfs mount. This
- * parameter maps to the The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
+ * If you're using tasks that use the Fargate launch type, the
- * If you're using tasks that use the Fargate launch type, the The total amount of swap memory (in MiB) a container can use. This parameter will be
- * translated to the If a The total amount of swap memory (in MiB) a container can use. This parameter will be translated to
+ * the If a If you're using tasks that use the Fargate launch type, the
- * If you're using tasks on Amazon Linux 2023 the If you're using tasks that use the Fargate launch type, the If you're using tasks on Amazon Linux 2023 the This allows you to tune a container's memory swappiness behavior. A
- * This allows you to tune a container's memory swappiness behavior. A If you're using tasks that use the Fargate launch type, the
- * If you're using tasks on Amazon Linux 2023 the If you're using tasks that use the Fargate launch type, the If you're using tasks on Amazon Linux 2023 the The name of the volume to mount. Must be a volume name referenced in the
- * The name of the volume to mount. Must be a volume name referenced in the If this value is If this value is Port mappings expose your container's network ports to the outside world. this allows
- * clients to access your application. It's also used for inter-container communication
- * within the same task. For task definitions (both the Fargate and EC2 launch type) that use the
- * Port mappings allow containers to access ports on the host container instance to send or receive
+ * traffic. Port mappings are specified as part of the container definition. If you use containers in a task with the Most fields of this parameter ( You can't expose the same container port for multiple protocols. If you attempt
- * this, an error is returned. You can't expose the same container port for multiple protocols. If you attempt this, an error is
+ * returned. After a task reaches the After a task reaches the The port number on the container that's bound to the user-specified or automatically
- * assigned host port. For tasks that use the Fargate launch type or EC2 tasks that use the
- * For Windows containers on Fargate, you can't use port 3150 for the
- * Suppose that you're using containers in a task with the EC2 launch type
- * and you specify a container port and not a host port. Then, your container automatically
- * receives a host port in the ephemeral port range. For more information, see
- * The port number on the container that's bound to the user-specified or automatically assigned host
+ * port. If you use containers in a task with the If you use containers in a task with the The port number on the container instance to reserve for your container. If you specify a If you specify a For containers in a task with the For containers in a task with the For containers in a task with the For containers in a task with the If you use containers in a task with the If you use containers in a task with the The default ephemeral port range for Docker version 1.6.0 and later is listed on the
- * instance under The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the
- * Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in
- * a running task is also reserved while the task is running. That is, after a task stops,
- * the host port is released. The current reserved ports are displayed in the
- * If you use containers in a task with the If you use containers in a task with the The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under
+ * The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container
+ * agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved
+ * while the task is running. That is, after a task stops, the host port is released. The current reserved
+ * ports are displayed in the The protocol used for the port mapping. Valid values are The protocol used for the port mapping. Valid values are The name that's used for the port mapping. This parameter only applies to
- * Service Connect. This parameter is the name that you use in the
- * For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. The name that's used for the port mapping. This parameter is the name that you use in the
+ * The application protocol that's used for the port mapping. This parameter only applies
- * to Service Connect. We recommend that you set this parameter to be consistent with the
- * protocol that your application uses. If you set this parameter, Amazon ECS adds
- * protocol-specific connection handling to the Service Connect proxy. If you set this
- * parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't
- * add protocol-specific telemetry for TCP. The application protocol that's used for the port mapping. This parameter only applies to
+ * Service Connect. We recommend that you set this parameter to be consistent with the protocol that your
+ * application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the
+ * Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS
+ * console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add
+ * protocol-specific telemetry for TCP.
- * "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" |
- * "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" |
- * "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" |
- * "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP"
- * | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" |
- * "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" |
- * "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" |
+ * "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" |
+ * "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" |
+ * "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" |
+ * "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" |
+ * "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" |
+ * "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" |
* "WAKE_ALARM"
* CapDrop in the docker container create command and the
- * --cap-drop option to docker
- * run."ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" |
- * "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" |
- * "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" |
- * "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP"
- * | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" |
- * "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" |
- * "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" |
+ * CapDrop in the docker container create command
+ * and the --cap-drop option to docker run."ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" |
+ * "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" |
+ * "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" |
+ * "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" |
+ * "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" |
+ * "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" |
* "WAKE_ALARM"
* read, write, and
- * mknod for the device.read, write, and mknod for the device."defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" |
- * "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" |
- * "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" |
- * "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" |
- * "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid"
- * | "nr_inodes" | "nr_blocks" | "mpol"
+ * "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" |
+ * "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" |
+ * "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" |
+ * "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime"
+ * | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
* capabilities is supported for all platform versions but the
- * add parameter is only supported if using platform version 1.4.0 or
- * later.capabilities is supported
+ * for all platform versions but the add parameter is only supported if using platform
+ * version 1.4.0 or later.Devices in the docker container create command and the --device option to docker run.Devices in the
+ * docker container create command and the --device option to docker run.devices parameter isn't supported.devices
+ * parameter isn't supported.init process inside the container that forwards signals and reaps
- * processes. This parameter maps to the --init option to docker run.
- * This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '\{\{.Server.APIVersion\}\}'
+ * init process inside the container that forwards signals and reaps processes. This
+ * parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '\{\{.Server.APIVersion\}\}'
* /dev/shm volume. This parameter
- * maps to the --shm-size option to docker
- * run./dev/shm volume. This parameter maps to the
+ * --shm-size option to docker run.sharedMemorySize parameter is not supported.--tmpfs option to docker run.--tmpfs option to docker run.tmpfs parameter isn't supported.tmpfs
+ * parameter isn't supported.--memory-swap option to docker run where the value would be the sum of
- * the container memory plus the maxSwap value.maxSwap value of 0 is specified, the container will not
- * use swap. Accepted values are 0 or any positive integer. If the
- * maxSwap parameter is omitted, the container will use the swap
- * configuration for the container instance it is running on. A maxSwap value
- * must be set for the swappiness parameter to be used.--memory-swap option to docker run where the value would be the sum of the container
+ * memory plus the maxSwap value.maxSwap value of 0 is specified, the container will not use swap.
+ * Accepted values are 0 or any positive integer. If the maxSwap parameter is
+ * omitted, the container will use the swap configuration for the container instance it is running on. A
+ * maxSwap value must be set for the swappiness parameter to be used.maxSwap parameter isn't supported.swappiness parameter isn't
- * supported.maxSwap
+ * parameter isn't supported.swappiness parameter isn't supported.swappiness value of 0 will cause swapping to not happen
- * unless absolutely necessary. A swappiness value of 100 will
- * cause pages to be swapped very aggressively. Accepted values are whole numbers between
- * 0 and 100. If the swappiness parameter is not
- * specified, a default value of 60 is used. If a value is not specified for
- * maxSwap then this parameter is ignored. This parameter maps to the
- * --memory-swappiness option to docker run.swappiness value of
+ * 0 will cause swapping to not happen unless absolutely necessary. A
+ * swappiness value of 100 will cause pages to be swapped very aggressively.
+ * Accepted values are whole numbers between 0 and 100. If the
+ * swappiness parameter is not specified, a default value of 60 is used. If
+ * a value is not specified for maxSwap then this parameter is ignored. This parameter maps
+ * to the --memory-swappiness option to docker run.swappiness parameter isn't supported.swappiness parameter isn't
- * supported.swappiness
+ * parameter isn't supported.swappiness parameter isn't supported.name parameter of task definition volume.name parameter
+ * of task definition volume.true, the container has read-only access to the volume.
- * If this value is false, then the container can write to the volume. The
- * default value is false.true, the container has read-only access to the volume. If this value
+ * is false, then the container can write to the volume. The default value is
+ * false.awsvpc network mode, only specify the containerPort. The
- * hostPort is always ignored, and the container port is automatically
- * mapped to a random high-numbered port on the host.awsvpc or host network mode,
+ * specify the exposed ports using containerPort. The hostPort can be left blank
+ * or it must be the same value as the containerPort.containerPort, hostPort,
- * protocol) maps to PortBindings in the docker container create command and the
- * --publish option to docker
- * run. If the network mode of a task definition is set to
- * host, host ports must either be undefined or match the container port
- * in the port mapping.protocol) maps to PortBindings in the docker container create command and
+ * the --publish option to docker run. If the network mode of a task definition
+ * is set to host, host ports must either be undefined or match the container port in the
+ * port mapping.RUNNING status, manual and automatic host and
- * container port assignments are visible in the networkBindings section of
- * DescribeTasks API responses.RUNNING status, manual and automatic host and container port
+ * assignments are visible in the networkBindings section of DescribeTasks API
+ * responses.awsvpc network mode, you use containerPort to specify the
- * exposed ports.containerPort. This is because it's reserved.hostPort. Port mappings that are automatically assigned in this way
- * don't count toward the 100 reserved ports quota of a container instance.awsvpc or host network mode,
+ * specify the exposed ports using containerPort.bridge network mode and you specify a container
+ * port and not a host port, your container automatically receives a host port in the ephemeral port
+ * range. For more information, see hostPort. Port mappings that are automatically assigned
+ * in this way do not count toward the 100 reserved ports limit of a container instance.containerPortRange, leave this field empty and the value
- * of the hostPort is set as follows:containerPortRange, leave this field empty and the value of the
+ * hostPort is set as follows:
*
- * awsvpc network mode, the
- * hostPort is set to the same value as the
- * containerPort. This is a static mapping strategy.awsvpc network mode, the hostPort
+ * is set to the same value as the containerPort. This is a static mapping
+ * strategy.bridge network mode, the Amazon ECS
- * agent finds open ports on the host and automatically binds them to the container
- * ports. This is a dynamic mapping strategy.bridge network mode, the Amazon ECS agent finds
+ * open ports on the host and automatically binds them to the container ports. This is a dynamic
+ * mapping strategy.awsvpc or host
- * network mode, the hostPort can either be left blank or set to the same
- * value as the containerPort.bridge network mode, you can
- * specify a non-reserved host port for your container port mapping, or you can omit the
- * hostPort (or set it to 0) while specifying a
- * containerPort and your container automatically receives a port in the
- * ephemeral port range for your container instance operating system and Docker
- * version./proc/sys/net/ipv4/ip_local_port_range. If this kernel
- * parameter is unavailable, the default ephemeral port range from 49153 through 65535
- * (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port
- * in the ephemeral port range as these are reserved for automatic assignment. In general,
- * ports below 32768 are outside of the ephemeral port range.remainingResources of DescribeContainerInstances output. A container instance can have up to 100
- * reserved ports at a time. This number includes the default reserved ports. Automatically
- * assigned ports aren't included in the 100 reserved ports quota.awsvpc or host network mode, the
+ * hostPort can either be left blank or set to the same value as the
+ * containerPort.bridge network mode, you can specify a
+ * non-reserved host port for your container port mapping, or you can omit the hostPort (or
+ * set it to 0) while specifying a containerPort and your container
+ * automatically receives a port in the ephemeral port range for your container instance operating system
+ * and Docker version./proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the
+ * default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used.
+ * Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic
+ * assignment. In general, ports below 32768 are outside of the ephemeral port range.remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports
+ * at a time. This number includes the default reserved ports. Automatically assigned ports aren't
+ * included in the 100 reserved ports quota.tcp and
- * udp. The default is tcp. protocol is
- * immutable in a Service Connect service. Updating this field requires a service deletion
- * and redeployment. tcp and udp. The
+ * default is tcp. protocol is immutable in a Service Connect service. Updating
+ * this field requires a service deletion and redeployment. serviceConnectConfiguration of a service. The name can include up to 64
- * characters. The characters can include lowercase letters, numbers, underscores (_), and
- * hyphens (-). The name can't start with a hyphen.serviceConnectConfiguration and the vpcLatticeConfigurations of a service.
+ * The name can include up to 64 characters. The characters can include lowercase letters, numbers,
+ * underscores (_), and hyphens (-). The name can't start with a hyphen.appProtocol is immutable in a Service Connect service. Updating this
- * field requires a service deletion and redeployment.appProtocol is immutable in a Service Connect service. Updating this field requires a
+ * service deletion and redeployment.
Tasks that run in a namespace can use short names to connect * to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. * Tasks connect through a managed proxy container @@ -5455,8 +5232,7 @@ export interface PortMapping { appProtocol?: ApplicationProtocol | undefined; /** - *
The port number range on the container that's bound to the dynamically mapped host - * port range.
+ *The port number range on the container that's bound to the dynamically mapped host port range.
*The following rules apply when you specify a containerPortRange:
The Amazon Resource Name (ARN) of the secret containing the private repository - * credentials.
+ *The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
*When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same - * Region as the task that you're launching then you can use either the full ARN or - * the name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN - * of the secret.
+ *When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the + * task that you're launching then you can use either the full ARN or the name of the secret. When + * you use the Amazon Web Services Management Console, you must specify the full ARN of the secret.
*The type and amount of a resource to assign to a container. The supported resource - * types are GPUs and Elastic Inference accelerators. For more information, see Working with - * GPUs on Amazon ECS or Working with Amazon Elastic - * Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide + *
The type and amount of a resource to assign to a container. The supported resource types are GPUs and + * Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon + * Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide *
* @public */ export interface ResourceRequirement { /** *The value for the specified resource type.
- *When the type is GPU, the value is the number of physical GPUs the
- * Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for
- * all containers in a task can't exceed the number of available GPUs on the container
- * instance that the task is launched on.
When the type is InferenceAccelerator, the value matches
- * the deviceName for an InferenceAccelerator specified in a task definition.
When the type is GPU, the value is the number of physical GPUs the Amazon ECS
+ * container agent reserves for the container. The number of GPUs that's reserved for all containers in a
+ * task can't exceed the number of available GPUs on the container instance that the task is launched
+ * on.
When the type is InferenceAccelerator, the value matches the
+ * deviceName for an InferenceAccelerator
+ * specified in a task definition.
You can enable a restart policy for each container defined in your
- * task definition, to overcome transient failures faster and maintain task availability. When you
- * enable a restart policy for a container, Amazon ECS can restart the container if it exits, without needing to replace
- * the task. For more information, see Restart individual containers
+ * You can enable a restart policy for each container defined in your task definition, to overcome
+ * transient failures faster and maintain task availability. When you enable a restart policy for a
+ * container, Amazon ECS can restart the container if it exits, without needing to replace the task. For more
+ * information, see Restart individual containers
* in Amazon ECS tasks with container restart policies in the Amazon Elastic Container Service Developer Guide. Specifies whether a restart policy is enabled for the
- * container. Specifies whether a restart policy is enabled for the container. A list of exit codes that Amazon ECS will ignore and not attempt a restart on. You can specify a maximum of 50 container exit
- * codes. By default, Amazon ECS does not ignore
- * any exit codes. A list of exit codes that Amazon ECS will ignore and not attempt a restart on. You can specify a maximum
+ * of 50 container exit codes. By default, Amazon ECS does not ignore any exit codes. A period of time (in seconds) that the container must run for before a restart can be attempted. A container can be
- * restarted only once every A period of time (in seconds) that the container must run for before a restart can be attempted. A
+ * container can be restarted only once every A list of namespaced kernel parameters to set in the container. This parameter maps to
- * We don't recommend that you specify network-related restartAttemptPeriod seconds. If a container isn't able to run for this time period and exits early, it will not be restarted. You can set a minimum
- * restartAttemptPeriod of 60 seconds and a maximum restartAttemptPeriod of 1800 seconds.
- * By default, a container must run for 300 seconds before it can be restarted.restartAttemptPeriod seconds. If a container
+ * isn't able to run for this time period and exits early, it will not be restarted. You can set a minimum
+ * restartAttemptPeriod of 60 seconds and a maximum restartAttemptPeriod of
+ * 1800 seconds. By default, a container must run for 300 seconds before it can be restarted.Sysctls in the docker container create command and the --sysctl option to docker run. For example, you can configure
- * net.ipv4.tcp_keepalive_time setting to maintain longer lived
- * connections.systemControls
- * parameters for multiple containers in a single task that also uses either the
- * awsvpc or host network mode. Doing this has the following
- * disadvantages:Sysctls in the docker container create command and the --sysctl option to
+ * docker run. For example, you can configure net.ipv4.tcp_keepalive_time setting to maintain
+ * longer lived connections.
We don't recommend that you specify network-related systemControls parameters for
+ * multiple containers in a single task that also uses either the awsvpc or host
+ * network mode. Doing this has the following disadvantages:
For tasks that use the awsvpc network mode including Fargate,
- * if you set systemControls for any container, it applies to all
- * containers in the task. If you set different systemControls for
- * multiple containers in a single task, the container that's started last
- * determines which systemControls take effect.
For tasks that use the awsvpc network mode including Fargate, if you set
+ * systemControls for any container, it applies to all containers in the task. If
+ * you set different systemControls for multiple containers in a single task, the
+ * container that's started last determines which systemControls take effect.
For tasks that use the host network mode, the network namespace
* systemControls aren't supported.
If you're setting an IPC resource namespace to use for the containers in the task, the - * following conditions apply to your system controls. For more information, see IPC mode.
+ *If you're setting an IPC resource namespace to use for the containers in the task, the following + * conditions apply to your system controls. For more information, see IPC + * mode.
*For tasks that use the host IPC mode, IPC namespace
- * systemControls aren't supported.
For tasks that use the host IPC mode, IPC namespace systemControls
+ * aren't supported.
For tasks that use the task IPC mode, IPC namespace
- * systemControls values apply to all containers within a
- * task.
For tasks that use the task IPC mode, IPC namespace systemControls
+ * values apply to all containers within a task.
The namespaced kernel parameter to set a value for.
Valid IPC namespace values: "kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni"
- * | "kernel.sem" | "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" |
- * "kernel.shm_rmid_forced", and Sysctls that start with
- * "fs.mqueue.*"
+ *
Valid IPC namespace values: "kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni" | "kernel.sem"
+ * | "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | "kernel.shm_rmid_forced", and
+ * Sysctls that start with "fs.mqueue.*"
*
Valid network namespace values: Sysctls that start with
- * "net.*"
+ *
Valid network namespace values: Sysctls that start with "net.*"
*
All of these values are supported by Fargate.
* @public @@ -5719,8 +5488,7 @@ export type UlimitName = (typeof UlimitName)[keyof typeof UlimitName]; * the number of open files that a container can use. The default *nofile soft limit is 65535 and the default hard limit
* is 65535.
- * You can specify the ulimit settings for a container in a task
- * definition.
You can specify the ulimit settings for a container in a task definition.
The soft limit for the ulimit type. The value can be specified in bytes, seconds, or as a count, depending on the type of the ulimit.
The soft limit for the ulimit type. The value can be specified in bytes, seconds, or as
+ * a count, depending on the type of the ulimit.
The hard limit for the ulimit type. The value can be specified in bytes, seconds, or as a count, depending on the type of the ulimit.
The hard limit for the ulimit type. The value can be specified in bytes, seconds, or as
+ * a count, depending on the type of the ulimit.
The name of another container within the same task definition to mount volumes - * from.
+ *The name of another container within the same task definition to mount volumes from.
* @public */ sourceContainer?: string | undefined; /** - *If this value is true, the container has read-only access to the volume.
- * If this value is false, then the container can write to the volume. The
- * default value is false.
If this value is true, the container has read-only access to the volume. If this value
+ * is false, then the container can write to the volume. The default value is
+ * false.
Container definitions are used in task definitions to describe the different - * containers that are launched as part of a task.
+ *Container definitions are used in task definitions to describe the different containers that are + * launched as part of a task.
* @public */ export interface ContainerDefinition { /** - *The name of a container. If you're linking multiple containers together in a task
- * definition, the name of one container can be entered in the
- * links of another container to connect the containers.
- * Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the docker container create command and the
- * --name option to docker
- * run.
The name of a container. If you're linking multiple containers together in a task definition, the
+ * name of one container can be entered in the links of another container to
+ * connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the docker
+ * container create command and the --name option to docker run.
The image used to start a container. This string is passed directly to the Docker
- * daemon. By default, images in the Docker Hub registry are available. Other repositories
- * are specified with either The image used to start a container. This string is passed directly to the Docker daemon. By default,
+ * images in the Docker Hub registry are available. Other repositories are specified with either
+ * . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to
* repository-url/image:tag
* or
* repository-url/image@digest
- * . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the docker container create command and the
- * IMAGE parameter of docker
- * run.Image in the docker container create
+ * command and the IMAGE parameter of docker run.
When a new task starts, the Amazon ECS container agent pulls the latest version of - * the specified image and tag for the container to use. However, subsequent - * updates to a repository image aren't propagated to already running tasks.
+ *When a new task starts, the Amazon ECS container agent pulls the latest version of the specified + * image and tag for the container to use. However, subsequent updates to a repository image + * aren't propagated to already running tasks.
*Images in Amazon ECR repositories can be specified by either using the full
- * registry/repository:tag or
- * registry/repository@digest. For example,
+ * registry/repository:tag or registry/repository@digest. For
+ * example,
* 012345678910.dkr.ecr.
* or
* 012345678910.dkr.ecr..
@@ -5811,12 +5576,12 @@ export interface ContainerDefinition {
* ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization
- * name (for example, amazon/amazon-ecs-agent).
Images in other repositories on Docker Hub are qualified with an organization name (for
+ * example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name
- * (for example, quay.io/assemblyline/ubuntu).
Images in other online repositories are qualified further by a domain name (for example,
+ * quay.io/assemblyline/ubuntu).
The number of cpu units reserved for the container. This parameter maps
- * to CpuShares in the docker container create commandand the --cpu-shares option to docker run.
This field is optional for tasks using the Fargate launch type, and the
- * only requirement is that the total amount of CPU reserved for all containers within a
- * task be lower than the task-level cpu value.
The number of cpu units reserved for the container. This parameter maps to
+ * CpuShares in the docker container create commandand the --cpu-shares
+ * option to docker run.
This field is optional for tasks using the Fargate launch type, and the only
+ * requirement is that the total amount of CPU reserved for all containers within a task be lower than the
+ * task-level cpu value.
You can determine the number of CPU units that are available per EC2 instance type - * by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page - * by 1,024.
+ *You can determine the number of CPU units that are available per EC2 instance type by multiplying + * the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
*Linux containers share unallocated CPU units with other containers on the container - * instance with the same ratio as their allocated amount. For example, if you run a - * single-container task on a single-core instance type with 512 CPU units specified for - * that container, and that's the only task running on the container instance, that - * container could use the full 1,024 CPU unit share at any given time. However, if you - * launched another copy of the same task on that container instance, each task is - * guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float - * to higher CPU usage if the other container was not using it. If both tasks were 100% - * active all of the time, they would be limited to 512 CPU units.
- *On Linux container instances, the Docker daemon on the container instance uses the CPU - * value to calculate the relative CPU share ratios for running containers. The minimum valid CPU share value - * that the Linux kernel allows is 2, and the - * maximum valid CPU share value that the Linux kernel allows is 262144. However, the CPU parameter isn't required, and you - * can use CPU values below 2 or above 262144 in your container definitions. For CPU values below 2 - * (including null) or above 262144, the behavior varies based on your Amazon ECS container agent - * version:
+ *Linux containers share unallocated CPU units with other containers on the container instance with the + * same ratio as their allocated amount. For example, if you run a single-container task on a single-core + * instance type with 512 CPU units specified for that container, and that's the only task running on the + * container instance, that container could use the full 1,024 CPU unit share at any given time. However, + * if you launched another copy of the same task on that container instance, each task is guaranteed a + * minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the + * other container was not using it. If both tasks were 100% active all of the time, they would be limited + * to 512 CPU units.
+ *On Linux container instances, the Docker daemon on the container instance uses the CPU value to + * calculate the relative CPU share ratios for running containers. The minimum valid CPU share value that + * the Linux kernel allows is 2, and the maximum valid CPU share value that the Linux kernel allows is + * 262144. However, the CPU parameter isn't required, and you can use CPU values below 2 or above 262144 + * in your container definitions. For CPU values below 2 (including null) or above 262144, the behavior + * varies based on your Amazon ECS container agent version:
*- * Agent versions less than or equal to 1.1.0: - * Null and zero CPU values are passed to Docker as 0, which Docker then converts - * to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux - * kernel converts to two CPU shares.
+ * Agent versions less than or equal to 1.1.0: Null and zero CPU + * values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of + * 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. *- * Agent versions greater than or equal to 1.2.0: - * Null, zero, and CPU values of 1 are passed to Docker as 2.
+ * Agent versions greater than or equal to 1.2.0: Null, zero, and + * CPU values of 1 are passed to Docker as 2. *- * Agent versions greater than or equal to - * 1.84.0: CPU values greater than 256 vCPU are passed to Docker as - * 256, which is equivalent to 262144 CPU shares.
+ * Agent versions greater than or equal to 1.84.0: CPU values + * greater than 256 vCPU are passed to Docker as 256, which is equivalent to 262144 CPU + * shares. *On Windows container instances, the CPU limit is enforced as an absolute limit, or a
- * quota. Windows containers only have access to the specified amount of CPU that's
- * described in the task definition. A null or zero CPU value is passed to Docker as
- * 0, which Windows interprets as 1% of one CPU.
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows
+ * containers only have access to the specified amount of CPU that's described in the task definition. A
+ * null or zero CPU value is passed to Docker as 0, which Windows interprets as 1% of one
+ * CPU.
The amount (in MiB) of memory to present to the container. If your container attempts
- * to exceed the memory specified here, the container is killed. The total amount of memory
- * reserved for all containers within a task must be lower than the task
- * memory value, if one is specified. This parameter maps to
- * Memory in the docker container create command and the --memory option to docker run.
The amount (in MiB) of memory to present to the container. If your container attempts to exceed the
+ * memory specified here, the container is killed. The total amount of memory reserved for all containers
+ * within a task must be lower than the task memory value, if one is specified. This
+ * parameter maps to Memory in the docker container create command and the
+ * --memory option to docker run.
If using the Fargate launch type, this parameter is optional.
- *If using the EC2 launch type, you must specify either a task-level
- * memory value or a container-level memory value. If you specify both a container-level
- * memory and memoryReservation value, memory
- * must be greater than memoryReservation. If you specify
- * memoryReservation, then that value is subtracted from the available
- * memory resources for the container instance where the container is placed. Otherwise,
- * the value of memory is used.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a - * container. So, don't specify less than 6 MiB of memory for your containers.
- *The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a - * container. So, don't specify less than 4 MiB of memory for your containers.
+ *If using the EC2 launch type, you must specify either a task-level memory value or a
+ * container-level memory value. If you specify both a container-level memory and
+ * memoryReservation value, memory must be greater than
+ * memoryReservation. If you specify memoryReservation, then that value is
+ * subtracted from the available memory resources for the container instance where the container is
+ * placed. Otherwise, the value of memory is used.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't + * specify less than 6 MiB of memory for your containers.
+ *The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, + * don't specify less than 4 MiB of memory for your containers.
* @public */ memory?: number | undefined; /** - *The soft limit (in MiB) of memory to reserve for the container. When system memory is
- * under heavy contention, Docker attempts to keep the container memory to this soft limit.
- * However, your container can consume more memory when it needs to, up to either the hard
- * limit specified with the memory parameter (if applicable), or all of the
- * available memory on the container instance, whichever comes first. This parameter maps
- * to MemoryReservation in the docker container create command and the --memory-reservation option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for
- * one or both of memory or memoryReservation in a container
- * definition. If you specify both, memory must be greater than
- * memoryReservation. If you specify memoryReservation, then
- * that value is subtracted from the available memory resources for the container instance
- * where the container is placed. Otherwise, the value of memory is
- * used.
For example, if your container normally uses 128 MiB of memory, but occasionally
- * bursts to 256 MiB of memory for short periods of time, you can set a
- * memoryReservation of 128 MiB, and a memory hard limit of
- * 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory
- * from the remaining resources on the container instance, but also allow the container to
- * consume more memory resources when needed.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a - * container. So, don't specify less than 6 MiB of memory for your containers.
- *The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a - * container. So, don't specify less than 4 MiB of memory for your containers.
+ *The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy
+ * contention, Docker attempts to keep the container memory to this soft limit. However, your container
+ * can consume more memory when it needs to, up to either the hard limit specified with the
+ * memory parameter (if applicable), or all of the available memory on the container
+ * instance, whichever comes first. This parameter maps to MemoryReservation in the docker
+ * container create command and the --memory-reservation option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for one or both of
+ * memory or memoryReservation in a container definition. If you specify
+ * both, memory must be greater than memoryReservation. If you specify
+ * memoryReservation, then that value is subtracted from the available memory resources
+ * for the container instance where the container is placed. Otherwise, the value of memory
+ * is used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of
+ * memory for short periods of time, you can set a memoryReservation of 128 MiB, and a
+ * memory hard limit of 300 MiB. This configuration would allow the container to only
+ * reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the
+ * container to consume more memory resources when needed.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't + * specify less than 6 MiB of memory for your containers.
+ *The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, + * don't specify less than 4 MiB of memory for your containers.
* @public */ memoryReservation?: number | undefined; /** - *The links parameter allows containers to communicate with each other
- * without the need for port mappings. This parameter is only supported if the network mode
- * of a task definition is bridge. The name:internalName
- * construct is analogous to name:alias in Docker links.
- * Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.. This parameter maps to Links in the docker container create command and the
- * --link option to docker
- * run.
The links parameter allows containers to communicate with each other without the need
+ * for port mappings. This parameter is only supported if the network mode of a task definition is
+ * bridge. The name:internalName construct is analogous to
+ * name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.. This parameter maps to
+ * Links in the docker container create command and the --link option to
+ * docker run.
This parameter is not supported for Windows containers.
*Containers that are collocated on a single container instance may be able to - * communicate with each other without requiring links or host port mappings. Network - * isolation is achieved on the container instance using security groups and VPC - * settings.
+ *Containers that are collocated on a single container instance may be able to communicate with + * each other without requiring links or host port mappings. Network isolation is achieved on the + * container instance using security groups and VPC settings.
*The list of port mappings for the container. Port mappings allow containers to access - * ports on the host container instance to send or receive traffic.
+ *The list of port mappings for the container. Port mappings allow containers to access ports on the + * host container instance to send or receive traffic.
*For task definitions that use the awsvpc network mode, only specify the
- * containerPort. The hostPort can be left blank or it must
- * be the same value as the containerPort.
containerPort. The hostPort can be left blank or it must be the same
+ * value as the containerPort.
* Port mappings on Windows use the NetNAT gateway address rather than
- * localhost. There's no loopback for port mappings on Windows, so you
- * can't access a container's mapped port from the host itself.
This parameter maps to PortBindings in the
- * the docker container create command and the
- * --publish option to docker
- * run. If the network mode of a task definition is set to none,
- * then you can't specify port mappings. If the network mode of a task definition is set to
- * host, then host ports must either be undefined or they must match the
- * container port in the port mapping.
localhost. There's no loopback for port mappings on Windows, so you can't access a
+ * container's mapped port from the host itself.
+ * This parameter maps to PortBindings in the the docker container create command and the
+ * --publish option to docker run. If the network mode of a task definition is set to
+ * none, then you can't specify port mappings. If the network mode of a task definition
+ * is set to host, then host ports must either be undefined or they must match the container
+ * port in the port mapping.
After a task reaches the RUNNING status, manual and automatic host
- * and container port assignments are visible in the Network
- * Bindings section of a container description for a selected task in
- * the Amazon ECS console. The assignments are also visible in the
- * networkBindings section DescribeTasks
+ *
After a task reaches the RUNNING status, manual and automatic host and container
+ * port assignments are visible in the Network Bindings section of a
+ * container description for a selected task in the Amazon ECS console. The assignments are also visible in
+ * the networkBindings section DescribeTasks
* responses.
If the essential parameter of a container is marked as true,
- * and that container fails or stops for any reason, all other containers that are part of
- * the task are stopped. If the essential parameter of a container is marked
- * as false, its failure doesn't affect the rest of the containers in a task.
- * If this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application - * that's composed of multiple containers, group containers that are used for a common - * purpose into components, and separate the different components into multiple task - * definitions. For more information, see Application - * Architecture in the Amazon Elastic Container Service Developer Guide.
+ *If the essential parameter of a container is marked as true, and that
+ * container fails or stops for any reason, all other containers that are part of the task are stopped. If
+ * the essential parameter of a container is marked as false, its failure
+ * doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is
+ * assumed to be essential.
All tasks must have at least one essential container. If you have an application that's composed of + * multiple containers, group containers that are used for a common purpose into components, and separate + * the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.
* @public */ essential?: boolean | undefined; /** - *The restart policy for a container. When you set up a restart policy, Amazon ECS can restart the container without needing to replace the - * task. For more information, see Restart individual containers in Amazon ECS tasks with container restart policies in the Amazon Elastic Container Service Developer Guide.
+ *The restart policy for a container. When you set up a restart policy, Amazon ECS can restart the container + * without needing to replace the task. For more information, see Restart individual containers + * in Amazon ECS tasks with container restart policies in the Amazon Elastic Container Service Developer Guide.
* @public */ restartPolicy?: ContainerRestartPolicy | undefined; /** *Early versions of the Amazon ECS container agent don't properly handle
- * entryPoint parameters. If you have problems using
- * entryPoint, update your container agent or enter your commands and
- * arguments as command array items instead.
Early versions of the Amazon ECS container agent don't properly handle entryPoint
+ * parameters. If you have problems using entryPoint, update your container agent or
+ * enter your commands and arguments as command array items instead.
The entry point that's passed to the container. This parameter maps to
- * Entrypoint in the docker container create command and the --entrypoint option to docker run.
The entry point that's passed to the container. This parameter maps to Entrypoint in the
+ * docker container create command and the --entrypoint option to docker run.
The command that's passed to the container. This parameter maps to Cmd in
- * the docker container create command and the
- * COMMAND parameter to docker
- * run. If there are multiple arguments, each
- * argument is a separated string in the array.
The command that's passed to the container. This parameter maps to Cmd in the docker
+ * container create command and the COMMAND parameter to docker run. If there are multiple
+ * arguments, each argument is a separated string in the array.
The environment variables to pass to a container. This parameter maps to
- * Env in the docker container create command and the --env option to docker run.
The environment variables to pass to a container. This parameter maps to Env in the
+ * docker container create command and the --env option to docker run.
We don't recommend that you use plaintext environment variables for sensitive - * information, such as credential data.
+ *We don't recommend that you use plaintext environment variables for sensitive information, such + * as credential data.
*A list of files containing the environment variables to pass to a container. This
- * parameter maps to the --env-file option to docker run.
You can specify up to ten environment files. The file must have a .env
- * file extension. Each line in an environment file contains an environment variable in
- * VARIABLE=VALUE format. Lines beginning with # are treated
- * as comments and are ignored.
If there are environment variables specified using the environment
- * parameter in a container definition, they take precedence over the variables contained
- * within an environment file. If multiple environment files are specified that contain the
- * same variable, they're processed from the top down. We recommend that you use unique
- * variable names. For more information, see Specifying Environment
- * Variables in the Amazon Elastic Container Service Developer Guide.
A list of files containing the environment variables to pass to a container. This parameter maps to
+ * the --env-file option to docker run.
You can specify up to ten environment files. The file must have a .env file extension.
+ * Each line in an environment file contains an environment variable in VARIABLE=VALUE
+ * format. Lines beginning with # are treated as comments and are ignored.
If there are environment variables specified using the environment parameter in a
+ * container definition, they take precedence over the variables contained within an environment file. If
+ * multiple environment files are specified that contain the same variable, they're processed from the top
+ * down. We recommend that you use unique variable names. For more information, see Specifying
+ * Environment Variables in the Amazon Elastic Container Service Developer Guide.
The mount points for data volumes in your container.
- *This parameter maps to Volumes in the docker container create command and the --volume option to docker run.
Windows containers can mount whole directories on the same drive as
- * $env:ProgramData. Windows containers can't mount directories on a
- * different drive, and mount point can't be across drives.
This parameter maps to Volumes in the docker container create command and the
+ * --volume option to docker run.
Windows containers can mount whole directories on the same drive as $env:ProgramData.
+ * Windows containers can't mount directories on a different drive, and mount point can't be across
+ * drives.
Data volumes to mount from another container. This parameter maps to
- * VolumesFrom in the docker container create command and the --volumes-from option to docker run.
Data volumes to mount from another container. This parameter maps to VolumesFrom in the
+ * docker container create command and the --volumes-from option to docker run.
Linux-specific modifications that are applied to the container, such as Linux kernel - * capabilities. For more information see KernelCapabilities.
+ *Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. + * For more information see KernelCapabilities.
*This parameter is not supported for Windows containers.
*The secrets to pass to the container. For more information, see Specifying - * Sensitive Data in the Amazon Elastic Container Service Developer Guide.
+ *The secrets to pass to the container. For more information, see Specifying Sensitive + * Data in the Amazon Elastic Container Service Developer Guide.
* @public */ secrets?: Secret[] | undefined; /** - *The dependencies defined for container startup and shutdown. A container can contain - * multiple dependencies on other containers in a task definition. When a dependency is - * defined for container startup, for container shutdown it is reversed.
- *For tasks using the EC2 launch type, the container instances require at
- * least version 1.26.0 of the container agent to turn on container dependencies. However,
- * we recommend using the latest container agent version. For information about checking
- * your agent version and updating to the latest version, see Updating the Amazon ECS
- * Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,
- * your instance needs at least version 1.26.0-1 of the ecs-init package. If
- * your container instances are launched from version 20190301 or later, then
- * they contain the required versions of the container agent and ecs-init. For
- * more information, see Amazon ECS-optimized Linux AMI
- * in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires - * the following platforms:
+ *The dependencies defined for container startup and shutdown. A container can contain multiple + * dependencies on other containers in a task definition. When a dependency is defined for container + * startup, for container shutdown it is reversed.
+ *For tasks using the EC2 launch type, the container instances require at least version
+ * 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest
+ * container agent version. For information about checking your agent version and updating to the latest
+ * version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an
+ * Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If
+ * your container instances are launched from version 20190301 or later, then they contain
+ * the required versions of the container agent and ecs-init. For more information, see
+ * Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires the following + * platforms:
*Linux platform version 1.3.0 or later.
Time duration (in seconds) to wait before giving up on resolving dependencies for a
- * container. For example, you specify two containers in a task definition with containerA
- * having a dependency on containerB reaching a COMPLETE,
- * SUCCESS, or HEALTHY status. If a startTimeout
- * value is specified for containerB and it doesn't reach the desired status within that
- * time then containerA gives up and not start. This results in the task transitioning to a
+ *
Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For
+ * example, you specify two containers in a task definition with containerA having a dependency on
+ * containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a
+ * startTimeout value is specified for containerB and it doesn't reach the desired status
+ * within that time then containerA gives up and not start. This results in the task transitioning to a
* STOPPED state.
When the ECS_CONTAINER_START_TIMEOUT container agent configuration
- * variable is used, it's enforced independently from this start timeout value.
When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used,
+ * it's enforced independently from this start timeout value.
For tasks using the Fargate launch type, the task or service requires - * the following platforms:
+ *For tasks using the Fargate launch type, the task or service requires the following + * platforms:
*Linux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For tasks using the EC2 launch type, your container instances require at
- * least version 1.26.0 of the container agent to use a container start
- * timeout value. However, we recommend using the latest container agent version. For
- * information about checking your agent version and updating to the latest version, see
- * Updating the Amazon ECS
- * Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,
- * your instance needs at least version 1.26.0-1 of the ecs-init
- * package. If your container instances are launched from version 20190301 or
- * later, then they contain the required versions of the container agent and
- * ecs-init. For more information, see Amazon ECS-optimized Linux AMI
- * in the Amazon Elastic Container Service Developer Guide.
For tasks using the EC2 launch type, your container instances require at least version
+ * 1.26.0 of the container agent to use a container start timeout value. However, we
+ * recommend using the latest container agent version. For information about checking your agent version
+ * and updating to the latest version, see Updating the Amazon ECS Container
+ * Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at
+ * least version 1.26.0-1 of the ecs-init package. If your container instances
+ * are launched from version 20190301 or later, then they contain the required versions of
+ * the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the
+ * Amazon Elastic Container Service Developer Guide.
The valid values for Fargate are 2-120 seconds.
* @public */ startTimeout?: number | undefined; /** - *Time duration (in seconds) to wait before the container is forcefully killed if it - * doesn't exit normally on its own.
- *For tasks using the Fargate launch type, the task or service requires - * the following platforms:
+ *Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit + * normally on its own.
+ *For tasks using the Fargate launch type, the task or service requires the following + * platforms:
*Linux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For tasks that use the Fargate launch type, the max stop timeout value is 120 seconds and if the parameter is not specified, the - * default value of 30 seconds is used.
- *For tasks that use the EC2 launch type, if the stopTimeout
- * parameter isn't specified, the value set for the Amazon ECS container agent configuration
- * variable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the
- * stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT
- * agent configuration variable are set, then the default values of 30 seconds for Linux
- * containers and 30 seconds on Windows containers are used. Your container instances
- * require at least version 1.26.0 of the container agent to use a container stop timeout
- * value. However, we recommend using the latest container agent version. For information
- * about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using
- * an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
- * ecs-init package. If your container instances are launched from version
- * 20190301 or later, then they contain the required versions of the
- * container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks that use the Fargate launch type, the max stop timeout value is 120 seconds and if the + * parameter is not specified, the default value of 30 seconds is used.
+ *For tasks that use the EC2 launch type, if the stopTimeout parameter isn't
+ * specified, the value set for the Amazon ECS container agent configuration variable
+ * ECS_CONTAINER_STOP_TIMEOUT is used. If neither the stopTimeout parameter
+ * or the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default
+ * values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container
+ * instances require at least version 1.26.0 of the container agent to use a container stop timeout value.
+ * However, we recommend using the latest container agent version. For information about checking your
+ * agent version and updating to the latest version, see Updating the Amazon ECS Container
+ * Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at
+ * least version 1.26.0-1 of the ecs-init package. If your container instances are launched
+ * from version 20190301 or later, then they contain the required versions of the container
+ * agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the
+ * Amazon Elastic Container Service Developer Guide.
The valid values for Fargate are 2-120 seconds.
* @public */ stopTimeout?: number | undefined; /** - *The hostname to use for your container. This parameter maps to Hostname
- * in the docker container create command and the
- * --hostname option to docker
- * run.
The hostname to use for your container. This parameter maps to Hostname in the docker
+ * container create command and the --hostname option to docker run.
The hostname parameter is not supported if you're using the
- * awsvpc network mode.
The hostname parameter is not supported if you're using the awsvpc
+ * network mode.
The user to use inside the container. This parameter maps to User in the docker container create command and the
- * --user option to docker
- * run.
The user to use inside the container. This parameter maps to User in the docker
+ * container create command and the --user option to docker run.
When running tasks using the host network mode, don't run containers
- * using the root user (UID 0). We recommend using a non-root user for better
- * security.
When running tasks using the host network mode, don't run containers using the
+ * root user (UID 0). We recommend using a non-root user for better security.
You can specify the user using the following formats. If specifying a UID
- * or GID, you must specify it as a positive integer.
You can specify the user using the following formats. If specifying a UID or GID, you
+ * must specify it as a positive integer.
@@ -6254,14 +5994,15 @@ export interface ContainerDefinition { /** *
The working directory to run commands inside the container in. This parameter maps to
- * WorkingDir in the docker container create command and the --workdir option to docker run.
WorkingDir in the docker container create command and the --workdir
+ * option to docker run.
* @public
*/
workingDirectory?: string | undefined;
/**
- * When this parameter is true, networking is off within the container. This parameter
- * maps to NetworkDisabled in the docker container create command.
When this parameter is true, networking is off within the container. This parameter maps to
+ * NetworkDisabled in the docker container create command.
This parameter is not supported for Windows containers.
*When this parameter is true, the container is given elevated privileges on the host
- * container instance (similar to the root user). This parameter maps to
- * Privileged in the docker container create command and the --privileged option to docker run
When this parameter is true, the container is given elevated privileges on the host container
+ * instance (similar to the root user). This parameter maps to Privileged in the
+ * docker container create command and the --privileged option to docker run
This parameter is not supported for Windows containers or tasks run on Fargate.
*When this parameter is true, the container is given read-only access to its root file
- * system. This parameter maps to ReadonlyRootfs in the docker container create command and the
- * --read-only option to docker
- * run.
When this parameter is true, the container is given read-only access to its root file system. This
+ * parameter maps to ReadonlyRootfs in the docker container create command and the
+ * --read-only option to docker run.
This parameter is not supported for Windows containers.
*A list of DNS servers that are presented to the container. This parameter maps to
- * Dns in the docker container create command and the --dns option to docker run.
A list of DNS servers that are presented to the container. This parameter maps to Dns in
+ * the docker container create command and the --dns option to docker run.
This parameter is not supported for Windows containers.
*A list of DNS search domains that are presented to the container. This parameter maps
- * to DnsSearch in the docker container create command and the --dns-search option to docker run.
A list of DNS search domains that are presented to the container. This parameter maps to
+ * DnsSearch in the docker container create command and the --dns-search
+ * option to docker run.
This parameter is not supported for Windows containers.
*A list of hostnames and IP address mappings to append to the /etc/hosts
- * file on the container. This parameter maps to ExtraHosts in the docker container create command and the
- * --add-host option to docker
- * run.
A list of hostnames and IP address mappings to append to the /etc/hosts file on the
+ * container. This parameter maps to ExtraHosts in the docker container create command and
+ * the --add-host option to docker run.
This parameter isn't supported for Windows containers or tasks that use the
- * awsvpc network mode.
This parameter isn't supported for Windows containers or tasks that use the awsvpc
+ * network mode.
A list of strings to provide custom configuration for multiple security systems. This field isn't valid for containers in tasks - * using the Fargate launch type.
- *For Linux tasks on EC2, this parameter can be used to reference custom - * labels for SELinux and AppArmor multi-level security systems.
- *For any tasks on EC2, this parameter can be used to reference a - * credential spec file that configures a container for Active Directory authentication. - * For more information, see Using gMSAs for Windows - * Containers and Using gMSAs for Linux - * Containers in the Amazon Elastic Container Service Developer Guide.
+ *A list of strings to provide custom configuration for multiple security systems. This field isn't + * valid for containers in tasks using the Fargate launch type.
+ *For Linux tasks on EC2, this parameter can be used to reference custom labels for + * SELinux and AppArmor multi-level security systems.
+ *For any tasks on EC2, this parameter can be used to reference a credential spec file + * that configures a container for Active Directory authentication. For more information, see Using gMSAs for + * Windows Containers and Using gMSAs for Linux Containers in + * the Amazon Elastic Container Service Developer Guide.
*This parameter maps to SecurityOpt in the docker container create command and the
- * --security-opt option to docker
- * run.
--security-opt option to docker run.
* The Amazon ECS container agent running on a container instance must register with the
- * ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true
- * environment variables before containers placed on that instance can use these
- * security options. For more information, see Amazon ECS Container
- * Agent Configuration in the Amazon Elastic Container Service Developer Guide.
ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment
+ * variables before containers placed on that instance can use these security options. For more
+ * information, see Amazon ECS Container Agent
+ * Configuration in the Amazon Elastic Container Service Developer Guide.
* Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | * "credentialspec:CredentialSpecFilePath"
@@ -6352,33 +6090,35 @@ export interface ContainerDefinition { dockerSecurityOptions?: string[] | undefined; /** - *When this parameter is true, you can deploy containerized applications
- * that require stdin or a tty to be allocated. This parameter
- * maps to OpenStdin in the docker container create command and the --interactive option to docker run.
When this parameter is true, you can deploy containerized applications that require
+ * stdin or a tty to be allocated. This parameter maps to
+ * OpenStdin in the docker container create command and the --interactive
+ * option to docker run.
When this parameter is true, a TTY is allocated. This parameter maps to
- * Tty in the docker container create command and the --tty option to docker run.
When this parameter is true, a TTY is allocated. This parameter maps to Tty
+ * in the docker container create command and the --tty option to docker run.
A key/value map of labels to add to the container. This parameter maps to
- * Labels in the docker container create command and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '\{\{.Server.APIVersion\}\}'
+ *
A key/value map of labels to add to the container. This parameter maps to Labels in the
+ * docker container create command and the --label option to docker run.
+ * This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '\{\{.Server.APIVersion\}\}'
*
A list of ulimits to set in the container. If a ulimit value
- * is specified in a task definition, it overrides the default values set by Docker. This
- * parameter maps to Ulimits in the docker container create command and the --ulimit option to docker run. Valid naming values are displayed
- * in the Ulimit data type.
A list of ulimits to set in the container. If a ulimit value is specified
+ * in a task definition, it overrides the default values set by Docker. This parameter maps to
+ * Ulimits in the docker container create command and the --ulimit option to
+ * docker run. Valid naming values are displayed in the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default
* resource limit values set by the operating system with the exception of
* the nofile resource limit parameter which Fargate
@@ -6398,113 +6138,104 @@ export interface ContainerDefinition {
/**
*
The log configuration specification for the container.
*This parameter maps to LogConfig in the docker container create command and the
- * --log-driver option to docker
- * run. By default, containers use the same logging driver that the Docker
- * daemon uses. However the container can use a different logging driver than the Docker
- * daemon by specifying a log driver with this parameter in the container definition. To
- * use a different logging driver for a container, the log system must be configured
- * properly on the container instance (or on a different log server for remote logging
- * options).
--log-driver option to docker run. By default, containers use the same logging driver
+ * that the Docker daemon uses. However the container can use a different logging driver than the Docker
+ * daemon by specifying a log driver with this parameter in the container definition. To use a different
+ * logging driver for a container, the log system must be configured properly on the container instance
+ * (or on a different log server for remote logging options).
* Amazon ECS currently supports a subset of the logging drivers available to the Docker - * daemon (shown in the LogConfiguration data type). Additional log - * drivers may be available in future releases of the Amazon ECS container agent.
+ *Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in + * the LogConfiguration data type). Additional log drivers may be available in future + * releases of the Amazon ECS container agent.
*This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '\{\{.Server.APIVersion\}\}'
*
The Amazon ECS container agent running on a container instance must register the
- * logging drivers available on that instance with the
- * ECS_AVAILABLE_LOGGING_DRIVERS environment variable before
- * containers placed on that instance can use these log configuration options. For more
- * information, see Amazon ECS Container
- * Agent Configuration in the Amazon Elastic Container Service Developer Guide.
The Amazon ECS container agent running on a container instance must register the logging drivers
+ * available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable
+ * before containers placed on that instance can use these log configuration options. For more
+ * information, see Amazon ECS Container Agent
+ * Configuration in the Amazon Elastic Container Service Developer Guide.
The container health check command and associated configuration parameters for the
- * container. This parameter maps to HealthCheck in the docker container create command and the
- * HEALTHCHECK parameter of docker
- * run.
The container health check command and associated configuration parameters for the container. This
+ * parameter maps to HealthCheck in the docker container create command and the
+ * HEALTHCHECK parameter of docker run.
A list of namespaced kernel parameters to set in the container. This parameter maps to
- * Sysctls in the docker container create command and the --sysctl option to docker run. For example, you can configure
- * net.ipv4.tcp_keepalive_time setting to maintain longer lived
- * connections.
Sysctls in the docker container create command and the --sysctl option to
+ * docker run. For example, you can configure net.ipv4.tcp_keepalive_time setting to maintain
+ * longer lived connections.
* @public
*/
systemControls?: SystemControl[] | undefined;
/**
- * The type and amount of a resource to assign to a container. The only supported - * resource is a GPU.
+ *The type and amount of a resource to assign to a container. The only supported resource is a + * GPU.
* @public */ resourceRequirements?: ResourceRequirement[] | undefined; /** - *The FireLens configuration for the container. This is used to specify and configure a - * log router for container logs. For more information, see Custom Log Routing - * in the Amazon Elastic Container Service Developer Guide.
+ *The FireLens configuration for the container. This is used to specify and configure a log router for + * container logs. For more information, see Custom Log Routing in the + * Amazon Elastic Container Service Developer Guide.
* @public */ firelensConfiguration?: FirelensConfiguration | undefined; /** - *A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec) file that
- * configures the container for Active Directory authentication. We recommend that you use
- * this parameter instead of the dockerSecurityOptions. The maximum number of
- * ARNs is 1.
A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec) file that configures the
+ * container for Active Directory authentication. We recommend that you use this parameter instead of the
+ * dockerSecurityOptions. The maximum number of ARNs is 1.
There are two formats for each ARN.
*You use credentialspecdomainless:MyARN to provide a
- * CredSpec with an additional section for a secret in Secrets Manager.
- * You provide the login credentials to the domain in the secret.
Each task that runs on any container instance can join different - * domains.
- *You can use this format without joining the container instance to a - * domain.
+ *You use credentialspecdomainless:MyARN to provide a CredSpec
+ * with an additional section for a secret in Secrets Manager. You provide the login credentials to the
+ * domain in the secret.
Each task that runs on any container instance can join different domains.
+ *You can use this format without joining the container instance to a domain.
*You use credentialspec:MyARN to provide a
- * CredSpec for a single domain.
You must join the container instance to the domain before you start any - * tasks that use this task definition.
+ *You use credentialspec:MyARN to provide a CredSpec for a single
+ * domain.
You must join the container instance to the domain before you start any tasks that use + * this task definition.
*In both formats, replace MyARN with the ARN in SSM or Amazon S3.
If you provide a credentialspecdomainless:MyARN, the
- * credspec must provide a ARN in Secrets Manager for a secret containing the
- * username, password, and the domain to connect to. For better security, the instance
- * isn't joined to the domain for domainless authentication. Other applications on the
- * instance can't use the domainless credentials. You can use this parameter to run tasks
- * on the same instance, even it the tasks need to join different domains. For more
- * information, see Using gMSAs for Windows
- * Containers and Using gMSAs for Linux
- * Containers.
If you provide a credentialspecdomainless:MyARN, the credspec must provide
+ * a ARN in Secrets Manager for a secret containing the username, password, and the domain to connect to. For better
+ * security, the instance isn't joined to the domain for domainless authentication. Other applications on
+ * the instance can't use the domainless credentials. You can use this parameter to run tasks on the same
+ * instance, even it the tasks need to join different domains. For more information, see Using gMSAs for
+ * Windows Containers and Using gMSAs for Linux
+ * Containers.
The amount of ephemeral storage to allocate for the task. This parameter is used to - * expand the total amount of ephemeral storage available, beyond the default amount, for - * tasks hosted on Fargate. For more information, see Using data volumes in - * tasks in the Amazon ECS Developer Guide;.
+ *The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total + * amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For + * more information, see Using data volumes in tasks + * in the Amazon ECS Developer Guide;.
*For tasks using the Fargate launch type, the task requires the - * following platforms:
+ *For tasks using the Fargate launch type, the task requires the following + * platforms:
*Linux platform version 1.4.0 or later.
The total amount, in GiB, of ephemeral storage to set for the task. The minimum
- * supported value is 20 GiB and the maximum supported value is
- * 200 GiB.
The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is
+ * 20 GiB and the maximum supported value is 200 GiB.
Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the - * Amazon Elastic Container Service Developer Guide.
+ *Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on + * Amazon ECS in the Amazon Elastic Container Service Developer Guide.
* @public */ export interface InferenceAccelerator { /** - *The Elastic Inference accelerator device name. The deviceName must also
- * be referenced in a container definition as a ResourceRequirement.
The Elastic Inference accelerator device name. The deviceName must also be referenced in
+ * a container definition as a ResourceRequirement.
The constraint on task placement in the task definition. For more information, see - * Task placement constraints in the - * Amazon Elastic Container Service Developer Guide.
+ *The constraint on task placement in the task definition. For more information, see Task + * placement constraints in the Amazon Elastic Container Service Developer Guide.
*Task placement constraints aren't supported for tasks run on Fargate.
*The type of constraint. The MemberOf constraint restricts selection to be
- * from a group of valid candidates.
The type of constraint. The MemberOf constraint restricts selection to be from a group
+ * of valid candidates.
A cluster query language expression to apply to the constraint. For more information, - * see Cluster query language in the Amazon Elastic Container Service Developer Guide.
+ *A cluster query language expression to apply to the constraint. For more information, see Cluster + * query language in the Amazon Elastic Container Service Developer Guide.
* @public */ expression?: string | undefined; @@ -6645,12 +6374,11 @@ export type ProxyConfigurationType = (typeof ProxyConfigurationType)[keyof typeo /** *The configuration details for the App Mesh proxy.
- *For tasks that use the EC2 launch type, the container instances require
- * at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the
- * ecs-init package to use a proxy configuration. If your container
- * instances are launched from the Amazon ECS optimized AMI version 20190301 or
- * later, then they contain the required versions of the container agent and
- * ecs-init. For more information, see Amazon ECS-optimized Linux AMI
+ *
For tasks that use the EC2 launch type, the container instances require at least
+ * version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init
+ * package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized
+ * AMI version 20190301 or later, then they contain the required versions of the container
+ * agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI
*
The set of network configuration parameters to provide the Container Network Interface - * (CNI) plugin, specified as key-value pairs.
+ *The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, + * specified as key-value pairs.
*
- * IgnoredUID - (Required) The user ID (UID) of the proxy
- * container as defined by the user parameter in a container
- * definition. This is used to ensure the proxy ignores its own traffic. If
- * IgnoredGID is specified, this field can be empty.
IgnoredUID - (Required) The user ID (UID) of the proxy container as
+ * defined by the user parameter in a container definition. This is used to ensure
+ * the proxy ignores its own traffic. If IgnoredGID is specified, this field can be
+ * empty.
*
- * IgnoredGID - (Required) The group ID (GID) of the proxy
- * container as defined by the user parameter in a container
- * definition. This is used to ensure the proxy ignores its own traffic. If
- * IgnoredUID is specified, this field can be empty.
IgnoredGID - (Required) The group ID (GID) of the proxy container as
+ * defined by the user parameter in a container definition. This is used to ensure
+ * the proxy ignores its own traffic. If IgnoredUID is specified, this field can be
+ * empty.
*
- * AppPorts - (Required) The list of ports that the
- * application uses. Network traffic to these ports is forwarded to the
- * ProxyIngressPort and ProxyEgressPort.
AppPorts - (Required) The list of ports that the application uses. Network
+ * traffic to these ports is forwarded to the ProxyIngressPort and
+ * ProxyEgressPort.
*
- * ProxyIngressPort - (Required) Specifies the port that
- * incoming traffic to the AppPorts is directed to.
ProxyIngressPort - (Required) Specifies the port that incoming traffic to
+ * the AppPorts is directed to.
*
- * ProxyEgressPort - (Required) Specifies the port that
- * outgoing traffic from the AppPorts is directed to.
ProxyEgressPort - (Required) Specifies the port that outgoing traffic from
+ * the AppPorts is directed to.
*
- * EgressIgnoredPorts - (Required) The egress traffic going to
- * the specified ports is ignored and not redirected to the
- * ProxyEgressPort. It can be an empty list.
EgressIgnoredPorts - (Required) The egress traffic going to the specified
+ * ports is ignored and not redirected to the ProxyEgressPort. It can be an empty
+ * list.
*
- * EgressIgnoredIPs - (Required) The egress traffic going to
- * the specified IP addresses is ignored and not redirected to the
- * ProxyEgressPort. It can be an empty list.
EgressIgnoredIPs - (Required) The egress traffic going to the specified IP
+ * addresses is ignored and not redirected to the ProxyEgressPort. It can be an empty
+ * list.
* The CPU architecture.
- *You can run your Linux tasks on an ARM-based platform by setting the value to
- * ARM64. This option is available for tasks that run on Linux Amazon EC2
- * instance or Linux containers on Fargate.
The default is X86_64.
You can run your Linux tasks on an ARM-based platform by setting the value to ARM64.
+ * This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on
+ * Fargate.
The operating system.
- *The default is Linux.
This parameter is specified when you're using Docker volumes. Docker volumes are only
- * supported when you're using the EC2 launch type. Windows containers only
- * support the use of the local driver. To use bind mounts, specify a
- * host instead.
This parameter is specified when you're using Docker volumes. Docker volumes are only supported when
+ * you're using the EC2 launch type. Windows containers only support the use of the
+ * local driver. To use bind mounts, specify a host instead.
The scope for the Docker volume that determines its lifecycle. Docker volumes that are
- * scoped to a task are automatically provisioned when the task starts and
- * destroyed when the task stops. Docker volumes that are scoped as shared
- * persist after the task stops.
The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
+ * task are automatically provisioned when the task starts and destroyed when the task
+ * stops. Docker volumes that are scoped as shared persist after the task stops.
If this value is true, the Docker volume is created if it doesn't already
- * exist.
If this value is true, the Docker volume is created if it doesn't already exist.
This field is only used if the scope is shared.
The Docker volume driver to use. The driver value must match the driver name provided
- * by Docker because it is used for task placement. If the driver was installed using the
- * Docker plugin CLI, use docker plugin ls to retrieve the driver name from
- * your container instance. If the driver was installed using another method, use Docker
- * plugin discovery to retrieve the driver name. This parameter maps to Driver in the docker container create command and the
- * xxdriver option to docker
- * volume create.
The Docker volume driver to use. The driver value must match the driver name provided by Docker
+ * because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
+ * docker plugin ls to retrieve the driver name from your container instance. If the
+ * driver was installed using another method, use Docker plugin discovery to retrieve the driver name.
+ * This parameter maps to Driver in the docker container create command and the
+ * xxdriver option to docker volume create.
A map of Docker driver-specific options passed through. This parameter maps to
- * DriverOpts in the docker create-volume command and the xxopt option to docker
- * volume create.
DriverOpts in the docker create-volume command and the xxopt option to
+ * docker volume create.
* @public
*/
driverOpts?: RecordCustom metadata to add to your Docker volume. This parameter maps to
- * Labels in the docker container create command and the xxlabel option to docker
- * volume create.
Custom metadata to add to your Docker volume. This parameter maps to Labels in the
+ * docker container create command and the xxlabel option to docker volume create.
The Amazon EFS access point ID to use. If an access point is specified, the root directory
- * value specified in the EFSVolumeConfiguration must either be omitted or set
- * to / which will enforce the path set on the EFS access point. If an access
- * point is used, transit encryption must be on in the EFSVolumeConfiguration.
- * For more information, see Working with Amazon EFS access
- * points in the Amazon Elastic File System User Guide.
The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified
+ * in the EFSVolumeConfiguration must either be omitted or set to / which will
+ * enforce the path set on the EFS access point. If an access point is used, transit encryption must be on
+ * in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the
+ * Amazon Elastic File System User Guide.
Determines whether to use the Amazon ECS task role defined in a task definition when
- * mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on
- * in the EFSVolumeConfiguration. If this parameter is omitted, the default
- * value of DISABLED is used. For more information, see Using
- * Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.
Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS
+ * file system. If it is turned on, transit encryption must be turned on in the
+ * EFSVolumeConfiguration. If this parameter is omitted, the default value of
+ * DISABLED is used. For more information, see Using Amazon EFS access
+ * points in the Amazon Elastic Container Service Developer Guide.
This parameter is specified when you're using an Amazon Elastic File System file system for task - * storage. For more information, see Amazon EFS volumes in the - * Amazon Elastic Container Service Developer Guide.
+ *This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more + * information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.
* @public */ export interface EFSVolumeConfiguration { @@ -6931,33 +6650,31 @@ export interface EFSVolumeConfiguration { fileSystemId: string | undefined; /** - *The directory within the Amazon EFS file system to mount as the root directory inside the
- * host. If this parameter is omitted, the root of the Amazon EFS volume will be used.
- * Specifying / will have the same effect as omitting this parameter.
The directory within the Amazon EFS file system to mount as the root directory inside the host. If this
+ * parameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have
+ * the same effect as omitting this parameter.
If an EFS access point is specified in the authorizationConfig, the
- * root directory parameter must either be omitted or set to / which will
- * enforce the path set on the EFS access point.
If an EFS access point is specified in the authorizationConfig, the root directory
+ * parameter must either be omitted or set to / which will enforce the path set on the
+ * EFS access point.
Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host
- * and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization
- * is used. If this parameter is omitted, the default value of DISABLED is
- * used. For more information, see Encrypting data in transit in
- * the Amazon Elastic File System User Guide.
Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS
+ * server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is
+ * omitted, the default value of DISABLED is used. For more information, see Encrypting data in
+ * transit in the Amazon Elastic File System User Guide.
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS - * server. If you do not specify a transit encryption port, it will use the port selection - * strategy that the Amazon EFS mount helper uses. For more information, see EFS mount - * helper in the Amazon Elastic File System User Guide.
+ *The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do + * not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount + * helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
* @public */ transitEncryptionPort?: number | undefined; @@ -6971,23 +6688,23 @@ export interface EFSVolumeConfiguration { /** *The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon ECS API - * Reference.
- *For more information and the input format, see Amazon FSx for Windows File Server Volumes - * in the Amazon Elastic Container Service Developer Guide.
+ * Reference. + *For more information and the input format, see Amazon FSx for Windows File Server Volumes in the + * Amazon Elastic Container Service Developer Guide.
* @public */ export interface FSxWindowsFileServerAuthorizationConfig { /** - *The authorization credential option to use. The authorization credential options can - * be provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store - * parameter. The ARN refers to the stored credentials.
+ *The authorization credential option to use. The authorization credential options can be provided + * using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store parameter. The ARN refers to + * the stored credentials.
* @public */ credentialsParameter: string | undefined; /** - *A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on - * Amazon EC2.
+ *A fully qualified domain name hosted by an Directory Service Managed + * Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.
* @public */ domain: string | undefined; @@ -6996,8 +6713,8 @@ export interface FSxWindowsFileServerAuthorizationConfig { /** *This parameter is specified when you're using Amazon FSx for Windows File Server file system for task * storage.
- *For more information and the input format, see Amazon FSx for Windows File Server volumes - * in the Amazon Elastic Container Service Developer Guide.
+ *For more information and the input format, see Amazon FSx for Windows File Server volumes in the + * Amazon Elastic Container Service Developer Guide.
* @public */ export interface FSxWindowsFileServerVolumeConfiguration { @@ -7008,8 +6725,8 @@ export interface FSxWindowsFileServerVolumeConfiguration { fileSystemId: string | undefined; /** - *The directory within the Amazon FSx for Windows File Server file system to mount as the root directory - * inside the host.
+ *The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the + * host.
* @public */ rootDirectory: string | undefined; @@ -7027,61 +6744,54 @@ export interface FSxWindowsFileServerVolumeConfiguration { */ export interface HostVolumeProperties { /** - *When the host parameter is used, specify a sourcePath to
- * declare the path on the host container instance that's presented to the container. If
- * this parameter is empty, then the Docker daemon has assigned a host path for you. If the
- * host parameter contains a sourcePath file location, then
- * the data volume persists at the specified location on the host container instance until
- * you delete it manually. If the sourcePath value doesn't exist on the host
- * container instance, the Docker daemon creates it. If the location does exist, the
+ *
When the host parameter is used, specify a sourcePath to declare the path
+ * on the host container instance that's presented to the container. If this parameter is empty, then the
+ * Docker daemon has assigned a host path for you. If the host parameter contains a
+ * sourcePath file location, then the data volume persists at the specified location on
+ * the host container instance until you delete it manually. If the sourcePath value doesn't
+ * exist on the host container instance, the Docker daemon creates it. If the location does exist, the
* contents of the source path folder are exported.
If you're using the Fargate launch type, the sourcePath
- * parameter is not supported.
If you're using the Fargate launch type, the sourcePath parameter is not
+ * supported.
The data volume configuration for tasks launched using this task definition.
- * Specifying a volume configuration in a task definition is optional. The volume
- * configuration may contain multiple volumes but only one volume configured at launch is
- * supported. Each volume defined in the volume configuration may only specify a
- * name and one of either configuredAtLaunch,
+ *
The data volume configuration for tasks launched using this task definition. Specifying a volume
+ * configuration in a task definition is optional. The volume configuration may contain multiple volumes
+ * but only one volume configured at launch is supported. Each volume defined in the volume configuration
+ * may only specify a name and one of either configuredAtLaunch,
* dockerVolumeConfiguration, efsVolumeConfiguration,
- * fsxWindowsFileServerVolumeConfiguration, or host. If an
- * empty volume configuration is specified, by default Amazon ECS uses a host volume. For more
- * information, see Using data volumes in
- * tasks.
fsxWindowsFileServerVolumeConfiguration, or host. If an empty volume
+ * configuration is specified, by default Amazon ECS uses a host volume. For more information, see Using data
+ * volumes in tasks.
* @public
*/
export interface Volume {
/**
* The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
- *When using a volume configured at launch, the name is required and must
- * also be specified as the volume name in the ServiceVolumeConfiguration or
- * TaskVolumeConfiguration parameter when creating your service or
- * standalone task.
For all other types of volumes, this name is referenced in the
- * sourceVolume parameter of the mountPoints object in the
- * container definition.
When a volume is using the efsVolumeConfiguration, the name is
- * required.
When using a volume configured at launch, the name is required and must also be
+ * specified as the volume name in the ServiceVolumeConfiguration or
+ * TaskVolumeConfiguration parameter when creating your service or standalone
+ * task.
For all other types of volumes, this name is referenced in the sourceVolume parameter of
+ * the mountPoints object in the container definition.
When a volume is using the efsVolumeConfiguration, the name is required.
This parameter is specified when you use bind mount host volumes. The contents of the
- * host parameter determine whether your bind mount host volume persists
- * on the host container instance and where it's stored. If the host parameter
- * is empty, then the Docker daemon assigns a host path for your data volume. However, the
- * data isn't guaranteed to persist after the containers that are associated with it stop
- * running.
Windows containers can mount whole directories on the same drive as
- * $env:ProgramData. Windows containers can't mount directories on a
- * different drive, and mount point can't be across drives. For example, you can mount
- * C:\my\path:C:\my\path and D:\:D:\, but not
+ * host parameter determine whether your bind mount host volume persists on the host
+ * container instance and where it's stored. If the host parameter is empty, then the Docker
+ * daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after
+ * the containers that are associated with it stop running.
Windows containers can mount whole directories on the same drive as $env:ProgramData.
+ * Windows containers can't mount directories on a different drive, and mount point can't be across
+ * drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\, but not
* D:\my\path:C:\my\path or D:\:C:\my\path.
This parameter is specified when you use Docker volumes.
- *Windows containers only support the use of the local driver. To use bind
- * mounts, specify the host parameter instead.
Windows containers only support the use of the local driver. To use bind mounts, specify
+ * the host parameter instead.
Docker volumes aren't supported by tasks run on Fargate.
*This parameter is specified when you use an Amazon Elastic File System file system for task - * storage.
+ *This parameter is specified when you use an Amazon Elastic File System file system for task storage.
* @public */ efsVolumeConfiguration?: EFSVolumeConfiguration | undefined; /** - *This parameter is specified when you use Amazon FSx for Windows File Server file system for task - * storage.
+ *This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
* @public */ fsxWindowsFileServerVolumeConfiguration?: FSxWindowsFileServerVolumeConfiguration | undefined; /** - *Indicates whether the volume should be configured at launch time. This is used to - * create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each - * task definition revision may only have one volume configured at launch in the volume - * configuration.
+ *Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS + * volumes for standalone tasks or tasks created as part of a service. Each task definition revision may + * only have one volume configured at launch in the volume configuration.
*To configure a volume at launch time, use this task definition revision and specify a
- * volumeConfigurations object when calling the
- * CreateService, UpdateService, RunTask or
- * StartTask APIs.
volumeConfigurations object when calling the CreateService,
+ * UpdateService, RunTask or StartTask APIs.
* @public
*/
configuredAtLaunch?: boolean | undefined;
}
/**
- * The details of a task definition which describes the container and volume definitions - * of an Amazon Elastic Container Service task. You can specify which Docker images to use, the required - * resources, and other configurations related to launching the task definition through an - * Amazon ECS service or task.
+ *The details of a task definition which describes the container and volume definitions of an Amazon Elastic Container Service + * task. You can specify which Docker images to use, the required resources, and other configurations + * related to launching the task definition through an Amazon ECS service or task.
* @public */ export interface TaskDefinition { @@ -7141,30 +6846,27 @@ export interface TaskDefinition { taskDefinitionArn?: string | undefined; /** - *A list of container definitions in JSON format that describe the different containers
- * that make up your task. For more information about container definition parameters and
- * defaults, see Amazon ECS Task
+ * A list of container definitions in JSON format that describe the different containers that make up
+ * your task. For more information about container definition parameters and defaults, see Amazon ECS Task
* Definitions in the Amazon Elastic Container Service Developer Guide. The name of a family that this task definition is registered to. Up to 255 characters
- * are allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and
- * underscores (_) are allowed. A family groups multiple versions of a task definition. Amazon ECS gives the first task
- * definition that you registered to a family a revision number of 1. Amazon ECS gives
- * sequential revision numbers to each task definition that you add. The name of a family that this task definition is registered to. Up to 255 characters are allowed.
+ * Letters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are
+ * allowed. A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that
+ * you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task
+ * definition that you add. The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the
- * task permission to call Amazon Web Services APIs on your behalf. For informationabout the required
- * IAM roles for Amazon ECS, see IAM
- * roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide. The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission
+ * to call Amazon Web Services APIs on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If the network mode is awsvpc, the task is allocated an elastic network
- * interface, and you must specify a NetworkConfiguration value when you create
+ * interface, and you must specify a NetworkConfiguration value when you create
* a service or run a task with the task definition. For more information, see Task Networking in the
* Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the
* same task on a single container instance when port mappings are used.
For more information, see Network - * settings in the Docker run reference.
* @public */ networkMode?: NetworkMode | undefined; /** - *The revision of the task in a particular family. The revision is a version number of a
- * task definition in a family. When you register a task definition for the first time, the
- * revision is 1. Each time that you register a new revision of a task
- * definition in the same family, the revision value always increases by one. This is even
- * if you deregistered previous revisions in this family.
The revision of the task in a particular family. The revision is a version number of a task
+ * definition in a family. When you register a task definition for the first time, the revision is
+ * 1. Each time that you register a new revision of a task definition in the same family,
+ * the revision value always increases by one. This is even if you deregistered previous revisions in this
+ * family.
The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.
+ *The list of data volume definitions for the task. For more information, see Using data + * volumes in tasks in the Amazon Elastic Container Service Developer Guide.
*The host and sourcePath parameters aren't supported for
- * tasks run on Fargate.
The host and sourcePath parameters aren't supported for tasks run on
+ * Fargate.
The container instance attributes required by your task. When an Amazon EC2 instance is - * registered to your cluster, the Amazon ECS container agent assigns some standard attributes - * to the instance. You can apply custom attributes. These are specified as key-value pairs - * using the Amazon ECS console or the PutAttributes API. These attributes are - * used when determining task placement for tasks hosted on Amazon EC2 instances. For more - * information, see Attributes in the Amazon Elastic Container Service Developer Guide.
+ *The container instance attributes required by your task. When an Amazon EC2 instance is registered to your + * cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply + * custom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks + * hosted on Amazon EC2 instances. For more information, see Attributes + * in the Amazon Elastic Container Service Developer Guide.
*This parameter isn't supported for tasks run on Fargate.
*Amazon ECS validates the task definition parameters with those supported by the launch type. For - * more information, see Amazon ECS launch types - * in the Amazon Elastic Container Service Developer Guide.
+ *Amazon ECS validates the task definition parameters with those supported by the launch type. For more + * information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
* @public */ compatibilities?: Compatibility[] | undefined; /** - *The operating system that your task definitions are running on. A platform family is - * specified only for tasks using the Fargate launch type.
- *When you specify a task in a service, this value must match the
- * runtimePlatform value of the service.
The operating system that your task definitions are running on. A platform family is specified only + * for tasks using the Fargate launch type.
+ *When you specify a task in a service, this value must match the runtimePlatform value of
+ * the service.
The task launch types the task definition was validated against. The valid values are
- * EC2, FARGATE, and EXTERNAL. For more
- * information, see Amazon ECS launch types
- * in the Amazon Elastic Container Service Developer Guide.
EC2, FARGATE, and EXTERNAL. For more information, see Amazon ECS launch
+ * types in the Amazon Elastic Container Service Developer Guide.
* @public
*/
requiresCompatibilities?: Compatibility[] | undefined;
/**
- * The number of cpu units used by the task. If you use the EC2 launch type,
- * this field is optional. Any value can be used. If you use the Fargate launch type, this
- * field is required. You must use one of the following values. The value that you choose
- * determines your range of valid values for the memory parameter.
If you use the EC2 launch type, this field is optional. Supported values
- * are between 128 CPU units (0.125 vCPUs) and 10240
- * CPU units (10 vCPUs).
The number of cpu units used by the task. If you use the EC2 launch type, this field is
+ * optional. Any value can be used. If you use the Fargate launch type, this field is required. You must
+ * use one of the following values. The value that you choose determines your range of valid values for
+ * the memory parameter.
If you use the EC2 launch type, this field is optional. Supported values are between
+ * 128 CPU units (0.125 vCPUs) and 10240 CPU units
+ * (10 vCPUs).
The CPU units cannot be less than 1 vCPU when you use Windows containers on * Fargate.
*The amount (in MiB) of memory used by the task.
- *If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory - * value or a container-level memory value. This field is optional and any value can be - * used. If a task-level memory value is specified, the container-level memory value is - * optional. For more information regarding container-level memory and memory reservation, - * see ContainerDefinition.
- *If your tasks runs on Fargate, this field is required. You must use one of the
- * following values. The value you choose determines your range of valid values for the
- * cpu parameter.
If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a + * container-level memory value. This field is optional and any value can be used. If a task-level memory + * value is specified, the container-level memory value is optional. For more information regarding + * container-level memory and memory reservation, see ContainerDefinition.
+ *If your tasks runs on Fargate, this field is required. You must use one of the following values.
+ * The value you choose determines your range of valid values for the cpu parameter.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
If task is specified, all containers within the specified
* task share the same process namespace.
If no value is specified, the - * default is a private namespace for each container. For more information, - * see PID settings in the Docker run - * reference.
+ * default is a private namespace for each container. *If the host PID mode is used, there's a heightened risk
- * of undesired process namespace exposure. For more information, see
- * Docker security.
This parameter is not supported for Windows containers.
*none is specified, then IPC resources
* within the containers of a task are private and not shared with other containers in a
* task or on the container instance. If no value is specified, then the IPC resource
- * namespace sharing depends on the Docker daemon setting on the container instance. For
- * more information, see IPC
- * settings in the Docker run reference.
+ * namespace sharing depends on the Docker daemon setting on the container instance.
* If the host IPC mode is used, be aware that there is a heightened risk of
- * undesired IPC namespace expose. For more information, see Docker
- * security.
If you are setting namespaced kernel parameters using The configuration details for the App Mesh proxy. Your Amazon ECS container instances require at least version 1.26.0 of the container agent
- * and at least version 1.26.0-1 of the Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least
+ * version 1.26.0-1 of the The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task
- * set found in to delete. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set found in to
+ * delete. The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to
- * delete. The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete. If If The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and
- * Region. The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to
- * deregister. If you do not specify a cluster, the default cluster is assumed. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister.
+ * If you do not specify a cluster, the default cluster is assumed. The container instance ID or full ARN of the container instance to deregister. For
- * more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide. The container instance ID or full ARN of the container instance to deregister. For more information
+ * about the ARN format, see Amazon Resource Name (ARN)
+ * in the Amazon ECS Developer Guide. Forces the container instance to be deregistered. If you have tasks running on the
- * container instance when you deregister it with the Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer
- * target group are deregistered. They begin connection draining according to the settings
- * on the load balancer or target group. Forces the container instance to be deregistered. If you have tasks running on the container instance
+ * when you deregister it with the Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group
+ * are deregistered. They begin connection draining according to the settings on the load balancer or
+ * target group. The Unix timestamp for when the container instance health status was last
- * updated. The Unix timestamp for when the container instance health status was last updated. The overall health status of the container instance. This is an aggregate status of
- * all container instance health checks. The overall health status of the container instance. This is an aggregate status of all container
+ * instance health checks. An array of objects representing the details of the container instance health
- * status. An array of objects representing the details of the container instance health status. The name of the resource, such as The name of the resource, such as The type of the resource. Valid values: The type of the resource. Valid values: When the When the When the When the When the When the When the When the The Docker and Amazon ECS container agent version information about a container
- * instance. The Docker and Amazon ECS container agent version information about a container instance. The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent
- * GitHub repository. The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub
+ * repository. An Amazon EC2 or External instance that's running the Amazon ECS agent and has been registered
- * with a cluster. An Amazon EC2 or External instance that's running the Amazon ECS agent and has been registered with a
+ * cluster. The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format,
- * see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide. The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN)
+ * in the Amazon ECS Developer Guide. The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2
- * instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID. The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For
+ * external instances, this value is the Amazon Web Services Systems Manager managed instance ID. The version counter for the container instance. Every time a container instance
- * experiences a change that triggers a CloudWatch event, the version counter is
- * incremented. If you're replicating your Amazon ECS container instance state with CloudWatch
- * Events, you can compare the version of a container instance reported by the Amazon ECS APIs
- * with the version reported in CloudWatch Events for the container instance (inside the
- * The version counter for the container instance. Every time a container instance experiences a change
+ * that triggers a CloudWatch event, the version counter is incremented. If you're replicating your Amazon ECS
+ * container instance state with CloudWatch Events, you can compare the version of a container instance
+ * reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance
+ * (inside the The version information for the Amazon ECS container agent and Docker daemon running on the
- * container instance. The version information for the Amazon ECS container agent and Docker daemon running on the container
+ * instance. For CPU and memory resource types, this parameter describes the remaining CPU and
- * memory that wasn't already allocated to tasks and is therefore available for new tasks.
- * For port resource types, this parameter describes the ports that were reserved by the
- * Amazon ECS container agent (at instance registration time) and any task containers that have
- * reserved port mappings on the host (with the For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't
+ * already allocated to tasks and is therefore available for new tasks. For port resource types, this
+ * parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration
+ * time) and any task containers that have reserved port mappings on the host (with the For CPU and memory resource types, this parameter describes the amount of each
- * resource that was available on the container instance when the container agent
- * registered it with Amazon ECS. This value represents the total amount of CPU and memory that
- * can be allocated on this container instance to tasks. For port resource types, this
- * parameter describes the ports that were reserved by the Amazon ECS container agent when it
- * registered the container instance with Amazon ECS. For CPU and memory resource types, this parameter describes the amount of each resource that was
+ * available on the container instance when the container agent registered it with Amazon ECS. This value
+ * represents the total amount of CPU and memory that can be allocated on this container instance to
+ * tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS
+ * container agent when it registered the container instance with Amazon ECS. The status of the container instance. The valid values are If your account has opted in to the The If your account has opted in to the The This parameter returns This parameter returns The number of tasks on the container instance that have a desired status
- * ( The number of tasks on the container instance that have a desired status ( The number of tasks on the container instance that are in the The number of tasks on the container instance that are in the The status of the most recent agent update. If an update wasn't ever requested, this
- * value is The status of the most recent agent update. If an update wasn't ever requested, this value is
+ * The attributes set for the container instance, either by the Amazon ECS container agent at
- * instance registration or manually with the PutAttributes
- * operation. The attributes set for the container instance, either by the Amazon ECS container agent at instance
+ * registration or manually with the PutAttributes operation. The resources attached to a container instance, such as an elastic network
- * interface. The resources attached to a container instance, such as an elastic network interface. The metadata that you apply to the container instance to help you categorize and
- * organize them. Each tag consists of a key and an optional value. You define both. The metadata that you apply to the container instance to help you categorize and organize them. Each
+ * tag consists of a key and an optional value. You define both. The following basic restrictions apply to tags: The The The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to
- * The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to Specifies whether or not you want to see the resource tags for the capacity provider.
- * If Specifies whether or not you want to see the resource tags for the capacity provider. If
+ * The maximum number of account setting results returned by
- * The maximum number of account setting results returned by The systemControls for
* the containers in the task, the following will apply to your IPC resource namespace. For
* more information, see System
@@ -7443,11 +7133,11 @@ export interface TaskDefinition {
/**
* ecs-init package to use a proxy
- * configuration. If your container instances are launched from the Amazon ECS optimized AMI
- * version 20190301 or later, they contain the required versions of the
- * container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.ecs-init package to use a proxy configuration. If your container
+ * instances are launched from the Amazon ECS optimized AMI version 20190301 or later, they
+ * contain the required versions of the container agent and ecs-init. For more information,
+ * see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.true, you can delete a task set even if it hasn't been scaled down to
- * zero.true, you can delete a task set even if it hasn't been scaled down to zero.force option, these
- * tasks remain running until you terminate the instance or the tasks stop through some
- * other means, but they're orphaned (no longer monitored or accounted for by Amazon ECS). If an
- * orphaned task on your container instance is part of an Amazon ECS service, then the service
- * scheduler starts another copy of that task, on a different container instance if
- * possible. force option, these tasks remain running until you
+ * terminate the instance or the tasks stop through some other means, but they're orphaned (no longer
+ * monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an
+ * Amazon ECS service, then the service scheduler starts another copy of that task, on a different container
+ * instance if possible. CPU, MEMORY,
- * PORTS, PORTS_UDP, or a user-defined resource.CPU, MEMORY, PORTS,
+ * PORTS_UDP, or a user-defined resource.INTEGER, DOUBLE,
- * LONG, or STRINGSET.INTEGER, DOUBLE, LONG,
+ * or STRINGSET.doubleValue type is set, the value of the resource must be a
- * double precision floating-point type.doubleValue type is set, the value of the resource must be a double precision
+ * floating-point type.longValue type is set, the value of the resource must be an
- * extended precision floating-point type.longValue type is set, the value of the resource must be an extended precision
+ * floating-point type.integerValue type is set, the value of the resource must be an
- * integer.integerValue type is set, the value of the resource must be an integer.stringSetValue type is set, the value of the resource must be a
- * string type.stringSetValue type is set, the value of the resource must be a string
+ * type.detail object) to verify that the version in your event stream is
+ * detail object) to verify that the version in your event stream is
* current.host or bridge
- * network mode). Any port that's not specified here is available for new tasks.host
+ * or bridge network mode). Any port that's not specified here is available for new
+ * tasks.REGISTERING,
* REGISTRATION_FAILED, ACTIVE, INACTIVE,
* DEREGISTERING, or DRAINING.awsvpcTrunking account setting, then
- * any newly registered container instance will transition to a REGISTERING
- * status while the trunk elastic network interface is provisioned for the instance. If the
- * registration fails, the instance will transition to a REGISTRATION_FAILED
- * status. You can describe the container instance and see the reason for failure in the
- * statusReason parameter. Once the container instance is terminated, the
- * instance transitions to a DEREGISTERING status while the trunk elastic
- * network interface is deprovisioned. The instance then transitions to an
- * INACTIVE status.ACTIVE status indicates that the container instance can accept tasks.
- * The DRAINING indicates that new tasks aren't placed on the container
- * instance and any service tasks running on the container instance are removed if
- * possible. For more information, see Container instance draining in the
- * Amazon Elastic Container Service Developer Guide.awsvpcTrunking account setting, then any newly
+ * registered container instance will transition to a REGISTERING status while the trunk
+ * elastic network interface is provisioned for the instance. If the registration fails, the instance will
+ * transition to a REGISTRATION_FAILED status. You can describe the container instance and
+ * see the reason for failure in the statusReason parameter. Once the container instance is
+ * terminated, the instance transitions to a DEREGISTERING status while the trunk elastic
+ * network interface is deprovisioned. The instance then transitions to an INACTIVE
+ * status.ACTIVE status indicates that the container instance can accept tasks. The
+ * DRAINING indicates that new tasks aren't placed on the container instance and any
+ * service tasks running on the container instance are removed if possible. For more information, see
+ * Container instance draining in the Amazon Elastic Container Service Developer Guide.true if the agent is connected to Amazon ECS. An
- * instance with an agent that may be unhealthy or stopped return false. Only
- * instances connected to an agent can accept task placement requests.true if the agent is connected to Amazon ECS. An instance with an
+ * agent that may be unhealthy or stopped return false. Only instances connected to an agent
+ * can accept task placement requests.desiredStatus) of RUNNING.desiredStatus)
+ * of RUNNING.PENDING
- * status.PENDING status.NULL.NULL.
*
family and revision (family:revision) or
- * full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a
- * revision.family and revision (family:revision) or full Amazon Resource Name (ARN) of
+ * the task definition to deregister. You must specify a revision.100 capacity providers can be described in an action.100 capacity
+ * providers can be described in an action.TAGS is specified, the tags are included in the response. If this field
- * is omitted, tags aren't included in the response.TAGS is specified, the tags are included in the response. If this field is omitted,
+ * tags aren't included in the response.DescribeCapacityProviders in paginated output. When this parameter is
- * used, DescribeCapacityProviders only returns maxResults
- * results in a single page along with a nextToken response element. The
- * remaining results of the initial request can be seen by sending another
- * DescribeCapacityProviders request with the returned
- * nextToken value. This value can be between
- * 1 and 10. If this
- * parameter is not used, then DescribeCapacityProviders returns up to
- * 10 results and a nextToken value
- * if applicable.DescribeCapacityProviders in
+ * paginated output. When this parameter is used, DescribeCapacityProviders only returns
+ * maxResults results in a single page along with a nextToken response
+ * element. The remaining results of the initial request can be seen by sending another
+ * DescribeCapacityProviders request with the returned nextToken value. This
+ * value can be between 1 and 10. If
+ * this parameter is not used, then DescribeCapacityProviders returns up to
+ * 10 results and a nextToken value if
+ * applicable.nextToken value returned from a previous paginated
- * DescribeCapacityProviders request where maxResults was
- * used and the results exceeded the value of that parameter. Pagination continues from the
- * end of the previous results that returned the nextToken value.DescribeCapacityProviders request where maxResults was used and the
+ * results exceeded the value of that parameter. Pagination continues from the end of the previous results
+ * that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to * retrieve the next items in a list and not for other programmatic purposes.
@@ -8050,11 +7723,10 @@ export interface DescribeCapacityProvidersResponse { failures?: Failure[] | undefined; /** - *The nextToken value to include in a future
- * DescribeCapacityProviders request. When the results of a
- * DescribeCapacityProviders request exceed maxResults, this
- * value can be used to retrieve the next page of results. This value is null
- * when there are no more results to return.
The nextToken value to include in a future DescribeCapacityProviders
+ * request. When the results of a DescribeCapacityProviders request exceed
+ * maxResults, this value can be used to retrieve the next page of results. This value is
+ * null when there are no more results to return.
A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. - * If you do not specify a cluster, the default cluster is assumed.
+ *A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.
* @public */ clusters?: string[] | undefined; /** - *Determines whether to include additional information about the clusters in the - * response. If this field is omitted, this information isn't included.
- *If ATTACHMENTS is specified, the attachments for the container instances
- * or tasks within the cluster are included, for example the capacity providers.
If SETTINGS is specified, the settings for the cluster are
- * included.
If CONFIGURATIONS is specified, the configuration for the cluster is
- * included.
If STATISTICS is specified, the task and service count is included,
- * separated by launch type.
If TAGS is specified, the metadata tags associated with the cluster are
- * included.
Determines whether to include additional information about the clusters in the response. If this + * field is omitted, this information isn't included.
+ *If ATTACHMENTS is specified, the attachments for the container instances or tasks within
+ * the cluster are included, for example the capacity providers.
If SETTINGS is specified, the settings for the cluster are included.
If CONFIGURATIONS is specified, the configuration for the cluster is included.
If STATISTICS is specified, the task and service count is included, separated by launch
+ * type.
If TAGS is specified, the metadata tags associated with the cluster are included.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to - * describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance - * or container instances you are describing were launched in any cluster other than the - * default cluster.
+ *The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. + * If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances + * you are describing were launched in any cluster other than the default cluster.
* @public */ cluster?: string | undefined; @@ -8157,11 +7824,10 @@ export interface DescribeContainerInstancesRequest { containerInstances: string[] | undefined; /** - *Specifies whether you want to see the resource tags for the container instance. If
- * TAGS is specified, the tags are included in the response. If
- * CONTAINER_INSTANCE_HEALTH is specified, the container instance health
- * is included in the response. If this field is omitted, tags and container instance
- * health status aren't included in the response.
Specifies whether you want to see the resource tags for the container instance. If TAGS
+ * is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is
+ * specified, the container instance health is included in the response. If this field is omitted, tags
+ * and container instance health status aren't included in the response.
The ARN of the service revision deployed as part of the rollback.
*When the type is GPU, the value is the number of physical
- * GPUs the Amazon ECS container agent reserves for the container. The number
+ * GPUs the Amazon ECS container agent reserves for the container. The number
* of GPUs that's reserved for all containers in a task can't exceed the number of
* available GPUs on the container instance that the task is launched on.
When the type is InferenceAccelerator, the value matches the
- * deviceName for an InferenceAccelerator specified in a task definition.
deviceName for an InferenceAccelerator specified in a task definition.
* @public
*/
serviceRevisionArn?: string | undefined;
@@ -8451,8 +8117,8 @@ export interface ServiceDeployment {
statusReason?: string | undefined;
/**
- * Optional deployment parameters that control how many tasks run during the deployment and the - * failure detection methods.
+ *Optional deployment parameters that control how many tasks run during a deployment and the ordering + * of stopping and starting tasks.
* @public */ deploymentConfiguration?: DeploymentConfiguration | undefined; @@ -8490,7 +8156,7 @@ export interface DescribeServiceDeploymentsResponse { *Any failures associated with the call.
*If you decsribe a deployment with a service revision created before October 25, 2024, the
* call fails. The failure includes the service revision ARN and the reason set to
- * MISSING.
MISSING.
* @public
*/
failures?: Failure[] | undefined;
@@ -8630,9 +8296,9 @@ export interface ServiceRevision {
guardDutyEnabled?: boolean | undefined;
/**
- * The Service Connect configuration of your Amazon ECS service. The configuration for this - * service to discover and connect to services, and be discovered by, and connected from, - * other services within a namespace.
+ *The Service Connect configuration of your Amazon ECS service. The configuration for this service to + * discover and connect to services, and be discovered by, and connected from, other services within a + * namespace.
*Tasks that run in a namespace can use short names to connect * to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. * Tasks connect through a managed proxy container @@ -8660,6 +8326,12 @@ export interface ServiceRevision { * @public */ createdAt?: Date | undefined; + + /** + *
The VPC Lattice configuration for the service revision.
+ * @public + */ + vpcLatticeConfigurations?: VpcLatticeConfiguration[] | undefined; } /** @@ -8698,23 +8370,23 @@ export type ServiceField = (typeof ServiceField)[keyof typeof ServiceField]; export interface DescribeServicesRequest { /** *The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. - * If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are - * describing were launched in any cluster other than the default cluster.
+ * If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were + * launched in any cluster other than the default cluster. * @public */ cluster?: string | undefined; /** - *A list of services to describe. You may specify up to 10 services to describe in a - * single operation.
+ *A list of services to describe. You may specify up to 10 services to describe in a single + * operation.
* @public */ services: string[] | undefined; /** - *Determines whether you want to see the resource tags for the service. If
- * TAGS is specified, the tags are included in the response. If this field
- * is omitted, tags aren't included in the response.
Determines whether you want to see the resource tags for the service. If TAGS is
+ * specified, the tags are included in the response. If this field is omitted, tags aren't included in the
+ * response.
The family for the latest ACTIVE revision,
- * family and revision (family:revision) for a
- * specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to
- * describe.
The family for the latest ACTIVE revision, family and
+ * revision (family:revision) for a specific revision in the family, or full
+ * Amazon Resource Name (ARN) of the task definition to describe.
Determines whether to see the resource tags for the task definition. If
- * TAGS is specified, the tags are included in the response. If this field
- * is omitted, tags aren't included in the response.
Determines whether to see the resource tags for the task definition. If TAGS is
+ * specified, the tags are included in the response. If this field is omitted, tags aren't included in the
+ * response.
The metadata that's applied to the task definition to help you categorize and organize - * them. Each tag consists of a key and an optional value. You define both.
+ *The metadata that's applied to the task definition to help you categorize and organize them. Each tag + * consists of a key and an optional value. You define both.
*The following basic restrictions apply to tags:
*The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to - * describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you - * are describing were launched in any cluster other than the default cluster.
+ *The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. + * If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were + * launched in any cluster other than the default cluster.
* @public */ cluster?: string | undefined; @@ -8853,9 +8524,9 @@ export interface DescribeTasksRequest { tasks: string[] | undefined; /** - *Specifies whether you want to see the resource tags for the task. If TAGS
- * is specified, the tags are included in the response. If this field is omitted, tags
- * aren't included in the response.
Specifies whether you want to see the resource tags for the task. If TAGS is specified,
+ * the tags are included in the response. If this field is omitted, tags aren't included in the
+ * response.
The name of the managed agent. When the execute command feature is turned on, the
- * managed agent name is ExecuteCommandAgent.
The name of the managed agent. When the execute command feature is turned on, the managed agent name
+ * is ExecuteCommandAgent.
Details on the network bindings between a container and its host container instance.
- * After a task reaches the RUNNING status, manual and automatic host and
- * container port assignments are visible in the networkBindings section of
- * DescribeTasks API responses.
Details on the network bindings between a container and its host container instance. After a task
+ * reaches the RUNNING status, manual and automatic host and container port assignments are
+ * visible in the networkBindings section of DescribeTasks API
+ * responses.
The port number range on the container that's bound to the dynamically mapped host - * port range.
+ *The port number range on the container that's bound to the dynamically mapped host port range.
*The following rules apply when you specify a containerPortRange:
The port number range on the host that's used with the network binding. This is - * assigned is assigned by Docker and delivered by the Amazon ECS agent.
+ *The port number range on the host that's used with the network binding. This is assigned is assigned + * by Docker and delivered by the Amazon ECS agent.
* @public */ hostPortRange?: string | undefined; } /** - *An object representing the elastic network interface for tasks that use the
- * awsvpc network mode.
An object representing the elastic network interface for tasks that use the awsvpc
+ * network mode.
A short (255 max characters) human-readable string to provide additional details about - * a running or stopped container.
+ *A short (255 max characters) human-readable string to provide additional details about a running or + * stopped container.
* @public */ reason?: string | undefined; @@ -9136,9 +8806,8 @@ export interface Container { networkInterfaces?: NetworkInterface[] | undefined; /** - *The health status of the container. If health checks aren't configured for this
- * container in its task definition, then it reports the health status as
- * UNKNOWN.
The health status of the container. If health checks aren't configured for this container in its task
+ * definition, then it reports the health status as UNKNOWN.
The number of CPU units set for the container. The value is 0 if no value
- * was specified in the container definition when the task definition was
- * registered.
The number of CPU units set for the container. The value is 0 if no value was specified
+ * in the container definition when the task definition was registered.
The total amount, in GiB, of the ephemeral storage to set for the task. The minimum
- * supported value is 20 GiB and the maximum supported value is
- * 200 GiB.
The total amount, in GiB, of the ephemeral storage to set for the task. The minimum supported value
+ * is 20 GiB and the maximum supported value is
200 GiB.
Specify an Amazon Web Services Key Management Service key ID to encrypt the ephemeral storage for the - * task.
+ *Specify an Key Management Service key ID to encrypt the ephemeral storage for the task.
* @public */ kmsKeyId?: string | undefined; } /** - *The overrides that are sent to a container. An empty container override can be passed
- * in. An example of an empty container override is \{"containerOverrides": [ ]
- * \}. If a non-empty container override is specified, the name
- * parameter must be included.
You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the - * sensitive data. For more information, see Retrieve secrets through - * environment variables in the Amazon ECS Developer Guide.
+ *The overrides that are sent to a container. An empty container override can be passed in. An example
+ * of an empty container override is \{"containerOverrides": [ ] \}. If a non-empty container
+ * override is specified, the name parameter must be included.
You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the sensitive data. For + * more information, see Retrieve secrets through environment + * variables in the Amazon ECS Developer Guide.
* @public */ export interface ContainerOverride { /** - *The name of the container that receives the override. This parameter is required if - * any override is specified.
+ *The name of the container that receives the override. This parameter is required if any override is + * specified.
* @public */ name?: string | undefined; /** - *The command to send to the container that overrides the default command from the - * Docker image or the task definition. You must also specify a container name.
+ *The command to send to the container that overrides the default command from the Docker image or the + * task definition. You must also specify a container name.
* @public */ command?: string[] | undefined; /** - *The environment variables to send to the container. You can add new environment - * variables, which are added to the container at launch, or you can override the existing - * environment variables from the Docker image or the task definition. You must also - * specify a container name.
+ *The environment variables to send to the container. You can add new environment variables, which are + * added to the container at launch, or you can override the existing environment variables from the + * Docker image or the task definition. You must also specify a container name.
* @public */ environment?: KeyValuePair[] | undefined; /** - *A list of files containing the environment variables to pass to a container, instead - * of the value from the container definition.
+ *A list of files containing the environment variables to pass to a container, instead of the value + * from the container definition.
* @public */ environmentFiles?: EnvironmentFile[] | undefined; /** - *The number of cpu units reserved for the container, instead of the
- * default value from the task definition. You must also specify a container name.
The number of cpu units reserved for the container, instead of the default value from
+ * the task definition. You must also specify a container name.
The hard limit (in MiB) of memory to present to the container, instead of the default - * value from the task definition. If your container attempts to exceed the memory - * specified here, the container is killed. You must also specify a container name.
+ *The hard limit (in MiB) of memory to present to the container, instead of the default value from the + * task definition. If your container attempts to exceed the memory specified here, the container is + * killed. You must also specify a container name.
* @public */ memory?: number | undefined; /** - *The soft limit (in MiB) of memory to reserve for the container, instead of the default - * value from the task definition. You must also specify a container name.
+ *The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the + * task definition. You must also specify a container name.
* @public */ memoryReservation?: number | undefined; /** - *The type and amount of a resource to assign to a container, instead of the default - * value from the task definition. The only supported resource is a GPU.
+ *The type and amount of a resource to assign to a container, instead of the default value from the + * task definition. The only supported resource is a GPU.
* @public */ resourceRequirements?: ResourceRequirement[] | undefined; } /** - *Details on an Elastic Inference accelerator task override. This parameter is used to - * override the Elastic Inference accelerator specified in the task definition. For more - * information, see Working with Amazon - * Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
+ *Details on an Elastic Inference accelerator task override. This parameter is used to override the + * Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the + * Amazon Elastic Container Service Developer Guide.
* @public */ export interface InferenceAcceleratorOverride { /** - *The Elastic Inference accelerator device name to override for the task. This parameter
- * must match a deviceName specified in the task definition.
The Elastic Inference accelerator device name to override for the task. This parameter must match a
+ * deviceName specified in the task definition.
The Amazon Resource Name (ARN) of the task execution role override for the task. For more information,
- * see Amazon ECS task
+ * The Amazon Resource Name (ARN) of the task execution role override for the task. For more information, see Amazon ECS task
* execution IAM role in the Amazon Elastic Container Service Developer Guide. The Amazon Resource Name (ARN) of the role that containers in this task can assume. All containers in
- * this task are granted the permissions that are specified in this role. For more
- * information, see IAM Role for Tasks
- * in the Amazon Elastic Container Service Developer Guide. The Amazon Resource Name (ARN) of the role that containers in this task can assume. All containers in this task are
+ * granted the permissions that are specified in this role. For more information, see IAM Role for
+ * Tasks in the Amazon Elastic Container Service Developer Guide. The ephemeral storage setting override for the task. This parameter is only supported for tasks hosted on Fargate that
- * use the following platform versions: This parameter is only supported for tasks hosted on Fargate that use the following
+ * platform versions: Linux platform version The Elastic Network Adapter that's associated with the task if the task uses the
- * The Elastic Network Adapter that's associated with the task if the task uses the The Unix timestamp for the time when the task last went into The Unix timestamp for the time when the task last went into The number of CPU units used by the task as expressed in a task definition. It can be
- * expressed as an integer using CPU units (for example, If you use the EC2 launch type, this field is optional. Supported values
- * are between If you use the Fargate launch type, this field is required. You must use
- * one of the following values. These values determine the range of supported values for
- * the The number of CPU units used by the task as expressed in a task definition. It can be expressed as an
+ * integer using CPU units (for example, If you use the EC2 launch type, this field is optional. Supported values are between
+ * If you use the Fargate launch type, this field is required. You must use one of the
+ * following values. These values determine the range of supported values for the The CPU units cannot be less than 1 vCPU when you use Windows containers on
* Fargate. The Unix timestamp for the time when the task was created. More specifically, it's for
- * the time when the task entered the The Unix timestamp for the time when the task was created. More specifically, it's for the time when
+ * the task entered the The desired status of the task. For more information, see Task
- * Lifecycle. The desired status of the task. For more information, see Task Lifecycle. Determines whether execute command functionality is turned on for this task. If
- * Determines whether execute command functionality is turned on for this task. If The health status for the task. It's determined by the health of the essential
- * containers in the task. If all essential containers in the task are reporting as
- * The health status for the task. It's determined by the health of the essential containers in the
+ * task. If all essential containers in the task are reporting as The Amazon ECS container agent doesn't monitor or report on Docker health checks that
- * are embedded in a container image and not specified in the container definition. For
- * example, this includes those specified in a parent image or from the image's
- * Dockerfile. Health check parameters that are specified in a container definition
- * override any Docker health checks that are found in the container image. The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in
+ * a container image and not specified in the container definition. For example, this includes those
+ * specified in a parent image or from the image's Dockerfile. Health check parameters that are
+ * specified in a container definition override any Docker health checks that are found in the
+ * container image. The last known status for the task. For more information, see Task
- * Lifecycle. The last known status for the task. For more information, see Task Lifecycle. The infrastructure where your task runs on. For more information, see Amazon ECS
- * launch types in the Amazon Elastic Container Service Developer Guide. The infrastructure where your task runs on. For more information, see Amazon ECS launch
+ * types in the Amazon Elastic Container Service Developer Guide. The amount of memory (in MiB) that the task uses as expressed in a task definition. It
- * can be expressed as an integer using MiB (for example, The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be
+ * expressed as an integer using MiB (for example, If you use the EC2 launch type, this field is optional. If you use the Fargate launch type, this field is required. You must use
- * one of the following values. The value that you choose determines the range of supported
- * values for the If you use the Fargate launch type, this field is required. You must use one of the
+ * following values. The value that you choose determines the range of supported values for the
+ * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available The platform version where your task runs on. A platform version is only specified for
- * tasks that use the Fargate launch type. If you didn't specify one, the
- * The platform version where your task runs on. A platform version is only specified for tasks that use
+ * the Fargate launch type. If you didn't specify one, the The operating system that your tasks are running on. A platform family is specified
- * only for tasks that use the Fargate launch type. All tasks that run as part of this service must use the same
- * The operating system that your tasks are running on. A platform family is specified only for tasks
+ * that use the Fargate launch type. All tasks that run as part of this service must use the same The Unix timestamp for the time when the task started. More specifically, it's for the
- * time when the task transitioned from the The Unix timestamp for the time when the task started. More specifically, it's for the time when the
+ * task transitioned from the The stop code indicating why a task was stopped. The For more information about stop code, see Stopped tasks
- * error codes in the Amazon ECS Developer Guide. The stop code indicating why a task was stopped. The For more information about stop code, see Stopped tasks error
+ * codes in the Amazon ECS Developer Guide. The Unix timestamp for the time when the task was stopped. More specifically, it's for
- * the time when the task transitioned from the The Unix timestamp for the time when the task was stopped. More specifically, it's for the time when
+ * the task transitioned from the The Unix timestamp for the time when the task stops. More specifically, it's for the
- * time when the task transitions from the The Unix timestamp for the time when the task stops. More specifically, it's for the time when the
+ * task transitions from the The metadata that you apply to the task to help you categorize and organize the task.
- * Each tag consists of a key and an optional value. You define both the key and
- * value. The metadata that you apply to the task to help you categorize and organize the task. Each tag
+ * consists of a key and an optional value. You define both the key and value. The following basic restrictions apply to tags: The version counter for the task. Every time a task experiences a change that starts a
- * CloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state
- * with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API
- * actions with the version reported in CloudWatch Events for the task (inside the
- * The version counter for the task. Every time a task experiences a change that starts a CloudWatch event,
+ * the version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can
+ * compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch
+ * Events for the task (inside the The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task
- * sets exist in. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist
+ * in. The ID or full Amazon Resource Name (ARN) of task sets to
- * describe. The ID or full Amazon Resource Name (ARN) of task sets to describe. Specifies whether to see the resource tags for the task set. If Specifies whether to see the resource tags for the task set. If The container instance ID or full ARN of the container instance. For more
- * information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide. The container instance ID or full ARN of the container instance. For more information about the
+ * ARN format, see Amazon Resource Name (ARN)
+ * in the Amazon ECS Developer Guide. The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs
- * to. The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs to. The name of the container to execute the command on. A container name only needs to be
- * specified for tasks containing multiple containers. The name of the container to execute the command on. A container name only needs to be specified for
+ * tasks containing multiple containers. A URL to the managed agent on the container that the SSM Session Manager client uses
- * to send commands and receive output from the container. A URL to the managed agent on the container that the SSM Session Manager client uses to send commands
+ * and receive output from the container. An encrypted token value containing session and caller information. It's used to
- * authenticate the connection to the container. An encrypted token value containing session and caller information. It's used to authenticate the
+ * connection to the container. Determines whether the execute command session is running in interactive mode. Amazon ECS
- * only supports initiating interactive sessions, so you must specify Determines whether the execute command session is running in interactive mode. Amazon ECS only supports
+ * initiating interactive sessions, so you must specify The details of the SSM session that was created for this instance of
- * execute-command. The details of the SSM session that was created for this instance of execute-command. The execute command cannot run. This error can be caused by any of the following
- * configuration issues: The execute command cannot run. This error can be caused by any of the following configuration
+ * issues: Incorrect IAM permissions The SSM agent is not installed or is not running There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for
- * Systems Manager Session Manager There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for Systems
+ * Manager Session Manager For information about how to troubleshoot the issues, see Troubleshooting issues with ECS
- * Exec in the Amazon Elastic Container Service Developer Guide. For information about how to troubleshoot the issues, see Troubleshooting issues with ECS Exec in
+ * the Amazon Elastic Container Service Developer Guide. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task
- * sets exist in. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist
+ * in. An object representing the protection status details for a task. You can set the
- * protection status with the UpdateTaskProtection API and get the status
- * of tasks with the GetTaskProtection API. An object representing the protection status details for a task. You can set the protection status
+ * with the UpdateTaskProtection API and get the status of tasks with the GetTaskProtection
+ * API. The protection status of the task. If scale-in protection is on for a task, the value
- * is The protection status of the task. If scale-in protection is on for a task, the value is
+ *
- *
*
1.4.0 or later.awsvpc network mode.awsvpc
+ * network mode.CONNECTED
- * status.CONNECTED status.1024). It can also be
- * expressed as a string using vCPUs (for example, 1 vCPU or 1
- * vcpu). String values are converted to an integer that indicates the CPU units
- * when the task definition is registered.128 CPU units (0.125 vCPUs) and 10240
- * CPU units (10 vCPUs).memory parameter:1024). It can also be expressed as a string using
+ * vCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an
+ * integer that indicates the CPU units when the task definition is registered.128 CPU units (0.125 vCPUs) and 10240 CPU units
+ * (10 vCPUs).memory
+ * parameter:
@@ -9480,23 +9139,21 @@ export interface Task {
cpu?: string | undefined;
/**
- *
PENDING state.PENDING state.true, execute command functionality is turned on all the containers in
- * the task.true,
+ * execute command functionality is turned on all the containers in the task.HEALTHY, the task status also reports as HEALTHY. If any
- * essential containers in the task are reporting as UNHEALTHY or
- * UNKNOWN, the task status also reports as UNHEALTHY or
- * UNKNOWN.HEALTHY, the task status
+ * also reports as HEALTHY. If any essential containers in the task are reporting as
+ * UNHEALTHY or UNKNOWN, the task status also reports as
+ * UNHEALTHY or UNKNOWN.1024). If it's
- * expressed as a string using GB (for example, 1GB or 1 GB),
- * it's converted to an integer indicating the MiB when the task definition is
- * registered.1024). If it's expressed as a string using
+ * GB (for example, 1GB or 1 GB), it's converted to an integer indicating the
+ * MiB when the task definition is registered.cpu parameter.cpu parameter.
*
cpu values: 256 (.25 vCPU)LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.LATEST platform
+ * version is used. For more information, see Fargate Platform Versions in
+ * the Amazon Elastic Container Service Developer Guide.platformFamily value as the service (for example,
- * LINUX.).platformFamily value as
+ * the service (for example, LINUX.).PENDING state to the
- * RUNNING state.PENDING state to the RUNNING state.stoppedReason might
- * contain additional details. stoppedReason might contain
+ * additional details. RUNNING state to the
- * STOPPED state.RUNNING state to the STOPPED state.RUNNING state to
- * STOPPING.RUNNING state to STOPPING.
*
detail object) to verify that the version in your event stream is
- * current.detail object) to verify that the version in your event
+ * stream is current.TAGS is
- * specified, the tags are included in the response. If this field is omitted, tags aren't
- * included in the response.TAGS is specified, the
+ * tags are included in the response. If this field is omitted, tags aren't included in the
+ * response.true for
- * this value.true for this value.
*
- * true. Otherwise, it is false.true. Otherwise, it is false.protectionEnabled: The protection status of the task. If scale-in
- * protection is turned on for a task, the value is true. Otherwise,
- * it is false.protectionEnabled: The protection status of the task. If scale-in protection is
+ * turned on for a task, the value is true. Otherwise, it is
+ * false.
- * expirationDate: The epoch time when protection for the task will
- * expire.
expirationDate: The epoch time when protection for the task will expire.
* The value of the account settings to filter results with. You must also specify an - * account setting name to use this parameter.
+ *The value of the account settings to filter results with. You must also specify an account setting + * name to use this parameter.
* @public */ value?: string | undefined; /** - *The ARN of the principal, which can be a user, role, or the root user. If this field is - * omitted, the account settings are listed only for the authenticated user.
+ *The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the + * account settings are listed only for the authenticated user.
*Federated users assume the account setting of the root user and can't have explicit - * account settings set for them.
+ *Federated users assume the account setting of the root user and can't have explicit account settings + * set for them.
*Determines whether to return the effective settings. If true, the account
- * settings for the root user or the default setting for the principalArn are
- * returned. If false, the account settings for the principalArn
- * are returned if they're set. Otherwise, no account settings are returned.
Determines whether to return the effective settings. If true, the account settings for
+ * the root user or the default setting for the principalArn are returned. If
+ * false, the account settings for the principalArn are returned if they're set.
+ * Otherwise, no account settings are returned.
The nextToken value returned from a ListAccountSettings
- * request indicating that more results are available to fulfill the request and further
- * calls will be needed. If maxResults was provided, it's possible the number
- * of results to be fewer than maxResults.
The nextToken value returned from a ListAccountSettings request indicating
+ * that more results are available to fulfill the request and further calls will be needed. If
+ * maxResults was provided, it's possible the number of results to be fewer than
+ * maxResults.
This token should be treated as an opaque identifier that is only used to * retrieve the next items in a list and not for other programmatic purposes.
@@ -10164,16 +9809,15 @@ export interface ListAccountSettingsRequest { nextToken?: string | undefined; /** - *The maximum number of account setting results returned by
- * ListAccountSettings in paginated output. When this parameter is used,
- * ListAccountSettings only returns maxResults results in a
- * single page along with a nextToken response element. The remaining results
- * of the initial request can be seen by sending another ListAccountSettings
- * request with the returned nextToken value. This value can be between
- * 1 and 10. If this
+ *
The maximum number of account setting results returned by ListAccountSettings in
+ * paginated output. When this parameter is used, ListAccountSettings only returns
+ * maxResults results in a single page along with a nextToken response
+ * element. The remaining results of the initial request can be seen by sending another
+ * ListAccountSettings request with the returned nextToken value. This value
+ * can be between 1 and 10. If this
* parameter isn't used, then ListAccountSettings returns up to
- * 10 results and a nextToken value
- * if applicable.
nextToken value if
+ * applicable.
* @public
*/
maxResults?: number | undefined;
@@ -10190,11 +9834,10 @@ export interface ListAccountSettingsResponse {
settings?: Setting[] | undefined;
/**
- * The nextToken value to include in a future
- * ListAccountSettings request. When the results of a
- * ListAccountSettings request exceed maxResults, this value
- * can be used to retrieve the next page of results. This value is null when
- * there are no more results to return.
The nextToken value to include in a future ListAccountSettings request.
+ * When the results of a ListAccountSettings request exceed maxResults, this
+ * value can be used to retrieve the next page of results. This value is null when there are
+ * no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. - * If you do not specify a cluster, the default cluster is assumed.
+ *The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.
* @public */ cluster?: string | undefined; @@ -10224,17 +9866,17 @@ export interface ListAttributesRequest { attributeName?: string | undefined; /** - *The value of the attribute to filter results with. You must also specify an attribute - * name to use this parameter.
+ *The value of the attribute to filter results with. You must also specify an attribute name to use + * this parameter.
* @public */ attributeValue?: string | undefined; /** - *The nextToken value returned from a ListAttributes request
- * indicating that more results are available to fulfill the request and further calls are
- * needed. If maxResults was provided, it's possible the number of results to
- * be fewer than maxResults.
The nextToken value returned from a ListAttributes request indicating that
+ * more results are available to fulfill the request and further calls are needed. If
+ * maxResults was provided, it's possible the number of results to be fewer than
+ * maxResults.
This token should be treated as an opaque identifier that is only used to * retrieve the next items in a list and not for other programmatic purposes.
@@ -10244,14 +9886,13 @@ export interface ListAttributesRequest { nextToken?: string | undefined; /** - *The maximum number of cluster results that ListAttributes returned in
- * paginated output. When this parameter is used, ListAttributes only returns
- * maxResults results in a single page along with a nextToken
- * response element. The remaining results of the initial request can be seen by sending
- * another ListAttributes request with the returned nextToken
- * value. This value can be between 1 and 100. If this
- * parameter isn't used, then ListAttributes returns up to
- * 100 results and a nextToken value if applicable.
The maximum number of cluster results that ListAttributes returned in paginated output.
+ * When this parameter is used, ListAttributes only returns maxResults results
+ * in a single page along with a nextToken response element. The remaining results of the
+ * initial request can be seen by sending another ListAttributes request with the returned
+ * nextToken value. This value can be between 1 and 100. If
+ * this parameter isn't used, then ListAttributes returns up to 100 results
+ * and a nextToken value if applicable.
The nextToken value to include in a future ListAttributes
- * request. When the results of a ListAttributes request exceed
- * maxResults, this value can be used to retrieve the next page of
- * results. This value is null when there are no more results to
+ *
The nextToken value to include in a future ListAttributes request. When the
+ * results of a ListAttributes request exceed maxResults, this value can be used
+ * to retrieve the next page of results. This value is null when there are no more results to
* return.
The nextToken value returned from a ListClusters request
- * indicating that more results are available to fulfill the request and further calls are
- * needed. If maxResults was provided, it's possible the number of results to
- * be fewer than maxResults.
The nextToken value returned from a ListClusters request indicating that
+ * more results are available to fulfill the request and further calls are needed. If
+ * maxResults was provided, it's possible the number of results to be fewer than
+ * maxResults.
This token should be treated as an opaque identifier that is only used to * retrieve the next items in a list and not for other programmatic purposes.
@@ -10296,14 +9936,13 @@ export interface ListClustersRequest { nextToken?: string | undefined; /** - *The maximum number of cluster results that ListClusters returned in
- * paginated output. When this parameter is used, ListClusters only returns
- * maxResults results in a single page along with a nextToken
- * response element. The remaining results of the initial request can be seen by sending
- * another ListClusters request with the returned nextToken
- * value. This value can be between 1 and 100. If this
- * parameter isn't used, then ListClusters returns up to 100
- * results and a nextToken value if applicable.
The maximum number of cluster results that ListClusters returned in paginated output.
+ * When this parameter is used, ListClusters only returns maxResults results in
+ * a single page along with a nextToken response element. The remaining results of the
+ * initial request can be seen by sending another ListClusters request with the returned
+ * nextToken value. This value can be between 1 and 100. If
+ * this parameter isn't used, then ListClusters returns up to 100 results
+ * and a nextToken value if applicable.
The list of full Amazon Resource Name (ARN) entries for each cluster that's associated with your - * account.
+ *The list of full Amazon Resource Name (ARN) entries for each cluster that's associated with your account.
* @public */ clusterArns?: string[] | undefined; /** - *The nextToken value to include in a future ListClusters
- * request. When the results of a ListClusters request exceed
- * maxResults, this value can be used to retrieve the next page of
- * results. This value is null when there are no more results to
+ *
The nextToken value to include in a future ListClusters request. When the
+ * results of a ListClusters request exceed maxResults, this value can be used
+ * to retrieve the next page of results. This value is null when there are no more results to
* return.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to - * list. If you do not specify a cluster, the default cluster is assumed.
+ *The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. + * If you do not specify a cluster, the default cluster is assumed.
* @public */ cluster?: string | undefined; /** - *You can filter the results of a ListContainerInstances operation with
- * cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
You can filter the results of a ListContainerInstances operation with cluster query
+ * language statements. For more information, see Cluster
+ * Query Language in the Amazon Elastic Container Service Developer Guide.
The nextToken value returned from a ListContainerInstances
- * request indicating that more results are available to fulfill the request and further
- * calls are needed. If maxResults was provided, it's possible the number of
- * results to be fewer than maxResults.
The nextToken value returned from a ListContainerInstances request
+ * indicating that more results are available to fulfill the request and further calls are needed. If
+ * maxResults was provided, it's possible the number of results to be fewer than
+ * maxResults.
This token should be treated as an opaque identifier that is only used to * retrieve the next items in a list and not for other programmatic purposes.
@@ -10380,26 +10018,23 @@ export interface ListContainerInstancesRequest { nextToken?: string | undefined; /** - *The maximum number of container instance results that
- * ListContainerInstances returned in paginated output. When this
- * parameter is used, ListContainerInstances only returns
- * maxResults results in a single page along with a nextToken
- * response element. The remaining results of the initial request can be seen by sending
- * another ListContainerInstances request with the returned
- * nextToken value. This value can be between 1 and
- * 100. If this parameter isn't used, then
- * ListContainerInstances returns up to 100 results and
- * a nextToken value if applicable.
The maximum number of container instance results that ListContainerInstances returned in
+ * paginated output. When this parameter is used, ListContainerInstances only returns
+ * maxResults results in a single page along with a nextToken response
+ * element. The remaining results of the initial request can be seen by sending another
+ * ListContainerInstances request with the returned nextToken value. This
+ * value can be between 1 and 100. If this parameter isn't used, then
+ * ListContainerInstances returns up to 100 results and a
+ * nextToken value if applicable.
Filters the container instances by status. For example, if you specify the
- * DRAINING status, the results include only container instances that have
- * been set to DRAINING using UpdateContainerInstancesState.
- * If you don't specify this parameter, the default is to include container instances set
- * to all states other than INACTIVE.
Filters the container instances by status. For example, if you specify the DRAINING
+ * status, the results include only container instances that have been set to DRAINING using
+ * UpdateContainerInstancesState. If you don't specify this parameter, the default is to
+ * include container instances set to all states other than INACTIVE.
The list of container instances with full ARN entries for each container instance - * associated with the specified cluster.
+ *The list of container instances with full ARN entries for each container instance associated with + * the specified cluster.
* @public */ containerInstanceArns?: string[] | undefined; /** - *The nextToken value to include in a future
- * ListContainerInstances request. When the results of a
- * ListContainerInstances request exceed maxResults, this
- * value can be used to retrieve the next page of results. This value is null
- * when there are no more results to return.
The nextToken value to include in a future ListContainerInstances request.
+ * When the results of a ListContainerInstances request exceed maxResults, this
+ * value can be used to retrieve the next page of results. This value is null when there are
+ * no more results to return.
The maximum number of service deployment results that ListServiceDeployments
* returned in paginated output. When this parameter is used,
- * ListServiceDeployments only returns maxResults results in
+ * ListServiceDeployments only returns maxResults results in
* a single page along with a nextToken response element. The remaining
* results of the initial request can be seen by sending another
- * ListServiceDeployments request with the returned nextToken
+ * ListServiceDeployments request with the returned nextToken
* value. This value can be between 1 and 100. If this parameter isn't used, then
- * ListServiceDeployments returns up to 20 results and a
- * nextToken value if applicable.
ListServiceDeployments returns up to 20 results and a
+ * nextToken value if applicable.
* @public
*/
maxResults?: number | undefined;
@@ -10616,17 +10250,17 @@ export interface ListServiceDeploymentsResponse {
*/
export interface ListServicesRequest {
/**
- * The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the
- * ListServices results. If you do not specify a cluster, the default cluster is assumed.
The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListServices
+ * results. If you do not specify a cluster, the default cluster is assumed.
The nextToken value returned from a ListServices request
- * indicating that more results are available to fulfill the request and further calls will
- * be needed. If maxResults was provided, it is possible the number of results
- * to be fewer than maxResults.
The nextToken value returned from a ListServices request indicating that
+ * more results are available to fulfill the request and further calls will be needed. If
+ * maxResults was provided, it is possible the number of results to be fewer than
+ * maxResults.
This token should be treated as an opaque identifier that is only used to * retrieve the next items in a list and not for other programmatic purposes.
@@ -10636,15 +10270,13 @@ export interface ListServicesRequest { nextToken?: string | undefined; /** - *The maximum number of service results that ListServices returned in
- * paginated output. When this parameter is used, ListServices only returns
- * maxResults results in a single page along with a nextToken
- * response element. The remaining results of the initial request can be seen by sending
- * another ListServices request with the returned nextToken
- * value. This value can be between 1 and 100. If
- * this parameter isn't used, then ListServices returns up to
- * 10 results and a nextToken value if
- * applicable.
The maximum number of service results that ListServices returned in paginated output.
+ * When this parameter is used, ListServices only returns maxResults results in
+ * a single page along with a nextToken response element. The remaining results of the
+ * initial request can be seen by sending another ListServices request with the returned
+ * nextToken value. This value can be between 1 and
+ * 100. If this parameter isn't used, then ListServices returns up to
+ * 10 results and a nextToken value if applicable.
The scheduling strategy to use when filtering the ListServices
- * results.
The scheduling strategy to use when filtering the ListServices results.
The list of full ARN entries for each service that's associated with the specified - * cluster.
+ *The list of full ARN entries for each service that's associated with the specified cluster.
* @public */ serviceArns?: string[] | undefined; /** - *The nextToken value to include in a future ListServices
- * request. When the results of a ListServices request exceed
- * maxResults, this value can be used to retrieve the next page of
- * results. This value is null when there are no more results to
+ *
The nextToken value to include in a future ListServices request. When the
+ * results of a ListServices request exceed maxResults, this value can be used
+ * to retrieve the next page of results. This value is null when there are no more results to
* return.
The nextToken value that's returned from a
- * ListServicesByNamespace request. It indicates that more results are
- * available to fulfill the request and further calls are needed. If
- * maxResults is returned, it is possible the number of results is less
- * than maxResults.
The nextToken value that's returned from a ListServicesByNamespace request.
+ * It indicates that more results are available to fulfill the request and further calls are needed. If
+ * maxResults is returned, it is possible the number of results is less than
+ * maxResults.
The maximum number of service results that ListServicesByNamespace
- * returns in paginated output. When this parameter is used,
- * ListServicesByNamespace only returns maxResults results in
- * a single page along with a nextToken response element. The remaining
- * results of the initial request can be seen by sending another
- * ListServicesByNamespace request with the returned
- * nextToken value. This value can be between 1 and
- * 100. If this parameter isn't used, then
- * ListServicesByNamespace returns up to
- * 10 results and a nextToken
- * value if applicable.
The maximum number of service results that ListServicesByNamespace returns in paginated
+ * output. When this parameter is used, ListServicesByNamespace only returns
+ * maxResults results in a single page along with a nextToken response
+ * element. The remaining results of the initial request can be seen by sending another
+ * ListServicesByNamespace request with the returned nextToken value. This
+ * value can be between 1 and 100. If this parameter
+ * isn't used, then ListServicesByNamespace returns up to
+ * 10 results and a nextToken value if
+ * applicable.
The nextToken value to include in a future
- * ListServicesByNamespace request. When the results of a
- * ListServicesByNamespace request exceed maxResults, this
- * value can be used to retrieve the next page of results. When there are no more results
- * to return, this value is null.
The nextToken value to include in a future ListServicesByNamespace request.
+ * When the results of a ListServicesByNamespace request exceed maxResults, this
+ * value can be used to retrieve the next page of results. When there are no more results to return, this
+ * value is null.
The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the - * supported resources are Amazon ECS tasks, services, task definitions, clusters, and container - * instances.
+ *The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources + * are Amazon ECS tasks, services, task definitions, clusters, and container instances.
* @public */ resourceArn: string | undefined; @@ -10795,33 +10419,29 @@ export type TaskDefinitionFamilyStatus = (typeof TaskDefinitionFamilyStatus)[key export interface ListTaskDefinitionFamiliesRequest { /** *The familyPrefix is a string that's used to filter the results of
- * ListTaskDefinitionFamilies. If you specify a familyPrefix,
- * only task definition family names that begin with the familyPrefix string
- * are returned.
ListTaskDefinitionFamilies. If you specify a familyPrefix, only task
+ * definition family names that begin with the familyPrefix string are returned.
* @public
*/
familyPrefix?: string | undefined;
/**
- * The task definition family status to filter the
- * ListTaskDefinitionFamilies results with. By default, both
- * ACTIVE and INACTIVE task definition families are listed.
- * If this parameter is set to ACTIVE, only task definition families that have
- * an ACTIVE task definition revision are returned. If this parameter is set
- * to INACTIVE, only task definition families that do not have any
- * ACTIVE task definition revisions are returned. If you paginate the
- * resulting output, be sure to keep the status value constant in each
- * subsequent request.
The task definition family status to filter the ListTaskDefinitionFamilies results with.
+ * By default, both ACTIVE and INACTIVE task definition families are listed. If
+ * this parameter is set to ACTIVE, only task definition families that have an
+ * ACTIVE task definition revision are returned. If this parameter is set to
+ * INACTIVE, only task definition families that do not have any ACTIVE task
+ * definition revisions are returned. If you paginate the resulting output, be sure to keep the
+ * status value constant in each subsequent request.
The nextToken value returned from a
- * ListTaskDefinitionFamilies request indicating that more results are
- * available to fulfill the request and further calls will be needed. If
- * maxResults was provided, it is possible the number of results to be
- * fewer than maxResults.
The nextToken value returned from a ListTaskDefinitionFamilies request
+ * indicating that more results are available to fulfill the request and further calls will be needed. If
+ * maxResults was provided, it is possible the number of results to be fewer than
+ * maxResults.
This token should be treated as an opaque identifier that is only used to * retrieve the next items in a list and not for other programmatic purposes.
@@ -10831,16 +10451,14 @@ export interface ListTaskDefinitionFamiliesRequest { nextToken?: string | undefined; /** - *The maximum number of task definition family results that
- * ListTaskDefinitionFamilies returned in paginated output. When this
- * parameter is used, ListTaskDefinitions only returns maxResults
- * results in a single page along with a nextToken response element. The
- * remaining results of the initial request can be seen by sending another
- * ListTaskDefinitionFamilies request with the returned
- * nextToken value. This value can be between 1 and
- * 100. If this parameter isn't used, then
- * ListTaskDefinitionFamilies returns up to 100 results
- * and a nextToken value if applicable.
The maximum number of task definition family results that ListTaskDefinitionFamilies
+ * returned in paginated output. When this parameter is used, ListTaskDefinitions only
+ * returns maxResults results in a single page along with a nextToken response
+ * element. The remaining results of the initial request can be seen by sending another
+ * ListTaskDefinitionFamilies request with the returned nextToken value.
+ * This value can be between 1 and 100. If this parameter isn't used, then
+ * ListTaskDefinitionFamilies returns up to 100 results and a
+ * nextToken value if applicable.
The list of task definition family names that match the
- * ListTaskDefinitionFamilies request.
The list of task definition family names that match the ListTaskDefinitionFamilies
+ * request.
The nextToken value to include in a future
- * ListTaskDefinitionFamilies request. When the results of a
- * ListTaskDefinitionFamilies request exceed maxResults, this
- * value can be used to retrieve the next page of results. This value is null
- * when there are no more results to return.
The nextToken value to include in a future ListTaskDefinitionFamilies
+ * request. When the results of a ListTaskDefinitionFamilies request exceed
+ * maxResults, this value can be used to retrieve the next page of results. This value is
+ * null when there are no more results to return.
The full family name to filter the ListTaskDefinitions results with.
- * Specifying a familyPrefix limits the listed task definitions to task
- * definition revisions that belong to that family.
The full family name to filter the ListTaskDefinitions results with. Specifying a
+ * familyPrefix limits the listed task definitions to task definition revisions that
+ * belong to that family.
The task definition status to filter the ListTaskDefinitions results
- * with. By default, only ACTIVE task definitions are listed. By setting this
- * parameter to INACTIVE, you can view task definitions that are
- * INACTIVE as long as an active task or service still references them. If
- * you paginate the resulting output, be sure to keep the status value
- * constant in each subsequent request.
The task definition status to filter the ListTaskDefinitions results with. By default,
+ * only ACTIVE task definitions are listed. By setting this parameter to
+ * INACTIVE, you can view task definitions that are INACTIVE as long as an
+ * active task or service still references them. If you paginate the resulting output, be sure to keep the
+ * status value constant in each subsequent request.
The order to sort the results in. Valid values are ASC and
- * DESC. By default, (ASC) task definitions are listed
- * lexicographically by family name and in ascending numerical order by revision so that
- * the newest task definitions in a family are listed last. Setting this parameter to
- * DESC reverses the sort order on family name and revision. This is so
- * that the newest task definitions in a family are listed first.
The order to sort the results in. Valid values are ASC and DESC. By
+ * default, (ASC) task definitions are listed lexicographically by family name and in
+ * ascending numerical order by revision so that the newest task definitions in a family are listed last.
+ * Setting this parameter to DESC reverses the sort order on family name and revision. This
+ * is so that the newest task definitions in a family are listed first.
The nextToken value returned from a ListTaskDefinitions
- * request indicating that more results are available to fulfill the request and further
- * calls will be needed. If maxResults was provided, it is possible the number
- * of results to be fewer than maxResults.
The nextToken value returned from a ListTaskDefinitions request indicating
+ * that more results are available to fulfill the request and further calls will be needed. If
+ * maxResults was provided, it is possible the number of results to be fewer than
+ * maxResults.
This token should be treated as an opaque identifier that is only used to * retrieve the next items in a list and not for other programmatic purposes.
@@ -10930,13 +10545,12 @@ export interface ListTaskDefinitionsRequest { nextToken?: string | undefined; /** - *The maximum number of task definition results that ListTaskDefinitions
- * returned in paginated output. When this parameter is used,
- * ListTaskDefinitions only returns maxResults results in a
- * single page along with a nextToken response element. The remaining results
- * of the initial request can be seen by sending another ListTaskDefinitions
- * request with the returned nextToken value. This value can be between
- * 1 and 100. If this parameter isn't used, then
+ *
The maximum number of task definition results that ListTaskDefinitions returned in
+ * paginated output. When this parameter is used, ListTaskDefinitions only returns
+ * maxResults results in a single page along with a nextToken response
+ * element. The remaining results of the initial request can be seen by sending another
+ * ListTaskDefinitions request with the returned nextToken value. This value
+ * can be between 1 and 100. If this parameter isn't used, then
* ListTaskDefinitions returns up to 100 results and a
* nextToken value if applicable.
The nextToken value to include in a future
- * ListTaskDefinitions request. When the results of a
- * ListTaskDefinitions request exceed maxResults, this value
- * can be used to retrieve the next page of results. This value is null when
- * there are no more results to return.
The nextToken value to include in a future ListTaskDefinitions request.
+ * When the results of a ListTaskDefinitions request exceed maxResults, this
+ * value can be used to retrieve the next page of results. This value is null when there are
+ * no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the
- * ListTasks results. If you do not specify a cluster, the default cluster is assumed.
The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks
+ * results. If you do not specify a cluster, the default cluster is assumed.
The container instance ID or full ARN of the container instance to use when
- * filtering the ListTasks results. Specifying a
- * containerInstance limits the results to tasks that belong to that
- * container instance.
The container instance ID or full ARN of the container instance to use when filtering the
+ * ListTasks results. Specifying a containerInstance limits the results to
+ * tasks that belong to that container instance.
The name of the task definition family to use when filtering the
- * ListTasks results. Specifying a family limits the results
- * to tasks that belong to that family.
The name of the task definition family to use when filtering the ListTasks results.
+ * Specifying a family limits the results to tasks that belong to that family.
The nextToken value returned from a ListTasks request
- * indicating that more results are available to fulfill the request and further calls will
- * be needed. If maxResults was provided, it's possible the number of results
- * to be fewer than maxResults.
The nextToken value returned from a ListTasks request indicating that more
+ * results are available to fulfill the request and further calls will be needed. If
+ * maxResults was provided, it's possible the number of results to be fewer than
+ * maxResults.
This token should be treated as an opaque identifier that is only used to * retrieve the next items in a list and not for other programmatic purposes.
@@ -11023,48 +10634,43 @@ export interface ListTasksRequest { nextToken?: string | undefined; /** - *The maximum number of task results that ListTasks returned in paginated
- * output. When this parameter is used, ListTasks only returns
- * maxResults results in a single page along with a nextToken
- * response element. The remaining results of the initial request can be seen by sending
- * another ListTasks request with the returned nextToken value.
- * This value can be between 1 and 100. If this parameter
- * isn't used, then ListTasks returns up to 100 results and
- * a nextToken value if applicable.
The maximum number of task results that ListTasks returned in paginated output. When
+ * this parameter is used, ListTasks only returns maxResults results in a single
+ * page along with a nextToken response element. The remaining results of the initial request
+ * can be seen by sending another ListTasks request with the returned nextToken
+ * value. This value can be between 1 and 100. If this parameter isn't used,
+ * then ListTasks returns up to 100 results and a nextToken
+ * value if applicable.
The startedBy value to filter the task results with. Specifying a
- * startedBy value limits the results to tasks that were started with that
- * value.
When you specify startedBy as the filter, it must be the only filter that
- * you use.
The startedBy value to filter the task results with. Specifying a startedBy
+ * value limits the results to tasks that were started with that value.
When you specify startedBy as the filter, it must be the only filter that you
+ * use.
The name of the service to use when filtering the ListTasks results.
- * Specifying a serviceName limits the results to tasks that belong to that
- * service.
The name of the service to use when filtering the ListTasks results. Specifying a
+ * serviceName limits the results to tasks that belong to that service.
The task desired status to use when filtering the ListTasks results.
- * Specifying a desiredStatus of STOPPED limits the results to
- * tasks that Amazon ECS has set the desired status to STOPPED. This can be useful
- * for debugging tasks that aren't starting properly or have died or finished. The default
- * status filter is RUNNING, which shows tasks that Amazon ECS has set the desired
- * status to RUNNING.
The task desired status to use when filtering the ListTasks results. Specifying a
+ * desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set
+ * the desired status to STOPPED. This can be useful for debugging tasks that aren't starting
+ * properly or have died or finished. The default status filter is RUNNING, which shows tasks
+ * that Amazon ECS has set the desired status to RUNNING.
Although you can filter results based on a desired status of PENDING,
- * this doesn't return any results. Amazon ECS never sets the desired status of a task to
- * that value (only a task's lastStatus may have a value of
- * PENDING).
Although you can filter results based on a desired status of PENDING, this doesn't
+ * return any results. Amazon ECS never sets the desired status of a task to that value (only a task's
+ * lastStatus may have a value of PENDING).
The nextToken value to include in a future ListTasks
- * request. When the results of a ListTasks request exceed
- * maxResults, this value can be used to retrieve the next page of
- * results. This value is null when there are no more results to
+ *
The nextToken value to include in a future ListTasks request. When the
+ * results of a ListTasks request exceed maxResults, this value can be used to
+ * retrieve the next page of results. This value is null when there are no more results to
* return.
- * serviceLongArnFormat - When modified, the Amazon Resource Name
- * (ARN) and resource ID format of the resource type for a specified user, role, or
- * the root user for an account is affected. The opt-in and opt-out account setting
- * must be set for each Amazon ECS resource separately. The ARN and resource ID format
- * of a resource is defined by the opt-in status of the user or role that created
- * the resource. You must turn on this setting to use Amazon ECS features such as
- * resource tagging.
serviceLongArnFormat - When modified, the Amazon Resource Name (ARN) and
+ * resource ID format of the resource type for a specified user, role, or the root user for an
+ * account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource
+ * separately. The ARN and resource ID format of a resource is defined by the opt-in status of
+ * the user or role that created the resource. You must turn on this setting to use Amazon ECS features
+ * such as resource tagging.
*
- * taskLongArnFormat - When modified, the Amazon Resource Name (ARN)
- * and resource ID format of the resource type for a specified user, role, or the
- * root user for an account is affected. The opt-in and opt-out account setting must
- * be set for each Amazon ECS resource separately. The ARN and resource ID format of a
- * resource is defined by the opt-in status of the user or role that created the
- * resource. You must turn on this setting to use Amazon ECS features such as resource
- * tagging.
taskLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource
+ * ID format of the resource type for a specified user, role, or the root user for an account is
+ * affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource
+ * separately. The ARN and resource ID format of a resource is defined by the opt-in status of
+ * the user or role that created the resource. You must turn on this setting to use Amazon ECS features
+ * such as resource tagging.
*
- * containerInstanceLongArnFormat - When modified, the Amazon
- * Resource Name (ARN) and resource ID format of the resource type for a specified
- * user, role, or the root user for an account is affected. The opt-in and opt-out
- * account setting must be set for each Amazon ECS resource separately. The ARN and
- * resource ID format of a resource is defined by the opt-in status of the user or
- * role that created the resource. You must turn on this setting to use Amazon ECS
- * features such as resource tagging.
containerInstanceLongArnFormat - When modified, the Amazon Resource Name (ARN)
+ * and resource ID format of the resource type for a specified user, role, or the root user for an
+ * account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource
+ * separately. The ARN and resource ID format of a resource is defined by the opt-in status of
+ * the user or role that created the resource. You must turn on this setting to use Amazon ECS features
+ * such as resource tagging.
*
- * awsvpcTrunking - When modified, the elastic network interface
- * (ENI) limit for any new container instances that support the feature is changed.
- * If awsvpcTrunking is turned on, any new container instances that
- * support the feature are launched have the increased ENI limits available to
- * them. For more information, see Elastic
- * Network Interface Trunking in the Amazon Elastic Container Service Developer Guide.
awsvpcTrunking - When modified, the elastic network interface (ENI) limit for
+ * any new container instances that support the feature is changed. If awsvpcTrunking
+ * is turned on, any new container instances that support the feature are launched have the
+ * increased ENI limits available to them. For more information, see Elastic Network Interface
+ * Trunking in the Amazon Elastic Container Service Developer Guide.
*
- * containerInsights - When modified, the default setting indicating
- * whether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed.
- * If containerInsights is turned on, any new clusters that are
- * created will have Container Insights turned on unless you disable it during
- * cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.
containerInsights - When modified, the default setting indicating whether Amazon Web Services
+ * CloudWatch Container Insights is turned on for your clusters is changed. If
+ * containerInsights is turned on, any new clusters that are created will have
+ * Container Insights turned on unless you disable it during cluster creation. For more
+ * information, see CloudWatch Container
+ * Insights in the Amazon Elastic Container Service Developer Guide.
*
- * dualStackIPv6 - When turned on, when using a VPC in dual stack
- * mode, your tasks using the awsvpc network mode can have an IPv6
- * address assigned. For more information on using IPv6 with tasks launched on
- * Amazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6
- * with tasks launched on Fargate, see Using a VPC in dual-stack mode.
dualStackIPv6 - When turned on, when using a VPC in dual stack mode, your tasks
+ * using the awsvpc network mode can have an IPv6 address assigned. For more
+ * information on using IPv6 with tasks launched on Amazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6 with tasks
+ * launched on Fargate, see Using a VPC in dual-stack mode.
*
- * fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a
- * security or infrastructure update is needed for an Amazon ECS task hosted on
- * Fargate, the tasks need to be stopped and new tasks launched to replace them.
- * Use fargateTaskRetirementWaitPeriod to configure the wait time to
- * retire a Fargate task. For information about the Fargate tasks maintenance,
- * see Amazon Web Services Fargate
- * task maintenance in the Amazon ECS Developer
+ * fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a security or
+ * infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be
+ * stopped and new tasks launched to replace them. Use
+ * fargateTaskRetirementWaitPeriod to configure the wait time to retire a
+ * Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services
+ * Fargate task maintenance in the Amazon ECS Developer
* Guide.
- * tagResourceAuthorization - Amazon ECS is introducing tagging
- * authorization for resource creation. Users must have permissions for actions
- * that create the resource, such as ecsCreateCluster. If tags are
- * specified when you create a resource, Amazon Web Services performs additional authorization to
- * verify if users or roles have permissions to create tags. Therefore, you must
- * grant explicit permissions to use the ecs:TagResource action. For
- * more information, see Grant permission to tag resources on creation in the
- * Amazon ECS Developer Guide.
tagResourceAuthorization - Amazon ECS is introducing tagging authorization for
+ * resource creation. Users must have permissions for actions that create the resource, such as
+ * ecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services
+ * performs additional authorization to verify if users or roles have permissions to create tags.
+ * Therefore, you must grant explicit permissions to use the ecs:TagResource action.
+ * For more information, see Grant permission
+ * to tag resources on creation in the Amazon ECS Developer
+ * Guide.
* @@ -11195,26 +10795,25 @@ export interface PutAccountSettingRequest { name: SettingName | undefined; /** - *
The account setting value for the specified principal ARN. Accepted values are
- * enabled, disabled, on, and
- * off.
When you specify fargateTaskRetirementWaitPeriod for the
- * name, the following are the valid values:
The account setting value for the specified principal ARN. Accepted values are enabled,
+ * disabled, on, and off.
When you specify fargateTaskRetirementWaitPeriod for the name, the
+ * following are the valid values:
- * 0 - Amazon Web Services sends the notification, and immediately retires the
- * affected tasks.
0 - Amazon Web Services sends the notification, and immediately retires the affected
+ * tasks.
*
- * 7 - Amazon Web Services sends the notification, and waits 7 calendar days to
- * retire the tasks.
7 - Amazon Web Services sends the notification, and waits 7 calendar days to retire the
+ * tasks.
*
- * 14 - Amazon Web Services sends the notification, and waits 14 calendar days to
- * retire the tasks.
14 - Amazon Web Services sends the notification, and waits 14 calendar days to retire the
+ * tasks.
* The ARN of the principal, which can be a user, role, or the root user. If you specify - * the root user, it modifies the account setting for all users, roles, and the root user of the - * account unless a user or role explicitly overrides these settings. If this field is - * omitted, the setting is changed only for the authenticated user.
+ *The ARN of the principal, which can be a user, role, or the root user. If you specify the root user, it + * modifies the account setting for all users, roles, and the root user of the account unless a user or role + * explicitly overrides these settings. If this field is omitted, the setting is changed only for the + * authenticated user.
*You must use the root user when you set the Fargate wait time
* (fargateTaskRetirementWaitPeriod).
Federated users assume the account setting of the root user and can't have explicit - * account settings set for them.
+ *Federated users assume the account setting of the root user and can't have explicit account settings + * set for them.
*
- * serviceLongArnFormat - When modified, the Amazon Resource Name
- * (ARN) and resource ID format of the resource type for a specified user, role, or
- * the root user for an account is affected. The opt-in and opt-out account setting
- * must be set for each Amazon ECS resource separately. The ARN and resource ID format
- * of a resource is defined by the opt-in status of the user or role that created
- * the resource. You must turn on this setting to use Amazon ECS features such as
- * resource tagging.
serviceLongArnFormat - When modified, the Amazon Resource Name (ARN) and
+ * resource ID format of the resource type for a specified user, role, or the root user for an
+ * account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource
+ * separately. The ARN and resource ID format of a resource is defined by the opt-in status of
+ * the user or role that created the resource. You must turn on this setting to use Amazon ECS features
+ * such as resource tagging.
*
- * taskLongArnFormat - When modified, the Amazon Resource Name (ARN)
- * and resource ID format of the resource type for a specified user, role, or the
- * root user for an account is affected. The opt-in and opt-out account setting must
- * be set for each Amazon ECS resource separately. The ARN and resource ID format of a
- * resource is defined by the opt-in status of the user or role that created the
- * resource. You must turn on this setting to use Amazon ECS features such as resource
- * tagging.
taskLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource
+ * ID format of the resource type for a specified user, role, or the root user for an account is
+ * affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource
+ * separately. The ARN and resource ID format of a resource is defined by the opt-in status of
+ * the user or role that created the resource. You must turn on this setting to use Amazon ECS features
+ * such as resource tagging.
*
- * containerInstanceLongArnFormat - When modified, the Amazon
- * Resource Name (ARN) and resource ID format of the resource type for a specified
- * user, role, or the root user for an account is affected. The opt-in and opt-out
- * account setting must be set for each Amazon ECS resource separately. The ARN and
- * resource ID format of a resource is defined by the opt-in status of the user or
- * role that created the resource. You must turn on this setting to use Amazon ECS
- * features such as resource tagging.
containerInstanceLongArnFormat - When modified, the Amazon Resource Name (ARN)
+ * and resource ID format of the resource type for a specified user, role, or the root user for an
+ * account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource
+ * separately. The ARN and resource ID format of a resource is defined by the opt-in status of
+ * the user or role that created the resource. You must turn on this setting to use Amazon ECS features
+ * such as resource tagging.
*
- * awsvpcTrunking - When modified, the elastic network interface
- * (ENI) limit for any new container instances that support the feature is changed.
- * If awsvpcTrunking is turned on, any new container instances that
- * support the feature are launched have the increased ENI limits available to
- * them. For more information, see Elastic
- * Network Interface Trunking in the Amazon Elastic Container Service Developer Guide.
awsvpcTrunking - When modified, the elastic network interface (ENI) limit for
+ * any new container instances that support the feature is changed. If awsvpcTrunking
+ * is turned on, any new container instances that support the feature are launched have the
+ * increased ENI limits available to them. For more information, see Elastic Network Interface
+ * Trunking in the Amazon Elastic Container Service Developer Guide.
*
- * containerInsights - When modified, the default setting indicating
- * whether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed.
- * If containerInsights is turned on, any new clusters that are
- * created will have Container Insights turned on unless you disable it during
- * cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.
containerInsights - When modified, the default setting indicating whether Amazon Web Services
+ * CloudWatch Container Insights is turned on for your clusters is changed. If
+ * containerInsights is turned on, any new clusters that are created will have
+ * Container Insights turned on unless you disable it during cluster creation. For more
+ * information, see CloudWatch Container
+ * Insights in the Amazon Elastic Container Service Developer Guide.
*
- * dualStackIPv6 - When turned on, when using a VPC in dual stack
- * mode, your tasks using the awsvpc network mode can have an IPv6
- * address assigned. For more information on using IPv6 with tasks launched on
- * Amazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6
- * with tasks launched on Fargate, see Using a VPC in dual-stack mode.
dualStackIPv6 - When turned on, when using a VPC in dual stack mode, your tasks
+ * using the awsvpc network mode can have an IPv6 address assigned. For more
+ * information on using IPv6 with tasks launched on Amazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6 with tasks
+ * launched on Fargate, see Using a VPC in dual-stack mode.
*
- * fargateFIPSMode - If you specify fargateFIPSMode,
- * Fargate FIPS 140 compliance is affected.
fargateFIPSMode - If you specify fargateFIPSMode, Fargate FIPS
+ * 140 compliance is affected.
*
- * fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a
- * security or infrastructure update is needed for an Amazon ECS task hosted on
- * Fargate, the tasks need to be stopped and new tasks launched to replace them.
- * Use fargateTaskRetirementWaitPeriod to configure the wait time to
- * retire a Fargate task. For information about the Fargate tasks maintenance,
- * see Amazon Web Services Fargate
- * task maintenance in the Amazon ECS Developer
+ * fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a security or
+ * infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be
+ * stopped and new tasks launched to replace them. Use
+ * fargateTaskRetirementWaitPeriod to configure the wait time to retire a
+ * Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services
+ * Fargate task maintenance in the Amazon ECS Developer
* Guide.
- * tagResourceAuthorization - Amazon ECS is introducing tagging
- * authorization for resource creation. Users must have permissions for actions
- * that create the resource, such as ecsCreateCluster. If tags are
- * specified when you create a resource, Amazon Web Services performs additional authorization to
- * verify if users or roles have permissions to create tags. Therefore, you must
- * grant explicit permissions to use the ecs:TagResource action. For
- * more information, see Grant permission to tag resources on creation in the
- * Amazon ECS Developer Guide.
tagResourceAuthorization - Amazon ECS is introducing tagging authorization for
+ * resource creation. Users must have permissions for actions that create the resource, such as
+ * ecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services
+ * performs additional authorization to verify if users or roles have permissions to create tags.
+ * Therefore, you must grant explicit permissions to use the ecs:TagResource action.
+ * For more information, see Grant permission
+ * to tag resources on creation in the Amazon ECS Developer
+ * Guide.
* @@ -11350,26 +10944,25 @@ export interface PutAccountSettingDefaultRequest { name: SettingName | undefined; /** - *
The account setting value for the specified principal ARN. Accepted values are
- * enabled, disabled, on, and
- * off.
When you specify fargateTaskRetirementWaitPeriod for the
- * name, the following are the valid values:
The account setting value for the specified principal ARN. Accepted values are enabled,
+ * disabled, on, and off.
When you specify fargateTaskRetirementWaitPeriod for the name, the
+ * following are the valid values:
- * 0 - Amazon Web Services sends the notification, and immediately retires the
- * affected tasks.
0 - Amazon Web Services sends the notification, and immediately retires the affected
+ * tasks.
*
- * 7 - Amazon Web Services sends the notification, and waits 7 calendar days to
- * retire the tasks.
7 - Amazon Web Services sends the notification, and waits 7 calendar days to retire the
+ * tasks.
*
- * 14 - Amazon Web Services sends the notification, and waits 14 calendar days to
- * retire the tasks.
14 - Amazon Web Services sends the notification, and waits 14 calendar days to retire the
+ * tasks.
* You can apply up to 10 custom attributes for each resource. You can view the - * attributes of a resource with ListAttributes. You can remove existing - * attributes on a resource with DeleteAttributes.
+ *You can apply up to 10 custom attributes for each resource. You can view the attributes of a resource + * with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.
* @public */ export class AttributeLimitExceededException extends __BaseException { @@ -11415,15 +11007,15 @@ export class AttributeLimitExceededException extends __BaseException { */ export interface PutAttributesRequest { /** - *The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply - * attributes. If you do not specify a cluster, the default cluster is assumed.
+ *The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. + * If you do not specify a cluster, the default cluster is assumed.
* @public */ cluster?: string | undefined; /** - *The attributes to apply to your resource. You can specify up to 10 custom attributes - * for each resource. You can specify up to 10 attributes in a single call.
+ *The attributes to apply to your resource. You can specify up to 10 custom attributes for each + * resource. You can specify up to 10 attributes in a single call.
* @public */ attributes: Attribute[] | undefined; @@ -11445,41 +11037,38 @@ export interface PutAttributesResponse { */ export interface PutClusterCapacityProvidersRequest { /** - *The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider - * settings for. If you don't specify a cluster, the default cluster is assumed.
+ *The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you + * don't specify a cluster, the default cluster is assumed.
* @public */ cluster: string | undefined; /** *The name of one or more capacity providers to associate with the cluster.
- *If specifying a capacity provider that uses an Auto Scaling group, the capacity - * provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
+ *If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already + * be created. New capacity providers can be created with the CreateCapacityProvider + * API operation.
*To use a Fargate capacity provider, specify either the FARGATE or
- * FARGATE_SPOT capacity providers. The Fargate capacity providers are
- * available to all accounts and only need to be associated with a cluster to be
- * used.
FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all
+ * accounts and only need to be associated with a cluster to be used.
* @public
*/
capacityProviders: string[] | undefined;
/**
* The capacity provider strategy to use by default for the cluster.
- *When creating a service or running a task on a cluster, if no capacity provider or - * launch type is specified then the default capacity provider strategy for the cluster is - * used.
+ *When creating a service or running a task on a cluster, if no capacity provider or launch type is + * specified then the default capacity provider strategy for the cluster is used.
*A capacity provider strategy consists of one or more capacity providers along with the
- * base and weight to assign to them. A capacity provider
- * must be associated with the cluster to be used in a capacity provider strategy. The
- * PutClusterCapacityProviders API is used to associate a capacity
- * provider with a cluster. Only capacity providers with an ACTIVE or
- * UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity - * provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
+ *base and weight to assign to them. A capacity provider must be associated
+ * with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.
+ * Only capacity providers with an ACTIVE or UPDATING status can be used.
+ * If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already + * be created. New capacity providers can be created with the CreateCapacityProvider + * API operation.
*To use a Fargate capacity provider, specify either the FARGATE or
- * FARGATE_SPOT capacity providers. The Fargate capacity providers are
- * available to all accounts and only need to be associated with a cluster to be
- * used.
FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all
+ * accounts and only need to be associated with a cluster to be used.
* @public
*/
defaultCapacityProviderStrategy: CapacityProviderStrategyItem[] | undefined;
@@ -11530,22 +11119,21 @@ export const PlatformDeviceType = {
export type PlatformDeviceType = (typeof PlatformDeviceType)[keyof typeof PlatformDeviceType];
/**
- * The devices that are available on the container instance. The only supported device - * type is a GPU.
+ *The devices that are available on the container instance. The only supported device type is a + * GPU.
* @public */ export interface PlatformDevice { /** - *The ID for the GPUs on the container instance. The available GPU IDs can also be
- * obtained on the container instance in the
- * /var/lib/ecs/gpu/nvidia_gpu_info.json file.
The ID for the GPUs on the container instance. The available GPU IDs can also be obtained on the
+ * container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.
The type of device that's available on the container instance. The only supported
- * value is GPU.
The type of device that's available on the container instance. The only supported value is
+ * GPU.
The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance - * with. If you do not specify a cluster, the default cluster is assumed.
+ *The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with. + * If you do not specify a cluster, the default cluster is assumed.
* @public */ cluster?: string | undefined; /** - *The instance identity document for the EC2 instance to register. This document can be
- * found by running the following command from the instance: The instance identity document for the EC2 instance to register. This document can be found by
+ * running the following command from the instance: The instance identity document signature for the EC2 instance to register. This
- * signature can be found by running the following command from the instance: The instance identity document signature for the EC2 instance to register. This signature can be
+ * found by running the following command from the instance: The version information for the Amazon ECS container agent and Docker daemon that runs on
- * the container instance. The version information for the Amazon ECS container agent and Docker daemon that runs on the container
+ * instance. The devices that are available on the container instance. The only supported device
- * type is a GPU. The devices that are available on the container instance. The only supported device type is a
+ * GPU. The metadata that you apply to the container instance to help you categorize and
- * organize them. Each tag consists of a key and an optional value. You define both. The metadata that you apply to the container instance to help you categorize and organize them. Each
+ * tag consists of a key and an optional value. You define both. The following basic restrictions apply to tags: You must specify a You must specify a The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can
- * assume. All containers in this task are granted the permissions that are specified in
- * this role. For more information, see IAM Roles for
- * Tasks in the Amazon Elastic Container Service Developer Guide. The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All
+ * containers in this task are granted the permissions that are specified in this role. For more
+ * information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide. If the network mode is If the network mode is For more information, see Network
- * settings in the Docker run reference. A list of container definitions in JSON format that describe the different containers
- * that make up your task. A list of container definitions in JSON format that describe the different containers that make up
+ * your task. A list of volume definitions in JSON format that containers in your task might
- * use. A list of volume definitions in JSON format that containers in your task might use. An array of placement constraint objects to use for the task. You can specify a
- * maximum of 10 constraints for each task. This limit includes constraints in the task
- * definition and those specified at runtime. An array of placement constraint objects to use for the task. You can specify a maximum of 10
+ * constraints for each task. This limit includes constraints in the task definition and those specified
+ * at runtime. The task launch type that Amazon ECS validates the task definition against. A client
- * exception is returned if the task definition doesn't validate against the
- * compatibilities specified. If no value is specified, the parameter is omitted from the
- * response. The task launch type that Amazon ECS validates the task definition against. A client exception is returned
+ * if the task definition doesn't validate against the compatibilities specified. If no value is
+ * specified, the parameter is omitted from the response. The number of CPU units used by the task. It can be expressed as an integer using CPU
- * units (for example, The number of CPU units used by the task. It can be expressed as an integer using CPU units (for
+ * example, Task-level CPU and memory parameters are ignored for Windows containers. We
- * recommend specifying container-level resources for Windows containers. Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying
+ * container-level resources for Windows containers. If you're using the EC2 launch type, this field is optional. Supported
- * values are between If you're using the Fargate launch type, this field is required and you
- * must use one of the following values, which determines your range of supported values
- * for the If you're using the EC2 launch type, this field is optional. Supported values are
+ * between If you're using the Fargate launch type, this field is required and you must use one of
+ * the following values, which determines your range of supported values for the The CPU units cannot be less than 1 vCPU when you use Windows containers on
* Fargate. The amount of memory (in MiB) used by the task. It can be expressed as an integer
- * using MiB (for example , The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB (for
+ * example , Task-level CPU and memory parameters are ignored for Windows containers. We
- * recommend specifying container-level resources for Windows containers. Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying
+ * container-level resources for Windows containers. If using the EC2 launch type, this field is optional. If using the Fargate launch type, this field is required and you must
- * use one of the following values. This determines your range of supported values for the
- * If using the Fargate launch type, this field is required and you must use one of the
+ * following values. This determines your range of supported values for the The CPU units cannot be less than 1 vCPU when you use Windows containers on
* Fargate. The metadata that you apply to the task definition to help you categorize and organize
- * them. Each tag consists of a key and an optional value. You define both of them. The metadata that you apply to the task definition to help you categorize and organize them. Each tag
+ * consists of a key and an optional value. You define both of them. The following basic restrictions apply to tags: If If no value is specified, the
- * default is a private namespace for each container. For more information,
- * see PID settings in the Docker run
- * reference.curl
+ * curl
* http://169.254.169.254/latest/dynamic/instance-identity/document/
* curl
+ * curl
* http://169.254.169.254/latest/dynamic/instance-identity/signature/
*
*
family for a task definition. You can use it track
- * multiple versions of the same task definition. The family is used as a name
- * for your task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.family for a task definition. You can use it track multiple versions
+ * of the same task definition. The family is used as a name for your task definition.
+ * Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.awsvpc, the task is allocated an elastic network
- * interface, and you must specify a NetworkConfiguration value when you create
+ * interface, and you must specify a NetworkConfiguration value when you create
* a service or run a task with the task definition. For more information, see Task Networking in the
* Amazon Elastic Container Service Developer Guide.host, you cannot run multiple instantiations of the
* same task on a single container instance when port mappings are used.1024) or as a string using vCPUs (for example, 1
- * vCPU or 1 vcpu) in a task definition. String values are
- * converted to an integer indicating the CPU units when the task definition is
- * registered.1024) or as a string using vCPUs (for example, 1 vCPU or 1
+ * vcpu) in a task definition. String values are converted to an integer indicating the CPU
+ * units when the task definition is registered.128 CPU units (0.125 vCPUs) and
- * 10240 CPU units (10 vCPUs). If you do not specify a value,
- * the parameter is ignored.memory parameter:128 CPU units (0.125 vCPUs) and 10240 CPU units
+ * (10 vCPUs). If you do not specify a value, the parameter is ignored.memory
+ * parameter:
@@ -11805,19 +11386,18 @@ export interface RegisterTaskDefinitionRequest {
cpu?: string | undefined;
/**
- *
1024) or as a string using GB (for example,
- * 1GB or 1 GB) in a task definition. String values are
- * converted to an integer indicating the MiB when the task definition is
- * registered.1024) or as a string using GB (for example, 1GB or 1
+ * GB) in a task definition. String values are converted to an integer indicating the MiB when the
+ * task definition is registered.cpu parameter.cpu
+ * parameter.
@@ -11852,8 +11432,8 @@ export interface RegisterTaskDefinitionRequest {
memory?: string | undefined;
/**
- *
*
task is specified, all containers within the specified
* task share the same process namespace.
If the host PID mode is used, there's a heightened risk
- * of undesired process namespace exposure. For more information, see
- * Docker security.
This parameter is not supported for Windows containers.
*none is specified, then IPC resources
* within the containers of a task are private and not shared with other containers in a
* task or on the container instance. If no value is specified, then the IPC resource
- * namespace sharing depends on the Docker daemon setting on the container instance. For
- * more information, see IPC
- * settings in the Docker run reference.
+ * namespace sharing depends on the Docker daemon setting on the container instance.
* If the host IPC mode is used, be aware that there is a heightened risk of
- * undesired IPC namespace expose. For more information, see Docker
- * security.
If you are setting namespaced kernel parameters using The configuration details for the App Mesh proxy. For tasks hosted on Amazon EC2 instances, the container instances require at least version
- * systemControls for
* the containers in the task, the following will apply to your IPC resource namespace. For
* more information, see System
@@ -11961,11 +11535,11 @@ export interface RegisterTaskDefinitionRequest {
/**
* 1.26.0 of the container agent and at least version
- * 1.26.0-1 of the ecs-init package to use a proxy
- * configuration. If your container instances are launched from the Amazon ECS-optimized
- * AMI version 20190301 or later, then they contain the required versions of
- * the container agent and ecs-init. For more information, see Amazon ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.1.26.0 of the container agent and at least version 1.26.0-1 of the
+ * ecs-init package to use a proxy configuration. If your container instances are
+ * launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain
+ * the required versions of the container agent and ecs-init. For more information, see
+ * Amazon ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.
The amount of ephemeral storage to allocate for the task. This parameter is used to - * expand the total amount of ephemeral storage available, beyond the default amount, for - * tasks hosted on Fargate. For more information, see Using data volumes in - * tasks in the Amazon ECS Developer Guide.
+ *The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total + * amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For + * more information, see Using data volumes in tasks + * in the Amazon ECS Developer Guide.
*For tasks using the Fargate launch type, the task requires the - * following platforms:
+ *For tasks using the Fargate launch type, the task requires the following + * platforms:
*Linux platform version 1.4.0 or later.
The operating system that your tasks definitions run on. A platform family is - * specified only for tasks using the Fargate launch type.
+ *The operating system that your tasks definitions run on. A platform family is specified only for + * tasks using the Fargate launch type.
* @public */ runtimePlatform?: RuntimePlatform | undefined; @@ -12045,17 +11619,17 @@ export class BlockedException extends __BaseException { /** *The RunTask request could not be processed due to conflicts. The provided
- * clientToken is already in use with a different RunTask
- * request. The resourceIds are the existing task ARNs which are already
- * associated with the clientToken.
clientToken is already in use with a different RunTask request. The
+ * resourceIds are the existing task ARNs which are already associated with the
+ * clientToken.
* To fix this issue:
*Run RunTask with a unique clientToken.
Run RunTask with the clientToken and the original
- * set of parameters
Run RunTask with the clientToken and the original set of
+ * parameters
The existing task ARNs which are already associated with the
- * clientToken.
The existing task ARNs which are already associated with the clientToken.
The termination policy for the Amazon EBS volume when the task exits. For more information, - * see Amazon ECS volume termination policy.
+ *The termination policy for the Amazon EBS volume when the task exits. For more information, see Amazon ECS + * volume termination policy.
* @public */ export interface TaskManagedEBSVolumeTerminationPolicy { /** *Indicates whether the volume should be deleted on when the task stops. If a value of
- * true is specified,
Amazon ECS deletes the Amazon EBS volume on your behalf when
- * the task goes into the STOPPED state. If no value is specified, the
- *
default value is true is used. When set to false, Amazon ECS
- * leaves the volume in your
account.
true is specified,
Amazon ECS deletes the Amazon EBS volume on your behalf when the task goes
+ * into the STOPPED state. If no value is specified, the
default value is true
+ * is used. When set to false, Amazon ECS leaves the volume in your
account.
* @public
*/
deleteOnTermination: boolean | undefined;
}
/**
- * The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. - * These settings are used to create each Amazon EBS volume, with one volume created for each - * task.
+ *The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings + * are used to create each Amazon EBS volume, with one volume created for each task.
* @public */ export interface TaskManagedEBSVolumeConfiguration { /** - *Indicates whether the volume should be encrypted. If no value is specified, encryption
- * is turned on by default. This parameter maps 1:1 with the Encrypted
- * parameter of the CreateVolume API in
- * the Amazon EC2 API Reference.
Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on
+ * by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume
+ * API in the Amazon EC2 API Reference.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When
- * encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key
- * for Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId
- * parameter of the CreateVolume API in
- * the Amazon EC2 API Reference.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned
+ * on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This
+ * parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the
+ * Amazon EC2 API Reference.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an - * ID, alias, or ARN that is invalid, the action can appear to complete, but - * eventually fails.
+ *Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or + * ARN that is invalid, the action can appear to complete, but eventually fails.
*The volume type. This parameter maps 1:1 with the VolumeType parameter of
- * the CreateVolume API in the Amazon EC2 API Reference. For more
- * information, see Amazon EBS volume types in
- * the Amazon EC2 User Guide.
The volume type. This parameter maps 1:1 with the VolumeType parameter of the CreateVolume
+ * API in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types
+ * in the Amazon EC2 User Guide.
The following are the supported volume types.
*The size of the volume in GiB. You must specify either a volume size or a snapshot ID.
- * If you specify a snapshot ID, the snapshot size is used for the volume size by default.
- * You can optionally specify a volume size greater than or equal to the snapshot size.
- * This parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.
The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify
+ * a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a
+ * volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the
+ * Size parameter of the CreateVolume API in the
+ * Amazon EC2 API Reference.
The following are the supported volume size values for each volume type.
*The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot
- * ID or a volume size. This parameter maps 1:1 with the SnapshotId parameter
- * of the CreateVolume API in
- * the Amazon EC2 API Reference.
The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume
+ * size. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume
+ * API in the Amazon EC2 API Reference.
The number of I/O operations per second (IOPS). For gp3,
- * io1, and io2 volumes, this represents the number of IOPS that
- * are provisioned for the volume. For gp2 volumes, this represents the
- * baseline performance of the volume and the rate at which the volume accumulates I/O
- * credits for bursting.
The number of I/O operations per second (IOPS). For gp3, io1, and
+ * io2 volumes, this represents the number of IOPS that are provisioned for the volume.
+ * For gp2 volumes, this represents the baseline performance of the volume and the rate at
+ * which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type.
*io2: 100 - 256,000 IOPS
* This parameter is required for io1 and io2 volume types. The
- * default for gp3 volumes is 3,000 IOPS. This parameter is not
- * supported for st1, sc1, or standard volume
- * types.
This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.
This parameter is required for io1 and io2 volume types. The default for
+ * gp3 volumes is 3,000 IOPS. This parameter is not supported for
+ * st1, sc1, or standard volume types.
This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the
+ * Amazon EC2 API Reference.
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.
- * This parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter
+ * maps 1:1 with the Throughput parameter of the CreateVolume API in the
+ * Amazon EC2 API Reference.
This parameter is only supported for the gp3 volume type.
The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This
- * parameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.
The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps
+ * 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the
+ * Amazon EC2 API Reference.
The ARN of the IAM role to associate with this volume. This is the Amazon ECS
- * infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend
- * using the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM
- * policy with this role. For more information, see Amazon ECS
- * infrastructure IAM role in the Amazon ECS Developer
- * Guide.
The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role
+ * that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed
+ * AmazonECSInfrastructureRolePolicyForVolumes IAM policy with this role. For more
+ * information, see Amazon ECS infrastructure IAM
+ * role in the Amazon ECS Developer Guide.
The termination policy for the volume when the task exits. This provides a way to - * control whether Amazon ECS terminates the Amazon EBS volume when the task stops.
+ *The termination policy for the volume when the task exits. This provides a way to control whether + * Amazon ECS terminates the Amazon EBS volume when the task stops.
* @public */ terminationPolicy?: TaskManagedEBSVolumeTerminationPolicy | undefined; /** - *The Linux filesystem type for the volume. For volumes created from a snapshot, you - * must specify the same filesystem type that the volume was using when the snapshot was - * created. If there is a filesystem type mismatch, the task will fail to start.
- *The available filesystem types are
ext3, ext4, and
- * xfs. If no value is specified, the xfs filesystem type is
- * used by default.
The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the + * same filesystem type that the volume was using when the snapshot was created. If there is a filesystem + * type mismatch, the task will fail to start.
+ *The available filesystem types are
ext3, ext4, and xfs. If no
+ * value is specified, the xfs filesystem type is used by default.
Configuration settings for the task volume that was configuredAtLaunch
- * that weren't set during RegisterTaskDef.
Configuration settings for the task volume that was configuredAtLaunch that weren't set
+ * during RegisterTaskDef.
The name of the volume. This value must match the volume name from the
- * Volume object in the task definition.
The name of the volume. This value must match the volume name from the Volume object in
+ * the task definition.
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. - * These settings are used to create each Amazon EBS volume, with one volume created for each - * task. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are - * created.
+ *The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings + * are used to create each Amazon EBS volume, with one volume created for each task. The Amazon EBS volumes are + * visible in your account in the Amazon EC2 console once they are created.
* @public */ managedEBSVolume?: TaskManagedEBSVolumeConfiguration | undefined; @@ -12310,133 +11875,125 @@ export interface TaskVolumeConfiguration { export interface RunTaskRequest { /** *The capacity provider strategy to use for the task.
- *If a capacityProviderStrategy is specified, the launchType
- * parameter must be omitted. If no capacityProviderStrategy or
- * launchType is specified, the
+ *
If a capacityProviderStrategy is specified, the launchType parameter must
+ * be omitted. If no capacityProviderStrategy or launchType is specified, the
* defaultCapacityProviderStrategy for the cluster is used.
When you use cluster auto scaling, you must specify
- * capacityProviderStrategy and not launchType.
When you use cluster auto scaling, you must specify capacityProviderStrategy and not
+ * launchType.
A capacity provider strategy may contain a maximum of 6 capacity providers.
* @public */ capacityProviderStrategy?: CapacityProviderStrategyItem[] | undefined; /** - *The short name or full Amazon Resource Name (ARN) of the cluster to run your task on. - * If you do not specify a cluster, the default cluster is assumed.
+ *The short name or full Amazon Resource Name (ARN) of the cluster to run your task on. If you do not specify a cluster, the default cluster is assumed.
* @public */ cluster?: string | undefined; /** - *The number of instantiations of the specified task to place on your cluster. You can - * specify up to 10 tasks for each call.
+ *The number of instantiations of the specified task to place on your cluster. You can specify up to 10 + * tasks for each call.
* @public */ count?: number | undefined; /** - *Specifies whether to use Amazon ECS managed tags for the task. For more information, see
- * Tagging Your Amazon ECS
+ * Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS
* Resources in the Amazon Elastic Container Service Developer Guide. Determines whether to use the execute command functionality for the containers in this
- * task. If If Determines whether to use the execute command functionality for the containers in this task. If
+ * If The name of the task group to associate with the task. The default value is the family
- * name of the task definition (for example, The name of the task group to associate with the task. The default value is the family name of the
+ * task definition (for example, The infrastructure to run your standalone task on. For more information, see Amazon ECS
- * launch types in the Amazon Elastic Container Service Developer Guide. The The infrastructure to run your standalone task on. For more information, see Amazon ECS launch
+ * types in the Amazon Elastic Container Service Developer Guide. The Fargate Spot infrastructure is available for use but a capacity provider
- * strategy must be used. For more information, see Fargate capacity providers in the
- * Amazon ECS Developer Guide. Fargate Spot infrastructure is available for use but a capacity provider strategy must be used.
+ * For more information, see Fargate capacity providers in the Amazon ECS Developer
+ * Guide. The The A task can use either a launch type or a capacity provider strategy. If a
- * When you use cluster auto scaling, you must specify
- * The A task can use either a launch type or a capacity provider strategy. If a When you use cluster auto scaling, you must specify The network configuration for the task. This parameter is required for task
- * definitions that use the The network configuration for the task. This parameter is required for task definitions that use the
+ * A list of container overrides in JSON format that specify the name of a container in
- * the specified task definition and the overrides it should receive. You can override the
- * default command for a container (that's specified in the task definition or Docker
- * image) with a A total of 8192 characters are allowed for overrides. This limit includes the JSON
- * formatting characters of the override structure. A list of container overrides in JSON format that specify the name of a container in the specified
+ * task definition and the overrides it should receive. You can override the default command for a
+ * container (that's specified in the task definition or Docker image) with a A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting
+ * characters of the override structure. An array of placement constraint objects to use for the task. You can specify up to 10
- * constraints for each task (including constraints in the task definition and those
- * specified at runtime). An array of placement constraint objects to use for the task. You can specify up to 10 constraints
+ * for each task (including constraints in the task definition and those specified at runtime). The placement strategy objects to use for the task. You can specify a maximum of 5
- * strategy rules for each task. The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for
+ * each task. The platform version the task uses. A platform version is only specified for tasks
- * hosted on Fargate. If one isn't specified, the The platform version the task uses. A platform version is only specified for tasks hosted on
+ * Fargate. If one isn't specified, the Specifies whether to propagate the tags from the task definition to the task. If no
- * value is specified, the tags aren't propagated. Tags can only be propagated to the task
- * during task creation. To add tags to a task after task creation, use theTagResource API action. Specifies whether to propagate the tags from the task definition to the task. If no value is
+ * specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To
+ * add tags to a task after task creation, use theTagResource API action. An error will be received if you specify the An error will be received if you specify the An optional tag specified when a task is started. For example, if you automatically
- * trigger a task to run a batch process job, you could apply a unique identifier for that
- * job to your task with the If a task is started by an Amazon ECS service, then the An optional tag specified when a task is started. For example, if you automatically trigger a task to
+ * run a batch process job, you could apply a unique identifier for that job to your task with the
+ * If a task is started by an Amazon ECS service, then the The metadata that you apply to the task to help you categorize and organize them. Each
- * tag consists of a key and an optional value, both of which you define. The metadata that you apply to the task to help you categorize and organize them. Each tag consists
+ * of a key and an optional value, both of which you define. The following basic restrictions apply to tags: The The full ARN value must match the value that you specified as the
- * When you specify a task definition, you must either specify a specific revision, or
- * all revisions in the ARN. To specify a specific revision, include the revision number in the ARN. For example,
- * to specify revision 2, use
- * To specify all revisions, use the wildcard (*) in the ARN. For example, to specify
- * all revisions, use
- * The The full ARN value must match the value that you specified as the When you specify a task definition, you must either specify a specific revision, or all revisions in
+ * the ARN. To specify a specific revision, include the revision number in the ARN. For example, to specify
+ * revision 2, use
+ * To specify all revisions, use the wildcard (*) in the ARN. For example, to specify all revisions,
+ * use For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service Developer Guide. An identifier that you provide to ensure the idempotency of the request. It must be
- * unique and is case sensitive. Up to 64 characters are allowed. The valid characters are
- * characters in the range of 33-126, inclusive. For more information, see Ensuring idempotency. An identifier that you provide to ensure the idempotency of the request. It must be unique and is
+ * case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of
+ * 33-126, inclusive. For more information, see Ensuring
+ * idempotency. The details of the volume that was The details of the volume that was A full description of the tasks that were run. The tasks that were successfully placed
- * on your cluster are described here. A full description of the tasks that were run. The tasks that were successfully placed on your
+ * cluster are described here. Any failures associated with the call. For information about how to address failures, see Service event messages and API failure
- * reasons in the Amazon Elastic Container Service Developer Guide. For information about how to address failures, see Service event messages and API failure reasons in the
+ * Amazon Elastic Container Service Developer Guide. The container instance IDs or full ARN entries for the container instances where you
- * would like to place your task. You can specify up to 10 container instances. The container instance IDs or full ARN entries for the container instances where you would like to
+ * place your task. You can specify up to 10 container instances. Specifies whether to use Amazon ECS managed tags for the task. For more information, see
- * Tagging Your Amazon ECS
+ * Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS
* Resources in the Amazon Elastic Container Service Developer Guide. Whether or not the execute command functionality is turned on for the task. If
- * Whether or not the execute command functionality is turned on for the task. If The name of the task group to associate with the task. The default value is the family
- * name of the task definition (for example, family:my-family-name). The name of the task group to associate with the task. The default value is the family name of the
+ * task definition (for example, family:my-family-name). A list of container overrides in JSON format that specify the name of a container in
- * the specified task definition and the overrides it receives. You can override the
- * default command for a container (that's specified in the task definition or Docker
- * image) with a A list of container overrides in JSON format that specify the name of a container in the specified
+ * task definition and the overrides it receives. You can override the default command for a container
+ * (that's specified in the task definition or Docker image) with a A total of 8192 characters are allowed for overrides. This limit includes the JSON
- * formatting characters of the override structure. A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting
+ * characters of the override structure. Specifies whether to propagate the tags from the task definition or the service to the
- * task. If no value is specified, the tags aren't propagated. Specifies whether to propagate the tags from the task definition or the service to the task. If no
+ * value is specified, the tags aren't propagated. The metadata that you apply to the task to help you categorize and organize them. Each
- * tag consists of a key and an optional value, both of which you define. The metadata that you apply to the task to help you categorize and organize them. Each tag consists
+ * of a key and an optional value, both of which you define. The following basic restrictions apply to tags: The The The details of the volume that was The details of the volume that was A full description of the tasks that were started. Each task that was successfully
- * placed on your container instances is described. A full description of the tasks that were started. Each task that was successfully placed on your
+ * container instances is described. An optional message specified when a task is stopped. For example, if you're using a
- * custom scheduler, you can use this parameter to specify the reason for stopping the task
- * here, and the message appears in subsequent DescribeTasks> API
- * operations on this task. An optional message specified when a task is stopped. For example, if you're using a custom
+ * scheduler, you can use this parameter to specify the reason for stopping the task here, and the message
+ * appears in subsequent DescribeTasks> API operations on
+ * this task. The short name or full ARN of the cluster that hosts the container instance the
- * attachment belongs to. The short name or full ARN of the cluster that hosts the container instance the attachment belongs
+ * to. The exit code for the container, if the state change is a result of the container
- * exiting. The exit code for the container, if the state change is a result of the container exiting. The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are
- * Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container
- * instances. The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are Amazon ECS capacity
+ * providers, tasks, services, task definitions, clusters, and container instances. The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, the supported resources
- * are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container
- * instances. The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, the supported resources are Amazon ECS
+ * capacity providers, tasks, services, task definitions, clusters, and container instances. The managed termination protection setting to use for the Auto Scaling group capacity
- * provider. This determines whether the Auto Scaling group has managed termination
- * protection. The managed termination protection setting to use for the Auto Scaling group capacity provider. This
+ * determines whether the Auto Scaling group has managed termination protection. When using managed termination protection, managed scaling must also be used
- * otherwise managed termination protection doesn't work. When using managed termination protection, managed scaling must also be used otherwise managed
+ * termination protection doesn't work. When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an
- * Auto Scaling group that contain tasks from being terminated during a scale-in action.
- * The Auto Scaling group and each instance in the Auto Scaling group must have instance
- * protection from scale-in actions on. For more information, see Instance Protection in the Auto Scaling User Guide. When managed termination protection is off, your Amazon EC2 instances aren't protected from
- * termination when the Auto Scaling group scales in. When managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling
+ * group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and
+ * each instance in the Auto Scaling group must have instance protection from scale-in actions on. For
+ * more information, see Instance
+ * Protection in the Auto Scaling User Guide. When managed termination protection is off, your Amazon EC2 instances aren't protected from termination
+ * when the Auto Scaling group scales in. Details about the capacity provider. Details about the capacity provider. The setting to use by default for a cluster. This parameter is used to turn on CloudWatch
- * Container Insights for a cluster. If this value is specified, it overrides the
- * The setting to use by default for a cluster. This parameter is used to turn on CloudWatch Container
+ * Insights for a cluster. If this value is specified, it overrides the Currently, if you delete an existing cluster that does not have Container Insights
- * turned on, and then create a new cluster with the same name with Container Insights
- * tuned on, Container Insights will not actually be turned on. If you want to preserve
- * the same name for your existing cluster and turn on Container Insights, you must
- * wait 7 days before you can re-create it. Currently, if you delete an existing cluster that does not have Container Insights turned on, and
+ * then create a new cluster with the same name with Container Insights tuned on, Container Insights
+ * will not actually be turned on. If you want to preserve the same name for your existing cluster and
+ * turn on Container Insights, you must wait 7 days before you can re-create it. Amazon ECS can't determine the current version of the Amazon ECS container agent on the
- * container instance and doesn't have enough information to proceed with an update. This
- * could be because the agent running on the container instance is a previous or custom
- * version that doesn't use our version information. Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and
+ * doesn't have enough information to proceed with an update. This could be because the agent running on
+ * the container instance is a previous or custom version that doesn't use our version information. There's no update available for this Amazon ECS container agent. This might be because the
- * agent is already running the latest version or because it's so old that there's no
- * update path to the current version. There's no update available for this Amazon ECS container agent. This might be because the agent is
+ * already running the latest version or because it's so old that there's no update path to the current
+ * version. The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is
- * running on. If you do not specify a cluster, the default cluster is assumed. The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on.
+ * If you do not specify a cluster, the default cluster is assumed. The container instance ID or full ARN entries for the container instance where you
- * would like to update the Amazon ECS container agent. The container instance ID or full ARN entries for the container instance where you would like to
+ * update the Amazon ECS container agent. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to
- * update. If you do not specify a cluster, the default cluster is assumed. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update.
+ * If you do not specify a cluster, the default cluster is assumed. The container instance state to update the container instance with. The only valid
- * values for this action are The container instance state to update the container instance with. The only valid values for this
+ * action are The number of instantiations of the task to place and keep running in your
- * service. The number of instantiations of the task to place and keep running in your service. The The The capacity provider strategy to update the service to use. if the service uses the default capacity provider strategy for the cluster, the
- * service can be updated to use one or more capacity providers as opposed to the default
- * capacity provider strategy. However, when a service is using a capacity provider
- * strategy that's not the default capacity provider strategy, the service can't be updated
- * to use the cluster's default capacity provider strategy. if the service uses the default capacity provider strategy for the cluster, the service can be
+ * updated to use one or more capacity providers as opposed to the default capacity provider strategy.
+ * However, when a service is using a capacity provider strategy that's not the default capacity provider
+ * strategy, the service can't be updated to use the cluster's default capacity provider strategy. A capacity provider strategy consists of one or more capacity providers along with the
- * If specifying a capacity provider that uses an Auto Scaling group, the capacity
- * provider must already be created. New capacity providers can be created with the CreateClusterCapacityProvider API operation. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already
+ * be created. New capacity providers can be created with the CreateClusterCapacityProvider API operation. To use a Fargate capacity provider, specify either the The PutClusterCapacityProvidersAPI operation is used to update the
- * list of available capacity providers for a cluster after the cluster is created.true, this enables execute command functionality on all containers
- * in the task.true, then the task definition must have a task role, or you must
- * provide one as an override.true, this enables execute command functionality on all containers in the task.true, then the task definition must have a task role, or you must provide one as an
+ * override.family:my-family-name).family:my-family-name).FARGATE launch type runs your tasks on Fargate On-Demand
- * infrastructure.FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.EC2 launch type runs your tasks on Amazon EC2 instances registered to your
* cluster.EXTERNAL launch type runs your tasks on your on-premises server or
- * virtual machine (VM) capacity registered to your cluster.launchType is specified, the capacityProviderStrategy
- * parameter must be omitted.capacityProviderStrategy and not launchType. EXTERNAL launch type runs your tasks on your on-premises server or virtual machine
+ * (VM) capacity registered to your cluster.launchType is
+ * specified, the capacityProviderStrategy parameter must be omitted.capacityProviderStrategy and not
+ * launchType. awsvpc network mode to receive their own elastic
- * network interface, and it isn't supported for other network modes. For more information,
- * see Task networking
- * in the Amazon Elastic Container Service Developer Guide.awsvpc network mode to receive their own elastic network interface, and it isn't
+ * supported for other network modes. For more information, see Task networking in the
+ * Amazon Elastic Container Service Developer Guide.command override. You can also override existing environment
- * variables (that are specified in the task definition or Docker image) on a container or
- * add new environment variables to it with an environment override.command
+ * override. You can also override existing environment variables (that are specified in the task
+ * definition or Docker image) on a container or add new environment variables to it with an
+ * environment override.LATEST
- * platform version is used. For more information, see Fargate platform
- * versions in the Amazon Elastic Container Service Developer Guide.LATEST platform version is used. For
+ * more information, see Fargate platform versions in
+ * the Amazon Elastic Container Service Developer Guide.SERVICE option when
- * running a task.SERVICE option when running a
+ * task.startedBy parameter. You can then identify which
- * tasks belong to that job by filtering the results of a ListTasks call with
- * the startedBy value. Up to 128 letters (uppercase and lowercase), numbers,
- * hyphens (-), forward slash (/), and underscores (_) are allowed.startedBy parameter
- * contains the deployment ID of the service that starts it.startedBy parameter. You can then identify which tasks belong to that job by filtering
+ * the results of a ListTasks call with the startedBy value. Up to 128 letters (uppercase and
+ * lowercase), numbers, hyphens (-), forward slash (/), and underscores (_) are allowed.startedBy parameter contains the
+ * deployment ID of the service that starts it.
*
family and revision (family:revision) or
- * full ARN of the task definition to run. If a revision isn't specified,
- * the latest ACTIVE revision is used.Resource of the principal's permissions policy.arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2.arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*.family and revision (family:revision) or full ARN of the
+ * task definition to run. If a revision isn't specified, the latest ACTIVE
+ * revision is used.Resource of the
+ * principal's permissions policy.arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2.arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*.configuredAtLaunch. You can configure
- * the size, volumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration. The name of the volume must
- * match the name from the task definition.configuredAtLaunch. You can configure the size,
+ * volumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration. The name of the volume must match the
+ * name from the task definition.true, this turns on the execute command functionality on all containers
- * in the task.true,
+ * this turns on the execute command functionality on all containers in the task.command override. You can also override existing environment
- * variables (that are specified in the task definition or Docker image) on a container or
- * add new environment variables to it with an environment override.command override. You can
+ * also override existing environment variables (that are specified in the task definition or Docker
+ * image) on a container or add new environment variables to it with an environment
+ * override.
*
family and revision (family:revision) or
- * full ARN of the task definition to start. If a revision isn't specified,
- * the latest ACTIVE revision is used.family and revision (family:revision) or full ARN of the
+ * task definition to start. If a revision isn't specified, the latest ACTIVE
+ * revision is used.configuredAtLaunch. You can configure
- * the size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name of the volume must
- * match the name from the task definition.configuredAtLaunch. You can configure the size,
+ * volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name of the volume must match the
+ * name from the task definition.containerInsights value set with PutAccountSetting or
- * PutAccountSettingDefault.containerInsights
+ * value set with PutAccountSetting or PutAccountSettingDefault.ACTIVE and DRAINING. A container
- * instance can only be updated to DRAINING status once it has reached an
- * ACTIVE state. If a container instance is in REGISTERING,
- * DEREGISTERING, or REGISTRATION_FAILED state you can
- * describe the container instance but can't update the container instance state.ACTIVE and DRAINING. A container instance can only be updated to
+ * DRAINING status once it has reached an ACTIVE state. If a container
+ * instance is in REGISTERING, DEREGISTERING, or
+ * REGISTRATION_FAILED state you can describe the container instance but can't update the
+ * container instance state.family and revision (family:revision) or
- * full ARN of the task definition to run in your service. If a revision is
- * not specified, the latest ACTIVE revision is used. If you modify the task
- * definition with UpdateService, Amazon ECS spawns a task with the new version of
- * the task definition and then stops an old task after the new version is running.family and revision (family:revision) or full ARN of the
+ * task definition to run in your service. If a revision is not specified, the latest
+ * ACTIVE revision is used. If you modify the task definition with
+ * UpdateService, Amazon ECS spawns a task with the new version of the task definition and
+ * then stops an old task after the new version is running.base and weight to assign to them. A capacity provider
- * must be associated with the cluster to be used in a capacity provider strategy. The
- * PutClusterCapacityProviders API is used to associate a capacity
- * provider with a cluster. Only capacity providers with an ACTIVE or
- * UPDATING status can be used.base and weight to assign to them. A capacity provider must be associated
+ * with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.
+ * Only capacity providers with an ACTIVE or UPDATING status can be used.FARGATE or
- * FARGATE_SPOT capacity providers. The Fargate capacity providers are
- * available to all accounts and only need to be associated with a cluster to be
- * used.FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all
+ * accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProvidersAPI operation is used to update the list of available capacity + * providers for a cluster after the cluster is created.
* * @public */ capacityProviderStrategy?: CapacityProviderStrategyItem[] | undefined; /** - *Optional deployment parameters that control how many tasks run during the deployment and the - * failure detection methods.
+ *Optional deployment parameters that control how many tasks run during the deployment and the ordering + * of stopping and starting tasks.
* @public */ deploymentConfiguration?: DeploymentConfiguration | undefined; @@ -311,125 +316,118 @@ export interface UpdateServiceRequest { networkConfiguration?: NetworkConfiguration | undefined; /** - *An array of task placement constraint objects to update the service to use. If no - * value is specified, the existing placement constraints for the service will remain - * unchanged. If this value is specified, it will override any existing placement - * constraints defined for the service. To remove all existing placement constraints, - * specify an empty array.
- *You can specify a maximum of 10 constraints for each task. This limit includes - * constraints in the task definition and those specified at runtime.
+ *An array of task placement constraint objects to update the service to use. If no value is specified, + * the existing placement constraints for the service will remain unchanged. If this value is specified, + * it will override any existing placement constraints defined for the service. To remove all existing + * placement constraints, specify an empty array.
+ *You can specify a maximum of 10 constraints for each task. This limit includes constraints in the + * task definition and those specified at runtime.
* @public */ placementConstraints?: PlacementConstraint[] | undefined; /** - *The task placement strategy objects to update the service to use. If no value is - * specified, the existing placement strategy for the service will remain unchanged. If - * this value is specified, it will override the existing placement strategy defined for - * the service. To remove an existing placement strategy, specify an empty object.
+ *The task placement strategy objects to update the service to use. If no value is specified, the + * existing placement strategy for the service will remain unchanged. If this value is specified, it will + * override the existing placement strategy defined for the service. To remove an existing placement + * strategy, specify an empty object.
*You can specify a maximum of five strategy rules for each service.
* @public */ placementStrategy?: PlacementStrategy[] | undefined; /** - *The platform version that your tasks in the service run on. A platform version is only
- * specified for tasks using the Fargate launch type. If a platform version
- * is not specified, the LATEST platform version is used. For more
- * information, see Fargate Platform
- * Versions in the Amazon Elastic Container Service Developer Guide.
The platform version that your tasks in the service run on. A platform version is only specified for
+ * tasks using the Fargate launch type. If a platform version is not specified, the
+ * LATEST platform version is used. For more information, see Fargate Platform Versions in
+ * the Amazon Elastic Container Service Developer Guide.
Determines whether to force a new deployment of the service. By default, deployments
- * aren't forced. You can use this option to start a new deployment with no service
- * definition changes. For example, you can update a service's tasks to use a newer Docker
- * image with the same image/tag combination (my_image:latest) or to roll
- * Fargate tasks onto a newer platform version.
Determines whether to force a new deployment of the service. By default, deployments aren't forced.
+ * You can use this option to start a new deployment with no service definition changes. For example, you
+ * can update a service's tasks to use a newer Docker image with the same image/tag combination
+ * (my_image:latest) or to roll Fargate tasks onto a newer platform version.
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy - * Elastic Load Balancing target health checks after a task has first started. This is only valid if your - * service is configured to use a load balancer. If your service's tasks take a while to - * start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of - * up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores - * the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler - * from marking tasks as unhealthy and stopping them before they have time to come - * up.
+ *The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container
+ * health checks after a task has first started. If you don't specify a health check grace
+ * period value, the default value of 0 is used. If you don't use any of the health checks,
+ * then healthCheckGracePeriodSeconds is unused.
If your service's tasks take a while to start and respond to health checks, you can specify a + * health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS + * service scheduler ignores health check status. This grace period can prevent the service scheduler from + * marking tasks as unhealthy and stopping them before they have time to come up.
* @public */ healthCheckGracePeriodSeconds?: number | undefined; /** - *If true, this enables execute command functionality on all task
- * containers.
If you do not want to override the value that was set when the service was created,
- * you can set this to null when performing this action.
If true, this enables execute command functionality on all task containers.
If you do not want to override the value that was set when the service was created, you can set this
+ * to null when performing this action.
Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For - * more information, see Tagging Your Amazon ECS - * Resources in the Amazon Elastic Container Service Developer Guide.
- *Only tasks launched after the update will reflect the update. To update the tags on
- * all tasks, set forceNewDeployment to true, so that Amazon ECS
- * starts new tasks with the updated tags.
Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For more information, + * see Tagging Your + * Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
+ *Only tasks launched after the update will reflect the update. To update the tags on all tasks, set
+ * forceNewDeployment to true, so that Amazon ECS starts new tasks with the
+ * updated tags.
A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the - * container name, and the container port to access from the load balancer. The container - * name is as it appears in a container definition.
- *When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks - * with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks - * are running.
- *For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target - * groups. You can update from a single target group to multiple target groups and from - * multiple target groups to a single target group.
- *For services that use blue/green deployments, you can update Elastic Load Balancing target groups by
- * using A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and
+ * the container port to access from the load balancer. The container name is as it appears in a container
+ * definition. When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the
+ * updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running. For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups. You can
+ * update from a single target group to multiple target groups and from multiple target groups to a single
+ * target group. For services that use blue/green deployments, you can update Elastic Load Balancing target groups by using
+ * For services that use the external deployment controller, you can add, update, or
- * remove load balancers by using CreateTaskSet.
- * Note that multiple target groups are not supported for external deployments. For more
- * information see Register
- * multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.
+ *
+ * through CodeDeploy. Note that multiple target groups are not supported for blue/green deployments. For more
+ * information see Register multiple target
+ * groups with a service in the Amazon Elastic Container Service Developer Guide.
* CreateDeployment
- * through CodeDeploy. Note that multiple target groups
- * are not supported for blue/green deployments. For more information see Register
- * multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.
For services that use the external deployment controller, you can add, update, or remove load + * balancers by using CreateTaskSet. Note that + * multiple target groups are not supported for external deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.
*You can remove existing loadBalancers by passing an empty list.
Determines whether to propagate the tags from the task definition or the service to - * the task. If no value is specified, the tags aren't propagated.
- *Only tasks launched after the update will reflect the update. To update the tags on
- * all tasks, set forceNewDeployment to true, so that Amazon ECS
- * starts new tasks with the updated tags.
Determines whether to propagate the tags from the task definition or the service to the task. If no + * value is specified, the tags aren't propagated.
+ *Only tasks launched after the update will reflect the update. To update the tags on all tasks, set
+ * forceNewDeployment to true, so that Amazon ECS starts new tasks with the
+ * updated tags.
The details for the service discovery registries to assign to this service. For more
- * information, see Service
+ * The details for the service discovery registries to assign to this service. For more information, see
+ * Service
* Discovery. When you add, update, or remove the service registries configuration, Amazon ECS starts new
- * tasks with the updated service registries configuration, and then stops the old tasks
- * when the new tasks are running. You can remove existing When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the
+ * updated service registries configuration, and then stops the old tasks when the new tasks are
+ * running. You can remove existing The details of the volume that was The details of the volume that was An object representing the VPC Lattice configuration for the service being updated. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task
- * set exists in. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists
+ * in. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task
- * sets exist in. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist
+ * in. Specify Specify If you set If you don’t specify the time, then the task is automatically protected for 120
- * minutes (2 hours). If you set If you don’t specify the time, then the task is automatically protected for 120 minutes (2
+ * hours).serviceRegistries by passing an empty
- * list.serviceRegistries by passing an empty list.configuredAtLaunch. You can configure
- * the size, volumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration. The name of the volume
- * must match the name from the task definition. If set to null, no new
- * deployment is triggered. Otherwise, if this configuration differs from the existing one,
- * it triggers a new deployment.configuredAtLaunch. You can configure the size,
+ * volumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the
+ * name from the task definition. If set to null, no new deployment is triggered.
+ * Otherwise, if this configuration differs from the existing one, it triggers a new deployment.true to mark a task for protection and false to
- * unset protection, making it eligible for termination.true to mark a task for protection and false to unset protection,
+ * making it eligible for termination.protectionEnabled to true, you can specify the
- * duration for task protection in minutes. You can specify a value from 1 minute to up to
- * 2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in
- * events from Service Auto Scaling or deployments. After this time period lapses,
- * protectionEnabled will be reset to false.protectionEnabled to true, you can specify the duration for task
+ * protection in minutes. You can specify a value from 1 minute to up to 2,880 minutes (48 hours). During
+ * this time, your task will not be terminated by scale-in events from Service Auto Scaling or
+ * deployments. After this time period lapses, protectionEnabled will be reset to
+ * false.
- * protectionEnabled: The protection status of the task. If scale-in
- * protection is turned on for a task, the value is true. Otherwise,
- * it is false.
protectionEnabled: The protection status of the task. If scale-in protection is
+ * turned on for a task, the value is true. Otherwise, it is
+ * false.
*
- * expirationDate: The epoch time when protection for the task will
- * expire.
expirationDate: The epoch time when protection for the task will expire.
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task - * set is found in.
+ *The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set is found + * in.
* @public */ cluster: string | undefined; @@ -600,8 +602,8 @@ export interface UpdateTaskSetRequest { taskSet: string | undefined; /** - *A floating-point percentage of the desired number of tasks to place and keep running - * in the task set.
+ *A floating-point percentage of the desired number of tasks to place and keep running in the task + * set.
* @public */ scale: Scale | undefined; diff --git a/clients/client-ecs/src/protocols/Aws_json1_1.ts b/clients/client-ecs/src/protocols/Aws_json1_1.ts index fcedf68858db..c1371ef12a1d 100644 --- a/clients/client-ecs/src/protocols/Aws_json1_1.ts +++ b/clients/client-ecs/src/protocols/Aws_json1_1.ts @@ -383,6 +383,7 @@ import { VersionInfo, Volume, VolumeFrom, + VpcLatticeConfiguration, } from "../models/models_0"; import { MissingVersionException, @@ -3374,6 +3375,10 @@ const se_UpdateTaskSetRequest = (input: UpdateTaskSetRequest, context: __SerdeCo // se_VolumeList omitted. +// se_VpcLatticeConfiguration omitted. + +// se_VpcLatticeConfigurations omitted. + // de_AccessDeniedException omitted. // de_Attachment omitted. @@ -3614,6 +3619,7 @@ const de_Deployment = (output: any, context: __SerdeContext): Deployment => { taskDefinition: __expectString, updatedAt: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), volumeConfigurations: _json, + vpcLatticeConfigurations: _json, }) as any; }; @@ -4275,6 +4281,7 @@ const de_ServiceRevision = (output: any, context: __SerdeContext): ServiceRevisi serviceRevisionArn: __expectString, taskDefinition: __expectString, volumeConfigurations: _json, + vpcLatticeConfigurations: _json, }) as any; }; @@ -4611,6 +4618,10 @@ const de_UpdateTaskSetResponse = (output: any, context: __SerdeContext): UpdateT // de_VolumeList omitted. +// de_VpcLatticeConfiguration omitted. + +// de_VpcLatticeConfigurations omitted. + const deserializeMetadata = (output: __HttpResponse): __ResponseMetadata => ({ httpStatusCode: output.statusCode, requestId: diff --git a/codegen/sdk-codegen/aws-models/ecs.json b/codegen/sdk-codegen/aws-models/ecs.json index e0cc8f295772..091882cba077 100644 --- a/codegen/sdk-codegen/aws-models/ecs.json +++ b/codegen/sdk-codegen/aws-models/ecs.json @@ -279,7 +279,7 @@ "name": "ecs" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes\n\t\t\tit easy to run, stop, and manage Docker containers. You can host your cluster on a\n\t\t\tserverless infrastructure that's managed by Amazon ECS by launching your services or tasks on\n\t\t\tFargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)\n\t\t\tor External (on-premises) instances that you manage.
\nAmazon ECS makes it easy to launch and stop container-based applications with simple API\n\t\t\tcalls. This makes it easy to get the state of your cluster from a centralized service,\n\t\t\tand gives you access to many familiar Amazon EC2 features.
\nYou can use Amazon ECS to schedule the placement of containers across your cluster based on\n\t\t\tyour resource needs, isolation policies, and availability requirements. With Amazon ECS, you\n\t\t\tdon't need to operate your own cluster management and configuration management systems.\n\t\t\tYou also don't need to worry about scaling your management infrastructure.
", + "smithy.api#documentation": "Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run,\n\t\t\tstop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's\n\t\t\tmanaged by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your\n\t\t\ttasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.
\nAmazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes\n\t\t\tit easy to get the state of your cluster from a centralized service, and gives you access to many\n\t\t\tfamiliar Amazon EC2 features.
\nYou can use Amazon ECS to schedule the placement of containers across your cluster based on your resource\n\t\t\tneeds, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your\n\t\t\town cluster management and configuration management systems. You also don't need to worry about scaling\n\t\t\tyour management infrastructure.
", "smithy.api#title": "Amazon EC2 Container Service", "smithy.api#xmlNamespace": { "uri": "http://ecs.amazonaws.com/doc/2014-11-13/" @@ -1336,13 +1336,13 @@ "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": " The status of the attachment. Valid values are PRECREATED,\n\t\t\t\tCREATED, ATTACHING, ATTACHED,\n\t\t\t\tDETACHING, DETACHED, DELETED, and\n\t\t\t\tFAILED.
The status of the attachment. Valid values are PRECREATED, CREATED,\n\t\t\t\tATTACHING, ATTACHED, DETACHING, DETACHED,\n\t\t\t\tDELETED, and FAILED.
Details of the attachment.
\nFor elastic network interfaces, this includes the network interface ID, the MAC\n\t\t\taddress, the subnet ID, and the private IPv4 address.
\nFor Service Connect services, this includes portName,\n\t\t\t\tclientAliases, discoveryName, and\n\t\t\t\tingressPortOverride.
For Elastic Block Storage, this includes roleArn,\n\t\t\t\tdeleteOnTermination, volumeName, volumeId,\n\t\t\tand statusReason (only when the attachment fails to create or\n\t\t\tattach).
Details of the attachment.
\nFor elastic network interfaces, this includes the network interface ID, the MAC address, the subnet\n\t\t\tID, and the private IPv4 address.
\nFor Service Connect services, this includes portName, clientAliases,\n\t\t\t\tdiscoveryName, and ingressPortOverride.
For Elastic Block Storage, this includes roleArn, deleteOnTermination,\n\t\t\t\tvolumeName, volumeId, and statusReason (only when the\n\t\t\tattachment fails to create or attach).
The name of the attribute. The name must contain between 1 and 128\n\t\t\tcharacters. The name may contain letters (uppercase and lowercase), numbers, hyphens\n\t\t\t(-), underscores (_), forward slashes (/), back slashes (\\), or periods (.).
The name of the attribute. The name must contain between 1 and 128 characters. The name\n\t\t\tmay contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes\n\t\t\t(/), back slashes (\\), or periods (.).
The value of the attribute. The value must contain between 1 and 128\n\t\t\tcharacters. It can contain letters (uppercase and lowercase), numbers, hyphens (-),\n\t\t\tunderscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\\),\n\t\t\tcolons (:), or spaces. The value can't start or end with a space.
The value of the attribute. The value must contain between 1 and 128 characters. It can\n\t\t\tcontain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs\n\t\t\t(@), forward slashes (/), back slashes (\\), colons (:), or spaces. The value can't start or end with a\n\t\t\tspace.
The type of the target to attach the attribute with. This parameter is required if you\n\t\t\tuse the short form ID for a resource instead of the full ARN.
" + "smithy.api#documentation": "The type of the target to attach the attribute with. This parameter is required if you use the short\n\t\t\tform ID for a resource instead of the full ARN.
" } }, "targetId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The ID of the target. You can specify the short form ID for a resource or the full\n\t\t\tAmazon Resource Name (ARN).
" + "smithy.api#documentation": "The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
" } } }, "traits": { - "smithy.api#documentation": "An attribute is a name-value pair that's associated with an Amazon ECS object. Use\n\t\t\tattributes to extend the Amazon ECS data model by adding custom metadata to your resources.\n\t\t\tFor more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "An attribute is a name-value pair that's associated with an Amazon ECS object. Use attributes to extend\n\t\t\tthe Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#AttributeLimitExceededException": { @@ -1434,7 +1434,7 @@ } }, "traits": { - "smithy.api#documentation": "You can apply up to 10 custom attributes for each resource. You can view the\n\t\t\tattributes of a resource with ListAttributes. You can remove existing\n\t\t\tattributes on a resource with DeleteAttributes.
", + "smithy.api#documentation": "You can apply up to 10 custom attributes for each resource. You can view the attributes of a resource\n\t\t\twith ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.
", "smithy.api#error": "client" } }, @@ -1450,7 +1450,7 @@ "autoScalingGroupArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group\n\t\t\tname.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.
", "smithy.api#required": {} } }, @@ -1463,7 +1463,7 @@ "managedTerminationProtection": { "target": "com.amazonaws.ecs#ManagedTerminationProtection", "traits": { - "smithy.api#documentation": "The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection. The default is off.
\nWhen using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.
\nWhen managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an\n\t\t\tAuto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions on as well. For more information, see Instance Protection in the Auto Scaling User Guide.
\nWhen managed termination protection is off, your Amazon EC2 instances aren't protected from\n\t\t\ttermination when the Auto Scaling group scales in.
" + "smithy.api#documentation": "The managed termination protection setting to use for the Auto Scaling group capacity provider. This\n\t\t\tdetermines whether the Auto Scaling group has managed termination protection. The default is\n\t\t\toff.
\nWhen using managed termination protection, managed scaling must also be used otherwise managed\n\t\t\t\ttermination protection doesn't work.
\nWhen managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling\n\t\t\tgroup that contain tasks from being terminated during a scale-in action. The Auto Scaling group and\n\t\t\teach instance in the Auto Scaling group must have instance protection from scale-in actions on as well.\n\t\t\tFor more information, see Instance\n\t\t\t\tProtection in the Auto Scaling User Guide.
\nWhen managed termination protection is off, your Amazon EC2 instances aren't protected from termination\n\t\t\twhen the Auto Scaling group scales in.
" } }, "managedDraining": { @@ -1489,7 +1489,7 @@ "managedTerminationProtection": { "target": "com.amazonaws.ecs#ManagedTerminationProtection", "traits": { - "smithy.api#documentation": "The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection.
\nWhen using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.
\nWhen managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an\n\t\t\tAuto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions on. For more information, see Instance Protection in the Auto Scaling User Guide.
\nWhen managed termination protection is off, your Amazon EC2 instances aren't protected from\n\t\t\ttermination when the Auto Scaling group scales in.
" + "smithy.api#documentation": "The managed termination protection setting to use for the Auto Scaling group capacity provider. This\n\t\t\tdetermines whether the Auto Scaling group has managed termination protection.
\nWhen using managed termination protection, managed scaling must also be used otherwise managed\n\t\t\t\ttermination protection doesn't work.
\nWhen managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling\n\t\t\tgroup that contain tasks from being terminated during a scale-in action. The Auto Scaling group and\n\t\t\teach instance in the Auto Scaling group must have instance protection from scale-in actions on. For\n\t\t\tmore information, see Instance\n\t\t\t\tProtection in the Auto Scaling User Guide.
\nWhen managed termination protection is off, your Amazon EC2 instances aren't protected from termination\n\t\t\twhen the Auto Scaling group scales in.
" } }, "managedDraining": { @@ -1509,20 +1509,20 @@ "subnets": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "The IDs of the subnets associated with the task or service. There's a limit of 16\n\t\t\tsubnets that can be specified per awsvpcConfiguration.
All specified subnets must be from the same VPC.
\nThe IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be\n\t\t\tspecified per awsvpcConfiguration.
All specified subnets must be from the same VPC.
\nThe IDs of the security groups associated with the task or service. If you don't\n\t\t\tspecify a security group, the default security group for the VPC is used. There's a\n\t\t\tlimit of 5 security groups that can be specified per\n\t\t\tawsvpcConfiguration.
All specified security groups must be from the same VPC.
\nThe IDs of the security groups associated with the task or service. If you don't specify a security\n\t\t\tgroup, the default security group for the VPC is used. There's a limit of 5 security groups that can be\n\t\t\tspecified per awsvpcConfiguration.
All specified security groups must be from the same VPC.
\nWhether the task's elastic network interface receives a public IP address. The default\n\t\t\tvalue is DISABLED.
Whether the task's elastic network interface receives a public IP address. The default value is\n\t\t\t\tDISABLED.
The current status of the capacity provider. Only capacity providers in an\n\t\t\t\tACTIVE state can be used in a cluster. When a capacity provider is\n\t\t\tsuccessfully deleted, it has an INACTIVE status.
The current status of the capacity provider. Only capacity providers in an ACTIVE state\n\t\t\tcan be used in a cluster. When a capacity provider is successfully deleted, it has an\n\t\t\t\tINACTIVE status.
The update status of the capacity provider. The following are the possible states that\n\t\t\tis returned.
\nThe capacity provider is in the process of being deleted.
\nThe capacity provider was successfully deleted and has an\n\t\t\t\t\t\t\tINACTIVE status.
The capacity provider can't be deleted. The update status reason provides\n\t\t\t\t\t\tfurther details about why the delete failed.
\nThe update status of the capacity provider. The following are the possible states that is\n\t\t\treturned.
\nThe capacity provider is in the process of being deleted.
\nThe capacity provider was successfully deleted and has an INACTIVE\n\t\t\t\t\t\tstatus.
The capacity provider can't be deleted. The update status reason provides further details\n\t\t\t\t\t\tabout why the delete failed.
\nThe update status reason. This provides further details about the update status for\n\t\t\tthe capacity provider.
" + "smithy.api#documentation": "The update status reason. This provides further details about the update status for the capacity\n\t\t\tprovider.
" } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "The metadata that you apply to the capacity provider to help you categorize and\n\t\t\torganize it. Each tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag\n\t\t\tconsists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The weight value designates the relative percentage of the total\n\t\t\tnumber of tasks launched that should use the specified capacity provider. The\n\t\t\t\tweight value is taken into consideration after the base\n\t\t\tvalue, if defined, is satisfied.
If no weight value is specified, the default value of 0 is\n\t\t\tused. When multiple capacity providers are specified within a capacity provider\n\t\t\tstrategy, at least one of the capacity providers must have a weight value greater than\n\t\t\tzero and any capacity providers with a weight of 0 can't be used to place\n\t\t\ttasks. If you specify multiple capacity providers in a strategy that all have a weight\n\t\t\tof 0, any RunTask or CreateService actions using\n\t\t\tthe capacity provider strategy will fail.
An example scenario for using weights is defining a strategy that contains two\n\t\t\tcapacity providers and both have a weight of 1, then when the\n\t\t\t\tbase is satisfied, the tasks will be split evenly across the two\n\t\t\tcapacity providers. Using that same logic, if you specify a weight of 1 for\n\t\t\t\tcapacityProviderA and a weight of 4 for\n\t\t\t\tcapacityProviderB, then for every one task that's run using\n\t\t\t\tcapacityProviderA, four tasks would use\n\t\t\t\tcapacityProviderB.
The weight value designates the relative percentage of the total number of tasks\n\t\t\tlaunched that should use the specified capacity provider. The weight value is taken into\n\t\t\tconsideration after the base value, if defined, is satisfied.
If no weight value is specified, the default value of 0 is used. When\n\t\t\tmultiple capacity providers are specified within a capacity provider strategy, at least one of the\n\t\t\tcapacity providers must have a weight value greater than zero and any capacity providers with a weight\n\t\t\tof 0 can't be used to place tasks. If you specify multiple capacity providers in a\n\t\t\tstrategy that all have a weight of 0, any RunTask or\n\t\t\t\tCreateService actions using the capacity provider strategy will fail.
An example scenario for using weights is defining a strategy that contains two capacity providers and\n\t\t\tboth have a weight of 1, then when the base is satisfied, the tasks will be\n\t\t\tsplit evenly across the two capacity providers. Using that same logic, if you specify a weight of\n\t\t\t\t1 for capacityProviderA and a weight of 4 for\n\t\t\t\tcapacityProviderB, then for every one task that's run using\n\t\t\t\tcapacityProviderA, four tasks would use\n\t\t\tcapacityProviderB.
The base value designates how many tasks, at a minimum, to run on\n\t\t\tthe specified capacity provider. Only one capacity provider in a capacity provider\n\t\t\tstrategy can have a base defined. If no value is specified, the\n\t\t\tdefault value of 0 is used.
The base value designates how many tasks, at a minimum, to run on the specified\n\t\t\tcapacity provider. Only one capacity provider in a capacity provider strategy can have a\n\t\t\t\tbase defined. If no value is specified, the default value of 0 is\n\t\t\tused.
The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the RunTaskor CreateCluster APIs or as\n\t\t\tthe default capacity provider strategy for a cluster with the CreateCluster API.
Only capacity providers that are already associated with a cluster and have an\n\t\t\t\tACTIVE or UPDATING status can be used in a capacity\n\t\t\tprovider strategy. The PutClusterCapacityProviders API is used to\n\t\t\tassociate a capacity provider with a cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New Auto Scaling group capacity providers can be\n\t\t\tcreated with the CreateClusterCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be used in a\n\t\t\tcapacity provider strategy.
With FARGATE_SPOT, you can run interruption tolerant tasks at a rate that's\n\t\t\tdiscounted compared to the FARGATE price. FARGATE_SPOT runs\n\t\t\ttasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are\n\t\t\tinterrupted with a two-minute warning. FARGATE_SPOT supports Linux tasks\n\t\t\twith the X86_64 architecture on platform version 1.3.0 or later.\n\t\t\t\tFARGATE_SPOT supports Linux tasks with the ARM64 architecture on\n\t\t\tplatform version 1.4.0 or later.
A capacity provider strategy may contain a maximum of 6 capacity providers.
" + "smithy.api#documentation": "The details of a capacity provider strategy. A capacity provider strategy can be set when using the\n\t\t\t\tRunTaskor\n\t\t\t\tCreateCluster APIs or as the default capacity provider strategy for a cluster with the\n\t\t\t\tCreateCluster API.
Only capacity providers that are already associated with a cluster and have an ACTIVE or\n\t\t\t\tUPDATING status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a\n\t\t\tcluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already\n\t\t\tbe created. New Auto Scaling group capacity providers can be created with the CreateClusterCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are available to all\n\t\t\taccounts and only need to be associated with a cluster to be used in a capacity provider\n\t\t\tstrategy.
With FARGATE_SPOT, you can run interruption tolerant tasks at a rate that's discounted\n\t\t\tcompared to the FARGATE price. FARGATE_SPOT runs tasks on spare compute\n\t\t\tcapacity. When Amazon Web Services needs the capacity back, your tasks are interrupted with a two-minute warning.\n\t\t\t\tFARGATE_SPOT supports Linux tasks with the X86_64 architecture on platform version\n\t\t\t1.3.0 or later. FARGATE_SPOT supports Linux tasks with the ARM64 architecture on platform\n\t\t\tversion 1.4.0 or later.
A capacity provider strategy may contain a maximum of 6 capacity providers.
" } }, "com.amazonaws.ecs#CapacityProviderStrategyItemBase": { @@ -1771,7 +1771,7 @@ } }, "traits": { - "smithy.api#documentation": "These errors are usually caused by a client action. This client action might be using\n\t\t\tan action or resource on behalf of a user that doesn't have permissions to use the\n\t\t\taction or resource. Or, it might be specifying an identifier that isn't valid.
\nThe following list includes additional causes for the error:
\nThe RunTask could not be processed because you use managed\n\t\t\t\t\tscaling and there is a capacity error because the quota of tasks in the\n\t\t\t\t\tPROVISIONING per cluster has been reached. For information\n\t\t\t\t\tabout the service quotas, see Amazon ECS\n\t\t\t\t\t\tservice quotas.
These errors are usually caused by a client action. This client action might be using an action or\n\t\t\tresource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might\n\t\t\tbe specifying an identifier that isn't valid.
\nThe following list includes additional causes for the error:
\nThe RunTask could not be processed because you use managed scaling and there is\n\t\t\t\t\ta capacity error because the quota of tasks in the PROVISIONING per cluster has\n\t\t\t\t\tbeen reached. For information about the service quotas, see Amazon ECS service\n\t\t\t\t\t\tquotas.
The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN\n\t\t\tformat, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN format, see Amazon Resource Name (ARN)\n\t\t\tin the Amazon ECS Developer Guide.
" } }, "clusterName": { @@ -1799,14 +1799,14 @@ "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The status of the cluster. The following are the possible states that are\n\t\t\treturned.
\nThe cluster is ready to accept tasks and if applicable you can register\n\t\t\t\t\t\tcontainer instances with the cluster.
\nThe cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider are being created.
\nThe cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider are being deleted.
\nThe cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider have failed to create.
\nThe cluster has been deleted. Clusters with an INACTIVE\n\t\t\t\t\t\tstatus may remain discoverable in your account for a period of time.\n\t\t\t\t\t\tHowever, this behavior is subject to change in the future. We don't\n\t\t\t\t\t\trecommend that you rely on INACTIVE clusters persisting.
The status of the cluster. The following are the possible states that are returned.
\nThe cluster is ready to accept tasks and if applicable you can register container\n\t\t\t\t\t\tinstances with the cluster.
\nThe cluster has capacity providers that are associated with it and the resources needed\n\t\t\t\t\t\tfor the capacity provider are being created.
\nThe cluster has capacity providers that are associated with it and the resources needed\n\t\t\t\t\t\tfor the capacity provider are being deleted.
\nThe cluster has capacity providers that are associated with it and the resources needed\n\t\t\t\t\t\tfor the capacity provider have failed to create.
\nThe cluster has been deleted. Clusters with an INACTIVE status may remain\n\t\t\t\t\t\tdiscoverable in your account for a period of time. However, this behavior is subject to\n\t\t\t\t\t\tchange in the future. We don't recommend that you rely on INACTIVE clusters\n\t\t\t\t\t\tpersisting.
The number of container instances registered into the cluster. This includes container\n\t\t\tinstances in both ACTIVE and DRAINING status.
The number of container instances registered into the cluster. This includes container instances in\n\t\t\tboth ACTIVE and DRAINING status.
The number of services that are running on the cluster in an ACTIVE\n\t\t\tstate. You can view these services with PListServices.
The number of services that are running on the cluster in an ACTIVE state. You can view\n\t\t\tthese services with PListServices.
Additional information about your clusters that are separated by launch type. They\n\t\t\tinclude the following:
\nrunningEC2TasksCount
\nRunningFargateTasksCount
\npendingEC2TasksCount
\npendingFargateTasksCount
\nactiveEC2ServiceCount
\nactiveFargateServiceCount
\ndrainingEC2ServiceCount
\ndrainingFargateServiceCount
\nAdditional information about your clusters that are separated by launch type. They include the\n\t\t\tfollowing:
\nrunningEC2TasksCount
\nRunningFargateTasksCount
\npendingEC2TasksCount
\npendingFargateTasksCount
\nactiveEC2ServiceCount
\nactiveFargateServiceCount
\ndrainingEC2ServiceCount
\ndrainingFargateServiceCount
\nThe metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the cluster to help you categorize and organize them. Each tag\n\t\t\tconsists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights\n\t\t\tis on or off for a cluster.
" + "smithy.api#documentation": "The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is on or off\n\t\t\tfor a cluster.
" } }, "capacityProviders": { @@ -1857,19 +1857,19 @@ "defaultCapacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "The default capacity provider strategy for the cluster. When services or tasks are run\n\t\t\tin the cluster with no launch type or capacity provider strategy specified, the default\n\t\t\tcapacity provider strategy is used.
" + "smithy.api#documentation": "The default capacity provider strategy for the cluster. When services or tasks are run in the cluster\n\t\t\twith no launch type or capacity provider strategy specified, the default capacity provider strategy is\n\t\t\tused.
" } }, "attachments": { "target": "com.amazonaws.ecs#Attachments", "traits": { - "smithy.api#documentation": "The resources attached to a cluster. When using a capacity provider with a cluster,\n\t\t\tthe capacity provider and associated resources are returned as cluster\n\t\t\tattachments.
" + "smithy.api#documentation": "The resources attached to a cluster. When using a capacity provider with a cluster, the capacity\n\t\t\tprovider and associated resources are returned as cluster attachments.
" } }, "attachmentsStatus": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The status of the capacity providers associated with the cluster. The following are\n\t\t\tthe states that are returned.
\nThe available capacity providers for the cluster are updating.
\nThe capacity providers have successfully updated.
\nThe capacity provider updates failed.
\nThe status of the capacity providers associated with the cluster. The following are the states that\n\t\t\tare returned.
\nThe available capacity providers for the cluster are updating.
\nThe capacity providers have successfully updated.
\nThe capacity provider updates failed.
\nA regional grouping of one or more container instances where you can run task\n\t\t\trequests. Each account receives a default cluster the first time you use the Amazon ECS\n\t\t\tservice, but you may also create other clusters. Clusters may contain more than one\n\t\t\tinstance type simultaneously.
" + "smithy.api#documentation": "A regional grouping of one or more container instances where you can run task requests. Each account\n\t\t\treceives a default cluster the first time you use the Amazon ECS service, but you may also create other\n\t\t\tclusters. Clusters may contain more than one instance type simultaneously.
" } }, "com.amazonaws.ecs#ClusterConfiguration": { @@ -1914,7 +1914,7 @@ } }, "traits": { - "smithy.api#documentation": "You can't delete a cluster that has registered container instances. First, deregister\n\t\t\tthe container instances before you can delete the cluster. For more information, see\n\t\t\tDeregisterContainerInstance.
", + "smithy.api#documentation": "You can't delete a cluster that has registered container instances. First, deregister the container\n\t\t\tinstances before you can delete the cluster. For more information, see DeregisterContainerInstance.
", "smithy.api#error": "client" } }, @@ -1929,7 +1929,7 @@ } }, "traits": { - "smithy.api#documentation": "You can't delete a cluster that contains services. First, update the service to reduce\n\t\t\tits desired task count to 0, and then delete the service. For more information, see\n\t\t\tUpdateService and DeleteService.
", + "smithy.api#documentation": "You can't delete a cluster that contains services. First, update the service to reduce its desired\n\t\t\ttask count to 0, and then delete the service. For more information, see UpdateService and DeleteService.
", "smithy.api#error": "client" } }, @@ -2010,7 +2010,7 @@ "namespace": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a\n\t\t\tService Connect configuration, this namespace is used.
" + "smithy.api#documentation": "The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace. When you create a service and don't specify a Service Connect\n\t\t\tconfiguration, this namespace is used.
" } } }, @@ -2024,7 +2024,7 @@ "namespace": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "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\n\t\t\ta Service Connect configuration. The namespace name can include up to 1024 characters.\n\t\t\tThe name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than\n\t\t\t(>), less than (<), or slash (/).
\nIf you enter an existing namespace name or ARN, then that namespace will be used.\n\t\t\tAny namespace type is supported. The namespace must be in this account and this Amazon Web Services\n\t\t\tRegion.
\nIf you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a\n\t\t\tCloud Map namespace with the \"API calls\" method of instance discovery only. This instance\n\t\t\tdiscovery method is the \"HTTP\" namespace type in the Command Line Interface. Other types of instance\n\t\t\tdiscovery aren't used by Service Connect.
\nIf you update the cluster with an empty string \"\" for the namespace name,\n\t\t\tthe cluster configuration for Service Connect is removed. Note that the namespace will\n\t\t\tremain in Cloud Map and must be deleted separately.
For more information about Cloud Map, see Working with Services\n\t\t\tin the Cloud Map Developer Guide.
", + "smithy.api#documentation": "The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify a\n\t\t\tService Connect configuration. The namespace name can include up to 1024 characters. The name is\n\t\t\tcase-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<),\n\t\t\tor slash (/).
\nIf you enter an existing namespace name or ARN, then that namespace will be used. Any namespace\n\t\t\ttype is supported. The namespace must be in this account and this Amazon Web Services Region.
\nIf you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a Cloud Map namespace\n\t\t\twith the \"API calls\" method of instance discovery only. This instance discovery method is the \"HTTP\"\n\t\t\tnamespace type in the Command Line Interface. Other types of instance discovery aren't used by\n\t\t\tService Connect.
\nIf you update the cluster with an empty string \"\" for the namespace name, the cluster\n\t\t\tconfiguration for Service Connect is removed. Note that the namespace will remain in Cloud Map and must\n\t\t\tbe deleted separately.
For more information about Cloud Map, see Working with Services in the\n\t\t\tCloud Map Developer Guide.
", "smithy.api#required": {} } } @@ -2045,12 +2045,12 @@ "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The value to set for the cluster setting. The supported values are\n\t\t\t\tenabled and disabled.
If you set name to containerInsights and value\n\t\t\tto enabled, CloudWatch Container Insights will be on for the cluster, otherwise\n\t\t\tit will be off unless the containerInsights account setting is turned on.\n\t\t\tIf a cluster value is specified, it will override the containerInsights\n\t\t\tvalue set with PutAccountSetting or PutAccountSettingDefault.
The value to set for the cluster setting. The supported values are enabled and\n\t\t\t\tdisabled.
If you set name to containerInsights and value to\n\t\t\t\tenabled, CloudWatch Container Insights will be on for the cluster, otherwise it will be off\n\t\t\tunless the containerInsights account setting is turned on. If a cluster value is\n\t\t\tspecified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
The settings to use when creating a cluster. This parameter is used to turn on CloudWatch\n\t\t\tContainer Insights for a cluster.
" + "smithy.api#documentation": "The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container\n\t\t\tInsights for a cluster.
" } }, "com.amazonaws.ecs#ClusterSettingName": { @@ -2111,7 +2111,7 @@ "resourceIds": { "target": "com.amazonaws.ecs#ResourceIds", "traits": { - "smithy.api#documentation": "The existing task ARNs which are already associated with the\n\t\t\t\tclientToken.
The existing task ARNs which are already associated with the clientToken.
The RunTask request could not be processed due to conflicts. The provided\n\t\t\t\tclientToken is already in use with a different RunTask\n\t\t\trequest. The resourceIds are the existing task ARNs which are already\n\t\t\tassociated with the clientToken.
To fix this issue:
\nRun RunTask with a unique clientToken.
Run RunTask with the clientToken and the original\n\t\t\t\t\tset of parameters
The RunTask request could not be processed due to conflicts. The provided\n\t\t\t\tclientToken is already in use with a different RunTask request. The\n\t\t\t\tresourceIds are the existing task ARNs which are already associated with the\n\t\t\t\tclientToken.
To fix this issue:
\nRun RunTask with a unique clientToken.
Run RunTask with the clientToken and the original set of\n\t\t\t\t\tparameters
A short (255 max characters) human-readable string to provide additional details about\n\t\t\ta running or stopped container.
" + "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details about a running or\n\t\t\tstopped container.
" } }, "networkBindings": { @@ -2215,7 +2215,7 @@ "healthStatus": { "target": "com.amazonaws.ecs#HealthStatus", "traits": { - "smithy.api#documentation": "The health status of the container. If health checks aren't configured for this\n\t\t\tcontainer in its task definition, then it reports the health status as\n\t\t\t\tUNKNOWN.
The health status of the container. If health checks aren't configured for this container in its task\n\t\t\tdefinition, then it reports the health status as UNKNOWN.
The number of CPU units set for the container. The value is 0 if no value\n\t\t\twas specified in the container definition when the task definition was\n\t\t\tregistered.
The number of CPU units set for the container. The value is 0 if no value was specified\n\t\t\tin the container definition when the task definition was registered.
The name of a container. If you're linking multiple containers together in a task\n\t\t\tdefinition, the name of one container can be entered in the\n\t\t\t\tlinks of another container to connect the containers.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the docker container create command and the\n\t\t\t\t--name option to docker\n\t\t\trun.
The name of a container. If you're linking multiple containers together in a task definition, the\n\t\t\t\tname of one container can be entered in the links of another container to\n\t\t\tconnect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the docker\n\t\t\tcontainer create command and the --name option to docker run.
The image used to start a container. This string is passed directly to the Docker\n\t\t\tdaemon. By default, images in the Docker Hub registry are available. Other repositories\n\t\t\tare specified with either \n repository-url/image:tag\n or \n repository-url/image@digest\n . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the docker container create command and the\n\t\t\t\tIMAGE parameter of docker\n\t\t\t\trun.
When a new task starts, the Amazon ECS container agent pulls the latest version of\n\t\t\t\t\tthe specified image and tag for the container to use. However, subsequent\n\t\t\t\t\tupdates to a repository image aren't propagated to already running tasks.
\nImages in Amazon ECR repositories can be specified by either using the full\n\t\t\t\t\t\tregistry/repository:tag or\n\t\t\t\t\t\tregistry/repository@digest. For example,\n\t\t\t\t\t\t012345678910.dkr.ecr.\n\t\t\t\t\tor\n\t\t\t\t\t\t012345678910.dkr.ecr..\n\t\t\t\t
Images in official repositories on Docker Hub use a single name (for example,\n\t\t\t\t\t\tubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization\n\t\t\t\t\tname (for example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name\n\t\t\t\t\t(for example, quay.io/assemblyline/ubuntu).
The image used to start a container. This string is passed directly to the Docker daemon. By default,\n\t\t\timages in the Docker Hub registry are available. Other repositories are specified with either \n repository-url/image:tag\n or \n repository-url/image@digest\n . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the docker container create\n\t\t\tcommand and the IMAGE parameter of docker run.
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified\n\t\t\t\t\timage and tag for the container to use. However, subsequent updates to a repository image\n\t\t\t\t\taren't propagated to already running tasks.
\nImages in Amazon ECR repositories can be specified by either using the full\n\t\t\t\t\t\tregistry/repository:tag or registry/repository@digest. For\n\t\t\t\t\texample,\n\t\t\t\t\t\t012345678910.dkr.ecr.\n\t\t\t\t\tor\n\t\t\t\t\t\t012345678910.dkr.ecr..\n\t\t\t\t
Images in official repositories on Docker Hub use a single name (for example,\n\t\t\t\t\t\tubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for\n\t\t\t\t\texample, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example,\n\t\t\t\t\t\tquay.io/assemblyline/ubuntu).
The number of cpu units reserved for the container. This parameter maps\n\t\t\tto CpuShares in the docker container create commandand the --cpu-shares option to docker run.
This field is optional for tasks using the Fargate launch type, and the\n\t\t\tonly requirement is that the total amount of CPU reserved for all containers within a\n\t\t\ttask be lower than the task-level cpu value.
You can determine the number of CPU units that are available per EC2 instance type\n\t\t\t\tby multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page\n\t\t\t\tby 1,024.
\nLinux containers share unallocated CPU units with other containers on the container\n\t\t\tinstance with the same ratio as their allocated amount. For example, if you run a\n\t\t\tsingle-container task on a single-core instance type with 512 CPU units specified for\n\t\t\tthat container, and that's the only task running on the container instance, that\n\t\t\tcontainer could use the full 1,024 CPU unit share at any given time. However, if you\n\t\t\tlaunched another copy of the same task on that container instance, each task is\n\t\t\tguaranteed a minimum of 512 CPU units when needed. Moreover, each container could float\n\t\t\tto higher CPU usage if the other container was not using it. If both tasks were 100%\n\t\t\tactive all of the time, they would be limited to 512 CPU units.
\nOn Linux container instances, the Docker daemon on the container instance uses the CPU\n\t\t\tvalue to calculate the relative CPU share ratios for running containers. The minimum valid CPU share value\n\t\t\tthat the Linux kernel allows is 2, and the\n\t\t\tmaximum valid CPU share value that the Linux kernel allows is 262144. However, the CPU parameter isn't required, and you\n\t\t\tcan use CPU values below 2 or above 262144 in your container definitions. For CPU values below 2\n\t\t\t(including null) or above 262144, the behavior varies based on your Amazon ECS container agent\n\t\t\tversion:
\n\n Agent versions less than or equal to 1.1.0:\n\t\t\t\t\tNull and zero CPU values are passed to Docker as 0, which Docker then converts\n\t\t\t\t\tto 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux\n\t\t\t\t\tkernel converts to two CPU shares.
\n\n Agent versions greater than or equal to 1.2.0:\n\t\t\t\t\tNull, zero, and CPU values of 1 are passed to Docker as 2.
\n\n Agent versions greater than or equal to\n\t\t\t\t\t\t1.84.0: CPU values greater than 256 vCPU are passed to Docker as\n\t\t\t\t\t256, which is equivalent to 262144 CPU shares.
\nOn Windows container instances, the CPU limit is enforced as an absolute limit, or a\n\t\t\tquota. Windows containers only have access to the specified amount of CPU that's\n\t\t\tdescribed in the task definition. A null or zero CPU value is passed to Docker as\n\t\t\t\t0, which Windows interprets as 1% of one CPU.
The number of cpu units reserved for the container. This parameter maps to\n\t\t\t\tCpuShares in the docker container create commandand the --cpu-shares\n\t\t\toption to docker run.
This field is optional for tasks using the Fargate launch type, and the only\n\t\t\trequirement is that the total amount of CPU reserved for all containers within a task be lower than the\n\t\t\ttask-level cpu value.
You can determine the number of CPU units that are available per EC2 instance type by multiplying\n\t\t\t\tthe vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
\nLinux containers share unallocated CPU units with other containers on the container instance with the\n\t\t\tsame ratio as their allocated amount. For example, if you run a single-container task on a single-core\n\t\t\tinstance type with 512 CPU units specified for that container, and that's the only task running on the\n\t\t\tcontainer instance, that container could use the full 1,024 CPU unit share at any given time. However,\n\t\t\tif you launched another copy of the same task on that container instance, each task is guaranteed a\n\t\t\tminimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the\n\t\t\tother container was not using it. If both tasks were 100% active all of the time, they would be limited\n\t\t\tto 512 CPU units.
\nOn Linux container instances, the Docker daemon on the container instance uses the CPU value to\n\t\t\tcalculate the relative CPU share ratios for running containers. The minimum valid CPU share value that\n\t\t\tthe Linux kernel allows is 2, and the maximum valid CPU share value that the Linux kernel allows is\n\t\t\t262144. However, the CPU parameter isn't required, and you can use CPU values below 2 or above 262144\n\t\t\tin your container definitions. For CPU values below 2 (including null) or above 262144, the behavior\n\t\t\tvaries based on your Amazon ECS container agent version:
\n\n Agent versions less than or equal to 1.1.0: Null and zero CPU\n\t\t\t\t\tvalues are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of\n\t\t\t\t\t1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.
\n\n Agent versions greater than or equal to 1.2.0: Null, zero, and\n\t\t\t\t\tCPU values of 1 are passed to Docker as 2.
\n\n Agent versions greater than or equal to 1.84.0: CPU values\n\t\t\t\t\tgreater than 256 vCPU are passed to Docker as 256, which is equivalent to 262144 CPU\n\t\t\t\t\tshares.
\nOn Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows\n\t\t\tcontainers only have access to the specified amount of CPU that's described in the task definition. A\n\t\t\tnull or zero CPU value is passed to Docker as 0, which Windows interprets as 1% of one\n\t\t\tCPU.
The amount (in MiB) of memory to present to the container. If your container attempts\n\t\t\tto exceed the memory specified here, the container is killed. The total amount of memory\n\t\t\treserved for all containers within a task must be lower than the task\n\t\t\t\tmemory value, if one is specified. This parameter maps to\n\t\t\tMemory in the docker container create command and the --memory option to docker run.
If using the Fargate launch type, this parameter is optional.
\nIf using the EC2 launch type, you must specify either a task-level\n\t\t\tmemory value or a container-level memory value. If you specify both a container-level\n\t\t\t\tmemory and memoryReservation value, memory\n\t\t\tmust be greater than memoryReservation. If you specify\n\t\t\t\tmemoryReservation, then that value is subtracted from the available\n\t\t\tmemory resources for the container instance where the container is placed. Otherwise,\n\t\t\tthe value of memory is used.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 6 MiB of memory for your containers.
\nThe Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 4 MiB of memory for your containers.
" + "smithy.api#documentation": "The amount (in MiB) of memory to present to the container. If your container attempts to exceed the\n\t\t\tmemory specified here, the container is killed. The total amount of memory reserved for all containers\n\t\t\twithin a task must be lower than the task memory value, if one is specified. This\n\t\t\tparameter maps to Memory in the docker container create command and the\n\t\t\t\t--memory option to docker run.
If using the Fargate launch type, this parameter is optional.
\nIf using the EC2 launch type, you must specify either a task-level memory value or a\n\t\t\tcontainer-level memory value. If you specify both a container-level memory and\n\t\t\t\tmemoryReservation value, memory must be greater than\n\t\t\t\tmemoryReservation. If you specify memoryReservation, then that value is\n\t\t\tsubtracted from the available memory resources for the container instance where the container is\n\t\t\tplaced. Otherwise, the value of memory is used.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't\n\t\t\tspecify less than 6 MiB of memory for your containers.
\nThe Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So,\n\t\t\tdon't specify less than 4 MiB of memory for your containers.
" } }, "memoryReservation": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The soft limit (in MiB) of memory to reserve for the container. When system memory is\n\t\t\tunder heavy contention, Docker attempts to keep the container memory to this soft limit.\n\t\t\tHowever, your container can consume more memory when it needs to, up to either the hard\n\t\t\tlimit specified with the memory parameter (if applicable), or all of the\n\t\t\tavailable memory on the container instance, whichever comes first. This parameter maps\n\t\t\tto MemoryReservation in the docker container create command and the --memory-reservation option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for\n\t\t\tone or both of memory or memoryReservation in a container\n\t\t\tdefinition. If you specify both, memory must be greater than\n\t\t\t\tmemoryReservation. If you specify memoryReservation, then\n\t\t\tthat value is subtracted from the available memory resources for the container instance\n\t\t\twhere the container is placed. Otherwise, the value of memory is\n\t\t\tused.
For example, if your container normally uses 128 MiB of memory, but occasionally\n\t\t\tbursts to 256 MiB of memory for short periods of time, you can set a\n\t\t\t\tmemoryReservation of 128 MiB, and a memory hard limit of\n\t\t\t300 MiB. This configuration would allow the container to only reserve 128 MiB of memory\n\t\t\tfrom the remaining resources on the container instance, but also allow the container to\n\t\t\tconsume more memory resources when needed.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 6 MiB of memory for your containers.
\nThe Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 4 MiB of memory for your containers.
" + "smithy.api#documentation": "The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy\n\t\t\tcontention, Docker attempts to keep the container memory to this soft limit. However, your container\n\t\t\tcan consume more memory when it needs to, up to either the hard limit specified with the\n\t\t\t\tmemory parameter (if applicable), or all of the available memory on the container\n\t\t\tinstance, whichever comes first. This parameter maps to MemoryReservation in the docker\n\t\t\tcontainer create command and the --memory-reservation option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for one or both of\n\t\t\t\tmemory or memoryReservation in a container definition. If you specify\n\t\t\tboth, memory must be greater than memoryReservation. If you specify\n\t\t\t\tmemoryReservation, then that value is subtracted from the available memory resources\n\t\t\tfor the container instance where the container is placed. Otherwise, the value of memory\n\t\t\tis used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of\n\t\t\tmemory for short periods of time, you can set a memoryReservation of 128 MiB, and a\n\t\t\t\tmemory hard limit of 300 MiB. This configuration would allow the container to only\n\t\t\treserve 128 MiB of memory from the remaining resources on the container instance, but also allow the\n\t\t\tcontainer to consume more memory resources when needed.
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't\n\t\t\tspecify less than 6 MiB of memory for your containers.
\nThe Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So,\n\t\t\tdon't specify less than 4 MiB of memory for your containers.
" } }, "links": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "The links parameter allows containers to communicate with each other\n\t\t\twithout the need for port mappings. This parameter is only supported if the network mode\n\t\t\tof a task definition is bridge. The name:internalName\n\t\t\tconstruct is analogous to name:alias in Docker links.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.. This parameter maps to Links in the docker container create command and the\n\t\t\t\t--link option to docker\n\t\t\trun.
This parameter is not supported for Windows containers.
\nContainers that are collocated on a single container instance may be able to\n\t\t\t\tcommunicate with each other without requiring links or host port mappings. Network\n\t\t\t\tisolation is achieved on the container instance using security groups and VPC\n\t\t\t\tsettings.
\nThe links parameter allows containers to communicate with each other without the need\n\t\t\tfor port mappings. This parameter is only supported if the network mode of a task definition is\n\t\t\t\tbridge. The name:internalName construct is analogous to\n\t\t\t\tname:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.. This parameter maps to\n\t\t\t\tLinks in the docker container create command and the --link option to\n\t\t\tdocker run.
This parameter is not supported for Windows containers.
\nContainers that are collocated on a single container instance may be able to communicate with\n\t\t\t\teach other without requiring links or host port mappings. Network isolation is achieved on the\n\t\t\t\tcontainer instance using security groups and VPC settings.
\nThe list of port mappings for the container. Port mappings allow containers to access\n\t\t\tports on the host container instance to send or receive traffic.
\nFor task definitions that use the awsvpc network mode, only specify the\n\t\t\t\tcontainerPort. The hostPort can be left blank or it must\n\t\t\tbe the same value as the containerPort.
Port mappings on Windows use the NetNAT gateway address rather than\n\t\t\t\tlocalhost. There's no loopback for port mappings on Windows, so you\n\t\t\tcan't access a container's mapped port from the host itself.
This parameter maps to PortBindings in the\n\t\t\tthe docker container create command and the\n\t\t\t\t--publish option to docker\n\t\t\t\trun. If the network mode of a task definition is set to none,\n\t\t\tthen you can't specify port mappings. If the network mode of a task definition is set to\n\t\t\t\thost, then host ports must either be undefined or they must match the\n\t\t\tcontainer port in the port mapping.
After a task reaches the RUNNING status, manual and automatic host\n\t\t\t\tand container port assignments are visible in the Network\n\t\t\t\t\tBindings section of a container description for a selected task in\n\t\t\t\tthe Amazon ECS console. The assignments are also visible in the\n\t\t\t\tnetworkBindings section DescribeTasks\n\t\t\t\tresponses.
The list of port mappings for the container. Port mappings allow containers to access ports on the\n\t\t\thost container instance to send or receive traffic.
\nFor task definitions that use the awsvpc network mode, only specify the\n\t\t\t\tcontainerPort. The hostPort can be left blank or it must be the same\n\t\t\tvalue as the containerPort.
Port mappings on Windows use the NetNAT gateway address rather than\n\t\t\t\tlocalhost. There's no loopback for port mappings on Windows, so you can't access a\n\t\t\tcontainer's mapped port from the host itself.
This parameter maps to PortBindings in the the docker container create command and the\n\t\t\t\t--publish option to docker run. If the network mode of a task definition is set to\n\t\t\t\tnone, then you can't specify port mappings. If the network mode of a task definition\n\t\t\tis set to host, then host ports must either be undefined or they must match the container\n\t\t\tport in the port mapping.
After a task reaches the RUNNING status, manual and automatic host and container\n\t\t\t\tport assignments are visible in the Network Bindings section of a\n\t\t\t\tcontainer description for a selected task in the Amazon ECS console. The assignments are also visible in\n\t\t\t\tthe networkBindings section DescribeTasks\n\t\t\t\tresponses.
If the essential parameter of a container is marked as true,\n\t\t\tand that container fails or stops for any reason, all other containers that are part of\n\t\t\tthe task are stopped. If the essential parameter of a container is marked\n\t\t\tas false, its failure doesn't affect the rest of the containers in a task.\n\t\t\tIf this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application\n\t\t\tthat's composed of multiple containers, group containers that are used for a common\n\t\t\tpurpose into components, and separate the different components into multiple task\n\t\t\tdefinitions. For more information, see Application\n\t\t\t\tArchitecture in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "If the essential parameter of a container is marked as true, and that\n\t\t\tcontainer fails or stops for any reason, all other containers that are part of the task are stopped. If\n\t\t\tthe essential parameter of a container is marked as false, its failure\n\t\t\tdoesn't affect the rest of the containers in a task. If this parameter is omitted, a container is\n\t\t\tassumed to be essential.
All tasks must have at least one essential container. If you have an application that's composed of\n\t\t\tmultiple containers, group containers that are used for a common purpose into components, and separate\n\t\t\tthe different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.
" } }, "restartPolicy": { "target": "com.amazonaws.ecs#ContainerRestartPolicy", "traits": { - "smithy.api#documentation": "The restart policy for a container. When you set up a restart policy, Amazon ECS can restart the container without needing to replace the\n\t\t\ttask. For more information, see Restart individual containers in Amazon ECS tasks with container restart policies in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The restart policy for a container. When you set up a restart policy, Amazon ECS can restart the container\n\t\t\twithout needing to replace the task. For more information, see Restart individual containers\n\t\t\t\tin Amazon ECS tasks with container restart policies in the Amazon Elastic Container Service Developer Guide.
" } }, "entryPoint": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "Early versions of the Amazon ECS container agent don't properly handle\n\t\t\t\t\tentryPoint parameters. If you have problems using\n\t\t\t\t\tentryPoint, update your container agent or enter your commands and\n\t\t\t\targuments as command array items instead.
The entry point that's passed to the container. This parameter maps to\n\t\t\tEntrypoint in the docker container create command and the --entrypoint option to docker run.
Early versions of the Amazon ECS container agent don't properly handle entryPoint\n\t\t\t\tparameters. If you have problems using entryPoint, update your container agent or\n\t\t\t\tenter your commands and arguments as command array items instead.
The entry point that's passed to the container. This parameter maps to Entrypoint in the\n\t\t\tdocker container create command and the --entrypoint option to docker run.
The command that's passed to the container. This parameter maps to Cmd in\n\t\t\tthe docker container create command and the\n\t\t\t\tCOMMAND parameter to docker\n\t\t\t\trun. If there are multiple arguments, each\n\t\t\targument is a separated string in the array.
The command that's passed to the container. This parameter maps to Cmd in the docker\n\t\t\tcontainer create command and the COMMAND parameter to docker run. If there are multiple\n\t\t\targuments, each argument is a separated string in the array.
The environment variables to pass to a container. This parameter maps to\n\t\t\tEnv in the docker container create command and the --env option to docker run.
We don't recommend that you use plaintext environment variables for sensitive\n\t\t\t\tinformation, such as credential data.
\nThe environment variables to pass to a container. This parameter maps to Env in the\n\t\t\tdocker container create command and the --env option to docker run.
We don't recommend that you use plaintext environment variables for sensitive information, such\n\t\t\t\tas credential data.
\nA list of files containing the environment variables to pass to a container. This\n\t\t\tparameter maps to the --env-file option to docker run.
You can specify up to ten environment files. The file must have a .env\n\t\t\tfile extension. Each line in an environment file contains an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored.
If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they're processed from the top down. We recommend that you use unique\n\t\t\tvariable names. For more information, see Specifying Environment\n\t\t\t\tVariables in the Amazon Elastic Container Service Developer Guide.
A list of files containing the environment variables to pass to a container. This parameter maps to\n\t\t\tthe --env-file option to docker run.
You can specify up to ten environment files. The file must have a .env file extension.\n\t\t\tEach line in an environment file contains an environment variable in VARIABLE=VALUE\n\t\t\tformat. Lines beginning with # are treated as comments and are ignored.
If there are environment variables specified using the environment parameter in a\n\t\t\tcontainer definition, they take precedence over the variables contained within an environment file. If\n\t\t\tmultiple environment files are specified that contain the same variable, they're processed from the top\n\t\t\tdown. We recommend that you use unique variable names. For more information, see Specifying\n\t\t\t\tEnvironment Variables in the Amazon Elastic Container Service Developer Guide.
The mount points for data volumes in your container.
\nThis parameter maps to Volumes in the docker container create command and the --volume option to docker run.
Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData. Windows containers can't mount directories on a\n\t\t\tdifferent drive, and mount point can't be across drives.
The mount points for data volumes in your container.
\nThis parameter maps to Volumes in the docker container create command and the\n\t\t\t\t--volume option to docker run.
Windows containers can mount whole directories on the same drive as $env:ProgramData.\n\t\t\tWindows containers can't mount directories on a different drive, and mount point can't be across\n\t\t\tdrives.
Data volumes to mount from another container. This parameter maps to\n\t\t\tVolumesFrom in the docker container create command and the --volumes-from option to docker run.
Data volumes to mount from another container. This parameter maps to VolumesFrom in the\n\t\t\tdocker container create command and the --volumes-from option to docker run.
Linux-specific modifications that are applied to the container, such as Linux kernel\n\t\t\tcapabilities. For more information see KernelCapabilities.
\nThis parameter is not supported for Windows containers.
\nLinux-specific modifications that are applied to the container, such as Linux kernel capabilities.\n\t\t\tFor more information see KernelCapabilities.
\nThis parameter is not supported for Windows containers.
\nThe secrets to pass to the container. For more information, see Specifying\n\t\t\t\tSensitive Data in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The secrets to pass to the container. For more information, see Specifying Sensitive\n\t\t\t\tData in the Amazon Elastic Container Service Developer Guide.
" } }, "dependsOn": { "target": "com.amazonaws.ecs#ContainerDependencies", "traits": { - "smithy.api#documentation": "The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies on other containers in a task definition. When a dependency is\n\t\t\tdefined for container startup, for container shutdown it is reversed.
\nFor tasks using the EC2 launch type, the container instances require at\n\t\t\tleast version 1.26.0 of the container agent to turn on container dependencies. However,\n\t\t\twe recommend using the latest container agent version. For information about checking\n\t\t\tyour agent version and updating to the latest version, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init package. If\n\t\t\tyour container instances are launched from version 20190301 or later, then\n\t\t\tthey contain the required versions of the container agent and ecs-init. For\n\t\t\tmore information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
The dependencies defined for container startup and shutdown. A container can contain multiple\n\t\t\tdependencies on other containers in a task definition. When a dependency is defined for container\n\t\t\tstartup, for container shutdown it is reversed.
\nFor tasks using the EC2 launch type, the container instances require at least version\n\t\t\t1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest\n\t\t\tcontainer agent version. For information about checking your agent version and updating to the latest\n\t\t\tversion, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an\n\t\t\tAmazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If\n\t\t\tyour container instances are launched from version 20190301 or later, then they contain\n\t\t\tthe required versions of the container agent and ecs-init. For more information, see\n\t\t\t\tAmazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires the following\n\t\t\tplatforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
Time duration (in seconds) to wait before giving up on resolving dependencies for a\n\t\t\tcontainer. For example, you specify two containers in a task definition with containerA\n\t\t\thaving a dependency on containerB reaching a COMPLETE,\n\t\t\tSUCCESS, or HEALTHY status. If a startTimeout\n\t\t\tvalue is specified for containerB and it doesn't reach the desired status within that\n\t\t\ttime then containerA gives up and not start. This results in the task transitioning to a\n\t\t\t\tSTOPPED state.
When the ECS_CONTAINER_START_TIMEOUT container agent configuration\n\t\t\t\tvariable is used, it's enforced independently from this start timeout value.
For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For tasks using the EC2 launch type, your container instances require at\n\t\t\tleast version 1.26.0 of the container agent to use a container start\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init\n\t\t\tpackage. If your container instances are launched from version 20190301 or\n\t\t\tlater, then they contain the required versions of the container agent and\n\t\t\t\tecs-init. For more information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The valid values for Fargate are 2-120 seconds.
" + "smithy.api#documentation": "Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For\n\t\t\texample, you specify two containers in a task definition with containerA having a dependency on\n\t\t\tcontainerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a\n\t\t\t\tstartTimeout value is specified for containerB and it doesn't reach the desired status\n\t\t\twithin that time then containerA gives up and not start. This results in the task transitioning to a\n\t\t\t\tSTOPPED state.
When the ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used,\n\t\t\t\tit's enforced independently from this start timeout value.
For tasks using the Fargate launch type, the task or service requires the following\n\t\t\tplatforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For tasks using the EC2 launch type, your container instances require at least version\n\t\t\t\t1.26.0 of the container agent to use a container start timeout value. However, we\n\t\t\trecommend using the latest container agent version. For information about checking your agent version\n\t\t\tand updating to the latest version, see Updating the Amazon ECS Container\n\t\t\t\tAgent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at\n\t\t\tleast version 1.26.0-1 of the ecs-init package. If your container instances\n\t\t\tare launched from version 20190301 or later, then they contain the required versions of\n\t\t\tthe container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
The valid values for Fargate are 2-120 seconds.
" } }, "stopTimeout": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "Time duration (in seconds) to wait before the container is forcefully killed if it\n\t\t\tdoesn't exit normally on its own.
\nFor tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For tasks that use the Fargate launch type, the max stop timeout value is 120 seconds and if the parameter is not specified, the\n\t\t\tdefault value of 30 seconds is used.
\nFor tasks that use the EC2 launch type, if the stopTimeout\n\t\t\tparameter isn't specified, the value set for the Amazon ECS container agent configuration\n\t\t\tvariable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the\n\t\t\t\tstopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT\n\t\t\tagent configuration variable are set, then the default values of 30 seconds for Linux\n\t\t\tcontainers and 30 seconds on Windows containers are used. Your container instances\n\t\t\trequire at least version 1.26.0 of the container agent to use a container stop timeout\n\t\t\tvalue. However, we recommend using the latest container agent version. For information\n\t\t\tabout checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The valid values for Fargate are 2-120 seconds.
" + "smithy.api#documentation": "Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit\n\t\t\tnormally on its own.
\nFor tasks using the Fargate launch type, the task or service requires the following\n\t\t\tplatforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For tasks that use the Fargate launch type, the max stop timeout value is 120 seconds and if the\n\t\t\tparameter is not specified, the default value of 30 seconds is used.
\nFor tasks that use the EC2 launch type, if the stopTimeout parameter isn't\n\t\t\tspecified, the value set for the Amazon ECS container agent configuration variable\n\t\t\t\tECS_CONTAINER_STOP_TIMEOUT is used. If neither the stopTimeout parameter\n\t\t\tor the ECS_CONTAINER_STOP_TIMEOUT agent configuration variable are set, then the default\n\t\t\tvalues of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container\n\t\t\tinstances require at least version 1.26.0 of the container agent to use a container stop timeout value.\n\t\t\tHowever, we recommend using the latest container agent version. For information about checking your\n\t\t\tagent version and updating to the latest version, see Updating the Amazon ECS Container\n\t\t\t\tAgent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at\n\t\t\tleast version 1.26.0-1 of the ecs-init package. If your container instances are launched\n\t\t\tfrom version 20190301 or later, then they contain the required versions of the container\n\t\t\tagent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
The valid values for Fargate are 2-120 seconds.
" } }, "hostname": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The hostname to use for your container. This parameter maps to Hostname\n\t\t\tin the docker container create command and the\n\t\t\t\t--hostname option to docker\n\t\t\t\trun.
The hostname parameter is not supported if you're using the\n\t\t\t\t\tawsvpc network mode.
The hostname to use for your container. This parameter maps to Hostname in the docker\n\t\t\tcontainer create command and the --hostname option to docker run.
The hostname parameter is not supported if you're using the awsvpc\n\t\t\t\tnetwork mode.
The user to use inside the container. This parameter maps to User in the docker container create command and the\n\t\t\t\t--user option to docker\n\t\t\trun.
When running tasks using the host network mode, don't run containers\n\t\t\t\tusing the root user (UID 0). We recommend using a non-root user for better\n\t\t\t\tsecurity.
You can specify the user using the following formats. If specifying a UID\n\t\t\tor GID, you must specify it as a positive integer.
\n user\n
\n user:group\n
\n uid\n
\n uid:gid\n
\n user:gid\n
\n uid:group\n
This parameter is not supported for Windows containers.
\nThe user to use inside the container. This parameter maps to User in the docker\n\t\t\tcontainer create command and the --user option to docker run.
When running tasks using the host network mode, don't run containers using the\n\t\t\t\troot user (UID 0). We recommend using a non-root user for better security.
You can specify the user using the following formats. If specifying a UID or GID, you\n\t\t\tmust specify it as a positive integer.
\n user\n
\n user:group\n
\n uid\n
\n uid:gid\n
\n user:gid\n
\n uid:group\n
This parameter is not supported for Windows containers.
\nThe working directory to run commands inside the container in. This parameter maps to\n\t\t\tWorkingDir in the docker container create command and the --workdir option to docker run.
The working directory to run commands inside the container in. This parameter maps to\n\t\t\t\tWorkingDir in the docker container create command and the --workdir\n\t\t\toption to docker run.
When this parameter is true, networking is off within the container. This parameter\n\t\t\tmaps to NetworkDisabled in the docker container create command.
This parameter is not supported for Windows containers.
\nWhen this parameter is true, networking is off within the container. This parameter maps to\n\t\t\t\tNetworkDisabled in the docker container create command.
This parameter is not supported for Windows containers.
\nWhen this parameter is true, the container is given elevated privileges on the host\n\t\t\tcontainer instance (similar to the root user). This parameter maps to\n\t\t\tPrivileged in the docker container create command and the --privileged option to docker run
This parameter is not supported for Windows containers or tasks run on Fargate.
\nWhen this parameter is true, the container is given elevated privileges on the host container\n\t\t\tinstance (similar to the root user). This parameter maps to Privileged in the\n\t\t\tdocker container create command and the --privileged option to docker run
This parameter is not supported for Windows containers or tasks run on Fargate.
\nWhen this parameter is true, the container is given read-only access to its root file\n\t\t\tsystem. This parameter maps to ReadonlyRootfs in the docker container create command and the\n\t\t\t\t--read-only option to docker\n\t\t\t\trun.
This parameter is not supported for Windows containers.
\nWhen this parameter is true, the container is given read-only access to its root file system. This\n\t\t\tparameter maps to ReadonlyRootfs in the docker container create command and the\n\t\t\t\t--read-only option to docker run.
This parameter is not supported for Windows containers.
\nA list of DNS servers that are presented to the container. This parameter maps to\n\t\t\tDns in the docker container create command and the --dns option to docker run.
This parameter is not supported for Windows containers.
\nA list of DNS servers that are presented to the container. This parameter maps to Dns in\n\t\t\tthe docker container create command and the --dns option to docker run.
This parameter is not supported for Windows containers.
\nA list of DNS search domains that are presented to the container. This parameter maps\n\t\t\tto DnsSearch in the docker container create command and the --dns-search option to docker run.
This parameter is not supported for Windows containers.
\nA list of DNS search domains that are presented to the container. This parameter maps to\n\t\t\t\tDnsSearch in the docker container create command and the --dns-search\n\t\t\toption to docker run.
This parameter is not supported for Windows containers.
\nA list of hostnames and IP address mappings to append to the /etc/hosts\n\t\t\tfile on the container. This parameter maps to ExtraHosts in the docker container create command and the\n\t\t\t\t--add-host option to docker\n\t\t\t\trun.
This parameter isn't supported for Windows containers or tasks that use the\n\t\t\t\t\tawsvpc network mode.
A list of hostnames and IP address mappings to append to the /etc/hosts file on the\n\t\t\tcontainer. This parameter maps to ExtraHosts in the docker container create command and\n\t\t\tthe --add-host option to docker run.
This parameter isn't supported for Windows containers or tasks that use the awsvpc\n\t\t\t\tnetwork mode.
A list of strings to provide custom configuration for multiple security systems. This field isn't valid for containers in tasks\n\t\t\tusing the Fargate launch type.
\nFor Linux tasks on EC2, this parameter can be used to reference custom\n\t\t\tlabels for SELinux and AppArmor multi-level security systems.
\nFor any tasks on EC2, this parameter can be used to reference a\n\t\t\tcredential spec file that configures a container for Active Directory authentication.\n\t\t\tFor more information, see Using gMSAs for Windows\n\t\t\t\tContainers and Using gMSAs for Linux\n\t\t\t\tContainers in the Amazon Elastic Container Service Developer Guide.
\nThis parameter maps to SecurityOpt in the docker container create command and the\n\t\t\t\t--security-opt option to docker\n\t\t\t\trun.
The Amazon ECS container agent running on a container instance must register with the\n\t\t\t\t\tECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true\n\t\t\t\tenvironment variables before containers placed on that instance can use these\n\t\t\t\tsecurity options. For more information, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.
Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" |\n\t\t\t\"credentialspec:CredentialSpecFilePath\"
" + "smithy.api#documentation": "A list of strings to provide custom configuration for multiple security systems. This field isn't\n\t\t\tvalid for containers in tasks using the Fargate launch type.
\nFor Linux tasks on EC2, this parameter can be used to reference custom labels for\n\t\t\tSELinux and AppArmor multi-level security systems.
\nFor any tasks on EC2, this parameter can be used to reference a credential spec file\n\t\t\tthat configures a container for Active Directory authentication. For more information, see Using gMSAs for\n\t\t\t\tWindows Containers and Using gMSAs for Linux Containers in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
\nThis parameter maps to SecurityOpt in the docker container create command and the\n\t\t\t\t--security-opt option to docker run.
The Amazon ECS container agent running on a container instance must register with the\n\t\t\t\t\tECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment\n\t\t\t\tvariables before containers placed on that instance can use these security options. For more\n\t\t\t\tinformation, see Amazon ECS Container Agent\n\t\t\t\t\tConfiguration in the Amazon Elastic Container Service Developer Guide.
Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" |\n\t\t\t\"credentialspec:CredentialSpecFilePath\"
" } }, "interactive": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "When this parameter is true, you can deploy containerized applications\n\t\t\tthat require stdin or a tty to be allocated. This parameter\n\t\t\tmaps to OpenStdin in the docker container create command and the --interactive option to docker run.
When this parameter is true, you can deploy containerized applications that require\n\t\t\t\tstdin or a tty to be allocated. This parameter maps to\n\t\t\t\tOpenStdin in the docker container create command and the --interactive\n\t\t\toption to docker run.
When this parameter is true, a TTY is allocated. This parameter maps to\n\t\t\tTty in the docker container create command and the --tty option to docker run.
When this parameter is true, a TTY is allocated. This parameter maps to Tty\n\t\t\tin the docker container create command and the --tty option to docker run.
A key/value map of labels to add to the container. This parameter maps to\n\t\t\tLabels in the docker container create command and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
A key/value map of labels to add to the container. This parameter maps to Labels in the\n\t\t\tdocker container create command and the --label option to docker run.\n\t\t\tThis parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
A list of ulimits to set in the container. If a ulimit value\n\t\t\tis specified in a task definition, it overrides the default values set by Docker. This\n\t\t\tparameter maps to Ulimits in the docker container create command and the --ulimit option to docker run. Valid naming values are displayed\n\t\t\tin the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default\n\t\t\t\t\t\t\tresource limit values set by the operating system with the exception of\n\t\t\t\t\t\t\tthe nofile resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The nofile resource limit sets a restriction on\n\t\t\t\t\t\t\tthe number of open files that a container can use. The default\n\t\t\t\t\t\t\t\tnofile soft limit is 65535 and the default hard limit\n\t\t\t\t\t\t\tis 65535.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
This parameter is not supported for Windows containers.
\nA list of ulimits to set in the container. If a ulimit value is specified\n\t\t\tin a task definition, it overrides the default values set by Docker. This parameter maps to\n\t\t\t\tUlimits in the docker container create command and the --ulimit option to\n\t\t\tdocker run. Valid naming values are displayed in the Ulimit data type.
Amazon ECS tasks hosted on Fargate use the default\n\t\t\t\t\t\t\tresource limit values set by the operating system with the exception of\n\t\t\t\t\t\t\tthe nofile resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The nofile resource limit sets a restriction on\n\t\t\t\t\t\t\tthe number of open files that a container can use. The default\n\t\t\t\t\t\t\t\tnofile soft limit is 65535 and the default hard limit\n\t\t\t\t\t\t\tis 65535.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
This parameter is not supported for Windows containers.
\nThe log configuration specification for the container.
\nThis parameter maps to LogConfig in the docker container create command and the\n\t\t\t\t--log-driver option to docker\n\t\t\t\trun. By default, containers use the same logging driver that the Docker\n\t\t\tdaemon uses. However the container can use a different logging driver than the Docker\n\t\t\tdaemon by specifying a log driver with this parameter in the container definition. To\n\t\t\tuse a different logging driver for a container, the log system must be configured\n\t\t\tproperly on the container instance (or on a different log server for remote logging\n\t\t\toptions).
Amazon ECS currently supports a subset of the logging drivers available to the Docker\n\t\t\t\tdaemon (shown in the LogConfiguration data type). Additional log\n\t\t\t\tdrivers may be available in future releases of the Amazon ECS container agent.
\nThis parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
The Amazon ECS container agent running on a container instance must register the\n\t\t\t\tlogging drivers available on that instance with the\n\t\t\t\t\tECS_AVAILABLE_LOGGING_DRIVERS environment variable before\n\t\t\t\tcontainers placed on that instance can use these log configuration options. For more\n\t\t\t\tinformation, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.
The log configuration specification for the container.
\nThis parameter maps to LogConfig in the docker container create command and the\n\t\t\t\t--log-driver option to docker run. By default, containers use the same logging driver\n\t\t\tthat the Docker daemon uses. However the container can use a different logging driver than the Docker\n\t\t\tdaemon by specifying a log driver with this parameter in the container definition. To use a different\n\t\t\tlogging driver for a container, the log system must be configured properly on the container instance\n\t\t\t(or on a different log server for remote logging options).
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in\n\t\t\t\tthe LogConfiguration data type). Additional log drivers may be available in future\n\t\t\t\treleases of the Amazon ECS container agent.
\nThis parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
The Amazon ECS container agent running on a container instance must register the logging drivers\n\t\t\t\tavailable on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable\n\t\t\t\tbefore containers placed on that instance can use these log configuration options. For more\n\t\t\t\tinformation, see Amazon ECS Container Agent\n\t\t\t\t\tConfiguration in the Amazon Elastic Container Service Developer Guide.
The container health check command and associated configuration parameters for the\n\t\t\tcontainer. This parameter maps to HealthCheck in the docker container create command and the\n\t\t\t\tHEALTHCHECK parameter of docker\n\t\t\t\trun.
The container health check command and associated configuration parameters for the container. This\n\t\t\tparameter maps to HealthCheck in the docker container create command and the\n\t\t\t\tHEALTHCHECK parameter of docker run.
A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\tSysctls in the docker container create command and the --sysctl option to docker run. For example, you can configure\n\t\t\t\tnet.ipv4.tcp_keepalive_time setting to maintain longer lived\n\t\t\tconnections.
A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the docker container create command and the --sysctl option to\n\t\t\tdocker run. For example, you can configure net.ipv4.tcp_keepalive_time setting to maintain\n\t\t\tlonger lived connections.
The type and amount of a resource to assign to a container. The only supported\n\t\t\tresource is a GPU.
" + "smithy.api#documentation": "The type and amount of a resource to assign to a container. The only supported resource is a\n\t\t\tGPU.
" } }, "firelensConfiguration": { "target": "com.amazonaws.ecs#FirelensConfiguration", "traits": { - "smithy.api#documentation": "The FireLens configuration for the container. This is used to specify and configure a\n\t\t\tlog router for container logs. For more information, see Custom Log Routing\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The FireLens configuration for the container. This is used to specify and configure a log router for\n\t\t\tcontainer logs. For more information, see Custom Log Routing in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "credentialSpecs": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec) file that\n\t\t\tconfigures the container for Active Directory authentication. We recommend that you use\n\t\t\tthis parameter instead of the dockerSecurityOptions. The maximum number of\n\t\t\tARNs is 1.
There are two formats for each ARN.
\nYou use credentialspecdomainless:MyARN to provide a\n\t\t\t\t\t\t\tCredSpec with an additional section for a secret in Secrets Manager.\n\t\t\t\t\t\tYou provide the login credentials to the domain in the secret.
Each task that runs on any container instance can join different\n\t\t\t\t\t\tdomains.
\nYou can use this format without joining the container instance to a\n\t\t\t\t\t\tdomain.
\nYou use credentialspec:MyARN to provide a\n\t\t\t\t\t\t\tCredSpec for a single domain.
You must join the container instance to the domain before you start any\n\t\t\t\t\t\ttasks that use this task definition.
\nIn both formats, replace MyARN with the ARN in SSM or Amazon S3.
If you provide a credentialspecdomainless:MyARN, the\n\t\t\t\tcredspec must provide a ARN in Secrets Manager for a secret containing the\n\t\t\tusername, password, and the domain to connect to. For better security, the instance\n\t\t\tisn't joined to the domain for domainless authentication. Other applications on the\n\t\t\tinstance can't use the domainless credentials. You can use this parameter to run tasks\n\t\t\ton the same instance, even it the tasks need to join different domains. For more\n\t\t\tinformation, see Using gMSAs for Windows\n\t\t\t\tContainers and Using gMSAs for Linux\n\t\t\t\tContainers.
A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec) file that configures the\n\t\t\tcontainer for Active Directory authentication. We recommend that you use this parameter instead of the\n\t\t\t\tdockerSecurityOptions. The maximum number of ARNs is 1.
There are two formats for each ARN.
\nYou use credentialspecdomainless:MyARN to provide a CredSpec\n\t\t\t\t\t\twith an additional section for a secret in Secrets Manager. You provide the login credentials to the\n\t\t\t\t\t\tdomain in the secret.
Each task that runs on any container instance can join different domains.
\nYou can use this format without joining the container instance to a domain.
\nYou use credentialspec:MyARN to provide a CredSpec for a single\n\t\t\t\t\t\tdomain.
You must join the container instance to the domain before you start any tasks that use\n\t\t\t\t\t\tthis task definition.
\nIn both formats, replace MyARN with the ARN in SSM or Amazon S3.
If you provide a credentialspecdomainless:MyARN, the credspec must provide\n\t\t\ta ARN in Secrets Manager for a secret containing the username, password, and the domain to connect to. For better\n\t\t\tsecurity, the instance isn't joined to the domain for domainless authentication. Other applications on\n\t\t\tthe instance can't use the domainless credentials. You can use this parameter to run tasks on the same\n\t\t\tinstance, even it the tasks need to join different domains. For more information, see Using gMSAs for\n\t\t\t\tWindows Containers and Using gMSAs for Linux\n\t\t\tContainers.
Container definitions are used in task definitions to describe the different\n\t\t\tcontainers that are launched as part of a task.
" + "smithy.api#documentation": "Container definitions are used in task definitions to describe the different containers that are\n\t\t\tlaunched as part of a task.
" } }, "com.amazonaws.ecs#ContainerDefinitions": { @@ -2562,13 +2562,13 @@ "condition": { "target": "com.amazonaws.ecs#ContainerCondition", "traits": { - "smithy.api#documentation": "The dependency condition of the container. The following are the available conditions\n\t\t\tand their behavior:
\n\n START - This condition emulates the behavior of links and\n\t\t\t\t\tvolumes today. It validates that a dependent container is started before\n\t\t\t\t\tpermitting other containers to start.
\n COMPLETE - This condition validates that a dependent\n\t\t\t\t\tcontainer runs to completion (exits) before permitting other containers to\n\t\t\t\t\tstart. This can be useful for nonessential containers that run a script and then\n\t\t\t\t\texit. This condition can't be set on an essential container.
\n SUCCESS - This condition is the same as\n\t\t\t\t\t\tCOMPLETE, but it also requires that the container exits with a\n\t\t\t\t\t\tzero status. This condition can't be set on an essential\n\t\t\t\t\tcontainer.
\n HEALTHY - This condition validates that the dependent\n\t\t\t\t\tcontainer passes its Docker health check before permitting other containers to\n\t\t\t\t\tstart. This requires that the dependent container has health checks configured.\n\t\t\t\t\tThis condition is confirmed only at task startup.
The dependency condition of the container. The following are the available conditions and their\n\t\t\tbehavior:
\n\n START - This condition emulates the behavior of links and volumes today.\n\t\t\t\t\tIt validates that a dependent container is started before permitting other containers to\n\t\t\t\t\tstart.
\n COMPLETE - This condition validates that a dependent container runs to\n\t\t\t\t\tcompletion (exits) before permitting other containers to start. This can be useful for\n\t\t\t\t\tnonessential containers that run a script and then exit. This condition can't be set on an\n\t\t\t\t\tessential container.
\n SUCCESS - This condition is the same as COMPLETE, but it also\n\t\t\t\t\trequires that the container exits with a zero status. This condition can't be set\n\t\t\t\t\ton an essential container.
\n HEALTHY - This condition validates that the dependent container passes its\n\t\t\t\t\tDocker health check before permitting other containers to start. This requires that the\n\t\t\t\t\tdependent container has health checks configured. This condition is confirmed only at task\n\t\t\t\t\tstartup.
The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.
\nYour Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tto use container dependencies. However, we recommend using the latest container agent\n\t\t\tversion. For information about checking your agent version and updating to the latest\n\t\t\tversion, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init package. If\n\t\t\tyour container instances are launched from version 20190301 or later, then\n\t\t\tthey contain the required versions of the container agent and ecs-init. For\n\t\t\tmore information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
For tasks that use the Fargate launch type, the task or service\n\t\t\t\trequires the following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For more information about how to create a container dependency, see Container dependency in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The dependencies defined for container startup and shutdown. A container can contain multiple\n\t\t\tdependencies. When a dependency is defined for container startup, for container shutdown it is\n\t\t\treversed.
\nYour Amazon ECS container instances require at least version 1.26.0 of the container agent to use\n\t\t\tcontainer dependencies. However, we recommend using the latest container agent version. For information\n\t\t\tabout checking your agent version and updating to the latest version, see Updating the Amazon ECS Container\n\t\t\t\tAgent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at\n\t\t\tleast version 1.26.0-1 of the ecs-init package. If your container instances are launched\n\t\t\tfrom version 20190301 or later, then they contain the required versions of the container\n\t\t\tagent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
For tasks that use the Fargate launch type, the task or service requires the\n\t\t\t\tfollowing platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For more information about how to create a container dependency, see Container dependency in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#ContainerImage": { @@ -2609,13 +2609,13 @@ "containerInstanceArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format,\n\t\t\tsee Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN)\n\t\t\tin the Amazon ECS Developer Guide.
" } }, "ec2InstanceId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2\n\t\t\tinstance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID.
" + "smithy.api#documentation": "The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 instance ID. For\n\t\t\texternal instances, this value is the Amazon Web Services Systems Manager managed instance ID.
" } }, "capacityProviderName": { @@ -2628,31 +2628,31 @@ "target": "com.amazonaws.ecs#Long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The version counter for the container instance. Every time a container instance\n\t\t\texperiences a change that triggers a CloudWatch event, the version counter is\n\t\t\tincremented. If you're replicating your Amazon ECS container instance state with CloudWatch\n\t\t\tEvents, you can compare the version of a container instance reported by the Amazon ECS APIs\n\t\t\twith the version reported in CloudWatch Events for the container instance (inside the\n\t\t\t\tdetail object) to verify that the version in your event stream is\n\t\t\tcurrent.
The version counter for the container instance. Every time a container instance experiences a change\n\t\t\tthat triggers a CloudWatch event, the version counter is incremented. If you're replicating your Amazon ECS\n\t\t\tcontainer instance state with CloudWatch Events, you can compare the version of a container instance\n\t\t\treported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance\n\t\t\t(inside the detail object) to verify that the version in your event stream is\n\t\t\tcurrent.
The version information for the Amazon ECS container agent and Docker daemon running on the\n\t\t\tcontainer instance.
" + "smithy.api#documentation": "The version information for the Amazon ECS container agent and Docker daemon running on the container\n\t\t\tinstance.
" } }, "remainingResources": { "target": "com.amazonaws.ecs#Resources", "traits": { - "smithy.api#documentation": "For CPU and memory resource types, this parameter describes the remaining CPU and\n\t\t\tmemory that wasn't already allocated to tasks and is therefore available for new tasks.\n\t\t\tFor port resource types, this parameter describes the ports that were reserved by the\n\t\t\tAmazon ECS container agent (at instance registration time) and any task containers that have\n\t\t\treserved port mappings on the host (with the host or bridge\n\t\t\tnetwork mode). Any port that's not specified here is available for new tasks.
For CPU and memory resource types, this parameter describes the remaining CPU and memory that wasn't\n\t\t\talready allocated to tasks and is therefore available for new tasks. For port resource types, this\n\t\t\tparameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration\n\t\t\ttime) and any task containers that have reserved port mappings on the host (with the host\n\t\t\tor bridge network mode). Any port that's not specified here is available for new\n\t\t\ttasks.
For CPU and memory resource types, this parameter describes the amount of each\n\t\t\tresource that was available on the container instance when the container agent\n\t\t\tregistered it with Amazon ECS. This value represents the total amount of CPU and memory that\n\t\t\tcan be allocated on this container instance to tasks. For port resource types, this\n\t\t\tparameter describes the ports that were reserved by the Amazon ECS container agent when it\n\t\t\tregistered the container instance with Amazon ECS.
" + "smithy.api#documentation": "For CPU and memory resource types, this parameter describes the amount of each resource that was\n\t\t\tavailable on the container instance when the container agent registered it with Amazon ECS. This value\n\t\t\trepresents the total amount of CPU and memory that can be allocated on this container instance to\n\t\t\ttasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS\n\t\t\tcontainer agent when it registered the container instance with Amazon ECS.
" } }, "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The status of the container instance. The valid values are REGISTERING,\n\t\t\t\tREGISTRATION_FAILED, ACTIVE, INACTIVE,\n\t\t\t\tDEREGISTERING, or DRAINING.
If your account has opted in to the awsvpcTrunking account setting, then\n\t\t\tany newly registered container instance will transition to a REGISTERING\n\t\t\tstatus while the trunk elastic network interface is provisioned for the instance. If the\n\t\t\tregistration fails, the instance will transition to a REGISTRATION_FAILED\n\t\t\tstatus. You can describe the container instance and see the reason for failure in the\n\t\t\t\tstatusReason parameter. Once the container instance is terminated, the\n\t\t\tinstance transitions to a DEREGISTERING status while the trunk elastic\n\t\t\tnetwork interface is deprovisioned. The instance then transitions to an\n\t\t\t\tINACTIVE status.
The ACTIVE status indicates that the container instance can accept tasks.\n\t\t\tThe DRAINING indicates that new tasks aren't placed on the container\n\t\t\tinstance and any service tasks running on the container instance are removed if\n\t\t\tpossible. For more information, see Container instance draining in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
The status of the container instance. The valid values are REGISTERING,\n\t\t\t\tREGISTRATION_FAILED, ACTIVE, INACTIVE,\n\t\t\t\tDEREGISTERING, or DRAINING.
If your account has opted in to the awsvpcTrunking account setting, then any newly\n\t\t\tregistered container instance will transition to a REGISTERING status while the trunk\n\t\t\telastic network interface is provisioned for the instance. If the registration fails, the instance will\n\t\t\ttransition to a REGISTRATION_FAILED status. You can describe the container instance and\n\t\t\tsee the reason for failure in the statusReason parameter. Once the container instance is\n\t\t\tterminated, the instance transitions to a DEREGISTERING status while the trunk elastic\n\t\t\tnetwork interface is deprovisioned. The instance then transitions to an INACTIVE\n\t\t\tstatus.
The ACTIVE status indicates that the container instance can accept tasks. The\n\t\t\t\tDRAINING indicates that new tasks aren't placed on the container instance and any\n\t\t\tservice tasks running on the container instance are removed if possible. For more information, see\n\t\t\t\tContainer instance draining in the Amazon Elastic Container Service Developer Guide.
This parameter returns true if the agent is connected to Amazon ECS. An\n\t\t\tinstance with an agent that may be unhealthy or stopped return false. Only\n\t\t\tinstances connected to an agent can accept task placement requests.
This parameter returns true if the agent is connected to Amazon ECS. An instance with an\n\t\t\tagent that may be unhealthy or stopped return false. Only instances connected to an agent\n\t\t\tcan accept task placement requests.
The number of tasks on the container instance that have a desired status\n\t\t\t\t(desiredStatus) of RUNNING.
The number of tasks on the container instance that have a desired status (desiredStatus)\n\t\t\tof RUNNING.
The number of tasks on the container instance that are in the PENDING\n\t\t\tstatus.
The number of tasks on the container instance that are in the PENDING status.
The status of the most recent agent update. If an update wasn't ever requested, this\n\t\t\tvalue is NULL.
The status of the most recent agent update. If an update wasn't ever requested, this value is\n\t\t\t\tNULL.
The attributes set for the container instance, either by the Amazon ECS container agent at\n\t\t\tinstance registration or manually with the PutAttributes\n\t\t\toperation.
" + "smithy.api#documentation": "The attributes set for the container instance, either by the Amazon ECS container agent at instance\n\t\t\tregistration or manually with the PutAttributes operation.
" } }, "registeredAt": { @@ -2703,13 +2703,13 @@ "attachments": { "target": "com.amazonaws.ecs#Attachments", "traits": { - "smithy.api#documentation": "The resources attached to a container instance, such as an elastic network\n\t\t\tinterface.
" + "smithy.api#documentation": "The resources attached to a container instance, such as an elastic network interface.
" } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the container instance to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
An Amazon EC2 or External instance that's running the Amazon ECS agent and has been registered\n\t\t\twith a cluster.
" + "smithy.api#documentation": "An Amazon EC2 or External instance that's running the Amazon ECS agent and has been registered with a\n\t\t\tcluster.
" } }, "com.amazonaws.ecs#ContainerInstanceField": { @@ -2752,13 +2752,13 @@ "overallStatus": { "target": "com.amazonaws.ecs#InstanceHealthCheckState", "traits": { - "smithy.api#documentation": "The overall health status of the container instance. This is an aggregate status of\n\t\t\tall container instance health checks.
" + "smithy.api#documentation": "The overall health status of the container instance. This is an aggregate status of all container\n\t\t\tinstance health checks.
" } }, "details": { "target": "com.amazonaws.ecs#InstanceHealthCheckResultList", "traits": { - "smithy.api#documentation": "An array of objects representing the details of the container instance health\n\t\t\tstatus.
" + "smithy.api#documentation": "An array of objects representing the details of the container instance health status.
" } } }, @@ -2813,54 +2813,54 @@ "name": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of the container that receives the override. This parameter is required if\n\t\t\tany override is specified.
" + "smithy.api#documentation": "The name of the container that receives the override. This parameter is required if any override is\n\t\t\tspecified.
" } }, "command": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "The command to send to the container that overrides the default command from the\n\t\t\tDocker image or the task definition. You must also specify a container name.
" + "smithy.api#documentation": "The command to send to the container that overrides the default command from the Docker image or the\n\t\t\ttask definition. You must also specify a container name.
" } }, "environment": { "target": "com.amazonaws.ecs#EnvironmentVariables", "traits": { - "smithy.api#documentation": "The environment variables to send to the container. You can add new environment\n\t\t\tvariables, which are added to the container at launch, or you can override the existing\n\t\t\tenvironment variables from the Docker image or the task definition. You must also\n\t\t\tspecify a container name.
" + "smithy.api#documentation": "The environment variables to send to the container. You can add new environment variables, which are\n\t\t\tadded to the container at launch, or you can override the existing environment variables from the\n\t\t\tDocker image or the task definition. You must also specify a container name.
" } }, "environmentFiles": { "target": "com.amazonaws.ecs#EnvironmentFiles", "traits": { - "smithy.api#documentation": "A list of files containing the environment variables to pass to a container, instead\n\t\t\tof the value from the container definition.
" + "smithy.api#documentation": "A list of files containing the environment variables to pass to a container, instead of the value\n\t\t\tfrom the container definition.
" } }, "cpu": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The number of cpu units reserved for the container, instead of the\n\t\t\tdefault value from the task definition. You must also specify a container name.
The number of cpu units reserved for the container, instead of the default value from\n\t\t\tthe task definition. You must also specify a container name.
The hard limit (in MiB) of memory to present to the container, instead of the default\n\t\t\tvalue from the task definition. If your container attempts to exceed the memory\n\t\t\tspecified here, the container is killed. You must also specify a container name.
" + "smithy.api#documentation": "The hard limit (in MiB) of memory to present to the container, instead of the default value from the\n\t\t\ttask definition. If your container attempts to exceed the memory specified here, the container is\n\t\t\tkilled. You must also specify a container name.
" } }, "memoryReservation": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The soft limit (in MiB) of memory to reserve for the container, instead of the default\n\t\t\tvalue from the task definition. You must also specify a container name.
" + "smithy.api#documentation": "The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the\n\t\t\ttask definition. You must also specify a container name.
" } }, "resourceRequirements": { "target": "com.amazonaws.ecs#ResourceRequirements", "traits": { - "smithy.api#documentation": "The type and amount of a resource to assign to a container, instead of the default\n\t\t\tvalue from the task definition. The only supported resource is a GPU.
" + "smithy.api#documentation": "The type and amount of a resource to assign to a container, instead of the default value from the\n\t\t\ttask definition. The only supported resource is a GPU.
" } } }, "traits": { - "smithy.api#documentation": "The overrides that are sent to a container. An empty container override can be passed\n\t\t\tin. An example of an empty container override is {\"containerOverrides\": [ ]\n\t\t\t\t}. If a non-empty container override is specified, the name\n\t\t\tparameter must be included.
You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the\n\t\t\tsensitive data. For more information, see Retrieve secrets through\n\t\t\t\tenvironment variables in the Amazon ECS Developer Guide.
" + "smithy.api#documentation": "The overrides that are sent to a container. An empty container override can be passed in. An example\n\t\t\tof an empty container override is {\"containerOverrides\": [ ] }. If a non-empty container\n\t\t\toverride is specified, the name parameter must be included.
You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the sensitive data. For\n\t\t\tmore information, see Retrieve secrets through environment\n\t\t\t\tvariables in the Amazon ECS Developer Guide.
" } }, "com.amazonaws.ecs#ContainerOverrides": { @@ -2875,25 +2875,25 @@ "enabled": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "Specifies whether a restart policy is enabled for the\n\t\t\tcontainer.
", + "smithy.api#documentation": "Specifies whether a restart policy is enabled for the container.
", "smithy.api#required": {} } }, "ignoredExitCodes": { "target": "com.amazonaws.ecs#IntegerList", "traits": { - "smithy.api#documentation": "A list of exit codes that Amazon ECS will ignore and not attempt a restart on. You can specify a maximum of 50 container exit\n\t\t\tcodes. By default, Amazon ECS does not ignore\n\t\t\tany exit codes.
" + "smithy.api#documentation": "A list of exit codes that Amazon ECS will ignore and not attempt a restart on. You can specify a maximum\n\t\t\tof 50 container exit codes. By default, Amazon ECS does not ignore any exit codes.
" } }, "restartAttemptPeriod": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "A period of time (in seconds) that the container must run for before a restart can be attempted. A container can be\n\t\t\trestarted only once every restartAttemptPeriod seconds. If a container isn't able to run for this time period and exits early, it will not be restarted. You can set a minimum\n\t\t\trestartAttemptPeriod of 60 seconds and a maximum restartAttemptPeriod of 1800 seconds.\n\t\t\tBy default, a container must run for 300 seconds before it can be restarted.
A period of time (in seconds) that the container must run for before a restart can be attempted. A\n\t\t\tcontainer can be restarted only once every restartAttemptPeriod seconds. If a container\n\t\t\tisn't able to run for this time period and exits early, it will not be restarted. You can set a minimum\n\t\t\t\trestartAttemptPeriod of 60 seconds and a maximum restartAttemptPeriod of\n\t\t\t1800 seconds. By default, a container must run for 300 seconds before it can be restarted.
You can enable a restart policy for each container defined in your\n\t\t\ttask definition, to overcome transient failures faster and maintain task availability. When you\n\t\t\tenable a restart policy for a container, Amazon ECS can restart the container if it exits, without needing to replace\n\t\t\tthe task. For more information, see Restart individual containers\n\t\t\t\tin Amazon ECS tasks with container restart policies in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "You can enable a restart policy for each container defined in your task definition, to overcome\n\t\t\ttransient failures faster and maintain task availability. When you enable a restart policy for a\n\t\t\tcontainer, Amazon ECS can restart the container if it exits, without needing to replace the task. For more\n\t\t\tinformation, see Restart individual containers\n\t\t\t\tin Amazon ECS tasks with container restart policies in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#ContainerStateChange": { @@ -2920,7 +2920,7 @@ "exitCode": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The exit code for the container, if the state change is a result of the container\n\t\t\texiting.
" + "smithy.api#documentation": "The exit code for the container, if the state change is a result of the container exiting.
" } }, "networkBindings": { @@ -2984,7 +2984,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new capacity provider. Capacity providers are associated with an Amazon ECS\n\t\t\tcluster and are used in capacity provider strategies to facilitate cluster auto\n\t\t\tscaling.
\nOnly capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on\n\t\t\tFargate use the FARGATE and FARGATE_SPOT capacity providers.\n\t\t\tThese providers are available to all accounts in the Amazon Web Services Regions that Fargate\n\t\t\tsupports.
Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used\n\t\t\tin capacity provider strategies to facilitate cluster auto scaling.
\nOnly capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use\n\t\t\tthe FARGATE and FARGATE_SPOT capacity providers. These providers are\n\t\t\tavailable to all accounts in the Amazon Web Services Regions that Fargate supports.
The name of the capacity provider. Up to 255 characters are allowed. They include\n\t\t\tletters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-).\n\t\t\tThe name can't be prefixed with \"aws\", \"ecs\", or\n\t\t\t\t\"fargate\".
The name of the capacity provider. Up to 255 characters are allowed. They include letters (both upper\n\t\t\tand lowercase letters), numbers, underscores (_), and hyphens (-). The name can't be prefixed with\n\t\t\t\t\"aws\", \"ecs\", or \"fargate\".
The metadata that you apply to the capacity provider to categorize and organize them\n\t\t\tmore conveniently. Each tag consists of a key and an optional value. You define both of\n\t\t\tthem.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the capacity provider to categorize and organize them more\n\t\t\tconveniently. Each tag consists of a key and an optional value. You define both of them.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Creates a new Amazon ECS cluster. By default, your account receives a default\n\t\t\tcluster when you launch your first container instance. However, you can create your own\n\t\t\tcluster with a unique name.
When you call the CreateCluster API operation, Amazon ECS attempts to\n\t\t\t\tcreate the Amazon ECS service-linked role for your account. This is so that it can manage\n\t\t\t\trequired resources in other Amazon Web Services services on your behalf. However, if the user that\n\t\t\t\tmakes the call doesn't have permissions to create the service-linked role, it isn't\n\t\t\t\tcreated. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
\nCreates a new Amazon ECS cluster. By default, your account receives a default cluster when\n\t\t\tyou launch your first container instance. However, you can create your own cluster with a unique\n\t\t\tname.
When you call the CreateCluster API operation,\n\t\t\t\tAmazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can\n\t\t\t\tmanage required resources in other Amazon Web Services services on your behalf. However, if the user that makes\n\t\t\t\tthe call doesn't have permissions to create the service-linked role, it isn't created. For more\n\t\t\t\tinformation, see Using service-linked\n\t\t\t\t\troles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
\nThe name of your cluster. If you don't specify a name for your cluster, you create a\n\t\t\tcluster that's named default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
The name of your cluster. If you don't specify a name for your cluster, you create a cluster that's\n\t\t\tnamed default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
The metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the cluster to help you categorize and organize them. Each tag\n\t\t\tconsists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The setting to use when creating a cluster. This parameter is used to turn on CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it overrides the\n\t\t\tcontainerInsights value set with PutAccountSetting or\n\t\t\tPutAccountSettingDefault.
The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights\n\t\t\tfor a cluster. If this value is specified, it overrides the containerInsights value set\n\t\t\twith PutAccountSetting or PutAccountSettingDefault.
The short name of one or more capacity providers to associate with the cluster. A\n\t\t\tcapacity provider must be associated with a cluster before it can be included as part of\n\t\t\tthe default capacity provider strategy of the cluster or used in a capacity provider\n\t\t\tstrategy when calling the CreateService or\n\t\t\t\tRunTask actions.
\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must be created but not associated with another cluster. New Auto Scaling group\n\t\t\tcapacity providers can be created with the CreateCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutCapacityProvider API operation is used to update the list of available\n\t\t\tcapacity providers for a cluster after the cluster is created.
" + "smithy.api#documentation": "The short name of one or more capacity providers to associate with the cluster. A capacity provider\n\t\t\tmust be associated with a cluster before it can be included as part of the default capacity provider\n\t\t\tstrategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.
\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be\n\t\t\tcreated but not associated with another cluster. New Auto Scaling group capacity providers can be\n\t\t\tcreated with the CreateCapacityProvider\n\t\t\tAPI operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are available to all\n\t\t\taccounts and only need to be associated with a cluster to be used.
The PutCapacityProvider API operation is used to update the list of available capacity\n\t\t\tproviders for a cluster after the cluster is created.
" } }, "defaultCapacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "The capacity provider strategy to set as the default for the cluster. After a default\n\t\t\tcapacity provider strategy is set for a cluster, when you call the CreateService or RunTask APIs with no\n\t\t\tcapacity provider strategy or launch type specified, the default capacity provider\n\t\t\tstrategy for the cluster is used.
\nIf a default capacity provider strategy isn't defined for a cluster when it was\n\t\t\tcreated, it can be defined later with the PutClusterCapacityProviders\n\t\t\tAPI operation.
" + "smithy.api#documentation": "The capacity provider strategy to set as the default for the cluster. After a default capacity\n\t\t\tprovider strategy is set for a cluster, when you call the CreateService or RunTask APIs with\n\t\t\tno capacity provider strategy or launch type specified, the default capacity provider strategy for the\n\t\t\tcluster is used.
\nIf a default capacity provider strategy isn't defined for a cluster when it was created, it can be\n\t\t\tdefined later with the PutClusterCapacityProviders API operation.
" } }, "serviceConnectDefaults": { @@ -3177,7 +3177,7 @@ } ], "traits": { - "smithy.api#documentation": "Runs and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the desiredCount,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, see the UpdateService action.
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.
\nAmazon Elastic Inference (EI) is no longer available to customers.
\nIn addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
\nYou can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. volumeConfigurations is only supported for REPLICA\n\t\t\tservice and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
Tasks for services that don't use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING state and are reported as\n\t\t\thealthy by the load balancer.
There are two service scheduler strategies available:
\n\n REPLICA - The replica scheduling strategy places and\n\t\t\t\t\tmaintains your desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
\n DAEMON - The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks. It also stops tasks\n\t\t\t\t\tthat don't meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.
If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.
If a service uses either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state.\n\t\t\tThis is while the container instances are in the DRAINING state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement. For\n\t\t\tinformation about task placement and task placement strategies, see Amazon ECS\n\t\t\t\ttask placement in the Amazon Elastic Container Service Developer Guide\n
", + "smithy.api#documentation": "Runs and maintains your desired number of tasks from a specified task definition. If the number of\n\t\t\ttasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the\n\t\t\ttask in the specified cluster. To update an existing service, use UpdateService.
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.
\nAmazon Elastic Inference (EI) is no longer available to customers.
\nIn addition to maintaining the desired count of tasks in your service, you can optionally run your\n\t\t\tservice behind one or more load balancers. The load balancers distribute traffic across the tasks that\n\t\t\tare associated with the service. For more information, see Service load\n\t\t\t\tbalancing in the Amazon Elastic Container Service Developer Guide.
\nYou can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a\n\t\t\tservice. volumeConfigurations is only supported for REPLICA service and not DAEMON\n\t\t\tservice. For more infomation, see Amazon EBS\n\t\t\t\tvolumes in the Amazon Elastic Container Service Developer Guide.
Tasks for services that don't use a load balancer are considered healthy if they're in the\n\t\t\t\tRUNNING state. Tasks for services that use a load balancer are considered healthy if\n\t\t\tthey're in the RUNNING state and are reported as healthy by the load balancer.
There are two service scheduler strategies available:
\n\n REPLICA - The replica scheduling strategy places and maintains your\n\t\t\t\t\tdesired number of tasks across your cluster. By default, the service scheduler spreads tasks\n\t\t\t\t\tacross Availability Zones. You can use task placement strategies and constraints to customize\n\t\t\t\t\ttask placement decisions. For more information, see Service\n\t\t\t\t\t\tscheduler concepts in the Amazon Elastic Container Service Developer Guide.
\n DAEMON - The daemon scheduling strategy deploys exactly one task on each\n\t\t\t\t\tactive container instance that meets all of the task placement constraints that you specify in\n\t\t\t\t\tyour cluster. The service scheduler also evaluates the task placement constraints for running\n\t\t\t\t\ttasks. It also stops tasks that don't meet the placement constraints. When using this strategy,\n\t\t\t\t\tyou don't need to specify a desired number of tasks, a task placement strategy, or use Service\n\t\t\t\t\tAuto Scaling policies. For more information, see Service\n\t\t\t\t\t\tscheduler concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is initiated\n\t\t\tby changing properties. For example, the deployment might be initiated by the task definition or by\n\t\t\tyour desired count of a service. You can use UpdateService. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service for\n\t\t\t\tminimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy percent represents\n\t\t\ta lower limit on the number of tasks in a service that must remain in the RUNNING state\n\t\t\tduring a deployment. Specifically, it represents it as a percentage of your desired number of tasks\n\t\t\t(rounded up to the nearest integer). This happens when any of your container instances are in the\n\t\t\t\tDRAINING state if the service contains tasks using the EC2 launch type.\n\t\t\tUsing this parameter, you can deploy without using additional cluster capacity. For example, if you set\n\t\t\tyour service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler\n\t\t\tmight stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in\n\t\t\tthe RUNNING state, tasks for services that don't use a load balancer are considered\n\t\t\thealthy . If they're in the RUNNING state and reported as healthy by the load balancer,\n\t\t\ttasks for services that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.
If a service uses the ECS deployment controller, the maximum\n\t\t\t\tpercent parameter represents an upper limit on the number of tasks in a service that are\n\t\t\tallowed in the RUNNING or PENDING state during a deployment. Specifically, it\n\t\t\trepresents it as a percentage of the desired number of tasks (rounded down to the nearest integer).\n\t\t\tThis happens when any of your container instances are in the DRAINING state if the service\n\t\t\tcontains tasks using the EC2 launch type. Using this parameter, you can define the\n\t\t\tdeployment batch size. For example, if your service has a desired number of four tasks and a maximum\n\t\t\tpercent value of 200%, the scheduler may start four new tasks before stopping the four older tasks\n\t\t\t(provided that the cluster resources required to do this are available). The default value for maximum\n\t\t\tpercent is 200%.
If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller\n\t\t\ttypes and tasks that use the EC2 launch type, the minimum healthy\n\t\t\t\tpercent and maximum percent values are used only to\n\t\t\tdefine the lower and upper limit on the number of the tasks in the service that remain in the\n\t\t\t\tRUNNING state. This is while the container instances are in the DRAINING\n\t\t\tstate. If the tasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're currently visible when\n\t\t\tdescribing your service.
When creating a service that uses the EXTERNAL deployment controller, you can specify\n\t\t\tonly parameters that aren't controlled at the task set level. The only required parameter is the\n\t\t\tservice name. You control your services using the CreateTaskSet. For more information, see Amazon ECS deployment\n\t\t\t\ttypes in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement. For information about\n\t\t\ttask placement and task placement strategies, see Amazon ECS task\n\t\t\t\tplacement in the Amazon Elastic Container Service Developer Guide\n
", "smithy.api#examples": [ { "title": "To create a new service", @@ -3299,32 +3299,32 @@ "serviceName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within\n\t\t\ta cluster, but you can have similarly named services in multiple clusters within a\n\t\t\tRegion or across multiple Regions.
", + "smithy.api#documentation": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but\n\t\t\tyou can have similarly named services in multiple clusters within a Region or across multiple\n\t\t\tRegions.
", "smithy.api#required": {} } }, "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision\n\t\t\tisn't specified, the latest ACTIVE revision is used.
A task definition must be specified if the service uses either the ECS or\n\t\t\t\tCODE_DEPLOY deployment controllers.
For more information about deployment types, see Amazon ECS deployment\n\t\t\t\ttypes.
" + "smithy.api#documentation": "The family and revision (family:revision) or full ARN of the\n\t\t\ttask definition to run in your service. If a revision isn't specified, the latest\n\t\t\t\tACTIVE revision is used.
A task definition must be specified if the service uses either the ECS or\n\t\t\t\tCODE_DEPLOY deployment controllers.
For more information about deployment types, see Amazon ECS deployment types.
" } }, "loadBalancers": { "target": "com.amazonaws.ecs#LoadBalancers", "traits": { - "smithy.api#documentation": "A load balancer object representing the load balancers to use with your service. For\n\t\t\tmore information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
\nIf the service uses the rolling update (ECS) deployment controller and\n\t\t\tusing either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach\n\t\t\tto the service. The service-linked role is required for services that use multiple\n\t\t\ttarget groups. For more information, see Using service-linked roles for Amazon ECS in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
If the service uses the CODE_DEPLOY deployment controller, the service is\n\t\t\trequired to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you\n\t\t\tspecify two target groups (referred to as a targetGroupPair). During a\n\t\t\tdeployment, CodeDeploy determines which task set in your service has the status\n\t\t\t\tPRIMARY, and it associates one target group with it. Then, it also\n\t\t\tassociates the other target group with the replacement task set. The load balancer can\n\t\t\talso have up to two listeners: a required listener for production traffic and an\n\t\t\toptional listener that you can use to perform validation tests with Lambda functions\n\t\t\tbefore routing production traffic to it.
If you use the CODE_DEPLOY deployment controller, these values can be\n\t\t\tchanged when updating the service.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,\n\t\t\tthe container name, and the container port to access from the load balancer. The\n\t\t\tcontainer name must be as it appears in a container definition. The load balancer name\n\t\t\tparameter must be omitted. When a task from this service is placed on a container\n\t\t\tinstance, the container instance and port combination is registered as a target in the\n\t\t\ttarget group that's specified here.
\nFor Classic Load Balancers, this object must contain the load balancer name, the container name , and\n\t\t\tthe container port to access from the load balancer. The container name must be as it\n\t\t\tappears in a container definition. The target group ARN parameter must be omitted.\n\t\t\tWhen a task from this service is placed on a container instance, the container instance\n\t\t\tis registered with the load balancer that's specified here.
\nServices with tasks that use the awsvpc network mode (for example, those\n\t\t\twith the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers\n\t\t\taren't supported. Also, when you create any target groups for these services, you must\n\t\t\tchoose ip as the target type, not instance. This is because\n\t\t\ttasks that use the awsvpc network mode are associated with an elastic\n\t\t\tnetwork interface, not an Amazon EC2 instance.
A load balancer object representing the load balancers to use with your service. For more\n\t\t\tinformation, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
\nIf the service uses the rolling update (ECS) deployment controller and using either an\n\t\t\tApplication Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The\n\t\t\tservice-linked role is required for services that use multiple target groups. For more information, see\n\t\t\t\tUsing service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If the service uses the CODE_DEPLOY deployment controller, the service is required to\n\t\t\tuse either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups\n\t\t\t(referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set\n\t\t\tin your service has the status PRIMARY, and it associates one target group with it. Then,\n\t\t\tit also associates the other target group with the replacement task set. The load balancer can also\n\t\t\thave up to two listeners: a required listener for production traffic and an optional listener that you\n\t\t\tcan use to perform validation tests with Lambda functions before routing production traffic to\n\t\t\tit.
If you use the CODE_DEPLOY deployment controller, these values can be changed when\n\t\t\tupdating the service.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container\n\t\t\tname, and the container port to access from the load balancer. The container name must be as it appears\n\t\t\tin a container definition. The load balancer name parameter must be omitted. When a task from this\n\t\t\tservice is placed on a container instance, the container instance and port combination is registered as\n\t\t\ta target in the target group that's specified here.
\nFor Classic Load Balancers, this object must contain the load balancer name, the container name , and the container\n\t\t\tport to access from the load balancer. The container name must be as it appears in a container\n\t\t\tdefinition. The target group ARN parameter must be omitted. When a task from this service is placed\n\t\t\ton a container instance, the container instance is registered with the load balancer that's specified\n\t\t\there.
\nServices with tasks that use the awsvpc network mode (for example, those with the\n\t\t\tFargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers aren't supported. Also, when\n\t\t\tyou create any target groups for these services, you must choose ip as the target type,\n\t\t\tnot instance. This is because tasks that use the awsvpc network mode are\n\t\t\tassociated with an elastic network interface, not an Amazon EC2 instance.
The details of the service discovery registry to associate with this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.
\nEach service may be associated with one service registry. Multiple service\n\t\t\t\tregistries for each service isn't supported.
\nThe details of the service discovery registry to associate with this service. For more information,\n\t\t\tsee Service\n\t\t\t\tdiscovery.
\nEach service may be associated with one service registry. Multiple service registries for each\n\t\t\t\tservice isn't supported.
\nThe number of instantiations of the specified task definition to place and keep\n\t\t\trunning in your service.
\nThis is required if schedulingStrategy is REPLICA or isn't\n\t\t\tspecified. If schedulingStrategy is DAEMON then this isn't\n\t\t\trequired.
The number of instantiations of the specified task definition to place and keep running in your\n\t\t\tservice.
\nThis is required if schedulingStrategy is REPLICA or isn't specified. If\n\t\t\t\tschedulingStrategy is DAEMON then this isn't required.
The infrastructure that you run your service on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
\nThe FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.
Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the Amazon ECS\n\t\t\t\t\tDeveloper Guide.
\nThe EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.
The EXTERNAL launch type runs your tasks on your on-premises server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.
A service can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.
The infrastructure that you run your service on. For more information, see Amazon ECS launch\n\t\t\t\ttypes in the Amazon Elastic Container Service Developer Guide.
\nThe FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used.\n\t\t\t\tFor more information, see Fargate capacity providers in the Amazon ECS Developer Guide.
\nThe EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.
The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine\n\t\t\t(VM) capacity registered to your cluster.
A service can use either a launch type or a capacity provider strategy. If a launchType\n\t\t\tis specified, the capacityProviderStrategy parameter must be omitted.
The capacity provider strategy to use for the service.
\nIf a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.
A capacity provider strategy may contain a maximum of 6 capacity providers.
" + "smithy.api#documentation": "The capacity provider strategy to use for the service.
\nIf a capacityProviderStrategy is specified, the launchType parameter must\n\t\t\tbe omitted. If no capacityProviderStrategy or launchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.
A capacity provider strategy may contain a maximum of 6 capacity providers.
" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The platform version that your tasks in the service are running on. A platform version\n\t\t\tis specified only for tasks using the Fargate launch type. If one isn't\n\t\t\tspecified, the LATEST platform version is used. For more information, see\n\t\t\t\tFargate platform\n\t\t\t\tversions in the Amazon Elastic Container Service Developer Guide.
The platform version that your tasks in the service are running on. A platform version is specified\n\t\t\tonly for tasks using the Fargate launch type. If one isn't specified, the\n\t\t\t\tLATEST platform version is used. For more information, see Fargate platform versions in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your\n\t\t\tload balancer on your behalf. This parameter is only permitted if you are using a load\n\t\t\tbalancer with your service and your task definition doesn't use the awsvpc\n\t\t\tnetwork mode. If you specify the role parameter, you must also specify a\n\t\t\tload balancer object with the loadBalancers parameter.
If your account has already created the Amazon ECS service-linked role, that role is\n\t\t\t\tused for your service unless you specify a role here. The service-linked role is\n\t\t\t\trequired if your task definition uses the awsvpc network mode or if the\n\t\t\t\tservice is configured to use service discovery, an external deployment controller,\n\t\t\t\tmultiple target groups, or Elastic Inference accelerators in which case you don't\n\t\t\t\tspecify a role here. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /, then you must either\n\t\t\tspecify the full role ARN (this is recommended) or prefix the role name with the path.\n\t\t\tFor example, if a role with the name bar has a path of /foo/\n\t\t\tthen you would specify /foo/bar as the role name. For more information, see\n\t\t\t\tFriendly names and paths in the IAM User\n\t\t\tGuide.
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on\n\t\t\tyour behalf. This parameter is only permitted if you are using a load balancer with your service and\n\t\t\tyour task definition doesn't use the awsvpc network mode. If you specify the\n\t\t\t\trole parameter, you must also specify a load balancer object with the\n\t\t\t\tloadBalancers parameter.
If your account has already created the Amazon ECS service-linked role, that role is used for your\n\t\t\t\tservice unless you specify a role here. The service-linked role is required if your task definition\n\t\t\t\tuses the awsvpc network mode or if the service is configured to use service discovery,\n\t\t\t\tan external deployment controller, multiple target groups, or Elastic Inference accelerators in\n\t\t\t\twhich case you don't specify a role here. For more information, see Using service-linked\n\t\t\t\t\troles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /, then you must either specify the full\n\t\t\trole ARN (this is recommended) or prefix the role name with the path. For example, if a role with the\n\t\t\tname bar has a path of /foo/ then you would specify /foo/bar as\n\t\t\tthe role name. For more information, see Friendly names and\n\t\t\t\tpaths in the IAM User Guide.
Optional deployment parameters that control how many tasks run during the deployment and the\n\t\t\tfailure detection methods.
" + "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment and the ordering\n\t\t\tof stopping and starting tasks.
" } }, "placementConstraints": { "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { - "smithy.api#documentation": "An array of placement constraint objects to use for tasks in your service. You can\n\t\t\tspecify a maximum of 10 constraints for each task. This limit includes constraints in\n\t\t\tthe task definition and those specified at runtime.
" + "smithy.api#documentation": "An array of placement constraint objects to use for tasks in your service. You can specify a maximum\n\t\t\tof 10 constraints for each task. This limit includes constraints in the task definition and those\n\t\t\tspecified at runtime.
" } }, "placementStrategy": { "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { - "smithy.api#documentation": "The placement strategy objects to use for tasks in your service. You can specify a\n\t\t\tmaximum of 5 strategy rules for each service.
" + "smithy.api#documentation": "The placement strategy objects to use for tasks in your service. You can specify a maximum of 5\n\t\t\tstrategy rules for each service.
" } }, "networkConfiguration": { "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { - "smithy.api#documentation": "The network configuration for the service. This parameter is required for task\n\t\t\tdefinitions that use the awsvpc network mode to receive their own elastic\n\t\t\tnetwork interface, and it isn't supported for other network modes. For more information,\n\t\t\tsee Task networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The network configuration for the service. This parameter is required for task definitions that use\n\t\t\tthe awsvpc network mode to receive their own elastic network interface, and it isn't\n\t\t\tsupported for other network modes. For more information, see Task networking in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing target health checks after a task has first started. This is only used when your\n\t\t\tservice is configured to use a load balancer. If your service has a load balancer\n\t\t\tdefined and you don't specify a health check grace period value, the default value of\n\t\t\t\t0 is used.
If you do not use an Elastic Load Balancing, we recommend that you use the startPeriod in\n\t\t\tthe task definition health check parameters. For more information, see Health\n\t\t\t\tcheck.
If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can\n\t\t\tspecify a health check grace period of up to 2,147,483,647 seconds (about 69 years).\n\t\t\tDuring that time, the Amazon ECS service scheduler ignores health check status. This grace\n\t\t\tperiod can prevent the service scheduler from marking tasks as unhealthy and stopping\n\t\t\tthem before they have time to come up.
" + "smithy.api#documentation": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container \n\t\t\thealth checks after a task has first started. If you don't specify a health check grace\n\t\t\tperiod value, the default value of 0 is used. If you don't use any of the health checks, \n\t\t\tthen healthCheckGracePeriodSeconds is unused.
If your service's tasks take a while to start and respond to health checks, you can specify a\n\t\t\thealth check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS\n\t\t\tservice scheduler ignores health check status. This grace period can prevent the service scheduler from\n\t\t\tmarking tasks as unhealthy and stopping them before they have time to come up.
" } }, "schedulingStrategy": { "target": "com.amazonaws.ecs#SchedulingStrategy", "traits": { - "smithy.api#documentation": "The scheduling strategy to use for the service. For more information, see Services.
\nThere are two service scheduler strategies available:
\n\n REPLICA-The replica scheduling strategy places and\n\t\t\t\t\tmaintains the desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. This\n\t\t\t\t\tscheduler strategy is required if the service uses the CODE_DEPLOY\n\t\t\t\t\tor EXTERNAL deployment controller types.
\n DAEMON-The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks and will stop tasks\n\t\t\t\t\tthat don't meet the placement constraints. When you're using this strategy, you\n\t\t\t\t\tdon't need to specify a desired number of tasks, a task placement strategy, or\n\t\t\t\t\tuse Service Auto Scaling policies.
Tasks using the Fargate launch type or the\n\t\t\t\t\t\t\tCODE_DEPLOY or EXTERNAL deployment controller\n\t\t\t\t\t\ttypes don't support the DAEMON scheduling strategy.
The scheduling strategy to use for the service. For more information, see Services.
\nThere are two service scheduler strategies available:
\n\n REPLICA-The replica scheduling strategy places and maintains the desired\n\t\t\t\t\tnumber of tasks across your cluster. By default, the service scheduler spreads tasks across\n\t\t\t\t\tAvailability Zones. You can use task placement strategies and constraints to customize task\n\t\t\t\t\tplacement decisions. This scheduler strategy is required if the service uses the\n\t\t\t\t\t\tCODE_DEPLOY or EXTERNAL deployment controller types.
\n DAEMON-The daemon scheduling strategy deploys exactly one task on each\n\t\t\t\t\tactive container instance that meets all of the task placement constraints that you specify in\n\t\t\t\t\tyour cluster. The service scheduler also evaluates the task placement constraints for running\n\t\t\t\t\ttasks and will stop tasks that don't meet the placement constraints. When you're using this\n\t\t\t\t\tstrategy, you don't need to specify a desired number of tasks, a task placement strategy, or\n\t\t\t\t\tuse Service Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY or\n\t\t\t\t\t\t\tEXTERNAL deployment controller types don't support the DAEMON\n\t\t\t\t\t\tscheduling strategy.
The deployment controller to use for the service. If no deployment controller is\n\t\t\tspecified, the default value of ECS is used.
The deployment controller to use for the service. If no deployment controller is specified, the\n\t\t\tdefault value of ECS is used.
The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define. When a\n\t\t\tservice is deleted, the tags are deleted as well.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the service to help you categorize and organize them. Each tag\n\t\t\tconsists of a key and an optional value, both of which you define. When a service is deleted, the tags\n\t\t\tare deleted as well.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For\n\t\t\tmore information, see Tagging your Amazon ECS\n\t\t\t\tresources in the Amazon Elastic Container Service Developer Guide.
\nWhen you use Amazon ECS managed tags, you need to set the propagateTags\n\t\t\trequest parameter.
Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more\n\t\t\tinformation, see Tagging your Amazon ECS resources in the Amazon Elastic Container Service Developer Guide.
\nWhen you use Amazon ECS managed tags, you need to set the propagateTags request\n\t\t\tparameter.
Specifies whether to propagate the tags from the task definition to the task. If no\n\t\t\tvalue is specified, the tags aren't propagated. Tags can only be propagated to the task\n\t\t\tduring task creation. To add tags to a task after task creation, use the TagResource API action.
\nYou must set this to a value other than NONE when you use Cost Explorer.\n\t\t\tFor more information, see Amazon ECS usage reports\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The default is NONE.
Specifies whether to propagate the tags from the task definition to the task. If no value is\n\t\t\tspecified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To\n\t\t\tadd tags to a task after task creation, use the TagResource API action.
\nYou must set this to a value other than NONE when you use Cost Explorer. For more\n\t\t\tinformation, see Amazon ECS usage reports in the Amazon Elastic Container Service Developer Guide.
The default is NONE.
Determines whether the execute command functionality is turned on for the service. If\n\t\t\t\ttrue, this enables execute command functionality on all containers in\n\t\t\tthe service tasks.
Determines whether the execute command functionality is turned on for the service. If\n\t\t\t\ttrue, this enables execute command functionality on all containers in the service\n\t\t\ttasks.
The configuration for a volume specified in the task definition as a volume that is\n\t\t\tconfigured at launch time. Currently, the only supported volume type is an Amazon EBS\n\t\t\tvolume.
" + "smithy.api#documentation": "The configuration for a volume specified in the task definition as a volume that is configured at\n\t\t\tlaunch time. Currently, the only supported volume type is an Amazon EBS volume.
" + } + }, + "vpcLatticeConfigurations": { + "target": "com.amazonaws.ecs#VpcLatticeConfigurations", + "traits": { + "smithy.api#documentation": "The VPC Lattice configuration for the service being created.
" } } }, @@ -3448,7 +3454,7 @@ "service": { "target": "com.amazonaws.ecs#Service", "traits": { - "smithy.api#documentation": "The full description of your service following the create call.
\nA service will return either a capacityProviderStrategy or\n\t\t\t\tlaunchType parameter, but not both, depending where one was specified\n\t\t\twhen it was created.
If a service is using the ECS deployment controller, the\n\t\t\t\tdeploymentController and taskSets parameters will not be\n\t\t\treturned.
if the service uses the CODE_DEPLOY deployment controller, the\n\t\t\t\tdeploymentController, taskSets and\n\t\t\t\tdeployments parameters will be returned, however the\n\t\t\t\tdeployments parameter will be an empty list.
The full description of your service following the create call.
\nA service will return either a capacityProviderStrategy or launchType\n\t\t\tparameter, but not both, depending where one was specified when it was created.
If a service is using the ECS deployment controller, the\n\t\t\t\tdeploymentController and taskSets parameters will not be returned.
if the service uses the CODE_DEPLOY deployment controller, the\n\t\t\t\tdeploymentController, taskSets and deployments parameters\n\t\t\twill be returned, however the deployments parameter will be an empty list.
Create a task set in the specified cluster and service. This is used when a service\n\t\t\tuses the EXTERNAL deployment controller type. For more information, see\n\t\t\t\tAmazon ECS deployment\n\t\t\t\ttypes in the Amazon Elastic Container Service Developer Guide.
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.
\nFor information about the maximum number of task sets and other quotas, see Amazon ECS\n\t\t\tservice quotas in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Create a task set in the specified cluster and service. This is used when a service uses the\n\t\t\t\tEXTERNAL deployment controller type. For more information, see Amazon ECS deployment\n\t\t\t\ttypes in the Amazon Elastic Container Service Developer Guide.
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.
\nFor information about the maximum number of task sets and other quotas, see Amazon ECS service\n\t\t\t\tquotas in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#CreateTaskSetRequest": { @@ -3516,20 +3522,20 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the\n\t\t\ttask set in.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set\n\t\t\tin.
", "smithy.api#required": {} } }, "externalId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "An optional non-unique tag that identifies this task set in external systems. If the\n\t\t\ttask set is associated with a service discovery registry, the tasks in this task set\n\t\t\twill have the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the provided\n\t\t\tvalue.
An optional non-unique tag that identifies this task set in external systems. If the task set is\n\t\t\tassociated with a service discovery registry, the tasks in this task set will have the\n\t\t\t\tECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the provided\n\t\t\tvalue.
The task definition for the tasks in the task set to use. If a revision isn't\n\t\t\tspecified, the latest ACTIVE revision is used.
The task definition for the tasks in the task set to use. If a revision isn't specified, the latest\n\t\t\t\tACTIVE revision is used.
A load balancer object representing the load balancer to use with the task set. The\n\t\t\tsupported load balancer types are either an Application Load Balancer or a Network Load Balancer.
" + "smithy.api#documentation": "A load balancer object representing the load balancer to use with the task set. The supported load\n\t\t\tbalancer types are either an Application Load Balancer or a Network Load Balancer.
" } }, "serviceRegistries": { "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { - "smithy.api#documentation": "The details of the service discovery registries to assign to this task set. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.
" + "smithy.api#documentation": "The details of the service discovery registries to assign to this task set. For more information, see\n\t\t\t\tService\n\t\t\t\tdiscovery.
" } }, "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "The launch type that new tasks in the task set uses. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
\nIf a launchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.
The launch type that new tasks in the task set uses. For more information, see Amazon ECS launch\n\t\t\t\ttypes in the Amazon Elastic Container Service Developer Guide.
\nIf a launchType is specified, the capacityProviderStrategy parameter must\n\t\t\tbe omitted.
The capacity provider strategy to use for the task set.
\nA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders\n\t\t\t\t API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.
If a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProviderProviderAPI operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.
" + "smithy.api#documentation": "The capacity provider strategy to use for the task set.
\nA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider must be associated\n\t\t\twith the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.\n\t\t\tOnly capacity providers with an ACTIVE or UPDATING status can be used.
If a capacityProviderStrategy is specified, the launchType parameter must\n\t\t\tbe omitted. If no capacityProviderStrategy or launchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already\n\t\t\tbe created. New capacity providers can be created with the CreateCapacityProviderProviderAPI operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are available to all\n\t\t\taccounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity\n\t\t\tproviders for a cluster after the cluster is created.
" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The platform version that the tasks in the task set uses. A platform version is\n\t\t\tspecified only for tasks using the Fargate launch type. If one isn't\n\t\t\tspecified, the LATEST platform version is used.
The platform version that the tasks in the task set uses. A platform version is specified only for\n\t\t\ttasks using the Fargate launch type. If one isn't specified, the LATEST\n\t\t\tplatform version is used.
A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.
" + "smithy.api#documentation": "A floating-point percentage of the desired number of tasks to place and keep running in the task\n\t\t\tset.
" } }, "clientToken": { @@ -3584,7 +3590,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both. When a service is\n\t\t\tdeleted, the tags are deleted.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the task set to help you categorize and organize them. Each tag\n\t\t\tconsists of a key and an optional value. You define both. When a service is deleted, the tags are\n\t\t\tdeleted.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Information about a set of Amazon ECS tasks in either an CodeDeploy or an\n\t\t\t\tEXTERNAL deployment. A task set includes details such as the desired\n\t\t\tnumber of tasks, how many tasks are running, and whether the task set serves production\n\t\t\ttraffic.
Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment.\n\t\t\tA task set includes details such as the desired number of tasks, how many tasks are running, and\n\t\t\twhether the task set serves production traffic.
Disables an account setting for a specified user, role, or the root user for an\n\t\t\taccount.
", + "smithy.api#documentation": "Disables an account setting for a specified user, role, or the root user for an account.
", "smithy.api#examples": [ { "title": "To delete the account settings for a specific IAM user or IAM role", @@ -3686,14 +3692,14 @@ "name": { "target": "com.amazonaws.ecs#SettingName", "traits": { - "smithy.api#documentation": "The resource name to disable the account setting for. If\n\t\t\t\tserviceLongArnFormat is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected.
The resource name to disable the account setting for. If serviceLongArnFormat is\n\t\t\tspecified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS tasks is affected. If\n\t\t\t\tcontainerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS\n\t\t\tcontainer instances is affected. If awsvpcTrunking is specified, the ENI limit for your\n\t\t\tAmazon ECS container instances is affected.
The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the\n\t\t\troot user. If you specify the root user, it disables the account setting for all users, roles,\n\t\t\tand the root user of the account unless a user or role explicitly overrides these settings.\n\t\t\tIf this field is omitted, the setting is changed only for the authenticated user.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the root user. If you\n\t\t\tspecify the root user, it disables the account setting for all users, roles, and the root user of the account\n\t\t\tunless a user or role explicitly overrides these settings. If this field is omitted, the setting is\n\t\t\tchanged only for the authenticated user.
" } } }, @@ -3744,13 +3750,13 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete\n\t\t\tattributes. If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "attributes": { "target": "com.amazonaws.ecs#Attributes", "traits": { - "smithy.api#documentation": "The attributes to delete from your resource. You can specify up to 10 attributes for\n\t\t\teach request. For custom attributes, specify the attribute name and target ID, but don't\n\t\t\tspecify the value. If you specify the target ID using the short form, you must also\n\t\t\tspecify the target type.
", + "smithy.api#documentation": "The attributes to delete from your resource. You can specify up to 10 attributes for each request.\n\t\t\tFor custom attributes, specify the attribute name and target ID, but don't specify the value. If you\n\t\t\tspecify the target ID using the short form, you must also specify the target type.
", "smithy.api#required": {} } } @@ -3793,7 +3799,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified capacity provider.
\nThe FARGATE and FARGATE_SPOT capacity providers are\n\t\t\t\treserved and can't be deleted. You can disassociate them from a cluster using either PutCapacityProviderProviders or by deleting the\n\t\t\t\tcluster.
Prior to a capacity provider being deleted, the capacity provider must be removed from\n\t\t\tthe capacity provider strategy from all services. The UpdateService\n\t\t\tAPI can be used to remove a capacity provider from a service's capacity provider\n\t\t\tstrategy. When updating a service, the forceNewDeployment option can be\n\t\t\tused to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity\n\t\t\tprovider are transitioned to use the capacity from the remaining capacity providers.\n\t\t\tOnly capacity providers that aren't associated with a cluster can be deleted. To remove\n\t\t\ta capacity provider from a cluster, you can either use PutCapacityProviderProviders or delete the cluster.
Deletes the specified capacity provider.
\nThe FARGATE and FARGATE_SPOT capacity providers are reserved and can't\n\t\t\t\tbe deleted. You can disassociate them from a cluster using either PutCapacityProviderProviders or by deleting the cluster.
Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity\n\t\t\tprovider strategy from all services. The UpdateService API can be used to\n\t\t\tremove a capacity provider from a service's capacity provider strategy. When updating a service, the\n\t\t\t\tforceNewDeployment option can be used to ensure that any tasks using the Amazon EC2\n\t\t\tinstance capacity provided by the capacity provider are transitioned to use the capacity from the\n\t\t\tremaining capacity providers. Only capacity providers that aren't associated with a cluster can be\n\t\t\tdeleted. To remove a capacity provider from a cluster, you can either use PutCapacityProviderProviders or delete the cluster.
Deletes the specified cluster. The cluster transitions to the INACTIVE\n\t\t\tstate. Clusters with an INACTIVE status might remain discoverable in your\n\t\t\taccount for a period of time. However, this behavior is subject to change in the future.\n\t\t\tWe don't recommend that you rely on INACTIVE clusters persisting.
You must deregister all container instances from this cluster before you may delete\n\t\t\tit. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
", + "smithy.api#documentation": "Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters\n\t\t\twith an INACTIVE status might remain discoverable in your account for a period of time.\n\t\t\tHowever, this behavior is subject to change in the future. We don't recommend that you rely on\n\t\t\t\tINACTIVE clusters persisting.
You must deregister all container instances from this cluster before you may delete it. You can list\n\t\t\tthe container instances in a cluster with ListContainerInstances\n\t\t\tand deregister them with DeregisterContainerInstance.
", "smithy.api#examples": [ { "title": "To delete an empty cluster", @@ -3938,7 +3944,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a specified service within a cluster. You can delete a service if you have no\n\t\t\trunning tasks in it and the desired task count is zero. If the service is actively\n\t\t\tmaintaining tasks, you can't delete it, and you must update the service to a desired\n\t\t\ttask count of zero. For more information, see UpdateService.
\nWhen you delete a service, if there are still running tasks that require cleanup,\n\t\t\t\tthe service status moves from ACTIVE to DRAINING, and the\n\t\t\t\tservice is no longer visible in the console or in the ListServices\n\t\t\t\tAPI operation. After all tasks have transitioned to either STOPPING or\n\t\t\t\t\tSTOPPED status, the service status moves from DRAINING\n\t\t\t\tto INACTIVE. Services in the DRAINING or\n\t\t\t\tINACTIVE status can still be viewed with the DescribeServices API operation. However, in the future,\n\t\t\t\t\tINACTIVE services may be cleaned up and purged from Amazon ECS record\n\t\t\t\tkeeping, and DescribeServices calls on those services return a\n\t\t\t\t\tServiceNotFoundException error.
If you attempt to create a new service with the same name as an existing service\n\t\t\t\tin either ACTIVE or DRAINING status, you receive an\n\t\t\t\terror.
Deletes a specified service within a cluster. You can delete a service if you have no running tasks\n\t\t\tin it and the desired task count is zero. If the service is actively maintaining tasks, you can't\n\t\t\tdelete it, and you must update the service to a desired task count of zero. For more information, see\n\t\t\t\tUpdateService.
\nWhen you delete a service, if there are still running tasks that require cleanup, the service\n\t\t\t\tstatus moves from ACTIVE to DRAINING, and the service is no longer\n\t\t\t\tvisible in the console or in the ListServices API operation.\n\t\t\t\tAfter all tasks have transitioned to either STOPPING or STOPPED status,\n\t\t\t\tthe service status moves from DRAINING to INACTIVE. Services in the\n\t\t\t\t\tDRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services\n\t\t\t\tmay be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on\n\t\t\t\tthose services return a ServiceNotFoundException error.
If you attempt to create a new service with the same name as an existing service in either\n\t\t\t\t\tACTIVE or DRAINING status, you receive an error.
If true, allows you to delete a service even if it wasn't scaled down to\n\t\t\tzero tasks. It's only necessary to use this if the service uses the REPLICA\n\t\t\tscheduling strategy.
If true, allows you to delete a service even if it wasn't scaled down to zero tasks.\n\t\t\tIt's only necessary to use this if the service uses the REPLICA scheduling\n\t\t\tstrategy.
Deletes one or more task definitions.
\nYou must deregister a task definition revision before you delete it. For more\n\t\t\tinformation, see DeregisterTaskDefinition.
\nWhen you delete a task definition revision, it is immediately transitions from the\n\t\t\t\tINACTIVE to DELETE_IN_PROGRESS. Existing tasks and\n\t\t\tservices that reference a DELETE_IN_PROGRESS task definition revision\n\t\t\tcontinue to run without disruption. Existing services that reference a\n\t\t\t\tDELETE_IN_PROGRESS task definition revision can still scale up or down\n\t\t\tby modifying the service's desired count.
You can't use a DELETE_IN_PROGRESS task definition revision to run new\n\t\t\ttasks or create new services. You also can't update an existing service to reference a\n\t\t\t\tDELETE_IN_PROGRESS task definition revision.
A task definition revision will stay in DELETE_IN_PROGRESS status until\n\t\t\tall the associated tasks and services have been terminated.
When you delete all INACTIVE task definition revisions, the task\n\t\t\tdefinition name is not displayed in the console and not returned in the API. If a task\n\t\t\tdefinition revisions are in the DELETE_IN_PROGRESS state, the task\n\t\t\tdefinition name is displayed in the console and returned in the API. The task definition\n\t\t\tname is retained by Amazon ECS and the revision is incremented the next time you create a\n\t\t\ttask definition with that name.
Deletes one or more task definitions.
\nYou must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition.
\nWhen you delete a task definition revision, it is immediately transitions from the\n\t\t\t\tINACTIVE to DELETE_IN_PROGRESS. Existing tasks and services that\n\t\t\treference a DELETE_IN_PROGRESS task definition revision continue to run without\n\t\t\tdisruption. Existing services that reference a DELETE_IN_PROGRESS task definition revision\n\t\t\tcan still scale up or down by modifying the service's desired count.
You can't use a DELETE_IN_PROGRESS task definition revision to run new tasks or create\n\t\t\tnew services. You also can't update an existing service to reference a DELETE_IN_PROGRESS\n\t\t\ttask definition revision.
A task definition revision will stay in DELETE_IN_PROGRESS status until all the\n\t\t\tassociated tasks and services have been terminated.
When you delete all INACTIVE task definition revisions, the task definition name is not\n\t\t\tdisplayed in the console and not returned in the API. If a task definition revisions are in the\n\t\t\t\tDELETE_IN_PROGRESS state, the task definition name is displayed in the console and\n\t\t\treturned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the\n\t\t\tnext time you create a task definition with that name.
The family and revision (family:revision) or\n\t\t\tfull Amazon Resource Name (ARN) of the task definition to delete. You must specify a\n\t\t\t\trevision.
You can specify up to 10 task definitions as a comma separated list.
", + "smithy.api#documentation": "The family and revision (family:revision) or full Amazon Resource Name (ARN) of\n\t\t\tthe task definition to delete. You must specify a revision.
You can specify up to 10 task definitions as a comma separated list.
", "smithy.api#required": {} } } @@ -4091,7 +4097,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a specified task set within a service. This is used when a service uses the\n\t\t\t\tEXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
Deletes a specified task set within a service. This is used when a service uses the\n\t\t\t\tEXTERNAL deployment controller type. For more information, see Amazon ECS deployment\n\t\t\t\ttypes in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset found in to delete.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set found in to\n\t\t\tdelete.
", "smithy.api#required": {} } }, "service": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to\n\t\t\tdelete.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.
", "smithy.api#required": {} } }, @@ -4121,7 +4127,7 @@ "force": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "If true, you can delete a task set even if it hasn't been scaled down to\n\t\t\tzero.
If true, you can delete a task set even if it hasn't been scaled down to zero.
The status of the deployment. The following describes each state.
\nThe most recent deployment of a service.
\nA service deployment that still has running tasks, but are in the process\n\t\t\t\t\t\tof being replaced with a new PRIMARY deployment.
A deployment that has been completely replaced.
\nThe status of the deployment. The following describes each state.
\nThe most recent deployment of a service.
\nA service deployment that still has running tasks, but are in the process of being\n\t\t\t\t\t\treplaced with a new PRIMARY deployment.
A deployment that has been completely replaced.
\nThe most recent task definition that was specified for the tasks in the service to\n\t\t\tuse.
" + "smithy.api#documentation": "The most recent task definition that was specified for the tasks in the service to use.
" } }, "desiredCount": { @@ -4175,21 +4181,21 @@ "target": "com.amazonaws.ecs#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of tasks in the deployment that are in the PENDING\n\t\t\tstatus.
The number of tasks in the deployment that are in the PENDING status.
The number of tasks in the deployment that are in the RUNNING\n\t\t\tstatus.
The number of tasks in the deployment that are in the RUNNING status.
The number of consecutively failed tasks in the deployment. A task is considered a\n\t\t\tfailure if the service scheduler can't launch the task, the task doesn't transition to a\n\t\t\t\tRUNNING state, or if it fails any of its defined health checks and is\n\t\t\tstopped.
Once a service deployment has one or more successfully running tasks, the failed\n\t\t\t\ttask count resets to zero and stops being evaluated.
\nThe number of consecutively failed tasks in the deployment. A task is considered a failure if the\n\t\t\tservice scheduler can't launch the task, the task doesn't transition to a RUNNING state,\n\t\t\tor if it fails any of its defined health checks and is stopped.
Once a service deployment has one or more successfully running tasks, the failed task count\n\t\t\t\tresets to zero and stops being evaluated.
\nThe launch type the tasks in the service are using. For more information, see Amazon ECS\n\t\t\t\tLaunch Types in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The launch type the tasks in the service are using. For more information, see Amazon ECS Launch\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The platform version that your tasks in the service run on. A platform version is only\n\t\t\tspecified for tasks using the Fargate launch type. If one isn't specified,\n\t\t\tthe LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The platform version that your tasks in the service run on. A platform version is only specified for\n\t\t\ttasks using the Fargate launch type. If one isn't specified, the LATEST\n\t\t\tplatform version is used. For more information, see Fargate Platform Versions in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
The operating system that your tasks in the service, or tasks are running on. A\n\t\t\tplatform family is specified only for tasks using the Fargate launch type.
\n All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service, for example, \n\t\t\tLINUX..
The operating system that your tasks in the service, or tasks are running on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.
\n All tasks that run as part of this service must use the same platformFamily value as\n\t\t\tthe service, for example, LINUX..
The rolloutState of a service is only returned for services that use\n\t\t\t\tthe rolling update (ECS) deployment type that aren't behind a\n\t\t\t\tClassic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins\n\t\t\tin an IN_PROGRESS state. When the service reaches a steady state, the\n\t\t\tdeployment transitions to a COMPLETED state. If the service fails to reach\n\t\t\ta steady state and circuit breaker is turned on, the deployment transitions to a\n\t\t\t\tFAILED state. A deployment in FAILED state doesn't launch\n\t\t\tany new tasks. For more information, see DeploymentCircuitBreaker.
The rolloutState of a service is only returned for services that use the rolling\n\t\t\t\tupdate (ECS) deployment type that aren't behind a Classic Load Balancer.
The rollout state of the deployment. When a service deployment is started, it begins in an\n\t\t\t\tIN_PROGRESS state. When the service reaches a steady state, the deployment transitions\n\t\t\tto a COMPLETED state. If the service fails to reach a steady state and circuit breaker is\n\t\t\tturned on, the deployment transitions to a FAILED state. A deployment in\n\t\t\t\tFAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.
The details of the Service Connect configuration that's used by this deployment.\n\t\t\tCompare the configuration between multiple deployments when troubleshooting issues with\n\t\t\tnew deployments.
\nThe configuration for this service to discover and connect to\n\tservices, and be discovered by, and connected from, other services within a namespace.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The details of the Service Connect configuration that's used by this deployment. Compare the\n\t\t\tconfiguration between multiple deployments when troubleshooting issues with new deployments.
\nThe configuration for this service to discover and connect to\n\tservices, and be discovered by, and connected from, other services within a namespace.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" } }, "serviceConnectResources": { "target": "com.amazonaws.ecs#ServiceConnectServiceResourceList", "traits": { - "smithy.api#documentation": "The list of Service Connect resources that are associated with this deployment. Each\n\t\t\tlist entry maps a discovery name to a Cloud Map service name.
" + "smithy.api#documentation": "The list of Service Connect resources that are associated with this deployment. Each list entry maps\n\t\t\ta discovery name to a Cloud Map service name.
" } }, "volumeConfigurations": { "target": "com.amazonaws.ecs#ServiceVolumeConfigurations", "traits": { - "smithy.api#documentation": "The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tdifferent settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. The name of the volume\n\t\t\tmust match the name from the task definition.
The details of the volume that was configuredAtLaunch. You can configure different\n\t\t\tsettings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the\n\t\t\t\tname from the task definition.
The Fargate ephemeral storage settings for the deployment.
" } + }, + "vpcLatticeConfigurations": { + "target": "com.amazonaws.ecs#VpcLatticeConfigurations", + "traits": { + "smithy.api#documentation": "The VPC Lattice configuration for the service deployment.
" + } } }, "traits": { @@ -4289,7 +4301,7 @@ "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Determines whether to configure Amazon ECS to roll back the service if a service deployment\n\t\t\tfails. If rollback is used, when a service deployment fails, the service is rolled back\n\t\t\tto the last deployment that completed successfully.
", + "smithy.api#documentation": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If\n\t\t\trollback is used, when a service deployment fails, the service is rolled back to the last deployment\n\t\t\tthat completed successfully.
", "smithy.api#required": {} } }, @@ -4297,13 +4309,13 @@ "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Determines whether to use the CloudWatch alarm option in the service deployment\n\t\t\tprocess.
", + "smithy.api#documentation": "Determines whether to use the CloudWatch alarm option in the service deployment process.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "One of the methods which provide a way for you to quickly identify when a deployment\n\t\t\thas failed, and then to optionally roll back the failure to the last working\n\t\t\tdeployment.
\nWhen the alarms are generated, Amazon ECS sets the service deployment to failed. Set the\n\t\t\trollback parameter to have Amazon ECS to roll back your service to the last completed\n\t\t\tdeployment after a failure.
\nYou can only use the DeploymentAlarms method to detect failures when the\n\t\t\t\tDeploymentController is set to ECS (rolling\n\t\t\tupdate).
For more information, see Rolling\n\t\t\t\tupdate in the \n Amazon Elastic Container Service Developer Guide\n .
" + "smithy.api#documentation": "One of the methods which provide a way for you to quickly identify when a deployment has failed, and\n\t\t\tthen to optionally roll back the failure to the last working deployment.
\nWhen the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback\n\t\t\tparameter to have Amazon ECS to roll back your service to the last completed deployment after a\n\t\t\tfailure.
\nYou can only use the DeploymentAlarms method to detect failures when the\n\t\t\t\tDeploymentController is set to ECS (rolling update).
For more information, see Rolling update in the\n\t\t\t\t\n Amazon Elastic Container Service Developer Guide\n .
" } }, "com.amazonaws.ecs#DeploymentCircuitBreaker": { @@ -4321,13 +4333,13 @@ "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Determines whether to configure Amazon ECS to roll back the service if a service deployment\n\t\t\tfails. If rollback is on, when a service deployment fails, the service is rolled back to\n\t\t\tthe last deployment that completed successfully.
", + "smithy.api#documentation": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If\n\t\t\trollback is on, when a service deployment fails, the service is rolled back to the last deployment that\n\t\t\tcompleted successfully.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type.
The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If it is turned\n\t\t\ton, a service deployment will transition to a failed state and stop launching new tasks.\n\t\t\tYou can also configure Amazon ECS to roll back your service to the last completed deployment\n\t\t\tafter a failure. For more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.
\nFor more information about API failure reasons, see API failure\n\t\t\t\treasons in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The deployment circuit breaker can only be used for services using the rolling update\n\t\t\t\t\t(ECS) deployment type.
The deployment circuit breaker determines whether a service\n\t\t\tdeployment will fail if the service can't reach a steady state. If it is turned on, a service\n\t\t\tdeployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS\n\t\t\tto roll back your service to the last completed deployment after a failure. For more information, see\n\t\t\t\tRolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.
\nFor more information about API failure reasons, see API failure reasons in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#DeploymentConfiguration": { @@ -4336,19 +4348,19 @@ "deploymentCircuitBreaker": { "target": "com.amazonaws.ecs#DeploymentCircuitBreaker", "traits": { - "smithy.api#documentation": "The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type.
The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If you use the\n\t\t\tdeployment circuit breaker, a service deployment will transition to a failed state and\n\t\t\tstop launching new tasks. If you use the rollback option, when a service deployment\n\t\t\tfails, the service is rolled back to the last deployment that completed successfully.\n\t\t\tFor more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer\n\t\t\t\tGuide\n
" + "smithy.api#documentation": "The deployment circuit breaker can only be used for services using the rolling update\n\t\t\t\t\t(ECS) deployment type.
The deployment circuit breaker determines whether a service\n\t\t\tdeployment will fail if the service can't reach a steady state. If you use the deployment circuit\n\t\t\tbreaker, a service deployment will transition to a failed state and stop launching new tasks. If you\n\t\t\tuse the rollback option, when a service deployment fails, the service is rolled back to the last\n\t\t\tdeployment that completed successfully. For more information, see Rolling update in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide\n
" } }, "maximumPercent": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tmaximumPercent parameter represents an upper limit on the number of\n\t\t\tyour service's tasks that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment, as a percentage of the\n\t\t\t\tdesiredCount (rounded down to the nearest integer). This parameter\n\t\t\tenables you to define the deployment batch size. For example, if your service is using\n\t\t\tthe REPLICA service scheduler and has a desiredCount of four\n\t\t\ttasks and a maximumPercent value of 200%, the scheduler may start four new\n\t\t\ttasks before stopping the four older tasks (provided that the cluster resources required\n\t\t\tto do this are available). The default maximumPercent value for a service\n\t\t\tusing the REPLICA service scheduler is 200%.
If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types, and tasks in the service use the EC2\n\t\t\tlaunch type, the maximum percent value is set to the\n\t\t\tdefault value. The maximum percent value is used to define the upper limit on the number of the tasks in the\n\t\t\tservice that remain in the RUNNING state while the container instances are\n\t\t\tin the DRAINING state.
You can't specify a custom maximumPercent value for a service that uses either the blue/green (CODE_DEPLOY) or\n\t\t\tEXTERNAL deployment types and has tasks that use the EC2 launch type.
If the tasks in the service use the\n\t\t\tFargate launch type, the maximum percent value is not used, although it is\n\t\t\treturned when describing your service.
" + "smithy.api#documentation": "If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tmaximumPercent parameter represents an upper limit on the number of your service's\n\t\t\ttasks that are allowed in the RUNNING or PENDING state during a deployment,\n\t\t\tas a percentage of the desiredCount (rounded down to the nearest integer). This parameter\n\t\t\tenables you to define the deployment batch size. For example, if your service is using the\n\t\t\t\tREPLICA service scheduler and has a desiredCount of four tasks and a\n\t\t\t\tmaximumPercent value of 200%, the scheduler may start four new tasks before stopping\n\t\t\tthe four older tasks (provided that the cluster resources required to do this are available). The\n\t\t\tdefault maximumPercent value for a service using the REPLICA service\n\t\t\tscheduler is 200%.
If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\tdeployment types, and tasks in the service use the EC2 launch type, the maximum percent value is set to the default value. The maximum percent value is used to define the upper limit on the number of the tasks in\n\t\t\tthe service that remain in the RUNNING state while the container instances are in the\n\t\t\t\tDRAINING state.
You can't specify a custom maximumPercent value for a service that uses either the\n\t\t\t\tblue/green (CODE_DEPLOY) or EXTERNAL deployment types and has tasks that\n\t\t\t\tuse the EC2 launch type.
If the tasks in the service use the Fargate launch type, the maximum percent value is\n\t\t\tnot used, although it is returned when describing your service.
" } }, "minimumHealthyPercent": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tminimumHealthyPercent represents a lower limit on the number of your\n\t\t\tservice's tasks that must remain in the RUNNING state during a deployment,\n\t\t\tas a percentage of the desiredCount (rounded up to the nearest integer).\n\t\t\tThis parameter enables you to deploy without using additional cluster capacity. For\n\t\t\texample, if your service has a desiredCount of four tasks and a\n\t\t\t\tminimumHealthyPercent of 50%, the service scheduler may stop two\n\t\t\texisting tasks to free up cluster capacity before starting two new tasks.
For services that do not use a load balancer, the following\n\t\t\tshould be noted:
\nA service is considered healthy if all essential containers within the tasks\n\t\t\t\t\tin the service pass their health checks.
\nIf a task has no essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for 40 seconds after a task reaches a RUNNING\n\t\t\t\t\tstate before the task is counted towards the minimum healthy percent\n\t\t\t\t\ttotal.
If a task has one or more essential containers with a health check defined,\n\t\t\t\t\tthe service scheduler will wait for the task to reach a healthy status before\n\t\t\t\t\tcounting it towards the minimum healthy percent total. A task is considered\n\t\t\t\t\thealthy when all essential containers within the task have passed their health\n\t\t\t\t\tchecks. The amount of time the service scheduler can wait for is determined by\n\t\t\t\t\tthe container health check settings.
\nFor services that do use a load balancer, the following should be\n\t\t\tnoted:
\nIf a task has no essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for the load balancer target group health check to return a\n\t\t\t\t\thealthy status before counting the task towards the minimum healthy percent\n\t\t\t\t\ttotal.
\nIf a task has an essential container with a health check defined, the service\n\t\t\t\t\tscheduler will wait for both the task to reach a healthy status and the load\n\t\t\t\t\tbalancer target group health check to return a healthy status before counting\n\t\t\t\t\tthe task towards the minimum healthy percent total.
\nThe default value for a replica service for minimumHealthyPercent is\n\t\t\t100%. The default minimumHealthyPercent value for a service using the\n\t\t\t\tDAEMON service schedule is 0% for the CLI, the Amazon Web Services SDKs, and the\n\t\t\tAPIs and 50% for the Amazon Web Services Management Console.
The minimum number of healthy tasks during a deployment is the\n\t\t\t\tdesiredCount multiplied by the minimumHealthyPercent/100,\n\t\t\trounded up to the nearest integer value.
If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and is running tasks that use the\n\t\t\tEC2 launch type, the minimum healthy\n\t\t\t\tpercent value is set to the default value. The minimum healthy percent value is used to define the lower\n\t\t\tlimit on the number of the tasks in the service that remain in the RUNNING\n\t\t\tstate while the container instances are in the DRAINING state.
You can't specify a custom minimumHealthyPercent value for a service that uses either the blue/green (CODE_DEPLOY) or\n\t\t\tEXTERNAL deployment types and has tasks that use the EC2 launch type.
If a service\n\t\t\tis using either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\tdeployment types and is running tasks that use the Fargate launch type,\n\t\t\tthe minimum healthy percent value is not used, although it is returned when describing\n\t\t\tyour service.
If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tminimumHealthyPercent represents a lower limit on the number of your service's tasks\n\t\t\tthat must remain in the RUNNING state during a deployment, as a percentage of the\n\t\t\t\tdesiredCount (rounded up to the nearest integer). This parameter enables you to deploy\n\t\t\twithout using additional cluster capacity. For example, if your service has a desiredCount\n\t\t\tof four tasks and a minimumHealthyPercent of 50%, the service scheduler may stop two\n\t\t\texisting tasks to free up cluster capacity before starting two new tasks.
For services that do not use a load balancer, the following should be\n\t\t\tnoted:
\nA service is considered healthy if all essential containers within the tasks in the service\n\t\t\t\t\tpass their health checks.
\nIf a task has no essential containers with a health check defined, the service scheduler will\n\t\t\t\t\twait for 40 seconds after a task reaches a RUNNING state before the task is\n\t\t\t\t\tcounted towards the minimum healthy percent total.
If a task has one or more essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for the task to reach a healthy status before counting it towards the\n\t\t\t\t\tminimum healthy percent total. A task is considered healthy when all essential containers\n\t\t\t\t\twithin the task have passed their health checks. The amount of time the service scheduler can\n\t\t\t\t\twait for is determined by the container health check settings.
\nFor services that do use a load balancer, the following should be noted:
\nIf a task has no essential containers with a health check defined, the service scheduler will\n\t\t\t\t\twait for the load balancer target group health check to return a healthy status before counting\n\t\t\t\t\tthe task towards the minimum healthy percent total.
\nIf a task has an essential container with a health check defined, the service scheduler will\n\t\t\t\t\twait for both the task to reach a healthy status and the load balancer target group health\n\t\t\t\t\tcheck to return a healthy status before counting the task towards the minimum healthy percent\n\t\t\t\t\ttotal.
\nThe default value for a replica service for minimumHealthyPercent is 100%. The default\n\t\t\t\tminimumHealthyPercent value for a service using the DAEMON service\n\t\t\tschedule is 0% for the CLI, the Amazon Web Services SDKs, and the APIs and 50% for the Amazon Web Services Management Console.
The minimum number of healthy tasks during a deployment is the desiredCount multiplied\n\t\t\tby the minimumHealthyPercent/100, rounded up to the nearest integer value.
If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\tdeployment types and is running tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value. The minimum healthy percent value is used to define the lower limit on the\n\t\t\tnumber of the tasks in the service that remain in the RUNNING state while the container\n\t\t\tinstances are in the DRAINING state.
You can't specify a custom minimumHealthyPercent value for a service that uses\n\t\t\t\teither the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and has\n\t\t\t\ttasks that use the EC2 launch type.
If a service is using either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\tdeployment types and is running tasks that use the Fargate launch type, the minimum\n\t\t\thealthy percent value is not used, although it is returned when describing your service.
Optional deployment parameters that control how many tasks run during the deployment and the\n\t\t\tfailure detection methods.
" + "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during a deployment and the ordering\n\t\t\tof stopping and starting tasks.
" } }, "com.amazonaws.ecs#DeploymentController": { @@ -4368,13 +4380,13 @@ "type": { "target": "com.amazonaws.ecs#DeploymentControllerType", "traits": { - "smithy.api#documentation": "The deployment controller type to use.
\nThere are three deployment controller types available:
\nThe rolling update (ECS) deployment type involves replacing\n\t\t\t\t\t\tthe current running version of the container with the latest version. The\n\t\t\t\t\t\tnumber of containers Amazon ECS adds or removes from the service during a rolling\n\t\t\t\t\t\tupdate is controlled by adjusting the minimum and maximum number of healthy\n\t\t\t\t\t\ttasks allowed during a service deployment, as specified in the DeploymentConfiguration.
The blue/green (CODE_DEPLOY) deployment type uses the\n\t\t\t\t\t\tblue/green deployment model powered by CodeDeploy, which allows you to verify a\n\t\t\t\t\t\tnew deployment of a service before sending production traffic to it.
The external (EXTERNAL) deployment type enables you to use\n\t\t\t\t\t\tany third-party deployment controller for full control over the deployment\n\t\t\t\t\t\tprocess for an Amazon ECS service.
The deployment controller type to use.
\nThere are three deployment controller types available:
\nThe rolling update (ECS) deployment type involves replacing the current\n\t\t\t\t\t\trunning version of the container with the latest version. The number of containers Amazon ECS\n\t\t\t\t\t\tadds or removes from the service during a rolling update is controlled by adjusting the\n\t\t\t\t\t\tminimum and maximum number of healthy tasks allowed during a service deployment, as\n\t\t\t\t\t\tspecified in the DeploymentConfiguration.
The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment\n\t\t\t\t\t\tmodel powered by CodeDeploy, which allows you to verify a new deployment of a service before\n\t\t\t\t\t\tsending production traffic to it.
The external (EXTERNAL) deployment type enables you to use any third-party\n\t\t\t\t\t\tdeployment controller for full control over the deployment process for an Amazon ECS\n\t\t\t\t\t\tservice.
The deployment controller to use for the service. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The deployment controller to use for the service. For more information, see Amazon ECS deployment\n\t\t\t\ttypes in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#DeploymentControllerType": { @@ -4406,7 +4418,7 @@ "kmsKeyId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "Specify an Amazon Web Services Key Management Service key ID to encrypt the ephemeral storage for\n\t\t\tdeployment.
" + "smithy.api#documentation": "Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.
" } } }, @@ -4466,7 +4478,7 @@ } ], "traits": { - "smithy.api#documentation": "Deregisters an Amazon ECS container instance from the specified cluster. This instance is\n\t\t\tno longer available to run tasks.
\nIf you intend to use the container instance for some other purpose after\n\t\t\tderegistration, we recommend that you stop all of the tasks running on the container\n\t\t\tinstance before deregistration. That prevents any orphaned tasks from consuming\n\t\t\tresources.
\nDeregistering a container instance removes the instance from a cluster, but it doesn't\n\t\t\tterminate the EC2 instance. If you are finished using the instance, be sure to terminate\n\t\t\tit in the Amazon EC2 console to stop billing.
\nIf you terminate a running container instance, Amazon ECS automatically deregisters the\n\t\t\t\tinstance from your cluster (stopped container instances or instances with\n\t\t\t\tdisconnected agents aren't automatically deregistered when terminated).
\nDeregisters an Amazon ECS container instance from the specified cluster. This instance is no longer\n\t\t\tavailable to run tasks.
\nIf you intend to use the container instance for some other purpose after deregistration, we recommend\n\t\t\tthat you stop all of the tasks running on the container instance before deregistration. That prevents\n\t\t\tany orphaned tasks from consuming resources.
\nDeregistering a container instance removes the instance from a cluster, but it doesn't terminate the\n\t\t\tEC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to\n\t\t\tstop billing.
\nIf you terminate a running container instance, Amazon ECS automatically deregisters the instance from\n\t\t\t\tyour cluster (stopped container instances or instances with disconnected agents aren't\n\t\t\t\tautomatically deregistered when terminated).
\nThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to\n\t\t\tderegister. If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "containerInstance": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The container instance ID or full ARN of the container instance to deregister. For\n\t\t\tmore information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
", + "smithy.api#documentation": "The container instance ID or full ARN of the container instance to deregister. For more information\n\t\t\tabout the ARN format, see Amazon Resource Name (ARN)\n\t\t\tin the Amazon ECS Developer Guide.
", "smithy.api#required": {} } }, "force": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "Forces the container instance to be deregistered. If you have tasks running on the\n\t\t\tcontainer instance when you deregister it with the force option, these\n\t\t\ttasks remain running until you terminate the instance or the tasks stop through some\n\t\t\tother means, but they're orphaned (no longer monitored or accounted for by Amazon ECS). If an\n\t\t\torphaned task on your container instance is part of an Amazon ECS service, then the service\n\t\t\tscheduler starts another copy of that task, on a different container instance if\n\t\t\tpossible.
Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer\n\t\t\ttarget group are deregistered. They begin connection draining according to the settings\n\t\t\ton the load balancer or target group.
" + "smithy.api#documentation": "Forces the container instance to be deregistered. If you have tasks running on the container instance\n\t\t\twhen you deregister it with the force option, these tasks remain running until you\n\t\t\tterminate the instance or the tasks stop through some other means, but they're orphaned (no longer\n\t\t\tmonitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an\n\t\t\tAmazon ECS service, then the service scheduler starts another copy of that task, on a different container\n\t\t\tinstance if possible.
Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group\n\t\t\tare deregistered. They begin connection draining according to the settings on the load balancer or\n\t\t\ttarget group.
" } } }, @@ -4542,7 +4554,7 @@ } ], "traits": { - "smithy.api#documentation": "Deregisters the specified task definition by family and revision. Upon deregistration,\n\t\t\tthe task definition is marked as INACTIVE. Existing tasks and services that\n\t\t\treference an INACTIVE task definition continue to run without disruption.\n\t\t\tExisting services that reference an INACTIVE task definition can still\n\t\t\tscale up or down by modifying the service's desired count. If you want to delete a task\n\t\t\tdefinition revision, you must first deregister the task definition revision.
You can't use an INACTIVE task definition to run new tasks or create new\n\t\t\tservices, and you can't update an existing service to reference an INACTIVE\n\t\t\ttask definition. However, there may be up to a 10-minute window following deregistration\n\t\t\twhere these restrictions have not yet taken effect.
At this time, INACTIVE task definitions remain discoverable in your\n\t\t\t\taccount indefinitely. However, this behavior is subject to change in the future. We\n\t\t\t\tdon't recommend that you rely on INACTIVE task definitions persisting\n\t\t\t\tbeyond the lifecycle of any associated tasks and services.
You must deregister a task definition revision before you delete it. For more\n\t\t\tinformation, see DeleteTaskDefinitions.
" + "smithy.api#documentation": "Deregisters the specified task definition by family and revision. Upon deregistration, the task\n\t\t\tdefinition is marked as INACTIVE. Existing tasks and services that reference an\n\t\t\t\tINACTIVE task definition continue to run without disruption. Existing services that\n\t\t\treference an INACTIVE task definition can still scale up or down by modifying the\n\t\t\tservice's desired count. If you want to delete a task definition revision, you must first deregister\n\t\t\tthe task definition revision.
You can't use an INACTIVE task definition to run new tasks or create new services, and\n\t\t\tyou can't update an existing service to reference an INACTIVE task definition. However,\n\t\t\tthere may be up to a 10-minute window following deregistration where these restrictions have not yet\n\t\t\ttaken effect.
At this time, INACTIVE task definitions remain discoverable in your account\n\t\t\t\tindefinitely. However, this behavior is subject to change in the future. We don't recommend that\n\t\t\t\tyou rely on INACTIVE task definitions persisting beyond the lifecycle of any\n\t\t\t\tassociated tasks and services.
You must deregister a task definition revision before you delete it. For more information, see DeleteTaskDefinitions.
" } }, "com.amazonaws.ecs#DeregisterTaskDefinitionRequest": { @@ -4551,7 +4563,7 @@ "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The family and revision (family:revision) or\n\t\t\tfull Amazon Resource Name (ARN) of the task definition to deregister. You must specify a\n\t\t\t\trevision.
The family and revision (family:revision) or full Amazon Resource Name (ARN) of\n\t\t\tthe task definition to deregister. You must specify a revision.
The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to\n\t\t\t\t100 capacity providers can be described in an action.
The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity\n\t\t\tproviders can be described in an action.
Specifies whether or not you want to see the resource tags for the capacity provider.\n\t\t\tIf TAGS is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags aren't included in the response.
Specifies whether or not you want to see the resource tags for the capacity provider. If\n\t\t\t\tTAGS is specified, the tags are included in the response. If this field is omitted,\n\t\t\ttags aren't included in the response.
The maximum number of account setting results returned by\n\t\t\t\tDescribeCapacityProviders in paginated output. When this parameter is\n\t\t\tused, DescribeCapacityProviders only returns maxResults\n\t\t\tresults in a single page along with a nextToken response element. The\n\t\t\tremaining results of the initial request can be seen by sending another\n\t\t\t\tDescribeCapacityProviders request with the returned\n\t\t\t\tnextToken value. This value can be between\n\t\t\t1 and 10. If this\n\t\t\tparameter is not used, then DescribeCapacityProviders returns up to\n\t\t\t10 results and a nextToken value\n\t\t\tif applicable.
The maximum number of account setting results returned by DescribeCapacityProviders in\n\t\t\tpaginated output. When this parameter is used, DescribeCapacityProviders only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken response\n\t\t\telement. The remaining results of the initial request can be seen by sending another\n\t\t\t\tDescribeCapacityProviders request with the returned nextToken value. This\n\t\t\tvalue can be between 1 and 10. If\n\t\t\tthis parameter is not used, then DescribeCapacityProviders returns up to\n\t\t\t10 results and a nextToken value if\n\t\t\tapplicable.
The nextToken value returned from a previous paginated\n\t\t\t\tDescribeCapacityProviders request where maxResults was\n\t\t\tused and the results exceeded the value of that parameter. Pagination continues from the\n\t\t\tend of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken value returned from a previous paginated\n\t\t\t\tDescribeCapacityProviders request where maxResults was used and the\n\t\t\tresults exceeded the value of that parameter. Pagination continues from the end of the previous results\n\t\t\tthat returned the nextToken value.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken value to include in a future\n\t\t\t\tDescribeCapacityProviders request. When the results of a\n\t\t\t\tDescribeCapacityProviders request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null\n\t\t\twhen there are no more results to return.
The nextToken value to include in a future DescribeCapacityProviders\n\t\t\trequest. When the results of a DescribeCapacityProviders request exceed\n\t\t\t\tmaxResults, this value can be used to retrieve the next page of results. This value is\n\t\t\t\tnull when there are no more results to return.
A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.
" } }, "include": { "target": "com.amazonaws.ecs#ClusterFieldList", "traits": { - "smithy.api#documentation": "Determines whether to include additional information about the clusters in the\n\t\t\tresponse. If this field is omitted, this information isn't included.
\nIf ATTACHMENTS is specified, the attachments for the container instances\n\t\t\tor tasks within the cluster are included, for example the capacity providers.
If SETTINGS is specified, the settings for the cluster are\n\t\t\tincluded.
If CONFIGURATIONS is specified, the configuration for the cluster is\n\t\t\tincluded.
If STATISTICS is specified, the task and service count is included,\n\t\t\tseparated by launch type.
If TAGS is specified, the metadata tags associated with the cluster are\n\t\t\tincluded.
Determines whether to include additional information about the clusters in the response. If this\n\t\t\tfield is omitted, this information isn't included.
\nIf ATTACHMENTS is specified, the attachments for the container instances or tasks within\n\t\t\tthe cluster are included, for example the capacity providers.
If SETTINGS is specified, the settings for the cluster are included.
If CONFIGURATIONS is specified, the configuration for the cluster is included.
If STATISTICS is specified, the task and service count is included, separated by launch\n\t\t\ttype.
If TAGS is specified, the metadata tags associated with the cluster are included.
Describes one or more container instances. Returns metadata about each container\n\t\t\tinstance requested.
", + "smithy.api#documentation": "Describes one or more container instances. Returns metadata about each container instance\n\t\t\trequested.
", "smithy.api#examples": [ { "title": "To describe container instance", @@ -4840,7 +4852,7 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to\n\t\t\tdescribe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance\n\t\t\tor container instances you are describing were launched in any cluster other than the\n\t\t\tdefault cluster.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances\n\t\t\tyou are describing were launched in any cluster other than the default cluster.
" } }, "containerInstances": { @@ -4853,7 +4865,7 @@ "include": { "target": "com.amazonaws.ecs#ContainerInstanceFieldList", "traits": { - "smithy.api#documentation": "Specifies whether you want to see the resource tags for the container instance. If\n\t\t\t\tTAGS is specified, the tags are included in the response. If\n\t\t\t\tCONTAINER_INSTANCE_HEALTH is specified, the container instance health\n\t\t\tis included in the response. If this field is omitted, tags and container instance\n\t\t\thealth status aren't included in the response.
Specifies whether you want to see the resource tags for the container instance. If TAGS\n\t\t\tis specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is\n\t\t\tspecified, the container instance health is included in the response. If this field is omitted, tags\n\t\t\tand container instance health status aren't included in the response.
Any failures associated with the call.
\nIf you decsribe a deployment with a service revision created before October 25, 2024, the\n\t\t\tcall fails. The failure includes the service revision ARN and the reason set to\n\t\t\t\tMISSING.
Any failures associated with the call.
\nIf you decsribe a deployment with a service revision created before October 25, 2024, the\n\t\t\tcall fails. The failure includes the service revision ARN and the reason set to\n\t\t\tMISSING.
The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are\n\t\t\tdescribing were launched in any cluster other than the default cluster.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were\n\t\t\tlaunched in any cluster other than the default cluster.
" } }, "services": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "A list of services to describe. You may specify up to 10 services to describe in a\n\t\t\tsingle operation.
", + "smithy.api#documentation": "A list of services to describe. You may specify up to 10 services to describe in a single\n\t\t\toperation.
", "smithy.api#required": {} } }, "include": { "target": "com.amazonaws.ecs#ServiceFieldList", "traits": { - "smithy.api#documentation": "Determines whether you want to see the resource tags for the service. If\n\t\t\t\tTAGS is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags aren't included in the response.
Determines whether you want to see the resource tags for the service. If TAGS is\n\t\t\tspecified, the tags are included in the response. If this field is omitted, tags aren't included in the\n\t\t\tresponse.
Describes a task definition. You can specify a family and\n\t\t\t\trevision to find information about a specific task definition, or you\n\t\t\tcan simply specify the family to find the latest ACTIVE revision in that\n\t\t\tfamily.
You can only describe INACTIVE task definitions while an active task\n\t\t\t\tor service references them.
Describes a task definition. You can specify a family and revision to find\n\t\t\tinformation about a specific task definition, or you can simply specify the family to find the latest\n\t\t\t\tACTIVE revision in that family.
You can only describe INACTIVE task definitions while an active task or service\n\t\t\t\treferences them.
The family for the latest ACTIVE revision,\n\t\t\t\tfamily and revision (family:revision) for a\n\t\t\tspecific revision in the family, or full Amazon Resource Name (ARN) of the task definition to\n\t\t\tdescribe.
The family for the latest ACTIVE revision, family and\n\t\t\t\trevision (family:revision) for a specific revision in the family, or full\n\t\t\tAmazon Resource Name (ARN) of the task definition to describe.
Determines whether to see the resource tags for the task definition. If\n\t\t\t\tTAGS is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags aren't included in the response.
Determines whether to see the resource tags for the task definition. If TAGS is\n\t\t\tspecified, the tags are included in the response. If this field is omitted, tags aren't included in the\n\t\t\tresponse.
The metadata that's applied to the task definition to help you categorize and organize\n\t\t\tthem. Each tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that's applied to the task definition to help you categorize and organize them. Each tag\n\t\t\tconsists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Describes the task sets in the specified cluster and service. This is used when a\n\t\t\tservice uses the EXTERNAL deployment controller type. For more information,\n\t\t\tsee Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
Describes the task sets in the specified cluster and service. This is used when a service uses the\n\t\t\t\tEXTERNAL deployment controller type. For more information, see Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tsets exist in.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist\n\t\t\tin.
", "smithy.api#required": {} } }, @@ -5389,13 +5401,13 @@ "taskSets": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "The ID or full Amazon Resource Name (ARN) of task sets to\n\t\t\tdescribe.
" + "smithy.api#documentation": "The ID or full Amazon Resource Name (ARN) of task sets to describe.
" } }, "include": { "target": "com.amazonaws.ecs#TaskSetFieldList", "traits": { - "smithy.api#documentation": "Specifies whether to see the resource tags for the task set. If TAGS is\n\t\t\tspecified, the tags are included in the response. If this field is omitted, tags aren't\n\t\t\tincluded in the response.
Specifies whether to see the resource tags for the task set. If TAGS is specified, the\n\t\t\ttags are included in the response. If this field is omitted, tags aren't included in the\n\t\t\tresponse.
Describes a specified task or tasks.
\nCurrently, stopped tasks appear in the returned results for at least one hour.
\nIf you have tasks with tags, and then delete the cluster, the tagged tasks are\n\t\t\treturned in the response. If you create a new cluster with the same name as the deleted\n\t\t\tcluster, the tagged tasks are not included in the response.
", + "smithy.api#documentation": "Describes a specified task or tasks.
\nCurrently, stopped tasks appear in the returned results for at least one hour.
\nIf you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the\n\t\t\tresponse. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are\n\t\t\tnot included in the response.
", "smithy.api#examples": [ { "title": "To describe a task", @@ -5552,7 +5564,7 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to\n\t\t\tdescribe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you\n\t\t\tare describing were launched in any cluster other than the default cluster.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were\n\t\t\tlaunched in any cluster other than the default cluster.
" } }, "tasks": { @@ -5565,7 +5577,7 @@ "include": { "target": "com.amazonaws.ecs#TaskFieldList", "traits": { - "smithy.api#documentation": "Specifies whether you want to see the resource tags for the task. If TAGS\n\t\t\tis specified, the tags are included in the response. If this field is omitted, tags\n\t\t\taren't included in the response.
Specifies whether you want to see the resource tags for the task. If TAGS is specified,\n\t\t\tthe tags are included in the response. If this field is omitted, tags aren't included in the\n\t\t\tresponse.
The explicit permissions to provide to the container for the device. By default, the\n\t\t\tcontainer has permissions for read, write, and\n\t\t\t\tmknod for the device.
The explicit permissions to provide to the container for the device. By default, the container has\n\t\t\tpermissions for read, write, and mknod for the device.
The container instance ID or full ARN of the container instance. For more\n\t\t\tinformation about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
" + "smithy.api#documentation": "The container instance ID or full ARN of the container instance. For more information about the\n\t\t\tARN format, see Amazon Resource Name (ARN)\n\t\t\tin the Amazon ECS Developer Guide.
" } }, "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs\n\t\t\tto.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs to.
" } } }, @@ -5759,36 +5771,36 @@ "scope": { "target": "com.amazonaws.ecs#Scope", "traits": { - "smithy.api#documentation": "The scope for the Docker volume that determines its lifecycle. Docker volumes that are\n\t\t\tscoped to a task are automatically provisioned when the task starts and\n\t\t\tdestroyed when the task stops. Docker volumes that are scoped as shared\n\t\t\tpersist after the task stops.
The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a\n\t\t\t\ttask are automatically provisioned when the task starts and destroyed when the task\n\t\t\tstops. Docker volumes that are scoped as shared persist after the task stops.
If this value is true, the Docker volume is created if it doesn't already\n\t\t\texist.
This field is only used if the scope is shared.
If this value is true, the Docker volume is created if it doesn't already exist.
This field is only used if the scope is shared.
The Docker volume driver to use. The driver value must match the driver name provided\n\t\t\tby Docker because it is used for task placement. If the driver was installed using the\n\t\t\tDocker plugin CLI, use docker plugin ls to retrieve the driver name from\n\t\t\tyour container instance. If the driver was installed using another method, use Docker\n\t\t\tplugin discovery to retrieve the driver name. This parameter maps to Driver in the docker container create command and the\n\t\t\t\txxdriver option to docker\n\t\t\t\tvolume create.
The Docker volume driver to use. The driver value must match the driver name provided by Docker\n\t\t\tbecause it is used for task placement. If the driver was installed using the Docker plugin CLI, use\n\t\t\t\tdocker plugin ls to retrieve the driver name from your container instance. If the\n\t\t\tdriver was installed using another method, use Docker plugin discovery to retrieve the driver name.\n\t\t\tThis parameter maps to Driver in the docker container create command and the\n\t\t\t\txxdriver option to docker volume create.
A map of Docker driver-specific options passed through. This parameter maps to\n\t\t\t\tDriverOpts in the docker create-volume command and the xxopt option to docker\n\t\t\t\tvolume create.
A map of Docker driver-specific options passed through. This parameter maps to\n\t\t\t\tDriverOpts in the docker create-volume command and the xxopt option to\n\t\t\tdocker volume create.
Custom metadata to add to your Docker volume. This parameter maps to\n\t\t\t\tLabels in the docker container create command and the xxlabel option to docker\n\t\t\t\tvolume create.
Custom metadata to add to your Docker volume. This parameter maps to Labels in the\n\t\t\tdocker container create command and the xxlabel option to docker volume create.
This parameter is specified when you're using Docker volumes. Docker volumes are only\n\t\t\tsupported when you're using the EC2 launch type. Windows containers only\n\t\t\tsupport the use of the local driver. To use bind mounts, specify a\n\t\t\t\thost instead.
This parameter is specified when you're using Docker volumes. Docker volumes are only supported when\n\t\t\tyou're using the EC2 launch type. Windows containers only support the use of the\n\t\t\t\tlocal driver. To use bind mounts, specify a host instead.
Determines whether to propagate the tags from the task definition to \u2028the Amazon EBS\n\t\t\tvolume. Tags can only propagate to a SERVICE specified in\n\t\t\t\t\u2028ServiceVolumeConfiguration. If no value is specified, the tags aren't\n\t\t\t\u2028propagated.
Determines whether to propagate the tags from the task definition to \u2028the Amazon EBS volume. Tags can only\n\t\t\tpropagate to a SERVICE specified in \u2028ServiceVolumeConfiguration. If no value\n\t\t\tis specified, the tags aren't \u2028propagated.
The Amazon EFS access point ID to use. If an access point is specified, the root directory\n\t\t\tvalue specified in the EFSVolumeConfiguration must either be omitted or set\n\t\t\tto / which will enforce the path set on the EFS access point. If an access\n\t\t\tpoint is used, transit encryption must be on in the EFSVolumeConfiguration.\n\t\t\tFor more information, see Working with Amazon EFS access\n\t\t\t\tpoints in the Amazon Elastic File System User Guide.
The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified\n\t\t\tin the EFSVolumeConfiguration must either be omitted or set to / which will\n\t\t\tenforce the path set on the EFS access point. If an access point is used, transit encryption must be on\n\t\t\tin the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the\n\t\t\tAmazon Elastic File System User Guide.
Determines whether to use the Amazon ECS task role defined in a task definition when\n\t\t\tmounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on\n\t\t\tin the EFSVolumeConfiguration. If this parameter is omitted, the default\n\t\t\tvalue of DISABLED is used. For more information, see Using\n\t\t\t\tAmazon EFS access points in the Amazon Elastic Container Service Developer Guide.
Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS\n\t\t\tfile system. If it is turned on, transit encryption must be turned on in the\n\t\t\t\tEFSVolumeConfiguration. If this parameter is omitted, the default value of\n\t\t\t\tDISABLED is used. For more information, see Using Amazon EFS access\n\t\t\t\tpoints in the Amazon Elastic Container Service Developer Guide.
The directory within the Amazon EFS file system to mount as the root directory inside the\n\t\t\thost. If this parameter is omitted, the root of the Amazon EFS volume will be used.\n\t\t\tSpecifying / will have the same effect as omitting this parameter.
If an EFS access point is specified in the authorizationConfig, the\n\t\t\t\troot directory parameter must either be omitted or set to / which will\n\t\t\t\tenforce the path set on the EFS access point.
The directory within the Amazon EFS file system to mount as the root directory inside the host. If this\n\t\t\tparameter is omitted, the root of the Amazon EFS volume will be used. Specifying / will have\n\t\t\tthe same effect as omitting this parameter.
If an EFS access point is specified in the authorizationConfig, the root directory\n\t\t\t\tparameter must either be omitted or set to / which will enforce the path set on the\n\t\t\t\tEFS access point.
Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host\n\t\t\tand the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization\n\t\t\tis used. If this parameter is omitted, the default value of DISABLED is\n\t\t\tused. For more information, see Encrypting data in transit in\n\t\t\tthe Amazon Elastic File System User Guide.
Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS\n\t\t\tserver. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is\n\t\t\tomitted, the default value of DISABLED is used. For more information, see Encrypting data in\n\t\t\t\ttransit in the Amazon Elastic File System User Guide.
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS\n\t\t\tserver. If you do not specify a transit encryption port, it will use the port selection\n\t\t\tstrategy that the Amazon EFS mount helper uses. For more information, see EFS mount\n\t\t\t\thelper in the Amazon Elastic File System User Guide.
" + "smithy.api#documentation": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do\n\t\t\tnot specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount\n\t\t\thelper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
" } }, "authorizationConfig": { @@ -5952,7 +5964,7 @@ } }, "traits": { - "smithy.api#documentation": "This parameter is specified when you're using an Amazon Elastic File System file system for task\n\t\t\tstorage. For more information, see Amazon EFS volumes in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more\n\t\t\tinformation, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#EnvironmentFile": { @@ -5961,20 +5973,20 @@ "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment\n\t\t\tvariable file.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable\n\t\t\tfile.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.ecs#EnvironmentFileType", "traits": { - "smithy.api#documentation": "The file type to use. Environment files are objects in Amazon S3. The only supported value\n\t\t\tis s3.
The file type to use. Environment files are objects in Amazon S3. The only supported value is\n\t\t\t\ts3.
A list of files containing the environment variables to pass to a container. You can\n\t\t\tspecify up to ten environment files. The file must have a .env file\n\t\t\textension. Each line in an environment file should contain an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored.
If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they're processed from the top down. We recommend that you use unique\n\t\t\tvariable names. For more information, see Use a file to pass\n\t\t\t\tenvironment variables to a container in the Amazon Elastic Container Service Developer Guide.
Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations\n\t\t\tapply.
\nYou must use the following platforms for the Fargate launch type:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
Consider the following when using the Fargate launch type:
\nThe file is handled like a native Docker env-file.
\nThere is no support for shell escape handling.
\nThe container entry point interperts the VARIABLE values.
A list of files containing the environment variables to pass to a container. You can specify up to\n\t\t\tten environment files. The file must have a .env file extension. Each line in an\n\t\t\tenvironment file should contain an environment variable in VARIABLE=VALUE format. Lines\n\t\t\tbeginning with # are treated as comments and are ignored.
If there are environment variables specified using the environment parameter in a\n\t\t\tcontainer definition, they take precedence over the variables contained within an environment file. If\n\t\t\tmultiple environment files are specified that contain the same variable, they're processed from the top\n\t\t\tdown. We recommend that you use unique variable names. For more information, see Use a file to\n\t\t\t\tpass environment variables to a container in the Amazon Elastic Container Service Developer Guide.
Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations apply.
\nYou must use the following platforms for the Fargate launch type:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
Consider the following when using the Fargate launch type:
\nThe file is handled like a native Docker env-file.
\nThere is no support for shell escape handling.
\nThe container entry point interperts the VARIABLE values.
The total amount, in GiB, of ephemeral storage to set for the task. The minimum\n\t\t\tsupported value is 20 GiB and the maximum supported value is\n\t\t\t\t200 GiB.
The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is\n\t\t\t\t20 GiB and the maximum supported value is 200 GiB.
The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Using data volumes in\n\t\t\t\ttasks in the Amazon ECS Developer Guide;.
\nFor tasks using the Fargate launch type, the task requires the\n\t\t\t\tfollowing platforms:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total\n\t\t\tamount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For\n\t\t\tmore information, see Using data volumes in tasks\n\t\t\tin the Amazon ECS Developer Guide;.
\nFor tasks using the Fargate launch type, the task requires the following\n\t\t\t\tplatforms:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
Runs a command remotely on a container within a task.
\nIf you use a condition key in your IAM policy to refine the conditions for the\n\t\t\tpolicy statement, for example limit the actions to a specific cluster, you receive an\n\t\t\t\tAccessDeniedException when there is a mismatch between the condition\n\t\t\tkey value and the corresponding parameter value.
For information about required permissions and considerations, see Using Amazon ECS\n\t\t\t\tExec for debugging in the Amazon ECS Developer Guide.\n\t\t
" + "smithy.api#documentation": "Runs a command remotely on a container within a task.
\nIf you use a condition key in your IAM policy to refine the conditions for the policy statement,\n\t\t\tfor example limit the actions to a specific cluster, you receive an AccessDeniedException\n\t\t\twhen there is a mismatch between the condition key value and the corresponding parameter value.
For information about required permissions and considerations, see Using Amazon ECS Exec for debugging in the\n\t\t\t\tAmazon ECS Developer Guide.
" } }, "com.amazonaws.ecs#ExecuteCommandConfiguration": { @@ -6054,19 +6066,19 @@ "kmsKeyId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "Specify an Key Management Service key ID to encrypt the data between the local client\n\t\t\tand the container.
" + "smithy.api#documentation": "Specify an Key Management Service key ID to encrypt the data between the local client and the\n\t\t\tcontainer.
" } }, "logging": { "target": "com.amazonaws.ecs#ExecuteCommandLogging", "traits": { - "smithy.api#documentation": "The log setting to use for redirecting logs for your execute command results. The\n\t\t\tfollowing log settings are available.
\n\n NONE: The execute command session is not logged.
\n DEFAULT: The awslogs configuration in the task\n\t\t\t\t\tdefinition is used. If no logging parameter is specified, it defaults to this\n\t\t\t\t\tvalue. If no awslogs log driver is configured in the task\n\t\t\t\t\tdefinition, the output won't be logged.
\n OVERRIDE: Specify the logging details as a part of\n\t\t\t\t\t\tlogConfiguration. If the OVERRIDE logging option\n\t\t\t\t\tis specified, the logConfiguration is required.
The log setting to use for redirecting logs for your execute command results. The following log\n\t\t\tsettings are available.
\n\n NONE: The execute command session is not logged.
\n DEFAULT: The awslogs configuration in the task definition is used.\n\t\t\t\t\tIf no logging parameter is specified, it defaults to this value. If no awslogs log\n\t\t\t\t\tdriver is configured in the task definition, the output won't be logged.
\n OVERRIDE: Specify the logging details as a part of\n\t\t\t\t\tlogConfiguration. If the OVERRIDE logging option is specified, the\n\t\t\t\t\t\tlogConfiguration is required.
The log configuration for the results of the execute command actions. The logs can be\n\t\t\tsent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is\n\t\t\tspecified, a logConfiguration must be provided.
The log configuration for the results of the execute command actions. The logs can be sent to\n\t\t\tCloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a\n\t\t\t\tlogConfiguration must be provided.
Determines whether to use encryption on the CloudWatch logs. If not specified,\n\t\t\tencryption will be off.
" + "smithy.api#documentation": "Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be\n\t\t\toff.
" } }, "s3BucketName": { @@ -6100,7 +6112,7 @@ "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Determines whether to use encryption on the S3 logs. If not specified, encryption is\n\t\t\tnot used.
" + "smithy.api#documentation": "Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.
" } }, "s3KeyPrefix": { @@ -6111,7 +6123,7 @@ } }, "traits": { - "smithy.api#documentation": "The log configuration for the results of the execute command actions. The logs can be\n\t\t\tsent to CloudWatch Logs or an Amazon S3 bucket.
" + "smithy.api#documentation": "The log configuration for the results of the execute command actions. The logs can be sent to\n\t\t\tCloudWatch Logs or an Amazon S3 bucket.
" } }, "com.amazonaws.ecs#ExecuteCommandLogging": { @@ -6149,7 +6161,7 @@ "container": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of the container to execute the command on. A container name only needs to be\n\t\t\tspecified for tasks containing multiple containers.
" + "smithy.api#documentation": "The name of the container to execute the command on. A container name only needs to be specified for\n\t\t\ttasks containing multiple containers.
" } }, "command": { @@ -6204,13 +6216,13 @@ "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Determines whether the execute command session is running in interactive mode. Amazon ECS\n\t\t\tonly supports initiating interactive sessions, so you must specify true for\n\t\t\tthis value.
Determines whether the execute command session is running in interactive mode. Amazon ECS only supports\n\t\t\tinitiating interactive sessions, so you must specify true for this value.
The details of the SSM session that was created for this instance of\n\t\t\texecute-command.
" + "smithy.api#documentation": "The details of the SSM session that was created for this instance of execute-command.
" } }, "taskArn": { @@ -6230,20 +6242,20 @@ "credentialsParameter": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The authorization credential option to use. The authorization credential options can\n\t\t\tbe provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store\n\t\t\tparameter. The ARN refers to the stored credentials.
", + "smithy.api#documentation": "The authorization credential option to use. The authorization credential options can be provided\n\t\t\tusing either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store parameter. The ARN refers to\n\t\t\tthe stored credentials.
", "smithy.api#required": {} } }, "domain": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on\n\t\t\tAmazon EC2.
", + "smithy.api#documentation": "A fully qualified domain name hosted by an Directory Service Managed\n\t\t\tMicrosoft AD (Active Directory) or self-hosted AD on Amazon EC2.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon ECS API\n\t\t\t\tReference.
\nFor more information and the input format, see Amazon FSx for Windows File Server Volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon ECS API\n\t\t\tReference.
\nFor more information and the input format, see Amazon FSx for Windows File Server Volumes in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#FSxWindowsFileServerVolumeConfiguration": { @@ -6259,7 +6271,7 @@ "rootDirectory": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The directory within the Amazon FSx for Windows File Server file system to mount as the root directory\n\t\t\tinside the host.
", + "smithy.api#documentation": "The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the\n\t\t\thost.
", "smithy.api#required": {} } }, @@ -6272,7 +6284,7 @@ } }, "traits": { - "smithy.api#documentation": "This parameter is specified when you're using Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.
\nFor more information and the input format, see Amazon FSx for Windows File Server volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "This parameter is specified when you're using Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.
\nFor more information and the input format, see Amazon FSx for Windows File Server volumes in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#Failure": { @@ -6298,7 +6310,7 @@ } }, "traits": { - "smithy.api#documentation": "A failed resource. For a list of common causes, see API failure\n\t\t\t\treasons in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "A failed resource. For a list of common causes, see API failure reasons in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#Failures": { @@ -6313,19 +6325,19 @@ "type": { "target": "com.amazonaws.ecs#FirelensConfigurationType", "traits": { - "smithy.api#documentation": "The log router to use. The valid values are fluentd or\n\t\t\t\tfluentbit.
The log router to use. The valid values are fluentd or fluentbit.
The options to use when configuring the log router. This field is optional and can be\n\t\t\tused to specify a custom configuration file or to add additional metadata, such as the\n\t\t\ttask, task definition, cluster, and container instance details to the log event. If\n\t\t\tspecified, the syntax to use is\n\t\t\t\t\"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}.\n\t\t\tFor more information, see Creating\n\t\t\t\ta task definition that uses a FireLens configuration in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
Tasks hosted on Fargate only support the file configuration file\n\t\t\t\ttype.
The options to use when configuring the log router. This field is optional and can be used to specify\n\t\t\ta custom configuration file or to add additional metadata, such as the task, task definition, cluster,\n\t\t\tand container instance details to the log event. If specified, the syntax to use is\n\t\t\t\t\"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}.\n\t\t\tFor more information, see Creating a task\n\t\t\t\tdefinition that uses a FireLens configuration in the Amazon Elastic Container Service Developer Guide.
Tasks hosted on Fargate only support the file configuration file type.
The FireLens configuration for the container. This is used to specify and configure a\n\t\t\tlog router for container logs. For more information, see Custom log routing\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The FireLens configuration for the container. This is used to specify and configure a log router for\n\t\t\tcontainer logs. For more information, see Custom log routing in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#FirelensConfigurationOptionsMap": { @@ -6415,7 +6427,7 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tsets exist in.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist\n\t\t\tin.
", "smithy.api#required": {} } }, @@ -6436,7 +6448,7 @@ "protectedTasks": { "target": "com.amazonaws.ecs#ProtectedTasks", "traits": { - "smithy.api#documentation": "A list of tasks with the following information.
\n\n taskArn: The task ARN.
\n protectionEnabled: The protection status of the task. If scale-in\n\t\t\t\t\tprotection is turned on for a task, the value is true. Otherwise,\n\t\t\t\t\tit is false.
\n expirationDate: The epoch time when protection for the task will\n\t\t\t\t\texpire.
A list of tasks with the following information.
\n\n taskArn: The task ARN.
\n protectionEnabled: The protection status of the task. If scale-in protection is\n\t\t\t\t\tturned on for a task, the value is true. Otherwise, it is\n\t\t\t\t\tfalse.
\n expirationDate: The epoch time when protection for the task will expire.
A string array representing the command that the container runs to determine if it is\n\t\t\thealthy. The string array must start with CMD to run the command arguments\n\t\t\tdirectly, or CMD-SHELL to run the command with the container's default\n\t\t\tshell.
When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list\n\t\t\tof commands in double quotes and brackets.
\n\n [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]\n
You don't include the double quotes and brackets when you use the Amazon Web Services Management Console.
\n\n CMD-SHELL, curl -f http://localhost/ || exit 1\n
An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n\t\t\tmore information, see HealthCheck in the docker container create command.
A string array representing the command that the container runs to determine if it is healthy. The\n\t\t\tstring array must start with CMD to run the command arguments directly, or\n\t\t\t\tCMD-SHELL to run the command with the container's default shell.
When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in\n\t\t\tdouble quotes and brackets.
\n\n [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]\n
You don't include the double quotes and brackets when you use the Amazon Web Services Management Console.
\n\n CMD-SHELL, curl -f http://localhost/ || exit 1\n
An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n\t\t\tmore information, see HealthCheck in the docker container create command.
The time period in seconds between each health check execution. You may specify\n\t\t\tbetween 5 and 300 seconds. The default value is 30 seconds.
" + "smithy.api#documentation": "The time period in seconds between each health check execution. You may specify between 5 and 300\n\t\t\tseconds. The default value is 30 seconds.
" } }, "timeout": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The time period in seconds to wait for a health check to succeed before it is\n\t\t\tconsidered a failure. You may specify between 2 and 60 seconds. The default value is\n\t\t\t5.
" + "smithy.api#documentation": "The time period in seconds to wait for a health check to succeed before it is considered a failure.\n\t\t\tYou may specify between 2 and 60 seconds. The default value is 5.
" } }, "retries": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The number of times to retry a failed health check before the container is considered\n\t\t\tunhealthy. You may specify between 1 and 10 retries. The default value is 3.
" + "smithy.api#documentation": "The number of times to retry a failed health check before the container is considered unhealthy. You\n\t\t\tmay specify between 1 and 10 retries. The default value is 3.
" } }, "startPeriod": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The optional grace period to provide containers time to bootstrap before failed health\n\t\t\tchecks count towards the maximum number of retries. You can specify between 0 and 300\n\t\t\tseconds. By default, the startPeriod is off.
If a health check succeeds within the startPeriod, then the container\n\t\t\t\tis considered healthy and any subsequent failures count toward the maximum number of\n\t\t\t\tretries.
The optional grace period to provide containers time to bootstrap before failed health checks count\n\t\t\ttowards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the\n\t\t\t\tstartPeriod is off.
If a health check succeeds within the startPeriod, then the container is considered\n\t\t\t\thealthy and any subsequent failures count toward the maximum number of retries.
An object representing a container health check. Health check parameters that are\n\t\t\tspecified in a container definition override any Docker health checks that exist in the\n\t\t\tcontainer image (such as those specified in a parent image or from the image's\n\t\t\tDockerfile). This configuration maps to the HEALTHCHECK parameter of docker run.
The Amazon ECS container agent only monitors and reports on the health checks specified\n\t\t\t\tin the task definition. Amazon ECS does not monitor Docker health checks that are\n\t\t\t\tembedded in a container image and not specified in the container definition. Health\n\t\t\t\tcheck parameters that are specified in a container definition override any Docker\n\t\t\t\thealth checks that exist in the container image.
\nYou can view the health status of both individual containers and a task with the\n\t\t\tDescribeTasks API operation or when viewing the task details in the console.
\nThe health check is designed to make sure that your containers survive agent restarts,\n\t\t\tupgrades, or temporary unavailability.
\nAmazon ECS performs health checks on containers with the default that launched the\n\t\t\tcontainer instance or the task.
\nThe following describes the possible healthStatus values for a\n\t\t\tcontainer:
\n HEALTHY-The container health check has passed\n\t\t\t\t\tsuccessfully.
\n UNHEALTHY-The container health check has failed.
\n UNKNOWN-The container health check is being evaluated,\n\t\t\t\t\tthere's no container health check defined, or Amazon ECS doesn't have the health\n\t\t\t\t\tstatus of the container.
The following describes the possible healthStatus values based on the\n\t\t\tcontainer health checker status of essential containers in the task with the following\n\t\t\tpriority order (high to low):
\n UNHEALTHY-One or more essential containers have failed\n\t\t\t\t\ttheir health check.
\n UNKNOWN-Any essential container running within the task is\n\t\t\t\t\tin an UNKNOWN state and no other essential containers have an\n\t\t\t\t\t\tUNHEALTHY state.
\n HEALTHY-All essential containers within the task have\n\t\t\t\t\tpassed their health checks.
Consider the following task health example with 2 containers.
\nIf Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tUNKNOWN, the task health is UNHEALTHY.
If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tHEALTHY, the task health is UNHEALTHY.
If Container1 is HEALTHY and Container2 is UNKNOWN,\n\t\t\t\t\tthe task health is UNKNOWN.
If Container1 is HEALTHY and Container2 is HEALTHY,\n\t\t\t\t\tthe task health is HEALTHY.
Consider the following task health example with 3 containers.
\nIf Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tUNKNOWN, and Container3 is UNKNOWN, the task health is\n\t\t\t\t\t\tUNHEALTHY.
If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tUNKNOWN, and Container3 is HEALTHY, the task health is\n\t\t\t\t\t\tUNHEALTHY.
If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tHEALTHY, and Container3 is HEALTHY, the task health is\n\t\t\t\t\t\tUNHEALTHY.
If Container1 is HEALTHY and Container2 is UNKNOWN,\n\t\t\t\t\tand Container3 is HEALTHY, the task health is\n\t\t\t\t\tUNKNOWN.
If Container1 is HEALTHY and Container2 is UNKNOWN,\n\t\t\t\t\tand Container3 is UNKNOWN, the task health is\n\t\t\t\t\tUNKNOWN.
If Container1 is HEALTHY and Container2 is HEALTHY,\n\t\t\t\t\tand Container3 is HEALTHY, the task health is\n\t\t\t\t\tHEALTHY.
If a task is run manually, and not as part of a service, the task will continue its\n\t\t\tlifecycle regardless of its health status. For tasks that are part of a service, if the\n\t\t\ttask reports as unhealthy then the task will be stopped and the service scheduler will\n\t\t\treplace it.
\nThe following are notes about container health check support:
\nIf the Amazon ECS container agent becomes disconnected from the Amazon ECS service, this\n\t\t\t\t\twon't cause a container to transition to an UNHEALTHY status. This\n\t\t\t\t\tis by design, to ensure that containers remain running during agent restarts or\n\t\t\t\t\ttemporary unavailability. The health check status is the \"last heard from\"\n\t\t\t\t\tresponse from the Amazon ECS agent, so if the container was considered\n\t\t\t\t\t\tHEALTHY prior to the disconnect, that status will remain until\n\t\t\t\t\tthe agent reconnects and another health check occurs. There are no assumptions\n\t\t\t\t\tmade about the status of the container health checks.
Container health checks require version 1.17.0 or greater of the\n\t\t\t\t\tAmazon ECS container agent. For more information, see Updating the\n\t\t\t\t\t\tAmazon ECS container agent.
Container health checks are supported for Fargate tasks if\n\t\t\t\t\tyou're using platform version 1.1.0 or greater. For more\n\t\t\t\t\tinformation, see Fargate\n\t\t\t\t\t\tplatform versions.
Container health checks aren't supported for tasks that are part of a service\n\t\t\t\t\tthat's configured to use a Classic Load Balancer.
\nAn object representing a container health check. Health check parameters that are specified in a\n\t\t\tcontainer definition override any Docker health checks that exist in the container image (such as those\n\t\t\tspecified in a parent image or from the image's Dockerfile). This configuration maps to the\n\t\t\t\tHEALTHCHECK parameter of docker run.
The Amazon ECS container agent only monitors and reports on the health checks specified in the task\n\t\t\t\tdefinition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and\n\t\t\t\tnot specified in the container definition. Health check parameters that are specified in a\n\t\t\t\tcontainer definition override any Docker health checks that exist in the container image.
\nYou can view the health status of both individual containers and a task with the DescribeTasks API\n\t\t\toperation or when viewing the task details in the console.
\nThe health check is designed to make sure that your containers survive agent restarts, upgrades, or\n\t\t\ttemporary unavailability.
\nAmazon ECS performs health checks on containers with the default that launched the container instance or\n\t\t\tthe task.
\nThe following describes the possible healthStatus values for a container:
\n HEALTHY-The container health check has passed successfully.
\n UNHEALTHY-The container health check has failed.
\n UNKNOWN-The container health check is being evaluated, there's no\n\t\t\t\t\tcontainer health check defined, or Amazon ECS doesn't have the health status of the\n\t\t\t\t\tcontainer.
The following describes the possible healthStatus values based on the container health\n\t\t\tchecker status of essential containers in the task with the following priority order (high to\n\t\t\tlow):
\n UNHEALTHY-One or more essential containers have failed their health\n\t\t\t\t\tcheck.
\n UNKNOWN-Any essential container running within the task is in an\n\t\t\t\t\t\tUNKNOWN state and no other essential containers have an UNHEALTHY\n\t\t\t\t\tstate.
\n HEALTHY-All essential containers within the task have passed their health\n\t\t\t\t\tchecks.
Consider the following task health example with 2 containers.
\nIf Container1 is UNHEALTHY and Container2 is UNKNOWN, the task\n\t\t\t\t\thealth is UNHEALTHY.
If Container1 is UNHEALTHY and Container2 is HEALTHY, the task\n\t\t\t\t\thealth is UNHEALTHY.
If Container1 is HEALTHY and Container2 is UNKNOWN, the task health\n\t\t\t\t\tis UNKNOWN.
If Container1 is HEALTHY and Container2 is HEALTHY, the task health\n\t\t\t\t\tis HEALTHY.
Consider the following task health example with 3 containers.
\nIf Container1 is UNHEALTHY and Container2 is UNKNOWN, and\n\t\t\t\t\tContainer3 is UNKNOWN, the task health is UNHEALTHY.
If Container1 is UNHEALTHY and Container2 is UNKNOWN, and\n\t\t\t\t\tContainer3 is HEALTHY, the task health is UNHEALTHY.
If Container1 is UNHEALTHY and Container2 is HEALTHY, and\n\t\t\t\t\tContainer3 is HEALTHY, the task health is UNHEALTHY.
If Container1 is HEALTHY and Container2 is UNKNOWN, and Container3\n\t\t\t\t\tis HEALTHY, the task health is UNKNOWN.
If Container1 is HEALTHY and Container2 is UNKNOWN, and Container3\n\t\t\t\t\tis UNKNOWN, the task health is UNKNOWN.
If Container1 is HEALTHY and Container2 is HEALTHY, and Container3\n\t\t\t\t\tis HEALTHY, the task health is HEALTHY.
If a task is run manually, and not as part of a service, the task will continue its lifecycle\n\t\t\tregardless of its health status. For tasks that are part of a service, if the task reports as unhealthy\n\t\t\tthen the task will be stopped and the service scheduler will replace it.
\nThe following are notes about container health check support:
\nIf the Amazon ECS container agent becomes disconnected from the Amazon ECS service, this won't cause a\n\t\t\t\t\tcontainer to transition to an UNHEALTHY status. This is by design, to ensure that\n\t\t\t\t\tcontainers remain running during agent restarts or temporary unavailability. The health check\n\t\t\t\t\tstatus is the \"last heard from\" response from the Amazon ECS agent, so if the container was\n\t\t\t\t\tconsidered HEALTHY prior to the disconnect, that status will remain until the\n\t\t\t\t\tagent reconnects and another health check occurs. There are no assumptions made about the\n\t\t\t\t\tstatus of the container health checks.
Container health checks require version 1.17.0 or greater of the Amazon ECS container\n\t\t\t\t\tagent. For more information, see Updating the Amazon ECS container\n\t\t\t\t\t\tagent.
Container health checks are supported for Fargate tasks if you're using\n\t\t\t\t\tplatform version 1.1.0 or greater. For more information, see Fargate\n\t\t\t\t\t\tplatform versions.
Container health checks aren't supported for tasks that are part of a service that's\n\t\t\t\t\tconfigured to use a Classic Load Balancer.
\nHostnames and IP address entries that are added to the /etc/hosts file of\n\t\t\ta container via the extraHosts parameter of its ContainerDefinition.
Hostnames and IP address entries that are added to the /etc/hosts file of a container\n\t\t\tvia the extraHosts parameter of its ContainerDefinition.\n\t\t
When the host parameter is used, specify a sourcePath to\n\t\t\tdeclare the path on the host container instance that's presented to the container. If\n\t\t\tthis parameter is empty, then the Docker daemon has assigned a host path for you. If the\n\t\t\t\thost parameter contains a sourcePath file location, then\n\t\t\tthe data volume persists at the specified location on the host container instance until\n\t\t\tyou delete it manually. If the sourcePath value doesn't exist on the host\n\t\t\tcontainer instance, the Docker daemon creates it. If the location does exist, the\n\t\t\tcontents of the source path folder are exported.
If you're using the Fargate launch type, the sourcePath\n\t\t\tparameter is not supported.
When the host parameter is used, specify a sourcePath to declare the path\n\t\t\ton the host container instance that's presented to the container. If this parameter is empty, then the\n\t\t\tDocker daemon has assigned a host path for you. If the host parameter contains a\n\t\t\t\tsourcePath file location, then the data volume persists at the specified location on\n\t\t\tthe host container instance until you delete it manually. If the sourcePath value doesn't\n\t\t\texist on the host container instance, the Docker daemon creates it. If the location does exist, the\n\t\t\tcontents of the source path folder are exported.
If you're using the Fargate launch type, the sourcePath parameter is not\n\t\t\tsupported.
The Elastic Inference accelerator device name. The deviceName must also\n\t\t\tbe referenced in a container definition as a ResourceRequirement.
The Elastic Inference accelerator device name. The deviceName must also be referenced in\n\t\t\ta container definition as a ResourceRequirement.
Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on\n\t\t\t\tAmazon ECS in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#InferenceAcceleratorOverride": { @@ -6591,7 +6603,7 @@ "deviceName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Elastic Inference accelerator device name to override for the task. This parameter\n\t\t\tmust match a deviceName specified in the task definition.
The Elastic Inference accelerator device name to override for the task. This parameter must match a\n\t\t\t\tdeviceName specified in the task definition.
Details on an Elastic Inference accelerator task override. This parameter is used to\n\t\t\toverride the Elastic Inference accelerator specified in the task definition. For more\n\t\t\tinformation, see Working with Amazon\n\t\t\t\tElastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Details on an Elastic Inference accelerator task override. This parameter is used to override the\n\t\t\tElastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#InferenceAcceleratorOverrides": { @@ -6635,7 +6647,7 @@ "lastUpdated": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp for when the container instance health status was last\n\t\t\tupdated.
" + "smithy.api#documentation": "The Unix timestamp for when the container instance health status was last updated.
" } }, "lastStatusChange": { @@ -6718,7 +6730,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified parameter isn't valid. Review the available parameters for the API\n\t\t\trequest.
", + "smithy.api#documentation": "The specified parameter isn't valid. Review the available parameters for the API request.
", "smithy.api#error": "client" } }, @@ -6751,18 +6763,18 @@ "add": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "The Linux capabilities for the container that have been added to the default\n\t\t\tconfiguration provided by Docker. This parameter maps to CapAdd in the docker container create command and the\n\t\t\t\t--cap-add option to docker\n\t\t\t\trun.
Tasks launched on Fargate only support adding the SYS_PTRACE kernel\n\t\t\t\tcapability.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n\t\t\t\t\"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n\t\t\t\t\"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n\t\t\t\t\"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n\t\t\t\t| \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n\t\t\t\t\"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n\t\t\t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\t\t\t\"WAKE_ALARM\"\n
The Linux capabilities for the container that have been added to the default configuration provided\n\t\t\tby Docker. This parameter maps to CapAdd in the docker container create command and the\n\t\t\t\t--cap-add option to docker run.
Tasks launched on Fargate only support adding the SYS_PTRACE kernel\n\t\t\t\tcapability.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" |\n\t\t\t\t\"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" |\n\t\t\t\t\"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" |\n\t\t\t\t\"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" |\n\t\t\t\t\"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" |\n\t\t\t\t\"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\t\t\t\"WAKE_ALARM\"\n
The Linux capabilities for the container that have been removed from the default\n\t\t\tconfiguration provided by Docker. This parameter maps to CapDrop in the docker container create command and the\n\t\t\t\t--cap-drop option to docker\n\t\t\t\trun.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n\t\t\t\t\"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n\t\t\t\t\"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n\t\t\t\t\"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n\t\t\t\t| \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n\t\t\t\t\"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n\t\t\t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\t\t\t\"WAKE_ALARM\"\n
The Linux capabilities for the container that have been removed from the default configuration\n\t\t\tprovided by Docker. This parameter maps to CapDrop in the docker container create command\n\t\t\tand the --cap-drop option to docker run.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" |\n\t\t\t\t\"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" |\n\t\t\t\t\"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" |\n\t\t\t\t\"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" |\n\t\t\t\t\"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" |\n\t\t\t\t\"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\t\t\t\"WAKE_ALARM\"\n
The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more detailed information about these Linux capabilities,\n\t\t\tsee the capabilities(7) Linux manual page.
" + "smithy.api#documentation": "The Linux capabilities to add or remove from the default Docker configuration for a container defined\n\t\t\tin the task definition. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual\n\t\t\tpage.
" } }, "com.amazonaws.ecs#KeyValuePair": { @@ -6771,13 +6783,13 @@ "name": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of the key-value pair. For environment variables, this is the name of the\n\t\t\tenvironment variable.
" + "smithy.api#documentation": "The name of the key-value pair. For environment variables, this is the name of the environment\n\t\t\tvariable.
" } }, "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The value of the key-value pair. For environment variables, this is the value of the\n\t\t\tenvironment variable.
" + "smithy.api#documentation": "The value of the key-value pair. For environment variables, this is the value of the environment\n\t\t\tvariable.
" } } }, @@ -6829,43 +6841,43 @@ "capabilities": { "target": "com.amazonaws.ecs#KernelCapabilities", "traits": { - "smithy.api#documentation": "The Linux capabilities for the container that are added to or dropped from the default\n\t\t\tconfiguration provided by Docker.
\nFor tasks that use the Fargate launch type,\n\t\t\t\t\tcapabilities is supported for all platform versions but the\n\t\t\t\t\tadd parameter is only supported if using platform version 1.4.0 or\n\t\t\t\tlater.
The Linux capabilities for the container that are added to or dropped from the default configuration\n\t\t\tprovided by Docker.
\nFor tasks that use the Fargate launch type, capabilities is supported\n\t\t\t\tfor all platform versions but the add parameter is only supported if using platform\n\t\t\t\tversion 1.4.0 or later.
Any host devices to expose to the container. This parameter maps to\n\t\t\tDevices in the docker container create command and the --device option to docker run.
If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tdevices parameter isn't supported.
Any host devices to expose to the container. This parameter maps to Devices in the\n\t\t\tdocker container create command and the --device option to docker run.
If you're using tasks that use the Fargate launch type, the devices\n\t\t\t\tparameter isn't supported.
Run an init process inside the container that forwards signals and reaps\n\t\t\tprocesses. This parameter maps to the --init option to docker run.\n\t\t\tThis parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
Run an init process inside the container that forwards signals and reaps processes. This\n\t\t\tparameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
The value for the size (in MiB) of the /dev/shm volume. This parameter\n\t\t\tmaps to the --shm-size option to docker\n\t\t\t\trun.
If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tsharedMemorySize parameter is not supported.
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the\n\t\t\t\t--shm-size option to docker run.
If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tsharedMemorySize parameter is not supported.
The container path, mount options, and size (in MiB) of the tmpfs mount. This\n\t\t\tparameter maps to the --tmpfs option to docker run.
If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\ttmpfs parameter isn't supported.
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the\n\t\t\t\t--tmpfs option to docker run.
If you're using tasks that use the Fargate launch type, the tmpfs\n\t\t\t\tparameter isn't supported.
The total amount of swap memory (in MiB) a container can use. This parameter will be\n\t\t\ttranslated to the --memory-swap option to docker run where the value would be the sum of\n\t\t\tthe container memory plus the maxSwap value.
If a maxSwap value of 0 is specified, the container will not\n\t\t\tuse swap. Accepted values are 0 or any positive integer. If the\n\t\t\t\tmaxSwap parameter is omitted, the container will use the swap\n\t\t\tconfiguration for the container instance it is running on. A maxSwap value\n\t\t\tmust be set for the swappiness parameter to be used.
If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tmaxSwap parameter isn't supported.
If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't\n\t\t\t\tsupported.
The total amount of swap memory (in MiB) a container can use. This parameter will be translated to\n\t\t\tthe --memory-swap option to docker run where the value would be the sum of the container\n\t\t\tmemory plus the maxSwap value.
If a maxSwap value of 0 is specified, the container will not use swap.\n\t\t\tAccepted values are 0 or any positive integer. If the maxSwap parameter is\n\t\t\tomitted, the container will use the swap configuration for the container instance it is running on. A\n\t\t\t\tmaxSwap value must be set for the swappiness parameter to be used.
If you're using tasks that use the Fargate launch type, the maxSwap\n\t\t\t\tparameter isn't supported.
If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't supported.
This allows you to tune a container's memory swappiness behavior. A\n\t\t\t\tswappiness value of 0 will cause swapping to not happen\n\t\t\tunless absolutely necessary. A swappiness value of 100 will\n\t\t\tcause pages to be swapped very aggressively. Accepted values are whole numbers between\n\t\t\t\t0 and 100. If the swappiness parameter is not\n\t\t\tspecified, a default value of 60 is used. If a value is not specified for\n\t\t\t\tmaxSwap then this parameter is ignored. This parameter maps to the\n\t\t\t\t--memory-swappiness option to docker run.
If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tswappiness parameter isn't supported.
If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't\n\t\t\t\tsupported.
This allows you to tune a container's memory swappiness behavior. A swappiness value of\n\t\t\t\t0 will cause swapping to not happen unless absolutely necessary. A\n\t\t\t\tswappiness value of 100 will cause pages to be swapped very aggressively.\n\t\t\tAccepted values are whole numbers between 0 and 100. If the\n\t\t\t\tswappiness parameter is not specified, a default value of 60 is used. If\n\t\t\ta value is not specified for maxSwap then this parameter is ignored. This parameter maps\n\t\t\tto the --memory-swappiness option to docker run.
If you're using tasks that use the Fargate launch type, the swappiness\n\t\t\t\tparameter isn't supported.
If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't supported.
The value of the account settings to filter results with. You must also specify an\n\t\t\taccount setting name to use this parameter.
" + "smithy.api#documentation": "The value of the account settings to filter results with. You must also specify an account setting\n\t\t\tname to use this parameter.
" } }, "principalArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The ARN of the principal, which can be a user, role, or the root user. If this field is\n\t\t\tomitted, the account settings are listed only for the authenticated user.
\nFederated users assume the account setting of the root user and can't have explicit\n\t\t\t\taccount settings set for them.
\nThe ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the\n\t\t\taccount settings are listed only for the authenticated user.
\nFederated users assume the account setting of the root user and can't have explicit account settings\n\t\t\t\tset for them.
\nDetermines whether to return the effective settings. If true, the account\n\t\t\tsettings for the root user or the default setting for the principalArn are\n\t\t\treturned. If false, the account settings for the principalArn\n\t\t\tare returned if they're set. Otherwise, no account settings are returned.
Determines whether to return the effective settings. If true, the account settings for\n\t\t\tthe root user or the default setting for the principalArn are returned. If\n\t\t\tfalse, the account settings for the principalArn are returned if they're set.\n\t\t\tOtherwise, no account settings are returned.
The nextToken value returned from a ListAccountSettings\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults was provided, it's possible the number\n\t\t\tof results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken value returned from a ListAccountSettings request indicating\n\t\t\tthat more results are available to fulfill the request and further calls will be needed. If\n\t\t\t\tmaxResults was provided, it's possible the number of results to be fewer than\n\t\t\t\tmaxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of account setting results returned by\n\t\t\t\tListAccountSettings in paginated output. When this parameter is used,\n\t\t\t\tListAccountSettings only returns maxResults results in a\n\t\t\tsingle page along with a nextToken response element. The remaining results\n\t\t\tof the initial request can be seen by sending another ListAccountSettings\n\t\t\trequest with the returned nextToken value. This value can be between\n\t\t\t1 and 10. If this\n\t\t\tparameter isn't used, then ListAccountSettings returns up to\n\t\t\t10 results and a nextToken value\n\t\t\tif applicable.
The maximum number of account setting results returned by ListAccountSettings in\n\t\t\tpaginated output. When this parameter is used, ListAccountSettings only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken response\n\t\t\telement. The remaining results of the initial request can be seen by sending another\n\t\t\t\tListAccountSettings request with the returned nextToken value. This value\n\t\t\tcan be between 1 and 10. If this\n\t\t\tparameter isn't used, then ListAccountSettings returns up to\n\t\t\t10 results and a nextToken value if\n\t\t\tapplicable.
The nextToken value to include in a future\n\t\t\t\tListAccountSettings request. When the results of a\n\t\t\t\tListAccountSettings request exceed maxResults, this value\n\t\t\tcan be used to retrieve the next page of results. This value is null when\n\t\t\tthere are no more results to return.
The nextToken value to include in a future ListAccountSettings request.\n\t\t\tWhen the results of a ListAccountSettings request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null when there are\n\t\t\tno more results to return.
Lists the attributes for Amazon ECS resources within a specified target type and cluster.\n\t\t\tWhen you specify a target type and cluster, ListAttributes returns a list\n\t\t\tof attribute objects, one for each attribute on each resource. You can filter the list\n\t\t\tof results to a single attribute name to only return results that have that name. You\n\t\t\tcan also filter the results by attribute name and value. You can do this, for example,\n\t\t\tto see which container instances in a cluster are running a Linux AMI\n\t\t\t\t(ecs.os-type=linux).
Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify\n\t\t\ta target type and cluster, ListAttributes returns a list of attribute objects, one for\n\t\t\teach attribute on each resource. You can filter the list of results to a single attribute name to only\n\t\t\treturn results that have that name. You can also filter the results by attribute name and value. You\n\t\t\tcan do this, for example, to see which container instances in a cluster are running a Linux AMI\n\t\t\t\t(ecs.os-type=linux).
The short name or full Amazon Resource Name (ARN) of the cluster to list attributes.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.
" } }, "targetType": { @@ -7074,19 +7086,19 @@ "attributeValue": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The value of the attribute to filter results with. You must also specify an attribute\n\t\t\tname to use this parameter.
" + "smithy.api#documentation": "The value of the attribute to filter results with. You must also specify an attribute name to use\n\t\t\tthis parameter.
" } }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The nextToken value returned from a ListAttributes request\n\t\t\tindicating that more results are available to fulfill the request and further calls are\n\t\t\tneeded. If maxResults was provided, it's possible the number of results to\n\t\t\tbe fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken value returned from a ListAttributes request indicating that\n\t\t\tmore results are available to fulfill the request and further calls are needed. If\n\t\t\t\tmaxResults was provided, it's possible the number of results to be fewer than\n\t\t\t\tmaxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of cluster results that ListAttributes returned in\n\t\t\tpaginated output. When this parameter is used, ListAttributes only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListAttributes request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter isn't used, then ListAttributes returns up to\n\t\t\t100 results and a nextToken value if applicable.
The maximum number of cluster results that ListAttributes returned in paginated output.\n\t\t\tWhen this parameter is used, ListAttributes only returns maxResults results\n\t\t\tin a single page along with a nextToken response element. The remaining results of the\n\t\t\tinitial request can be seen by sending another ListAttributes request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and 100. If\n\t\t\tthis parameter isn't used, then ListAttributes returns up to 100 results\n\t\t\tand a nextToken value if applicable.
The nextToken value to include in a future ListAttributes\n\t\t\trequest. When the results of a ListAttributes request exceed\n\t\t\t\tmaxResults, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null when there are no more results to\n\t\t\treturn.
The nextToken value to include in a future ListAttributes request. When the\n\t\t\tresults of a ListAttributes request exceed maxResults, this value can be used\n\t\t\tto retrieve the next page of results. This value is null when there are no more results to\n\t\t\treturn.
The nextToken value returned from a ListClusters request\n\t\t\tindicating that more results are available to fulfill the request and further calls are\n\t\t\tneeded. If maxResults was provided, it's possible the number of results to\n\t\t\tbe fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken value returned from a ListClusters request indicating that\n\t\t\tmore results are available to fulfill the request and further calls are needed. If\n\t\t\t\tmaxResults was provided, it's possible the number of results to be fewer than\n\t\t\t\tmaxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of cluster results that ListClusters returned in\n\t\t\tpaginated output. When this parameter is used, ListClusters only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListClusters request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter isn't used, then ListClusters returns up to 100\n\t\t\tresults and a nextToken value if applicable.
The maximum number of cluster results that ListClusters returned in paginated output.\n\t\t\tWhen this parameter is used, ListClusters only returns maxResults results in\n\t\t\ta single page along with a nextToken response element. The remaining results of the\n\t\t\tinitial request can be seen by sending another ListClusters request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and 100. If\n\t\t\tthis parameter isn't used, then ListClusters returns up to 100 results\n\t\t\tand a nextToken value if applicable.
The list of full Amazon Resource Name (ARN) entries for each cluster that's associated with your\n\t\t\taccount.
" + "smithy.api#documentation": "The list of full Amazon Resource Name (ARN) entries for each cluster that's associated with your account.
" } }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The nextToken value to include in a future ListClusters\n\t\t\trequest. When the results of a ListClusters request exceed\n\t\t\t\tmaxResults, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null when there are no more results to\n\t\t\treturn.
The nextToken value to include in a future ListClusters request. When the\n\t\t\tresults of a ListClusters request exceed maxResults, this value can be used\n\t\t\tto retrieve the next page of results. This value is null when there are no more results to\n\t\t\treturn.
Returns a list of container instances in a specified cluster. You can filter the\n\t\t\tresults of a ListContainerInstances operation with cluster query language\n\t\t\tstatements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
Returns a list of container instances in a specified cluster. You can filter the results of a\n\t\t\t\tListContainerInstances operation with cluster query language statements inside the\n\t\t\t\tfilter parameter. For more information, see Cluster\n\t\t\t\tQuery Language in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to\n\t\t\tlist. If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "filter": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "You can filter the results of a ListContainerInstances operation with\n\t\t\tcluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
You can filter the results of a ListContainerInstances operation with cluster query\n\t\t\tlanguage statements. For more information, see Cluster\n\t\t\t\tQuery Language in the Amazon Elastic Container Service Developer Guide.
The nextToken value returned from a ListContainerInstances\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls are needed. If maxResults was provided, it's possible the number of\n\t\t\tresults to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken value returned from a ListContainerInstances request\n\t\t\tindicating that more results are available to fulfill the request and further calls are needed. If\n\t\t\t\tmaxResults was provided, it's possible the number of results to be fewer than\n\t\t\t\tmaxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of container instance results that\n\t\t\t\tListContainerInstances returned in paginated output. When this\n\t\t\tparameter is used, ListContainerInstances only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListContainerInstances request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and\n\t\t\t100. If this parameter isn't used, then\n\t\t\t\tListContainerInstances returns up to 100 results and\n\t\t\ta nextToken value if applicable.
The maximum number of container instance results that ListContainerInstances returned in\n\t\t\tpaginated output. When this parameter is used, ListContainerInstances only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken response\n\t\t\telement. The remaining results of the initial request can be seen by sending another\n\t\t\t\tListContainerInstances request with the returned nextToken value. This\n\t\t\tvalue can be between 1 and 100. If this parameter isn't used, then\n\t\t\t\tListContainerInstances returns up to 100 results and a\n\t\t\t\tnextToken value if applicable.
Filters the container instances by status. For example, if you specify the\n\t\t\t\tDRAINING status, the results include only container instances that have\n\t\t\tbeen set to DRAINING using UpdateContainerInstancesState.\n\t\t\tIf you don't specify this parameter, the default is to include container instances set\n\t\t\tto all states other than INACTIVE.
Filters the container instances by status. For example, if you specify the DRAINING\n\t\t\tstatus, the results include only container instances that have been set to DRAINING using\n\t\t\t\tUpdateContainerInstancesState. If you don't specify this parameter, the default is to\n\t\t\tinclude container instances set to all states other than INACTIVE.
The list of container instances with full ARN entries for each container instance\n\t\t\tassociated with the specified cluster.
" + "smithy.api#documentation": "The list of container instances with full ARN entries for each container instance associated with\n\t\t\tthe specified cluster.
" } }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The nextToken value to include in a future\n\t\t\t\tListContainerInstances request. When the results of a\n\t\t\t\tListContainerInstances request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null\n\t\t\twhen there are no more results to return.
The nextToken value to include in a future ListContainerInstances request.\n\t\t\tWhen the results of a ListContainerInstances request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null when there are\n\t\t\tno more results to return.
The maximum number of service deployment results that ListServiceDeployments\n\t\t\treturned in paginated output. When this parameter is used,\n\t\t\t\tListServiceDeployments only returns maxResults results in\n\t\t\ta single page along with a nextToken response element. The remaining\n\t\t\tresults of the initial request can be seen by sending another\n\t\t\t\tListServiceDeployments request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If this parameter isn't used, then\n\t\t\t\tListServiceDeployments returns up to 20 results and a\n\t\t\t\tnextToken value if applicable.
The maximum number of service deployment results that ListServiceDeployments\n\t\t\treturned in paginated output. When this parameter is used,\n\t\t\tListServiceDeployments only returns maxResults results in\n\t\t\ta single page along with a nextToken response element. The remaining\n\t\t\tresults of the initial request can be seen by sending another\n\t\t\tListServiceDeployments request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If this parameter isn't used, then\n\t\t\tListServiceDeployments returns up to 20 results and a\n\t\t\tnextToken value if applicable.
Returns a list of services. You can filter the results by cluster, launch type, and\n\t\t\tscheduling strategy.
", + "smithy.api#documentation": "Returns a list of services. You can filter the results by cluster, launch type, and scheduling\n\t\t\tstrategy.
", "smithy.api#examples": [ { "title": "To list the services in a cluster", @@ -7474,7 +7486,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation lists all of the services that are associated with a Cloud Map\n\t\t\tnamespace. This list might include services in different clusters. In contrast,\n\t\t\t\tListServices can only list services in one cluster at a time. If you\n\t\t\tneed to filter the list of services in a single cluster by various parameters, use\n\t\t\t\tListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
This operation lists all of the services that are associated with a Cloud Map namespace. This list\n\t\t\tmight include services in different clusters. In contrast, ListServices can only list\n\t\t\tservices in one cluster at a time. If you need to filter the list of services in a single cluster by\n\t\t\tvarious parameters, use ListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
The nextToken value that's returned from a\n\t\t\t\tListServicesByNamespace request. It indicates that more results are\n\t\t\tavailable to fulfill the request and further calls are needed. If\n\t\t\t\tmaxResults is returned, it is possible the number of results is less\n\t\t\tthan maxResults.
The nextToken value that's returned from a ListServicesByNamespace request.\n\t\t\tIt indicates that more results are available to fulfill the request and further calls are needed. If\n\t\t\t\tmaxResults is returned, it is possible the number of results is less than\n\t\t\t\tmaxResults.
The maximum number of service results that ListServicesByNamespace\n\t\t\treturns in paginated output. When this parameter is used,\n\t\t\t\tListServicesByNamespace only returns maxResults results in\n\t\t\ta single page along with a nextToken response element. The remaining\n\t\t\tresults of the initial request can be seen by sending another\n\t\t\t\tListServicesByNamespace request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and\n\t\t\t100. If this parameter isn't used, then\n\t\t\t\tListServicesByNamespace returns up to\n\t\t\t10 results and a nextToken\n\t\t\tvalue if applicable.
The maximum number of service results that ListServicesByNamespace returns in paginated\n\t\t\toutput. When this parameter is used, ListServicesByNamespace only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken response\n\t\t\telement. The remaining results of the initial request can be seen by sending another\n\t\t\t\tListServicesByNamespace request with the returned nextToken value. This\n\t\t\tvalue can be between 1 and 100. If this parameter\n\t\t\tisn't used, then ListServicesByNamespace returns up to\n\t\t\t10 results and a nextToken value if\n\t\t\tapplicable.
The nextToken value to include in a future\n\t\t\t\tListServicesByNamespace request. When the results of a\n\t\t\t\tListServicesByNamespace request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. When there are no more results\n\t\t\tto return, this value is null.
The nextToken value to include in a future ListServicesByNamespace request.\n\t\t\tWhen the results of a ListServicesByNamespace request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. When there are no more results to return, this\n\t\t\tvalue is null.
The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the\n\t\t\t\tListServices results. If you do not specify a cluster, the default cluster is assumed.
The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListServices\n\t\t\tresults. If you do not specify a cluster, the default cluster is assumed.
The nextToken value returned from a ListServices request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken value returned from a ListServices request indicating that\n\t\t\tmore results are available to fulfill the request and further calls will be needed. If\n\t\t\t\tmaxResults was provided, it is possible the number of results to be fewer than\n\t\t\t\tmaxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of service results that ListServices returned in\n\t\t\tpaginated output. When this parameter is used, ListServices only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListServices request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If\n\t\t\tthis parameter isn't used, then ListServices returns up to\n\t\t\t10 results and a nextToken value if\n\t\t\tapplicable.
The maximum number of service results that ListServices returned in paginated output.\n\t\t\tWhen this parameter is used, ListServices only returns maxResults results in\n\t\t\ta single page along with a nextToken response element. The remaining results of the\n\t\t\tinitial request can be seen by sending another ListServices request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and\n\t\t\t100. If this parameter isn't used, then ListServices returns up to\n\t\t\t10 results and a nextToken value if applicable.
The scheduling strategy to use when filtering the ListServices\n\t\t\tresults.
The scheduling strategy to use when filtering the ListServices results.
The list of full ARN entries for each service that's associated with the specified\n\t\t\tcluster.
" + "smithy.api#documentation": "The list of full ARN entries for each service that's associated with the specified cluster.
" } }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The nextToken value to include in a future ListServices\n\t\t\trequest. When the results of a ListServices request exceed\n\t\t\t\tmaxResults, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null when there are no more results to\n\t\t\treturn.
The nextToken value to include in a future ListServices request. When the\n\t\t\tresults of a ListServices request exceed maxResults, this value can be used\n\t\t\tto retrieve the next page of results. This value is null when there are no more results to\n\t\t\treturn.
The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the\n\t\t\tsupported resources are Amazon ECS tasks, services, task definitions, clusters, and container\n\t\t\tinstances.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources\n\t\t\tare Amazon ECS tasks, services, task definitions, clusters, and container instances.
", "smithy.api#required": {} } } @@ -7680,7 +7692,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of task definition families that are registered to your account. This\n\t\t\tlist includes task definition families that no longer have any ACTIVE task\n\t\t\tdefinition revisions.
You can filter out task definition families that don't contain any ACTIVE\n\t\t\ttask definition revisions by setting the status parameter to\n\t\t\t\tACTIVE. You can also filter the results with the\n\t\t\t\tfamilyPrefix parameter.
Returns a list of task definition families that are registered to your account. This list includes\n\t\t\ttask definition families that no longer have any ACTIVE task definition revisions.
You can filter out task definition families that don't contain any ACTIVE task\n\t\t\tdefinition revisions by setting the status parameter to ACTIVE. You can also\n\t\t\tfilter the results with the familyPrefix parameter.
The familyPrefix is a string that's used to filter the results of\n\t\t\t\tListTaskDefinitionFamilies. If you specify a familyPrefix,\n\t\t\tonly task definition family names that begin with the familyPrefix string\n\t\t\tare returned.
The familyPrefix is a string that's used to filter the results of\n\t\t\t\tListTaskDefinitionFamilies. If you specify a familyPrefix, only task\n\t\t\tdefinition family names that begin with the familyPrefix string are returned.
The task definition family status to filter the\n\t\t\t\tListTaskDefinitionFamilies results with. By default, both\n\t\t\t\tACTIVE and INACTIVE task definition families are listed.\n\t\t\tIf this parameter is set to ACTIVE, only task definition families that have\n\t\t\tan ACTIVE task definition revision are returned. If this parameter is set\n\t\t\tto INACTIVE, only task definition families that do not have any\n\t\t\t\tACTIVE task definition revisions are returned. If you paginate the\n\t\t\tresulting output, be sure to keep the status value constant in each\n\t\t\tsubsequent request.
The task definition family status to filter the ListTaskDefinitionFamilies results with.\n\t\t\tBy default, both ACTIVE and INACTIVE task definition families are listed. If\n\t\t\tthis parameter is set to ACTIVE, only task definition families that have an\n\t\t\t\tACTIVE task definition revision are returned. If this parameter is set to\n\t\t\t\tINACTIVE, only task definition families that do not have any ACTIVE task\n\t\t\tdefinition revisions are returned. If you paginate the resulting output, be sure to keep the\n\t\t\t\tstatus value constant in each subsequent request.
The nextToken value returned from a\n\t\t\t\tListTaskDefinitionFamilies request indicating that more results are\n\t\t\tavailable to fulfill the request and further calls will be needed. If\n\t\t\t\tmaxResults was provided, it is possible the number of results to be\n\t\t\tfewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken value returned from a ListTaskDefinitionFamilies request\n\t\t\tindicating that more results are available to fulfill the request and further calls will be needed. If\n\t\t\t\tmaxResults was provided, it is possible the number of results to be fewer than\n\t\t\t\tmaxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of task definition family results that\n\t\t\t\tListTaskDefinitionFamilies returned in paginated output. When this\n\t\t\tparameter is used, ListTaskDefinitions only returns maxResults\n\t\t\tresults in a single page along with a nextToken response element. The\n\t\t\tremaining results of the initial request can be seen by sending another\n\t\t\t\tListTaskDefinitionFamilies request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and\n\t\t\t100. If this parameter isn't used, then\n\t\t\t\tListTaskDefinitionFamilies returns up to 100 results\n\t\t\tand a nextToken value if applicable.
The maximum number of task definition family results that ListTaskDefinitionFamilies\n\t\t\treturned in paginated output. When this parameter is used, ListTaskDefinitions only\n\t\t\treturns maxResults results in a single page along with a nextToken response\n\t\t\telement. The remaining results of the initial request can be seen by sending another\n\t\t\t\tListTaskDefinitionFamilies request with the returned nextToken value.\n\t\t\tThis value can be between 1 and 100. If this parameter isn't used, then\n\t\t\t\tListTaskDefinitionFamilies returns up to 100 results and a\n\t\t\t\tnextToken value if applicable.
The list of task definition family names that match the\n\t\t\t\tListTaskDefinitionFamilies request.
The list of task definition family names that match the ListTaskDefinitionFamilies\n\t\t\trequest.
The nextToken value to include in a future\n\t\t\t\tListTaskDefinitionFamilies request. When the results of a\n\t\t\t\tListTaskDefinitionFamilies request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null\n\t\t\twhen there are no more results to return.
The nextToken value to include in a future ListTaskDefinitionFamilies\n\t\t\trequest. When the results of a ListTaskDefinitionFamilies request exceed\n\t\t\t\tmaxResults, this value can be used to retrieve the next page of results. This value is\n\t\t\t\tnull when there are no more results to return.
Returns a list of task definitions that are registered to your account. You can filter\n\t\t\tthe results by family name with the familyPrefix parameter or by status\n\t\t\twith the status parameter.
Returns a list of task definitions that are registered to your account. You can filter the results by\n\t\t\tfamily name with the familyPrefix parameter or by status with the status\n\t\t\tparameter.
The full family name to filter the ListTaskDefinitions results with.\n\t\t\tSpecifying a familyPrefix limits the listed task definitions to task\n\t\t\tdefinition revisions that belong to that family.
The full family name to filter the ListTaskDefinitions results with. Specifying a\n\t\t\t\tfamilyPrefix limits the listed task definitions to task definition revisions that\n\t\t\tbelong to that family.
The task definition status to filter the ListTaskDefinitions results\n\t\t\twith. By default, only ACTIVE task definitions are listed. By setting this\n\t\t\tparameter to INACTIVE, you can view task definitions that are\n\t\t\t\tINACTIVE as long as an active task or service still references them. If\n\t\t\tyou paginate the resulting output, be sure to keep the status value\n\t\t\tconstant in each subsequent request.
The task definition status to filter the ListTaskDefinitions results with. By default,\n\t\t\tonly ACTIVE task definitions are listed. By setting this parameter to\n\t\t\t\tINACTIVE, you can view task definitions that are INACTIVE as long as an\n\t\t\tactive task or service still references them. If you paginate the resulting output, be sure to keep the\n\t\t\t\tstatus value constant in each subsequent request.
The order to sort the results in. Valid values are ASC and\n\t\t\t\tDESC. By default, (ASC) task definitions are listed\n\t\t\tlexicographically by family name and in ascending numerical order by revision so that\n\t\t\tthe newest task definitions in a family are listed last. Setting this parameter to\n\t\t\t\tDESC reverses the sort order on family name and revision. This is so\n\t\t\tthat the newest task definitions in a family are listed first.
The order to sort the results in. Valid values are ASC and DESC. By\n\t\t\tdefault, (ASC) task definitions are listed lexicographically by family name and in\n\t\t\tascending numerical order by revision so that the newest task definitions in a family are listed last.\n\t\t\tSetting this parameter to DESC reverses the sort order on family name and revision. This\n\t\t\tis so that the newest task definitions in a family are listed first.
The nextToken value returned from a ListTaskDefinitions\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults was provided, it is possible the number\n\t\t\tof results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken value returned from a ListTaskDefinitions request indicating\n\t\t\tthat more results are available to fulfill the request and further calls will be needed. If\n\t\t\t\tmaxResults was provided, it is possible the number of results to be fewer than\n\t\t\t\tmaxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of task definition results that ListTaskDefinitions\n\t\t\treturned in paginated output. When this parameter is used,\n\t\t\t\tListTaskDefinitions only returns maxResults results in a\n\t\t\tsingle page along with a nextToken response element. The remaining results\n\t\t\tof the initial request can be seen by sending another ListTaskDefinitions\n\t\t\trequest with the returned nextToken value. This value can be between\n\t\t\t1 and 100. If this parameter isn't used, then\n\t\t\t\tListTaskDefinitions returns up to 100 results and a\n\t\t\t\tnextToken value if applicable.
The maximum number of task definition results that ListTaskDefinitions returned in\n\t\t\tpaginated output. When this parameter is used, ListTaskDefinitions only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken response\n\t\t\telement. The remaining results of the initial request can be seen by sending another\n\t\t\t\tListTaskDefinitions request with the returned nextToken value. This value\n\t\t\tcan be between 1 and 100. If this parameter isn't used, then\n\t\t\t\tListTaskDefinitions returns up to 100 results and a\n\t\t\t\tnextToken value if applicable.
The nextToken value to include in a future\n\t\t\t\tListTaskDefinitions request. When the results of a\n\t\t\t\tListTaskDefinitions request exceed maxResults, this value\n\t\t\tcan be used to retrieve the next page of results. This value is null when\n\t\t\tthere are no more results to return.
The nextToken value to include in a future ListTaskDefinitions request.\n\t\t\tWhen the results of a ListTaskDefinitions request exceed maxResults, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null when there are\n\t\t\tno more results to return.
Returns a list of tasks. You can filter the results by cluster, task definition\n\t\t\tfamily, container instance, launch type, what IAM principal started the task, or by\n\t\t\tthe desired status of the task.
\nRecently stopped tasks might appear in the returned results.
", + "smithy.api#documentation": "Returns a list of tasks. You can filter the results by cluster, task definition family, container\n\t\t\tinstance, launch type, what IAM principal started the task, or by the desired status of the\n\t\t\ttask.
\nRecently stopped tasks might appear in the returned results.
", "smithy.api#examples": [ { "title": "To list the tasks on a particular container instance", @@ -7945,49 +7957,49 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the\n\t\t\t\tListTasks results. If you do not specify a cluster, the default cluster is assumed.
The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks\n\t\t\tresults. If you do not specify a cluster, the default cluster is assumed.
The container instance ID or full ARN of the container instance to use when\n\t\t\tfiltering the ListTasks results. Specifying a\n\t\t\t\tcontainerInstance limits the results to tasks that belong to that\n\t\t\tcontainer instance.
The container instance ID or full ARN of the container instance to use when filtering the\n\t\t\t\tListTasks results. Specifying a containerInstance limits the results to\n\t\t\ttasks that belong to that container instance.
The name of the task definition family to use when filtering the\n\t\t\t\tListTasks results. Specifying a family limits the results\n\t\t\tto tasks that belong to that family.
The name of the task definition family to use when filtering the ListTasks results.\n\t\t\tSpecifying a family limits the results to tasks that belong to that family.
The nextToken value returned from a ListTasks request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults was provided, it's possible the number of results\n\t\t\tto be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken value returned from a ListTasks request indicating that more\n\t\t\tresults are available to fulfill the request and further calls will be needed. If\n\t\t\t\tmaxResults was provided, it's possible the number of results to be fewer than\n\t\t\t\tmaxResults.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of task results that ListTasks returned in paginated\n\t\t\toutput. When this parameter is used, ListTasks only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListTasks request with the returned nextToken value.\n\t\t\tThis value can be between 1 and 100. If this parameter\n\t\t\tisn't used, then ListTasks returns up to 100 results and\n\t\t\ta nextToken value if applicable.
The maximum number of task results that ListTasks returned in paginated output. When\n\t\t\tthis parameter is used, ListTasks only returns maxResults results in a single\n\t\t\tpage along with a nextToken response element. The remaining results of the initial request\n\t\t\tcan be seen by sending another ListTasks request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If this parameter isn't used,\n\t\t\tthen ListTasks returns up to 100 results and a nextToken\n\t\t\tvalue if applicable.
The startedBy value to filter the task results with. Specifying a\n\t\t\t\tstartedBy value limits the results to tasks that were started with that\n\t\t\tvalue.
When you specify startedBy as the filter, it must be the only filter that\n\t\t\tyou use.
The startedBy value to filter the task results with. Specifying a startedBy\n\t\t\tvalue limits the results to tasks that were started with that value.
When you specify startedBy as the filter, it must be the only filter that you\n\t\t\tuse.
The name of the service to use when filtering the ListTasks results.\n\t\t\tSpecifying a serviceName limits the results to tasks that belong to that\n\t\t\tservice.
The name of the service to use when filtering the ListTasks results. Specifying a\n\t\t\t\tserviceName limits the results to tasks that belong to that service.
The task desired status to use when filtering the ListTasks results.\n\t\t\tSpecifying a desiredStatus of STOPPED limits the results to\n\t\t\ttasks that Amazon ECS has set the desired status to STOPPED. This can be useful\n\t\t\tfor debugging tasks that aren't starting properly or have died or finished. The default\n\t\t\tstatus filter is RUNNING, which shows tasks that Amazon ECS has set the desired\n\t\t\tstatus to RUNNING.
Although you can filter results based on a desired status of PENDING,\n\t\t\t\tthis doesn't return any results. Amazon ECS never sets the desired status of a task to\n\t\t\t\tthat value (only a task's lastStatus may have a value of\n\t\t\t\t\tPENDING).
The task desired status to use when filtering the ListTasks results. Specifying a\n\t\t\t\tdesiredStatus of STOPPED limits the results to tasks that Amazon ECS has set\n\t\t\tthe desired status to STOPPED. This can be useful for debugging tasks that aren't starting\n\t\t\tproperly or have died or finished. The default status filter is RUNNING, which shows tasks\n\t\t\tthat Amazon ECS has set the desired status to RUNNING.
Although you can filter results based on a desired status of PENDING, this doesn't\n\t\t\t\treturn any results. Amazon ECS never sets the desired status of a task to that value (only a task's\n\t\t\t\t\tlastStatus may have a value of PENDING).
The nextToken value to include in a future ListTasks\n\t\t\trequest. When the results of a ListTasks request exceed\n\t\t\t\tmaxResults, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null when there are no more results to\n\t\t\treturn.
The nextToken value to include in a future ListTasks request. When the\n\t\t\tresults of a ListTasks request exceed maxResults, this value can be used to\n\t\t\tretrieve the next page of results. This value is null when there are no more results to\n\t\t\treturn.
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n\t\t\ttask set.
\nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
\nFor services using the ECS deployment controller, you can specify one or\n\t\t\tmultiple target groups. For more information, see Registering multiple target groups with a service in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY deployment controller, you're required\n\t\t\tto define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc network mode, you\n\t\t\t\tmust choose ip as the target type, not instance. Do this\n\t\t\t\twhen creating your target groups because tasks that use the awsvpc\n\t\t\t\tnetwork mode are associated with an elastic network interface, not an Amazon EC2\n\t\t\t\tinstance. This network mode is required for the Fargate launch\n\t\t\t\ttype.
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
\nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
\nFor services using the ECS deployment controller, you can specify one or multiple target\n\t\t\tgroups. For more information, see Registering multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY deployment controller, you're required to define two\n\t\t\ttarget groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc network mode, you must choose\n\t\t\t\t\tip as the target type, not instance. Do this when creating your\n\t\t\t\ttarget groups because tasks that use the awsvpc network mode are associated with an\n\t\t\t\telastic network interface, not an Amazon EC2 instance. This network mode is required for the\n\t\t\t\tFargate launch type.
The name of the load balancer to associate with the service or task set.
\nIf you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be\n\t\t\tomitted.
" + "smithy.api#documentation": "The name of the load balancer to associate with the Amazon ECS service or task set.
\nIf you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
" } }, "containerName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of the container (as it appears in a container definition) to associate with\n\t\t\tthe load balancer.
\nYou need to specify the container name when configuring the target group for an Amazon ECS\n\t\t\tload balancer.
" + "smithy.api#documentation": "The name of the container (as it appears in a container definition) to associate with the load\n\t\t\tbalancer.
\nYou need to specify the container name when configuring the target group for an Amazon ECS load\n\t\t\tbalancer.
" } }, "containerPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The port on the container to associate with the load balancer. This port must\n\t\t\tcorrespond to a containerPort in the task definition the tasks in the\n\t\t\tservice are using. For tasks that use the EC2 launch type, the container\n\t\t\tinstance they're launched on must allow ingress traffic on the hostPort of\n\t\t\tthe port mapping.
The port on the container to associate with the load balancer. This port must correspond to a\n\t\t\t\tcontainerPort in the task definition the tasks in the service are using. For tasks\n\t\t\tthat use the EC2 launch type, the container instance they're launched on must allow\n\t\t\tingress traffic on the hostPort of the port mapping.
The load balancer configuration to use with a service or task set.
\nWhen you add, update, or remove a load balancer configuration, Amazon ECS starts a new\n\t\t\tdeployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and\n\t\t\tderegister from load balancers.
\nWe recommend that you verify this on a test environment before you update the Elastic Load Balancing\n\t\t\tconfiguration.
\nA service-linked role is required for services that use multiple target groups. For\n\t\t\tmore information, see Using\n\t\t\t\tservice-linked roles in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The load balancer configuration to use with a service or task set.
\nWhen you add, update, or remove a load balancer configuration, Amazon ECS starts a new deployment with the\n\t\t\tupdated Elastic Load Balancing configuration. This causes tasks to register to and deregister from load\n\t\t\tbalancers.
\nWe recommend that you verify this on a test environment before you update the Elastic Load Balancing configuration.
\nA service-linked role is required for services that use multiple target groups. For more information,\n\t\t\tsee Using service-linked roles in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#LoadBalancers": { @@ -8065,25 +8077,25 @@ "logDriver": { "target": "com.amazonaws.ecs#LogDriver", "traits": { - "smithy.api#documentation": "The log driver to use for the container.
\nFor tasks on Fargate, the supported log drivers are awslogs,\n\t\t\t\tsplunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are\n\t\t\t\tawslogs, fluentd, gelf,\n\t\t\t\tjson-file, journald, syslog,\n\t\t\t\tsplunk, and awsfirelens.
For more information about using the awslogs log driver, see Send\n\t\t\t\tAmazon ECS logs to CloudWatch in the Amazon Elastic Container Service Developer Guide.
For more information about using the awsfirelens log driver, see Send\n\t\t\t\tAmazon ECS logs to an Amazon Web Services service or Amazon Web Services Partner.
If you have a custom driver that isn't listed, you can fork the Amazon ECS container\n\t\t\t\tagent project that's available\n\t\t\t\t\ton GitHub and customize it to work with that driver. We encourage you to\n\t\t\t\tsubmit pull requests for changes that you would like to have included. However, we\n\t\t\t\tdon't currently provide support for running modified copies of this software.
\nThe log driver to use for the container.
\nFor tasks on Fargate, the supported log drivers are awslogs, splunk, and\n\t\t\t\tawsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs,\n\t\t\t\tfluentd, gelf, json-file, journald,\n\t\t\t\tsyslog, splunk, and awsfirelens.
For more information about using the awslogs log driver, see Send Amazon ECS logs to CloudWatch in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
For more information about using the awsfirelens log driver, see Send Amazon ECS logs to\n\t\t\t\tan Amazon Web Services service or Amazon Web Services Partner.
If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project\n\t\t\t\tthat's available on GitHub and\n\t\t\t\tcustomize it to work with that driver. We encourage you to submit pull requests for changes that\n\t\t\t\tyou would like to have included. However, we don't currently provide support for running modified\n\t\t\t\tcopies of this software.
\nThe configuration options to send to the log driver.
\nThe options you can specify depend on the log driver. Some\n\t\t\t\tof the options you can specify when you use the awslogs log driver to route logs to\n\t\t\t\tAmazon CloudWatch include the following:
Required: No
\nSpecify whether you want the log group to be\n\t\t\t\t\t\t\tcreated automatically. If this option isn't\n\t\t\t\t\t\t\tspecified, it defaults to\n\t\t\t\t\t\t\tfalse.
Your IAM policy must include the\n\t\t\t\t\t\t\t\tlogs:CreateLogGroup permission before\n\t\t\t\t\t\t\t\tyou attempt to use\n\t\t\t\t\t\t\t\tawslogs-create-group.
Required: Yes
\nSpecify the Amazon Web Services Region that the\n\t\t\t\t\t\t\tawslogs log driver is to send your\n\t\t\t\t\t\t\tDocker logs to. You can choose to send all of your\n\t\t\t\t\t\t\tlogs from clusters in different Regions to a\n\t\t\t\t\t\t\tsingle region in CloudWatch Logs. This is so that they're\n\t\t\t\t\t\t\tall visible in one location. Otherwise, you can\n\t\t\t\t\t\t\tseparate them by Region for more granularity. Make\n\t\t\t\t\t\t\tsure that the specified log group exists in the\n\t\t\t\t\t\t\tRegion that you specify with this option.
Required: Yes
\nMake sure to specify a log group that the\n\t\t\t\t\t\t\tawslogs log driver sends its log\n\t\t\t\t\t\t\tstreams to.
Required: Yes, when\n\t\t\t\t\t\t\tusing the Fargate launch\n\t\t\t\t\t\t\ttype.Optional for\n\t\t\t\t\t\t\t\tthe EC2 launch type, required for\n\t\t\t\t\t\t\t\tthe Fargate launch\n\t\t\t\t\t\t\t\ttype.
\nUse the awslogs-stream-prefix\n\t\t\t\t\t\t\toption to associate a log stream with the\n\t\t\t\t\t\t\tspecified prefix, the container name, and the ID\n\t\t\t\t\t\t\tof the Amazon ECS task that the container belongs to.\n\t\t\t\t\t\t\tIf you specify a prefix with this option, then the\n\t\t\t\t\t\t\tlog stream takes the format prefix-name/container-name/ecs-task-id.
If you don't specify a prefix\n\t\t\t\t\t\t\twith this option, then the log stream is named\n\t\t\t\t\t\t\tafter the container ID that's assigned by the\n\t\t\t\t\t\t\tDocker daemon on the container instance. Because\n\t\t\t\t\t\t\tit's difficult to trace logs back to the container\n\t\t\t\t\t\t\tthat sent them with just the Docker container ID\n\t\t\t\t\t\t\t(which is only available on the container\n\t\t\t\t\t\t\tinstance), we recommend that you specify a prefix\n\t\t\t\t\t\t\twith this option.
\nFor Amazon ECS services, you can use the service\n\t\t\t\t\t\t\tname as the prefix. Doing so, you can trace log\n\t\t\t\t\t\t\tstreams to the service that the container belongs\n\t\t\t\t\t\t\tto, the name of the container that sent them, and\n\t\t\t\t\t\t\tthe ID of the task that the container belongs\n\t\t\t\t\t\t\tto.
\nYou must specify a\n\t\t\t\t\t\t\tstream-prefix for your logs to have your logs\n\t\t\t\t\t\t\tappear in the Log pane when using the Amazon ECS\n\t\t\t\t\t\t\tconsole.
\nRequired: No
\nThis option defines a multiline start pattern\n\t\t\t\t\t\t\tin Python strftime format. A log\n\t\t\t\t\t\t\tmessage consists of a line that matches the\n\t\t\t\t\t\t\tpattern and any following lines that don’t match\n\t\t\t\t\t\t\tthe pattern. The matched line is the delimiter\n\t\t\t\t\t\t\tbetween log messages.
One example of a use case for using this\n\t\t\t\t\t\t\tformat is for parsing output such as a stack dump,\n\t\t\t\t\t\t\twhich might otherwise be logged in multiple\n\t\t\t\t\t\t\tentries. The correct pattern allows it to be\n\t\t\t\t\t\t\tcaptured in a single entry.
\nFor more information, see awslogs-datetime-format.
\nYou cannot configure both the\n\t\t\t\t\t\t\tawslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern\n\t\t\t\t\t\t\toptions.
Multiline logging performs regular\n\t\t\t\t\t\t\t\texpression parsing and matching of all log\n\t\t\t\t\t\t\t\tmessages. This might have a negative impact on\n\t\t\t\t\t\t\t\tlogging performance.
\nRequired: No
\nThis option defines a multiline start pattern\n\t\t\t\t\t\t\tthat uses a regular expression. A log message\n\t\t\t\t\t\t\tconsists of a line that matches the pattern and\n\t\t\t\t\t\t\tany following lines that don’t match the pattern.\n\t\t\t\t\t\t\tThe matched line is the delimiter between log\n\t\t\t\t\t\t\tmessages.
\nFor more information, see awslogs-multiline-pattern.
\nThis option is ignored if\n\t\t\t\t\t\t\tawslogs-datetime-format is also\n\t\t\t\t\t\t\tconfigured.
You cannot configure both the\n\t\t\t\t\t\t\tawslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern\n\t\t\t\t\t\t\toptions.
Multiline logging performs regular\n\t\t\t\t\t\t\t\texpression parsing and matching of all log\n\t\t\t\t\t\t\t\tmessages. This might have a negative impact on\n\t\t\t\t\t\t\t\tlogging performance.
\nRequired: No
\nValid values: non-blocking |\n\t\t\t\t\t\t\tblocking\n
This option defines the delivery mode of log\n\t\t\t\t\t\t\tmessages from the container to CloudWatch Logs. The delivery\n\t\t\t\t\t\t\tmode you choose affects application availability\n\t\t\t\t\t\t\twhen the flow of logs from container to CloudWatch is\n\t\t\t\t\t\t\tinterrupted.
\nIf you use the blocking\n\t\t\t\t\t\t\tmode and the flow of logs to CloudWatch is interrupted,\n\t\t\t\t\t\t\tcalls from container code to write to the\n\t\t\t\t\t\t\tstdout and stderr\n\t\t\t\t\t\t\tstreams will block. The logging thread of the\n\t\t\t\t\t\t\tapplication will block as a result. This may cause\n\t\t\t\t\t\t\tthe application to become unresponsive and lead to\n\t\t\t\t\t\t\tcontainer healthcheck failure.
If you use the non-blocking mode,\n\t\t\t\t\t\t\tthe container's logs are instead stored in an\n\t\t\t\t\t\t\tin-memory intermediate buffer configured with the\n\t\t\t\t\t\t\tmax-buffer-size option. This prevents\n\t\t\t\t\t\t\tthe application from becoming unresponsive when\n\t\t\t\t\t\t\tlogs cannot be sent to CloudWatch. We recommend using this mode if you want to\n\t\t\t\t\t\t\tensure service availability and are okay with some\n\t\t\t\t\t\t\tlog loss. For more information, see Preventing log loss with non-blocking mode in the awslogs container log driver.
Required: No
\nDefault value: 1m\n
When non-blocking mode is used,\n\t\t\t\t\t\t\tthe max-buffer-size log option\n\t\t\t\t\t\t\tcontrols the size of the buffer that's used for\n\t\t\t\t\t\t\tintermediate message storage. Make sure to specify\n\t\t\t\t\t\t\tan adequate buffer size based on your application.\n\t\t\t\t\t\t\tWhen the buffer fills up, further logs cannot be\n\t\t\t\t\t\t\tstored. Logs that cannot be stored are lost.\n\t\t\t\t\t\t
To route logs using the splunk log router, you need to specify a\n\t\t\t\tsplunk-token and a\n\t\t\t\tsplunk-url.
When you use the awsfirelens log router to route logs to an Amazon Web Services Service or\n\t\t\t\tAmazon Web Services Partner Network destination for log storage and analytics, you can\n\t\t\t\tset the log-driver-buffer-limit option to limit\n\t\t\t\tthe number of events that are buffered in memory, before\n\t\t\t\tbeing sent to the log router container. It can help to\n\t\t\t\tresolve potential log loss issue because high throughput\n\t\t\t\tmight result in memory running out for the buffer inside of\n\t\t\t\tDocker.
Other options you can specify when using awsfirelens to route\n\t\t\t\tlogs depend on the destination. When you export logs to\n\t\t\t\tAmazon Data Firehose, you can specify the Amazon Web Services Region with\n\t\t\t\tregion and a name for the log stream with\n\t\t\t\tdelivery_stream.
When you export logs to\n\t\t\t\tAmazon Kinesis Data Streams, you can specify an Amazon Web Services Region with\n\t\t\t\tregion and a data stream name with\n\t\t\t\tstream.
When you export logs to Amazon OpenSearch Service,\n\t\t\t\tyou can specify options like Name,\n\t\t\t\tHost (OpenSearch Service endpoint without protocol), Port,\n\t\t\t\tIndex, Type,\n\t\t\t\tAws_auth, Aws_region, Suppress_Type_Name, and\n\t\t\t\ttls.
When you export logs to Amazon S3, you can\n\t\t\t\t\tspecify the bucket using the bucket option. You can also specify region,\n\t\t\t\t\ttotal_file_size, upload_timeout,\n\t\t\t\t\tand use_put_object as options.
This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
The configuration options to send to the log driver.
\nThe options you can specify depend on the log driver. Some of the options you can specify when you\n\t\t\tuse the awslogs log driver to route logs to Amazon CloudWatch include the following:
Required: No
\nSpecify whether you want the log group to be created automatically. If this option isn't\n\t\t\t\t\t\tspecified, it defaults to false.
Your IAM policy must include the logs:CreateLogGroup permission before\n\t\t\t\t\t\t\tyou attempt to use awslogs-create-group.
Required: Yes
\nSpecify the Amazon Web Services Region that the awslogs log driver is to send your Docker\n\t\t\t\t\t\tlogs to. You can choose to send all of your logs from clusters in different Regions to a\n\t\t\t\t\t\tsingle region in CloudWatch Logs. This is so that they're all visible in one location. Otherwise, you\n\t\t\t\t\t\tcan separate them by Region for more granularity. Make sure that the specified log group\n\t\t\t\t\t\texists in the Region that you specify with this option.
Required: Yes
\nMake sure to specify a log group that the awslogs log driver sends its log\n\t\t\t\t\t\tstreams to.
Required: Yes, when using the Fargate launch\n\t\t\t\t\t\t\ttype.Optional for the EC2 launch type, required for the\n\t\t\t\t\t\t\tFargate launch type.
\nUse the awslogs-stream-prefix option to associate a log stream with the\n\t\t\t\t\t\tspecified prefix, the container name, and the ID of the Amazon ECS task that the container\n\t\t\t\t\t\tbelongs to. If you specify a prefix with this option, then the log stream takes the format\n\t\t\t\t\t\t\tprefix-name/container-name/ecs-task-id.
If you don't specify a prefix with this option, then the log stream is named after the\n\t\t\t\t\t\tcontainer ID that's assigned by the Docker daemon on the container instance. Because it's\n\t\t\t\t\t\tdifficult to trace logs back to the container that sent them with just the Docker container\n\t\t\t\t\t\tID (which is only available on the container instance), we recommend that you specify a\n\t\t\t\t\t\tprefix with this option.
\nFor Amazon ECS services, you can use the service name as the prefix. Doing so, you can trace\n\t\t\t\t\t\tlog streams to the service that the container belongs to, the name of the container that\n\t\t\t\t\t\tsent them, and the ID of the task that the container belongs to.
\nYou must specify a stream-prefix for your logs to have your logs appear in the Log pane\n\t\t\t\t\t\twhen using the Amazon ECS console.
\nRequired: No
\nThis option defines a multiline start pattern in Python strftime format. A\n\t\t\t\t\t\tlog message consists of a line that matches the pattern and any following lines that don’t\n\t\t\t\t\t\tmatch the pattern. The matched line is the delimiter between log messages.
One example of a use case for using this format is for parsing output such as a stack\n\t\t\t\t\t\tdump, which might otherwise be logged in multiple entries. The correct pattern allows it to\n\t\t\t\t\t\tbe captured in a single entry.
\nFor more information, see awslogs-datetime-format.
\nYou cannot configure both the awslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern options.
Multiline logging performs regular expression parsing and matching of all log\n\t\t\t\t\t\t\tmessages. This might have a negative impact on logging performance.
\nRequired: No
\nThis option defines a multiline start pattern that uses a regular expression. A log\n\t\t\t\t\t\tmessage consists of a line that matches the pattern and any following lines that don’t\n\t\t\t\t\t\tmatch the pattern. The matched line is the delimiter between log messages.
\nFor more information, see awslogs-multiline-pattern.
\nThis option is ignored if awslogs-datetime-format is also configured.
You cannot configure both the awslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern options.
Multiline logging performs regular expression parsing and matching of all log\n\t\t\t\t\t\t\tmessages. This might have a negative impact on logging performance.
\nRequired: No
\nValid values: non-blocking | blocking\n
This option defines the delivery mode of log messages from the container to CloudWatch Logs. The\n\t\t\t\t\t\tdelivery mode you choose affects application availability when the flow of logs from\n\t\t\t\t\t\tcontainer to CloudWatch is interrupted.
\nIf you use the blocking mode and the flow of logs to CloudWatch is interrupted,\n\t\t\t\t\t\tcalls from container code to write to the stdout and stderr\n\t\t\t\t\t\tstreams will block. The logging thread of the application will block as a result. This may\n\t\t\t\t\t\tcause the application to become unresponsive and lead to container healthcheck failure.
If you use the non-blocking mode, the container's logs are instead stored in\n\t\t\t\t\t\tan in-memory intermediate buffer configured with the max-buffer-size option.\n\t\t\t\t\t\tThis prevents the application from becoming unresponsive when logs cannot be sent to CloudWatch.\n\t\t\t\t\t\tWe recommend using this mode if you want to ensure service availability and are okay with\n\t\t\t\t\t\tsome log loss. For more information, see Preventing log loss with non-blocking mode in the awslogs container log\n\t\t\t\t\t\t\tdriver.
Required: No
\nDefault value: 1m\n
When non-blocking mode is used, the max-buffer-size log option\n\t\t\t\t\t\tcontrols the size of the buffer that's used for intermediate message storage. Make sure to\n\t\t\t\t\t\tspecify an adequate buffer size based on your application. When the buffer fills up,\n\t\t\t\t\t\tfurther logs cannot be stored. Logs that cannot be stored are lost.
To route logs using the splunk log router, you need to specify a\n\t\t\t\tsplunk-token and a splunk-url.
When you use the awsfirelens log router to route logs to an Amazon Web Services Service or Amazon Web Services Partner Network\n\t\t\tdestination for log storage and analytics, you can set the log-driver-buffer-limit option\n\t\t\tto limit the number of events that are buffered in memory, before being sent to the log router\n\t\t\tcontainer. It can help to resolve potential log loss issue because high throughput might result in\n\t\t\tmemory running out for the buffer inside of Docker.
Other options you can specify when using awsfirelens to route logs depend on the\n\t\t\tdestination. When you export logs to Amazon Data Firehose, you can specify the Amazon Web Services Region with\n\t\t\t\tregion and a name for the log stream with delivery_stream.
When you export logs to Amazon Kinesis Data Streams, you can specify an Amazon Web Services Region with region and a\n\t\t\tdata stream name with stream.
When you export logs to Amazon OpenSearch Service, you can specify options like Name, Host\n\t\t\t(OpenSearch Service endpoint without protocol), Port, Index, Type,\n\t\t\t\tAws_auth, Aws_region, Suppress_Type_Name, and\n\t\t\t\ttls.
When you export logs to Amazon S3, you can specify the bucket using the bucket option. You\n\t\t\tcan also specify region, total_file_size, upload_timeout, and\n\t\t\t\tuse_put_object as options.
This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n
The secrets to pass to the log configuration. For more information, see Specifying\n\t\t\t\tsensitive data in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The secrets to pass to the log configuration. For more information, see Specifying sensitive\n\t\t\t\tdata in the Amazon Elastic Container Service Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "The log configuration for the container. This parameter maps to LogConfig\n\t\t\tin the docker container create command and the\n\t\t\t\t--log-driver option to docker\n\t\t\t\t\trun.
By default, containers use the same logging driver that the Docker daemon uses.\n\t\t\tHowever, the container might use a different logging driver than the Docker daemon by\n\t\t\tspecifying a log driver configuration in the container definition.
\nUnderstand the following when specifying a log configuration for your\n\t\t\tcontainers.
\nAmazon ECS currently supports a subset of the logging drivers available to the\n\t\t\t\t\tDocker daemon. Additional log drivers may be available in future releases of the\n\t\t\t\t\tAmazon ECS container agent.
\nFor tasks on Fargate, the supported log drivers are awslogs,\n\t\t\t\t\t\tsplunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are\n\t\t\t\t\t\tawslogs, fluentd, gelf,\n\t\t\t\t\t\tjson-file, journald,syslog,\n\t\t\t\t\t\tsplunk, and awsfirelens.
This parameter requires version 1.18 of the Docker Remote API or greater on\n\t\t\t\t\tyour container instance.
\nFor tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must\n\t\t\t\t\tregister the available logging drivers with the\n\t\t\t\t\t\tECS_AVAILABLE_LOGGING_DRIVERS environment variable before\n\t\t\t\t\tcontainers placed on that instance can use these log configuration options. For\n\t\t\t\t\tmore information, see Amazon ECS container agent configuration in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
For tasks that are on Fargate, because you don't have access to the\n\t\t\t\t\tunderlying infrastructure your tasks are hosted on, any additional software\n\t\t\t\t\tneeded must be installed outside of the task. For example, the Fluentd output\n\t\t\t\t\taggregators or a remote host running Logstash to send Gelf logs to.
\nThe log configuration for the container. This parameter maps to LogConfig in the docker\n\t\t\tcontainer create command and the --log-driver option to docker run.
By default, containers use the same logging driver that the Docker daemon uses. However, the\n\t\t\tcontainer might use a different logging driver than the Docker daemon by specifying a log driver\n\t\t\tconfiguration in the container definition.
\nUnderstand the following when specifying a log configuration for your containers.
\nAmazon ECS currently supports a subset of the logging drivers available to the Docker daemon.\n\t\t\t\t\tAdditional log drivers may be available in future releases of the Amazon ECS container agent.
\nFor tasks on Fargate, the supported log drivers are awslogs,\n\t\t\t\t\t\tsplunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are awslogs,\n\t\t\t\t\t\tfluentd, gelf, json-file,\n\t\t\t\t\t\tjournald,syslog, splunk, and\n\t\t\t\t\t\tawsfirelens.
This parameter requires version 1.18 of the Docker Remote API or greater on your container\n\t\t\t\t\tinstance.
\nFor tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the\n\t\t\t\t\tavailable logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS environment\n\t\t\t\t\tvariable before containers placed on that instance can use these log configuration options. For\n\t\t\t\t\tmore information, see Amazon ECS container agent configuration in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
For tasks that are on Fargate, because you don't have access to the underlying\n\t\t\t\t\tinfrastructure your tasks are hosted on, any additional software needed must be installed\n\t\t\t\t\toutside of the task. For example, the Fluentd output aggregators or a remote host running\n\t\t\t\t\tLogstash to send Gelf logs to.
\nThe name of the managed agent. When the execute command feature is turned on, the\n\t\t\tmanaged agent name is ExecuteCommandAgent.
The name of the managed agent. When the execute command feature is turned on, the managed agent name\n\t\t\tis ExecuteCommandAgent.
The target capacity utilization as a percentage for the capacity provider. The\n\t\t\tspecified value must be greater than 0 and less than or equal to\n\t\t\t\t100. For example, if you want the capacity provider to maintain 10%\n\t\t\tspare capacity, then that means the utilization is 90%, so use a\n\t\t\t\ttargetCapacity of 90. The default value of\n\t\t\t\t100 percent results in the Amazon EC2 instances in your Auto Scaling group\n\t\t\tbeing completely used.
The target capacity utilization as a percentage for the capacity provider. The specified value must\n\t\t\tbe greater than 0 and less than or equal to 100. For example, if you want the\n\t\t\tcapacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use a\n\t\t\t\ttargetCapacity of 90. The default value of 100 percent\n\t\t\tresults in the Amazon EC2 instances in your Auto Scaling group being completely used.
The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is omitted, the default\n\t\t\tvalue of 1 is used.
When additional capacity is required, Amazon ECS will scale up the minimum scaling step\n\t\t\tsize even if the actual demand is less than the minimum scaling step size.
\nIf you use a capacity provider with an Auto Scaling group configured with more than\n\t\t\tone Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum\n\t\t\tscaling step size value and will ignore both the maximum scaling step size as well as\n\t\t\tthe capacity demand.
" + "smithy.api#documentation": "The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is\n\t\t\tnot affected by this parameter If this parameter is omitted, the default value of 1 is\n\t\t\tused.
When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the\n\t\t\tactual demand is less than the minimum scaling step size.
\nIf you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2\n\t\t\tinstance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value\n\t\t\tand will ignore both the maximum scaling step size as well as the capacity demand.
" } }, "maximumScalingStepSize": { "target": "com.amazonaws.ecs#ManagedScalingStepSize", "traits": { - "smithy.api#documentation": "The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is omitted, the default\n\t\t\tvalue of 10000 is used.
The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is\n\t\t\tomitted, the default value of 10000 is used.
The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute\n\t\t\tto CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value\n\t\t\tof 300 seconds is used.
The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics\n\t\t\tfor Auto Scaling group. If this parameter is omitted, the default value of 300 seconds is\n\t\t\tused.
The managed scaling settings for the Auto Scaling group capacity provider.
\nWhen managed scaling is turned on, Amazon ECS manages the scale-in and scale-out actions of\n\t\t\tthe Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS\n\t\t\tmanaged CloudWatch metric with the specified targetCapacity value as the target\n\t\t\tvalue for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.
If managed scaling is off, the user must manage the scaling of the Auto Scaling\n\t\t\tgroup.
" + "smithy.api#documentation": "The managed scaling settings for the Auto Scaling group capacity provider.
\nWhen managed scaling is turned on, Amazon ECS manages the scale-in and scale-out actions of the Auto\n\t\t\tScaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS managed CloudWatch metric with\n\t\t\tthe specified targetCapacity value as the target value for the metric. For more\n\t\t\tinformation, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.
If managed scaling is off, the user must manage the scaling of the Auto Scaling group.
" } }, "com.amazonaws.ecs#ManagedScalingInstanceWarmupPeriod": { @@ -8349,7 +8361,7 @@ "kmsKeyId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "Specify a Amazon Web Services Key Management Service key ID to encrypt the managed storage.
" + "smithy.api#documentation": "Specify a Key Management Service key ID to encrypt the managed storage.
" } }, "fargateEphemeralStorageKmsKeyId": { @@ -8391,7 +8403,7 @@ } }, "traits": { - "smithy.api#documentation": "Amazon ECS can't determine the current version of the Amazon ECS container agent on the\n\t\t\tcontainer instance and doesn't have enough information to proceed with an update. This\n\t\t\tcould be because the agent running on the container instance is a previous or custom\n\t\t\tversion that doesn't use our version information.
", + "smithy.api#documentation": "Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and\n\t\t\tdoesn't have enough information to proceed with an update. This could be because the agent running on\n\t\t\tthe container instance is a previous or custom version that doesn't use our version information.
", "smithy.api#error": "client" } }, @@ -8401,7 +8413,7 @@ "sourceVolume": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of the volume to mount. Must be a volume name referenced in the\n\t\t\t\tname parameter of task definition volume.
The name of the volume to mount. Must be a volume name referenced in the name parameter\n\t\t\tof task definition volume.
If this value is true, the container has read-only access to the volume.\n\t\t\tIf this value is false, then the container can write to the volume. The\n\t\t\tdefault value is false.
If this value is true, the container has read-only access to the volume. If this value\n\t\t\tis false, then the container can write to the volume. The default value is\n\t\t\t\tfalse.
The port number range on the container that's bound to the dynamically mapped host\n\t\t\tport range.
\nThe following rules apply when you specify a containerPortRange:
You must use either the bridge network mode or the awsvpc\n\t\t\t\t\tnetwork mode.
This parameter is available for both the EC2 and Fargate launch types.
\nThis parameter is available for both the Linux and Windows operating systems.
\nThe container instance must have at least version 1.67.0 of the container agent\n\t\t\t\t\tand at least version 1.67.0-1 of the ecs-init package
You can specify a maximum of 100 port ranges per container.
\nYou do not specify a hostPortRange. The value of the hostPortRange is set\n\t\t\t\t\tas follows:
For containers in a task with the awsvpc network mode,\n\t\t\t\t\t\t\tthe hostPortRange is set to the same value as the\n\t\t\t\t\t\t\t\tcontainerPortRange. This is a static mapping\n\t\t\t\t\t\t\tstrategy.
For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
The containerPortRange valid values are between 1 and\n\t\t\t\t\t65535.
A port can only be included in one port mapping per container.
\nYou cannot specify overlapping port ranges.
\nThe first port in the range must be less than last port in the range.
\nDocker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
\nFor more information, see Issue #11185 on the Github website.
\nFor information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
\nYou can call \n DescribeTasks\n to view the hostPortRange which\n\t\t\tare the host ports that are bound to the container ports.
The port number range on the container that's bound to the dynamically mapped host port range.
\nThe following rules apply when you specify a containerPortRange:
You must use either the bridge network mode or the awsvpc\n\t\t\t\t\tnetwork mode.
This parameter is available for both the EC2 and Fargate launch types.
\nThis parameter is available for both the Linux and Windows operating systems.
\nThe container instance must have at least version 1.67.0 of the container agent\n\t\t\t\t\tand at least version 1.67.0-1 of the ecs-init package
You can specify a maximum of 100 port ranges per container.
\nYou do not specify a hostPortRange. The value of the hostPortRange is set\n\t\t\t\t\tas follows:
For containers in a task with the awsvpc network mode,\n\t\t\t\t\t\t\tthe hostPortRange is set to the same value as the\n\t\t\t\t\t\t\t\tcontainerPortRange. This is a static mapping\n\t\t\t\t\t\t\tstrategy.
For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
The containerPortRange valid values are between 1 and\n\t\t\t\t\t65535.
A port can only be included in one port mapping per container.
\nYou cannot specify overlapping port ranges.
\nThe first port in the range must be less than last port in the range.
\nDocker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
\nFor more information, see Issue #11185 on the Github website.
\nFor information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
\nYou can call \n DescribeTasks\n to view the hostPortRange which\n\t\t\tare the host ports that are bound to the container ports.
The port number range on the host that's used with the network binding. This is\n\t\t\tassigned is assigned by Docker and delivered by the Amazon ECS agent.
" + "smithy.api#documentation": "The port number range on the host that's used with the network binding. This is assigned is assigned\n\t\t\tby Docker and delivered by the Amazon ECS agent.
" } } }, "traits": { - "smithy.api#documentation": "Details on the network bindings between a container and its host container instance.\n\t\t\tAfter a task reaches the RUNNING status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the networkBindings section of\n\t\t\tDescribeTasks API responses.
Details on the network bindings between a container and its host container instance. After a task\n\t\t\treaches the RUNNING status, manual and automatic host and container port assignments are\n\t\t\tvisible in the networkBindings section of DescribeTasks API\n\t\t\tresponses.
An object representing the elastic network interface for tasks that use the\n\t\t\t\tawsvpc network mode.
An object representing the elastic network interface for tasks that use the awsvpc\n\t\t\tnetwork mode.
There's no update available for this Amazon ECS container agent. This might be because the\n\t\t\tagent is already running the latest version or because it's so old that there's no\n\t\t\tupdate path to the current version.
", + "smithy.api#documentation": "There's no update available for this Amazon ECS container agent. This might be because the agent is\n\t\t\talready running the latest version or because it's so old that there's no update path to the current\n\t\t\tversion.
", "smithy.api#error": "client" } }, @@ -8658,18 +8670,18 @@ "type": { "target": "com.amazonaws.ecs#PlacementConstraintType", "traits": { - "smithy.api#documentation": "The type of constraint. Use distinctInstance to ensure that each task in\n\t\t\ta particular group is running on a different container instance. Use\n\t\t\t\tmemberOf to restrict the selection to a group of valid\n\t\t\tcandidates.
The type of constraint. Use distinctInstance to ensure that each task in a particular\n\t\t\tgroup is running on a different container instance. Use memberOf to restrict the selection\n\t\t\tto a group of valid candidates.
A cluster query language expression to apply to the constraint. The expression can\n\t\t\thave a maximum length of 2000 characters. You can't specify an expression if the\n\t\t\tconstraint type is distinctInstance. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
A cluster query language expression to apply to the constraint. The expression can have a maximum\n\t\t\tlength of 2000 characters. You can't specify an expression if the constraint type is\n\t\t\t\tdistinctInstance. For more information, see Cluster\n\t\t\t\tquery language in the Amazon Elastic Container Service Developer Guide.
An object representing a constraint on task placement. For more information, see\n\t\t\t\tTask placement constraints in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
\nIf you're using the Fargate launch type, task placement constraints\n\t\t\t\taren't supported.
\nAn object representing a constraint on task placement. For more information, see Task\n\t\t\t\tplacement constraints in the Amazon Elastic Container Service Developer Guide.
\nIf you're using the Fargate launch type, task placement constraints aren't\n\t\t\t\tsupported.
\nThe type of placement strategy. The random placement strategy randomly\n\t\t\tplaces tasks on available candidates. The spread placement strategy spreads\n\t\t\tplacement across available candidates evenly based on the field parameter.\n\t\t\tThe binpack strategy places tasks on available candidates that have the\n\t\t\tleast available amount of the resource that's specified with the field\n\t\t\tparameter. For example, if you binpack on memory, a task is placed on the instance with\n\t\t\tthe least amount of remaining memory but still enough to run the task.
The type of placement strategy. The random placement strategy randomly places tasks on\n\t\t\tavailable candidates. The spread placement strategy spreads placement across available\n\t\t\tcandidates evenly based on the field parameter. The binpack strategy places\n\t\t\ttasks on available candidates that have the least available amount of the resource that's specified\n\t\t\twith the field parameter. For example, if you binpack on memory, a task is placed on the\n\t\t\tinstance with the least amount of remaining memory but still enough to run the task.
The field to apply the placement strategy against. For the spread\n\t\t\tplacement strategy, valid values are instanceId (or host,\n\t\t\twhich has the same effect), or any platform or custom attribute that's applied to a\n\t\t\tcontainer instance, such as attribute:ecs.availability-zone. For the\n\t\t\t\tbinpack placement strategy, valid values are cpu and\n\t\t\t\tmemory. For the random placement strategy, this field is\n\t\t\tnot used.
The field to apply the placement strategy against. For the spread placement strategy,\n\t\t\tvalid values are instanceId (or host, which has the same effect), or any\n\t\t\tplatform or custom attribute that's applied to a container instance, such as\n\t\t\t\tattribute:ecs.availability-zone. For the binpack placement strategy,\n\t\t\tvalid values are cpu and memory. For the random placement\n\t\t\tstrategy, this field is not used.
The task placement strategy for a task or service. For more information, see Task placement strategies in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The task placement strategy for a task or service. For more information, see Task\n\t\t\t\tplacement strategies in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#PlacementStrategyType": { @@ -8750,20 +8762,20 @@ "id": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The ID for the GPUs on the container instance. The available GPU IDs can also be\n\t\t\tobtained on the container instance in the\n\t\t\t\t/var/lib/ecs/gpu/nvidia_gpu_info.json file.
The ID for the GPUs on the container instance. The available GPU IDs can also be obtained on the\n\t\t\tcontainer instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.
The type of device that's available on the container instance. The only supported\n\t\t\tvalue is GPU.
The type of device that's available on the container instance. The only supported value is\n\t\t\t\tGPU.
The devices that are available on the container instance. The only supported device\n\t\t\ttype is a GPU.
" + "smithy.api#documentation": "The devices that are available on the container instance. The only supported device type is a\n\t\t\tGPU.
" } }, "com.amazonaws.ecs#PlatformDeviceType": { @@ -8819,42 +8831,42 @@ "containerPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The port number on the container that's bound to the user-specified or automatically\n\t\t\tassigned host port.
\nFor tasks that use the Fargate launch type or EC2 tasks that use the\n\t\t\t\tawsvpc network mode, you use containerPort to specify the\n\t\t\texposed ports.
For Windows containers on Fargate, you can't use port 3150 for the\n\t\t\t\tcontainerPort. This is because it's reserved.
Suppose that you're using containers in a task with the EC2 launch type\n\t\t\tand you specify a container port and not a host port. Then, your container automatically\n\t\t\treceives a host port in the ephemeral port range. For more information, see\n\t\t\t\thostPort. Port mappings that are automatically assigned in this way\n\t\t\tdon't count toward the 100 reserved ports quota of a container instance.
The port number on the container that's bound to the user-specified or automatically assigned host\n\t\t\tport.
\nIf you use containers in a task with the awsvpc or host network mode,\n\t\t\tspecify the exposed ports using containerPort.
If you use containers in a task with the bridge network mode and you specify a container\n\t\t\tport and not a host port, your container automatically receives a host port in the ephemeral port\n\t\t\trange. For more information, see hostPort. Port mappings that are automatically assigned\n\t\t\tin this way do not count toward the 100 reserved ports limit of a container instance.
The port number on the container instance to reserve for your container.
\nIf you specify a containerPortRange, leave this field empty and the value\n\t\t\tof the hostPort is set as follows:
For containers in a task with the awsvpc network mode, the\n\t\t\t\t\t\thostPort is set to the same value as the\n\t\t\t\t\t\tcontainerPort. This is a static mapping strategy.
For containers in a task with the bridge network mode, the Amazon ECS\n\t\t\t\t\tagent finds open ports on the host and automatically binds them to the container\n\t\t\t\t\tports. This is a dynamic mapping strategy.
If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, the hostPort can either be left blank or set to the same\n\t\t\tvalue as the containerPort.
If you use containers in a task with the bridge network mode, you can\n\t\t\tspecify a non-reserved host port for your container port mapping, or you can omit the\n\t\t\t\thostPort (or set it to 0) while specifying a\n\t\t\t\tcontainerPort and your container automatically receives a port in the\n\t\t\tephemeral port range for your container instance operating system and Docker\n\t\t\tversion.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n\t\t\tinstance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel\n\t\t\tparameter is unavailable, the default ephemeral port range from 49153 through 65535\n\t\t\t(Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port\n\t\t\tin the ephemeral port range as these are reserved for automatic assignment. In general,\n\t\t\tports below 32768 are outside of the ephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\n\t\t\tAmazon ECS container agent ports 51678-51680. Any host port that was previously specified in\n\t\t\ta running task is also reserved while the task is running. That is, after a task stops,\n\t\t\tthe host port is released. The current reserved ports are displayed in the\n\t\t\t\tremainingResources of DescribeContainerInstances output. A container instance can have up to 100\n\t\t\treserved ports at a time. This number includes the default reserved ports. Automatically\n\t\t\tassigned ports aren't included in the 100 reserved ports quota.
The port number on the container instance to reserve for your container.
\nIf you specify a containerPortRange, leave this field empty and the value of the\n\t\t\t\thostPort is set as follows:
For containers in a task with the awsvpc network mode, the hostPort\n\t\t\t\t\tis set to the same value as the containerPort. This is a static mapping\n\t\t\t\t\tstrategy.
For containers in a task with the bridge network mode, the Amazon ECS agent finds\n\t\t\t\t\topen ports on the host and automatically binds them to the container ports. This is a dynamic\n\t\t\t\t\tmapping strategy.
If you use containers in a task with the awsvpc or host network mode, the\n\t\t\t\thostPort can either be left blank or set to the same value as the\n\t\t\t\tcontainerPort.
If you use containers in a task with the bridge network mode, you can specify a\n\t\t\tnon-reserved host port for your container port mapping, or you can omit the hostPort (or\n\t\t\tset it to 0) while specifying a containerPort and your container\n\t\t\tautomatically receives a port in the ephemeral port range for your container instance operating system\n\t\t\tand Docker version.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under\n\t\t\t\t/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the\n\t\t\tdefault ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used.\n\t\t\tDo not attempt to specify a host port in the ephemeral port range as these are reserved for automatic\n\t\t\tassignment. In general, ports below 32768 are outside of the ephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container\n\t\t\tagent ports 51678-51680. Any host port that was previously specified in a running task is also reserved\n\t\t\twhile the task is running. That is, after a task stops, the host port is released. The current reserved\n\t\t\tports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports\n\t\t\tat a time. This number includes the default reserved ports. Automatically assigned ports aren't\n\t\t\tincluded in the 100 reserved ports quota.
The protocol used for the port mapping. Valid values are tcp and\n\t\t\t\tudp. The default is tcp. protocol is\n\t\t\timmutable in a Service Connect service. Updating this field requires a service deletion\n\t\t\tand redeployment.
The protocol used for the port mapping. Valid values are tcp and udp. The\n\t\t\tdefault is tcp. protocol is immutable in a Service Connect service. Updating\n\t\t\tthis field requires a service deletion and redeployment.
The name that's used for the port mapping. This parameter only applies to\n\t\t\tService Connect. This parameter is the name that you use in the\n\t\t\t\tserviceConnectConfiguration of a service. The name can include up to 64\n\t\t\tcharacters. The characters can include lowercase letters, numbers, underscores (_), and\n\t\t\thyphens (-). The name can't start with a hyphen.
For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The name that's used for the port mapping. This parameter is the name that you use in the \n\t\t\tserviceConnectConfiguration and the vpcLatticeConfigurations of a service. \n\t\t\tThe name can include up to 64 characters. The characters can include lowercase letters, numbers, \n\t\t\tunderscores (_), and hyphens (-). The name can't start with a hyphen.
The application protocol that's used for the port mapping. This parameter only applies\n\t\t\tto Service Connect. We recommend that you set this parameter to be consistent with the\n\t\t\tprotocol that your application uses. If you set this parameter, Amazon ECS adds\n\t\t\tprotocol-specific connection handling to the Service Connect proxy. If you set this\n\t\t\tparameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.
\nIf you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't\n\t\t\tadd protocol-specific telemetry for TCP.
\n\n appProtocol is immutable in a Service Connect service. Updating this\n\t\t\tfield requires a service deletion and redeployment.
Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The application protocol that's used for the port mapping. This parameter only applies to\n\t\t\tService Connect. We recommend that you set this parameter to be consistent with the protocol that your\n\t\t\tapplication uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the\n\t\t\tService Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS\n\t\t\tconsole and CloudWatch.
\nIf you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add\n\t\t\tprotocol-specific telemetry for TCP.
\n\n appProtocol is immutable in a Service Connect service. Updating this field requires a\n\t\t\tservice deletion and redeployment.
Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" } }, "containerPortRange": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The port number range on the container that's bound to the dynamically mapped host\n\t\t\tport range.
\nThe following rules apply when you specify a containerPortRange:
You must use either the bridge network mode or the awsvpc\n\t\t\t\t\tnetwork mode.
This parameter is available for both the EC2 and Fargate launch types.
\nThis parameter is available for both the Linux and Windows operating systems.
\nThe container instance must have at least version 1.67.0 of the container agent\n\t\t\t\t\tand at least version 1.67.0-1 of the ecs-init package
You can specify a maximum of 100 port ranges per container.
\nYou do not specify a hostPortRange. The value of the hostPortRange is set\n\t\t\t\t\tas follows:
For containers in a task with the awsvpc network mode,\n\t\t\t\t\t\t\tthe hostPortRange is set to the same value as the\n\t\t\t\t\t\t\t\tcontainerPortRange. This is a static mapping\n\t\t\t\t\t\t\tstrategy.
For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
The containerPortRange valid values are between 1 and\n\t\t\t\t\t65535.
A port can only be included in one port mapping per container.
\nYou cannot specify overlapping port ranges.
\nThe first port in the range must be less than last port in the range.
\nDocker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
\nFor more information, see Issue #11185 on the Github website.
\nFor information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
\nYou can call \n DescribeTasks\n to view the hostPortRange which\n\t\t\tare the host ports that are bound to the container ports.
The port number range on the container that's bound to the dynamically mapped host port range.
\nThe following rules apply when you specify a containerPortRange:
You must use either the bridge network mode or the awsvpc\n\t\t\t\t\tnetwork mode.
This parameter is available for both the EC2 and Fargate launch types.
\nThis parameter is available for both the Linux and Windows operating systems.
\nThe container instance must have at least version 1.67.0 of the container agent\n\t\t\t\t\tand at least version 1.67.0-1 of the ecs-init package
You can specify a maximum of 100 port ranges per container.
\nYou do not specify a hostPortRange. The value of the hostPortRange is set\n\t\t\t\t\tas follows:
For containers in a task with the awsvpc network mode,\n\t\t\t\t\t\t\tthe hostPortRange is set to the same value as the\n\t\t\t\t\t\t\t\tcontainerPortRange. This is a static mapping\n\t\t\t\t\t\t\tstrategy.
For containers in a task with the bridge network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
The containerPortRange valid values are between 1 and\n\t\t\t\t\t65535.
A port can only be included in one port mapping per container.
\nYou cannot specify overlapping port ranges.
\nThe first port in the range must be less than last port in the range.
\nDocker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
\nFor more information, see Issue #11185 on the Github website.
\nFor information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide.
\nYou can call \n DescribeTasks\n to view the hostPortRange which\n\t\t\tare the host ports that are bound to the container ports.
Port mappings expose your container's network ports to the outside world. this allows\n\t\t\tclients to access your application. It's also used for inter-container communication\n\t\t\twithin the same task.
\nFor task definitions (both the Fargate and EC2 launch type) that use the\n\t\t\t\tawsvpc network mode, only specify the containerPort. The\n\t\t\t\thostPort is always ignored, and the container port is automatically\n\t\t\tmapped to a random high-numbered port on the host.
Most fields of this parameter (containerPort, hostPort,\n\t\t\tprotocol) maps to PortBindings in the docker container create command and the\n\t\t\t\t--publish option to docker\n\t\t\t\t\trun. If the network mode of a task definition is set to\n\t\t\t\thost, host ports must either be undefined or match the container port\n\t\t\tin the port mapping.
You can't expose the same container port for multiple protocols. If you attempt\n\t\t\t\tthis, an error is returned.
\nAfter a task reaches the RUNNING status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the networkBindings section of\n\t\t\tDescribeTasks API responses.
Port mappings allow containers to access ports on the host container instance to send or receive\n\t\t\ttraffic. Port mappings are specified as part of the container definition.
\nIf you use containers in a task with the awsvpc or host network mode,\n\t\t\tspecify the exposed ports using containerPort. The hostPort can be left blank\n\t\t\tor it must be the same value as the containerPort.
Most fields of this parameter (containerPort, hostPort,\n\t\t\t\tprotocol) maps to PortBindings in the docker container create command and\n\t\t\tthe --publish option to docker run. If the network mode of a task definition\n\t\t\tis set to host, host ports must either be undefined or match the container port in the\n\t\t\tport mapping.
You can't expose the same container port for multiple protocols. If you attempt this, an error is\n\t\t\t\treturned.
\nAfter a task reaches the RUNNING status, manual and automatic host and container port\n\t\t\tassignments are visible in the networkBindings section of DescribeTasks API\n\t\t\tresponses.
The protection status of the task. If scale-in protection is on for a task, the value\n\t\t\tis true. Otherwise, it is false.
The protection status of the task. If scale-in protection is on for a task, the value is\n\t\t\t\ttrue. Otherwise, it is false.
An object representing the protection status details for a task. You can set the\n\t\t\tprotection status with the UpdateTaskProtection API and get the status\n\t\t\tof tasks with the GetTaskProtection API.
" + "smithy.api#documentation": "An object representing the protection status details for a task. You can set the protection status\n\t\t\twith the UpdateTaskProtection API and get the status of tasks with the GetTaskProtection\n\t\t\tAPI.
" } }, "com.amazonaws.ecs#ProtectedTasks": { @@ -8947,12 +8959,12 @@ "properties": { "target": "com.amazonaws.ecs#ProxyConfigurationProperties", "traits": { - "smithy.api#documentation": "The set of network configuration parameters to provide the Container Network Interface\n\t\t\t(CNI) plugin, specified as key-value pairs.
\n\n IgnoredUID - (Required) The user ID (UID) of the proxy\n\t\t\t\t\tcontainer as defined by the user parameter in a container\n\t\t\t\t\tdefinition. This is used to ensure the proxy ignores its own traffic. If\n\t\t\t\t\t\tIgnoredGID is specified, this field can be empty.
\n IgnoredGID - (Required) The group ID (GID) of the proxy\n\t\t\t\t\tcontainer as defined by the user parameter in a container\n\t\t\t\t\tdefinition. This is used to ensure the proxy ignores its own traffic. If\n\t\t\t\t\t\tIgnoredUID is specified, this field can be empty.
\n AppPorts - (Required) The list of ports that the\n\t\t\t\t\tapplication uses. Network traffic to these ports is forwarded to the\n\t\t\t\t\t\tProxyIngressPort and ProxyEgressPort.
\n ProxyIngressPort - (Required) Specifies the port that\n\t\t\t\t\tincoming traffic to the AppPorts is directed to.
\n ProxyEgressPort - (Required) Specifies the port that\n\t\t\t\t\toutgoing traffic from the AppPorts is directed to.
\n EgressIgnoredPorts - (Required) The egress traffic going to\n\t\t\t\t\tthe specified ports is ignored and not redirected to the\n\t\t\t\t\t\tProxyEgressPort. It can be an empty list.
\n EgressIgnoredIPs - (Required) The egress traffic going to\n\t\t\t\t\tthe specified IP addresses is ignored and not redirected to the\n\t\t\t\t\t\tProxyEgressPort. It can be an empty list.
The set of network configuration parameters to provide the Container Network Interface (CNI) plugin,\n\t\t\tspecified as key-value pairs.
\n\n IgnoredUID - (Required) The user ID (UID) of the proxy container as\n\t\t\t\t\tdefined by the user parameter in a container definition. This is used to ensure\n\t\t\t\t\tthe proxy ignores its own traffic. If IgnoredGID is specified, this field can be\n\t\t\t\t\tempty.
\n IgnoredGID - (Required) The group ID (GID) of the proxy container as\n\t\t\t\t\tdefined by the user parameter in a container definition. This is used to ensure\n\t\t\t\t\tthe proxy ignores its own traffic. If IgnoredUID is specified, this field can be\n\t\t\t\t\tempty.
\n AppPorts - (Required) The list of ports that the application uses. Network\n\t\t\t\t\ttraffic to these ports is forwarded to the ProxyIngressPort and\n\t\t\t\t\t\tProxyEgressPort.
\n ProxyIngressPort - (Required) Specifies the port that incoming traffic to\n\t\t\t\t\tthe AppPorts is directed to.
\n ProxyEgressPort - (Required) Specifies the port that outgoing traffic from\n\t\t\t\t\tthe AppPorts is directed to.
\n EgressIgnoredPorts - (Required) The egress traffic going to the specified\n\t\t\t\t\tports is ignored and not redirected to the ProxyEgressPort. It can be an empty\n\t\t\t\t\tlist.
\n EgressIgnoredIPs - (Required) The egress traffic going to the specified IP\n\t\t\t\t\taddresses is ignored and not redirected to the ProxyEgressPort. It can be an empty\n\t\t\t\t\tlist.
The configuration details for the App Mesh proxy.
\nFor tasks that use the EC2 launch type, the container instances require\n\t\t\tat least version 1.26.0 of the container agent and at least version 1.26.0-1 of the\n\t\t\t\tecs-init package to use a proxy configuration. If your container\n\t\t\tinstances are launched from the Amazon ECS optimized AMI version 20190301 or\n\t\t\tlater, then they contain the required versions of the container agent and\n\t\t\t\tecs-init. For more information, see Amazon ECS-optimized Linux AMI\n
The configuration details for the App Mesh proxy.
\nFor tasks that use the EC2 launch type, the container instances require at least\n\t\t\tversion 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init\n\t\t\tpackage to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized\n\t\t\tAMI version 20190301 or later, then they contain the required versions of the container\n\t\t\tagent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI\n
Modifies an account setting. Account settings are set on a per-Region basis.
\nIf you change the root user account setting, the default settings are reset for users and\n\t\t\troles that do not have specified individual account settings. For more information, see\n\t\t\t\tAccount\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.
", + "smithy.api#documentation": "Modifies an account setting. Account settings are set on a per-Region basis.
\nIf you change the root user account setting, the default settings are reset for users and roles that do\n\t\t\tnot have specified individual account settings. For more information, see Account Settings in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
", "smithy.api#examples": [ { "title": "To modify the account settings for a specific IAM user or IAM role", @@ -9048,7 +9060,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies an account setting for all users on an account for whom no individual account\n\t\t\tsetting has been specified. Account settings are set on a per-Region basis.
", + "smithy.api#documentation": "Modifies an account setting for all users on an account for whom no individual account setting has\n\t\t\tbeen specified. Account settings are set on a per-Region basis.
", "smithy.api#examples": [ { "title": "To modify the default account settings for all IAM users or roles on an account", @@ -9074,14 +9086,14 @@ "name": { "target": "com.amazonaws.ecs#SettingName", "traits": { - "smithy.api#documentation": "The resource name for which to modify the account setting.
\nThe following are the valid values for the account setting name.
\n\n serviceLongArnFormat - When modified, the Amazon Resource Name\n\t\t\t\t\t(ARN) and resource ID format of the resource type for a specified user, role, or\n\t\t\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting\n\t\t\t\t\tmust be set for each Amazon ECS resource separately. The ARN and resource ID format\n\t\t\t\t\tof a resource is defined by the opt-in status of the user or role that created\n\t\t\t\t\tthe resource. You must turn on this setting to use Amazon ECS features such as\n\t\t\t\t\tresource tagging.
\n taskLongArnFormat - When modified, the Amazon Resource Name (ARN)\n\t\t\t\t\tand resource ID format of the resource type for a specified user, role, or the\n\t\t\t\t\troot user for an account is affected. The opt-in and opt-out account setting must\n\t\t\t\t\tbe set for each Amazon ECS resource separately. The ARN and resource ID format of a\n\t\t\t\t\tresource is defined by the opt-in status of the user or role that created the\n\t\t\t\t\tresource. You must turn on this setting to use Amazon ECS features such as resource\n\t\t\t\t\ttagging.
\n containerInstanceLongArnFormat - When modified, the Amazon\n\t\t\t\t\tResource Name (ARN) and resource ID format of the resource type for a specified\n\t\t\t\t\tuser, role, or the root user for an account is affected. The opt-in and opt-out\n\t\t\t\t\taccount setting must be set for each Amazon ECS resource separately. The ARN and\n\t\t\t\t\tresource ID format of a resource is defined by the opt-in status of the user or\n\t\t\t\t\trole that created the resource. You must turn on this setting to use Amazon ECS\n\t\t\t\t\tfeatures such as resource tagging.
\n awsvpcTrunking - When modified, the elastic network interface\n\t\t\t\t\t(ENI) limit for any new container instances that support the feature is changed.\n\t\t\t\t\tIf awsvpcTrunking is turned on, any new container instances that\n\t\t\t\t\tsupport the feature are launched have the increased ENI limits available to\n\t\t\t\t\tthem. For more information, see Elastic\n\t\t\t\t\t\tNetwork Interface Trunking in the Amazon Elastic Container Service Developer Guide.
\n containerInsights - When modified, the default setting indicating\n\t\t\t\t\twhether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed.\n\t\t\t\t\tIf containerInsights is turned on, any new clusters that are\n\t\t\t\t\tcreated will have Container Insights turned on unless you disable it during\n\t\t\t\t\tcluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.
\n dualStackIPv6 - When turned on, when using a VPC in dual stack\n\t\t\t\t\tmode, your tasks using the awsvpc network mode can have an IPv6\n\t\t\t\t\taddress assigned. For more information on using IPv6 with tasks launched on\n\t\t\t\t\tAmazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6\n\t\t\t\t\twith tasks launched on Fargate, see Using a VPC in dual-stack mode.
\n fargateFIPSMode - If you specify fargateFIPSMode,\n\t\t\t\t\tFargate FIPS 140 compliance is affected.
\n fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a\n\t\t\t\t\tsecurity or infrastructure update is needed for an Amazon ECS task hosted on\n\t\t\t\t\tFargate, the tasks need to be stopped and new tasks launched to replace them.\n\t\t\t\t\tUse fargateTaskRetirementWaitPeriod to configure the wait time to\n\t\t\t\t\tretire a Fargate task. For information about the Fargate tasks maintenance,\n\t\t\t\t\tsee Amazon Web Services Fargate\n\t\t\t\t\t\ttask maintenance in the Amazon ECS Developer\n\t\t\t\t\tGuide.
\n tagResourceAuthorization - Amazon ECS is introducing tagging\n\t\t\t\t\tauthorization for resource creation. Users must have permissions for actions\n\t\t\t\t\tthat create the resource, such as ecsCreateCluster. If tags are\n\t\t\t\t\tspecified when you create a resource, Amazon Web Services performs additional authorization to\n\t\t\t\t\tverify if users or roles have permissions to create tags. Therefore, you must\n\t\t\t\t\tgrant explicit permissions to use the ecs:TagResource action. For\n\t\t\t\t\tmore information, see Grant permission to tag resources on creation in the\n\t\t\t\t\t\tAmazon ECS Developer Guide.
\n guardDutyActivate - The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether\n\t\t\tAmazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your\n\t\t\tAmazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.
The resource name for which to modify the account setting.
\nThe following are the valid values for the account setting name.
\n\n serviceLongArnFormat - When modified, the Amazon Resource Name (ARN) and\n\t\t\t\t\tresource ID format of the resource type for a specified user, role, or the root user for an\n\t\t\t\t\taccount is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource\n\t\t\t\t\tseparately. The ARN and resource ID format of a resource is defined by the opt-in status of\n\t\t\t\t\tthe user or role that created the resource. You must turn on this setting to use Amazon ECS features\n\t\t\t\t\tsuch as resource tagging.
\n taskLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource\n\t\t\t\t\tID format of the resource type for a specified user, role, or the root user for an account is\n\t\t\t\t\taffected. The opt-in and opt-out account setting must be set for each Amazon ECS resource\n\t\t\t\t\tseparately. The ARN and resource ID format of a resource is defined by the opt-in status of\n\t\t\t\t\tthe user or role that created the resource. You must turn on this setting to use Amazon ECS features\n\t\t\t\t\tsuch as resource tagging.
\n containerInstanceLongArnFormat - When modified, the Amazon Resource Name (ARN)\n\t\t\t\t\tand resource ID format of the resource type for a specified user, role, or the root user for an\n\t\t\t\t\taccount is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource\n\t\t\t\t\tseparately. The ARN and resource ID format of a resource is defined by the opt-in status of\n\t\t\t\t\tthe user or role that created the resource. You must turn on this setting to use Amazon ECS features\n\t\t\t\t\tsuch as resource tagging.
\n awsvpcTrunking - When modified, the elastic network interface (ENI) limit for\n\t\t\t\t\tany new container instances that support the feature is changed. If awsvpcTrunking\n\t\t\t\t\tis turned on, any new container instances that support the feature are launched have the\n\t\t\t\t\tincreased ENI limits available to them. For more information, see Elastic Network Interface\n\t\t\t\t\t\tTrunking in the Amazon Elastic Container Service Developer Guide.
\n containerInsights - When modified, the default setting indicating whether Amazon Web Services\n\t\t\t\t\tCloudWatch Container Insights is turned on for your clusters is changed. If\n\t\t\t\t\t\tcontainerInsights is turned on, any new clusters that are created will have\n\t\t\t\t\tContainer Insights turned on unless you disable it during cluster creation. For more\n\t\t\t\t\tinformation, see CloudWatch Container\n\t\t\t\t\t\tInsights in the Amazon Elastic Container Service Developer Guide.
\n dualStackIPv6 - When turned on, when using a VPC in dual stack mode, your tasks\n\t\t\t\t\tusing the awsvpc network mode can have an IPv6 address assigned. For more\n\t\t\t\t\tinformation on using IPv6 with tasks launched on Amazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6 with tasks\n\t\t\t\t\tlaunched on Fargate, see Using a VPC in dual-stack mode.
\n fargateFIPSMode - If you specify fargateFIPSMode, Fargate FIPS\n\t\t\t\t\t140 compliance is affected.
\n fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a security or\n\t\t\t\t\tinfrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be\n\t\t\t\t\tstopped and new tasks launched to replace them. Use\n\t\t\t\t\t\tfargateTaskRetirementWaitPeriod to configure the wait time to retire a\n\t\t\t\t\tFargate task. For information about the Fargate tasks maintenance, see Amazon Web Services\n\t\t\t\t\t\tFargate task maintenance in the Amazon ECS Developer\n\t\t\t\t\tGuide.
\n tagResourceAuthorization - Amazon ECS is introducing tagging authorization for\n\t\t\t\t\tresource creation. Users must have permissions for actions that create the resource, such as\n\t\t\t\t\t\tecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services\n\t\t\t\t\tperforms additional authorization to verify if users or roles have permissions to create tags.\n\t\t\t\t\tTherefore, you must grant explicit permissions to use the ecs:TagResource action.\n\t\t\t\t\tFor more information, see Grant permission\n\t\t\t\t\t\tto tag resources on creation in the Amazon ECS Developer\n\t\t\t\t\tGuide.
\n guardDutyActivate - The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether\n\t\t\tAmazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your\n\t\t\tAmazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.
The account setting value for the specified principal ARN. Accepted values are\n\t\t\t\tenabled, disabled, on, and\n\t\t\toff.
When you specify fargateTaskRetirementWaitPeriod for the\n\t\t\t\tname, the following are the valid values:
\n 0 - Amazon Web Services sends the notification, and immediately retires the\n\t\t\t\t\taffected tasks.
\n 7 - Amazon Web Services sends the notification, and waits 7 calendar days to\n\t\t\t\t\tretire the tasks.
\n 14 - Amazon Web Services sends the notification, and waits 14 calendar days to\n\t\t\t\t\tretire the tasks.
The account setting value for the specified principal ARN. Accepted values are enabled,\n\t\t\t\tdisabled, on, and off.
When you specify fargateTaskRetirementWaitPeriod for the name, the\n\t\t\tfollowing are the valid values:
\n 0 - Amazon Web Services sends the notification, and immediately retires the affected\n\t\t\t\t\ttasks.
\n 7 - Amazon Web Services sends the notification, and waits 7 calendar days to retire the\n\t\t\t\t\ttasks.
\n 14 - Amazon Web Services sends the notification, and waits 14 calendar days to retire the\n\t\t\t\t\ttasks.
The Amazon ECS account setting name to modify.
\nThe following are the valid values for the account setting name.
\n\n serviceLongArnFormat - When modified, the Amazon Resource Name\n\t\t\t\t\t(ARN) and resource ID format of the resource type for a specified user, role, or\n\t\t\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting\n\t\t\t\t\tmust be set for each Amazon ECS resource separately. The ARN and resource ID format\n\t\t\t\t\tof a resource is defined by the opt-in status of the user or role that created\n\t\t\t\t\tthe resource. You must turn on this setting to use Amazon ECS features such as\n\t\t\t\t\tresource tagging.
\n taskLongArnFormat - When modified, the Amazon Resource Name (ARN)\n\t\t\t\t\tand resource ID format of the resource type for a specified user, role, or the\n\t\t\t\t\troot user for an account is affected. The opt-in and opt-out account setting must\n\t\t\t\t\tbe set for each Amazon ECS resource separately. The ARN and resource ID format of a\n\t\t\t\t\tresource is defined by the opt-in status of the user or role that created the\n\t\t\t\t\tresource. You must turn on this setting to use Amazon ECS features such as resource\n\t\t\t\t\ttagging.
\n containerInstanceLongArnFormat - When modified, the Amazon\n\t\t\t\t\tResource Name (ARN) and resource ID format of the resource type for a specified\n\t\t\t\t\tuser, role, or the root user for an account is affected. The opt-in and opt-out\n\t\t\t\t\taccount setting must be set for each Amazon ECS resource separately. The ARN and\n\t\t\t\t\tresource ID format of a resource is defined by the opt-in status of the user or\n\t\t\t\t\trole that created the resource. You must turn on this setting to use Amazon ECS\n\t\t\t\t\tfeatures such as resource tagging.
\n awsvpcTrunking - When modified, the elastic network interface\n\t\t\t\t\t(ENI) limit for any new container instances that support the feature is changed.\n\t\t\t\t\tIf awsvpcTrunking is turned on, any new container instances that\n\t\t\t\t\tsupport the feature are launched have the increased ENI limits available to\n\t\t\t\t\tthem. For more information, see Elastic\n\t\t\t\t\t\tNetwork Interface Trunking in the Amazon Elastic Container Service Developer Guide.
\n containerInsights - When modified, the default setting indicating\n\t\t\t\t\twhether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed.\n\t\t\t\t\tIf containerInsights is turned on, any new clusters that are\n\t\t\t\t\tcreated will have Container Insights turned on unless you disable it during\n\t\t\t\t\tcluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.
\n dualStackIPv6 - When turned on, when using a VPC in dual stack\n\t\t\t\t\tmode, your tasks using the awsvpc network mode can have an IPv6\n\t\t\t\t\taddress assigned. For more information on using IPv6 with tasks launched on\n\t\t\t\t\tAmazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6\n\t\t\t\t\twith tasks launched on Fargate, see Using a VPC in dual-stack mode.
\n fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a\n\t\t\t\t\tsecurity or infrastructure update is needed for an Amazon ECS task hosted on\n\t\t\t\t\tFargate, the tasks need to be stopped and new tasks launched to replace them.\n\t\t\t\t\tUse fargateTaskRetirementWaitPeriod to configure the wait time to\n\t\t\t\t\tretire a Fargate task. For information about the Fargate tasks maintenance,\n\t\t\t\t\tsee Amazon Web Services Fargate\n\t\t\t\t\t\ttask maintenance in the Amazon ECS Developer\n\t\t\t\t\tGuide.
\n tagResourceAuthorization - Amazon ECS is introducing tagging\n\t\t\t\t\tauthorization for resource creation. Users must have permissions for actions\n\t\t\t\t\tthat create the resource, such as ecsCreateCluster. If tags are\n\t\t\t\t\tspecified when you create a resource, Amazon Web Services performs additional authorization to\n\t\t\t\t\tverify if users or roles have permissions to create tags. Therefore, you must\n\t\t\t\t\tgrant explicit permissions to use the ecs:TagResource action. For\n\t\t\t\t\tmore information, see Grant permission to tag resources on creation in the\n\t\t\t\t\t\tAmazon ECS Developer Guide.
\n guardDutyActivate - The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether\n\t\t\tAmazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your\n\t\t\tAmazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.
The Amazon ECS account setting name to modify.
\nThe following are the valid values for the account setting name.
\n\n serviceLongArnFormat - When modified, the Amazon Resource Name (ARN) and\n\t\t\t\t\tresource ID format of the resource type for a specified user, role, or the root user for an\n\t\t\t\t\taccount is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource\n\t\t\t\t\tseparately. The ARN and resource ID format of a resource is defined by the opt-in status of\n\t\t\t\t\tthe user or role that created the resource. You must turn on this setting to use Amazon ECS features\n\t\t\t\t\tsuch as resource tagging.
\n taskLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource\n\t\t\t\t\tID format of the resource type for a specified user, role, or the root user for an account is\n\t\t\t\t\taffected. The opt-in and opt-out account setting must be set for each Amazon ECS resource\n\t\t\t\t\tseparately. The ARN and resource ID format of a resource is defined by the opt-in status of\n\t\t\t\t\tthe user or role that created the resource. You must turn on this setting to use Amazon ECS features\n\t\t\t\t\tsuch as resource tagging.
\n containerInstanceLongArnFormat - When modified, the Amazon Resource Name (ARN)\n\t\t\t\t\tand resource ID format of the resource type for a specified user, role, or the root user for an\n\t\t\t\t\taccount is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource\n\t\t\t\t\tseparately. The ARN and resource ID format of a resource is defined by the opt-in status of\n\t\t\t\t\tthe user or role that created the resource. You must turn on this setting to use Amazon ECS features\n\t\t\t\t\tsuch as resource tagging.
\n awsvpcTrunking - When modified, the elastic network interface (ENI) limit for\n\t\t\t\t\tany new container instances that support the feature is changed. If awsvpcTrunking\n\t\t\t\t\tis turned on, any new container instances that support the feature are launched have the\n\t\t\t\t\tincreased ENI limits available to them. For more information, see Elastic Network Interface\n\t\t\t\t\t\tTrunking in the Amazon Elastic Container Service Developer Guide.
\n containerInsights - When modified, the default setting indicating whether Amazon Web Services\n\t\t\t\t\tCloudWatch Container Insights is turned on for your clusters is changed. If\n\t\t\t\t\t\tcontainerInsights is turned on, any new clusters that are created will have\n\t\t\t\t\tContainer Insights turned on unless you disable it during cluster creation. For more\n\t\t\t\t\tinformation, see CloudWatch Container\n\t\t\t\t\t\tInsights in the Amazon Elastic Container Service Developer Guide.
\n dualStackIPv6 - When turned on, when using a VPC in dual stack mode, your tasks\n\t\t\t\t\tusing the awsvpc network mode can have an IPv6 address assigned. For more\n\t\t\t\t\tinformation on using IPv6 with tasks launched on Amazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6 with tasks\n\t\t\t\t\tlaunched on Fargate, see Using a VPC in dual-stack mode.
\n fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a security or\n\t\t\t\t\tinfrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be\n\t\t\t\t\tstopped and new tasks launched to replace them. Use\n\t\t\t\t\t\tfargateTaskRetirementWaitPeriod to configure the wait time to retire a\n\t\t\t\t\tFargate task. For information about the Fargate tasks maintenance, see Amazon Web Services\n\t\t\t\t\t\tFargate task maintenance in the Amazon ECS Developer\n\t\t\t\t\tGuide.
\n tagResourceAuthorization - Amazon ECS is introducing tagging authorization for\n\t\t\t\t\tresource creation. Users must have permissions for actions that create the resource, such as\n\t\t\t\t\t\tecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services\n\t\t\t\t\tperforms additional authorization to verify if users or roles have permissions to create tags.\n\t\t\t\t\tTherefore, you must grant explicit permissions to use the ecs:TagResource action.\n\t\t\t\t\tFor more information, see Grant permission\n\t\t\t\t\t\tto tag resources on creation in the Amazon ECS Developer\n\t\t\t\t\tGuide.
\n guardDutyActivate - The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether\n\t\t\tAmazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your\n\t\t\tAmazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.
The account setting value for the specified principal ARN. Accepted values are\n\t\t\t\tenabled, disabled, on, and\n\t\t\toff.
When you specify fargateTaskRetirementWaitPeriod for the\n\t\t\t\tname, the following are the valid values:
\n 0 - Amazon Web Services sends the notification, and immediately retires the\n\t\t\t\t\taffected tasks.
\n 7 - Amazon Web Services sends the notification, and waits 7 calendar days to\n\t\t\t\t\tretire the tasks.
\n 14 - Amazon Web Services sends the notification, and waits 14 calendar days to\n\t\t\t\t\tretire the tasks.
The account setting value for the specified principal ARN. Accepted values are enabled,\n\t\t\t\tdisabled, on, and off.
When you specify fargateTaskRetirementWaitPeriod for the name, the\n\t\t\tfollowing are the valid values:
\n 0 - Amazon Web Services sends the notification, and immediately retires the affected\n\t\t\t\t\ttasks.
\n 7 - Amazon Web Services sends the notification, and waits 7 calendar days to retire the\n\t\t\t\t\ttasks.
\n 14 - Amazon Web Services sends the notification, and waits 14 calendar days to retire the\n\t\t\t\t\ttasks.
The ARN of the principal, which can be a user, role, or the root user. If you specify\n\t\t\tthe root user, it modifies the account setting for all users, roles, and the root user of the\n\t\t\taccount unless a user or role explicitly overrides these settings. If this field is\n\t\t\tomitted, the setting is changed only for the authenticated user.
\nYou must use the root user when you set the Fargate wait time\n\t\t\t\t\t(fargateTaskRetirementWaitPeriod).
Federated users assume the account setting of the root user and can't have explicit\n\t\t\t\taccount settings set for them.
\nThe ARN of the principal, which can be a user, role, or the root user. If you specify the root user, it\n\t\t\tmodifies the account setting for all users, roles, and the root user of the account unless a user or role\n\t\t\texplicitly overrides these settings. If this field is omitted, the setting is changed only for the\n\t\t\tauthenticated user.
\nYou must use the root user when you set the Fargate wait time\n\t\t\t\t\t(fargateTaskRetirementWaitPeriod).
Federated users assume the account setting of the root user and can't have explicit account settings\n\t\t\t\tset for them.
\nCreate or update an attribute on an Amazon ECS resource. If the attribute doesn't exist,\n\t\t\tit's created. If the attribute exists, its value is replaced with the specified value.\n\t\t\tTo delete an attribute, use DeleteAttributes. For more information,\n\t\t\tsee Attributes in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, it's created. If\n\t\t\tthe attribute exists, its value is replaced with the specified value. To delete an attribute, use\n\t\t\t\tDeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#PutAttributesRequest": { @@ -9178,13 +9190,13 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply\n\t\t\tattributes. If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "attributes": { "target": "com.amazonaws.ecs#Attributes", "traits": { - "smithy.api#documentation": "The attributes to apply to your resource. You can specify up to 10 custom attributes\n\t\t\tfor each resource. You can specify up to 10 attributes in a single call.
", + "smithy.api#documentation": "The attributes to apply to your resource. You can specify up to 10 custom attributes for each\n\t\t\tresource. You can specify up to 10 attributes in a single call.
", "smithy.api#required": {} } } @@ -9236,7 +9248,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the available capacity providers and the default capacity provider strategy\n\t\t\tfor a cluster.
\nYou must specify both the available capacity providers and a default capacity provider\n\t\t\tstrategy for the cluster. If the specified cluster has existing capacity providers\n\t\t\tassociated with it, you must specify all existing capacity providers in addition to any\n\t\t\tnew ones you want to add. Any existing capacity providers that are associated with a\n\t\t\tcluster that are omitted from a PutClusterCapacityProviders API call\n\t\t\twill be disassociated with the cluster. You can only disassociate an existing capacity\n\t\t\tprovider from a cluster if it's not being used by any existing tasks.
\nWhen creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified, then the cluster's default capacity provider strategy is used.\n\t\t\tWe recommend that you define a default capacity provider strategy for your cluster.\n\t\t\tHowever, you must specify an empty array ([]) to bypass defining a default\n\t\t\tstrategy.
Modifies the available capacity providers and the default capacity provider strategy for a\n\t\t\tcluster.
\nYou must specify both the available capacity providers and a default capacity provider strategy for\n\t\t\tthe cluster. If the specified cluster has existing capacity providers associated with it, you must\n\t\t\tspecify all existing capacity providers in addition to any new ones you want to add. Any existing\n\t\t\tcapacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only\n\t\t\tdisassociate an existing capacity provider from a cluster if it's not being used by any existing\n\t\t\ttasks.
\nWhen creating a service or running a task on a cluster, if no capacity provider or launch type is\n\t\t\tspecified, then the cluster's default capacity provider strategy is used. We recommend that you define\n\t\t\ta default capacity provider strategy for your cluster. However, you must specify an empty array\n\t\t\t\t([]) to bypass defining a default strategy.
The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider\n\t\t\tsettings for. If you don't specify a cluster, the default cluster is assumed.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you\n\t\t\tdon't specify a cluster, the default cluster is assumed.
", "smithy.api#required": {} } }, "capacityProviders": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "The name of one or more capacity providers to associate with the cluster.
\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The name of one or more capacity providers to associate with the cluster.
\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already\n\t\t\tbe created. New capacity providers can be created with the CreateCapacityProvider\n\t\t\tAPI operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are available to all\n\t\t\taccounts and only need to be associated with a cluster to be used.
The capacity provider strategy to use by default for the cluster.
\nWhen creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified then the default capacity provider strategy for the cluster is\n\t\t\tused.
\nA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The capacity provider strategy to use by default for the cluster.
\nWhen creating a service or running a task on a cluster, if no capacity provider or launch type is\n\t\t\tspecified then the default capacity provider strategy for the cluster is used.
\nA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider must be associated\n\t\t\twith the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.\n\t\t\tOnly capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already\n\t\t\tbe created. New capacity providers can be created with the CreateCapacityProvider\n\t\t\tAPI operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are available to all\n\t\t\taccounts and only need to be associated with a cluster to be used.
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nRegisters an EC2 instance into the specified cluster. This instance becomes available\n\t\t\tto place containers on.
" + "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nRegisters an EC2 instance into the specified cluster. This instance becomes available to place\n\t\t\tcontainers on.
" } }, "com.amazonaws.ecs#RegisterContainerInstanceRequest": { @@ -9311,19 +9323,19 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance\n\t\t\twith. If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "instanceIdentityDocument": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The instance identity document for the EC2 instance to register. This document can be\n\t\t\tfound by running the following command from the instance: curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/document/\n
The instance identity document for the EC2 instance to register. This document can be found by\n\t\t\trunning the following command from the instance: curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/document/\n
The instance identity document signature for the EC2 instance to register. This\n\t\t\tsignature can be found by running the following command from the instance: curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/signature/\n
The instance identity document signature for the EC2 instance to register. This signature can be\n\t\t\tfound by running the following command from the instance: curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/signature/\n
The version information for the Amazon ECS container agent and Docker daemon that runs on\n\t\t\tthe container instance.
" + "smithy.api#documentation": "The version information for the Amazon ECS container agent and Docker daemon that runs on the container\n\t\t\tinstance.
" } }, "containerInstanceArn": { @@ -9353,13 +9365,13 @@ "platformDevices": { "target": "com.amazonaws.ecs#PlatformDevices", "traits": { - "smithy.api#documentation": "The devices that are available on the container instance. The only supported device\n\t\t\ttype is a GPU.
" + "smithy.api#documentation": "The devices that are available on the container instance. The only supported device type is a\n\t\t\tGPU.
" } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the container instance to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Registers a new task definition from the supplied family and\n\t\t\t\tcontainerDefinitions. Optionally, you can add data volumes to your\n\t\t\tcontainers with the volumes parameter. For more information about task\n\t\t\tdefinition parameters and defaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.
You can specify a role for your task with the taskRoleArn parameter. When\n\t\t\tyou specify a role for a task, its containers can then use the latest versions of the\n\t\t\tCLI or SDKs to make API requests to the Amazon Web Services services that are specified in the\n\t\t\tpolicy that's associated with the role. For more information, see IAM\n\t\t\t\tRoles for Tasks in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition\n\t\t\twith the networkMode parameter. If you specify the awsvpc\n\t\t\tnetwork mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with\n\t\t\tthe task definition. For more information, see Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
Registers a new task definition from the supplied family and\n\t\t\t\tcontainerDefinitions. Optionally, you can add data volumes to your containers with the\n\t\t\t\tvolumes parameter. For more information about task definition parameters and defaults,\n\t\t\tsee Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.
You can specify a role for your task with the taskRoleArn parameter. When you specify a\n\t\t\trole for a task, its containers can then use the latest versions of the CLI or SDKs to make API\n\t\t\trequests to the Amazon Web Services services that are specified in the policy that's associated with the role. For\n\t\t\tmore information, see IAM Roles for Tasks in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition with the\n\t\t\t\tnetworkMode parameter. If you specify the awsvpc network mode, the task\n\t\t\tis allocated an elastic network interface, and you must specify a NetworkConfiguration when\n\t\t\tyou create a service or run a task with the task definition. For more information, see Task\n\t\t\t\tNetworking in the Amazon Elastic Container Service Developer Guide.
You must specify a family for a task definition. You can use it track\n\t\t\tmultiple versions of the same task definition. The family is used as a name\n\t\t\tfor your task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
You must specify a family for a task definition. You can use it track multiple versions\n\t\t\tof the same task definition. The family is used as a name for your task definition.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can\n\t\t\tassume. All containers in this task are granted the permissions that are specified in\n\t\t\tthis role. For more information, see IAM Roles for\n\t\t\t\tTasks in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All\n\t\t\tcontainers in this task are granted the permissions that are specified in this role. For more\n\t\t\tinformation, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
" } }, "executionRoleArn": { @@ -9472,68 +9484,68 @@ "networkMode": { "target": "com.amazonaws.ecs#NetworkMode", "traits": { - "smithy.api#documentation": "The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. \n For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, awsvpc can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.
When using the host network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
For more information, see Network\n settings in the Docker run reference.
" + "smithy.api#documentation": "The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. \n For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, awsvpc can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.
When using the host network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
A list of container definitions in JSON format that describe the different containers\n\t\t\tthat make up your task.
", + "smithy.api#documentation": "A list of container definitions in JSON format that describe the different containers that make up\n\t\t\tyour task.
", "smithy.api#required": {} } }, "volumes": { "target": "com.amazonaws.ecs#VolumeList", "traits": { - "smithy.api#documentation": "A list of volume definitions in JSON format that containers in your task might\n\t\t\tuse.
" + "smithy.api#documentation": "A list of volume definitions in JSON format that containers in your task might use.
" } }, "placementConstraints": { "target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraints", "traits": { - "smithy.api#documentation": "An array of placement constraint objects to use for the task. You can specify a\n\t\t\tmaximum of 10 constraints for each task. This limit includes constraints in the task\n\t\t\tdefinition and those specified at runtime.
" + "smithy.api#documentation": "An array of placement constraint objects to use for the task. You can specify a maximum of 10\n\t\t\tconstraints for each task. This limit includes constraints in the task definition and those specified\n\t\t\tat runtime.
" } }, "requiresCompatibilities": { "target": "com.amazonaws.ecs#CompatibilityList", "traits": { - "smithy.api#documentation": "The task launch type that Amazon ECS validates the task definition against. A client\n\t\t\texception is returned if the task definition doesn't validate against the\n\t\t\tcompatibilities specified. If no value is specified, the parameter is omitted from the\n\t\t\tresponse.
" + "smithy.api#documentation": "The task launch type that Amazon ECS validates the task definition against. A client exception is returned\n\t\t\tif the task definition doesn't validate against the compatibilities specified. If no value is\n\t\t\tspecified, the parameter is omitted from the response.
" } }, "cpu": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The number of CPU units used by the task. It can be expressed as an integer using CPU\n\t\t\tunits (for example, 1024) or as a string using vCPUs (for example, 1\n\t\t\t\tvCPU or 1 vcpu) in a task definition. String values are\n\t\t\tconverted to an integer indicating the CPU units when the task definition is\n\t\t\tregistered.
Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.
\nIf you're using the EC2 launch type, this field is optional. Supported\n\t\t\tvalues are between 128 CPU units (0.125 vCPUs) and\n\t\t\t\t10240 CPU units (10 vCPUs). If you do not specify a value,\n\t\t\tthe parameter is ignored.
If you're using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the memory parameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.
\n256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or\n later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or\n later.
The number of CPU units used by the task. It can be expressed as an integer using CPU units (for\n\t\t\texample, 1024) or as a string using vCPUs (for example, 1 vCPU or 1\n\t\t\t\tvcpu) in a task definition. String values are converted to an integer indicating the CPU\n\t\t\tunits when the task definition is registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying\n\t\t\t\tcontainer-level resources for Windows containers.
\nIf you're using the EC2 launch type, this field is optional. Supported values are\n\t\t\tbetween 128 CPU units (0.125 vCPUs) and 10240 CPU units\n\t\t\t\t(10 vCPUs). If you do not specify a value, the parameter is ignored.
If you're using the Fargate launch type, this field is required and you must use one of\n\t\t\tthe following values, which determines your range of supported values for the memory\n\t\t\tparameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.
\n256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or\n later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or\n later.
The amount of memory (in MiB) used by the task. It can be expressed as an integer\n\t\t\tusing MiB (for example ,1024) or as a string using GB (for example,\n\t\t\t\t1GB or 1 GB) in a task definition. String values are\n\t\t\tconverted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.
Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.
\nIf using the EC2 launch type, this field is optional.
\nIf using the Fargate launch type, this field is required and you must\n\t\t\tuse one of the following values. This determines your range of supported values for the\n\t\t\t\tcpu parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.
\n512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or\n later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or\n later.
The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB (for\n\t\t\texample ,1024) or as a string using GB (for example, 1GB or 1\n\t\t\tGB) in a task definition. String values are converted to an integer indicating the MiB when the\n\t\t\ttask definition is registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying\n\t\t\t\tcontainer-level resources for Windows containers.
\nIf using the EC2 launch type, this field is optional.
\nIf using the Fargate launch type, this field is required and you must use one of the\n\t\t\tfollowing values. This determines your range of supported values for the cpu\n\t\t\tparameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.
\n512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or\n later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or\n later.
The metadata that you apply to the task definition to help you categorize and organize\n\t\t\tthem. Each tag consists of a key and an optional value. You define both of them.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the task definition to help you categorize and organize them. Each tag\n\t\t\tconsists of a key and an optional value. You define both of them.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The process namespace to use for the containers in the task. The valid\n values are host or task. On Fargate for\n Linux containers, the only valid value is task. For\n example, monitoring sidecars might need pidMode to access\n information about other containers running in the same task.
If host is specified, all containers within the tasks\n that specified the host PID mode on the same container\n instance share the same process namespace with the host Amazon EC2\n instance.
If task is specified, all containers within the specified\n task share the same process namespace.
If no value is specified, the\n default is a private namespace for each container. For more information,\n see PID settings in the Docker run\n reference.
\nIf the host PID mode is used, there's a heightened risk\n of undesired process namespace exposure. For more information, see\n Docker security.
This parameter is not supported for Windows containers.
\nThis parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.
The process namespace to use for the containers in the task. The valid\n values are host or task. On Fargate for\n Linux containers, the only valid value is task. For\n example, monitoring sidecars might need pidMode to access\n information about other containers running in the same task.
If host is specified, all containers within the tasks\n that specified the host PID mode on the same container\n instance share the same process namespace with the host Amazon EC2\n instance.
If task is specified, all containers within the specified\n task share the same process namespace.
If no value is specified, the\n default is a private namespace for each container.
\nIf the host PID mode is used, there's a heightened risk\n of undesired process namespace exposure.
This parameter is not supported for Windows containers.
\nThis parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.
The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.
If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.
If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related\n systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related\n systemControls will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks run on Fargate.
\nThe IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance.
If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose.
If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related\n systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related\n systemControls will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks run on Fargate.
\nThe configuration details for the App Mesh proxy.
\nFor tasks hosted on Amazon EC2 instances, the container instances require at least version\n\t\t\t\t1.26.0 of the container agent and at least version\n\t\t\t\t1.26.0-1 of the ecs-init package to use a proxy\n\t\t\tconfiguration. If your container instances are launched from the Amazon ECS-optimized\n\t\t\tAMI version 20190301 or later, then they contain the required versions of\n\t\t\tthe container agent and ecs-init. For more information, see Amazon ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.
The configuration details for the App Mesh proxy.
\nFor tasks hosted on Amazon EC2 instances, the container instances require at least version\n\t\t\t\t1.26.0 of the container agent and at least version 1.26.0-1 of the\n\t\t\t\tecs-init package to use a proxy configuration. If your container instances are\n\t\t\tlaunched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain\n\t\t\tthe required versions of the container agent and ecs-init. For more information, see\n\t\t\t\tAmazon ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.
The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Using data volumes in\n\t\t\t\ttasks in the Amazon ECS Developer Guide.
\nFor tasks using the Fargate launch type, the task requires the\n\t\t\t\tfollowing platforms:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total\n\t\t\tamount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For\n\t\t\tmore information, see Using data volumes in tasks\n\t\t\tin the Amazon ECS Developer Guide.
\nFor tasks using the Fargate launch type, the task requires the following\n\t\t\t\tplatforms:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
The operating system that your tasks definitions run on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.
" + "smithy.api#documentation": "The operating system that your tasks definitions run on. A platform family is specified only for\n\t\t\ttasks using the Fargate launch type.
" } } }, @@ -9585,7 +9597,7 @@ "credentialsParameter": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret containing the private repository\n\t\t\tcredentials.
\nWhen you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same\n\t\t\t\tRegion as the task that you're launching then you can use either the full ARN or\n\t\t\t\tthe name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN\n\t\t\t\tof the secret.
\nThe Amazon Resource Name (ARN) of the secret containing the private repository credentials.
\nWhen you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same Region as the\n\t\t\t\ttask that you're launching then you can use either the full ARN or the name of the secret. When\n\t\t\t\tyou use the Amazon Web Services Management Console, you must specify the full ARN of the secret.
\nThe name of the resource, such as CPU, MEMORY,\n\t\t\t\tPORTS, PORTS_UDP, or a user-defined resource.
The name of the resource, such as CPU, MEMORY, PORTS,\n\t\t\t\tPORTS_UDP, or a user-defined resource.
The type of the resource. Valid values: INTEGER, DOUBLE,\n\t\t\t\tLONG, or STRINGSET.
The type of the resource. Valid values: INTEGER, DOUBLE, LONG,\n\t\t\tor STRINGSET.
When the doubleValue type is set, the value of the resource must be a\n\t\t\tdouble precision floating-point type.
When the doubleValue type is set, the value of the resource must be a double precision\n\t\t\tfloating-point type.
When the longValue type is set, the value of the resource must be an\n\t\t\textended precision floating-point type.
When the longValue type is set, the value of the resource must be an extended precision\n\t\t\tfloating-point type.
When the integerValue type is set, the value of the resource must be an\n\t\t\tinteger.
When the integerValue type is set, the value of the resource must be an integer.
When the stringSetValue type is set, the value of the resource must be a\n\t\t\tstring type.
When the stringSetValue type is set, the value of the resource must be a string\n\t\t\ttype.
The value for the specified resource type.
\nWhen the type is GPU, the value is the number of physical GPUs the\n\t\t\tAmazon ECS container agent reserves for the container. The number of GPUs that's reserved for\n\t\t\tall containers in a task can't exceed the number of available GPUs on the container\n\t\t\tinstance that the task is launched on.
When the type is InferenceAccelerator, the value matches\n\t\t\tthe deviceName for an InferenceAccelerator specified in a task definition.
The value for the specified resource type.
\nWhen the type is GPU, the value is the number of physical GPUs the Amazon ECS\n\t\t\tcontainer agent reserves for the container. The number of GPUs that's reserved for all containers in a\n\t\t\ttask can't exceed the number of available GPUs on the container instance that the task is launched\n\t\t\ton.
When the type is InferenceAccelerator, the value matches the\n\t\t\t\tdeviceName for an InferenceAccelerator\n\t\t\tspecified in a task definition.
The type and amount of a resource to assign to a container. The supported resource\n\t\t\ttypes are GPUs and Elastic Inference accelerators. For more information, see Working with\n\t\t\t\tGPUs on Amazon ECS or Working with Amazon Elastic\n\t\t\t\tInference on Amazon ECS in the Amazon Elastic Container Service Developer Guide\n
" + "smithy.api#documentation": "The type and amount of a resource to assign to a container. The supported resource types are GPUs and\n\t\t\tElastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon\n\t\t\t\tElastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide\n
" } }, "com.amazonaws.ecs#ResourceRequirements": { @@ -9752,7 +9764,7 @@ "serviceRevisionArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The ARN of the service revision deployed as part of the rollback.
\nWhen the type is GPU, the value is the number of physical\n\t\t\t\tGPUs the Amazon ECS container agent reserves for the container. The number\n\t\t\tof GPUs that's reserved for all containers in a task can't exceed the number of\n\t\t\tavailable GPUs on the container instance that the task is launched on.
When the type is InferenceAccelerator, the value matches the\n\t\t\t\tdeviceName for an InferenceAccelerator specified in a task definition.
The ARN of the service revision deployed as part of the rollback.
\nWhen the type is GPU, the value is the number of physical\n\t\t\tGPUs the Amazon ECS container agent reserves for the container. The number\n\t\t\tof GPUs that's reserved for all containers in a task can't exceed the number of\n\t\t\tavailable GPUs on the container instance that the task is launched on.
When the type is InferenceAccelerator, the value matches the\n\t\t\tdeviceName for an InferenceAccelerator specified in a task definition.
Starts a new task using the specified task definition.
\nOn 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.
\nAmazon Elastic Inference (EI) is no longer available to customers.
\nYou can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the Amazon Elastic Container Service Developer Guide.
\nAlternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
\nThe Amazon ECS API follows an eventual consistency model. This is because of the\n\t\t\tdistributed nature of the system supporting the API. This means that the result of an\n\t\t\tAPI command you run that affects your Amazon ECS resources might not be immediately visible\n\t\t\tto all subsequent commands you run. Keep this in mind when you carry out an API command\n\t\t\tthat immediately follows a previous API command.
\nTo manage eventual consistency, you can do the following:
\nConfirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.
\nAdd wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.
\nStarts a new task using the specified task definition.
\nOn 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.
\nAmazon Elastic Inference (EI) is no longer available to customers.
\nYou can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using\n\t\t\tplacement constraints and placement strategies. For more information, see Scheduling\n\t\t\t\tTasks in the Amazon Elastic Container Service Developer Guide.
\nAlternatively, you can use StartTask to use your own scheduler or place tasks manually\n\t\t\ton specific container instances.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a\n\t\t\tservice. For more infomation, see Amazon EBS\n\t\t\t\tvolumes in the Amazon Elastic Container Service Developer Guide.
\nThe Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the\n\t\t\tsystem supporting the API. This means that the result of an API command you run that affects your Amazon ECS\n\t\t\tresources might not be immediately visible to all subsequent commands you run. Keep this in mind when\n\t\t\tyou carry out an API command that immediately follows a previous API command.
\nTo manage eventual consistency, you can do the following:
\nConfirm the state of the resource before you run a command to modify it. Run the\n\t\t\t\t\tDescribeTasks command using an exponential backoff algorithm to ensure that you allow enough\n\t\t\t\t\ttime for the previous command to propagate through the system. To do this, run the\n\t\t\t\t\tDescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing\n\t\t\t\t\tgradually up to five minutes of wait time.
\nAdd wait time between subsequent commands, even if the DescribeTasks command returns an\n\t\t\t\t\taccurate response. Apply an exponential backoff algorithm starting with a couple of seconds of\n\t\t\t\t\twait time, and increase gradually up to about five minutes of wait time.
\nThe capacity provider strategy to use for the task.
\nIf a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.
When you use cluster auto scaling, you must specify\n\t\t\t\tcapacityProviderStrategy and not launchType.
A capacity provider strategy may contain a maximum of 6 capacity providers.
" + "smithy.api#documentation": "The capacity provider strategy to use for the task.
\nIf a capacityProviderStrategy is specified, the launchType parameter must\n\t\t\tbe omitted. If no capacityProviderStrategy or launchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.
When you use cluster auto scaling, you must specify capacityProviderStrategy and not\n\t\t\t\tlaunchType.
A capacity provider strategy may contain a maximum of 6 capacity providers.
" } }, "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to run your task on.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to run your task on. If you do not specify a cluster, the default cluster is assumed.
" } }, "count": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The number of instantiations of the specified task to place on your cluster. You can\n\t\t\tspecify up to 10 tasks for each call.
" + "smithy.api#documentation": "The number of instantiations of the specified task to place on your cluster. You can specify up to 10\n\t\t\ttasks for each call.
" } }, "enableECSManagedTags": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether to use Amazon ECS managed tags for the task. For more information, see\n\t\t\t\tTagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" } }, "enableExecuteCommand": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Determines whether to use the execute command functionality for the containers in this\n\t\t\ttask. If true, this enables execute command functionality on all containers\n\t\t\tin the task.
If true, then the task definition must have a task role, or you must\n\t\t\tprovide one as an override.
Determines whether to use the execute command functionality for the containers in this task. If\n\t\t\t\ttrue, this enables execute command functionality on all containers in the task.
If true, then the task definition must have a task role, or you must provide one as an\n\t\t\toverride.
The name of the task group to associate with the task. The default value is the family\n\t\t\tname of the task definition (for example, family:my-family-name).
The name of the task group to associate with the task. The default value is the family name of the\n\t\t\ttask definition (for example, family:my-family-name).
The infrastructure to run your standalone task on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
\nThe FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.
Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the\n\t\t\t\t\tAmazon ECS Developer Guide.
\nThe EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.
The EXTERNAL launch type runs your tasks on your on-premises server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.
When you use cluster auto scaling, you must specify\n\t\t\t\tcapacityProviderStrategy and not launchType.
The infrastructure to run your standalone task on. For more information, see Amazon ECS launch\n\t\t\t\ttypes in the Amazon Elastic Container Service Developer Guide.
\nThe FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used.\n\t\t\t\tFor more information, see Fargate capacity providers in the Amazon ECS Developer\n\t\t\t\tGuide.
\nThe EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.
The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine\n\t\t\t(VM) capacity registered to your cluster.
A task can use either a launch type or a capacity provider strategy. If a launchType is\n\t\t\tspecified, the capacityProviderStrategy parameter must be omitted.
When you use cluster auto scaling, you must specify capacityProviderStrategy and not\n\t\t\t\tlaunchType.
The network configuration for the task. This parameter is required for task\n\t\t\tdefinitions that use the awsvpc network mode to receive their own elastic\n\t\t\tnetwork interface, and it isn't supported for other network modes. For more information,\n\t\t\tsee Task networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The network configuration for the task. This parameter is required for task definitions that use the\n\t\t\t\tawsvpc network mode to receive their own elastic network interface, and it isn't\n\t\t\tsupported for other network modes. For more information, see Task networking in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it should receive. You can override the\n\t\t\tdefault command for a container (that's specified in the task definition or Docker\n\t\t\timage) with a command override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\tformatting characters of the override structure.
" + "smithy.api#documentation": "A list of container overrides in JSON format that specify the name of a container in the specified\n\t\t\ttask definition and the overrides it should receive. You can override the default command for a\n\t\t\tcontainer (that's specified in the task definition or Docker image) with a command\n\t\t\toverride. You can also override existing environment variables (that are specified in the task\n\t\t\tdefinition or Docker image) on a container or add new environment variables to it with an\n\t\t\t\tenvironment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting\n\t\t\tcharacters of the override structure.
" } }, "placementConstraints": { "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { - "smithy.api#documentation": "An array of placement constraint objects to use for the task. You can specify up to 10\n\t\t\tconstraints for each task (including constraints in the task definition and those\n\t\t\tspecified at runtime).
" + "smithy.api#documentation": "An array of placement constraint objects to use for the task. You can specify up to 10 constraints\n\t\t\tfor each task (including constraints in the task definition and those specified at runtime).
" } }, "placementStrategy": { "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { - "smithy.api#documentation": "The placement strategy objects to use for the task. You can specify a maximum of 5\n\t\t\tstrategy rules for each task.
" + "smithy.api#documentation": "The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for\n\t\t\teach task.
" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The platform version the task uses. A platform version is only specified for tasks\n\t\t\thosted on Fargate. If one isn't specified, the LATEST\n\t\t\tplatform version is used. For more information, see Fargate platform\n\t\t\t\tversions in the Amazon Elastic Container Service Developer Guide.
The platform version the task uses. A platform version is only specified for tasks hosted on\n\t\t\tFargate. If one isn't specified, the LATEST platform version is used. For\n\t\t\tmore information, see Fargate platform versions in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
Specifies whether to propagate the tags from the task definition to the task. If no\n\t\t\tvalue is specified, the tags aren't propagated. Tags can only be propagated to the task\n\t\t\tduring task creation. To add tags to a task after task creation, use theTagResource API action.
\nAn error will be received if you specify the SERVICE option when\n\t\t\t\trunning a task.
Specifies whether to propagate the tags from the task definition to the task. If no value is\n\t\t\tspecified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To\n\t\t\tadd tags to a task after task creation, use theTagResource API action.
\nAn error will be received if you specify the SERVICE option when running a\n\t\t\t\ttask.
An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call with\n\t\t\tthe startedBy value. Up to 128 letters (uppercase and lowercase), numbers,\n\t\t\thyphens (-), forward slash (/), and underscores (_) are allowed.
If a task is started by an Amazon ECS service, then the startedBy parameter\n\t\t\tcontains the deployment ID of the service that starts it.
An optional tag specified when a task is started. For example, if you automatically trigger a task to\n\t\t\trun a batch process job, you could apply a unique identifier for that job to your task with the\n\t\t\t\tstartedBy parameter. You can then identify which tasks belong to that job by filtering\n\t\t\tthe results of a ListTasks call with the startedBy value. Up to 128 letters (uppercase and\n\t\t\tlowercase), numbers, hyphens (-), forward slash (/), and underscores (_) are allowed.
If a task is started by an Amazon ECS service, then the startedBy parameter contains the\n\t\t\tdeployment ID of the service that starts it.
The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the task to help you categorize and organize them. Each tag consists\n\t\t\tof a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run. If a revision isn't specified,\n\t\t\tthe latest ACTIVE revision is used.
The full ARN value must match the value that you specified as the\n\t\t\t\tResource of the principal's permissions policy.
When you specify a task definition, you must either specify a specific revision, or\n\t\t\tall revisions in the ARN.
\nTo specify a specific revision, include the revision number in the ARN. For example,\n\t\t\tto specify revision 2, use\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2.
To specify all revisions, use the wildcard (*) in the ARN. For example, to specify\n\t\t\tall revisions, use\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*.
For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
", + "smithy.api#documentation": "The family and revision (family:revision) or full ARN of the\n\t\t\ttask definition to run. If a revision isn't specified, the latest ACTIVE\n\t\t\trevision is used.
The full ARN value must match the value that you specified as the Resource of the\n\t\t\tprincipal's permissions policy.
When you specify a task definition, you must either specify a specific revision, or all revisions in\n\t\t\tthe ARN.
\nTo specify a specific revision, include the revision number in the ARN. For example, to specify\n\t\t\trevision 2, use\n\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2.
To specify all revisions, use the wildcard (*) in the ARN. For example, to specify all revisions,\n\t\t\tuse arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*.
For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "An identifier that you provide to ensure the idempotency of the request. It must be\n\t\t\tunique and is case sensitive. Up to 64 characters are allowed. The valid characters are\n\t\t\tcharacters in the range of 33-126, inclusive. For more information, see Ensuring idempotency.
", + "smithy.api#documentation": "An identifier that you provide to ensure the idempotency of the request. It must be unique and is\n\t\t\tcase sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of\n\t\t\t33-126, inclusive. For more information, see Ensuring\n\t\t\t\tidempotency.
", "smithy.api#idempotencyToken": {} } }, "volumeConfigurations": { "target": "com.amazonaws.ecs#TaskVolumeConfigurations", "traits": { - "smithy.api#documentation": "The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tthe size, volumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration. The name of the volume must\n\t\t\tmatch the name from the task definition.
The details of the volume that was configuredAtLaunch. You can configure the size,\n\t\t\tvolumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration. The name of the volume must match the\n\t\t\t\tname from the task definition.
A full description of the tasks that were run. The tasks that were successfully placed\n\t\t\ton your cluster are described here.
" + "smithy.api#documentation": "A full description of the tasks that were run. The tasks that were successfully placed on your\n\t\t\tcluster are described here.
" } }, "failures": { "target": "com.amazonaws.ecs#Failures", "traits": { - "smithy.api#documentation": "Any failures associated with the call.
\nFor information about how to address failures, see Service event messages and API failure\n\t\t\t\treasons in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Any failures associated with the call.
\nFor information about how to address failures, see Service event messages and API failure reasons in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" } } }, @@ -9992,13 +10004,13 @@ "cpuArchitecture": { "target": "com.amazonaws.ecs#CPUArchitecture", "traits": { - "smithy.api#documentation": "The CPU architecture.
\nYou can run your Linux tasks on an ARM-based platform by setting the value to\n\t\t\t\tARM64. This option is available for tasks that run on Linux Amazon EC2\n\t\t\tinstance or Linux containers on Fargate.
The default is X86_64.
The CPU architecture.
\nYou can run your Linux tasks on an ARM-based platform by setting the value to ARM64.\n\t\t\tThis option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on\n\t\t\tFargate.
The operating system.
\nThe default is Linux.
The operating system.
" } } }, @@ -10013,7 +10025,7 @@ "target": "com.amazonaws.ecs#Double", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The value, specified as a percent total of a service's desiredCount, to\n\t\t\tscale the task set. Accepted values are numbers between 0 and 100.
The value, specified as a percent total of a service's desiredCount, to scale the task\n\t\t\tset. Accepted values are numbers between 0 and 100.
A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.
" + "smithy.api#documentation": "A floating-point percentage of the desired number of tasks to place and keep running in the task\n\t\t\tset.
" } }, "com.amazonaws.ecs#ScaleUnit": { @@ -10085,13 +10097,13 @@ "valueFrom": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The secret to expose to the container. The supported values are either the full ARN\n\t\t\tof the Secrets Manager secret or the full ARN of the parameter in the SSM\n\t\t\tParameter Store.
\nFor information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or\n\t\t\t\tRequired IAM permissions for Amazon ECS secrets (for Systems Manager Parameter\n\t\t\tstore) in the Amazon Elastic Container Service Developer Guide.
\nIf the SSM Parameter Store parameter exists in the same Region as the task\n\t\t\t\tyou're launching, then you can use either the full ARN or name of the parameter.\n\t\t\t\tIf the parameter exists in a different Region, then the full ARN must be\n\t\t\t\tspecified.
\nThe secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.
\nFor information about the require Identity and Access Management permissions, see Required\n\t\t\t\tIAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM\n\t\t\t\tpermissions for Amazon ECS secrets (for Systems Manager Parameter store) in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
\nIf the SSM Parameter Store parameter exists in the same Region as the task you're launching,\n\t\t\t\tthen you can use either the full ARN or name of the parameter. If the parameter exists in a\n\t\t\t\tdifferent Region, then the full ARN must be specified.
\nAn object representing the secret to expose to your container. Secrets can be exposed\n\t\t\tto a container in the following ways:
\nTo inject sensitive data into your containers as environment variables, use\n\t\t\t\t\tthe secrets container definition parameter.
To reference sensitive information in the log configuration of a container,\n\t\t\t\t\tuse the secretOptions container definition parameter.
For more information, see Specifying\n\t\t\t\tsensitive data in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "An object representing the secret to expose to your container. Secrets can be exposed to a container\n\t\t\tin the following ways:
\nTo inject sensitive data into your containers as environment variables, use the\n\t\t\t\t\t\tsecrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the\n\t\t\t\t\t\tsecretOptions container definition parameter.
For more information, see Specifying sensitive\n\t\t\t\tdata in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#SecretList": { @@ -10127,13 +10139,13 @@ "serviceArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The ARN that identifies the service. For more information about the ARN format,\n\t\t\tsee Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
" + "smithy.api#documentation": "The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN)\n\t\t\tin the Amazon ECS Developer Guide.
" } }, "serviceName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within\n\t\t\ta cluster. However, you can have similarly named services in multiple clusters within a\n\t\t\tRegion or across multiple Regions.
" + "smithy.api#documentation": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster.\n\t\t\tHowever, you can have similarly named services in multiple clusters within a Region or across multiple\n\t\t\tRegions.
" } }, "clusterArn": { @@ -10145,26 +10157,26 @@ "loadBalancers": { "target": "com.amazonaws.ecs#LoadBalancers", "traits": { - "smithy.api#documentation": "A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the\n\t\t\tcontainer name, and the container port to access from the load balancer. The container\n\t\t\tname is as it appears in a container definition.
" + "smithy.api#documentation": "A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and\n\t\t\tthe container port to access from the load balancer. The container name is as it appears in a container\n\t\t\tdefinition.
" } }, "serviceRegistries": { "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { - "smithy.api#documentation": "The details for the service discovery registries to assign to this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.
" + "smithy.api#documentation": "The details for the service discovery registries to assign to this service. For more information, see\n\t\t\t\tService\n\t\t\t\tDiscovery.
" } }, "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The status of the service. The valid values are ACTIVE,\n\t\t\t\tDRAINING, or INACTIVE.
The status of the service. The valid values are ACTIVE, DRAINING, or\n\t\t\t\tINACTIVE.
The desired number of instantiations of the task definition to keep running on the\n\t\t\tservice. This value is specified when the service is created with CreateService , and it can be modified with UpdateService.
" + "smithy.api#documentation": "The desired number of instantiations of the task definition to keep running on the service. This\n\t\t\tvalue is specified when the service is created with CreateService , and it can be\n\t\t\tmodified with UpdateService.
" } }, "runningCount": { @@ -10184,43 +10196,43 @@ "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "The launch type the service is using. When using the DescribeServices API, this field\n\t\t\tis omitted if the service was created using a capacity provider strategy.
" + "smithy.api#documentation": "The launch type the service is using. When using the DescribeServices API, this field is omitted if\n\t\t\tthe service was created using a capacity provider strategy.
" } }, "capacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "The capacity provider strategy the service uses. When using DescribeServices,\n\t\t\tthis field is omitted if the service was created using a launch type.
The capacity provider strategy the service uses. When using the DescribeServices API, this field is\n\t\t\tomitted if the service was created using a launch type.
" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The platform version to run your service on. A platform version is only specified for\n\t\t\ttasks that are hosted on Fargate. If one isn't specified, the LATEST\n\t\t\tplatform version is used. For more information, see Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
The platform version to run your service on. A platform version is only specified for tasks that are\n\t\t\thosted on Fargate. If one isn't specified, the LATEST platform version is used. For more\n\t\t\tinformation, see Fargate Platform Versions in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
The operating system that your tasks in the service run on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.
\n All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service (for example,\n\t\t\tLINUX).
The operating system that your tasks in the service run on. A platform family is specified only for\n\t\t\ttasks using the Fargate launch type.
\n All tasks that run as part of this service must use the same platformFamily value as\n\t\t\tthe service (for example, LINUX).
The task definition to use for tasks in the service. This value is specified when the\n\t\t\tservice is created with CreateService, and it can be modified with\n\t\t\tUpdateService.
" + "smithy.api#documentation": "The task definition to use for tasks in the service. This value is specified when the service is\n\t\t\tcreated with CreateService, and it can be modified with UpdateService.
" } }, "deploymentConfiguration": { "target": "com.amazonaws.ecs#DeploymentConfiguration", "traits": { - "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.
" + "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment and the ordering\n\t\t\tof stopping and starting tasks.
" } }, "taskSets": { "target": "com.amazonaws.ecs#TaskSets", "traits": { - "smithy.api#documentation": "Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL\n\t\t\tdeployment. An Amazon ECS task set includes details such as the desired number of tasks, how\n\t\t\tmany tasks are running, and whether the task set serves production traffic.
Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An\n\t\t\tAmazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and\n\t\t\twhether the task set serves production traffic.
The ARN of the IAM role that's associated with the service. It allows the Amazon ECS\n\t\t\tcontainer agent to register container instances with an Elastic Load Balancing load balancer.
" + "smithy.api#documentation": "The ARN of the IAM role that's associated with the service. It allows the Amazon ECS container agent\n\t\t\tto register container instances with an Elastic Load Balancing load balancer.
" } }, "events": { "target": "com.amazonaws.ecs#ServiceEvents", "traits": { - "smithy.api#documentation": "The event stream for your service. A maximum of 100 of the latest events are\n\t\t\tdisplayed.
" + "smithy.api#documentation": "The event stream for your service. A maximum of 100 of the latest events are displayed.
" } }, "createdAt": { @@ -10268,13 +10280,13 @@ "healthCheckGracePeriodSeconds": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing target health checks after a task has first started.
" + "smithy.api#documentation": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target\n\t\t\thealth checks after a task has first started.
" } }, "schedulingStrategy": { "target": "com.amazonaws.ecs#SchedulingStrategy", "traits": { - "smithy.api#documentation": "The scheduling strategy to use for the service. For more information, see Services.
\nThere are two service scheduler strategies available.
\n\n REPLICA-The replica scheduling strategy places and\n\t\t\t\t\tmaintains the desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement\n\t\t\t\t\tdecisions.
\n DAEMON-The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance. This task meets all of the task\n\t\t\t\t\tplacement constraints that you specify in your cluster. The service scheduler\n\t\t\t\t\talso evaluates the task placement constraints for running tasks. It stop tasks\n\t\t\t\t\tthat don't meet the placement constraints.
Fargate tasks don't support the DAEMON\n\t\t\t\t\t\tscheduling strategy.
The scheduling strategy to use for the service. For more information, see Services.
\nThere are two service scheduler strategies available.
\n\n REPLICA-The replica scheduling strategy places and maintains the desired\n\t\t\t\t\tnumber of tasks across your cluster. By default, the service scheduler spreads tasks across\n\t\t\t\t\tAvailability Zones. You can use task placement strategies and constraints to customize task\n\t\t\t\t\tplacement decisions.
\n DAEMON-The daemon scheduling strategy deploys exactly one task on each\n\t\t\t\t\tactive container instance. This task meets all of the task placement constraints that you\n\t\t\t\t\tspecify in your cluster. The service scheduler also evaluates the task placement constraints\n\t\t\t\t\tfor running tasks. It stop tasks that don't meet the placement constraints.
Fargate tasks don't support the DAEMON scheduling\n\t\t\t\t\t\tstrategy.
The metadata that you apply to the service to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value. You define both the key and value.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the service to help you categorize and organize them. Each tag\n\t\t\tconsists of a key and an optional value. You define bot the key and value.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Determines whether to use Amazon ECS managed tags for the tasks in the service. For more\n\t\t\tinformation, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see\n\t\t\t\tTagging Your\n\t\t\t\tAmazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
" } }, "propagateTags": { "target": "com.amazonaws.ecs#PropagateTags", "traits": { - "smithy.api#documentation": "Determines whether to propagate the tags from the task definition or the service to\n\t\t\tthe task. If no value is specified, the tags aren't propagated.
" + "smithy.api#documentation": "Determines whether to propagate the tags from the task definition or the service to the task. If no\n\t\t\tvalue is specified, the tags aren't propagated.
" } }, "enableExecuteCommand": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Determines whether the execute command functionality is turned on for the service. If\n\t\t\t\ttrue, the execute command functionality is turned on for all containers\n\t\t\tin tasks as part of the service.
Determines whether the execute command functionality is turned on for the service. If\n\t\t\t\ttrue, the execute command functionality is turned on for all containers in tasks as\n\t\t\tpart of the service.
The listening port number for the Service Connect proxy. This port is available\n\t\t\tinside of all of the tasks within the same namespace.
\nTo avoid changing your applications in client Amazon ECS services, set this to the same\n\t\t\tport that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
", + "smithy.api#documentation": "The listening port number for the Service Connect proxy. This port is available inside of all of the\n\t\t\ttasks within the same namespace.
\nTo avoid changing your applications in client Amazon ECS services, set this to the same port that the\n\t\t\tclient application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
", "smithy.api#required": {} } }, "dnsName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The dnsName is the name that you use in the applications of client tasks\n\t\t\tto connect to this service. The name must be a valid DNS name but doesn't need to be\n\t\t\tfully-qualified. The name can include up to 127 characters. The name can include\n\t\t\tlowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name\n\t\t\tcan't start with a hyphen.
If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
To avoid changing your applications in client Amazon ECS services, set this to the same\n\t\t\tname that the client application uses by default. For example, a few common names are\n\t\t\t\tdatabase, db, or the lowercase name of a database, such as\n\t\t\t\tmysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
The dnsName is the name that you use in the applications of client tasks to connect to\n\t\t\tthis service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can\n\t\t\tinclude up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens\n\t\t\t(-), and periods (.). The name can't start with a hyphen.
If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.
To avoid changing your applications in client Amazon ECS services, set this to the same name that the\n\t\t\tclient application uses by default. For example, a few common names are database,\n\t\t\t\tdb, or the lowercase name of a database, such as mysql or\n\t\t\t\tredis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
Each alias (\"endpoint\") is a fully-qualified name and port number that other tasks\n\t\t\t(\"clients\") can use to connect to this service.
\nEach name and port mapping must be unique within the namespace.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Each alias (\"endpoint\") is a fully-qualified name and port number that other tasks (\"clients\") can\n\t\t\tuse to connect to this service.
\nEach name and port mapping must be unique within the namespace.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#ServiceConnectClientAliasList": { @@ -10361,13 +10373,13 @@ "namespace": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in\n\t\t\tthe same Amazon Web Services Region as the Amazon ECS service and cluster. The type of namespace doesn't\n\t\t\taffect Service Connect. For more information about Cloud Map, see Working\n\t\t\t\twith Services in the Cloud Map Developer Guide.
" + "smithy.api#documentation": "The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Web Services\n\t\t\tRegion as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For\n\t\t\tmore information about Cloud Map, see Working with Services in the\n\t\t\tCloud Map Developer Guide.
" } }, "services": { "target": "com.amazonaws.ecs#ServiceConnectServiceList", "traits": { - "smithy.api#documentation": "The list of Service Connect service objects. These are names and aliases (also known\n\t\t\tas endpoints) that are used by other Amazon ECS services to connect to this service.\n\t\t\t
\nThis field is not required for a \"client\" Amazon ECS service that's a member of a namespace\n\t\t\tonly to connect to other services within the namespace. An example of this would be a\n\t\t\tfrontend application that accepts incoming requests from either a load balancer that's\n\t\t\tattached to the service or by other means.
\nAn object selects a port from the task definition, assigns a name for the Cloud Map\n\t\t\tservice, and a list of aliases (endpoints) and ports for client applications to refer to\n\t\t\tthis service.
" + "smithy.api#documentation": "The list of Service Connect service objects. These are names and aliases (also known as endpoints)\n\t\t\tthat are used by other Amazon ECS services to connect to this service.
\nThis field is not required for a \"client\" Amazon ECS service that's a member of a namespace only to\n\t\t\tconnect to other services within the namespace. An example of this would be a frontend application that\n\t\t\taccepts incoming requests from either a load balancer that's attached to the service or by other\n\t\t\tmeans.
\nAn object selects a port from the task definition, assigns a name for the Cloud Map service, and a\n\t\t\tlist of aliases (endpoints) and ports for client applications to refer to this service.
" } }, "logConfiguration": { @@ -10375,7 +10387,7 @@ } }, "traits": { - "smithy.api#documentation": "The Service Connect configuration of your Amazon ECS service. The configuration for this\n\t\t\tservice to discover and connect to services, and be discovered by, and connected from,\n\t\t\tother services within a namespace.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The Service Connect configuration of your Amazon ECS service. The configuration for this service to\n\t\t\tdiscover and connect to services, and be discovered by, and connected from, other services within a\n\t\t\tnamespace.
\nTasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#ServiceConnectService": { @@ -10384,7 +10396,7 @@ "portName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The portName must match the name of one of the portMappings\n\t\t\tfrom all the containers in the task definition of this Amazon ECS service.
The portName must match the name of one of the portMappings from all the\n\t\t\tcontainers in the task definition of this Amazon ECS service.
The list of client aliases for this Service Connect service. You use these to assign\n\t\t\tnames that can be used by client applications. The maximum number of client aliases that\n\t\t\tyou can have in this list is 1.
\nEach alias (\"endpoint\") is a fully-qualified name and port number that other Amazon ECS\n\t\t\ttasks (\"clients\") can use to connect to this service.
\nEach name and port mapping must be unique within the namespace.
\nFor each ServiceConnectService, you must provide at least one\n\t\t\t\tclientAlias with one port.
The list of client aliases for this Service Connect service. You use these to assign names that can\n\t\t\tbe used by client applications. The maximum number of client aliases that you can have in this list is\n\t\t\t1.
\nEach alias (\"endpoint\") is a fully-qualified name and port number that other Amazon ECS tasks (\"clients\")\n\t\t\tcan use to connect to this service.
\nEach name and port mapping must be unique within the namespace.
\nFor each ServiceConnectService, you must provide at least one clientAlias\n\t\t\twith one port.
The port number for the Service Connect proxy to listen on.
\nUse the value of this field to bypass the proxy for traffic on the port number\n\t\t\tspecified in the named portMapping in the task definition of this\n\t\t\tapplication, and then use it in your VPC security groups to allow traffic into the proxy\n\t\t\tfor this Amazon ECS service.
In awsvpc mode and Fargate, the default value is the container port\n\t\t\tnumber. The container port number is in the portMapping in the task\n\t\t\tdefinition. In bridge mode, the default value is the ephemeral port of the\n\t\t\tService Connect proxy.
The port number for the Service Connect proxy to listen on.
\nUse the value of this field to bypass the proxy for traffic on the port number specified in the named\n\t\t\t\tportMapping in the task definition of this application, and then use it in your VPC\n\t\t\tsecurity groups to allow traffic into the proxy for this Amazon ECS service.
In awsvpc mode and Fargate, the default value is the container port number. The\n\t\t\tcontainer port number is in the portMapping in the task definition. In bridge mode, the\n\t\t\tdefault value is the ephemeral port of the Service Connect proxy.
A reference to an object that represents the configured timeouts for\n\t\t\tService Connect.
" + "smithy.api#documentation": "A reference to an object that represents the configured timeouts for Service Connect.
" } }, "tls": { "target": "com.amazonaws.ecs#ServiceConnectTlsConfiguration", "traits": { - "smithy.api#documentation": "A reference to an object that represents a Transport Layer Security (TLS)\n\t\t\tconfiguration.
" + "smithy.api#documentation": "A reference to an object that represents a Transport Layer Security (TLS) configuration.
" } } }, @@ -10441,12 +10453,12 @@ "discoveryArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this\n\t\t\tService Connect resource. You can use this ARN in other integrations with Cloud Map.\n\t\t\tHowever, Service Connect can't ensure connectivity outside of Amazon ECS.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the discovery name for this\n\t\t\tService Connect resource. You can use this ARN in other integrations with Cloud Map. However,\n\t\t\tService Connect can't ensure connectivity outside of Amazon ECS.
" } } }, "traits": { - "smithy.api#documentation": "The Service Connect resource. Each configuration maps a discovery name to a\n\t\t\tCloud Map service name. The data is stored in Cloud Map as part of the\n\t\t\tService Connect configuration for each discovery name of this Amazon ECS service.
\nA task can resolve the dnsName for each of the clientAliases\n\t\t\tof a service. However a task can't resolve the discovery names. If you want to connect\n\t\t\tto a service, refer to the ServiceConnectConfiguration of that service for\n\t\t\tthe list of clientAliases that you can use.
The Service Connect resource. Each configuration maps a discovery name to a Cloud Map service name.\n\t\t\tThe data is stored in Cloud Map as part of the Service Connect configuration for each discovery name\n\t\t\tof this Amazon ECS service.
\nA task can resolve the dnsName for each of the clientAliases of a service.\n\t\t\tHowever a task can't resolve the discovery names. If you want to connect to a service, refer to the\n\t\t\t\tServiceConnectConfiguration of that service for the list of clientAliases\n\t\t\tthat you can use.
Information about the circuit breaker used to determine when a service deployment has\n\t\t\tfailed.
\nThe deployment circuit breaker is the rolling update mechanism that determines if the\n\t\t\ttasks reach a steady state. The deployment circuit breaker has an option that will\n\t\t\tautomatically roll back a failed deployment to the last cpompleted service\n\t\t\trevision. For more information, see How the Amazon ECS\n\t\t\tdeployment circuit breaker detects failures in the Amazon ECS Developer\n\t\t\t\tGuide.
" + "smithy.api#documentation": "Information about the circuit breaker used to determine when a service deployment has\n\t\t\tfailed.
\nThe deployment circuit breaker is the rolling update mechanism that determines if the\n\t\t\ttasks reach a steady state. The deployment circuit breaker has an option that will\n\t\t\tautomatically roll back a failed deployment to the last cpompleted service\n\t\t\trevision. For more information, see How the Amazon ECS\n\t\t\t\tdeployment circuit breaker detects failures in the Amazon ECS Developer\n\t\t\t\t\tGuide.
" } }, "com.amazonaws.ecs#ServiceDeploymentRollbackMonitorsStatus": { @@ -10868,55 +10880,55 @@ "encrypted": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "Indicates whether the volume should be encrypted. If no value is specified, encryption\n\t\t\tis turned on by default. This parameter maps 1:1 with the Encrypted\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on\n\t\t\tby default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume\n\t\t\t\tAPI in the Amazon EC2 API Reference.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When\n\t\t\tencryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key\n\t\t\tfor Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an\n\t\t\t\tID, alias, or ARN that is invalid, the action can appear to complete, but\n\t\t\t\teventually fails.
\nThe Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned\n\t\t\ton and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This\n\t\t\tparameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the\n\t\t\t\tAmazon EC2 API Reference.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or\n\t\t\t\tARN that is invalid, the action can appear to complete, but eventually fails.
\nThe volume type. This parameter maps 1:1 with the VolumeType parameter of\n\t\t\tthe CreateVolume API in the Amazon EC2 API Reference. For more\n\t\t\tinformation, see Amazon EBS volume types in\n\t\t\tthe Amazon EC2 User Guide.
The following are the supported volume types.
\nGeneral Purpose SSD: gp2|gp3\n
Provisioned IOPS SSD: io1|io2\n
Throughput Optimized HDD: st1\n
Cold HDD: sc1\n
Magnetic: standard\n
The magnetic volume type is not supported on Fargate.
\nThe volume type. This parameter maps 1:1 with the VolumeType parameter of the CreateVolume\n\t\t\t\tAPI in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types\n\t\t\tin the Amazon EC2 User Guide.
The following are the supported volume types.
\nGeneral Purpose SSD: gp2|gp3\n
Provisioned IOPS SSD: io1|io2\n
Throughput Optimized HDD: st1\n
Cold HDD: sc1\n
Magnetic: standard\n
The magnetic volume type is not supported on Fargate.
\nThe size of the volume in GiB. You must specify either a volume size or a snapshot ID.\n\t\t\tIf you specify a snapshot ID, the snapshot size is used for the volume size by default.\n\t\t\tYou can optionally specify a volume size greater than or equal to the snapshot size.\n\t\t\tThis parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.
The following are the supported volume size values for each volume type.
\n\n gp2 and gp3: 1-16,384
\n io1 and io2: 4-16,384
\n st1 and sc1: 125-16,384
\n standard: 1-1,024
The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify\n\t\t\ta snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a\n\t\t\tvolume size greater than or equal to the snapshot size. This parameter maps 1:1 with the\n\t\t\t\tSize parameter of the CreateVolume API in the\n\t\t\t\tAmazon EC2 API Reference.
The following are the supported volume size values for each volume type.
\n\n gp2 and gp3: 1-16,384
\n io1 and io2: 4-16,384
\n st1 and sc1: 125-16,384
\n standard: 1-1,024
The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot\n\t\t\tID or a volume size. This parameter maps 1:1 with the SnapshotId parameter\n\t\t\tof the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume\n\t\t\tsize. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume\n\t\t\t\tAPI in the Amazon EC2 API Reference.
The number of I/O operations per second (IOPS). For gp3,\n\t\t\tio1, and io2 volumes, this represents the number of IOPS that\n\t\t\tare provisioned for the volume. For gp2 volumes, this represents the\n\t\t\tbaseline performance of the volume and the rate at which the volume accumulates I/O\n\t\t\tcredits for bursting.
The following are the supported values for each volume type.
\n\n gp3: 3,000 - 16,000 IOPS
\n io1: 100 - 64,000 IOPS
\n io2: 100 - 256,000 IOPS
This parameter is required for io1 and io2 volume types. The\n\t\t\tdefault for gp3 volumes is 3,000 IOPS. This parameter is not\n\t\t\tsupported for st1, sc1, or standard volume\n\t\t\ttypes.
This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.
The number of I/O operations per second (IOPS). For gp3, io1, and\n\t\t\t\tio2 volumes, this represents the number of IOPS that are provisioned for the volume.\n\t\t\tFor gp2 volumes, this represents the baseline performance of the volume and the rate at\n\t\t\twhich the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type.
\n\n gp3: 3,000 - 16,000 IOPS
\n io1: 100 - 64,000 IOPS
\n io2: 100 - 256,000 IOPS
This parameter is required for io1 and io2 volume types. The default for\n\t\t\t\tgp3 volumes is 3,000 IOPS. This parameter is not supported for\n\t\t\t\tst1, sc1, or standard volume types.
This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the\n\t\t\t\tAmazon EC2 API Reference.
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.\n\t\t\tThis parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.
This parameter is only supported for the gp3 volume type.
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter\n\t\t\tmaps 1:1 with the Throughput parameter of the CreateVolume API in the\n\t\t\t\tAmazon EC2 API Reference.
This parameter is only supported for the gp3 volume type.
The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This\n\t\t\tparameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.
The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps\n\t\t\t1:1 with the TagSpecifications.N parameter of the CreateVolume API in the\n\t\t\t\tAmazon EC2 API Reference.
The ARN of the IAM role to associate with this volume. This is the Amazon ECS\n\t\t\tinfrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend\n\t\t\tusing the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM\n\t\t\tpolicy with this role. For more information, see Amazon ECS\n\t\t\t\tinfrastructure IAM role in the Amazon ECS Developer\n\t\t\tGuide.
The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role\n\t\t\tthat is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed\n\t\t\t\tAmazonECSInfrastructureRolePolicyForVolumes IAM policy with this role. For more\n\t\t\tinformation, see Amazon ECS infrastructure IAM\n\t\t\t\trole in the Amazon ECS Developer Guide.
The specified service isn't active. You can't update a service that's inactive. If you\n\t\t\thave previously deleted a service, you can re-create it with CreateService.
", + "smithy.api#documentation": "The specified service isn't active. You can't update a service that's inactive. If you have\n\t\t\tpreviously deleted a service, you can re-create it with CreateService.
", "smithy.api#error": "client" } }, @@ -10957,7 +10969,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region\n\t\t\tspecific.
", + "smithy.api#documentation": "The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
", "smithy.api#error": "client" } }, @@ -10973,30 +10985,30 @@ "registryArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is\n\t\t\tCloud Map. For more information, see CreateService.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Cloud Map. For more\n\t\t\tinformation, see CreateService.
" } }, "port": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The port value used if your service discovery service specified an SRV record. This\n\t\t\tfield might be used if both the awsvpc network mode and SRV records are\n\t\t\tused.
The port value used if your service discovery service specified an SRV record. This field might be\n\t\t\tused if both the awsvpc network mode and SRV records are used.
The container name value to be used for your service discovery service. It's already\n\t\t\tspecified in the task definition. If the task definition that your service task\n\t\t\tspecifies uses the bridge or host network mode, you must\n\t\t\tspecify a containerName and containerPort combination from the\n\t\t\ttask definition. If the task definition that your service task specifies uses the\n\t\t\t\tawsvpc network mode and a type SRV DNS record is used, you must specify\n\t\t\teither a containerName and containerPort combination or a\n\t\t\t\tport value. However, you can't specify both.
The container name value to be used for your service discovery service. It's already specified in the\n\t\t\ttask definition. If the task definition that your service task specifies uses the bridge\n\t\t\tor host network mode, you must specify a containerName and\n\t\t\t\tcontainerPort combination from the task definition. If the task definition that your\n\t\t\tservice task specifies uses the awsvpc network mode and a type SRV DNS record is used, you\n\t\t\tmust specify either a containerName and containerPort combination or a\n\t\t\t\tport value. However, you can't specify both.
The port value to be used for your service discovery service. It's already specified\n\t\t\tin the task definition. If the task definition your service task specifies uses the\n\t\t\t\tbridge or host network mode, you must specify a\n\t\t\t\tcontainerName and containerPort combination from the task\n\t\t\tdefinition. If the task definition your service task specifies uses the\n\t\t\t\tawsvpc network mode and a type SRV DNS record is used, you must specify\n\t\t\teither a containerName and containerPort combination or a\n\t\t\t\tport value. However, you can't specify both.
The port value to be used for your service discovery service. It's already specified in the task\n\t\t\tdefinition. If the task definition your service task specifies uses the bridge or\n\t\t\t\thost network mode, you must specify a containerName and\n\t\t\t\tcontainerPort combination from the task definition. If the task definition your\n\t\t\tservice task specifies uses the awsvpc network mode and a type SRV DNS record is used, you\n\t\t\tmust specify either a containerName and containerPort combination or a\n\t\t\t\tport value. However, you can't specify both.
The details for the service registry.
\nEach service may be associated with one service registry. Multiple service registries\n\t\t\tfor each service are not supported.
\nWhen you add, update, or remove the service registries configuration, Amazon ECS starts a\n\t\t\tnew deployment. New tasks are registered and deregistered to the updated service\n\t\t\tregistry configuration.
" + "smithy.api#documentation": "The details for the service registry.
\nEach service may be associated with one service registry. Multiple service registries for each\n\t\t\tservice are not supported.
\nWhen you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment.\n\t\t\tNew tasks are registered and deregistered to the updated service registry configuration.
" } }, "com.amazonaws.ecs#ServiceRevision": { @@ -11095,6 +11107,12 @@ "traits": { "smithy.api#documentation": "The time that the service revision was created. The format is yyyy-mm-dd HH:mm:ss.SSSSS.
" } + }, + "vpcLatticeConfigurations": { + "target": "com.amazonaws.ecs#VpcLatticeConfigurations", + "traits": { + "smithy.api#documentation": "The VPC Lattice configuration for the service revision.
" + } } }, "traits": { @@ -11154,19 +11172,19 @@ "name": { "target": "com.amazonaws.ecs#ECSVolumeName", "traits": { - "smithy.api#documentation": "The name of the volume. This value must match the volume name from the\n\t\t\t\tVolume object in the task definition.
The name of the volume. This value must match the volume name from the Volume object in\n\t\t\tthe task definition.
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.\n\t\t\tThese settings are used to create each Amazon EBS volume, with one volume created for each\n\t\t\ttask in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console\n\t\t\tonce they are created.
" + "smithy.api#documentation": "The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings\n\t\t\tare used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS\n\t\t\tvolumes are visible in your account in the Amazon EC2 console once they are created.
" } } }, "traits": { - "smithy.api#documentation": "The configuration for a volume specified in the task definition as a volume that is\n\t\t\tconfigured at launch time. Currently, the only supported volume type is an Amazon EBS\n\t\t\tvolume.
" + "smithy.api#documentation": "The configuration for a volume specified in the task definition as a volume that is configured at\n\t\t\tlaunch time. Currently, the only supported volume type is an Amazon EBS volume.
" } }, "com.amazonaws.ecs#ServiceVolumeConfigurations": { @@ -11193,13 +11211,13 @@ "streamUrl": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "A URL to the managed agent on the container that the SSM Session Manager client uses\n\t\t\tto send commands and receive output from the container.
" + "smithy.api#documentation": "A URL to the managed agent on the container that the SSM Session Manager client uses to send commands\n\t\t\tand receive output from the container.
" } }, "tokenValue": { "target": "com.amazonaws.ecs#SensitiveString", "traits": { - "smithy.api#documentation": "An encrypted token value containing session and caller information. It's used to\n\t\t\tauthenticate the connection to the container.
" + "smithy.api#documentation": "An encrypted token value containing session and caller information. It's used to authenticate the\n\t\t\tconnection to the container.
" } } }, @@ -11225,13 +11243,13 @@ "principalArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The ARN of the principal. It can be a user, role, or the root user. If this field is\n\t\t\tomitted, the authenticated user is assumed.
" + "smithy.api#documentation": "The ARN of the principal. It can be a user, role, or the root user. If this field is omitted, the\n\t\t\tauthenticated user is assumed.
" } }, "type": { "target": "com.amazonaws.ecs#SettingType", "traits": { - "smithy.api#documentation": "Indicates whether Amazon Web Services manages the account setting, or if the user manages it.
\n\n aws_managed account settings are read-only, as Amazon Web Services manages such on the\n\t\t\tcustomer's behalf. Currently, the guardDutyActivate account setting is the\n\t\t\tonly one Amazon Web Services manages.
Indicates whether Amazon Web Services manages the account setting, or if the user manages it.
\n\n aws_managed account settings are read-only, as Amazon Web Services manages such on the customer's\n\t\t\tbehalf. Currently, the guardDutyActivate account setting is the only one Amazon Web Services\n\t\t\tmanages.
Starts a new task from the specified task definition on the specified container\n\t\t\tinstance or instances.
\nOn 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.
\nAmazon Elastic Inference (EI) is no longer available to customers.
\nAlternatively, you can useRunTask to place tasks for you. For more\n\t\t\tinformation, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Starts a new task from the specified task definition on the specified container instance or\n\t\t\tinstances.
\nOn 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.
\nAmazon Elastic Inference (EI) is no longer available to customers.
\nAlternatively, you can useRunTask to place tasks for you. For more information, see\n\t\t\t\tScheduling\n\t\t\t\tTasks in the Amazon Elastic Container Service Developer Guide.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a\n\t\t\tservice. For more infomation, see Amazon EBS\n\t\t\t\tvolumes in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#StartTaskRequest": { @@ -11396,7 +11414,7 @@ "containerInstances": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "The container instance IDs or full ARN entries for the container instances where you\n\t\t\twould like to place your task. You can specify up to 10 container instances.
", + "smithy.api#documentation": "The container instance IDs or full ARN entries for the container instances where you would like to\n\t\t\tplace your task. You can specify up to 10 container instances.
", "smithy.api#required": {} } }, @@ -11404,20 +11422,20 @@ "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether to use Amazon ECS managed tags for the task. For more information, see\n\t\t\t\tTagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" } }, "enableExecuteCommand": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Whether or not the execute command functionality is turned on for the task. If\n\t\t\t\ttrue, this turns on the execute command functionality on all containers\n\t\t\tin the task.
Whether or not the execute command functionality is turned on for the task. If true,\n\t\t\tthis turns on the execute command functionality on all containers in the task.
The name of the task group to associate with the task. The default value is the family\n\t\t\tname of the task definition (for example, family:my-family-name).
" + "smithy.api#documentation": "The name of the task group to associate with the task. The default value is the family name of the\n\t\t\ttask definition (for example, family:my-family-name).
" } }, "networkConfiguration": { @@ -11429,13 +11447,13 @@ "overrides": { "target": "com.amazonaws.ecs#TaskOverride", "traits": { - "smithy.api#documentation": "A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it receives. You can override the\n\t\t\tdefault command for a container (that's specified in the task definition or Docker\n\t\t\timage) with a command override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\t\tformatting characters of the override structure.
\nA list of container overrides in JSON format that specify the name of a container in the specified\n\t\t\ttask definition and the overrides it receives. You can override the default command for a container\n\t\t\t(that's specified in the task definition or Docker image) with a command override. You can\n\t\t\talso override existing environment variables (that are specified in the task definition or Docker\n\t\t\timage) on a container or add new environment variables to it with an environment\n\t\t\toverride.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting\n\t\t\t\tcharacters of the override structure.
\nSpecifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttask. If no value is specified, the tags aren't propagated.
" + "smithy.api#documentation": "Specifies whether to propagate the tags from the task definition or the service to the task. If no\n\t\t\tvalue is specified, the tags aren't propagated.
" } }, "referenceId": { @@ -11453,20 +11471,20 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the task to help you categorize and organize them. Each tag consists\n\t\t\tof a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to start. If a revision isn't specified,\n\t\t\tthe latest ACTIVE revision is used.
The family and revision (family:revision) or full ARN of the\n\t\t\ttask definition to start. If a revision isn't specified, the latest ACTIVE\n\t\t\trevision is used.
The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tthe size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name of the volume must\n\t\t\tmatch the name from the task definition.
The details of the volume that was configuredAtLaunch. You can configure the size,\n\t\t\tvolumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name of the volume must match the\n\t\t\t\tname from the task definition.
A full description of the tasks that were started. Each task that was successfully\n\t\t\tplaced on your container instances is described.
" + "smithy.api#documentation": "A full description of the tasks that were started. Each task that was successfully placed on your\n\t\t\tcontainer instances is described.
" } }, "failures": { @@ -11523,7 +11541,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops a running task. Any tags associated with the task will be deleted.
\nWhen you call StopTask on a task, the equivalent of docker\n\t\t\t\tstop is issued to the containers running in the task. This results in a\n\t\t\t\tSIGTERM value and a default 30-second timeout, after which the\n\t\t\t\tSIGKILL value is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM value gracefully and exits within 30 seconds\n\t\t\tfrom receiving it, no SIGKILL value is sent.
For Windows containers, POSIX signals do not work and runtime stops the container by\n\t\t\tsending a CTRL_SHUTDOWN_EVENT. For more information, see Unable to react to graceful shutdown\n\t\t\t\tof (Windows) container #25982 on GitHub.
The default 30-second timeout can be configured on the Amazon ECS container agent with\n\t\t\t\tthe ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see\n\t\t\t\t\tAmazon ECS Container Agent Configuration in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
Stops a running task. Any tags associated with the task will be deleted.
\nWhen you call StopTask on a task, the equivalent of docker stop is issued\n\t\t\tto the containers running in the task. This results in a SIGTERM value and a default\n\t\t\t30-second timeout, after which the SIGKILL value is sent and the containers are forcibly\n\t\t\tstopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds\n\t\t\tfrom receiving it, no SIGKILL value is sent.
For Windows containers, POSIX signals do not work and runtime stops the container by sending a\n\t\t\t\tCTRL_SHUTDOWN_EVENT. For more information, see Unable to react to graceful shutdown of (Windows)\n\t\t\t\tcontainer #25982 on GitHub.
The default 30-second timeout can be configured on the Amazon ECS container agent with the\n\t\t\t\t\tECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS\n\t\t\t\t\tContainer Agent Configuration in the Amazon Elastic Container Service Developer Guide.
An optional message specified when a task is stopped. For example, if you're using a\n\t\t\tcustom scheduler, you can use this parameter to specify the reason for stopping the task\n\t\t\there, and the message appears in subsequent DescribeTasks> API\n\t\t\toperations on this task.
" + "smithy.api#documentation": "An optional message specified when a task is stopped. For example, if you're using a custom\n\t\t\tscheduler, you can use this parameter to specify the reason for stopping the task here, and the message\n\t\t\tappears in subsequent DescribeTasks> API operations on\n\t\t\tthis task.
" } } }, @@ -11617,7 +11635,7 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full ARN of the cluster that hosts the container instance the\n\t\t\tattachment belongs to.
" + "smithy.api#documentation": "The short name or full ARN of the cluster that hosts the container instance the attachment belongs\n\t\t\tto.
" } }, "attachments": { @@ -11859,12 +11877,12 @@ "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The namespaced kernel parameter to set a value for.
Valid IPC namespace values: \"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\"\n\t\t\t\t| \"kernel.sem\" | \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" |\n\t\t\t\t\"kernel.shm_rmid_forced\", and Sysctls that start with\n\t\t\t\t\"fs.mqueue.*\"\n
Valid network namespace values: Sysctls that start with\n\t\t\t\t\"net.*\"\n
All of these values are supported by Fargate.
" + "smithy.api#documentation": "The namespaced kernel parameter to set a value for.
Valid IPC namespace values: \"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\" | \"kernel.sem\"\n\t\t\t\t| \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" | \"kernel.shm_rmid_forced\", and\n\t\t\t\tSysctls that start with \"fs.mqueue.*\"\n
Valid network namespace values: Sysctls that start with \"net.*\"\n
All of these values are supported by Fargate.
" } } }, "traits": { - "smithy.api#documentation": "A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\tSysctls in the docker container create command and the --sysctl option to docker run. For example, you can configure\n\t\t\t\tnet.ipv4.tcp_keepalive_time setting to maintain longer lived\n\t\t\tconnections.
We don't recommend that you specify network-related systemControls\n\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\t\tawsvpc or host network mode. Doing this has the following\n\t\t\tdisadvantages:
For tasks that use the awsvpc network mode including Fargate,\n\t\t\t\t\tif you set systemControls for any container, it applies to all\n\t\t\t\t\tcontainers in the task. If you set different systemControls for\n\t\t\t\t\tmultiple containers in a single task, the container that's started last\n\t\t\t\t\tdetermines which systemControls take effect.
For tasks that use the host network mode, the network namespace\n\t\t\t\t\t\tsystemControls aren't supported.
If you're setting an IPC resource namespace to use for the containers in the task, the\n\t\t\tfollowing conditions apply to your system controls. For more information, see IPC mode.
\nFor tasks that use the host IPC mode, IPC namespace\n\t\t\t\t\t\tsystemControls aren't supported.
For tasks that use the task IPC mode, IPC namespace\n\t\t\t\t\t\tsystemControls values apply to all containers within a\n\t\t\t\t\ttask.
This parameter is not supported for Windows containers.
\nThis parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.
A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the docker container create command and the --sysctl option to\n\t\t\tdocker run. For example, you can configure net.ipv4.tcp_keepalive_time setting to maintain\n\t\t\tlonger lived connections.
We don't recommend that you specify network-related systemControls parameters for\n\t\t\tmultiple containers in a single task that also uses either the awsvpc or host\n\t\t\tnetwork mode. Doing this has the following disadvantages:
For tasks that use the awsvpc network mode including Fargate, if you set\n\t\t\t\t\t\tsystemControls for any container, it applies to all containers in the task. If\n\t\t\t\t\tyou set different systemControls for multiple containers in a single task, the\n\t\t\t\t\tcontainer that's started last determines which systemControls take effect.
For tasks that use the host network mode, the network namespace\n\t\t\t\t\t\tsystemControls aren't supported.
If you're setting an IPC resource namespace to use for the containers in the task, the following\n\t\t\tconditions apply to your system controls. For more information, see IPC\n\t\t\t\tmode.
\nFor tasks that use the host IPC mode, IPC namespace systemControls\n\t\t\t\t\taren't supported.
For tasks that use the task IPC mode, IPC namespace systemControls\n\t\t\t\t\tvalues apply to all containers within a task.
This parameter is not supported for Windows containers.
\nThis parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.
One part of a key-value pair that make up a tag. A key is a general label\n\t\t\tthat acts like a category for more specific tag values.
One part of a key-value pair that make up a tag. A key is a general label that acts like\n\t\t\ta category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as\n\t\t\ta descriptor within a tag category (key).
The optional part of a key-value pair that make up a tag. A value acts as a descriptor\n\t\t\twithin a tag category (key).
The metadata that you apply to a resource to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define them.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists\n\t\t\tof a key and an optional value. You define them.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Associates the specified tags to a resource with the specified\n\t\t\t\tresourceArn. If existing tags on a resource aren't specified in the\n\t\t\trequest parameters, they aren't changed. When a resource is deleted, the tags that are\n\t\t\tassociated with that resource are deleted as well.
Associates the specified tags to a resource with the specified resourceArn. If existing\n\t\t\ttags on a resource aren't specified in the request parameters, they aren't changed. When a resource is\n\t\t\tdeleted, the tags that are associated with that resource are deleted as well.
The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are\n\t\t\tAmazon ECS capacity providers, tasks, services, task definitions, clusters, and container\n\t\t\tinstances.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are Amazon ECS capacity\n\t\t\tproviders, tasks, services, task definitions, clusters, and container instances.
", "smithy.api#required": {} } }, @@ -12016,7 +12034,7 @@ } }, "traits": { - "smithy.api#documentation": "The execute command cannot run. This error can be caused by any of the following\n\t\t\tconfiguration issues:
\nIncorrect IAM permissions
\nThe SSM agent is not installed or is not running
\nThere is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for\n\t\t\t\t\tSystems Manager Session Manager
\nFor information about how to troubleshoot the issues, see Troubleshooting issues with ECS\n\t\t\t\tExec in the Amazon Elastic Container Service Developer Guide.
", + "smithy.api#documentation": "The execute command cannot run. This error can be caused by any of the following configuration\n\t\t\tissues:
\nIncorrect IAM permissions
\nThe SSM agent is not installed or is not running
\nThere is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for Systems\n\t\t\t\t\tManager Session Manager
\nFor information about how to troubleshoot the issues, see Troubleshooting issues with ECS Exec in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
", "smithy.api#error": "client" } }, @@ -12031,7 +12049,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified target wasn't found. You can view your available container instances\n\t\t\twith ListContainerInstances. Amazon ECS container instances are cluster-specific and\n\t\t\tRegion-specific.
", + "smithy.api#documentation": "The specified target wasn't found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and\n\t\t\tRegion-specific.
", "smithy.api#error": "client" } }, @@ -12052,7 +12070,7 @@ "attachments": { "target": "com.amazonaws.ecs#Attachments", "traits": { - "smithy.api#documentation": "The Elastic Network Adapter that's associated with the task if the task uses the\n\t\t\t\tawsvpc network mode.
The Elastic Network Adapter that's associated with the task if the task uses the awsvpc\n\t\t\tnetwork mode.
The Unix timestamp for the time when the task last went into CONNECTED\n\t\t\tstatus.
The Unix timestamp for the time when the task last went into CONNECTED status.
The number of CPU units used by the task as expressed in a task definition. It can be\n\t\t\texpressed as an integer using CPU units (for example, 1024). It can also be\n\t\t\texpressed as a string using vCPUs (for example, 1 vCPU or 1\n\t\t\t\tvcpu). String values are converted to an integer that indicates the CPU units\n\t\t\twhen the task definition is registered.
If you use the EC2 launch type, this field is optional. Supported values\n\t\t\tare between 128 CPU units (0.125 vCPUs) and 10240\n\t\t\tCPU units (10 vCPUs).
If you use the Fargate launch type, this field is required. You must use\n\t\t\tone of the following values. These values determine the range of supported values for\n\t\t\tthe memory parameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.
\n256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or\n later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or\n later.
The number of CPU units used by the task as expressed in a task definition. It can be expressed as an\n\t\t\tinteger using CPU units (for example, 1024). It can also be expressed as a string using\n\t\t\tvCPUs (for example, 1 vCPU or 1 vcpu). String values are converted to an\n\t\t\tinteger that indicates the CPU units when the task definition is registered.
If you use the EC2 launch type, this field is optional. Supported values are between\n\t\t\t\t128 CPU units (0.125 vCPUs) and 10240 CPU units\n\t\t\t\t(10 vCPUs).
If you use the Fargate launch type, this field is required. You must use one of the\n\t\t\tfollowing values. These values determine the range of supported values for the memory\n\t\t\tparameter:
The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.
\n256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or\n later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or\n later.
The Unix timestamp for the time when the task was created. More specifically, it's for\n\t\t\tthe time when the task entered the PENDING state.
The Unix timestamp for the time when the task was created. More specifically, it's for the time when\n\t\t\tthe task entered the PENDING state.
The desired status of the task. For more information, see Task\n\t\t\tLifecycle.
" + "smithy.api#documentation": "The desired status of the task. For more information, see Task Lifecycle.
" } }, "enableExecuteCommand": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Determines whether execute command functionality is turned on for this task. If\n\t\t\t\ttrue, execute command functionality is turned on all the containers in\n\t\t\tthe task.
Determines whether execute command functionality is turned on for this task. If true,\n\t\t\texecute command functionality is turned on all the containers in the task.
The health status for the task. It's determined by the health of the essential\n\t\t\tcontainers in the task. If all essential containers in the task are reporting as\n\t\t\t\tHEALTHY, the task status also reports as HEALTHY. If any\n\t\t\tessential containers in the task are reporting as UNHEALTHY or\n\t\t\t\tUNKNOWN, the task status also reports as UNHEALTHY or\n\t\t\t\tUNKNOWN.
The Amazon ECS container agent doesn't monitor or report on Docker health checks that\n\t\t\t\tare embedded in a container image and not specified in the container definition. For\n\t\t\t\texample, this includes those specified in a parent image or from the image's\n\t\t\t\tDockerfile. Health check parameters that are specified in a container definition\n\t\t\t\toverride any Docker health checks that are found in the container image.
\nThe health status for the task. It's determined by the health of the essential containers in the\n\t\t\ttask. If all essential containers in the task are reporting as HEALTHY, the task status\n\t\t\talso reports as HEALTHY. If any essential containers in the task are reporting as\n\t\t\t\tUNHEALTHY or UNKNOWN, the task status also reports as\n\t\t\t\tUNHEALTHY or UNKNOWN.
The Amazon ECS container agent doesn't monitor or report on Docker health checks that are embedded in\n\t\t\t\ta container image and not specified in the container definition. For example, this includes those\n\t\t\t\tspecified in a parent image or from the image's Dockerfile. Health check parameters that are\n\t\t\t\tspecified in a container definition override any Docker health checks that are found in the\n\t\t\t\tcontainer image.
\nThe last known status for the task. For more information, see Task\n\t\t\t\tLifecycle.
" + "smithy.api#documentation": "The last known status for the task. For more information, see Task Lifecycle.
" } }, "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "The infrastructure where your task runs on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The infrastructure where your task runs on. For more information, see Amazon ECS launch\n\t\t\t\ttypes in the Amazon Elastic Container Service Developer Guide.
" } }, "memory": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The amount of memory (in MiB) that the task uses as expressed in a task definition. It\n\t\t\tcan be expressed as an integer using MiB (for example, 1024). If it's\n\t\t\texpressed as a string using GB (for example, 1GB or 1 GB),\n\t\t\tit's converted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.
If you use the EC2 launch type, this field is optional.
\nIf you use the Fargate launch type, this field is required. You must use\n\t\t\tone of the following values. The value that you choose determines the range of supported\n\t\t\tvalues for the cpu parameter.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or\n later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or\n later.
The amount of memory (in MiB) that the task uses as expressed in a task definition. It can be\n\t\t\texpressed as an integer using MiB (for example, 1024). If it's expressed as a string using\n\t\t\tGB (for example, 1GB or 1 GB), it's converted to an integer indicating the\n\t\t\tMiB when the task definition is registered.
If you use the EC2 launch type, this field is optional.
\nIf you use the Fargate launch type, this field is required. You must use one of the\n\t\t\tfollowing values. The value that you choose determines the range of supported values for the\n\t\t\t\tcpu parameter.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or\n later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or\n later.
The platform version where your task runs on. A platform version is only specified for\n\t\t\ttasks that use the Fargate launch type. If you didn't specify one, the\n\t\t\t\tLATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The platform version where your task runs on. A platform version is only specified for tasks that use\n\t\t\tthe Fargate launch type. If you didn't specify one, the LATEST platform\n\t\t\tversion is used. For more information, see Fargate Platform Versions in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
The operating system that your tasks are running on. A platform family is specified\n\t\t\tonly for tasks that use the Fargate launch type.
\n All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service (for example,\n\t\t\tLINUX.).
The operating system that your tasks are running on. A platform family is specified only for tasks\n\t\t\tthat use the Fargate launch type.
\n All tasks that run as part of this service must use the same platformFamily value as\n\t\t\tthe service (for example, LINUX.).
The Unix timestamp for the time when the task started. More specifically, it's for the\n\t\t\ttime when the task transitioned from the PENDING state to the\n\t\t\t\tRUNNING state.
The Unix timestamp for the time when the task started. More specifically, it's for the time when the\n\t\t\ttask transitioned from the PENDING state to the RUNNING state.
The stop code indicating why a task was stopped. The stoppedReason might\n\t\t\tcontain additional details.
For more information about stop code, see Stopped tasks\n\t\t\t\terror codes in the Amazon ECS Developer Guide.
" + "smithy.api#documentation": "The stop code indicating why a task was stopped. The stoppedReason might contain\n\t\t\tadditional details.
For more information about stop code, see Stopped tasks error\n\t\t\t\tcodes in the Amazon ECS Developer Guide.
" } }, "stoppedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the task was stopped. More specifically, it's for\n\t\t\tthe time when the task transitioned from the RUNNING state to the\n\t\t\t\tSTOPPED state.
The Unix timestamp for the time when the task was stopped. More specifically, it's for the time when\n\t\t\tthe task transitioned from the RUNNING state to the STOPPED state.
The Unix timestamp for the time when the task stops. More specifically, it's for the\n\t\t\ttime when the task transitions from the RUNNING state to\n\t\t\t\tSTOPPING.
The Unix timestamp for the time when the task stops. More specifically, it's for the time when the\n\t\t\ttask transitions from the RUNNING state to STOPPING.
The metadata that you apply to the task to help you categorize and organize the task.\n\t\t\tEach tag consists of a key and an optional value. You define both the key and\n\t\t\tvalue.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the task to help you categorize and organize the task. Each tag\n\t\t\tconsists of a key and an optional value. You define both the key and value.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The version counter for the task. Every time a task experiences a change that starts a\n\t\t\tCloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state\n\t\t\twith CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API\n\t\t\tactions with the version reported in CloudWatch Events for the task (inside the\n\t\t\t\tdetail object) to verify that the version in your event stream is\n\t\t\tcurrent.
The version counter for the task. Every time a task experiences a change that starts a CloudWatch event,\n\t\t\tthe version counter is incremented. If you replicate your Amazon ECS task state with CloudWatch Events, you can\n\t\t\tcompare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch\n\t\t\tEvents for the task (inside the detail object) to verify that the version in your event\n\t\t\tstream is current.
A list of container definitions in JSON format that describe the different containers\n\t\t\tthat make up your task. For more information about container definition parameters and\n\t\t\tdefaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "A list of container definitions in JSON format that describe the different containers that make up\n\t\t\tyour task. For more information about container definition parameters and defaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.
" } }, "family": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of a family that this task definition is registered to. Up to 255 characters\n\t\t\tare allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and\n\t\t\tunderscores (_) are allowed.
\nA family groups multiple versions of a task definition. Amazon ECS gives the first task\n\t\t\tdefinition that you registered to a family a revision number of 1. Amazon ECS gives\n\t\t\tsequential revision numbers to each task definition that you add.
" + "smithy.api#documentation": "The name of a family that this task definition is registered to. Up to 255 characters are allowed.\n\t\t\tLetters (both uppercase and lowercase letters), numbers, hyphens (-), and underscores (_) are\n\t\t\tallowed.
\nA family groups multiple versions of a task definition. Amazon ECS gives the first task definition that\n\t\t\tyou registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task\n\t\t\tdefinition that you add.
" } }, "taskRoleArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the\n\t\t\ttask permission to call Amazon Web Services APIs on your behalf. For informationabout the required\n\t\t\tIAM roles for Amazon ECS, see IAM\n\t\t\t\troles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the task permission\n\t\t\tto call Amazon Web Services APIs on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
" } }, "executionRoleArn": { @@ -12314,20 +12332,20 @@ "networkMode": { "target": "com.amazonaws.ecs#NetworkMode", "traits": { - "smithy.api#documentation": "The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. \n For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, awsvpc can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.
When using the host network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
For more information, see Network\n settings in the Docker run reference.
" + "smithy.api#documentation": "The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. \n For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, awsvpc can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.
When using the host network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
The revision of the task in a particular family. The revision is a version number of a\n\t\t\ttask definition in a family. When you register a task definition for the first time, the\n\t\t\trevision is 1. Each time that you register a new revision of a task\n\t\t\tdefinition in the same family, the revision value always increases by one. This is even\n\t\t\tif you deregistered previous revisions in this family.
The revision of the task in a particular family. The revision is a version number of a task\n\t\t\tdefinition in a family. When you register a task definition for the first time, the revision is\n\t\t\t\t1. Each time that you register a new revision of a task definition in the same family,\n\t\t\tthe revision value always increases by one. This is even if you deregistered previous revisions in this\n\t\t\tfamily.
The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.
\nThe host and sourcePath parameters aren't supported for\n\t\t\t\ttasks run on Fargate.
The list of data volume definitions for the task. For more information, see Using data\n\t\t\t\tvolumes in tasks in the Amazon Elastic Container Service Developer Guide.
\nThe host and sourcePath parameters aren't supported for tasks run on\n\t\t\t\tFargate.
The container instance attributes required by your task. When an Amazon EC2 instance is\n\t\t\tregistered to your cluster, the Amazon ECS container agent assigns some standard attributes\n\t\t\tto the instance. You can apply custom attributes. These are specified as key-value pairs\n\t\t\tusing the Amazon ECS console or the PutAttributes API. These attributes are\n\t\t\tused when determining task placement for tasks hosted on Amazon EC2 instances. For more\n\t\t\tinformation, see Attributes in the Amazon Elastic Container Service Developer Guide.
\nThis parameter isn't supported for tasks run on Fargate.
\nThe container instance attributes required by your task. When an Amazon EC2 instance is registered to your\n\t\t\tcluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply\n\t\t\tcustom attributes. These are specified as key-value pairs using the Amazon ECS console or the PutAttributes API. These attributes are used when determining task placement for tasks\n\t\t\thosted on Amazon EC2 instances. For more information, see Attributes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
\nThis parameter isn't supported for tasks run on Fargate.
\nAmazon ECS validates the task definition parameters with those supported by the launch type. For\n\t\t\tmore information, see Amazon ECS launch types\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Amazon ECS validates the task definition parameters with those supported by the launch type. For more\n\t\t\tinformation, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
" } }, "runtimePlatform": { "target": "com.amazonaws.ecs#RuntimePlatform", "traits": { - "smithy.api#documentation": "The operating system that your task definitions are running on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.
\nWhen you specify a task in a service, this value must match the\n\t\t\t\truntimePlatform value of the service.
The operating system that your task definitions are running on. A platform family is specified only\n\t\t\tfor tasks using the Fargate launch type.
\nWhen you specify a task in a service, this value must match the runtimePlatform value of\n\t\t\tthe service.
The task launch types the task definition was validated against. The valid values are\n\t\t\t\tEC2, FARGATE, and EXTERNAL. For more\n\t\t\tinformation, see Amazon ECS launch types\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The task launch types the task definition was validated against. The valid values are\n\t\t\t\tEC2, FARGATE, and EXTERNAL. For more information, see Amazon ECS launch\n\t\t\t\ttypes in the Amazon Elastic Container Service Developer Guide.
The number of cpu units used by the task. If you use the EC2 launch type,\n\t\t\tthis field is optional. Any value can be used. If you use the Fargate launch type, this\n\t\t\tfield is required. You must use one of the following values. The value that you choose\n\t\t\tdetermines your range of valid values for the memory parameter.
If you use the EC2 launch type, this field is optional. Supported values\n\t\t\tare between 128 CPU units (0.125 vCPUs) and 10240\n\t\t\tCPU units (10 vCPUs).
The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.
\n256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or\n later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or\n later.
The number of cpu units used by the task. If you use the EC2 launch type, this field is\n\t\t\toptional. Any value can be used. If you use the Fargate launch type, this field is required. You must\n\t\t\tuse one of the following values. The value that you choose determines your range of valid values for\n\t\t\tthe memory parameter.
If you use the EC2 launch type, this field is optional. Supported values are between\n\t\t\t\t128 CPU units (0.125 vCPUs) and 10240 CPU units\n\t\t\t\t(10 vCPUs).
The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.
\n256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0 or\n later.
16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0 or\n later.
The amount (in MiB) of memory used by the task.
\nIf your tasks runs on Amazon EC2 instances, you must specify either a task-level memory\n\t\t\tvalue or a container-level memory value. This field is optional and any value can be\n\t\t\tused. If a task-level memory value is specified, the container-level memory value is\n\t\t\toptional. For more information regarding container-level memory and memory reservation,\n\t\t\tsee ContainerDefinition.
\nIf your tasks runs on Fargate, this field is required. You must use one of the\n\t\t\tfollowing values. The value you choose determines your range of valid values for the\n\t\t\t\tcpu parameter.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or\n later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or\n later.
The amount (in MiB) of memory used by the task.
\nIf your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a\n\t\t\tcontainer-level memory value. This field is optional and any value can be used. If a task-level memory\n\t\t\tvalue is specified, the container-level memory value is optional. For more information regarding\n\t\t\tcontainer-level memory and memory reservation, see ContainerDefinition.
\nIf your tasks runs on Fargate, this field is required. You must use one of the following values.\n\t\t\tThe value you choose determines your range of valid values for the cpu parameter.
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0 or\n later.
Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0 or\n later.
The process namespace to use for the containers in the task. The valid\n values are host or task. On Fargate for\n Linux containers, the only valid value is task. For\n example, monitoring sidecars might need pidMode to access\n information about other containers running in the same task.
If host is specified, all containers within the tasks\n that specified the host PID mode on the same container\n instance share the same process namespace with the host Amazon EC2\n instance.
If task is specified, all containers within the specified\n task share the same process namespace.
If no value is specified, the\n default is a private namespace for each container. For more information,\n see PID settings in the Docker run\n reference.
\nIf the host PID mode is used, there's a heightened risk\n of undesired process namespace exposure. For more information, see\n Docker security.
This parameter is not supported for Windows containers.
\nThis parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.
The process namespace to use for the containers in the task. The valid\n values are host or task. On Fargate for\n Linux containers, the only valid value is task. For\n example, monitoring sidecars might need pidMode to access\n information about other containers running in the same task.
If host is specified, all containers within the tasks\n that specified the host PID mode on the same container\n instance share the same process namespace with the host Amazon EC2\n instance.
If task is specified, all containers within the specified\n task share the same process namespace.
If no value is specified, the\n default is a private namespace for each container.
\nIf the host PID mode is used, there's a heightened risk\n of undesired process namespace exposure.
This parameter is not supported for Windows containers.
\nThis parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.
The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.
If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.
If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related\n systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related\n systemControls will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks run on Fargate.
\nThe IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance.
If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose.
If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related\n systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related\n systemControls will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks run on Fargate.
\nThe configuration details for the App Mesh proxy.
\nYour Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tand at least version 1.26.0-1 of the ecs-init package to use a proxy\n\t\t\tconfiguration. If your container instances are launched from the Amazon ECS optimized AMI\n\t\t\tversion 20190301 or later, they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The configuration details for the App Mesh proxy.
\nYour Amazon ECS container instances require at least version 1.26.0 of the container agent and at least\n\t\t\tversion 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container\n\t\t\tinstances are launched from the Amazon ECS optimized AMI version 20190301 or later, they\n\t\t\tcontain the required versions of the container agent and ecs-init. For more information,\n\t\t\tsee Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The details of a task definition which describes the container and volume definitions\n\t\t\tof an Amazon Elastic Container Service task. You can specify which Docker images to use, the required\n\t\t\tresources, and other configurations related to launching the task definition through an\n\t\t\tAmazon ECS service or task.
" + "smithy.api#documentation": "The details of a task definition which describes the container and volume definitions of an Amazon Elastic Container Service\n\t\t\ttask. You can specify which Docker images to use, the required resources, and other configurations\n\t\t\trelated to launching the task definition through an Amazon ECS service or task.
" } }, "com.amazonaws.ecs#TaskDefinitionFamilyStatus": { @@ -12483,18 +12501,18 @@ "type": { "target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraintType", "traits": { - "smithy.api#documentation": "The type of constraint. The MemberOf constraint restricts selection to be\n\t\t\tfrom a group of valid candidates.
The type of constraint. The MemberOf constraint restricts selection to be from a group\n\t\t\tof valid candidates.
A cluster query language expression to apply to the constraint. For more information,\n\t\t\tsee Cluster query language in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "A cluster query language expression to apply to the constraint. For more information, see Cluster\n\t\t\t\tquery language in the Amazon Elastic Container Service Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "The constraint on task placement in the task definition. For more information, see\n\t\t\t\tTask placement constraints in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
\nTask placement constraints aren't supported for tasks run on Fargate.
\nThe constraint on task placement in the task definition. For more information, see Task\n\t\t\t\tplacement constraints in the Amazon Elastic Container Service Developer Guide.
\nTask placement constraints aren't supported for tasks run on Fargate.
\nThe total amount, in GiB, of the ephemeral storage to set for the task. The minimum\n\t\t\tsupported value is 20 GiB and the maximum supported value is\u2028\n\t\t\t\t200 GiB.
The total amount, in GiB, of the ephemeral storage to set for the task. The minimum supported value\n\t\t\tis 20 GiB and the maximum supported value is\u2028 200 GiB.
Specify an Amazon Web Services Key Management Service key ID to encrypt the ephemeral storage for the\n\t\t\ttask.
" + "smithy.api#documentation": "Specify an Key Management Service key ID to encrypt the ephemeral storage for the task.
" } } }, @@ -12610,73 +12628,73 @@ "encrypted": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "Indicates whether the volume should be encrypted. If no value is specified, encryption\n\t\t\tis turned on by default. This parameter maps 1:1 with the Encrypted\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on\n\t\t\tby default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume\n\t\t\t\tAPI in the Amazon EC2 API Reference.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When\n\t\t\tencryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key\n\t\t\tfor Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId\n\t\t\tparameter of the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an\n\t\t\t\tID, alias, or ARN that is invalid, the action can appear to complete, but\n\t\t\t\teventually fails.
\nThe Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned\n\t\t\ton and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This\n\t\t\tparameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the\n\t\t\t\tAmazon EC2 API Reference.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or\n\t\t\t\tARN that is invalid, the action can appear to complete, but eventually fails.
\nThe volume type. This parameter maps 1:1 with the VolumeType parameter of\n\t\t\tthe CreateVolume API in the Amazon EC2 API Reference. For more\n\t\t\tinformation, see Amazon EBS volume types in\n\t\t\tthe Amazon EC2 User Guide.
The following are the supported volume types.
\nGeneral Purpose SSD: gp2|gp3\n
Provisioned IOPS SSD: io1|io2\n
Throughput Optimized HDD: st1\n
Cold HDD: sc1\n
Magnetic: standard\n
The magnetic volume type is not supported on Fargate.
\nThe volume type. This parameter maps 1:1 with the VolumeType parameter of the CreateVolume\n\t\t\t\tAPI in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types\n\t\t\tin the Amazon EC2 User Guide.
The following are the supported volume types.
\nGeneral Purpose SSD: gp2|gp3\n
Provisioned IOPS SSD: io1|io2\n
Throughput Optimized HDD: st1\n
Cold HDD: sc1\n
Magnetic: standard\n
The magnetic volume type is not supported on Fargate.
\nThe size of the volume in GiB. You must specify either a volume size or a snapshot ID.\n\t\t\tIf you specify a snapshot ID, the snapshot size is used for the volume size by default.\n\t\t\tYou can optionally specify a volume size greater than or equal to the snapshot size.\n\t\t\tThis parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.
The following are the supported volume size values for each volume type.
\n\n gp2 and gp3: 1-16,384
\n io1 and io2: 4-16,384
\n st1 and sc1: 125-16,384
\n standard: 1-1,024
The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify\n\t\t\ta snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a\n\t\t\tvolume size greater than or equal to the snapshot size. This parameter maps 1:1 with the\n\t\t\t\tSize parameter of the CreateVolume API in the\n\t\t\t\tAmazon EC2 API Reference.
The following are the supported volume size values for each volume type.
\n\n gp2 and gp3: 1-16,384
\n io1 and io2: 4-16,384
\n st1 and sc1: 125-16,384
\n standard: 1-1,024
The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot\n\t\t\tID or a volume size. This parameter maps 1:1 with the SnapshotId parameter\n\t\t\tof the CreateVolume API in\n\t\t\tthe Amazon EC2 API Reference.
The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume\n\t\t\tsize. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume\n\t\t\t\tAPI in the Amazon EC2 API Reference.
The number of I/O operations per second (IOPS). For gp3,\n\t\t\tio1, and io2 volumes, this represents the number of IOPS that\n\t\t\tare provisioned for the volume. For gp2 volumes, this represents the\n\t\t\tbaseline performance of the volume and the rate at which the volume accumulates I/O\n\t\t\tcredits for bursting.
The following are the supported values for each volume type.
\n\n gp3: 3,000 - 16,000 IOPS
\n io1: 100 - 64,000 IOPS
\n io2: 100 - 256,000 IOPS
This parameter is required for io1 and io2 volume types. The\n\t\t\tdefault for gp3 volumes is 3,000 IOPS. This parameter is not\n\t\t\tsupported for st1, sc1, or standard volume\n\t\t\ttypes.
This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.
The number of I/O operations per second (IOPS). For gp3, io1, and\n\t\t\t\tio2 volumes, this represents the number of IOPS that are provisioned for the volume.\n\t\t\tFor gp2 volumes, this represents the baseline performance of the volume and the rate at\n\t\t\twhich the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type.
\n\n gp3: 3,000 - 16,000 IOPS
\n io1: 100 - 64,000 IOPS
\n io2: 100 - 256,000 IOPS
This parameter is required for io1 and io2 volume types. The default for\n\t\t\t\tgp3 volumes is 3,000 IOPS. This parameter is not supported for\n\t\t\t\tst1, sc1, or standard volume types.
This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the\n\t\t\t\tAmazon EC2 API Reference.
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.\n\t\t\tThis parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.
This parameter is only supported for the gp3 volume type.
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter\n\t\t\tmaps 1:1 with the Throughput parameter of the CreateVolume API in the\n\t\t\t\tAmazon EC2 API Reference.
This parameter is only supported for the gp3 volume type.
The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This\n\t\t\tparameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.
The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps\n\t\t\t1:1 with the TagSpecifications.N parameter of the CreateVolume API in the\n\t\t\t\tAmazon EC2 API Reference.
The ARN of the IAM role to associate with this volume. This is the Amazon ECS\n\t\t\tinfrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend\n\t\t\tusing the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM\n\t\t\tpolicy with this role. For more information, see Amazon ECS\n\t\t\t\tinfrastructure IAM role in the Amazon ECS Developer\n\t\t\tGuide.
The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role\n\t\t\tthat is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed\n\t\t\t\tAmazonECSInfrastructureRolePolicyForVolumes IAM policy with this role. For more\n\t\t\tinformation, see Amazon ECS infrastructure IAM\n\t\t\t\trole in the Amazon ECS Developer Guide.
The termination policy for the volume when the task exits. This provides a way to\n\t\t\tcontrol whether Amazon ECS terminates the Amazon EBS volume when the task stops.
" + "smithy.api#documentation": "The termination policy for the volume when the task exits. This provides a way to control whether\n\t\t\tAmazon ECS terminates the Amazon EBS volume when the task stops.
" } }, "filesystemType": { "target": "com.amazonaws.ecs#TaskFilesystemType", "traits": { - "smithy.api#documentation": "The Linux filesystem type for the volume. For volumes created from a snapshot, you\n\t\t\tmust specify the same filesystem type that the volume was using when the snapshot was\n\t\t\tcreated. If there is a filesystem type mismatch, the task will fail to start.
\nThe available filesystem types are\u2028 ext3, ext4, and\n\t\t\t\txfs. If no value is specified, the xfs filesystem type is\n\t\t\tused by default.
The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the\n\t\t\tsame filesystem type that the volume was using when the snapshot was created. If there is a filesystem\n\t\t\ttype mismatch, the task will fail to start.
\nThe available filesystem types are\u2028 ext3, ext4, and xfs. If no\n\t\t\tvalue is specified, the xfs filesystem type is used by default.
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.\n\t\t\tThese settings are used to create each Amazon EBS volume, with one volume created for each\n\t\t\ttask.
" + "smithy.api#documentation": "The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings\n\t\t\tare used to create each Amazon EBS volume, with one volume created for each task.
" } }, "com.amazonaws.ecs#TaskManagedEBSVolumeTerminationPolicy": { @@ -12685,13 +12703,13 @@ "deleteOnTermination": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "Indicates whether the volume should be deleted on when the task stops. If a value of\n\t\t\t\ttrue is specified, \u2028Amazon ECS deletes the Amazon EBS volume on your behalf when\n\t\t\tthe task goes into the STOPPED state. If no value is specified, the\n\t\t\t\u2028default value is true is used. When set to false, Amazon ECS\n\t\t\tleaves the volume in your \u2028account.
Indicates whether the volume should be deleted on when the task stops. If a value of\n\t\t\t\ttrue is specified, \u2028Amazon ECS deletes the Amazon EBS volume on your behalf when the task goes\n\t\t\tinto the STOPPED state. If no value is specified, the \u2028default value is true\n\t\t\tis used. When set to false, Amazon ECS leaves the volume in your \u2028account.
The termination policy for the Amazon EBS volume when the task exits. For more information,\n\t\t\tsee Amazon ECS volume termination policy.
" + "smithy.api#documentation": "The termination policy for the Amazon EBS volume when the task exits. For more information, see Amazon ECS\n\t\t\t\tvolume termination policy.
" } }, "com.amazonaws.ecs#TaskOverride": { @@ -12718,7 +12736,7 @@ "executionRoleArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution role override for the task. For more information,\n\t\t\tsee Amazon ECS task\n\t\t\t\texecution IAM role in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution role override for the task. For more information, see Amazon ECS task\n\t\t\t\texecution IAM role in the Amazon Elastic Container Service Developer Guide.
" } }, "memory": { @@ -12730,13 +12748,13 @@ "taskRoleArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that containers in this task can assume. All containers in\n\t\t\tthis task are granted the permissions that are specified in this role. For more\n\t\t\tinformation, see IAM Role for Tasks\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that containers in this task can assume. All containers in this task are\n\t\t\tgranted the permissions that are specified in this role. For more information, see IAM Role for\n\t\t\t\tTasks in the Amazon Elastic Container Service Developer Guide.
" } }, "ephemeralStorage": { "target": "com.amazonaws.ecs#EphemeralStorage", "traits": { - "smithy.api#documentation": "The ephemeral storage setting override for the task.
\nThis parameter is only supported for tasks hosted on Fargate that\n\t\t\t\tuse the following platform versions:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
The ephemeral storage setting override for the task.
\nThis parameter is only supported for tasks hosted on Fargate that use the following\n\t\t\t\tplatform versions:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists\n\t\t\tin.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
" } }, "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The tag specified when a task set is started. If an CodeDeploy deployment created the task\n\t\t\tset, the startedBy parameter is CODE_DEPLOY. If an external\n\t\t\tdeployment created the task set, the startedBy field isn't used.
The tag specified when a task set is started. If an CodeDeploy deployment created the task set, the\n\t\t\t\tstartedBy parameter is CODE_DEPLOY. If an external deployment created the\n\t\t\ttask set, the startedBy field isn't used.
The external ID associated with the task set.
\nIf an CodeDeploy deployment created a task set, the externalId parameter\n\t\t\tcontains the CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service\n\t\t\tdiscovery registry, the externalId parameter contains the\n\t\t\t\tECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.
The external ID associated with the task set.
\nIf an CodeDeploy deployment created a task set, the externalId parameter contains the CodeDeploy\n\t\t\tdeployment ID.
If a task set is created for an external deployment and is associated with a service discovery\n\t\t\tregistry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID\n\t\t\tCloud Map attribute.
The status of the task set. The following describes each state.
\nThe task set is serving production traffic.
\nThe task set isn't serving production traffic.
\nThe tasks in the task set are being stopped, and their corresponding\n\t\t\t\t\t\ttargets are being deregistered from their target group.
\nThe status of the task set. The following describes each state.
\nThe task set is serving production traffic.
\nThe task set isn't serving production traffic.
\nThe tasks in the task set are being stopped, and their corresponding targets are being\n\t\t\t\t\t\tderegistered from their target group.
\nThe computed desired count for the task set. This is calculated by multiplying the\n\t\t\tservice's desiredCount by the task set's scale percentage. The\n\t\t\tresult is always rounded up. For example, if the computed desired count is 1.2, it\n\t\t\trounds up to 2 tasks.
The computed desired count for the task set. This is calculated by multiplying the service's\n\t\t\t\tdesiredCount by the task set's scale percentage. The result is always\n\t\t\trounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.
The number of tasks in the task set that are in the PENDING status during\n\t\t\ta deployment. A task in the PENDING state is preparing to enter the\n\t\t\t\tRUNNING state. A task set enters the PENDING status when\n\t\t\tit launches for the first time or when it's restarted after being in the\n\t\t\t\tSTOPPED state.
The number of tasks in the task set that are in the PENDING status during a deployment.\n\t\t\tA task in the PENDING state is preparing to enter the RUNNING state. A task\n\t\t\tset enters the PENDING status when it launches for the first time or when it's restarted\n\t\t\tafter being in the STOPPED state.
The number of tasks in the task set that are in the RUNNING status during\n\t\t\ta deployment. A task in the RUNNING state is running and ready for\n\t\t\tuse.
The number of tasks in the task set that are in the RUNNING status during a deployment.\n\t\t\tA task in the RUNNING state is running and ready for use.
The launch type the tasks in the task set are using. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The launch type the tasks in the task set are using. For more information, see Amazon ECS launch\n\t\t\t\ttypes in the Amazon Elastic Container Service Developer Guide.
" } }, "capacityProviderStrategy": { @@ -12843,13 +12861,13 @@ "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Fargate platform version where the tasks in the task set are running. A platform\n\t\t\tversion is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The Fargate platform version where the tasks in the task set are running. A platform version is\n\t\t\tonly specified for tasks run on Fargate. For more information, see Fargate platform versions in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
" } }, "platformFamily": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The operating system that your tasks in the set are running on. A platform family is\n\t\t\tspecified only for tasks that use the Fargate launch type.
\nAll tasks in the set must have the same value.
" + "smithy.api#documentation": "The operating system that your tasks in the set are running on. A platform family is specified only\n\t\t\tfor tasks that use the Fargate launch type.
\nAll tasks in the set must have the same value.
" } }, "networkConfiguration": { @@ -12867,31 +12885,31 @@ "serviceRegistries": { "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { - "smithy.api#documentation": "The details for the service discovery registries to assign to this task set. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.
" + "smithy.api#documentation": "The details for the service discovery registries to assign to this task set. For more information,\n\t\t\tsee Service\n\t\t\t\tdiscovery.
" } }, "scale": { "target": "com.amazonaws.ecs#Scale", "traits": { - "smithy.api#documentation": "A floating-point percentage of your desired number of tasks to place and keep running\n\t\t\tin the task set.
" + "smithy.api#documentation": "A floating-point percentage of your desired number of tasks to place and keep running in the task\n\t\t\tset.
" } }, "stabilityStatus": { "target": "com.amazonaws.ecs#StabilityStatus", "traits": { - "smithy.api#documentation": "The stability status. This indicates whether the task set has reached a steady state.\n\t\t\tIf the following conditions are met, the task set are in\n\t\t\tSTEADY_STATE:
The task runningCount is equal to the\n\t\t\t\t\t\tcomputedDesiredCount.
The pendingCount is 0.
There are no tasks that are running on container instances in the\n\t\t\t\t\t\tDRAINING status.
All tasks are reporting a healthy status from the load balancers, service\n\t\t\t\t\tdiscovery, and container health checks.
\nIf any of those conditions aren't met, the stability status returns\n\t\t\t\tSTABILIZING.
The stability status. This indicates whether the task set has reached a steady state. If the\n\t\t\tfollowing conditions are met, the task set are in STEADY_STATE:
The task runningCount is equal to the computedDesiredCount.
The pendingCount is 0.
There are no tasks that are running on container instances in the DRAINING\n\t\t\t\t\tstatus.
All tasks are reporting a healthy status from the load balancers, service discovery, and\n\t\t\t\t\tcontainer health checks.
\nIf any of those conditions aren't met, the stability status returns STABILIZING.
The Unix timestamp for the time when the task set stability status was\n\t\t\tretrieved.
" + "smithy.api#documentation": "The Unix timestamp for the time when the task set stability status was retrieved.
" } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the task set to help you categorize and organize them. Each tag\n\t\t\tconsists of a key and an optional value. You define both.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL\n\t\t\tdeployment. An Amazon ECS task set includes details such as the desired number of tasks, how\n\t\t\tmany tasks are running, and whether the task set serves production traffic.
Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An\n\t\t\tAmazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and\n\t\t\twhether the task set serves production traffic.
The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and\n\t\t\tRegion.
", + "smithy.api#documentation": "The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.
", "smithy.api#error": "client" } }, @@ -12990,19 +13008,19 @@ "name": { "target": "com.amazonaws.ecs#ECSVolumeName", "traits": { - "smithy.api#documentation": "The name of the volume. This value must match the volume name from the\n\t\t\t\tVolume object in the task definition.
The name of the volume. This value must match the volume name from the Volume object in\n\t\t\tthe task definition.
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.\n\t\t\tThese settings are used to create each Amazon EBS volume, with one volume created for each\n\t\t\ttask. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are\n\t\t\tcreated.
" + "smithy.api#documentation": "The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings\n\t\t\tare used to create each Amazon EBS volume, with one volume created for each task. The Amazon EBS volumes are\n\t\t\tvisible in your account in the Amazon EC2 console once they are created.
" } } }, "traits": { - "smithy.api#documentation": "Configuration settings for the task volume that was configuredAtLaunch\n\t\t\tthat weren't set during RegisterTaskDef.
Configuration settings for the task volume that was configuredAtLaunch that weren't set\n\t\t\tduring RegisterTaskDef.
The amount of time in seconds a connection will stay active while idle. A value of\n\t\t\t\t0 can be set to disable idleTimeout.
The idleTimeout default for\n\t\t\t\tHTTP/HTTP2/GRPC is 5 minutes.
The idleTimeout default for TCP is 1 hour.
The amount of time in seconds a connection will stay active while idle. A value of 0 can\n\t\t\tbe set to disable idleTimeout.
The idleTimeout default for HTTP/HTTP2/GRPC is 5\n\t\t\tminutes.
The idleTimeout default for TCP is 1 hour.
The amount of time waiting for the upstream to respond with a complete response per\n\t\t\trequest. A value of 0 can be set to disable perRequestTimeout.\n\t\t\t\tperRequestTimeout can only be set if Service Connect\n\t\t\t\tappProtocol isn't TCP. Only idleTimeout is\n\t\t\tallowed for TCP\n appProtocol.
The amount of time waiting for the upstream to respond with a complete response per request. A value\n\t\t\tof 0 can be set to disable perRequestTimeout. perRequestTimeout\n\t\t\tcan only be set if Service Connect appProtocol isn't TCP. Only\n\t\t\t\tidleTimeout is allowed for TCP\n appProtocol.
An object that represents the timeout configurations for Service Connect.
\nIf idleTimeout is set to a time that is less than\n\t\t\t\t\tperRequestTimeout, the connection will close when the\n\t\t\t\t\tidleTimeout is reached and not the\n\t\t\t\tperRequestTimeout.
An object that represents the timeout configurations for Service Connect.
\nIf idleTimeout is set to a time that is less than perRequestTimeout,\n\t\t\t\tthe connection will close when the idleTimeout is reached and not the\n\t\t\t\t\tperRequestTimeout.
The list of tmpfs volume mount options.
\nValid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" |\n\t\t\t\t\"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" |\n\t\t\t\t\"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" |\n\t\t\t\t\"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" |\n\t\t\t\t\"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\"\n\t\t\t\t| \"nr_inodes\" | \"nr_blocks\" | \"mpol\"\n
The list of tmpfs volume mount options.
\nValid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" |\n\t\t\t\t\"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" |\n\t\t\t\t\"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" |\n\t\t\t\t\"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\"\n\t\t\t\t| \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"\n
The soft limit for the ulimit type. The value can be specified in bytes, seconds, or as a count, depending on the type of the ulimit.
The soft limit for the ulimit type. The value can be specified in bytes, seconds, or as\n\t\t\ta count, depending on the type of the ulimit.
The hard limit for the ulimit type. The value can be specified in bytes, seconds, or as a count, depending on the type of the ulimit.
The hard limit for the ulimit type. The value can be specified in bytes, seconds, or as\n\t\t\ta count, depending on the type of the ulimit.
The ulimit settings to pass to the container.
Amazon ECS tasks hosted on Fargate use the default\n\t\t\t\t\t\t\tresource limit values set by the operating system with the exception of\n\t\t\t\t\t\t\tthe nofile resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The nofile resource limit sets a restriction on\n\t\t\t\t\t\t\tthe number of open files that a container can use. The default\n\t\t\t\t\t\t\t\tnofile soft limit is 65535 and the default hard limit\n\t\t\t\t\t\t\tis 65535.
You can specify the ulimit settings for a container in a task\n\t\t\tdefinition.
The ulimit settings to pass to the container.
Amazon ECS tasks hosted on Fargate use the default\n\t\t\t\t\t\t\tresource limit values set by the operating system with the exception of\n\t\t\t\t\t\t\tthe nofile resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The nofile resource limit sets a restriction on\n\t\t\t\t\t\t\tthe number of open files that a container can use. The default\n\t\t\t\t\t\t\t\tnofile soft limit is 65535 and the default hard limit\n\t\t\t\t\t\t\tis 65535.
You can specify the ulimit settings for a container in a task definition.
The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, the supported resources\n\t\t\tare Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container\n\t\t\tinstances.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, the supported resources are Amazon ECS\n\t\t\tcapacity providers, tasks, services, task definitions, clusters, and container instances.
", "smithy.api#required": {} } }, @@ -13482,7 +13500,7 @@ "settings": { "target": "com.amazonaws.ecs#ClusterSettings", "traits": { - "smithy.api#documentation": "The setting to use by default for a cluster. This parameter is used to turn on CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it overrides the\n\t\t\tcontainerInsights value set with PutAccountSetting or\n\t\t\tPutAccountSettingDefault.
Currently, if you delete an existing cluster that does not have Container Insights\n\t\t\t\tturned on, and then create a new cluster with the same name with Container Insights\n\t\t\t\ttuned on, Container Insights will not actually be turned on. If you want to preserve\n\t\t\t\tthe same name for your existing cluster and turn on Container Insights, you must\n\t\t\t\twait 7 days before you can re-create it.
\nThe setting to use by default for a cluster. This parameter is used to turn on CloudWatch Container\n\t\t\tInsights for a cluster. If this value is specified, it overrides the containerInsights\n\t\t\tvalue set with PutAccountSetting or PutAccountSettingDefault.
Currently, if you delete an existing cluster that does not have Container Insights turned on, and\n\t\t\t\tthen create a new cluster with the same name with Container Insights tuned on, Container Insights\n\t\t\t\twill not actually be turned on. If you want to preserve the same name for your existing cluster and\n\t\t\t\tturn on Container Insights, you must wait 7 days before you can re-create it.
\nUpdates the Amazon ECS container agent on a specified container instance. Updating the\n\t\t\tAmazon ECS container agent doesn't interrupt running tasks or services on the container\n\t\t\tinstance. The process for updating the agent differs depending on whether your container\n\t\t\tinstance was launched with the Amazon ECS-optimized AMI or another operating system.
\nThe UpdateContainerAgent API isn't supported for container instances\n\t\t\t\tusing the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent,\n\t\t\t\tyou can update the ecs-init package. This updates the agent. For more\n\t\t\t\tinformation, see Updating the\n\t\t\t\t\tAmazon ECS container agent in the Amazon Elastic Container Service Developer Guide.
Agent updates with the UpdateContainerAgent API operation do not\n\t\t\t\tapply to Windows container instances. We recommend that you launch new container\n\t\t\t\tinstances to update the agent version in your Windows clusters.
The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon\n\t\t\tLinux AMI with the ecs-init service installed and running. For help\n\t\t\tupdating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.
Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container\n\t\t\tagent doesn't interrupt running tasks or services on the container instance. The process for updating\n\t\t\tthe agent differs depending on whether your container instance was launched with the Amazon ECS-optimized\n\t\t\tAMI or another operating system.
\nThe UpdateContainerAgent API isn't supported for container instances using the\n\t\t\t\tAmazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the\n\t\t\t\t\tecs-init package. This updates the agent. For more information, see Updating\n\t\t\t\t\tthe Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.
Agent updates with the UpdateContainerAgent API operation do not apply to Windows\n\t\t\t\tcontainer instances. We recommend that you launch new container instances to update the agent\n\t\t\t\tversion in your Windows clusters.
The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon Linux AMI with\n\t\t\tthe ecs-init service installed and running. For help updating the Amazon ECS container agent on\n\t\t\tother operating systems, see Manually updating\n\t\t\t\tthe Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is\n\t\t\trunning on. If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "containerInstance": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The container instance ID or full ARN entries for the container instance where you\n\t\t\twould like to update the Amazon ECS container agent.
", + "smithy.api#documentation": "The container instance ID or full ARN entries for the container instance where you would like to\n\t\t\tupdate the Amazon ECS container agent.
", "smithy.api#required": {} } } @@ -13598,7 +13616,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the status of an Amazon ECS container instance.
\nOnce a container instance has reached an ACTIVE state, you can change the\n\t\t\tstatus of a container instance to DRAINING to manually remove an instance\n\t\t\tfrom a cluster, for example to perform system updates, update the Docker daemon, or\n\t\t\tscale down the cluster size.
A container instance can't be changed to DRAINING until it has\n\t\t\t\treached an ACTIVE status. If the instance is in any other status, an\n\t\t\t\terror will be received.
When you set a container instance to DRAINING, Amazon ECS prevents new tasks\n\t\t\tfrom being scheduled for placement on the container instance and replacement service\n\t\t\ttasks are started on other container instances in the cluster if the resources are\n\t\t\tavailable. Service tasks on the container instance that are in the PENDING\n\t\t\tstate are stopped immediately.
Service tasks on the container instance that are in the RUNNING state are\n\t\t\tstopped and replaced according to the service's deployment configuration parameters,\n\t\t\t\tminimumHealthyPercent and maximumPercent. You can change\n\t\t\tthe deployment configuration of your service using UpdateService.
If minimumHealthyPercent is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount temporarily during task replacement. For example,\n\t\t\t\t\t\tdesiredCount is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. If the\n\t\t\t\t\tminimum is 100%, the service scheduler can't remove existing tasks until the\n\t\t\t\t\treplacement tasks are considered healthy. Tasks for services that do not use a\n\t\t\t\t\tload balancer are considered healthy if they're in the RUNNING\n\t\t\t\t\tstate. Tasks for services that use a load balancer are considered healthy if\n\t\t\t\t\tthey're in the RUNNING state and are reported as healthy by the\n\t\t\t\t\tload balancer.
The maximumPercent parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during task replacement. You can use this to define the\n\t\t\t\t\treplacement batch size. For example, if desiredCount is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four tasks to be\n\t\t\t\t\tdrained, provided that the cluster resources required to do this are available.\n\t\t\t\t\tIf the maximum is 100%, then replacement tasks can't start until the draining\n\t\t\t\t\ttasks have stopped.
Any PENDING or RUNNING tasks that do not belong to a service\n\t\t\taren't affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING\n\t\t\ttasks. You can verify this using ListTasks.
When a container instance has been drained, you can set a container instance to\n\t\t\t\tACTIVE status and once it has reached that status the Amazon ECS scheduler\n\t\t\tcan begin scheduling tasks on the instance again.
Modifies the status of an Amazon ECS container instance.
\nOnce a container instance has reached an ACTIVE state, you can change the status of a\n\t\t\tcontainer instance to DRAINING to manually remove an instance from a cluster, for example\n\t\t\tto perform system updates, update the Docker daemon, or scale down the cluster size.
A container instance can't be changed to DRAINING until it has reached an\n\t\t\t\t\tACTIVE status. If the instance is in any other status, an error will be\n\t\t\t\treceived.
When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being\n\t\t\tscheduled for placement on the container instance and replacement service tasks are started on other\n\t\t\tcontainer instances in the cluster if the resources are available. Service tasks on the container\n\t\t\tinstance that are in the PENDING state are stopped immediately.
Service tasks on the container instance that are in the RUNNING state are stopped and\n\t\t\treplaced according to the service's deployment configuration parameters,\n\t\t\t\tminimumHealthyPercent and maximumPercent. You can change the deployment\n\t\t\tconfiguration of your service using UpdateService.
If minimumHealthyPercent is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount temporarily during task replacement. For example,\n\t\t\t\t\t\tdesiredCount is four tasks, a minimum of 50% allows the scheduler to stop two\n\t\t\t\t\texisting tasks before starting two new tasks. If the minimum is 100%, the service scheduler\n\t\t\t\t\tcan't remove existing tasks until the replacement tasks are considered healthy. Tasks for\n\t\t\t\t\tservices that do not use a load balancer are considered healthy if they're in the\n\t\t\t\t\t\tRUNNING state. Tasks for services that use a load balancer are considered\n\t\t\t\t\thealthy if they're in the RUNNING state and are reported as healthy by the load\n\t\t\t\t\tbalancer.
The maximumPercent parameter represents an upper limit on the number of running\n\t\t\t\t\ttasks during task replacement. You can use this to define the replacement batch size. For\n\t\t\t\t\texample, if desiredCount is four tasks, a maximum of 200% starts four new tasks\n\t\t\t\t\tbefore stopping the four tasks to be drained, provided that the cluster resources required to\n\t\t\t\t\tdo this are available. If the maximum is 100%, then replacement tasks can't start until the\n\t\t\t\t\tdraining tasks have stopped.
Any PENDING or RUNNING tasks that do not belong to a service aren't\n\t\t\taffected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING tasks. You can\n\t\t\tverify this using ListTasks.
When a container instance has been drained, you can set a container instance to ACTIVE\n\t\t\tstatus and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the\n\t\t\tinstance again.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to\n\t\t\tupdate. If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "containerInstances": { @@ -13620,7 +13638,7 @@ "status": { "target": "com.amazonaws.ecs#ContainerInstanceStatus", "traits": { - "smithy.api#documentation": "The container instance state to update the container instance with. The only valid\n\t\t\tvalues for this action are ACTIVE and DRAINING. A container\n\t\t\tinstance can only be updated to DRAINING status once it has reached an\n\t\t\t\tACTIVE state. If a container instance is in REGISTERING,\n\t\t\t\tDEREGISTERING, or REGISTRATION_FAILED state you can\n\t\t\tdescribe the container instance but can't update the container instance state.
The container instance state to update the container instance with. The only valid values for this\n\t\t\taction are ACTIVE and DRAINING. A container instance can only be updated to\n\t\t\t\tDRAINING status once it has reached an ACTIVE state. If a container\n\t\t\tinstance is in REGISTERING, DEREGISTERING, or\n\t\t\t\tREGISTRATION_FAILED state you can describe the container instance but can't update the\n\t\t\tcontainer instance state.
There's already a current Amazon ECS container agent update in progress on the container\n\t\t\tinstance that's specified. If the container agent becomes disconnected while it's in a\n\t\t\ttransitional stage, such as PENDING or STAGING, the update\n\t\t\tprocess can get stuck in that state. However, when the agent reconnects, it resumes\n\t\t\twhere it stopped previously.
There's already a current Amazon ECS container agent update in progress on the container instance that's\n\t\t\tspecified. If the container agent becomes disconnected while it's in a transitional stage, such as\n\t\t\t\tPENDING or STAGING, the update process can get stuck in that state.\n\t\t\tHowever, when the agent reconnects, it resumes where it stopped previously.
Modifies the parameters of a service.
\nOn 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.
\nFor services using the rolling update (ECS) you can update the desired\n\t\t\tcount, deployment configuration, network configuration, load balancers, service\n\t\t\tregistries, enable ECS managed tags option, propagate tags option, task placement\n\t\t\tconstraints and strategies, and task definition. When you update any of these\n\t\t\tparameters, Amazon ECS starts new tasks with the new configuration.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or\n\t\t\trunning a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. You can update\n\t\t\tyour volume configurations and trigger a new deployment.\n\t\t\t\tvolumeConfigurations is only supported for REPLICA service and not\n\t\t\tDAEMON service. If you leave volumeConfigurations\n null, it doesn't trigger a new deployment. For more infomation on volumes,\n\t\t\tsee Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
For services using the blue/green (CODE_DEPLOY) deployment controller,\n\t\t\tonly the desired count, deployment configuration, health check grace period, task\n\t\t\tplacement constraints and strategies, enable ECS managed tags option, and propagate tags\n\t\t\tcan be updated using this API. If the network configuration, platform version, task\n\t\t\tdefinition, or load balancer need to be updated, create a new CodeDeploy deployment. For more\n\t\t\tinformation, see CreateDeployment in the CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired\n\t\t\tcount, task placement constraints and strategies, health check grace period, enable ECS\n\t\t\tmanaged tags option, and propagate tags option, using this API. If the launch type, load\n\t\t\tbalancer, network configuration, platform version, or task definition need to be\n\t\t\tupdated, create a new task set For more information, see CreateTaskSet.
\nYou can add to or subtract from the number of instantiations of a task definition in a\n\t\t\tservice by specifying the cluster that the service is running in and a new\n\t\t\t\tdesiredCount parameter.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or\n\t\t\trunning a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
\nIf you have updated the container image of your application, you can create a new task\n\t\t\tdefinition with that image and deploy it to your service. The service scheduler uses the\n\t\t\tminimum healthy percent and maximum percent parameters (in the service's deployment\n\t\t\tconfiguration) to determine the deployment strategy.
\nIf your updated Docker image uses the same tag as what is in the existing task\n\t\t\t\tdefinition for your service (for example, my_image:latest), you don't\n\t\t\t\tneed to create a new revision of your task definition. You can update the service\n\t\t\t\tusing the forceNewDeployment option. The new tasks launched by the\n\t\t\t\tdeployment pull the current image/tag combination from your repository when they\n\t\t\t\tstart.
You can also update the deployment configuration of a service. When a deployment is\n\t\t\ttriggered by updating the task definition of a service, the service scheduler uses the\n\t\t\tdeployment configuration parameters, minimumHealthyPercent and\n\t\t\t\tmaximumPercent, to determine the deployment strategy.
If minimumHealthyPercent is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount temporarily during a deployment. For example, if\n\t\t\t\t\t\tdesiredCount is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. Tasks for\n\t\t\t\t\tservices that don't use a load balancer are considered healthy if they're in the\n\t\t\t\t\t\tRUNNING state. Tasks for services that use a load balancer are\n\t\t\t\t\tconsidered healthy if they're in the RUNNING state and are reported\n\t\t\t\t\tas healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during a deployment. You can use it to define the\n\t\t\t\t\tdeployment batch size. For example, if desiredCount is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four older tasks\n\t\t\t\t\t(provided that the cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent\n\t\t\tof docker stop is issued to the containers running in the task. This\n\t\t\tresults in a SIGTERM and a 30-second timeout. After this,\n\t\t\t\tSIGKILL is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM gracefully and exits within 30 seconds from\n\t\t\treceiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic.
\nDetermine which of the container instances in your cluster can support your\n\t\t\t\t\tservice's task definition. For example, they have the required CPU, memory,\n\t\t\t\t\tports, and container instance attributes.
\nBy default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner even though you can choose a different\n\t\t\t\t\tplacement strategy.
\nSort the valid container instances by the fewest number of running\n\t\t\t\t\t\t\ttasks for this service in the same Availability Zone as the instance.\n\t\t\t\t\t\t\tFor example, if zone A has one running service task and zones B and C\n\t\t\t\t\t\t\teach have zero, valid container instances in either zone B or C are\n\t\t\t\t\t\t\tconsidered optimal for placement.
\nPlace the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone (based on the previous steps), favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.
\nWhen the service scheduler stops running tasks, it attempts to maintain balance across\n\t\t\tthe Availability Zones in your cluster using the following logic:
\nSort the container instances by the largest number of running tasks for this\n\t\t\t\t\tservice in the same Availability Zone as the instance. For example, if zone A\n\t\t\t\t\thas one running service task and zones B and C each have two, container\n\t\t\t\t\tinstances in either zone B or C are considered optimal for termination.
\nStop the task on a container instance in an optimal Availability Zone (based\n\t\t\t\t\ton the previous steps), favoring container instances with the largest number of\n\t\t\t\t\trunning tasks for this service.
\nYou must have a service-linked role when you update any of the following service\n\t\t\t\tproperties:
\n\n loadBalancers,
\n serviceRegistries\n
For more information about the role see the CreateService request\n\t\t\t\tparameter \n role\n .
Modifies the parameters of a service.
\nOn 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.
\nFor services using the rolling update (ECS) you can update the desired count, deployment\n\t\t\tconfiguration, network configuration, load balancers, service registries, enable ECS managed tags\n\t\t\toption, propagate tags option, task placement constraints and strategies, and task definition. When you\n\t\t\tupdate any of these parameters, Amazon ECS starts new tasks with the new configuration.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a\n\t\t\ttask, or when creating or updating a service. For more infomation, see Amazon EBS\n\t\t\t\tvolumes in the Amazon Elastic Container Service Developer Guide. You can update your volume configurations and trigger a new\n\t\t\tdeployment. volumeConfigurations is only supported for REPLICA service and not DAEMON\n\t\t\tservice. If you leave volumeConfigurations\n null, it doesn't trigger a new deployment. For more infomation on volumes, see Amazon EBS\n\t\t\t\tvolumes in the Amazon Elastic Container Service Developer Guide.
For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired\n\t\t\tcount, deployment configuration, health check grace period, task placement constraints and strategies,\n\t\t\tenable ECS managed tags option, and propagate tags can be updated using this API. If the network\n\t\t\tconfiguration, platform version, task definition, or load balancer need to be updated, create a new\n\t\t\tCodeDeploy deployment. For more information, see CreateDeployment in the\n\t\t\tCodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired count, task\n\t\t\tplacement constraints and strategies, health check grace period, enable ECS managed tags option, and\n\t\t\tpropagate tags option, using this API. If the launch type, load balancer, network configuration,\n\t\t\tplatform version, or task definition need to be updated, create a new task set For more information,\n\t\t\tsee CreateTaskSet.
\nYou can add to or subtract from the number of instantiations of a task definition in a service by\n\t\t\tspecifying the cluster that the service is running in and a new desiredCount\n\t\t\tparameter.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a\n\t\t\ttask, or when creating or updating a service. For more infomation, see Amazon EBS\n\t\t\t\tvolumes in the Amazon Elastic Container Service Developer Guide.
\nIf you have updated the container image of your application, you can create a new task definition\n\t\t\twith that image and deploy it to your service. The service scheduler uses the minimum healthy percent\n\t\t\tand maximum percent parameters (in the service's deployment configuration) to determine the deployment\n\t\t\tstrategy.
\nIf your updated Docker image uses the same tag as what is in the existing task definition for\n\t\t\t\tyour service (for example, my_image:latest), you don't need to create a new revision\n\t\t\t\tof your task definition. You can update the service using the forceNewDeployment\n\t\t\t\toption. The new tasks launched by the deployment pull the current image/tag combination from your\n\t\t\t\trepository when they start.
You can also update the deployment configuration of a service. When a deployment is triggered by\n\t\t\tupdating the task definition of a service, the service scheduler uses the deployment configuration\n\t\t\tparameters, minimumHealthyPercent and maximumPercent, to determine the\n\t\t\tdeployment strategy.
If minimumHealthyPercent is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount temporarily during a deployment. For example, if\n\t\t\t\t\t\tdesiredCount is four tasks, a minimum of 50% allows the scheduler to stop two\n\t\t\t\t\texisting tasks before starting two new tasks. Tasks for services that don't use a load balancer\n\t\t\t\t\tare considered healthy if they're in the RUNNING state. Tasks for services that\n\t\t\t\t\tuse a load balancer are considered healthy if they're in the RUNNING state and are\n\t\t\t\t\treported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running\n\t\t\t\t\ttasks during a deployment. You can use it to define the deployment batch size. For example, if\n\t\t\t\t\t\tdesiredCount is four tasks, a maximum of 200% starts four new tasks before\n\t\t\t\t\tstopping the four older tasks (provided that the cluster resources required to do this are\n\t\t\t\t\tavailable).
When UpdateService stops a task during a deployment, the equivalent of docker stop\n\t\t\tis issued to the containers running in the task. This results in a SIGTERM and a 30-second\n\t\t\ttimeout. After this, SIGKILL is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no\n\t\t\t\tSIGKILL is sent.
When the service scheduler launches new tasks, it determines task placement in your cluster with the\n\t\t\tfollowing logic.
\nDetermine which of the container instances in your cluster can support your service's task\n\t\t\t\t\tdefinition. For example, they have the required CPU, memory, ports, and container instance\n\t\t\t\t\tattributes.
\nBy default, the service scheduler attempts to balance tasks across Availability Zones in this\n\t\t\t\t\tmanner even though you can choose a different placement strategy.
\nSort the valid container instances by the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice in the same Availability Zone as the instance. For example, if zone A has one\n\t\t\t\t\t\t\trunning service task and zones B and C each have zero, valid container instances in\n\t\t\t\t\t\t\teither zone B or C are considered optimal for placement.
\nPlace the new service task on a valid container instance in an optimal Availability\n\t\t\t\t\t\t\tZone (based on the previous steps), favoring container instances with the fewest number\n\t\t\t\t\t\t\tof running tasks for this service.
\nWhen the service scheduler stops running tasks, it attempts to maintain balance across the\n\t\t\tAvailability Zones in your cluster using the following logic:
\nSort the container instances by the largest number of running tasks for this service in the\n\t\t\t\t\tsame Availability Zone as the instance. For example, if zone A has one running service task and\n\t\t\t\t\tzones B and C each have two, container instances in either zone B or C are considered optimal\n\t\t\t\t\tfor termination.
\nStop the task on a container instance in an optimal Availability Zone (based on the previous\n\t\t\t\t\tsteps), favoring container instances with the largest number of running tasks for this\n\t\t\t\t\tservice.
\nYou must have a service-linked role when you update any of the following service\n\t\t\t\tproperties:
\n\n loadBalancers,
\n serviceRegistries\n
For more information about the role see the CreateService request parameter \n role\n .
Modifies which task set in a service is the primary task set. Any parameters that are\n\t\t\tupdated on the primary task set in a service will transition to the service. This is\n\t\t\tused when a service uses the EXTERNAL deployment controller type. For more\n\t\t\tinformation, see Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
Modifies which task set in a service is the primary task set. Any parameters that are updated on the\n\t\t\tprimary task set in a service will transition to the service. This is used when a service uses the\n\t\t\t\tEXTERNAL deployment controller type. For more information, see Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset exists in.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists\n\t\t\tin.
", "smithy.api#required": {} } }, @@ -13834,25 +13852,25 @@ "desiredCount": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The number of instantiations of the task to place and keep running in your\n\t\t\tservice.
" + "smithy.api#documentation": "The number of instantiations of the task to place and keep running in your service.
" } }, "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision is\n\t\t\tnot specified, the latest ACTIVE revision is used. If you modify the task\n\t\t\tdefinition with UpdateService, Amazon ECS spawns a task with the new version of\n\t\t\tthe task definition and then stops an old task after the new version is running.
The family and revision (family:revision) or full ARN of the\n\t\t\ttask definition to run in your service. If a revision is not specified, the latest\n\t\t\t\tACTIVE revision is used. If you modify the task definition with\n\t\t\t\tUpdateService, Amazon ECS spawns a task with the new version of the task definition and\n\t\t\tthen stops an old task after the new version is running.
The capacity provider strategy to update the service to use.
\nif the service uses the default capacity provider strategy for the cluster, the\n\t\t\tservice can be updated to use one or more capacity providers as opposed to the default\n\t\t\tcapacity provider strategy. However, when a service is using a capacity provider\n\t\t\tstrategy that's not the default capacity provider strategy, the service can't be updated\n\t\t\tto use the cluster's default capacity provider strategy.
\nA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateClusterCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutClusterCapacityProvidersAPI operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.
\n " + "smithy.api#documentation": "The capacity provider strategy to update the service to use.
\nif the service uses the default capacity provider strategy for the cluster, the service can be\n\t\t\tupdated to use one or more capacity providers as opposed to the default capacity provider strategy.\n\t\t\tHowever, when a service is using a capacity provider strategy that's not the default capacity provider\n\t\t\tstrategy, the service can't be updated to use the cluster's default capacity provider strategy.
\nA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider must be associated\n\t\t\twith the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.\n\t\t\tOnly capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already\n\t\t\tbe created. New capacity providers can be created with the CreateClusterCapacityProvider API operation.
\nTo use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are available to all\n\t\t\taccounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProvidersAPI operation is used to update the list of available capacity\n\t\t\tproviders for a cluster after the cluster is created.
\n " } }, "deploymentConfiguration": { "target": "com.amazonaws.ecs#DeploymentConfiguration", "traits": { - "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment and the\n\t\t\tfailure detection methods.
" + "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment and the ordering\n\t\t\tof stopping and starting tasks.
" } }, "networkConfiguration": { @@ -13864,62 +13882,62 @@ "placementConstraints": { "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { - "smithy.api#documentation": "An array of task placement constraint objects to update the service to use. If no\n\t\t\tvalue is specified, the existing placement constraints for the service will remain\n\t\t\tunchanged. If this value is specified, it will override any existing placement\n\t\t\tconstraints defined for the service. To remove all existing placement constraints,\n\t\t\tspecify an empty array.
\nYou can specify a maximum of 10 constraints for each task. This limit includes\n\t\t\tconstraints in the task definition and those specified at runtime.
" + "smithy.api#documentation": "An array of task placement constraint objects to update the service to use. If no value is specified,\n\t\t\tthe existing placement constraints for the service will remain unchanged. If this value is specified,\n\t\t\tit will override any existing placement constraints defined for the service. To remove all existing\n\t\t\tplacement constraints, specify an empty array.
\nYou can specify a maximum of 10 constraints for each task. This limit includes constraints in the\n\t\t\ttask definition and those specified at runtime.
" } }, "placementStrategy": { "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { - "smithy.api#documentation": "The task placement strategy objects to update the service to use. If no value is\n\t\t\tspecified, the existing placement strategy for the service will remain unchanged. If\n\t\t\tthis value is specified, it will override the existing placement strategy defined for\n\t\t\tthe service. To remove an existing placement strategy, specify an empty object.
\nYou can specify a maximum of five strategy rules for each service.
" + "smithy.api#documentation": "The task placement strategy objects to update the service to use. If no value is specified, the\n\t\t\texisting placement strategy for the service will remain unchanged. If this value is specified, it will\n\t\t\toverride the existing placement strategy defined for the service. To remove an existing placement\n\t\t\tstrategy, specify an empty object.
\nYou can specify a maximum of five strategy rules for each service.
" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The platform version that your tasks in the service run on. A platform version is only\n\t\t\tspecified for tasks using the Fargate launch type. If a platform version\n\t\t\tis not specified, the LATEST platform version is used. For more\n\t\t\tinformation, see Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
The platform version that your tasks in the service run on. A platform version is only specified for\n\t\t\ttasks using the Fargate launch type. If a platform version is not specified, the\n\t\t\t\tLATEST platform version is used. For more information, see Fargate Platform Versions in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
Determines whether to force a new deployment of the service. By default, deployments\n\t\t\taren't forced. You can use this option to start a new deployment with no service\n\t\t\tdefinition changes. For example, you can update a service's tasks to use a newer Docker\n\t\t\timage with the same image/tag combination (my_image:latest) or to roll\n\t\t\tFargate tasks onto a newer platform version.
Determines whether to force a new deployment of the service. By default, deployments aren't forced.\n\t\t\tYou can use this option to start a new deployment with no service definition changes. For example, you\n\t\t\tcan update a service's tasks to use a newer Docker image with the same image/tag combination\n\t\t\t\t(my_image:latest) or to roll Fargate tasks onto a newer platform version.
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing target health checks after a task has first started. This is only valid if your\n\t\t\tservice is configured to use a load balancer. If your service's tasks take a while to\n\t\t\tstart and respond to Elastic Load Balancing health checks, you can specify a health check grace period of\n\t\t\tup to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores\n\t\t\tthe Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler\n\t\t\tfrom marking tasks as unhealthy and stopping them before they have time to come\n\t\t\tup.
" + "smithy.api#documentation": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container \n\t\t\thealth checks after a task has first started. If you don't specify a health check grace\n\t\t\tperiod value, the default value of 0 is used. If you don't use any of the health checks, \n\t\t\tthen healthCheckGracePeriodSeconds is unused.
If your service's tasks take a while to start and respond to health checks, you can specify a\n\t\t\thealth check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS\n\t\t\tservice scheduler ignores health check status. This grace period can prevent the service scheduler from\n\t\t\tmarking tasks as unhealthy and stopping them before they have time to come up.
" } }, "enableExecuteCommand": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "If true, this enables execute command functionality on all task\n\t\t\tcontainers.
If you do not want to override the value that was set when the service was created,\n\t\t\tyou can set this to null when performing this action.
If true, this enables execute command functionality on all task containers.
If you do not want to override the value that was set when the service was created, you can set this\n\t\t\tto null when performing this action.
Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For\n\t\t\tmore information, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
\nOnly tasks launched after the update will reflect the update. To update the tags on\n\t\t\tall tasks, set forceNewDeployment to true, so that Amazon ECS\n\t\t\tstarts new tasks with the updated tags.
Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For more information,\n\t\t\tsee Tagging Your\n\t\t\t\tAmazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
\nOnly tasks launched after the update will reflect the update. To update the tags on all tasks, set\n\t\t\t\tforceNewDeployment to true, so that Amazon ECS starts new tasks with the\n\t\t\tupdated tags.
A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the\n\t\t\tcontainer name, and the container port to access from the load balancer. The container\n\t\t\tname is as it appears in a container definition.
\nWhen you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks\n\t\t\twith the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks\n\t\t\tare running.
\nFor services that use rolling updates, you can add, update, or remove Elastic Load Balancing target\n\t\t\tgroups. You can update from a single target group to multiple target groups and from\n\t\t\tmultiple target groups to a single target group.
\nFor services that use blue/green deployments, you can update Elastic Load Balancing target groups by\n\t\t\tusing \n CreateDeployment\n through CodeDeploy. Note that multiple target groups\n\t\t\tare not supported for blue/green deployments. For more information see Register\n\t\t\t\tmultiple target groups with a service in the Amazon Elastic Container Service Developer Guide.
For services that use the external deployment controller, you can add, update, or\n\t\t\tremove load balancers by using CreateTaskSet.\n\t\t\tNote that multiple target groups are not supported for external deployments. For more\n\t\t\tinformation see Register\n\t\t\t\tmultiple target groups with a service in the Amazon Elastic Container Service Developer Guide.
\nYou can remove existing loadBalancers by passing an empty list.
A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and\n\t\t\tthe container port to access from the load balancer. The container name is as it appears in a container\n\t\t\tdefinition.
\nWhen you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the\n\t\t\tupdated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running.
\nFor services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups. You can\n\t\t\tupdate from a single target group to multiple target groups and from multiple target groups to a single\n\t\t\ttarget group.
\nFor services that use blue/green deployments, you can update Elastic Load Balancing target groups by using\n\t\t\t\t\t\n CreateDeployment\n \n\t\t\tthrough CodeDeploy. Note that multiple target groups are not supported for blue/green deployments. For more\n\t\t\tinformation see Register multiple target\n\t\t\t\tgroups with a service in the Amazon Elastic Container Service Developer Guide.
For services that use the external deployment controller, you can add, update, or remove load\n\t\t\tbalancers by using CreateTaskSet. Note that\n\t\t\tmultiple target groups are not supported for external deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.
\nYou can remove existing loadBalancers by passing an empty list.
Determines whether to propagate the tags from the task definition or the service to\n\t\t\tthe task. If no value is specified, the tags aren't propagated.
\nOnly tasks launched after the update will reflect the update. To update the tags on\n\t\t\tall tasks, set forceNewDeployment to true, so that Amazon ECS\n\t\t\tstarts new tasks with the updated tags.
Determines whether to propagate the tags from the task definition or the service to the task. If no\n\t\t\tvalue is specified, the tags aren't propagated.
\nOnly tasks launched after the update will reflect the update. To update the tags on all tasks, set\n\t\t\t\tforceNewDeployment to true, so that Amazon ECS starts new tasks with the\n\t\t\tupdated tags.
The details for the service discovery registries to assign to this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.
\nWhen you add, update, or remove the service registries configuration, Amazon ECS starts new\n\t\t\ttasks with the updated service registries configuration, and then stops the old tasks\n\t\t\twhen the new tasks are running.
\nYou can remove existing serviceRegistries by passing an empty\n\t\t\tlist.
The details for the service discovery registries to assign to this service. For more information, see\n\t\t\t\tService\n\t\t\t\tDiscovery.
\nWhen you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the\n\t\t\tupdated service registries configuration, and then stops the old tasks when the new tasks are\n\t\t\trunning.
\nYou can remove existing serviceRegistries by passing an empty list.
The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tthe size, volumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration. The name of the volume\n\t\t\tmust match the name from the task definition. If set to null, no new\n\t\t\tdeployment is triggered. Otherwise, if this configuration differs from the existing one,\n\t\t\tit triggers a new deployment.
The details of the volume that was configuredAtLaunch. You can configure the size,\n\t\t\tvolumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the\n\t\t\t\tname from the task definition. If set to null, no new deployment is triggered.\n\t\t\tOtherwise, if this configuration differs from the existing one, it triggers a new deployment.
An object representing the VPC Lattice configuration for the service being updated.
" } } }, @@ -13985,7 +14009,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the protection status of a task. You can set protectionEnabled to\n\t\t\t\ttrue to protect your task from termination during scale-in events from\n\t\t\t\tService\n\t\t\t\tAutoscaling or deployments.
Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the\n\t\t\t\tprotectionEnabled property making the task eligible for termination by\n\t\t\ta subsequent scale-in event.
You can specify a custom expiration period for task protection from 1 minute to up to\n\t\t\t2,880 minutes (48 hours). To specify the custom expiration period, set the\n\t\t\t\texpiresInMinutes property. The expiresInMinutes property\n\t\t\tis always reset when you invoke this operation for a task that already has\n\t\t\t\tprotectionEnabled set to true. You can keep extending the\n\t\t\tprotection expiration period of a task by invoking this operation repeatedly.
To learn more about Amazon ECS task protection, see Task scale-in\n\t\t\t\tprotection in the \n Amazon Elastic Container Service Developer Guide\n .
\nThis operation is only supported for tasks belonging to an Amazon ECS service. Invoking\n\t\t\t\tthis operation for a standalone task will result in an TASK_NOT_VALID\n\t\t\t\tfailure. For more information, see API failure\n\t\t\t\t\treasons.
If you prefer to set task protection from within the container, we recommend using\n\t\t\t\tthe Task scale-in protection endpoint.
\nUpdates the protection status of a task. You can set protectionEnabled to\n\t\t\t\ttrue to protect your task from termination during scale-in events from Service\n\t\t\t\tAutoscaling or deployments.
Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the\n\t\t\t\tprotectionEnabled property making the task eligible for termination by a subsequent\n\t\t\tscale-in event.
You can specify a custom expiration period for task protection from 1 minute to up to 2,880 minutes\n\t\t\t(48 hours). To specify the custom expiration period, set the expiresInMinutes property.\n\t\t\tThe expiresInMinutes property is always reset when you invoke this operation for a task\n\t\t\tthat already has protectionEnabled set to true. You can keep extending the\n\t\t\tprotection expiration period of a task by invoking this operation repeatedly.
To learn more about Amazon ECS task protection, see Task scale-in\n\t\t\t\tprotection in the \n Amazon Elastic Container Service Developer Guide\n .
\nThis operation is only supported for tasks belonging to an Amazon ECS service. Invoking this operation\n\t\t\t\tfor a standalone task will result in an TASK_NOT_VALID failure. For more information,\n\t\t\t\tsee API failure reasons.
If you prefer to set task protection from within the container, we recommend using the Task scale-in\n\t\t\t\t\tprotection endpoint.
\nThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tsets exist in.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist\n\t\t\tin.
", "smithy.api#required": {} } }, @@ -14068,14 +14092,14 @@ "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specify true to mark a task for protection and false to\n\t\t\tunset protection, making it eligible for termination.
Specify true to mark a task for protection and false to unset protection,\n\t\t\tmaking it eligible for termination.
If you set protectionEnabled to true, you can specify the\n\t\t\tduration for task protection in minutes. You can specify a value from 1 minute to up to\n\t\t\t2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in\n\t\t\tevents from Service Auto Scaling or deployments. After this time period lapses,\n\t\t\t\tprotectionEnabled will be reset to false.
If you don’t specify the time, then the task is automatically protected for 120\n\t\t\tminutes (2 hours).
" + "smithy.api#documentation": "If you set protectionEnabled to true, you can specify the duration for task\n\t\t\tprotection in minutes. You can specify a value from 1 minute to up to 2,880 minutes (48 hours). During\n\t\t\tthis time, your task will not be terminated by scale-in events from Service Auto Scaling or\n\t\t\tdeployments. After this time period lapses, protectionEnabled will be reset to\n\t\t\t\tfalse.
If you don’t specify the time, then the task is automatically protected for 120 minutes (2\n\t\t\thours).
" } } }, @@ -14089,7 +14113,7 @@ "protectedTasks": { "target": "com.amazonaws.ecs#ProtectedTasks", "traits": { - "smithy.api#documentation": "A list of tasks with the following information.
\n\n taskArn: The task ARN.
\n protectionEnabled: The protection status of the task. If scale-in\n\t\t\t\t\tprotection is turned on for a task, the value is true. Otherwise,\n\t\t\t\t\tit is false.
\n expirationDate: The epoch time when protection for the task will\n\t\t\t\t\texpire.
A list of tasks with the following information.
\n\n taskArn: The task ARN.
\n protectionEnabled: The protection status of the task. If scale-in protection is\n\t\t\t\t\tturned on for a task, the value is true. Otherwise, it is\n\t\t\t\t\tfalse.
\n expirationDate: The epoch time when protection for the task will expire.
Modifies a task set. This is used when a service uses the EXTERNAL\n\t\t\tdeployment controller type. For more information, see Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
Modifies a task set. This is used when a service uses the EXTERNAL deployment controller\n\t\t\ttype. For more information, see Amazon ECS Deployment Types in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset is found in.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set is found\n\t\t\tin.
", "smithy.api#required": {} } }, @@ -14171,7 +14195,7 @@ "scale": { "target": "com.amazonaws.ecs#Scale", "traits": { - "smithy.api#documentation": "A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.
", + "smithy.api#documentation": "A floating-point percentage of the desired number of tasks to place and keep running in the task\n\t\t\tset.
", "smithy.api#required": {} } } @@ -14206,7 +14230,7 @@ "agentHash": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent\n\t\t\t GitHub repository.
" + "smithy.api#documentation": "The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub\n\t\t\trepository.
" } }, "dockerVersion": { @@ -14217,7 +14241,7 @@ } }, "traits": { - "smithy.api#documentation": "The Docker and Amazon ECS container agent version information about a container\n\t\t\tinstance.
" + "smithy.api#documentation": "The Docker and Amazon ECS container agent version information about a container instance.
" } }, "com.amazonaws.ecs#Volume": { @@ -14226,42 +14250,42 @@ "name": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
\nWhen using a volume configured at launch, the name is required and must\n\t\t\talso be specified as the volume name in the ServiceVolumeConfiguration or\n\t\t\t\tTaskVolumeConfiguration parameter when creating your service or\n\t\t\tstandalone task.
For all other types of volumes, this name is referenced in the\n\t\t\t\tsourceVolume parameter of the mountPoints object in the\n\t\t\tcontainer definition.
When a volume is using the efsVolumeConfiguration, the name is\n\t\t\trequired.
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
\nWhen using a volume configured at launch, the name is required and must also be\n\t\t\tspecified as the volume name in the ServiceVolumeConfiguration or\n\t\t\t\tTaskVolumeConfiguration parameter when creating your service or standalone\n\t\t\ttask.
For all other types of volumes, this name is referenced in the sourceVolume parameter of\n\t\t\tthe mountPoints object in the container definition.
When a volume is using the efsVolumeConfiguration, the name is required.
This parameter is specified when you use bind mount host volumes. The contents of the\n\t\t\t\thost parameter determine whether your bind mount host volume persists\n\t\t\ton the host container instance and where it's stored. If the host parameter\n\t\t\tis empty, then the Docker daemon assigns a host path for your data volume. However, the\n\t\t\tdata isn't guaranteed to persist after the containers that are associated with it stop\n\t\t\trunning.
Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData. Windows containers can't mount directories on a\n\t\t\tdifferent drive, and mount point can't be across drives. For example, you can mount\n\t\t\t\tC:\\my\\path:C:\\my\\path and D:\\:D:\\, but not\n\t\t\t\tD:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.
This parameter is specified when you use bind mount host volumes. The contents of the\n\t\t\t\thost parameter determine whether your bind mount host volume persists on the host\n\t\t\tcontainer instance and where it's stored. If the host parameter is empty, then the Docker\n\t\t\tdaemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after\n\t\t\tthe containers that are associated with it stop running.
Windows containers can mount whole directories on the same drive as $env:ProgramData.\n\t\t\tWindows containers can't mount directories on a different drive, and mount point can't be across\n\t\t\tdrives. For example, you can mount C:\\my\\path:C:\\my\\path and D:\\:D:\\, but not\n\t\t\t\tD:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.
This parameter is specified when you use Docker volumes.
\nWindows containers only support the use of the local driver. To use bind\n\t\t\tmounts, specify the host parameter instead.
Docker volumes aren't supported by tasks run on Fargate.
\nThis parameter is specified when you use Docker volumes.
\nWindows containers only support the use of the local driver. To use bind mounts, specify\n\t\t\tthe host parameter instead.
Docker volumes aren't supported by tasks run on Fargate.
\nThis parameter is specified when you use an Amazon Elastic File System file system for task\n\t\t\tstorage.
" + "smithy.api#documentation": "This parameter is specified when you use an Amazon Elastic File System file system for task storage.
" } }, "fsxWindowsFileServerVolumeConfiguration": { "target": "com.amazonaws.ecs#FSxWindowsFileServerVolumeConfiguration", "traits": { - "smithy.api#documentation": "This parameter is specified when you use Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.
" + "smithy.api#documentation": "This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
" } }, "configuredAtLaunch": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "Indicates whether the volume should be configured at launch time. This is used to\n\t\t\tcreate Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each\n\t\t\ttask definition revision may only have one volume configured at launch in the volume\n\t\t\tconfiguration.
\nTo configure a volume at launch time, use this task definition revision and specify a\n\t\t\t\tvolumeConfigurations object when calling the\n\t\t\tCreateService, UpdateService, RunTask or\n\t\t\t\tStartTask APIs.
Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS\n\t\t\tvolumes for standalone tasks or tasks created as part of a service. Each task definition revision may\n\t\t\tonly have one volume configured at launch in the volume configuration.
\nTo configure a volume at launch time, use this task definition revision and specify a\n\t\t\t\tvolumeConfigurations object when calling the CreateService,\n\t\t\t\tUpdateService, RunTask or StartTask APIs.
The data volume configuration for tasks launched using this task definition.\n\t\t\tSpecifying a volume configuration in a task definition is optional. The volume\n\t\t\tconfiguration may contain multiple volumes but only one volume configured at launch is\n\t\t\tsupported. Each volume defined in the volume configuration may only specify a\n\t\t\t\tname and one of either configuredAtLaunch,\n\t\t\t\tdockerVolumeConfiguration, efsVolumeConfiguration,\n\t\t\t\tfsxWindowsFileServerVolumeConfiguration, or host. If an\n\t\t\tempty volume configuration is specified, by default Amazon ECS uses a host volume. For more\n\t\t\tinformation, see Using data volumes in\n\t\t\t\ttasks.
The data volume configuration for tasks launched using this task definition. Specifying a volume\n\t\t\tconfiguration in a task definition is optional. The volume configuration may contain multiple volumes\n\t\t\tbut only one volume configured at launch is supported. Each volume defined in the volume configuration\n\t\t\tmay only specify a name and one of either configuredAtLaunch,\n\t\t\t\tdockerVolumeConfiguration, efsVolumeConfiguration,\n\t\t\t\tfsxWindowsFileServerVolumeConfiguration, or host. If an empty volume\n\t\t\tconfiguration is specified, by default Amazon ECS uses a host volume. For more information, see Using data\n\t\t\t\tvolumes in tasks.
The name of another container within the same task definition to mount volumes\n\t\t\tfrom.
" + "smithy.api#documentation": "The name of another container within the same task definition to mount volumes from.
" } }, "readOnly": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "If this value is true, the container has read-only access to the volume.\n\t\t\tIf this value is false, then the container can write to the volume. The\n\t\t\tdefault value is false.
If this value is true, the container has read-only access to the volume. If this value\n\t\t\tis false, then the container can write to the volume. The default value is\n\t\t\t\tfalse.
The ARN of the IAM role to associate with this VPC Lattice configuration. This is the Amazon ECS\u2028\n\t\t\tinfrastructure IAM role that is used to manage your VPC Lattice infrastructure.
", + "smithy.api#required": {} + } + }, + "targetGroupArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the target group or groups associated with the VPC Lattice\n\t\t\tconfiguration that the Amazon ECS tasks will be registered to.
", + "smithy.api#required": {} + } + }, + "portName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the port mapping to register in the VPC Lattice target group. This is the \n\t\t\tname of the portMapping you defined in your task definition.
The VPC Lattice configuration for your service that holds the information for the target group(s) \n\t\t\tAmazon ECS tasks will be registered to.
" + } + }, + "com.amazonaws.ecs#VpcLatticeConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#VpcLatticeConfiguration" + } } } }