aws-sdk 2.1024.0 → 2.1028.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +24 -1
- package/README.md +1 -1
- package/apis/backup-2018-11-15.min.json +92 -59
- package/apis/batch-2016-08-10.examples.json +30 -6
- package/apis/batch-2016-08-10.min.json +267 -72
- package/apis/batch-2016-08-10.paginators.json +6 -0
- package/apis/connect-2017-08-08.min.json +258 -62
- package/apis/connect-2017-08-08.paginators.json +5 -0
- package/apis/devops-guru-2020-12-01.min.json +477 -144
- package/apis/devops-guru-2020-12-01.paginators.json +27 -7
- package/apis/ec2-2016-11-15.min.json +650 -645
- package/apis/ecs-2014-11-13.min.json +100 -78
- package/apis/greengrassv2-2020-11-30.min.json +2 -1
- package/apis/metadata.json +3 -0
- package/apis/resiliencehub-2020-04-30.examples.json +5 -0
- package/apis/resiliencehub-2020-04-30.min.json +1863 -0
- package/apis/resiliencehub-2020-04-30.paginators.json +74 -0
- package/apis/translate-2017-07-01.min.json +28 -13
- package/clients/all.d.ts +1 -0
- package/clients/all.js +2 -1
- package/clients/backup.d.ts +13 -0
- package/clients/batch.d.ts +239 -23
- package/clients/connect.d.ts +265 -28
- package/clients/devopsguru.d.ts +420 -63
- package/clients/dynamodb.d.ts +61 -61
- package/clients/ec2.d.ts +5 -1
- package/clients/ecs.d.ts +380 -345
- package/clients/greengrassv2.d.ts +8 -4
- package/clients/health.d.ts +49 -49
- package/clients/mediaconvert.d.ts +16 -16
- package/clients/resiliencehub.d.ts +2101 -0
- package/clients/resiliencehub.js +18 -0
- package/clients/ssm.d.ts +4 -4
- package/clients/translate.d.ts +34 -5
- package/dist/aws-sdk-core-react-native.js +116 -101
- package/dist/aws-sdk-react-native.js +181 -171
- package/dist/aws-sdk.js +1326 -1025
- package/dist/aws-sdk.min.js +71 -71
- package/lib/config-base.d.ts +8 -0
- package/lib/config.js +14 -2
- package/lib/config_service_placeholders.d.ts +2 -0
- package/lib/config_use_dualstack.d.ts +3 -0
- package/lib/core.js +1 -1
- package/lib/dynamodb/document_client.d.ts +39 -39
- package/lib/metadata_service/get_endpoint.js +8 -0
- package/lib/metadata_service/get_endpoint_config_options.js +12 -0
- package/lib/metadata_service/get_endpoint_mode.js +8 -0
- package/lib/metadata_service/get_endpoint_mode_config_options.js +14 -0
- package/lib/metadata_service/get_metadata_service_endpoint.js +4 -4
- package/lib/node_loader.js +63 -21
- package/lib/region/utils.js +21 -0
- package/lib/region_config.js +12 -55
- package/lib/region_config_data.json +102 -59
- package/lib/service.js +20 -1
- package/lib/services/s3util.js +2 -1
- package/package.json +1 -1
- package/scripts/region-checker/allowlist.js +5 -5
- package/lib/metadata_service/endpoint.js +0 -6
- package/lib/metadata_service/endpoint_config_options.js +0 -14
- package/lib/metadata_service/endpoint_mode.js +0 -6
- package/lib/metadata_service/endpoint_mode_config_options.js +0 -16
package/clients/ecs.d.ts
CHANGED
|
@@ -13,27 +13,27 @@ declare class ECS extends Service {
|
|
|
13
13
|
constructor(options?: ECS.Types.ClientConfiguration)
|
|
14
14
|
config: Config & ECS.Types.ClientConfiguration;
|
|
15
15
|
/**
|
|
16
|
-
* 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
|
|
16
|
+
* 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.
|
|
17
17
|
*/
|
|
18
18
|
createCapacityProvider(params: ECS.Types.CreateCapacityProviderRequest, callback?: (err: AWSError, data: ECS.Types.CreateCapacityProviderResponse) => void): Request<ECS.Types.CreateCapacityProviderResponse, AWSError>;
|
|
19
19
|
/**
|
|
20
|
-
* 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
|
|
20
|
+
* 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.
|
|
21
21
|
*/
|
|
22
22
|
createCapacityProvider(callback?: (err: AWSError, data: ECS.Types.CreateCapacityProviderResponse) => void): Request<ECS.Types.CreateCapacityProviderResponse, AWSError>;
|
|
23
23
|
/**
|
|
24
|
-
* 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 with the CreateCluster action. When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account so that required resources in other Amazon Web Services services
|
|
24
|
+
* 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 with the CreateCluster action. 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 IAM 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.
|
|
25
25
|
*/
|
|
26
26
|
createCluster(params: ECS.Types.CreateClusterRequest, callback?: (err: AWSError, data: ECS.Types.CreateClusterResponse) => void): Request<ECS.Types.CreateClusterResponse, AWSError>;
|
|
27
27
|
/**
|
|
28
|
-
* 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 with the CreateCluster action. When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account so that required resources in other Amazon Web Services services
|
|
28
|
+
* 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 with the CreateCluster action. 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 IAM 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.
|
|
29
29
|
*/
|
|
30
30
|
createCluster(callback?: (err: AWSError, data: ECS.Types.CreateClusterResponse) => void): Request<ECS.Types.CreateClusterResponse, AWSError>;
|
|
31
31
|
/**
|
|
32
|
-
* Runs and maintains
|
|
32
|
+
* 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. 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. 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 the container instance that they're hosted on is 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. 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. This is done with an UpdateService operation. 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 operation. 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 in your cluster using the following logic: Determine which of the container instances in your cluster can support the task definition of your service. 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. This is the case even if you can choose a different placement strategy with the placementStrategy parameter. Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. 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.
|
|
33
33
|
*/
|
|
34
34
|
createService(params: ECS.Types.CreateServiceRequest, callback?: (err: AWSError, data: ECS.Types.CreateServiceResponse) => void): Request<ECS.Types.CreateServiceResponse, AWSError>;
|
|
35
35
|
/**
|
|
36
|
-
* Runs and maintains
|
|
36
|
+
* 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. 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. 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 the container instance that they're hosted on is 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. 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. This is done with an UpdateService operation. 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 operation. 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 in your cluster using the following logic: Determine which of the container instances in your cluster can support the task definition of your service. 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. This is the case even if you can choose a different placement strategy with the placementStrategy parameter. Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. 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.
|
|
37
37
|
*/
|
|
38
38
|
createService(callback?: (err: AWSError, data: ECS.Types.CreateServiceResponse) => void): Request<ECS.Types.CreateServiceResponse, AWSError>;
|
|
39
39
|
/**
|
|
@@ -61,27 +61,27 @@ declare class ECS extends Service {
|
|
|
61
61
|
*/
|
|
62
62
|
deleteAttributes(callback?: (err: AWSError, data: ECS.Types.DeleteAttributesResponse) => void): Request<ECS.Types.DeleteAttributesResponse, AWSError>;
|
|
63
63
|
/**
|
|
64
|
-
* Deletes the specified capacity provider. The FARGATE and FARGATE_SPOT capacity providers are reserved and
|
|
64
|
+
* Deletes the specified capacity provider. The FARGATE and FARGATE_SPOT capacity providers are reserved and can't be deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders API or by deleting the cluster. 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 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 PutClusterCapacityProviders or delete the cluster.
|
|
65
65
|
*/
|
|
66
66
|
deleteCapacityProvider(params: ECS.Types.DeleteCapacityProviderRequest, callback?: (err: AWSError, data: ECS.Types.DeleteCapacityProviderResponse) => void): Request<ECS.Types.DeleteCapacityProviderResponse, AWSError>;
|
|
67
67
|
/**
|
|
68
|
-
* Deletes the specified capacity provider. The FARGATE and FARGATE_SPOT capacity providers are reserved and
|
|
68
|
+
* Deletes the specified capacity provider. The FARGATE and FARGATE_SPOT capacity providers are reserved and can't be deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders API or by deleting the cluster. 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 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 PutClusterCapacityProviders or delete the cluster.
|
|
69
69
|
*/
|
|
70
70
|
deleteCapacityProvider(callback?: (err: AWSError, data: ECS.Types.DeleteCapacityProviderResponse) => void): Request<ECS.Types.DeleteCapacityProviderResponse, AWSError>;
|
|
71
71
|
/**
|
|
72
|
-
* Deletes the specified cluster. The cluster
|
|
72
|
+
* Deletes the specified cluster. The cluster transitions to the 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. 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.
|
|
73
73
|
*/
|
|
74
74
|
deleteCluster(params: ECS.Types.DeleteClusterRequest, callback?: (err: AWSError, data: ECS.Types.DeleteClusterResponse) => void): Request<ECS.Types.DeleteClusterResponse, AWSError>;
|
|
75
75
|
/**
|
|
76
|
-
* Deletes the specified cluster. The cluster
|
|
76
|
+
* Deletes the specified cluster. The cluster transitions to the 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. 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.
|
|
77
77
|
*/
|
|
78
78
|
deleteCluster(callback?: (err: AWSError, data: ECS.Types.DeleteClusterResponse) => void): Request<ECS.Types.DeleteClusterResponse, AWSError>;
|
|
79
79
|
/**
|
|
80
|
-
* 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
|
|
80
|
+
* 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 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. If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error.
|
|
81
81
|
*/
|
|
82
82
|
deleteService(params: ECS.Types.DeleteServiceRequest, callback?: (err: AWSError, data: ECS.Types.DeleteServiceResponse) => void): Request<ECS.Types.DeleteServiceResponse, AWSError>;
|
|
83
83
|
/**
|
|
84
|
-
* 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
|
|
84
|
+
* 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 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. If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error.
|
|
85
85
|
*/
|
|
86
86
|
deleteService(callback?: (err: AWSError, data: ECS.Types.DeleteServiceResponse) => void): Request<ECS.Types.DeleteServiceResponse, AWSError>;
|
|
87
87
|
/**
|
|
@@ -93,19 +93,19 @@ declare class ECS extends Service {
|
|
|
93
93
|
*/
|
|
94
94
|
deleteTaskSet(callback?: (err: AWSError, data: ECS.Types.DeleteTaskSetResponse) => void): Request<ECS.Types.DeleteTaskSetResponse, AWSError>;
|
|
95
95
|
/**
|
|
96
|
-
* 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, you
|
|
96
|
+
* 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).
|
|
97
97
|
*/
|
|
98
98
|
deregisterContainerInstance(params: ECS.Types.DeregisterContainerInstanceRequest, callback?: (err: AWSError, data: ECS.Types.DeregisterContainerInstanceResponse) => void): Request<ECS.Types.DeregisterContainerInstanceResponse, AWSError>;
|
|
99
99
|
/**
|
|
100
|
-
* 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, you
|
|
100
|
+
* 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).
|
|
101
101
|
*/
|
|
102
102
|
deregisterContainerInstance(callback?: (err: AWSError, data: ECS.Types.DeregisterContainerInstanceResponse) => void): Request<ECS.Types.DeregisterContainerInstanceResponse, AWSError>;
|
|
103
103
|
/**
|
|
104
|
-
* 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. You
|
|
104
|
+
* 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. 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.
|
|
105
105
|
*/
|
|
106
106
|
deregisterTaskDefinition(params: ECS.Types.DeregisterTaskDefinitionRequest, callback?: (err: AWSError, data: ECS.Types.DeregisterTaskDefinitionResponse) => void): Request<ECS.Types.DeregisterTaskDefinitionResponse, AWSError>;
|
|
107
107
|
/**
|
|
108
|
-
* 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. You
|
|
108
|
+
* 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. 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.
|
|
109
109
|
*/
|
|
110
110
|
deregisterTaskDefinition(callback?: (err: AWSError, data: ECS.Types.DeregisterTaskDefinitionResponse) => void): Request<ECS.Types.DeregisterTaskDefinitionResponse, AWSError>;
|
|
111
111
|
/**
|
|
@@ -189,11 +189,11 @@ declare class ECS extends Service {
|
|
|
189
189
|
*/
|
|
190
190
|
listAccountSettings(callback?: (err: AWSError, data: ECS.Types.ListAccountSettingsResponse) => void): Request<ECS.Types.ListAccountSettingsResponse, AWSError>;
|
|
191
191
|
/**
|
|
192
|
-
* Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, 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, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).
|
|
192
|
+
* Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, 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).
|
|
193
193
|
*/
|
|
194
194
|
listAttributes(params: ECS.Types.ListAttributesRequest, callback?: (err: AWSError, data: ECS.Types.ListAttributesResponse) => void): Request<ECS.Types.ListAttributesResponse, AWSError>;
|
|
195
195
|
/**
|
|
196
|
-
* Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, 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, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).
|
|
196
|
+
* Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, 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).
|
|
197
197
|
*/
|
|
198
198
|
listAttributes(callback?: (err: AWSError, data: ECS.Types.ListAttributesResponse) => void): Request<ECS.Types.ListAttributesResponse, AWSError>;
|
|
199
199
|
/**
|
|
@@ -229,11 +229,11 @@ declare class ECS extends Service {
|
|
|
229
229
|
*/
|
|
230
230
|
listTagsForResource(callback?: (err: AWSError, data: ECS.Types.ListTagsForResourceResponse) => void): Request<ECS.Types.ListTagsForResourceResponse, AWSError>;
|
|
231
231
|
/**
|
|
232
|
-
* Returns a list of task definition families that are registered to your account
|
|
232
|
+
* Returns a list of task definition families that are registered to your account. This list includes task 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 definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.
|
|
233
233
|
*/
|
|
234
234
|
listTaskDefinitionFamilies(params: ECS.Types.ListTaskDefinitionFamiliesRequest, callback?: (err: AWSError, data: ECS.Types.ListTaskDefinitionFamiliesResponse) => void): Request<ECS.Types.ListTaskDefinitionFamiliesResponse, AWSError>;
|
|
235
235
|
/**
|
|
236
|
-
* Returns a list of task definition families that are registered to your account
|
|
236
|
+
* Returns a list of task definition families that are registered to your account. This list includes task 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 definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.
|
|
237
237
|
*/
|
|
238
238
|
listTaskDefinitionFamilies(callback?: (err: AWSError, data: ECS.Types.ListTaskDefinitionFamiliesResponse) => void): Request<ECS.Types.ListTaskDefinitionFamiliesResponse, AWSError>;
|
|
239
239
|
/**
|
|
@@ -253,11 +253,11 @@ declare class ECS extends Service {
|
|
|
253
253
|
*/
|
|
254
254
|
listTasks(callback?: (err: AWSError, data: ECS.Types.ListTasksResponse) => void): Request<ECS.Types.ListTasksResponse, AWSError>;
|
|
255
255
|
/**
|
|
256
|
-
* Modifies an account setting. Account settings are set on a per-Region basis. If you change the account setting for the root user, the default settings for all of the IAM users and roles
|
|
256
|
+
* Modifies an account setting. Account settings are set on a per-Region basis. If you change the account setting for the root user, the default settings for all of the IAM users and roles that no individual account setting was specified are reset for. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide. When serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat are specified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified IAM user, IAM 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 IAM user or role that created the resource. You must enable this setting to use Amazon ECS features such as resource tagging. When awsvpcTrunking is specified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is enabled, 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. When containerInsights is specified, the default setting indicating whether CloudWatch Container Insights is enabled for your clusters is changed. If containerInsights is enabled, any new clusters that are created will have Container Insights enabled unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.
|
|
257
257
|
*/
|
|
258
258
|
putAccountSetting(params: ECS.Types.PutAccountSettingRequest, callback?: (err: AWSError, data: ECS.Types.PutAccountSettingResponse) => void): Request<ECS.Types.PutAccountSettingResponse, AWSError>;
|
|
259
259
|
/**
|
|
260
|
-
* Modifies an account setting. Account settings are set on a per-Region basis. If you change the account setting for the root user, the default settings for all of the IAM users and roles
|
|
260
|
+
* Modifies an account setting. Account settings are set on a per-Region basis. If you change the account setting for the root user, the default settings for all of the IAM users and roles that no individual account setting was specified are reset for. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide. When serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat are specified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified IAM user, IAM 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 IAM user or role that created the resource. You must enable this setting to use Amazon ECS features such as resource tagging. When awsvpcTrunking is specified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is enabled, 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. When containerInsights is specified, the default setting indicating whether CloudWatch Container Insights is enabled for your clusters is changed. If containerInsights is enabled, any new clusters that are created will have Container Insights enabled unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.
|
|
261
261
|
*/
|
|
262
262
|
putAccountSetting(callback?: (err: AWSError, data: ECS.Types.PutAccountSettingResponse) => void): Request<ECS.Types.PutAccountSettingResponse, AWSError>;
|
|
263
263
|
/**
|
|
@@ -269,19 +269,19 @@ declare class ECS extends Service {
|
|
|
269
269
|
*/
|
|
270
270
|
putAccountSettingDefault(callback?: (err: AWSError, data: ECS.Types.PutAccountSettingDefaultResponse) => void): Request<ECS.Types.PutAccountSettingDefaultResponse, AWSError>;
|
|
271
271
|
/**
|
|
272
|
-
* Create or update an attribute on an Amazon ECS resource. If the attribute
|
|
272
|
+
* 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.
|
|
273
273
|
*/
|
|
274
274
|
putAttributes(params: ECS.Types.PutAttributesRequest, callback?: (err: AWSError, data: ECS.Types.PutAttributesResponse) => void): Request<ECS.Types.PutAttributesResponse, AWSError>;
|
|
275
275
|
/**
|
|
276
|
-
* Create or update an attribute on an Amazon ECS resource. If the attribute
|
|
276
|
+
* 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.
|
|
277
277
|
*/
|
|
278
278
|
putAttributes(callback?: (err: AWSError, data: ECS.Types.PutAttributesResponse) => void): Request<ECS.Types.PutAttributesResponse, AWSError>;
|
|
279
279
|
/**
|
|
280
|
-
* 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 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.
|
|
280
|
+
* 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 ([]) to bypass defining a default strategy.
|
|
281
281
|
*/
|
|
282
282
|
putClusterCapacityProviders(params: ECS.Types.PutClusterCapacityProvidersRequest, callback?: (err: AWSError, data: ECS.Types.PutClusterCapacityProvidersResponse) => void): Request<ECS.Types.PutClusterCapacityProvidersResponse, AWSError>;
|
|
283
283
|
/**
|
|
284
|
-
* 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 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.
|
|
284
|
+
* 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 ([]) to bypass defining a default strategy.
|
|
285
285
|
*/
|
|
286
286
|
putClusterCapacityProviders(callback?: (err: AWSError, data: ECS.Types.PutClusterCapacityProvidersResponse) => void): Request<ECS.Types.PutClusterCapacityProvidersResponse, AWSError>;
|
|
287
287
|
/**
|
|
@@ -293,19 +293,19 @@ declare class ECS extends Service {
|
|
|
293
293
|
*/
|
|
294
294
|
registerContainerInstance(callback?: (err: AWSError, data: ECS.Types.RegisterContainerInstanceResponse) => void): Request<ECS.Types.RegisterContainerInstanceResponse, AWSError>;
|
|
295
295
|
/**
|
|
296
|
-
* Registers a new task definition from the supplied 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 Definitions in the Amazon Elastic Container Service Developer Guide. You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM 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 IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide. You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. 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.
|
|
296
|
+
* Registers a new task definition from the supplied 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 Definitions in the Amazon Elastic Container Service Developer Guide. You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM 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 IAM policy that's associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide. You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. 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.
|
|
297
297
|
*/
|
|
298
298
|
registerTaskDefinition(params: ECS.Types.RegisterTaskDefinitionRequest, callback?: (err: AWSError, data: ECS.Types.RegisterTaskDefinitionResponse) => void): Request<ECS.Types.RegisterTaskDefinitionResponse, AWSError>;
|
|
299
299
|
/**
|
|
300
|
-
* Registers a new task definition from the supplied 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 Definitions in the Amazon Elastic Container Service Developer Guide. You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM 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 IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide. You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. 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.
|
|
300
|
+
* Registers a new task definition from the supplied 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 Definitions in the Amazon Elastic Container Service Developer Guide. You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM 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 IAM policy that's associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide. You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. 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.
|
|
301
301
|
*/
|
|
302
302
|
registerTaskDefinition(callback?: (err: AWSError, data: ECS.Types.RegisterTaskDefinitionResponse) => void): Request<ECS.Types.RegisterTaskDefinitionResponse, AWSError>;
|
|
303
303
|
/**
|
|
304
|
-
* Starts a new task using the specified task definition. 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 StartTask to use your own scheduler or place tasks manually on specific container instances. The Amazon ECS API follows an eventual consistency model
|
|
304
|
+
* Starts a new task using the specified task definition. 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 StartTask to use your own scheduler or place tasks manually on specific container instances. The Amazon ECS API follows an eventual consistency model. This is because 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. 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.
|
|
305
305
|
*/
|
|
306
306
|
runTask(params: ECS.Types.RunTaskRequest, callback?: (err: AWSError, data: ECS.Types.RunTaskResponse) => void): Request<ECS.Types.RunTaskResponse, AWSError>;
|
|
307
307
|
/**
|
|
308
|
-
* Starts a new task using the specified task definition. 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 StartTask to use your own scheduler or place tasks manually on specific container instances. The Amazon ECS API follows an eventual consistency model
|
|
308
|
+
* Starts a new task using the specified task definition. 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 StartTask to use your own scheduler or place tasks manually on specific container instances. The Amazon ECS API follows an eventual consistency model. This is because 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. 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.
|
|
309
309
|
*/
|
|
310
310
|
runTask(callback?: (err: AWSError, data: ECS.Types.RunTaskResponse) => void): Request<ECS.Types.RunTaskResponse, AWSError>;
|
|
311
311
|
/**
|
|
@@ -349,11 +349,11 @@ declare class ECS extends Service {
|
|
|
349
349
|
*/
|
|
350
350
|
submitTaskStateChange(callback?: (err: AWSError, data: ECS.Types.SubmitTaskStateChangeResponse) => void): Request<ECS.Types.SubmitTaskStateChangeResponse, AWSError>;
|
|
351
351
|
/**
|
|
352
|
-
* Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource
|
|
352
|
+
* 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.
|
|
353
353
|
*/
|
|
354
354
|
tagResource(params: ECS.Types.TagResourceRequest, callback?: (err: AWSError, data: ECS.Types.TagResourceResponse) => void): Request<ECS.Types.TagResourceResponse, AWSError>;
|
|
355
355
|
/**
|
|
356
|
-
* Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource
|
|
356
|
+
* 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.
|
|
357
357
|
*/
|
|
358
358
|
tagResource(callback?: (err: AWSError, data: ECS.Types.TagResourceResponse) => void): Request<ECS.Types.TagResourceResponse, AWSError>;
|
|
359
359
|
/**
|
|
@@ -389,27 +389,27 @@ declare class ECS extends Service {
|
|
|
389
389
|
*/
|
|
390
390
|
updateClusterSettings(callback?: (err: AWSError, data: ECS.Types.UpdateClusterSettingsResponse) => void): Request<ECS.Types.UpdateClusterSettingsResponse, AWSError>;
|
|
391
391
|
/**
|
|
392
|
-
* Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent
|
|
392
|
+
* 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 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.
|
|
393
393
|
*/
|
|
394
394
|
updateContainerAgent(params: ECS.Types.UpdateContainerAgentRequest, callback?: (err: AWSError, data: ECS.Types.UpdateContainerAgentResponse) => void): Request<ECS.Types.UpdateContainerAgentResponse, AWSError>;
|
|
395
395
|
/**
|
|
396
|
-
* Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent
|
|
396
|
+
* 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 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.
|
|
397
397
|
*/
|
|
398
398
|
updateContainerAgent(callback?: (err: AWSError, data: ECS.Types.UpdateContainerAgentResponse) => void): Request<ECS.Types.UpdateContainerAgentResponse, AWSError>;
|
|
399
399
|
/**
|
|
400
|
-
* 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. A container instance
|
|
400
|
+
* 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. 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. 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 the container instance they're hosted on is 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. 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.
|
|
401
401
|
*/
|
|
402
402
|
updateContainerInstancesState(params: ECS.Types.UpdateContainerInstancesStateRequest, callback?: (err: AWSError, data: ECS.Types.UpdateContainerInstancesStateResponse) => void): Request<ECS.Types.UpdateContainerInstancesStateResponse, AWSError>;
|
|
403
403
|
/**
|
|
404
|
-
* 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. A container instance
|
|
404
|
+
* 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. 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. 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 the container instance they're hosted on is 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. 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.
|
|
405
405
|
*/
|
|
406
406
|
updateContainerInstancesState(callback?: (err: AWSError, data: ECS.Types.UpdateContainerInstancesStateResponse) => void): Request<ECS.Types.UpdateContainerInstancesStateResponse, AWSError>;
|
|
407
407
|
/**
|
|
408
|
-
* Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws.amazon.com/service-terms ("Beta Terms"). These Beta Terms apply to your participation in this preview. Modifies the parameters of a service. For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, task placement constraints and strategies, or task definition used can be updated. For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, task placement constraints and strategies, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new CodeDeploy deployment
|
|
408
|
+
* Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws.amazon.com/service-terms ("Beta Terms"). These Beta Terms apply to your participation in this preview. Modifies the parameters of a service. For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, task placement constraints and strategies, or task definition used can be updated. For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, task placement constraints and strategies, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new CodeDeploy deployment is created. 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, and health check grace period 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. If you have updated the Docker 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. 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 the container instance they're hosted on is 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). 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. 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. 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: 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.
|
|
409
409
|
*/
|
|
410
410
|
updateService(params: ECS.Types.UpdateServiceRequest, callback?: (err: AWSError, data: ECS.Types.UpdateServiceResponse) => void): Request<ECS.Types.UpdateServiceResponse, AWSError>;
|
|
411
411
|
/**
|
|
412
|
-
* Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws.amazon.com/service-terms ("Beta Terms"). These Beta Terms apply to your participation in this preview. Modifies the parameters of a service. For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, task placement constraints and strategies, or task definition used can be updated. For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, task placement constraints and strategies, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new CodeDeploy deployment
|
|
412
|
+
* Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws.amazon.com/service-terms ("Beta Terms"). These Beta Terms apply to your participation in this preview. Modifies the parameters of a service. For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, task placement constraints and strategies, or task definition used can be updated. For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, task placement constraints and strategies, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new CodeDeploy deployment is created. 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, and health check grace period 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. If you have updated the Docker 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. 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 the container instance they're hosted on is 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). 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. 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. 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: 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.
|
|
413
413
|
*/
|
|
414
414
|
updateService(callback?: (err: AWSError, data: ECS.Types.UpdateServiceResponse) => void): Request<ECS.Types.UpdateServiceResponse, AWSError>;
|
|
415
415
|
/**
|
|
@@ -497,15 +497,15 @@ declare namespace ECS {
|
|
|
497
497
|
export type Attachments = Attachment[];
|
|
498
498
|
export interface Attribute {
|
|
499
499
|
/**
|
|
500
|
-
* The name of the attribute. The name must contain between 1 and 128 characters
|
|
500
|
+
* 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 (.).
|
|
501
501
|
*/
|
|
502
502
|
name: String;
|
|
503
503
|
/**
|
|
504
|
-
* The value of the attribute. The value must contain between 1 and 128 characters
|
|
504
|
+
* 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 can't start or end with a space.
|
|
505
505
|
*/
|
|
506
506
|
value?: String;
|
|
507
507
|
/**
|
|
508
|
-
* The type of the target
|
|
508
|
+
* 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.
|
|
509
509
|
*/
|
|
510
510
|
targetType?: TargetType;
|
|
511
511
|
/**
|
|
@@ -524,7 +524,7 @@ declare namespace ECS {
|
|
|
524
524
|
*/
|
|
525
525
|
managedScaling?: ManagedScaling;
|
|
526
526
|
/**
|
|
527
|
-
* 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
|
|
527
|
+
* 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 managed termination protection is enabled, 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 enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide. When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.
|
|
528
528
|
*/
|
|
529
529
|
managedTerminationProtection?: ManagedTerminationProtection;
|
|
530
530
|
}
|
|
@@ -534,17 +534,17 @@ declare namespace ECS {
|
|
|
534
534
|
*/
|
|
535
535
|
managedScaling?: ManagedScaling;
|
|
536
536
|
/**
|
|
537
|
-
* 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
|
|
537
|
+
* 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 managed termination protection is enabled, 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 enabled. For more information, see Instance Protection in the Auto Scaling User Guide. When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.
|
|
538
538
|
*/
|
|
539
539
|
managedTerminationProtection?: ManagedTerminationProtection;
|
|
540
540
|
}
|
|
541
541
|
export interface AwsVpcConfiguration {
|
|
542
542
|
/**
|
|
543
|
-
* The IDs of the subnets associated with the task or service. There
|
|
543
|
+
* 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.
|
|
544
544
|
*/
|
|
545
545
|
subnets: StringList;
|
|
546
546
|
/**
|
|
547
|
-
* The IDs of the security groups associated with the task or service. If you
|
|
547
|
+
* 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.
|
|
548
548
|
*/
|
|
549
549
|
securityGroups?: StringList;
|
|
550
550
|
/**
|
|
@@ -566,7 +566,7 @@ declare namespace ECS {
|
|
|
566
566
|
*/
|
|
567
567
|
name?: String;
|
|
568
568
|
/**
|
|
569
|
-
* The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it
|
|
569
|
+
* The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.
|
|
570
570
|
*/
|
|
571
571
|
status?: CapacityProviderStatus;
|
|
572
572
|
/**
|
|
@@ -574,7 +574,7 @@ declare namespace ECS {
|
|
|
574
574
|
*/
|
|
575
575
|
autoScalingGroupProvider?: AutoScalingGroupProvider;
|
|
576
576
|
/**
|
|
577
|
-
* The update status of the capacity provider. The following are the possible states that
|
|
577
|
+
* The update status of the capacity provider. The following are the possible states that is returned. DELETE_IN_PROGRESS The capacity provider is in the process of being deleted. DELETE_COMPLETE The capacity provider was successfully deleted and has an INACTIVE status. DELETE_FAILED The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.
|
|
578
578
|
*/
|
|
579
579
|
updateStatus?: CapacityProviderUpdateStatus;
|
|
580
580
|
/**
|
|
@@ -582,7 +582,7 @@ declare namespace ECS {
|
|
|
582
582
|
*/
|
|
583
583
|
updateStatusReason?: String;
|
|
584
584
|
/**
|
|
585
|
-
* 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
|
|
585
|
+
* 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: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
|
|
586
586
|
*/
|
|
587
587
|
tags?: Tags;
|
|
588
588
|
}
|
|
@@ -596,7 +596,7 @@ declare namespace ECS {
|
|
|
596
596
|
*/
|
|
597
597
|
capacityProvider: String;
|
|
598
598
|
/**
|
|
599
|
-
* 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
|
|
599
|
+
* 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.
|
|
600
600
|
*/
|
|
601
601
|
weight?: CapacityProviderStrategyItemWeight;
|
|
602
602
|
/**
|
|
@@ -622,7 +622,7 @@ declare namespace ECS {
|
|
|
622
622
|
*/
|
|
623
623
|
configuration?: ClusterConfiguration;
|
|
624
624
|
/**
|
|
625
|
-
* The status of the cluster. The following are the possible states that
|
|
625
|
+
* The status of the cluster. The following are the possible states that are returned. ACTIVE The cluster is ready to accept tasks and if applicable you can register container instances with the cluster. PROVISIONING The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being created. DEPROVISIONING The cluster has capacity providers that are associated with it and the resources needed for the capacity provider are being deleted. FAILED The cluster has capacity providers that are associated with it and the resources needed for the capacity provider have failed to create. INACTIVE 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.
|
|
626
626
|
*/
|
|
627
627
|
status?: String;
|
|
628
628
|
/**
|
|
@@ -642,11 +642,11 @@ declare namespace ECS {
|
|
|
642
642
|
*/
|
|
643
643
|
activeServicesCount?: Integer;
|
|
644
644
|
/**
|
|
645
|
-
* Additional information about your clusters that are separated by launch type
|
|
645
|
+
* Additional information about your clusters that are separated by launch type. They include the following: runningEC2TasksCount RunningFargateTasksCount pendingEC2TasksCount pendingFargateTasksCount activeEC2ServiceCount activeFargateServiceCount drainingEC2ServiceCount drainingFargateServiceCount
|
|
646
646
|
*/
|
|
647
647
|
statistics?: Statistics;
|
|
648
648
|
/**
|
|
649
|
-
* 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
|
|
649
|
+
* 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: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
|
|
650
650
|
*/
|
|
651
651
|
tags?: Tags;
|
|
652
652
|
/**
|
|
@@ -662,11 +662,11 @@ declare namespace ECS {
|
|
|
662
662
|
*/
|
|
663
663
|
defaultCapacityProviderStrategy?: CapacityProviderStrategy;
|
|
664
664
|
/**
|
|
665
|
-
* The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that
|
|
665
|
+
* The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that's created is returned as a cluster attachment.
|
|
666
666
|
*/
|
|
667
667
|
attachments?: Attachments;
|
|
668
668
|
/**
|
|
669
|
-
* The status of the capacity providers associated with the cluster. The following are the states that
|
|
669
|
+
* The status of the capacity providers associated with the cluster. The following are the states that are returned. UPDATE_IN_PROGRESS The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning. UPDATE_COMPLETE The capacity providers have successfully updated. UPDATE_FAILED The capacity provider updates failed.
|
|
670
670
|
*/
|
|
671
671
|
attachmentsStatus?: String;
|
|
672
672
|
}
|
|
@@ -740,7 +740,7 @@ declare namespace ECS {
|
|
|
740
740
|
*/
|
|
741
741
|
networkInterfaces?: NetworkInterfaces;
|
|
742
742
|
/**
|
|
743
|
-
* The health status of the container. If health checks
|
|
743
|
+
* 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.
|
|
744
744
|
*/
|
|
745
745
|
healthStatus?: HealthStatus;
|
|
746
746
|
/**
|
|
@@ -748,7 +748,7 @@ declare namespace ECS {
|
|
|
748
748
|
*/
|
|
749
749
|
managedAgents?: ManagedAgents;
|
|
750
750
|
/**
|
|
751
|
-
* The number of CPU units set for the container. The value
|
|
751
|
+
* 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.
|
|
752
752
|
*/
|
|
753
753
|
cpu?: String;
|
|
754
754
|
/**
|
|
@@ -767,11 +767,11 @@ declare namespace ECS {
|
|
|
767
767
|
export type ContainerCondition = "START"|"COMPLETE"|"SUCCESS"|"HEALTHY"|string;
|
|
768
768
|
export interface ContainerDefinition {
|
|
769
769
|
/**
|
|
770
|
-
* The name of a container. If you
|
|
770
|
+
* 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 Create a container section of the Docker Remote API and the --name option to docker run.
|
|
771
771
|
*/
|
|
772
772
|
name?: String;
|
|
773
773
|
/**
|
|
774
|
-
* The image used to start a container. This string is passed directly to the Docker daemon.
|
|
774
|
+
* 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 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 Create a container section of the Docker Remote API 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. Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. Images in official repositories on Docker Hub use a single name (for example, 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 online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
|
|
775
775
|
*/
|
|
776
776
|
image?: String;
|
|
777
777
|
/**
|
|
@@ -779,15 +779,15 @@ declare namespace ECS {
|
|
|
779
779
|
*/
|
|
780
780
|
repositoryCredentials?: RepositoryCredentials;
|
|
781
781
|
/**
|
|
782
|
-
* The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and 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. 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
|
|
782
|
+
* The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and 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. 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. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), 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 greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2. 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.
|
|
783
783
|
*/
|
|
784
784
|
cpu?: Integer;
|
|
785
785
|
/**
|
|
786
|
-
* 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 Create a container section of the Docker Remote API 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
|
|
786
|
+
* 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 Create a container section of the Docker Remote API 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 daemon reserves a minimum of 4 MiB of memory for a container. Therefore, we recommend that you specify fewer than 4 MiB of memory for your containers.
|
|
787
787
|
*/
|
|
788
788
|
memory?: BoxedInteger;
|
|
789
789
|
/**
|
|
790
|
-
* 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 Create a container section of the Docker Remote API 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
|
|
790
|
+
* 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 Create a container section of the Docker Remote API 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 daemon reserves a minimum of 4 MiB of memory for a container. Therefore, we recommend that you specify fewer than 4 MiB of memory for your containers.
|
|
791
791
|
*/
|
|
792
792
|
memoryReservation?: BoxedInteger;
|
|
793
793
|
/**
|
|
@@ -795,31 +795,31 @@ declare namespace ECS {
|
|
|
795
795
|
*/
|
|
796
796
|
links?: StringList;
|
|
797
797
|
/**
|
|
798
|
-
* 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,
|
|
798
|
+
* 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. 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 Create a container section of the Docker Remote API 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 responses.
|
|
799
799
|
*/
|
|
800
800
|
portMappings?: PortMappingList;
|
|
801
801
|
/**
|
|
802
|
-
* 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,
|
|
802
|
+
* 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.
|
|
803
803
|
*/
|
|
804
804
|
essential?: BoxedBoolean;
|
|
805
805
|
/**
|
|
806
|
-
* Early versions of the Amazon ECS container agent
|
|
806
|
+
* 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 Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.
|
|
807
807
|
*/
|
|
808
808
|
entryPoint?: StringList;
|
|
809
809
|
/**
|
|
810
|
-
* The command that
|
|
810
|
+
* The command that's passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array.
|
|
811
811
|
*/
|
|
812
812
|
command?: StringList;
|
|
813
813
|
/**
|
|
814
|
-
* The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run. We
|
|
814
|
+
* The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run. We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.
|
|
815
815
|
*/
|
|
816
816
|
environment?: EnvironmentVariables;
|
|
817
817
|
/**
|
|
818
|
-
* 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
|
|
818
|
+
* 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. For more information about the environment variable file syntax, see Declare default environment variables in file. 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.
|
|
819
819
|
*/
|
|
820
820
|
environmentFiles?: EnvironmentFiles;
|
|
821
821
|
/**
|
|
822
|
-
* The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run. Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers
|
|
822
|
+
* The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API 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.
|
|
823
823
|
*/
|
|
824
824
|
mountPoints?: MountPointList;
|
|
825
825
|
/**
|
|
@@ -835,27 +835,27 @@ declare namespace ECS {
|
|
|
835
835
|
*/
|
|
836
836
|
secrets?: SecretList;
|
|
837
837
|
/**
|
|
838
|
-
* 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. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable 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
|
|
838
|
+
* 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. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable 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. Windows platform version 1.0.0 or later.
|
|
839
839
|
*/
|
|
840
840
|
dependsOn?: ContainerDependencies;
|
|
841
841
|
/**
|
|
842
|
-
* 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
|
|
842
|
+
* 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. 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 enable 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.
|
|
843
843
|
*/
|
|
844
844
|
startTimeout?: BoxedInteger;
|
|
845
845
|
/**
|
|
846
|
-
* 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
|
|
846
|
+
* 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. 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 enable 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.
|
|
847
847
|
*/
|
|
848
848
|
stopTimeout?: BoxedInteger;
|
|
849
849
|
/**
|
|
850
|
-
* The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run. The hostname parameter is not supported if you
|
|
850
|
+
* The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run. The hostname parameter is not supported if you're using the awsvpc network mode.
|
|
851
851
|
*/
|
|
852
852
|
hostname?: String;
|
|
853
853
|
/**
|
|
854
|
-
* The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run. When running tasks using the host network mode,
|
|
854
|
+
* The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API 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. You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer. user user:group uid uid:gid user:gid uid:group This parameter is not supported for Windows containers.
|
|
855
855
|
*/
|
|
856
856
|
user?: String;
|
|
857
857
|
/**
|
|
858
|
-
* The working directory
|
|
858
|
+
* The working directory to run commands inside the container in. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.
|
|
859
859
|
*/
|
|
860
860
|
workingDirectory?: String;
|
|
861
861
|
/**
|
|
@@ -879,15 +879,15 @@ declare namespace ECS {
|
|
|
879
879
|
*/
|
|
880
880
|
dnsSearchDomains?: StringList;
|
|
881
881
|
/**
|
|
882
|
-
* 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 Create a container section of the Docker Remote API and the --add-host option to docker run. This parameter
|
|
882
|
+
* 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 Create a container section of the Docker Remote API and the --add-host option to docker run. This parameter isn't supported for Windows containers or tasks that use the awsvpc network mode.
|
|
883
883
|
*/
|
|
884
884
|
extraHosts?: HostEntryList;
|
|
885
885
|
/**
|
|
886
|
-
* A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field
|
|
886
|
+
* A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field isn't valid for containers in tasks using the Fargate launch type. With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide. This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --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. For more information about valid values, see Docker Run Security Configuration. Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
|
|
887
887
|
*/
|
|
888
888
|
dockerSecurityOptions?: StringList;
|
|
889
889
|
/**
|
|
890
|
-
* When this parameter is true,
|
|
890
|
+
* 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 Create a container section of the Docker Remote API and the --interactive option to docker run.
|
|
891
891
|
*/
|
|
892
892
|
interactive?: BoxedBoolean;
|
|
893
893
|
/**
|
|
@@ -899,11 +899,11 @@ declare namespace ECS {
|
|
|
899
899
|
*/
|
|
900
900
|
dockerLabels?: DockerLabelsMap;
|
|
901
901
|
/**
|
|
902
|
-
* A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it
|
|
902
|
+
* 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 Create a container section of the Docker Remote API 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 overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and hard limit is 4096. 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}}' This parameter is not supported for Windows containers.
|
|
903
903
|
*/
|
|
904
904
|
ulimits?: UlimitList;
|
|
905
905
|
/**
|
|
906
|
-
* The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container
|
|
906
|
+
* The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API 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). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation. 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.
|
|
907
907
|
*/
|
|
908
908
|
logConfiguration?: LogConfiguration;
|
|
909
909
|
/**
|
|
@@ -911,7 +911,7 @@ declare namespace ECS {
|
|
|
911
911
|
*/
|
|
912
912
|
healthCheck?: HealthCheck;
|
|
913
913
|
/**
|
|
914
|
-
* A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.
|
|
914
|
+
* A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run. We don't recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that's started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.
|
|
915
915
|
*/
|
|
916
916
|
systemControls?: SystemControls;
|
|
917
917
|
/**
|
|
@@ -931,7 +931,7 @@ declare namespace ECS {
|
|
|
931
931
|
*/
|
|
932
932
|
containerName: String;
|
|
933
933
|
/**
|
|
934
|
-
* 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. 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
|
|
934
|
+
* 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. 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. 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.
|
|
935
935
|
*/
|
|
936
936
|
condition: ContainerCondition;
|
|
937
937
|
}
|
|
@@ -945,11 +945,11 @@ declare namespace ECS {
|
|
|
945
945
|
*/
|
|
946
946
|
ec2InstanceId?: String;
|
|
947
947
|
/**
|
|
948
|
-
* The capacity provider associated with the container instance.
|
|
948
|
+
* The capacity provider that's associated with the container instance.
|
|
949
949
|
*/
|
|
950
950
|
capacityProviderName?: String;
|
|
951
951
|
/**
|
|
952
|
-
* 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
|
|
952
|
+
* 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 detail object) to verify that the version in your event stream is current.
|
|
953
953
|
*/
|
|
954
954
|
version?: Long;
|
|
955
955
|
/**
|
|
@@ -957,7 +957,7 @@ declare namespace ECS {
|
|
|
957
957
|
*/
|
|
958
958
|
versionInfo?: VersionInfo;
|
|
959
959
|
/**
|
|
960
|
-
* For CPU and memory resource types, this parameter describes the remaining CPU and memory that
|
|
960
|
+
* 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 host or bridge network mode). Any port that's not specified here is available for new tasks.
|
|
961
961
|
*/
|
|
962
962
|
remainingResources?: Resources;
|
|
963
963
|
/**
|
|
@@ -965,7 +965,7 @@ declare namespace ECS {
|
|
|
965
965
|
*/
|
|
966
966
|
registeredResources?: Resources;
|
|
967
967
|
/**
|
|
968
|
-
* The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING. If your account has opted in to the 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. The ACTIVE status indicates that the container instance can accept tasks. The DRAINING indicates that new tasks
|
|
968
|
+
* The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING. If your account has opted in to the 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. The 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.
|
|
969
969
|
*/
|
|
970
970
|
status?: String;
|
|
971
971
|
/**
|
|
@@ -985,7 +985,7 @@ declare namespace ECS {
|
|
|
985
985
|
*/
|
|
986
986
|
pendingTasksCount?: Integer;
|
|
987
987
|
/**
|
|
988
|
-
* The status of the most recent agent update. If an update
|
|
988
|
+
* The status of the most recent agent update. If an update wasn't ever requested, this value is NULL.
|
|
989
989
|
*/
|
|
990
990
|
agentUpdateStatus?: AgentUpdateStatus;
|
|
991
991
|
/**
|
|
@@ -993,7 +993,7 @@ declare namespace ECS {
|
|
|
993
993
|
*/
|
|
994
994
|
attributes?: Attributes;
|
|
995
995
|
/**
|
|
996
|
-
* The Unix timestamp for when the container instance was registered.
|
|
996
|
+
* The Unix timestamp for the time when the container instance was registered.
|
|
997
997
|
*/
|
|
998
998
|
registeredAt?: Timestamp;
|
|
999
999
|
/**
|
|
@@ -1001,12 +1001,26 @@ declare namespace ECS {
|
|
|
1001
1001
|
*/
|
|
1002
1002
|
attachments?: Attachments;
|
|
1003
1003
|
/**
|
|
1004
|
-
* 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
|
|
1004
|
+
* 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: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
|
|
1005
1005
|
*/
|
|
1006
1006
|
tags?: Tags;
|
|
1007
|
+
/**
|
|
1008
|
+
* An object representing the health status of the container instance.
|
|
1009
|
+
*/
|
|
1010
|
+
healthStatus?: ContainerInstanceHealthStatus;
|
|
1007
1011
|
}
|
|
1008
|
-
export type ContainerInstanceField = "TAGS"|string;
|
|
1012
|
+
export type ContainerInstanceField = "TAGS"|"CONTAINER_INSTANCE_HEALTH"|string;
|
|
1009
1013
|
export type ContainerInstanceFieldList = ContainerInstanceField[];
|
|
1014
|
+
export interface ContainerInstanceHealthStatus {
|
|
1015
|
+
/**
|
|
1016
|
+
* The overall health status of the container instance. This is an aggregate status of all container instance health checks.
|
|
1017
|
+
*/
|
|
1018
|
+
overallStatus?: InstanceHealthCheckState;
|
|
1019
|
+
/**
|
|
1020
|
+
* An array of objects representing the details of the container instance health status.
|
|
1021
|
+
*/
|
|
1022
|
+
details?: InstanceHealthCheckResultList;
|
|
1023
|
+
}
|
|
1010
1024
|
export type ContainerInstanceStatus = "ACTIVE"|"DRAINING"|"REGISTERING"|"DEREGISTERING"|"REGISTRATION_FAILED"|string;
|
|
1011
1025
|
export type ContainerInstances = ContainerInstance[];
|
|
1012
1026
|
export interface ContainerOverride {
|
|
@@ -1062,7 +1076,7 @@ declare namespace ECS {
|
|
|
1062
1076
|
*/
|
|
1063
1077
|
exitCode?: BoxedInteger;
|
|
1064
1078
|
/**
|
|
1065
|
-
* Any network bindings associated with the container.
|
|
1079
|
+
* Any network bindings that are associated with the container.
|
|
1066
1080
|
*/
|
|
1067
1081
|
networkBindings?: NetworkBindings;
|
|
1068
1082
|
/**
|
|
@@ -1078,7 +1092,7 @@ declare namespace ECS {
|
|
|
1078
1092
|
export type Containers = Container[];
|
|
1079
1093
|
export interface CreateCapacityProviderRequest {
|
|
1080
1094
|
/**
|
|
1081
|
-
* The name of the capacity provider. Up to 255 characters are allowed
|
|
1095
|
+
* 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 "aws", "ecs", or "fargate".
|
|
1082
1096
|
*/
|
|
1083
1097
|
name: String;
|
|
1084
1098
|
/**
|
|
@@ -1086,7 +1100,7 @@ declare namespace ECS {
|
|
|
1086
1100
|
*/
|
|
1087
1101
|
autoScalingGroupProvider: AutoScalingGroupProvider;
|
|
1088
1102
|
/**
|
|
1089
|
-
* The metadata that you apply to the capacity provider to
|
|
1103
|
+
* 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: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
|
|
1090
1104
|
*/
|
|
1091
1105
|
tags?: Tags;
|
|
1092
1106
|
}
|
|
@@ -1098,15 +1112,15 @@ declare namespace ECS {
|
|
|
1098
1112
|
}
|
|
1099
1113
|
export interface CreateClusterRequest {
|
|
1100
1114
|
/**
|
|
1101
|
-
* The name of your cluster. If you
|
|
1115
|
+
* 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.
|
|
1102
1116
|
*/
|
|
1103
1117
|
clusterName?: String;
|
|
1104
1118
|
/**
|
|
1105
|
-
* 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
|
|
1119
|
+
* 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: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
|
|
1106
1120
|
*/
|
|
1107
1121
|
tags?: Tags;
|
|
1108
1122
|
/**
|
|
1109
|
-
* The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it
|
|
1123
|
+
* The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
|
|
1110
1124
|
*/
|
|
1111
1125
|
settings?: ClusterSettings;
|
|
1112
1126
|
/**
|
|
@@ -1114,11 +1128,11 @@ declare namespace ECS {
|
|
|
1114
1128
|
*/
|
|
1115
1129
|
configuration?: ClusterConfiguration;
|
|
1116
1130
|
/**
|
|
1117
|
-
* 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
|
|
1131
|
+
* 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 PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
|
|
1118
1132
|
*/
|
|
1119
1133
|
capacityProviders?: StringList;
|
|
1120
1134
|
/**
|
|
1121
|
-
* The capacity provider strategy to set as the default for the cluster.
|
|
1135
|
+
* 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 RunTask or CreateService 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.
|
|
1122
1136
|
*/
|
|
1123
1137
|
defaultCapacityProviderStrategy?: CapacityProviderStrategy;
|
|
1124
1138
|
}
|
|
@@ -1130,7 +1144,7 @@ declare namespace ECS {
|
|
|
1130
1144
|
}
|
|
1131
1145
|
export interface CreateServiceRequest {
|
|
1132
1146
|
/**
|
|
1133
|
-
* The short name or full Amazon Resource Name (ARN) of the cluster
|
|
1147
|
+
* The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
|
|
1134
1148
|
*/
|
|
1135
1149
|
cluster?: String;
|
|
1136
1150
|
/**
|
|
@@ -1138,27 +1152,27 @@ declare namespace ECS {
|
|
|
1138
1152
|
*/
|
|
1139
1153
|
serviceName: String;
|
|
1140
1154
|
/**
|
|
1141
|
-
* The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision
|
|
1155
|
+
* 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.
|
|
1142
1156
|
*/
|
|
1143
1157
|
taskDefinition?: String;
|
|
1144
1158
|
/**
|
|
1145
|
-
* 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
|
|
1159
|
+
* 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. After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port that's specified in the service definition are immutable. 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.
|
|
1146
1160
|
*/
|
|
1147
1161
|
loadBalancers?: LoadBalancers;
|
|
1148
1162
|
/**
|
|
1149
|
-
* 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
|
|
1163
|
+
* 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.
|
|
1150
1164
|
*/
|
|
1151
1165
|
serviceRegistries?: ServiceRegistries;
|
|
1152
1166
|
/**
|
|
1153
|
-
* The number of instantiations of the specified task definition to place and keep running on your cluster. This is required if schedulingStrategy is REPLICA or
|
|
1167
|
+
* The number of instantiations of the specified task definition to place and keep running on your cluster. This is required if schedulingStrategy is REPLICA or isn't specified. If schedulingStrategy is DAEMON then this isn't required.
|
|
1154
1168
|
*/
|
|
1155
1169
|
desiredCount?: BoxedInteger;
|
|
1156
1170
|
/**
|
|
1157
|
-
*
|
|
1171
|
+
* An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 32 ASCII characters are allowed.
|
|
1158
1172
|
*/
|
|
1159
1173
|
clientToken?: String;
|
|
1160
1174
|
/**
|
|
1161
|
-
* The infrastructure
|
|
1175
|
+
* 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 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. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate. The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster. The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster. A service can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
|
|
1162
1176
|
*/
|
|
1163
1177
|
launchType?: LaunchType;
|
|
1164
1178
|
/**
|
|
@@ -1166,11 +1180,11 @@ declare namespace ECS {
|
|
|
1166
1180
|
*/
|
|
1167
1181
|
capacityProviderStrategy?: CapacityProviderStrategy;
|
|
1168
1182
|
/**
|
|
1169
|
-
* 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 LATEST platform version is used
|
|
1183
|
+
* 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 LATEST platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
|
|
1170
1184
|
*/
|
|
1171
1185
|
platformVersion?: String;
|
|
1172
1186
|
/**
|
|
1173
|
-
* 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
|
|
1187
|
+
* 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 awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter. 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 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. If your specified role has a path other than /, 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.
|
|
1174
1188
|
*/
|
|
1175
1189
|
role?: String;
|
|
1176
1190
|
/**
|
|
@@ -1178,23 +1192,23 @@ declare namespace ECS {
|
|
|
1178
1192
|
*/
|
|
1179
1193
|
deploymentConfiguration?: DeploymentConfiguration;
|
|
1180
1194
|
/**
|
|
1181
|
-
* An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints
|
|
1195
|
+
* 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.
|
|
1182
1196
|
*/
|
|
1183
1197
|
placementConstraints?: PlacementConstraints;
|
|
1184
1198
|
/**
|
|
1185
|
-
* The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules
|
|
1199
|
+
* The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
|
|
1186
1200
|
*/
|
|
1187
1201
|
placementStrategy?: PlacementStrategies;
|
|
1188
1202
|
/**
|
|
1189
|
-
* The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it
|
|
1203
|
+
* The network configuration for the service. This parameter is required for task definitions that use the 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.
|
|
1190
1204
|
*/
|
|
1191
1205
|
networkConfiguration?: NetworkConfiguration;
|
|
1192
1206
|
/**
|
|
1193
|
-
* The period of time, in seconds, that the Amazon ECS service scheduler
|
|
1207
|
+
* 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 0 is used. 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.
|
|
1194
1208
|
*/
|
|
1195
1209
|
healthCheckGracePeriodSeconds?: BoxedInteger;
|
|
1196
1210
|
/**
|
|
1197
|
-
* The scheduling strategy to use for the service. For more information, see Services. There are two service scheduler strategies available: 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
|
|
1211
|
+
* The scheduling strategy to use for the service. For more information, see Services. There are two service scheduler strategies available: 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 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.
|
|
1198
1212
|
*/
|
|
1199
1213
|
schedulingStrategy?: SchedulingStrategy;
|
|
1200
1214
|
/**
|
|
@@ -1210,17 +1224,17 @@ declare namespace ECS {
|
|
|
1210
1224
|
*/
|
|
1211
1225
|
enableECSManagedTags?: Boolean;
|
|
1212
1226
|
/**
|
|
1213
|
-
* Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags
|
|
1227
|
+
* Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation or task creation, use the TagResource API action.
|
|
1214
1228
|
*/
|
|
1215
1229
|
propagateTags?: PropagateTags;
|
|
1216
1230
|
/**
|
|
1217
|
-
*
|
|
1231
|
+
* Determines whether the execute command functionality is enabled for the service. If true, this enables execute command functionality on all containers in the service tasks.
|
|
1218
1232
|
*/
|
|
1219
1233
|
enableExecuteCommand?: Boolean;
|
|
1220
1234
|
}
|
|
1221
1235
|
export interface CreateServiceResponse {
|
|
1222
1236
|
/**
|
|
1223
|
-
* The full description of your service following the create call. A service will return either a capacityProviderStrategy or launchType parameter, but not both, depending
|
|
1237
|
+
* 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. If a service is using the ECS deployment controller, the 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.
|
|
1224
1238
|
*/
|
|
1225
1239
|
service?: Service;
|
|
1226
1240
|
}
|
|
@@ -1254,7 +1268,7 @@ declare namespace ECS {
|
|
|
1254
1268
|
*/
|
|
1255
1269
|
serviceRegistries?: ServiceRegistries;
|
|
1256
1270
|
/**
|
|
1257
|
-
* The launch type that new tasks in the task set
|
|
1271
|
+
* 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 launchType is specified, the capacityProviderStrategy parameter must be omitted.
|
|
1258
1272
|
*/
|
|
1259
1273
|
launchType?: LaunchType;
|
|
1260
1274
|
/**
|
|
@@ -1262,7 +1276,7 @@ declare namespace ECS {
|
|
|
1262
1276
|
*/
|
|
1263
1277
|
capacityProviderStrategy?: CapacityProviderStrategy;
|
|
1264
1278
|
/**
|
|
1265
|
-
* The platform version that the tasks in the task set
|
|
1279
|
+
* 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.
|
|
1266
1280
|
*/
|
|
1267
1281
|
platformVersion?: String;
|
|
1268
1282
|
/**
|
|
@@ -1270,11 +1284,11 @@ declare namespace ECS {
|
|
|
1270
1284
|
*/
|
|
1271
1285
|
scale?: Scale;
|
|
1272
1286
|
/**
|
|
1273
|
-
*
|
|
1287
|
+
* The identifier that you provide to ensure the idempotency of the request. It's case sensitive and must be unique. It can be up to 32 ASCII characters are allowed.
|
|
1274
1288
|
*/
|
|
1275
1289
|
clientToken?: String;
|
|
1276
1290
|
/**
|
|
1277
|
-
* 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
|
|
1291
|
+
* 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: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
|
|
1278
1292
|
*/
|
|
1279
1293
|
tags?: Tags;
|
|
1280
1294
|
}
|
|
@@ -1286,11 +1300,11 @@ declare namespace ECS {
|
|
|
1286
1300
|
}
|
|
1287
1301
|
export interface DeleteAccountSettingRequest {
|
|
1288
1302
|
/**
|
|
1289
|
-
* The resource name
|
|
1303
|
+
* 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.
|
|
1290
1304
|
*/
|
|
1291
1305
|
name: SettingName;
|
|
1292
1306
|
/**
|
|
1293
|
-
* The ARN of the principal
|
|
1307
|
+
* The Amazon Resource Name (ARN) of the principal. It can be an IAM user, IAM role, or the root user. If you specify the root user, it disables the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
|
|
1294
1308
|
*/
|
|
1295
1309
|
principalArn?: String;
|
|
1296
1310
|
}
|
|
@@ -1306,7 +1320,7 @@ declare namespace ECS {
|
|
|
1306
1320
|
*/
|
|
1307
1321
|
cluster?: String;
|
|
1308
1322
|
/**
|
|
1309
|
-
* The attributes to delete from your resource. You can specify up to 10 attributes
|
|
1323
|
+
* 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.
|
|
1310
1324
|
*/
|
|
1311
1325
|
attributes: Attributes;
|
|
1312
1326
|
}
|
|
@@ -1350,7 +1364,7 @@ declare namespace ECS {
|
|
|
1350
1364
|
*/
|
|
1351
1365
|
service: String;
|
|
1352
1366
|
/**
|
|
1353
|
-
* If true, allows you to delete a service even if it
|
|
1367
|
+
* 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.
|
|
1354
1368
|
*/
|
|
1355
1369
|
force?: BoxedBoolean;
|
|
1356
1370
|
}
|
|
@@ -1362,7 +1376,7 @@ declare namespace ECS {
|
|
|
1362
1376
|
}
|
|
1363
1377
|
export interface DeleteTaskSetRequest {
|
|
1364
1378
|
/**
|
|
1365
|
-
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set
|
|
1379
|
+
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set found in to delete.
|
|
1366
1380
|
*/
|
|
1367
1381
|
cluster: String;
|
|
1368
1382
|
/**
|
|
@@ -1374,7 +1388,7 @@ declare namespace ECS {
|
|
|
1374
1388
|
*/
|
|
1375
1389
|
taskSet: String;
|
|
1376
1390
|
/**
|
|
1377
|
-
* If true,
|
|
1391
|
+
* If true, you can delete a task set even if it hasn't been scaled down to zero.
|
|
1378
1392
|
*/
|
|
1379
1393
|
force?: BoxedBoolean;
|
|
1380
1394
|
}
|
|
@@ -1390,7 +1404,7 @@ declare namespace ECS {
|
|
|
1390
1404
|
*/
|
|
1391
1405
|
id?: String;
|
|
1392
1406
|
/**
|
|
1393
|
-
* The status of the deployment. The following describes each state
|
|
1407
|
+
* The status of the deployment. The following describes each state. PRIMARY The most recent deployment of a service. ACTIVE A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment. INACTIVE A deployment that has been completely replaced.
|
|
1394
1408
|
*/
|
|
1395
1409
|
status?: String;
|
|
1396
1410
|
/**
|
|
@@ -1414,11 +1428,11 @@ declare namespace ECS {
|
|
|
1414
1428
|
*/
|
|
1415
1429
|
failedTasks?: Integer;
|
|
1416
1430
|
/**
|
|
1417
|
-
* The Unix timestamp for when the service deployment was created.
|
|
1431
|
+
* The Unix timestamp for the time when the service deployment was created.
|
|
1418
1432
|
*/
|
|
1419
1433
|
createdAt?: Timestamp;
|
|
1420
1434
|
/**
|
|
1421
|
-
* The Unix timestamp for when the service deployment was last updated.
|
|
1435
|
+
* The Unix timestamp for the time when the service deployment was last updated.
|
|
1422
1436
|
*/
|
|
1423
1437
|
updatedAt?: Timestamp;
|
|
1424
1438
|
/**
|
|
@@ -1430,7 +1444,7 @@ declare namespace ECS {
|
|
|
1430
1444
|
*/
|
|
1431
1445
|
launchType?: LaunchType;
|
|
1432
1446
|
/**
|
|
1433
|
-
* The platform version
|
|
1447
|
+
* 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.
|
|
1434
1448
|
*/
|
|
1435
1449
|
platformVersion?: String;
|
|
1436
1450
|
/**
|
|
@@ -1442,7 +1456,7 @@ declare namespace ECS {
|
|
|
1442
1456
|
*/
|
|
1443
1457
|
networkConfiguration?: NetworkConfiguration;
|
|
1444
1458
|
/**
|
|
1445
|
-
* The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that
|
|
1459
|
+
* 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 enabled, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.
|
|
1446
1460
|
*/
|
|
1447
1461
|
rolloutState?: DeploymentRolloutState;
|
|
1448
1462
|
/**
|
|
@@ -1452,11 +1466,11 @@ declare namespace ECS {
|
|
|
1452
1466
|
}
|
|
1453
1467
|
export interface DeploymentCircuitBreaker {
|
|
1454
1468
|
/**
|
|
1455
|
-
*
|
|
1469
|
+
* Determines whether to enable the deployment circuit breaker logic for the service.
|
|
1456
1470
|
*/
|
|
1457
1471
|
enable: Boolean;
|
|
1458
1472
|
/**
|
|
1459
|
-
*
|
|
1473
|
+
* Determines whether to enable Amazon ECS to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
|
|
1460
1474
|
*/
|
|
1461
1475
|
rollback: Boolean;
|
|
1462
1476
|
}
|
|
@@ -1470,7 +1484,7 @@ declare namespace ECS {
|
|
|
1470
1484
|
*/
|
|
1471
1485
|
maximumPercent?: BoxedInteger;
|
|
1472
1486
|
/**
|
|
1473
|
-
* If a service is using the rolling update (ECS) deployment type, 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, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they
|
|
1487
|
+
* If a service is using the rolling update (ECS) deployment type, 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, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and they're reported as healthy by the load balancer. The default value for minimum healthy percent is 100%. If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and 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. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.
|
|
1474
1488
|
*/
|
|
1475
1489
|
minimumHealthyPercent?: BoxedInteger;
|
|
1476
1490
|
}
|
|
@@ -1493,7 +1507,7 @@ declare namespace ECS {
|
|
|
1493
1507
|
*/
|
|
1494
1508
|
containerInstance: String;
|
|
1495
1509
|
/**
|
|
1496
|
-
* Forces the
|
|
1510
|
+
* Forces the container instance to be deregistered. If you have tasks running on the container instance when you deregister it with the 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. 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.
|
|
1497
1511
|
*/
|
|
1498
1512
|
force?: BoxedBoolean;
|
|
1499
1513
|
}
|
|
@@ -1521,7 +1535,7 @@ declare namespace ECS {
|
|
|
1521
1535
|
*/
|
|
1522
1536
|
capacityProviders?: StringList;
|
|
1523
1537
|
/**
|
|
1524
|
-
* Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags
|
|
1538
|
+
* Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.
|
|
1525
1539
|
*/
|
|
1526
1540
|
include?: CapacityProviderFieldList;
|
|
1527
1541
|
/**
|
|
@@ -1553,7 +1567,7 @@ declare namespace ECS {
|
|
|
1553
1567
|
*/
|
|
1554
1568
|
clusters?: StringList;
|
|
1555
1569
|
/**
|
|
1556
|
-
*
|
|
1570
|
+
* 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. 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.
|
|
1557
1571
|
*/
|
|
1558
1572
|
include?: ClusterFieldList;
|
|
1559
1573
|
}
|
|
@@ -1577,7 +1591,7 @@ declare namespace ECS {
|
|
|
1577
1591
|
*/
|
|
1578
1592
|
containerInstances: StringList;
|
|
1579
1593
|
/**
|
|
1580
|
-
* 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 this field is omitted, tags
|
|
1594
|
+
* 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.
|
|
1581
1595
|
*/
|
|
1582
1596
|
include?: ContainerInstanceFieldList;
|
|
1583
1597
|
}
|
|
@@ -1601,7 +1615,7 @@ declare namespace ECS {
|
|
|
1601
1615
|
*/
|
|
1602
1616
|
services: StringList;
|
|
1603
1617
|
/**
|
|
1604
|
-
*
|
|
1618
|
+
* 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.
|
|
1605
1619
|
*/
|
|
1606
1620
|
include?: ServiceFieldList;
|
|
1607
1621
|
}
|
|
@@ -1621,7 +1635,7 @@ declare namespace ECS {
|
|
|
1621
1635
|
*/
|
|
1622
1636
|
taskDefinition: String;
|
|
1623
1637
|
/**
|
|
1624
|
-
*
|
|
1638
|
+
* 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.
|
|
1625
1639
|
*/
|
|
1626
1640
|
include?: TaskDefinitionFieldList;
|
|
1627
1641
|
}
|
|
@@ -1631,7 +1645,7 @@ declare namespace ECS {
|
|
|
1631
1645
|
*/
|
|
1632
1646
|
taskDefinition?: TaskDefinition;
|
|
1633
1647
|
/**
|
|
1634
|
-
* The metadata that
|
|
1648
|
+
* 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: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
|
|
1635
1649
|
*/
|
|
1636
1650
|
tags?: Tags;
|
|
1637
1651
|
}
|
|
@@ -1649,7 +1663,7 @@ declare namespace ECS {
|
|
|
1649
1663
|
*/
|
|
1650
1664
|
taskSets?: StringList;
|
|
1651
1665
|
/**
|
|
1652
|
-
* Specifies whether to see the resource tags for the task set. If TAGS is specified, the tags are included in the response. If this field is omitted, tags
|
|
1666
|
+
* Specifies whether to see the resource tags for the task set. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.
|
|
1653
1667
|
*/
|
|
1654
1668
|
include?: TaskSetFieldList;
|
|
1655
1669
|
}
|
|
@@ -1673,7 +1687,7 @@ declare namespace ECS {
|
|
|
1673
1687
|
*/
|
|
1674
1688
|
tasks: StringList;
|
|
1675
1689
|
/**
|
|
1676
|
-
* 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
|
|
1690
|
+
* 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.
|
|
1677
1691
|
*/
|
|
1678
1692
|
include?: TaskFieldList;
|
|
1679
1693
|
}
|
|
@@ -1711,7 +1725,7 @@ declare namespace ECS {
|
|
|
1711
1725
|
*/
|
|
1712
1726
|
containerInstance?: String;
|
|
1713
1727
|
/**
|
|
1714
|
-
* The short name or full Amazon Resource Name (ARN) of the cluster
|
|
1728
|
+
* The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs to.
|
|
1715
1729
|
*/
|
|
1716
1730
|
cluster?: String;
|
|
1717
1731
|
}
|
|
@@ -1732,7 +1746,7 @@ declare namespace ECS {
|
|
|
1732
1746
|
*/
|
|
1733
1747
|
scope?: Scope;
|
|
1734
1748
|
/**
|
|
1735
|
-
* If this value is true, the Docker volume is created if it
|
|
1749
|
+
* 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.
|
|
1736
1750
|
*/
|
|
1737
1751
|
autoprovision?: BoxedBoolean;
|
|
1738
1752
|
/**
|
|
@@ -1755,7 +1769,7 @@ declare namespace ECS {
|
|
|
1755
1769
|
*/
|
|
1756
1770
|
accessPointId?: String;
|
|
1757
1771
|
/**
|
|
1758
|
-
*
|
|
1772
|
+
* Determines whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled 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.
|
|
1759
1773
|
*/
|
|
1760
1774
|
iam?: EFSAuthorizationConfigIAM;
|
|
1761
1775
|
}
|
|
@@ -1771,7 +1785,7 @@ declare namespace ECS {
|
|
|
1771
1785
|
*/
|
|
1772
1786
|
rootDirectory?: String;
|
|
1773
1787
|
/**
|
|
1774
|
-
*
|
|
1788
|
+
* Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled 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.
|
|
1775
1789
|
*/
|
|
1776
1790
|
transitEncryption?: EFSTransitEncryption;
|
|
1777
1791
|
/**
|
|
@@ -1822,7 +1836,7 @@ declare namespace ECS {
|
|
|
1822
1836
|
*/
|
|
1823
1837
|
cloudWatchLogGroupName?: String;
|
|
1824
1838
|
/**
|
|
1825
|
-
*
|
|
1839
|
+
* Determines whether to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
|
|
1826
1840
|
*/
|
|
1827
1841
|
cloudWatchEncryptionEnabled?: Boolean;
|
|
1828
1842
|
/**
|
|
@@ -1830,7 +1844,7 @@ declare namespace ECS {
|
|
|
1830
1844
|
*/
|
|
1831
1845
|
s3BucketName?: String;
|
|
1832
1846
|
/**
|
|
1833
|
-
*
|
|
1847
|
+
* Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.
|
|
1834
1848
|
*/
|
|
1835
1849
|
s3EncryptionEnabled?: Boolean;
|
|
1836
1850
|
/**
|
|
@@ -1875,7 +1889,7 @@ declare namespace ECS {
|
|
|
1875
1889
|
*/
|
|
1876
1890
|
containerName?: String;
|
|
1877
1891
|
/**
|
|
1878
|
-
*
|
|
1892
|
+
* Determines whether the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify true for this value.
|
|
1879
1893
|
*/
|
|
1880
1894
|
interactive?: Boolean;
|
|
1881
1895
|
/**
|
|
@@ -1941,7 +1955,7 @@ declare namespace ECS {
|
|
|
1941
1955
|
export type GpuIds = String[];
|
|
1942
1956
|
export interface HealthCheck {
|
|
1943
1957
|
/**
|
|
1944
|
-
* A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute 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,
|
|
1958
|
+
* A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute 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 brackets. [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ] You don't need to include the brackets when you use the Amazon Web Services Management Console. "CMD-SHELL", "curl -f http://localhost/ || exit 1" An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.
|
|
1945
1959
|
*/
|
|
1946
1960
|
command: StringList;
|
|
1947
1961
|
/**
|
|
@@ -1957,7 +1971,7 @@ declare namespace ECS {
|
|
|
1957
1971
|
*/
|
|
1958
1972
|
retries?: BoxedInteger;
|
|
1959
1973
|
/**
|
|
1960
|
-
* The optional grace period
|
|
1974
|
+
* 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 disabled. 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.
|
|
1961
1975
|
*/
|
|
1962
1976
|
startPeriod?: BoxedInteger;
|
|
1963
1977
|
}
|
|
@@ -1975,7 +1989,7 @@ declare namespace ECS {
|
|
|
1975
1989
|
export type HostEntryList = HostEntry[];
|
|
1976
1990
|
export interface HostVolumeProperties {
|
|
1977
1991
|
/**
|
|
1978
|
-
* When the host parameter is used, specify a sourcePath to declare the path on the host container instance that
|
|
1992
|
+
* 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.
|
|
1979
1993
|
*/
|
|
1980
1994
|
sourcePath?: String;
|
|
1981
1995
|
}
|
|
@@ -2001,6 +2015,27 @@ declare namespace ECS {
|
|
|
2001
2015
|
}
|
|
2002
2016
|
export type InferenceAcceleratorOverrides = InferenceAcceleratorOverride[];
|
|
2003
2017
|
export type InferenceAccelerators = InferenceAccelerator[];
|
|
2018
|
+
export interface InstanceHealthCheckResult {
|
|
2019
|
+
/**
|
|
2020
|
+
* The type of container instance health status that was verified.
|
|
2021
|
+
*/
|
|
2022
|
+
type?: InstanceHealthCheckType;
|
|
2023
|
+
/**
|
|
2024
|
+
* The container instance health status.
|
|
2025
|
+
*/
|
|
2026
|
+
status?: InstanceHealthCheckState;
|
|
2027
|
+
/**
|
|
2028
|
+
* The Unix timestamp for when the container instance health status was last updated.
|
|
2029
|
+
*/
|
|
2030
|
+
lastUpdated?: Timestamp;
|
|
2031
|
+
/**
|
|
2032
|
+
* The Unix timestamp for when the container instance health status last changed.
|
|
2033
|
+
*/
|
|
2034
|
+
lastStatusChange?: Timestamp;
|
|
2035
|
+
}
|
|
2036
|
+
export type InstanceHealthCheckResultList = InstanceHealthCheckResult[];
|
|
2037
|
+
export type InstanceHealthCheckState = "OK"|"IMPAIRED"|"INSUFFICIENT_DATA"|"INITIALIZING"|string;
|
|
2038
|
+
export type InstanceHealthCheckType = "CONTAINER_RUNTIME"|string;
|
|
2004
2039
|
export type Integer = number;
|
|
2005
2040
|
export type IpcMode = "host"|"task"|"none"|string;
|
|
2006
2041
|
export interface KernelCapabilities {
|
|
@@ -2030,7 +2065,7 @@ declare namespace ECS {
|
|
|
2030
2065
|
*/
|
|
2031
2066
|
capabilities?: KernelCapabilities;
|
|
2032
2067
|
/**
|
|
2033
|
-
* Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run. If you
|
|
2068
|
+
* Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run. If you're using tasks that use the Fargate launch type, the devices parameter isn't supported.
|
|
2034
2069
|
*/
|
|
2035
2070
|
devices?: DevicesList;
|
|
2036
2071
|
/**
|
|
@@ -2042,15 +2077,15 @@ declare namespace ECS {
|
|
|
2042
2077
|
*/
|
|
2043
2078
|
sharedMemorySize?: BoxedInteger;
|
|
2044
2079
|
/**
|
|
2045
|
-
* The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run. If you
|
|
2080
|
+
* The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run. If you're using tasks that use the Fargate launch type, the tmpfs parameter isn't supported.
|
|
2046
2081
|
*/
|
|
2047
2082
|
tmpfs?: TmpfsList;
|
|
2048
2083
|
/**
|
|
2049
|
-
* The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value. If a 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. If you
|
|
2084
|
+
* The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value. If a 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. If you're using tasks that use the Fargate launch type, the maxSwap parameter isn't supported.
|
|
2050
2085
|
*/
|
|
2051
2086
|
maxSwap?: BoxedInteger;
|
|
2052
2087
|
/**
|
|
2053
|
-
* This allows you to tune a container's memory swappiness behavior. A 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. If you
|
|
2088
|
+
* This allows you to tune a container's memory swappiness behavior. A 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. If you're using tasks that use the Fargate launch type, the swappiness parameter isn't supported.
|
|
2054
2089
|
*/
|
|
2055
2090
|
swappiness?: BoxedInteger;
|
|
2056
2091
|
}
|
|
@@ -2060,7 +2095,7 @@ declare namespace ECS {
|
|
|
2060
2095
|
*/
|
|
2061
2096
|
name?: SettingName;
|
|
2062
2097
|
/**
|
|
2063
|
-
* The value of the account settings
|
|
2098
|
+
* The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.
|
|
2064
2099
|
*/
|
|
2065
2100
|
value?: String;
|
|
2066
2101
|
/**
|
|
@@ -2068,15 +2103,15 @@ declare namespace ECS {
|
|
|
2068
2103
|
*/
|
|
2069
2104
|
principalArn?: String;
|
|
2070
2105
|
/**
|
|
2071
|
-
*
|
|
2106
|
+
* 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.
|
|
2072
2107
|
*/
|
|
2073
2108
|
effectiveSettings?: Boolean;
|
|
2074
2109
|
/**
|
|
2075
|
-
* 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
|
|
2110
|
+
* 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.
|
|
2076
2111
|
*/
|
|
2077
2112
|
nextToken?: String;
|
|
2078
2113
|
/**
|
|
2079
|
-
* 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
|
|
2114
|
+
* 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.
|
|
2080
2115
|
*/
|
|
2081
2116
|
maxResults?: Integer;
|
|
2082
2117
|
}
|
|
@@ -2096,23 +2131,23 @@ declare namespace ECS {
|
|
|
2096
2131
|
*/
|
|
2097
2132
|
cluster?: String;
|
|
2098
2133
|
/**
|
|
2099
|
-
* The type of the target
|
|
2134
|
+
* The type of the target to list attributes with.
|
|
2100
2135
|
*/
|
|
2101
2136
|
targetType: TargetType;
|
|
2102
2137
|
/**
|
|
2103
|
-
* The name of the attribute
|
|
2138
|
+
* The name of the attribute to filter the results with.
|
|
2104
2139
|
*/
|
|
2105
2140
|
attributeName?: String;
|
|
2106
2141
|
/**
|
|
2107
|
-
* The value of the attribute
|
|
2142
|
+
* The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.
|
|
2108
2143
|
*/
|
|
2109
2144
|
attributeValue?: String;
|
|
2110
2145
|
/**
|
|
2111
|
-
* The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls
|
|
2146
|
+
* 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.
|
|
2112
2147
|
*/
|
|
2113
2148
|
nextToken?: String;
|
|
2114
2149
|
/**
|
|
2115
|
-
* The maximum number of cluster results
|
|
2150
|
+
* 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.
|
|
2116
2151
|
*/
|
|
2117
2152
|
maxResults?: BoxedInteger;
|
|
2118
2153
|
}
|
|
@@ -2128,17 +2163,17 @@ declare namespace ECS {
|
|
|
2128
2163
|
}
|
|
2129
2164
|
export interface ListClustersRequest {
|
|
2130
2165
|
/**
|
|
2131
|
-
* The nextToken value returned from a ListClusters request indicating that more results are available to fulfill the request and further calls
|
|
2166
|
+
* 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.
|
|
2132
2167
|
*/
|
|
2133
2168
|
nextToken?: String;
|
|
2134
2169
|
/**
|
|
2135
|
-
* The maximum number of cluster results
|
|
2170
|
+
* 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.
|
|
2136
2171
|
*/
|
|
2137
2172
|
maxResults?: BoxedInteger;
|
|
2138
2173
|
}
|
|
2139
2174
|
export interface ListClustersResponse {
|
|
2140
2175
|
/**
|
|
2141
|
-
* The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
|
|
2176
|
+
* The list of full Amazon Resource Name (ARN) entries for each cluster that's associated with your account.
|
|
2142
2177
|
*/
|
|
2143
2178
|
clusterArns?: StringList;
|
|
2144
2179
|
/**
|
|
@@ -2156,15 +2191,15 @@ declare namespace ECS {
|
|
|
2156
2191
|
*/
|
|
2157
2192
|
filter?: String;
|
|
2158
2193
|
/**
|
|
2159
|
-
* The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls
|
|
2194
|
+
* 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.
|
|
2160
2195
|
*/
|
|
2161
2196
|
nextToken?: String;
|
|
2162
2197
|
/**
|
|
2163
|
-
* The maximum number of container instance results
|
|
2198
|
+
* 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.
|
|
2164
2199
|
*/
|
|
2165
2200
|
maxResults?: BoxedInteger;
|
|
2166
2201
|
/**
|
|
2167
|
-
* 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
|
|
2202
|
+
* 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.
|
|
2168
2203
|
*/
|
|
2169
2204
|
status?: ContainerInstanceStatus;
|
|
2170
2205
|
}
|
|
@@ -2188,7 +2223,7 @@ declare namespace ECS {
|
|
|
2188
2223
|
*/
|
|
2189
2224
|
nextToken?: String;
|
|
2190
2225
|
/**
|
|
2191
|
-
* The maximum number of service results
|
|
2226
|
+
* 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.
|
|
2192
2227
|
*/
|
|
2193
2228
|
maxResults?: BoxedInteger;
|
|
2194
2229
|
/**
|
|
@@ -2202,7 +2237,7 @@ declare namespace ECS {
|
|
|
2202
2237
|
}
|
|
2203
2238
|
export interface ListServicesResponse {
|
|
2204
2239
|
/**
|
|
2205
|
-
* The list of full ARN entries for each service associated with the specified cluster.
|
|
2240
|
+
* The list of full ARN entries for each service that's associated with the specified cluster.
|
|
2206
2241
|
*/
|
|
2207
2242
|
serviceArns?: StringList;
|
|
2208
2243
|
/**
|
|
@@ -2212,7 +2247,7 @@ declare namespace ECS {
|
|
|
2212
2247
|
}
|
|
2213
2248
|
export interface ListTagsForResourceRequest {
|
|
2214
2249
|
/**
|
|
2215
|
-
* The Amazon Resource Name (ARN) that identifies the resource
|
|
2250
|
+
* 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.
|
|
2216
2251
|
*/
|
|
2217
2252
|
resourceArn: String;
|
|
2218
2253
|
}
|
|
@@ -2224,11 +2259,11 @@ declare namespace ECS {
|
|
|
2224
2259
|
}
|
|
2225
2260
|
export interface ListTaskDefinitionFamiliesRequest {
|
|
2226
2261
|
/**
|
|
2227
|
-
* The familyPrefix is a string that
|
|
2262
|
+
* 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.
|
|
2228
2263
|
*/
|
|
2229
2264
|
familyPrefix?: String;
|
|
2230
2265
|
/**
|
|
2231
|
-
* The task definition family status
|
|
2266
|
+
* 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.
|
|
2232
2267
|
*/
|
|
2233
2268
|
status?: TaskDefinitionFamilyStatus;
|
|
2234
2269
|
/**
|
|
@@ -2236,7 +2271,7 @@ declare namespace ECS {
|
|
|
2236
2271
|
*/
|
|
2237
2272
|
nextToken?: String;
|
|
2238
2273
|
/**
|
|
2239
|
-
* The maximum number of task definition family results
|
|
2274
|
+
* 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.
|
|
2240
2275
|
*/
|
|
2241
2276
|
maxResults?: BoxedInteger;
|
|
2242
2277
|
}
|
|
@@ -2252,15 +2287,15 @@ declare namespace ECS {
|
|
|
2252
2287
|
}
|
|
2253
2288
|
export interface ListTaskDefinitionsRequest {
|
|
2254
2289
|
/**
|
|
2255
|
-
* The full family name
|
|
2290
|
+
* 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.
|
|
2256
2291
|
*/
|
|
2257
2292
|
familyPrefix?: String;
|
|
2258
2293
|
/**
|
|
2259
|
-
* The task definition status
|
|
2294
|
+
* 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.
|
|
2260
2295
|
*/
|
|
2261
2296
|
status?: TaskDefinitionStatus;
|
|
2262
2297
|
/**
|
|
2263
|
-
* The order
|
|
2298
|
+
* 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.
|
|
2264
2299
|
*/
|
|
2265
2300
|
sort?: SortOrder;
|
|
2266
2301
|
/**
|
|
@@ -2268,7 +2303,7 @@ declare namespace ECS {
|
|
|
2268
2303
|
*/
|
|
2269
2304
|
nextToken?: String;
|
|
2270
2305
|
/**
|
|
2271
|
-
* The maximum number of task definition results
|
|
2306
|
+
* 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.
|
|
2272
2307
|
*/
|
|
2273
2308
|
maxResults?: BoxedInteger;
|
|
2274
2309
|
}
|
|
@@ -2296,15 +2331,15 @@ declare namespace ECS {
|
|
|
2296
2331
|
*/
|
|
2297
2332
|
family?: String;
|
|
2298
2333
|
/**
|
|
2299
|
-
* 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
|
|
2334
|
+
* 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.
|
|
2300
2335
|
*/
|
|
2301
2336
|
nextToken?: String;
|
|
2302
2337
|
/**
|
|
2303
|
-
* The maximum number of task results
|
|
2338
|
+
* 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.
|
|
2304
2339
|
*/
|
|
2305
2340
|
maxResults?: BoxedInteger;
|
|
2306
2341
|
/**
|
|
2307
|
-
* The startedBy value
|
|
2342
|
+
* The startedBy value to filter the task results with. Specifying a startedBy value limits the results to tasks that were started with that value.
|
|
2308
2343
|
*/
|
|
2309
2344
|
startedBy?: String;
|
|
2310
2345
|
/**
|
|
@@ -2312,7 +2347,7 @@ declare namespace ECS {
|
|
|
2312
2347
|
*/
|
|
2313
2348
|
serviceName?: String;
|
|
2314
2349
|
/**
|
|
2315
|
-
* 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
|
|
2350
|
+
* 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).
|
|
2316
2351
|
*/
|
|
2317
2352
|
desiredStatus?: DesiredStatus;
|
|
2318
2353
|
/**
|
|
@@ -2332,7 +2367,7 @@ declare namespace ECS {
|
|
|
2332
2367
|
}
|
|
2333
2368
|
export interface LoadBalancer {
|
|
2334
2369
|
/**
|
|
2335
|
-
* 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. If you
|
|
2370
|
+
* 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. If you're using a Classic Load Balancer, omit the target group ARN. 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.
|
|
2336
2371
|
*/
|
|
2337
2372
|
targetGroupArn?: String;
|
|
2338
2373
|
/**
|
|
@@ -2344,14 +2379,14 @@ declare namespace ECS {
|
|
|
2344
2379
|
*/
|
|
2345
2380
|
containerName?: String;
|
|
2346
2381
|
/**
|
|
2347
|
-
* 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
|
|
2382
|
+
* 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.
|
|
2348
2383
|
*/
|
|
2349
2384
|
containerPort?: BoxedInteger;
|
|
2350
2385
|
}
|
|
2351
2386
|
export type LoadBalancers = LoadBalancer[];
|
|
2352
2387
|
export interface LogConfiguration {
|
|
2353
2388
|
/**
|
|
2354
|
-
* 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, logentries,syslog, splunk, and awsfirelens. For more information about using the awslogs log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide. For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide. If you have a custom driver that
|
|
2389
|
+
* 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, logentries,syslog, splunk, and awsfirelens. For more information about using the awslogs log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide. For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide. 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.
|
|
2355
2390
|
*/
|
|
2356
2391
|
logDriver: LogDriver;
|
|
2357
2392
|
/**
|
|
@@ -2368,7 +2403,7 @@ declare namespace ECS {
|
|
|
2368
2403
|
export type Long = number;
|
|
2369
2404
|
export interface ManagedAgent {
|
|
2370
2405
|
/**
|
|
2371
|
-
* The Unix timestamp for when the managed agent was last started.
|
|
2406
|
+
* The Unix timestamp for the time when the managed agent was last started.
|
|
2372
2407
|
*/
|
|
2373
2408
|
lastStartedAt?: Timestamp;
|
|
2374
2409
|
/**
|
|
@@ -2387,7 +2422,7 @@ declare namespace ECS {
|
|
|
2387
2422
|
export type ManagedAgentName = "ExecuteCommandAgent"|string;
|
|
2388
2423
|
export interface ManagedAgentStateChange {
|
|
2389
2424
|
/**
|
|
2390
|
-
* The name of the container associated with the managed agent.
|
|
2425
|
+
* The name of the container that's associated with the managed agent.
|
|
2391
2426
|
*/
|
|
2392
2427
|
containerName: String;
|
|
2393
2428
|
/**
|
|
@@ -2407,19 +2442,19 @@ declare namespace ECS {
|
|
|
2407
2442
|
export type ManagedAgents = ManagedAgent[];
|
|
2408
2443
|
export interface ManagedScaling {
|
|
2409
2444
|
/**
|
|
2410
|
-
*
|
|
2445
|
+
* Determines whether to enable managed scaling for the capacity provider.
|
|
2411
2446
|
*/
|
|
2412
2447
|
status?: ManagedScalingStatus;
|
|
2413
2448
|
/**
|
|
2414
|
-
* The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. A value of 100
|
|
2449
|
+
* The target capacity value for the capacity provider. The specified value must be greater than 0 and less than or equal to 100. A value of 100 results in the Amazon EC2 instances in your Auto Scaling group being completely used.
|
|
2415
2450
|
*/
|
|
2416
2451
|
targetCapacity?: ManagedScalingTargetCapacity;
|
|
2417
2452
|
/**
|
|
2418
|
-
* The minimum number of container instances that Amazon ECS
|
|
2453
|
+
* The minimum number of container instances that Amazon ECS scales in or scales out at one time. If this parameter is omitted, the default value of 1 is used.
|
|
2419
2454
|
*/
|
|
2420
2455
|
minimumScalingStepSize?: ManagedScalingStepSize;
|
|
2421
2456
|
/**
|
|
2422
|
-
* The maximum number of container instances that Amazon ECS
|
|
2457
|
+
* The maximum number of container instances that Amazon ECS scales in or scales out at one time. If this parameter is omitted, the default value of 10000 is used.
|
|
2423
2458
|
*/
|
|
2424
2459
|
maximumScalingStepSize?: ManagedScalingStepSize;
|
|
2425
2460
|
/**
|
|
@@ -2453,11 +2488,11 @@ declare namespace ECS {
|
|
|
2453
2488
|
*/
|
|
2454
2489
|
bindIP?: String;
|
|
2455
2490
|
/**
|
|
2456
|
-
* The port number on the container that
|
|
2491
|
+
* The port number on the container that's used with the network binding.
|
|
2457
2492
|
*/
|
|
2458
2493
|
containerPort?: BoxedInteger;
|
|
2459
2494
|
/**
|
|
2460
|
-
* The port number on the host that
|
|
2495
|
+
* The port number on the host that's used with the network binding.
|
|
2461
2496
|
*/
|
|
2462
2497
|
hostPort?: BoxedInteger;
|
|
2463
2498
|
/**
|
|
@@ -2468,7 +2503,7 @@ declare namespace ECS {
|
|
|
2468
2503
|
export type NetworkBindings = NetworkBinding[];
|
|
2469
2504
|
export interface NetworkConfiguration {
|
|
2470
2505
|
/**
|
|
2471
|
-
* The VPC subnets and security groups associated with a task. All specified subnets and security groups must be from the same VPC.
|
|
2506
|
+
* The VPC subnets and security groups that are associated with a task. All specified subnets and security groups must be from the same VPC.
|
|
2472
2507
|
*/
|
|
2473
2508
|
awsvpcConfiguration?: AwsVpcConfiguration;
|
|
2474
2509
|
}
|
|
@@ -2505,22 +2540,22 @@ declare namespace ECS {
|
|
|
2505
2540
|
export type PlacementStrategies = PlacementStrategy[];
|
|
2506
2541
|
export interface PlacementStrategy {
|
|
2507
2542
|
/**
|
|
2508
|
-
* 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
|
|
2543
|
+
* 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.
|
|
2509
2544
|
*/
|
|
2510
2545
|
type?: PlacementStrategyType;
|
|
2511
2546
|
/**
|
|
2512
|
-
* 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
|
|
2547
|
+
* 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.
|
|
2513
2548
|
*/
|
|
2514
2549
|
field?: String;
|
|
2515
2550
|
}
|
|
2516
2551
|
export type PlacementStrategyType = "random"|"spread"|"binpack"|string;
|
|
2517
2552
|
export interface PlatformDevice {
|
|
2518
2553
|
/**
|
|
2519
|
-
* The ID for the
|
|
2554
|
+
* 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.
|
|
2520
2555
|
*/
|
|
2521
2556
|
id: String;
|
|
2522
2557
|
/**
|
|
2523
|
-
* The type of device that
|
|
2558
|
+
* The type of device that's available on the container instance. The only supported value is GPU.
|
|
2524
2559
|
*/
|
|
2525
2560
|
type: PlatformDeviceType;
|
|
2526
2561
|
}
|
|
@@ -2528,11 +2563,11 @@ declare namespace ECS {
|
|
|
2528
2563
|
export type PlatformDevices = PlatformDevice[];
|
|
2529
2564
|
export interface PortMapping {
|
|
2530
2565
|
/**
|
|
2531
|
-
* The port number on the container that
|
|
2566
|
+
* 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 awsvpc or host network mode, specify the exposed ports using containerPort. If you use containers in a task with the 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.
|
|
2532
2567
|
*/
|
|
2533
2568
|
containerPort?: BoxedInteger;
|
|
2534
2569
|
/**
|
|
2535
|
-
* The port number on the container instance to reserve for your container. If you
|
|
2570
|
+
* The port number on the container instance to reserve for your container. If you use containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort. If you use containers in a task with the 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. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 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. The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0. 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 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.
|
|
2536
2571
|
*/
|
|
2537
2572
|
hostPort?: BoxedInteger;
|
|
2538
2573
|
/**
|
|
@@ -2600,7 +2635,7 @@ declare namespace ECS {
|
|
|
2600
2635
|
*/
|
|
2601
2636
|
cluster?: String;
|
|
2602
2637
|
/**
|
|
2603
|
-
* The attributes to apply to your resource. You can specify up to 10 custom attributes
|
|
2638
|
+
* 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.
|
|
2604
2639
|
*/
|
|
2605
2640
|
attributes: Attributes;
|
|
2606
2641
|
}
|
|
@@ -2612,7 +2647,7 @@ declare namespace ECS {
|
|
|
2612
2647
|
}
|
|
2613
2648
|
export interface PutClusterCapacityProvidersRequest {
|
|
2614
2649
|
/**
|
|
2615
|
-
* The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you
|
|
2650
|
+
* 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.
|
|
2616
2651
|
*/
|
|
2617
2652
|
cluster: String;
|
|
2618
2653
|
/**
|
|
@@ -2632,7 +2667,7 @@ declare namespace ECS {
|
|
|
2632
2667
|
}
|
|
2633
2668
|
export interface RegisterContainerInstanceRequest {
|
|
2634
2669
|
/**
|
|
2635
|
-
* The short name or full Amazon Resource Name (ARN) of the cluster
|
|
2670
|
+
* 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.
|
|
2636
2671
|
*/
|
|
2637
2672
|
cluster?: String;
|
|
2638
2673
|
/**
|
|
@@ -2648,7 +2683,7 @@ declare namespace ECS {
|
|
|
2648
2683
|
*/
|
|
2649
2684
|
totalResources?: Resources;
|
|
2650
2685
|
/**
|
|
2651
|
-
* The version information for the Amazon ECS container agent and Docker daemon
|
|
2686
|
+
* The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.
|
|
2652
2687
|
*/
|
|
2653
2688
|
versionInfo?: VersionInfo;
|
|
2654
2689
|
/**
|
|
@@ -2664,7 +2699,7 @@ declare namespace ECS {
|
|
|
2664
2699
|
*/
|
|
2665
2700
|
platformDevices?: PlatformDevices;
|
|
2666
2701
|
/**
|
|
2667
|
-
* 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
|
|
2702
|
+
* 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: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
|
|
2668
2703
|
*/
|
|
2669
2704
|
tags?: Tags;
|
|
2670
2705
|
}
|
|
@@ -2676,7 +2711,7 @@ declare namespace ECS {
|
|
|
2676
2711
|
}
|
|
2677
2712
|
export interface RegisterTaskDefinitionRequest {
|
|
2678
2713
|
/**
|
|
2679
|
-
* You must specify a family for a task definition
|
|
2714
|
+
* You must specify a 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.
|
|
2680
2715
|
*/
|
|
2681
2716
|
family: String;
|
|
2682
2717
|
/**
|
|
@@ -2696,27 +2731,27 @@ declare namespace ECS {
|
|
|
2696
2731
|
*/
|
|
2697
2732
|
containerDefinitions: ContainerDefinitions;
|
|
2698
2733
|
/**
|
|
2699
|
-
* A list of volume definitions in JSON format that containers in your task
|
|
2734
|
+
* A list of volume definitions in JSON format that containers in your task might use.
|
|
2700
2735
|
*/
|
|
2701
2736
|
volumes?: VolumeList;
|
|
2702
2737
|
/**
|
|
2703
|
-
* An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints
|
|
2738
|
+
* 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.
|
|
2704
2739
|
*/
|
|
2705
2740
|
placementConstraints?: TaskDefinitionPlacementConstraints;
|
|
2706
2741
|
/**
|
|
2707
|
-
* The task launch type that Amazon ECS
|
|
2742
|
+
* 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.
|
|
2708
2743
|
*/
|
|
2709
2744
|
requiresCompatibilities?: CompatibilityList;
|
|
2710
2745
|
/**
|
|
2711
|
-
* The number of CPU units used by the task. It can be expressed as an integer using CPU units
|
|
2746
|
+
* The number of CPU units used by the task. It can be expressed as an integer using CPU units (for example, 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. 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 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). 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 memory parameter: The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. 256 (.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: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
|
|
2712
2747
|
*/
|
|
2713
2748
|
cpu?: String;
|
|
2714
2749
|
/**
|
|
2715
|
-
* The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB
|
|
2750
|
+
* The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB (for example ,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. 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 cpu parameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. 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)
|
|
2716
2751
|
*/
|
|
2717
2752
|
memory?: String;
|
|
2718
2753
|
/**
|
|
2719
|
-
* 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
|
|
2754
|
+
* 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: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
|
|
2720
2755
|
*/
|
|
2721
2756
|
tags?: Tags;
|
|
2722
2757
|
/**
|
|
@@ -2756,7 +2791,7 @@ declare namespace ECS {
|
|
|
2756
2791
|
}
|
|
2757
2792
|
export interface RepositoryCredentials {
|
|
2758
2793
|
/**
|
|
2759
|
-
* The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you
|
|
2794
|
+
* 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.
|
|
2760
2795
|
*/
|
|
2761
2796
|
credentialsParameter: String;
|
|
2762
2797
|
}
|
|
@@ -2767,7 +2802,7 @@ declare namespace ECS {
|
|
|
2767
2802
|
*/
|
|
2768
2803
|
name?: String;
|
|
2769
2804
|
/**
|
|
2770
|
-
* The type of the resource
|
|
2805
|
+
* The type of the resource. Valid values: INTEGER, DOUBLE, LONG, or STRINGSET.
|
|
2771
2806
|
*/
|
|
2772
2807
|
type?: String;
|
|
2773
2808
|
/**
|
|
@@ -2789,7 +2824,7 @@ declare namespace ECS {
|
|
|
2789
2824
|
}
|
|
2790
2825
|
export interface ResourceRequirement {
|
|
2791
2826
|
/**
|
|
2792
|
-
* The value for the specified resource type. If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent
|
|
2827
|
+
* The value for the specified resource type. If the GPU type is used, 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. If the InferenceAccelerator type is used, the value matches the deviceName for an InferenceAccelerator specified in a task definition.
|
|
2793
2828
|
*/
|
|
2794
2829
|
value: String;
|
|
2795
2830
|
/**
|
|
@@ -2806,11 +2841,11 @@ declare namespace ECS {
|
|
|
2806
2841
|
*/
|
|
2807
2842
|
capacityProviderStrategy?: CapacityProviderStrategy;
|
|
2808
2843
|
/**
|
|
2809
|
-
* The short name or full Amazon Resource Name (ARN) of the cluster
|
|
2844
|
+
* 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.
|
|
2810
2845
|
*/
|
|
2811
2846
|
cluster?: String;
|
|
2812
2847
|
/**
|
|
2813
|
-
* The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks
|
|
2848
|
+
* The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.
|
|
2814
2849
|
*/
|
|
2815
2850
|
count?: BoxedInteger;
|
|
2816
2851
|
/**
|
|
@@ -2818,7 +2853,7 @@ declare namespace ECS {
|
|
|
2818
2853
|
*/
|
|
2819
2854
|
enableECSManagedTags?: Boolean;
|
|
2820
2855
|
/**
|
|
2821
|
-
*
|
|
2856
|
+
* Determines whether to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
|
|
2822
2857
|
*/
|
|
2823
2858
|
enableExecuteCommand?: Boolean;
|
|
2824
2859
|
/**
|
|
@@ -2826,31 +2861,31 @@ declare namespace ECS {
|
|
|
2826
2861
|
*/
|
|
2827
2862
|
group?: String;
|
|
2828
2863
|
/**
|
|
2829
|
-
* The infrastructure
|
|
2864
|
+
* 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 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. For more information, see Fargate capacity providers in the Amazon ECS User Guide for Fargate. The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster. The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster. A task can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted. When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.
|
|
2830
2865
|
*/
|
|
2831
2866
|
launchType?: LaunchType;
|
|
2832
2867
|
/**
|
|
2833
|
-
* The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it
|
|
2868
|
+
* The network configuration for the task. This parameter is required for task definitions that use the 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.
|
|
2834
2869
|
*/
|
|
2835
2870
|
networkConfiguration?: NetworkConfiguration;
|
|
2836
2871
|
/**
|
|
2837
|
-
* 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
|
|
2872
|
+
* 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 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. A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
|
|
2838
2873
|
*/
|
|
2839
2874
|
overrides?: TaskOverride;
|
|
2840
2875
|
/**
|
|
2841
|
-
* An array of placement constraint objects to use for the task. You can specify up to 10 constraints
|
|
2876
|
+
* 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).
|
|
2842
2877
|
*/
|
|
2843
2878
|
placementConstraints?: PlacementConstraints;
|
|
2844
2879
|
/**
|
|
2845
|
-
* The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules
|
|
2880
|
+
* The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.
|
|
2846
2881
|
*/
|
|
2847
2882
|
placementStrategy?: PlacementStrategies;
|
|
2848
2883
|
/**
|
|
2849
|
-
* The platform version the task
|
|
2884
|
+
* The platform version the task uses. A platform version is only specified for tasks hosted on Fargate. 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.
|
|
2850
2885
|
*/
|
|
2851
2886
|
platformVersion?: String;
|
|
2852
2887
|
/**
|
|
2853
|
-
* Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags
|
|
2888
|
+
* 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. An error will be received if you specify the SERVICE option when running a task.
|
|
2854
2889
|
*/
|
|
2855
2890
|
propagateTags?: PropagateTags;
|
|
2856
2891
|
/**
|
|
@@ -2858,7 +2893,7 @@ declare namespace ECS {
|
|
|
2858
2893
|
*/
|
|
2859
2894
|
referenceId?: String;
|
|
2860
2895
|
/**
|
|
2861
|
-
* 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 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 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
|
|
2896
|
+
* 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 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 36 letters (uppercase and lowercase), numbers, hyphens (-), and underscores (_) are allowed. If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.
|
|
2862
2897
|
*/
|
|
2863
2898
|
startedBy?: String;
|
|
2864
2899
|
/**
|
|
@@ -2866,7 +2901,7 @@ declare namespace ECS {
|
|
|
2866
2901
|
*/
|
|
2867
2902
|
tags?: Tags;
|
|
2868
2903
|
/**
|
|
2869
|
-
* The family and revision (family:revision) or full ARN of the task definition to run. If a revision
|
|
2904
|
+
* The 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. The full ARN value must match the value that you specified as the Resource of the IAM principal's permissions policy. For example, if the Resource is arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the taskDefinition ARN value must be arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName.
|
|
2870
2905
|
*/
|
|
2871
2906
|
taskDefinition: String;
|
|
2872
2907
|
}
|
|
@@ -2909,7 +2944,7 @@ declare namespace ECS {
|
|
|
2909
2944
|
*/
|
|
2910
2945
|
name: String;
|
|
2911
2946
|
/**
|
|
2912
|
-
* 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. If the SSM Parameter Store parameter exists in the same Region as the task you
|
|
2947
|
+
* 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. 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.
|
|
2913
2948
|
*/
|
|
2914
2949
|
valueFrom: String;
|
|
2915
2950
|
}
|
|
@@ -2921,7 +2956,7 @@ declare namespace ECS {
|
|
|
2921
2956
|
*/
|
|
2922
2957
|
serviceArn?: String;
|
|
2923
2958
|
/**
|
|
2924
|
-
* 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,
|
|
2959
|
+
* 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.
|
|
2925
2960
|
*/
|
|
2926
2961
|
serviceName?: String;
|
|
2927
2962
|
/**
|
|
@@ -2929,11 +2964,11 @@ declare namespace ECS {
|
|
|
2929
2964
|
*/
|
|
2930
2965
|
clusterArn?: String;
|
|
2931
2966
|
/**
|
|
2932
|
-
* A list of Elastic Load Balancing load balancer objects
|
|
2967
|
+
* 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.
|
|
2933
2968
|
*/
|
|
2934
2969
|
loadBalancers?: LoadBalancers;
|
|
2935
2970
|
/**
|
|
2936
|
-
* The details
|
|
2971
|
+
* The details for the service discovery registries to assign to this service. For more information, see Service Discovery.
|
|
2937
2972
|
*/
|
|
2938
2973
|
serviceRegistries?: ServiceRegistries;
|
|
2939
2974
|
/**
|
|
@@ -2957,15 +2992,15 @@ declare namespace ECS {
|
|
|
2957
2992
|
*/
|
|
2958
2993
|
launchType?: LaunchType;
|
|
2959
2994
|
/**
|
|
2960
|
-
* The capacity provider strategy the service
|
|
2995
|
+
* 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.
|
|
2961
2996
|
*/
|
|
2962
2997
|
capacityProviderStrategy?: CapacityProviderStrategy;
|
|
2963
2998
|
/**
|
|
2964
|
-
* The platform version
|
|
2999
|
+
* 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 LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
|
|
2965
3000
|
*/
|
|
2966
3001
|
platformVersion?: String;
|
|
2967
3002
|
/**
|
|
2968
|
-
* The operating system that your tasks in the service
|
|
3003
|
+
* 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 platformFamily value as the service (for example, LINUX).
|
|
2969
3004
|
*/
|
|
2970
3005
|
platformFamily?: String;
|
|
2971
3006
|
/**
|
|
@@ -2985,7 +3020,7 @@ declare namespace ECS {
|
|
|
2985
3020
|
*/
|
|
2986
3021
|
deployments?: Deployments;
|
|
2987
3022
|
/**
|
|
2988
|
-
* The ARN of the IAM role associated with the service
|
|
3023
|
+
* 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.
|
|
2989
3024
|
*/
|
|
2990
3025
|
roleArn?: String;
|
|
2991
3026
|
/**
|
|
@@ -2993,7 +3028,7 @@ declare namespace ECS {
|
|
|
2993
3028
|
*/
|
|
2994
3029
|
events?: ServiceEvents;
|
|
2995
3030
|
/**
|
|
2996
|
-
* The Unix timestamp for when the service was created.
|
|
3031
|
+
* The Unix timestamp for the time when the service was created.
|
|
2997
3032
|
*/
|
|
2998
3033
|
createdAt?: Timestamp;
|
|
2999
3034
|
/**
|
|
@@ -3013,15 +3048,15 @@ declare namespace ECS {
|
|
|
3013
3048
|
*/
|
|
3014
3049
|
healthCheckGracePeriodSeconds?: BoxedInteger;
|
|
3015
3050
|
/**
|
|
3016
|
-
* The scheduling strategy to use for the service. For more information, see Services. There are two service scheduler strategies available
|
|
3051
|
+
* The scheduling strategy to use for the service. For more information, see Services. There are two service scheduler strategies available. 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 taskmeets 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.
|
|
3017
3052
|
*/
|
|
3018
3053
|
schedulingStrategy?: SchedulingStrategy;
|
|
3019
3054
|
/**
|
|
3020
|
-
* The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service
|
|
3055
|
+
* The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service uses the ECS deployment controller type.
|
|
3021
3056
|
*/
|
|
3022
3057
|
deploymentController?: DeploymentController;
|
|
3023
3058
|
/**
|
|
3024
|
-
* 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
|
|
3059
|
+
* 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: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
|
|
3025
3060
|
*/
|
|
3026
3061
|
tags?: Tags;
|
|
3027
3062
|
/**
|
|
@@ -3029,25 +3064,25 @@ declare namespace ECS {
|
|
|
3029
3064
|
*/
|
|
3030
3065
|
createdBy?: String;
|
|
3031
3066
|
/**
|
|
3032
|
-
*
|
|
3067
|
+
* Determines whether to enable 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.
|
|
3033
3068
|
*/
|
|
3034
3069
|
enableECSManagedTags?: Boolean;
|
|
3035
3070
|
/**
|
|
3036
|
-
*
|
|
3071
|
+
* 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.
|
|
3037
3072
|
*/
|
|
3038
3073
|
propagateTags?: PropagateTags;
|
|
3039
3074
|
/**
|
|
3040
|
-
*
|
|
3075
|
+
* Determines whether the execute command functionality is enabled for the service. If true, the execute command functionality is enabled for all containers in tasks as part of the service.
|
|
3041
3076
|
*/
|
|
3042
3077
|
enableExecuteCommand?: Boolean;
|
|
3043
3078
|
}
|
|
3044
3079
|
export interface ServiceEvent {
|
|
3045
3080
|
/**
|
|
3046
|
-
* The ID string
|
|
3081
|
+
* The ID string for the event.
|
|
3047
3082
|
*/
|
|
3048
3083
|
id?: String;
|
|
3049
3084
|
/**
|
|
3050
|
-
* The Unix timestamp for when the event was triggered.
|
|
3085
|
+
* The Unix timestamp for the time when the event was triggered.
|
|
3051
3086
|
*/
|
|
3052
3087
|
createdAt?: Timestamp;
|
|
3053
3088
|
/**
|
|
@@ -3065,15 +3100,15 @@ declare namespace ECS {
|
|
|
3065
3100
|
*/
|
|
3066
3101
|
registryArn?: String;
|
|
3067
3102
|
/**
|
|
3068
|
-
* The port value used if your service discovery service specified an SRV record. This field
|
|
3103
|
+
* 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.
|
|
3069
3104
|
*/
|
|
3070
3105
|
port?: BoxedInteger;
|
|
3071
3106
|
/**
|
|
3072
|
-
* The container name value
|
|
3107
|
+
* 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.
|
|
3073
3108
|
*/
|
|
3074
3109
|
containerName?: String;
|
|
3075
3110
|
/**
|
|
3076
|
-
* The port value
|
|
3111
|
+
* 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.
|
|
3077
3112
|
*/
|
|
3078
3113
|
containerPort?: BoxedInteger;
|
|
3079
3114
|
}
|
|
@@ -3088,7 +3123,7 @@ declare namespace ECS {
|
|
|
3088
3123
|
*/
|
|
3089
3124
|
streamUrl?: String;
|
|
3090
3125
|
/**
|
|
3091
|
-
* An encrypted token value containing session and caller information.
|
|
3126
|
+
* An encrypted token value containing session and caller information. It's used to authenticate the connection to the container.
|
|
3092
3127
|
*/
|
|
3093
3128
|
tokenValue?: SensitiveString;
|
|
3094
3129
|
}
|
|
@@ -3098,11 +3133,11 @@ declare namespace ECS {
|
|
|
3098
3133
|
*/
|
|
3099
3134
|
name?: SettingName;
|
|
3100
3135
|
/**
|
|
3101
|
-
*
|
|
3136
|
+
* Determines whether the account setting is enabled or disabled for the specified resource.
|
|
3102
3137
|
*/
|
|
3103
3138
|
value?: String;
|
|
3104
3139
|
/**
|
|
3105
|
-
* The ARN of the principal
|
|
3140
|
+
* The ARN of the principal. It can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.
|
|
3106
3141
|
*/
|
|
3107
3142
|
principalArn?: String;
|
|
3108
3143
|
}
|
|
@@ -3112,11 +3147,11 @@ declare namespace ECS {
|
|
|
3112
3147
|
export type StabilityStatus = "STEADY_STATE"|"STABILIZING"|string;
|
|
3113
3148
|
export interface StartTaskRequest {
|
|
3114
3149
|
/**
|
|
3115
|
-
* The short name or full Amazon Resource Name (ARN) of the cluster
|
|
3150
|
+
* The short name or full Amazon Resource Name (ARN) of the cluster where to start your task. If you do not specify a cluster, the default cluster is assumed.
|
|
3116
3151
|
*/
|
|
3117
3152
|
cluster?: String;
|
|
3118
3153
|
/**
|
|
3119
|
-
* The container instance IDs or full ARN entries for the container instances
|
|
3154
|
+
* 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.
|
|
3120
3155
|
*/
|
|
3121
3156
|
containerInstances: StringList;
|
|
3122
3157
|
/**
|
|
@@ -3136,11 +3171,11 @@ declare namespace ECS {
|
|
|
3136
3171
|
*/
|
|
3137
3172
|
networkConfiguration?: NetworkConfiguration;
|
|
3138
3173
|
/**
|
|
3139
|
-
* A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it
|
|
3174
|
+
* 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 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. A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
|
|
3140
3175
|
*/
|
|
3141
3176
|
overrides?: TaskOverride;
|
|
3142
3177
|
/**
|
|
3143
|
-
* Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags
|
|
3178
|
+
* 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.
|
|
3144
3179
|
*/
|
|
3145
3180
|
propagateTags?: PropagateTags;
|
|
3146
3181
|
/**
|
|
@@ -3148,7 +3183,7 @@ declare namespace ECS {
|
|
|
3148
3183
|
*/
|
|
3149
3184
|
referenceId?: String;
|
|
3150
3185
|
/**
|
|
3151
|
-
* 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 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 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. If a task is started by an Amazon ECS service,
|
|
3186
|
+
* 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 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 36 letters (uppercase and lowercase), numbers, hyphens (-), and underscores (_) are allowed. If a task is started by an Amazon ECS service, the startedBy parameter contains the deployment ID of the service that starts it.
|
|
3152
3187
|
*/
|
|
3153
3188
|
startedBy?: String;
|
|
3154
3189
|
/**
|
|
@@ -3156,7 +3191,7 @@ declare namespace ECS {
|
|
|
3156
3191
|
*/
|
|
3157
3192
|
tags?: Tags;
|
|
3158
3193
|
/**
|
|
3159
|
-
* The family and revision (family:revision) or full ARN of the task definition to start. If a revision
|
|
3194
|
+
* The 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.
|
|
3160
3195
|
*/
|
|
3161
3196
|
taskDefinition: String;
|
|
3162
3197
|
}
|
|
@@ -3181,7 +3216,7 @@ declare namespace ECS {
|
|
|
3181
3216
|
*/
|
|
3182
3217
|
task: String;
|
|
3183
3218
|
/**
|
|
3184
|
-
* An optional message specified when a task is stopped. For example, if you
|
|
3219
|
+
* 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. Up to 255 characters are allowed in this message.
|
|
3185
3220
|
*/
|
|
3186
3221
|
reason?: String;
|
|
3187
3222
|
}
|
|
@@ -3232,7 +3267,7 @@ declare namespace ECS {
|
|
|
3232
3267
|
*/
|
|
3233
3268
|
status?: String;
|
|
3234
3269
|
/**
|
|
3235
|
-
* The exit code returned for the state change request.
|
|
3270
|
+
* The exit code that's returned for the state change request.
|
|
3236
3271
|
*/
|
|
3237
3272
|
exitCode?: BoxedInteger;
|
|
3238
3273
|
/**
|
|
@@ -3268,7 +3303,7 @@ declare namespace ECS {
|
|
|
3268
3303
|
*/
|
|
3269
3304
|
reason?: String;
|
|
3270
3305
|
/**
|
|
3271
|
-
* Any containers associated with the state change request.
|
|
3306
|
+
* Any containers that's associated with the state change request.
|
|
3272
3307
|
*/
|
|
3273
3308
|
containers?: ContainerStateChanges;
|
|
3274
3309
|
/**
|
|
@@ -3276,19 +3311,19 @@ declare namespace ECS {
|
|
|
3276
3311
|
*/
|
|
3277
3312
|
attachments?: AttachmentStateChanges;
|
|
3278
3313
|
/**
|
|
3279
|
-
* The details for the managed agent associated with the task.
|
|
3314
|
+
* The details for the managed agent that's associated with the task.
|
|
3280
3315
|
*/
|
|
3281
3316
|
managedAgents?: ManagedAgentStateChanges;
|
|
3282
3317
|
/**
|
|
3283
|
-
* The Unix timestamp for when the container image pull
|
|
3318
|
+
* The Unix timestamp for the time when the container image pull started.
|
|
3284
3319
|
*/
|
|
3285
3320
|
pullStartedAt?: Timestamp;
|
|
3286
3321
|
/**
|
|
3287
|
-
* The Unix timestamp for when the container image pull completed.
|
|
3322
|
+
* The Unix timestamp for the time when the container image pull completed.
|
|
3288
3323
|
*/
|
|
3289
3324
|
pullStoppedAt?: Timestamp;
|
|
3290
3325
|
/**
|
|
3291
|
-
* The Unix timestamp for when the task execution stopped.
|
|
3326
|
+
* The Unix timestamp for the time when the task execution stopped.
|
|
3292
3327
|
*/
|
|
3293
3328
|
executionStoppedAt?: Timestamp;
|
|
3294
3329
|
}
|
|
@@ -3300,11 +3335,11 @@ declare namespace ECS {
|
|
|
3300
3335
|
}
|
|
3301
3336
|
export interface SystemControl {
|
|
3302
3337
|
/**
|
|
3303
|
-
* The namespaced kernel parameter
|
|
3338
|
+
* The namespaced kernel parameter to set a value for.
|
|
3304
3339
|
*/
|
|
3305
3340
|
namespace?: String;
|
|
3306
3341
|
/**
|
|
3307
|
-
* The value for the namespaced kernel parameter specified in namespace.
|
|
3342
|
+
* The value for the namespaced kernel parameter that's specified in namespace.
|
|
3308
3343
|
*/
|
|
3309
3344
|
value?: String;
|
|
3310
3345
|
}
|
|
@@ -3323,7 +3358,7 @@ declare namespace ECS {
|
|
|
3323
3358
|
export type TagKeys = TagKey[];
|
|
3324
3359
|
export interface TagResourceRequest {
|
|
3325
3360
|
/**
|
|
3326
|
-
* The Amazon Resource Name (ARN) of the resource to
|
|
3361
|
+
* 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.
|
|
3327
3362
|
*/
|
|
3328
3363
|
resourceArn: String;
|
|
3329
3364
|
/**
|
|
@@ -3338,7 +3373,7 @@ declare namespace ECS {
|
|
|
3338
3373
|
export type TargetType = "container-instance"|string;
|
|
3339
3374
|
export interface Task {
|
|
3340
3375
|
/**
|
|
3341
|
-
* The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
|
|
3376
|
+
* The Elastic Network Adapter that's associated with the task if the task uses the awsvpc network mode.
|
|
3342
3377
|
*/
|
|
3343
3378
|
attachments?: Attachments;
|
|
3344
3379
|
/**
|
|
@@ -3346,11 +3381,11 @@ declare namespace ECS {
|
|
|
3346
3381
|
*/
|
|
3347
3382
|
attributes?: Attributes;
|
|
3348
3383
|
/**
|
|
3349
|
-
* The
|
|
3384
|
+
* The Availability Zone for the task.
|
|
3350
3385
|
*/
|
|
3351
3386
|
availabilityZone?: String;
|
|
3352
3387
|
/**
|
|
3353
|
-
* The capacity provider associated with the task.
|
|
3388
|
+
* The capacity provider that's associated with the task.
|
|
3354
3389
|
*/
|
|
3355
3390
|
capacityProviderName?: String;
|
|
3356
3391
|
/**
|
|
@@ -3362,7 +3397,7 @@ declare namespace ECS {
|
|
|
3362
3397
|
*/
|
|
3363
3398
|
connectivity?: Connectivity;
|
|
3364
3399
|
/**
|
|
3365
|
-
* The Unix timestamp for when the task last went into CONNECTED status.
|
|
3400
|
+
* The Unix timestamp for the time when the task last went into CONNECTED status.
|
|
3366
3401
|
*/
|
|
3367
3402
|
connectivityAt?: Timestamp;
|
|
3368
3403
|
/**
|
|
@@ -3370,15 +3405,15 @@ declare namespace ECS {
|
|
|
3370
3405
|
*/
|
|
3371
3406
|
containerInstanceArn?: String;
|
|
3372
3407
|
/**
|
|
3373
|
-
* The containers associated with the task.
|
|
3408
|
+
* The containers that's associated with the task.
|
|
3374
3409
|
*/
|
|
3375
3410
|
containers?: Containers;
|
|
3376
3411
|
/**
|
|
3377
|
-
* 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
|
|
3412
|
+
* 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, 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. 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). 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 memory parameter: The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. 256 (.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: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
|
|
3378
3413
|
*/
|
|
3379
3414
|
cpu?: String;
|
|
3380
3415
|
/**
|
|
3381
|
-
* The Unix timestamp for when the task was created
|
|
3416
|
+
* The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the PENDING state.
|
|
3382
3417
|
*/
|
|
3383
3418
|
createdAt?: Timestamp;
|
|
3384
3419
|
/**
|
|
@@ -3386,35 +3421,35 @@ declare namespace ECS {
|
|
|
3386
3421
|
*/
|
|
3387
3422
|
desiredStatus?: String;
|
|
3388
3423
|
/**
|
|
3389
|
-
*
|
|
3424
|
+
* Determines whether execute command functionality is enabled for this task. If true, execute command functionality is enabled on all the containers in the task.
|
|
3390
3425
|
*/
|
|
3391
3426
|
enableExecuteCommand?: Boolean;
|
|
3392
3427
|
/**
|
|
3393
|
-
* The Unix timestamp for when the task execution stopped.
|
|
3428
|
+
* The Unix timestamp for the time when the task execution stopped.
|
|
3394
3429
|
*/
|
|
3395
3430
|
executionStoppedAt?: Timestamp;
|
|
3396
3431
|
/**
|
|
3397
|
-
* The name of the task group associated with the task.
|
|
3432
|
+
* The name of the task group that's associated with the task.
|
|
3398
3433
|
*/
|
|
3399
3434
|
group?: String;
|
|
3400
3435
|
/**
|
|
3401
|
-
* The health status for the task
|
|
3436
|
+
* 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 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. 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.
|
|
3402
3437
|
*/
|
|
3403
3438
|
healthStatus?: HealthStatus;
|
|
3404
3439
|
/**
|
|
3405
|
-
* The Elastic Inference accelerator associated with the task.
|
|
3440
|
+
* The Elastic Inference accelerator that's associated with the task.
|
|
3406
3441
|
*/
|
|
3407
3442
|
inferenceAccelerators?: InferenceAccelerators;
|
|
3408
3443
|
/**
|
|
3409
|
-
* The last known status
|
|
3444
|
+
* The last known status for the task. For more information, see Task Lifecycle.
|
|
3410
3445
|
*/
|
|
3411
3446
|
lastStatus?: String;
|
|
3412
3447
|
/**
|
|
3413
|
-
* The infrastructure
|
|
3448
|
+
* The infrastructure where your task runs on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
|
|
3414
3449
|
*/
|
|
3415
3450
|
launchType?: LaunchType;
|
|
3416
3451
|
/**
|
|
3417
|
-
* The amount of memory (in MiB)
|
|
3452
|
+
* 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, 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. 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 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)
|
|
3418
3453
|
*/
|
|
3419
3454
|
memory?: String;
|
|
3420
3455
|
/**
|
|
@@ -3422,35 +3457,35 @@ declare namespace ECS {
|
|
|
3422
3457
|
*/
|
|
3423
3458
|
overrides?: TaskOverride;
|
|
3424
3459
|
/**
|
|
3425
|
-
* The platform version
|
|
3460
|
+
* 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 LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
|
|
3426
3461
|
*/
|
|
3427
3462
|
platformVersion?: String;
|
|
3428
3463
|
/**
|
|
3429
|
-
* The operating system that your tasks are running on. A platform family is specified only for tasks
|
|
3464
|
+
* 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 platformFamily value as the service (for example, LINUX.).
|
|
3430
3465
|
*/
|
|
3431
3466
|
platformFamily?: String;
|
|
3432
3467
|
/**
|
|
3433
|
-
* The Unix timestamp for when the container image pull began.
|
|
3468
|
+
* The Unix timestamp for the time when the container image pull began.
|
|
3434
3469
|
*/
|
|
3435
3470
|
pullStartedAt?: Timestamp;
|
|
3436
3471
|
/**
|
|
3437
|
-
* The Unix timestamp for when the container image pull completed.
|
|
3472
|
+
* The Unix timestamp for the time when the container image pull completed.
|
|
3438
3473
|
*/
|
|
3439
3474
|
pullStoppedAt?: Timestamp;
|
|
3440
3475
|
/**
|
|
3441
|
-
* The Unix timestamp for when the task started
|
|
3476
|
+
* The Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the PENDING state to the RUNNING state.
|
|
3442
3477
|
*/
|
|
3443
3478
|
startedAt?: Timestamp;
|
|
3444
3479
|
/**
|
|
3445
|
-
* The tag specified when a task is started. If
|
|
3480
|
+
* The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.
|
|
3446
3481
|
*/
|
|
3447
3482
|
startedBy?: String;
|
|
3448
3483
|
/**
|
|
3449
|
-
* The stop code indicating why a task was stopped. The stoppedReason
|
|
3484
|
+
* The stop code indicating why a task was stopped. The stoppedReason might contain additional details.
|
|
3450
3485
|
*/
|
|
3451
3486
|
stopCode?: TaskStopCode;
|
|
3452
3487
|
/**
|
|
3453
|
-
* The Unix timestamp for when the task was stopped
|
|
3488
|
+
* The Unix timestamp for the time when the task was stopped. More specifically, it's for the time when the task transitioned from the RUNNING state to the STOPPED state.
|
|
3454
3489
|
*/
|
|
3455
3490
|
stoppedAt?: Timestamp;
|
|
3456
3491
|
/**
|
|
@@ -3458,11 +3493,11 @@ declare namespace ECS {
|
|
|
3458
3493
|
*/
|
|
3459
3494
|
stoppedReason?: String;
|
|
3460
3495
|
/**
|
|
3461
|
-
* The Unix timestamp for when the task stops
|
|
3496
|
+
* The Unix timestamp for the time when the task stops. More specifically, it's for the time when the task transitions from the RUNNING state to STOPPED.
|
|
3462
3497
|
*/
|
|
3463
3498
|
stoppingAt?: Timestamp;
|
|
3464
3499
|
/**
|
|
3465
|
-
* The metadata that you apply to the task to help you categorize and organize
|
|
3500
|
+
* 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: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
|
|
3466
3501
|
*/
|
|
3467
3502
|
tags?: Tags;
|
|
3468
3503
|
/**
|
|
@@ -3474,7 +3509,7 @@ declare namespace ECS {
|
|
|
3474
3509
|
*/
|
|
3475
3510
|
taskDefinitionArn?: String;
|
|
3476
3511
|
/**
|
|
3477
|
-
* The version counter for the task. Every time a task experiences a change that
|
|
3512
|
+
* 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 detail object) to verify that the version in your event stream is current.
|
|
3478
3513
|
*/
|
|
3479
3514
|
version?: Long;
|
|
3480
3515
|
/**
|
|
@@ -3492,11 +3527,11 @@ declare namespace ECS {
|
|
|
3492
3527
|
*/
|
|
3493
3528
|
containerDefinitions?: ContainerDefinitions;
|
|
3494
3529
|
/**
|
|
3495
|
-
* The name of a family that this task definition is registered to. Up to 255
|
|
3530
|
+
* 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.
|
|
3496
3531
|
*/
|
|
3497
3532
|
family?: String;
|
|
3498
3533
|
/**
|
|
3499
|
-
* 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 more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide. IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code
|
|
3534
|
+
* 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 more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide. IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see Windows IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.
|
|
3500
3535
|
*/
|
|
3501
3536
|
taskRoleArn?: String;
|
|
3502
3537
|
/**
|
|
@@ -3508,11 +3543,11 @@ declare namespace ECS {
|
|
|
3508
3543
|
*/
|
|
3509
3544
|
networkMode?: NetworkMode;
|
|
3510
3545
|
/**
|
|
3511
|
-
* 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
|
|
3546
|
+
* 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.
|
|
3512
3547
|
*/
|
|
3513
3548
|
revision?: Integer;
|
|
3514
3549
|
/**
|
|
3515
|
-
* 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
|
|
3550
|
+
* 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.
|
|
3516
3551
|
*/
|
|
3517
3552
|
volumes?: VolumeList;
|
|
3518
3553
|
/**
|
|
@@ -3520,11 +3555,11 @@ declare namespace ECS {
|
|
|
3520
3555
|
*/
|
|
3521
3556
|
status?: TaskDefinitionStatus;
|
|
3522
3557
|
/**
|
|
3523
|
-
* 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
|
|
3558
|
+
* 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.
|
|
3524
3559
|
*/
|
|
3525
3560
|
requiresAttributes?: RequiresAttributes;
|
|
3526
3561
|
/**
|
|
3527
|
-
* An array of placement constraint objects to use for tasks. This parameter
|
|
3562
|
+
* An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on Fargate.
|
|
3528
3563
|
*/
|
|
3529
3564
|
placementConstraints?: TaskDefinitionPlacementConstraints;
|
|
3530
3565
|
/**
|
|
@@ -3540,15 +3575,15 @@ declare namespace ECS {
|
|
|
3540
3575
|
*/
|
|
3541
3576
|
requiresCompatibilities?: CompatibilityList;
|
|
3542
3577
|
/**
|
|
3543
|
-
* The number of cpu units used by the task. If you
|
|
3578
|
+
* 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. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. 256 (.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: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
|
|
3544
3579
|
*/
|
|
3545
3580
|
cpu?: String;
|
|
3546
3581
|
/**
|
|
3547
|
-
* The amount (in MiB) of memory used by the task. If your tasks
|
|
3582
|
+
* 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. 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)
|
|
3548
3583
|
*/
|
|
3549
3584
|
memory?: String;
|
|
3550
3585
|
/**
|
|
3551
|
-
* The Elastic Inference accelerator associated with the task.
|
|
3586
|
+
* The Elastic Inference accelerator that's associated with the task.
|
|
3552
3587
|
*/
|
|
3553
3588
|
inferenceAccelerators?: InferenceAccelerators;
|
|
3554
3589
|
/**
|
|
@@ -3560,15 +3595,15 @@ declare namespace ECS {
|
|
|
3560
3595
|
*/
|
|
3561
3596
|
ipcMode?: IpcMode;
|
|
3562
3597
|
/**
|
|
3563
|
-
* 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 ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS
|
|
3598
|
+
* 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 ecs-init package to enable 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.
|
|
3564
3599
|
*/
|
|
3565
3600
|
proxyConfiguration?: ProxyConfiguration;
|
|
3566
3601
|
/**
|
|
3567
|
-
* The Unix timestamp for when the task definition was registered.
|
|
3602
|
+
* The Unix timestamp for the time when the task definition was registered.
|
|
3568
3603
|
*/
|
|
3569
3604
|
registeredAt?: Timestamp;
|
|
3570
3605
|
/**
|
|
3571
|
-
* The Unix timestamp for when the task definition was deregistered.
|
|
3606
|
+
* The Unix timestamp for the time when the task definition was deregistered.
|
|
3572
3607
|
*/
|
|
3573
3608
|
deregisteredAt?: Timestamp;
|
|
3574
3609
|
/**
|
|
@@ -3600,7 +3635,7 @@ declare namespace ECS {
|
|
|
3600
3635
|
export type TaskFieldList = TaskField[];
|
|
3601
3636
|
export interface TaskOverride {
|
|
3602
3637
|
/**
|
|
3603
|
-
* One or more container overrides sent to a task.
|
|
3638
|
+
* One or more container overrides that are sent to a task.
|
|
3604
3639
|
*/
|
|
3605
3640
|
containerOverrides?: ContainerOverrides;
|
|
3606
3641
|
/**
|
|
@@ -3624,7 +3659,7 @@ declare namespace ECS {
|
|
|
3624
3659
|
*/
|
|
3625
3660
|
taskRoleArn?: String;
|
|
3626
3661
|
/**
|
|
3627
|
-
* The ephemeral storage setting override for the task. This parameter is only supported for tasks hosted on Fargate
|
|
3662
|
+
* The ephemeral storage setting override for the task. This parameter is only supported for tasks hosted on Fargate that use the following platform versions: Linux platform version 1.4.0 or later. Windows platform version 1.0.0 or later.
|
|
3628
3663
|
*/
|
|
3629
3664
|
ephemeralStorage?: EphemeralStorage;
|
|
3630
3665
|
}
|
|
@@ -3646,19 +3681,19 @@ declare namespace ECS {
|
|
|
3646
3681
|
*/
|
|
3647
3682
|
clusterArn?: String;
|
|
3648
3683
|
/**
|
|
3649
|
-
* The tag specified when a task set is started. If
|
|
3684
|
+
* 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.
|
|
3650
3685
|
*/
|
|
3651
3686
|
startedBy?: String;
|
|
3652
3687
|
/**
|
|
3653
|
-
* The external ID associated with the task set. If
|
|
3688
|
+
* 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.
|
|
3654
3689
|
*/
|
|
3655
3690
|
externalId?: String;
|
|
3656
3691
|
/**
|
|
3657
|
-
* The status of the task set. The following describes each state
|
|
3692
|
+
* The status of the task set. The following describes each state. PRIMARY The task set is serving production traffic. ACTIVE The task set isn't serving production traffic. DRAINING The tasks in the task set are being stopped, and their corresponding targets are being deregistered from their target group.
|
|
3658
3693
|
*/
|
|
3659
3694
|
status?: String;
|
|
3660
3695
|
/**
|
|
3661
|
-
* The task definition the task set is using.
|
|
3696
|
+
* The task definition that the task set is using.
|
|
3662
3697
|
*/
|
|
3663
3698
|
taskDefinition?: String;
|
|
3664
3699
|
/**
|
|
@@ -3666,7 +3701,7 @@ declare namespace ECS {
|
|
|
3666
3701
|
*/
|
|
3667
3702
|
computedDesiredCount?: Integer;
|
|
3668
3703
|
/**
|
|
3669
|
-
* 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
|
|
3704
|
+
* 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.
|
|
3670
3705
|
*/
|
|
3671
3706
|
pendingCount?: Integer;
|
|
3672
3707
|
/**
|
|
@@ -3674,11 +3709,11 @@ declare namespace ECS {
|
|
|
3674
3709
|
*/
|
|
3675
3710
|
runningCount?: Integer;
|
|
3676
3711
|
/**
|
|
3677
|
-
* The Unix timestamp for when the task set was created.
|
|
3712
|
+
* The Unix timestamp for the time when the task set was created.
|
|
3678
3713
|
*/
|
|
3679
3714
|
createdAt?: Timestamp;
|
|
3680
3715
|
/**
|
|
3681
|
-
* The Unix timestamp for when the task set was last updated.
|
|
3716
|
+
* The Unix timestamp for the time when the task set was last updated.
|
|
3682
3717
|
*/
|
|
3683
3718
|
updatedAt?: Timestamp;
|
|
3684
3719
|
/**
|
|
@@ -3686,15 +3721,15 @@ declare namespace ECS {
|
|
|
3686
3721
|
*/
|
|
3687
3722
|
launchType?: LaunchType;
|
|
3688
3723
|
/**
|
|
3689
|
-
* The capacity provider strategy associated with the task set.
|
|
3724
|
+
* The capacity provider strategy that are associated with the task set.
|
|
3690
3725
|
*/
|
|
3691
3726
|
capacityProviderStrategy?: CapacityProviderStrategy;
|
|
3692
3727
|
/**
|
|
3693
|
-
* The Fargate platform version
|
|
3728
|
+
* 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.
|
|
3694
3729
|
*/
|
|
3695
3730
|
platformVersion?: String;
|
|
3696
3731
|
/**
|
|
3697
|
-
* The operating system that your tasks in the set are running on. A platform family is specified only for tasks
|
|
3732
|
+
* 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.
|
|
3698
3733
|
*/
|
|
3699
3734
|
platformFamily?: String;
|
|
3700
3735
|
/**
|
|
@@ -3702,27 +3737,27 @@ declare namespace ECS {
|
|
|
3702
3737
|
*/
|
|
3703
3738
|
networkConfiguration?: NetworkConfiguration;
|
|
3704
3739
|
/**
|
|
3705
|
-
* Details on a load balancer that
|
|
3740
|
+
* Details on a load balancer that are used with a task set.
|
|
3706
3741
|
*/
|
|
3707
3742
|
loadBalancers?: LoadBalancers;
|
|
3708
3743
|
/**
|
|
3709
|
-
* The details
|
|
3744
|
+
* The details for the service discovery registries to assign to this task set. For more information, see Service discovery.
|
|
3710
3745
|
*/
|
|
3711
3746
|
serviceRegistries?: ServiceRegistries;
|
|
3712
3747
|
/**
|
|
3713
|
-
* A floating-point percentage of
|
|
3748
|
+
* A floating-point percentage of your desired number of tasks to place and keep running in the task set.
|
|
3714
3749
|
*/
|
|
3715
3750
|
scale?: Scale;
|
|
3716
3751
|
/**
|
|
3717
|
-
* The stability status
|
|
3752
|
+
* The stability status. This indicates whether the task set has reached a steady state. If the following conditions are met, the task set sre 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 status. 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 STABILIZING.
|
|
3718
3753
|
*/
|
|
3719
3754
|
stabilityStatus?: StabilityStatus;
|
|
3720
3755
|
/**
|
|
3721
|
-
* The Unix timestamp for when the task set stability status was retrieved.
|
|
3756
|
+
* The Unix timestamp for the time when the task set stability status was retrieved.
|
|
3722
3757
|
*/
|
|
3723
3758
|
stabilityStatusAt?: Timestamp;
|
|
3724
3759
|
/**
|
|
3725
|
-
* 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
|
|
3760
|
+
* 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: Maximum number of tags per resource - 50 For each resource, each tag key must be unique, and each tag key can have only one value. Maximum key length - 128 Unicode characters in UTF-8 Maximum value length - 256 Unicode characters in UTF-8 If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
|
|
3726
3761
|
*/
|
|
3727
3762
|
tags?: Tags;
|
|
3728
3763
|
}
|
|
@@ -3766,7 +3801,7 @@ declare namespace ECS {
|
|
|
3766
3801
|
export type UlimitName = "core"|"cpu"|"data"|"fsize"|"locks"|"memlock"|"msgqueue"|"nice"|"nofile"|"nproc"|"rss"|"rtprio"|"rttime"|"sigpending"|"stack"|string;
|
|
3767
3802
|
export interface UntagResourceRequest {
|
|
3768
3803
|
/**
|
|
3769
|
-
* The Amazon Resource Name (ARN) of the resource
|
|
3804
|
+
* 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.
|
|
3770
3805
|
*/
|
|
3771
3806
|
resourceArn: String;
|
|
3772
3807
|
/**
|
|
@@ -3782,7 +3817,7 @@ declare namespace ECS {
|
|
|
3782
3817
|
*/
|
|
3783
3818
|
name: String;
|
|
3784
3819
|
/**
|
|
3785
|
-
* An object
|
|
3820
|
+
* An object that represent the parameters to update for the Auto Scaling group capacity provider.
|
|
3786
3821
|
*/
|
|
3787
3822
|
autoScalingGroupProvider: AutoScalingGroupProviderUpdate;
|
|
3788
3823
|
}
|
|
@@ -3818,7 +3853,7 @@ declare namespace ECS {
|
|
|
3818
3853
|
*/
|
|
3819
3854
|
cluster: String;
|
|
3820
3855
|
/**
|
|
3821
|
-
* The setting to use by default for a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it
|
|
3856
|
+
* The setting to use by default for a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
|
|
3822
3857
|
*/
|
|
3823
3858
|
settings: ClusterSettings;
|
|
3824
3859
|
}
|
|
@@ -3834,13 +3869,13 @@ declare namespace ECS {
|
|
|
3834
3869
|
*/
|
|
3835
3870
|
cluster?: String;
|
|
3836
3871
|
/**
|
|
3837
|
-
* The container instance ID or full ARN entries for the container instance
|
|
3872
|
+
* The container instance ID or full ARN entries for the container instance where you would like to update the Amazon ECS container agent.
|
|
3838
3873
|
*/
|
|
3839
3874
|
containerInstance: String;
|
|
3840
3875
|
}
|
|
3841
3876
|
export interface UpdateContainerAgentResponse {
|
|
3842
3877
|
/**
|
|
3843
|
-
* The container instance
|
|
3878
|
+
* The container instance that the container agent was updated for.
|
|
3844
3879
|
*/
|
|
3845
3880
|
containerInstance?: ContainerInstance;
|
|
3846
3881
|
}
|
|
@@ -3854,7 +3889,7 @@ declare namespace ECS {
|
|
|
3854
3889
|
*/
|
|
3855
3890
|
containerInstances: StringList;
|
|
3856
3891
|
/**
|
|
3857
|
-
* The container instance state
|
|
3892
|
+
* The container instance state to update the container instance with. The only valid values for this action are 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.
|
|
3858
3893
|
*/
|
|
3859
3894
|
status: ContainerInstanceStatus;
|
|
3860
3895
|
}
|
|
@@ -3890,7 +3925,7 @@ declare namespace ECS {
|
|
|
3890
3925
|
}
|
|
3891
3926
|
export interface UpdateServiceRequest {
|
|
3892
3927
|
/**
|
|
3893
|
-
* The short name or full Amazon Resource Name (ARN) of the cluster that your service
|
|
3928
|
+
* The short name or full Amazon Resource Name (ARN) of the cluster that your service runs on. If you do not specify a cluster, the default cluster is assumed.
|
|
3894
3929
|
*/
|
|
3895
3930
|
cluster?: String;
|
|
3896
3931
|
/**
|
|
@@ -3906,7 +3941,7 @@ declare namespace ECS {
|
|
|
3906
3941
|
*/
|
|
3907
3942
|
taskDefinition?: String;
|
|
3908
3943
|
/**
|
|
3909
|
-
* The capacity provider strategy to update the service to use.
|
|
3944
|
+
* 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. 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. 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 PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
|
|
3910
3945
|
*/
|
|
3911
3946
|
capacityProviderStrategy?: CapacityProviderStrategy;
|
|
3912
3947
|
/**
|
|
@@ -3918,23 +3953,23 @@ declare namespace ECS {
|
|
|
3918
3953
|
*/
|
|
3919
3954
|
networkConfiguration?: NetworkConfiguration;
|
|
3920
3955
|
/**
|
|
3921
|
-
* 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
|
|
3956
|
+
* 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.
|
|
3922
3957
|
*/
|
|
3923
3958
|
placementConstraints?: PlacementConstraints;
|
|
3924
3959
|
/**
|
|
3925
|
-
* 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
|
|
3960
|
+
* 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.
|
|
3926
3961
|
*/
|
|
3927
3962
|
placementStrategy?: PlacementStrategies;
|
|
3928
3963
|
/**
|
|
3929
|
-
* The platform version
|
|
3964
|
+
* 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.
|
|
3930
3965
|
*/
|
|
3931
3966
|
platformVersion?: String;
|
|
3932
3967
|
/**
|
|
3933
|
-
*
|
|
3968
|
+
* 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.
|
|
3934
3969
|
*/
|
|
3935
3970
|
forceNewDeployment?: Boolean;
|
|
3936
3971
|
/**
|
|
3937
|
-
* The period of time, in seconds, that the Amazon ECS service scheduler
|
|
3972
|
+
* 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.
|
|
3938
3973
|
*/
|
|
3939
3974
|
healthCheckGracePeriodSeconds?: BoxedInteger;
|
|
3940
3975
|
/**
|
|
@@ -3950,11 +3985,11 @@ declare namespace ECS {
|
|
|
3950
3985
|
}
|
|
3951
3986
|
export interface UpdateTaskSetRequest {
|
|
3952
3987
|
/**
|
|
3953
|
-
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set
|
|
3988
|
+
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set is found in.
|
|
3954
3989
|
*/
|
|
3955
3990
|
cluster: String;
|
|
3956
3991
|
/**
|
|
3957
|
-
* The short name or full Amazon Resource Name (ARN) of the service that the task set
|
|
3992
|
+
* The short name or full Amazon Resource Name (ARN) of the service that the task set is found in.
|
|
3958
3993
|
*/
|
|
3959
3994
|
service: String;
|
|
3960
3995
|
/**
|
|
@@ -3982,7 +4017,7 @@ declare namespace ECS {
|
|
|
3982
4017
|
*/
|
|
3983
4018
|
agentHash?: String;
|
|
3984
4019
|
/**
|
|
3985
|
-
* The Docker version running on the container instance.
|
|
4020
|
+
* The Docker version that's running on the container instance.
|
|
3986
4021
|
*/
|
|
3987
4022
|
dockerVersion?: String;
|
|
3988
4023
|
}
|
|
@@ -3992,25 +4027,25 @@ declare namespace ECS {
|
|
|
3992
4027
|
*/
|
|
3993
4028
|
name?: String;
|
|
3994
4029
|
/**
|
|
3995
|
-
* This parameter is specified when you
|
|
4030
|
+
* 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 D:\my\path:C:\my\path or D:\:C:\my\path.
|
|
3996
4031
|
*/
|
|
3997
4032
|
host?: HostVolumeProperties;
|
|
3998
4033
|
/**
|
|
3999
|
-
* This parameter is specified when you
|
|
4034
|
+
* 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. Docker volumes aren't supported by tasks run on Fargate.
|
|
4000
4035
|
*/
|
|
4001
4036
|
dockerVolumeConfiguration?: DockerVolumeConfiguration;
|
|
4002
4037
|
/**
|
|
4003
|
-
* This parameter is specified when you
|
|
4038
|
+
* This parameter is specified when you use an Amazon Elastic File System file system for task storage.
|
|
4004
4039
|
*/
|
|
4005
4040
|
efsVolumeConfiguration?: EFSVolumeConfiguration;
|
|
4006
4041
|
/**
|
|
4007
|
-
* This parameter is specified when you
|
|
4042
|
+
* This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
|
|
4008
4043
|
*/
|
|
4009
4044
|
fsxWindowsFileServerVolumeConfiguration?: FSxWindowsFileServerVolumeConfiguration;
|
|
4010
4045
|
}
|
|
4011
4046
|
export interface VolumeFrom {
|
|
4012
4047
|
/**
|
|
4013
|
-
* The name of another container within the same task definition
|
|
4048
|
+
* The name of another container within the same task definition to mount volumes from.
|
|
4014
4049
|
*/
|
|
4015
4050
|
sourceContainer?: String;
|
|
4016
4051
|
/**
|