@awboost/cfn-resource-types 0.1.51 → 0.1.53
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/lib/AWS-ARCZonalShift-ZonalAutoshiftConfiguration.d.ts +1 -1
- package/lib/AWS-Amplify-Domain.d.ts +12 -2
- package/lib/AWS-Bedrock-DataSource.d.ts +179 -0
- package/lib/AWS-Bedrock-DataSource.js +12 -0
- package/lib/AWS-Bedrock-KnowledgeBase.d.ts +316 -0
- package/lib/AWS-Bedrock-KnowledgeBase.js +12 -0
- package/lib/AWS-CleanRoomsML-TrainingDataset.d.ts +155 -0
- package/lib/AWS-CleanRoomsML-TrainingDataset.js +12 -0
- package/lib/AWS-Deadline-Farm.d.ts +45 -0
- package/lib/AWS-Deadline-Farm.js +12 -0
- package/lib/AWS-Deadline-Fleet.d.ts +348 -0
- package/lib/AWS-Deadline-Fleet.js +12 -0
- package/lib/AWS-Deadline-LicenseEndpoint.d.ts +58 -0
- package/lib/AWS-Deadline-LicenseEndpoint.js +12 -0
- package/lib/AWS-Deadline-MeteredProduct.d.ts +50 -0
- package/lib/AWS-Deadline-MeteredProduct.js +12 -0
- package/lib/AWS-Deadline-Queue.d.ts +134 -0
- package/lib/AWS-Deadline-Queue.js +12 -0
- package/lib/AWS-Deadline-QueueEnvironment.d.ts +52 -0
- package/lib/AWS-Deadline-QueueEnvironment.js +12 -0
- package/lib/AWS-Deadline-QueueFleetAssociation.d.ts +29 -0
- package/lib/AWS-Deadline-QueueFleetAssociation.js +12 -0
- package/lib/AWS-Deadline-StorageProfile.d.ts +70 -0
- package/lib/AWS-Deadline-StorageProfile.js +12 -0
- package/lib/AWS-EC2-SecurityGroup.d.ts +0 -1
- package/lib/AWS-EC2-Subnet.d.ts +7 -4
- package/lib/AWS-ECS-TaskDefinition.d.ts +146 -41
- package/lib/AWS-ECS-TaskDefinition.js +3 -1
- package/lib/AWS-EntityResolution-IdNamespace.d.ts +130 -0
- package/lib/AWS-EntityResolution-IdNamespace.js +13 -0
- package/lib/AWS-EntityResolution-PolicyStatement.d.ts +44 -0
- package/lib/AWS-EntityResolution-PolicyStatement.js +13 -0
- package/lib/AWS-GlobalAccelerator-CrossAccountAttachment.d.ts +71 -0
- package/lib/AWS-GlobalAccelerator-CrossAccountAttachment.js +12 -0
- package/lib/AWS-IVS-EncoderConfiguration.d.ts +90 -0
- package/lib/AWS-IVS-EncoderConfiguration.js +12 -0
- package/lib/AWS-IVS-PlaybackRestrictionPolicy.d.ts +73 -0
- package/lib/AWS-IVS-PlaybackRestrictionPolicy.js +12 -0
- package/lib/AWS-IVS-StorageConfiguration.d.ts +76 -0
- package/lib/AWS-IVS-StorageConfiguration.js +12 -0
- package/lib/AWS-Lambda-Function.d.ts +5 -5
- package/lib/AWS-MediaTailor-Channel.d.ts +4 -0
- package/lib/AWS-RDS-CustomDBEngineVersion.d.ts +13 -1
- package/lib/AWS-Route53-HostedZone.d.ts +4 -4
- package/lib/AWS-SSM-Parameter.d.ts +1 -1
- package/lib/AWS-SageMaker-Domain.d.ts +6 -0
- package/lib/AWS-SageMaker-UserProfile.d.ts +6 -0
- package/lib/AWS-SecurityHub-Insight.d.ts +35 -3
- package/package.json +2 -2
|
@@ -4,7 +4,9 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
4
4
|
* Resource type definition for `AWS::ECS::TaskDefinition`.
|
|
5
5
|
* 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
6
6
|
You can specify a role for your task with the ``taskRoleArn`` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
7
|
-
You can specify a Docker networking mode for the containers in your task definition with the ``
|
|
7
|
+
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](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#/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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
8
|
+
In the following example or examples, the Authorization header contents (``AUTHPARAMS``) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*.
|
|
9
|
+
You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.
|
|
8
10
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html}
|
|
9
11
|
*/
|
|
10
12
|
export type ECSTaskDefinitionProperties = {
|
|
@@ -20,7 +22,10 @@ export type ECSTaskDefinitionProperties = {
|
|
|
20
22
|
+ 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)
|
|
21
23
|
+ 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
|
|
22
24
|
+ 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
|
|
23
|
-
+ 8192 (8 vCPU) - Available ``memory``
|
|
25
|
+
+ 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments
|
|
26
|
+
This option requires Linux platform ``1.4.0`` or later.
|
|
27
|
+
+ 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments
|
|
28
|
+
This option requires Linux platform ``1.4.0`` or later.
|
|
24
29
|
*/
|
|
25
30
|
Cpu?: string;
|
|
26
31
|
/**
|
|
@@ -43,7 +48,12 @@ export type ECSTaskDefinitionProperties = {
|
|
|
43
48
|
InferenceAccelerators?: InferenceAccelerator[];
|
|
44
49
|
/**
|
|
45
50
|
* The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*.
|
|
46
|
-
If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more
|
|
51
|
+
If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).
|
|
52
|
+
If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
53
|
+
+ For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported.
|
|
54
|
+
+ For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task.
|
|
55
|
+
|
|
56
|
+
This parameter is not supported for Windows containers or tasks run on FARGATElong.
|
|
47
57
|
*/
|
|
48
58
|
IpcMode?: string;
|
|
49
59
|
/**
|
|
@@ -52,13 +62,23 @@ export type ECSTaskDefinitionProperties = {
|
|
|
52
62
|
If your tasks runs on FARGATElong, 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.
|
|
53
63
|
+ 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU)
|
|
54
64
|
+ 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU)
|
|
55
|
-
+ 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu``
|
|
65
|
+
+ 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)
|
|
66
|
+
+ Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU)
|
|
67
|
+
+ Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU)
|
|
68
|
+
+ Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU)
|
|
69
|
+
This option requires Linux platform ``1.4.0`` or later.
|
|
70
|
+
+ Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU)
|
|
71
|
+
This option requires Linux platform ``1.4.0`` or later.
|
|
56
72
|
*/
|
|
57
73
|
Memory?: string;
|
|
58
74
|
/**
|
|
59
75
|
* The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``.
|
|
60
76
|
For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ``<default>`` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode.
|
|
61
|
-
With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached
|
|
77
|
+
With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings.
|
|
78
|
+
When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.
|
|
79
|
+
If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
80
|
+
If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
|
|
81
|
+
For more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*.
|
|
62
82
|
*/
|
|
63
83
|
NetworkMode?: string;
|
|
64
84
|
/**
|
|
@@ -66,7 +86,9 @@ export type ECSTaskDefinitionProperties = {
|
|
|
66
86
|
If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.
|
|
67
87
|
If ``task`` is specified, all containers within the specified task share the same process namespace.
|
|
68
88
|
If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*.
|
|
69
|
-
If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://
|
|
89
|
+
If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/).
|
|
90
|
+
This parameter is not supported for Windows containers.
|
|
91
|
+
This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.
|
|
70
92
|
*/
|
|
71
93
|
PidMode?: string;
|
|
72
94
|
/**
|
|
@@ -97,7 +119,7 @@ export type ECSTaskDefinitionProperties = {
|
|
|
97
119
|
+ Maximum value length - 256 Unicode characters in UTF-8
|
|
98
120
|
+ 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: + - = . _ : / @.
|
|
99
121
|
+ Tag keys and values are case-sensitive.
|
|
100
|
-
+ 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 AWS use. You cannot edit or delete tag keys or values
|
|
122
|
+
+ 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 AWS 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.
|
|
101
123
|
*/
|
|
102
124
|
Tags?: Tag[];
|
|
103
125
|
/**
|
|
@@ -147,7 +169,12 @@ export type ContainerDefinition = {
|
|
|
147
169
|
* The number of ``cpu`` units reserved for the container. This parameter maps to ``CpuShares`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cpu-shares`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).
|
|
148
170
|
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.
|
|
149
171
|
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](https://docs.aws.amazon.com/ec2/instance-types/) detail page by 1,024.
|
|
150
|
-
Linux containers share unallocated CPU units with other containers on the
|
|
172
|
+
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.
|
|
173
|
+
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](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#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:
|
|
174
|
+
+ *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.
|
|
175
|
+
+ *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2.
|
|
176
|
+
|
|
177
|
+
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.
|
|
151
178
|
*/
|
|
152
179
|
Cpu?: number;
|
|
153
180
|
/**
|
|
@@ -155,12 +182,17 @@ export type ContainerDefinition = {
|
|
|
155
182
|
There are two formats for each ARN.
|
|
156
183
|
+ credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition.
|
|
157
184
|
In both formats, replace ``MyARN`` with the ARN in SSM or Amazon S3.
|
|
158
|
-
If you provide a ``credentialspecdomainless:MyARN``, the ``credspec`` must
|
|
185
|
+
If you provide a ``credentialspecdomainless:MyARN``, the ``credspec`` must provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html).
|
|
159
186
|
*/
|
|
160
187
|
CredentialSpecs?: string[];
|
|
161
188
|
/**
|
|
162
189
|
* 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.
|
|
163
|
-
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) 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 [
|
|
190
|
+
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
191
|
+
For tasks using the Fargate launch type, the task or service requires the following platforms:
|
|
192
|
+
+ Linux platform version ``1.3.0`` or later.
|
|
193
|
+
+ Windows platform version ``1.0.0`` or later.
|
|
194
|
+
|
|
195
|
+
If the task definition is used in a blue/green deployment that uses [AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html), the ``dependsOn`` parameter is not supported. For more information see [Issue #680](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-coverage-roadmap/issues/680) on the on the GitHub website.
|
|
164
196
|
*/
|
|
165
197
|
DependsOn?: ContainerDependency[];
|
|
166
198
|
/**
|
|
@@ -186,7 +218,10 @@ export type ContainerDefinition = {
|
|
|
186
218
|
* A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see [Docker Run Security Configuration](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This field isn't valid for containers in tasks using the Fargate launch type.
|
|
187
219
|
For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.
|
|
188
220
|
For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
189
|
-
This parameter maps to ``SecurityOpt`` in the [Create a
|
|
221
|
+
This parameter maps to ``SecurityOpt`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--security-opt`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).
|
|
222
|
+
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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
223
|
+
For more information about valid values, see [Docker Run Security Configuration](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).
|
|
224
|
+
Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
|
|
190
225
|
*/
|
|
191
226
|
DockerSecurityOptions?: string[];
|
|
192
227
|
/**
|
|
@@ -202,7 +237,7 @@ export type ContainerDefinition = {
|
|
|
202
237
|
/**
|
|
203
238
|
* A list of files containing the environment variables to pass to a container. This parameter maps to the ``--env-file`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).
|
|
204
239
|
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](https://docs.aws.amazon.com/https://docs.docker.com/compose/env-file/).
|
|
205
|
-
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
|
|
240
|
+
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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
206
241
|
*/
|
|
207
242
|
EnvironmentFiles?: EnvironmentFile[];
|
|
208
243
|
/**
|
|
@@ -230,7 +265,11 @@ export type ContainerDefinition = {
|
|
|
230
265
|
Hostname?: string;
|
|
231
266
|
/**
|
|
232
267
|
* 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](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``IMAGE`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).
|
|
233
|
-
+ 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
|
|
268
|
+
+ 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.
|
|
269
|
+
+ 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``.
|
|
270
|
+
+ Images in official repositories on Docker Hub use a single name (for example, ``ubuntu`` or ``mongo``).
|
|
271
|
+
+ Images in other repositories on Docker Hub are qualified with an organization name (for example, ``amazon/amazon-ecs-agent``).
|
|
272
|
+
+ Images in other online repositories are qualified further by a domain name (for example, ``quay.io/assemblyline/ubuntu``).
|
|
234
273
|
*/
|
|
235
274
|
Image: string;
|
|
236
275
|
/**
|
|
@@ -239,7 +278,8 @@ export type ContainerDefinition = {
|
|
|
239
278
|
Interactive?: boolean;
|
|
240
279
|
/**
|
|
241
280
|
* The ``links`` parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is ``bridge``. The ``name:internalName`` construct is analogous to ``name:alias`` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to [Legacy container links](https://docs.aws.amazon.com/https://docs.docker.com/network/links/) in the Docker documentation. This parameter maps to ``Links`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--link`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).
|
|
242
|
-
This parameter is not supported for
|
|
281
|
+
This parameter is not supported for Windows containers.
|
|
282
|
+
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
|
|
243
283
|
*/
|
|
244
284
|
Links?: string[];
|
|
245
285
|
/**
|
|
@@ -249,18 +289,26 @@ export type ContainerDefinition = {
|
|
|
249
289
|
LinuxParameters?: LinuxParameters;
|
|
250
290
|
/**
|
|
251
291
|
* The log configuration specification for the container.
|
|
252
|
-
This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container may 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 on the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/
|
|
292
|
+
This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container may 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 on the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.
|
|
293
|
+
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
|
|
294
|
+
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}}'``
|
|
295
|
+
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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
253
296
|
*/
|
|
254
297
|
LogConfiguration?: LogConfiguration;
|
|
255
298
|
/**
|
|
256
299
|
* 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](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).
|
|
257
300
|
If using the Fargate launch type, this parameter is optional.
|
|
258
|
-
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 ``
|
|
301
|
+
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.
|
|
302
|
+
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers.
|
|
303
|
+
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
|
|
259
304
|
*/
|
|
260
305
|
Memory?: number;
|
|
261
306
|
/**
|
|
262
307
|
* 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](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory-reservation`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).
|
|
263
|
-
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
|
|
308
|
+
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.
|
|
309
|
+
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.
|
|
310
|
+
The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers.
|
|
311
|
+
The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
|
|
264
312
|
*/
|
|
265
313
|
MemoryReservation?: number;
|
|
266
314
|
/**
|
|
@@ -277,7 +325,8 @@ export type ContainerDefinition = {
|
|
|
277
325
|
* 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.
|
|
278
326
|
For task definitions that use the ``awsvpc`` network mode, you should only specify the ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``.
|
|
279
327
|
Port mappings on Windows use the ``NetNAT`` gateway address rather than ``localhost``. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.
|
|
280
|
-
This parameter maps to ``PortBindings`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--publish`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). If the network mode of a task definition is set to
|
|
328
|
+
This parameter maps to ``PortBindings`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--publish`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/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.
|
|
329
|
+
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](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses.
|
|
281
330
|
*/
|
|
282
331
|
PortMappings?: PortMapping[];
|
|
283
332
|
/**
|
|
@@ -313,7 +362,8 @@ export type ContainerDefinition = {
|
|
|
313
362
|
+ Linux platform version ``1.3.0`` or later.
|
|
314
363
|
+ Windows platform version ``1.0.0`` or later.
|
|
315
364
|
|
|
316
|
-
For tasks using the EC2 launch type, your container instances require at least version ``1.26.0`` of the container agent to use a container start timeout value. However
|
|
365
|
+
For tasks using the EC2 launch type, your container instances require at least version ``1.26.0`` of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
366
|
+
The valid values are 2-120 seconds.
|
|
317
367
|
*/
|
|
318
368
|
StartTimeout?: number;
|
|
319
369
|
/**
|
|
@@ -323,7 +373,8 @@ export type ContainerDefinition = {
|
|
|
323
373
|
+ Windows platform version ``1.0.0`` or later.
|
|
324
374
|
|
|
325
375
|
The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
|
|
326
|
-
For tasks that use the EC2 launch type, if the ``stopTimeout`` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ``ECS_CONTAINER_STOP_TIMEOUT`` is used. If neither the ``stopTimeout`` parameter or the ``ECS_CONTAINER_STOP_TIMEOUT`` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we
|
|
376
|
+
For tasks that use the EC2 launch type, if the ``stopTimeout`` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ``ECS_CONTAINER_STOP_TIMEOUT`` is used. If neither the ``stopTimeout`` parameter or the ``ECS_CONTAINER_STOP_TIMEOUT`` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
377
|
+
The valid values are 2-120 seconds.
|
|
327
378
|
*/
|
|
328
379
|
StopTimeout?: number;
|
|
329
380
|
/**
|
|
@@ -361,7 +412,8 @@ export type ContainerDefinition = {
|
|
|
361
412
|
/**
|
|
362
413
|
* Type definition for `AWS::ECS::TaskDefinition.ContainerDependency`.
|
|
363
414
|
* The ``ContainerDependency`` property specifies 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.
|
|
364
|
-
Your Amazon ECS 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you are 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
|
|
415
|
+
Your Amazon ECS 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you are 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
416
|
+
For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.
|
|
365
417
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html}
|
|
366
418
|
*/
|
|
367
419
|
export type ContainerDependency = {
|
|
@@ -370,7 +422,7 @@ export type ContainerDependency = {
|
|
|
370
422
|
+ ``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.
|
|
371
423
|
+ ``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.
|
|
372
424
|
+ ``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.
|
|
373
|
-
+ ``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
|
|
425
|
+
+ ``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.
|
|
374
426
|
*/
|
|
375
427
|
Condition?: string;
|
|
376
428
|
/**
|
|
@@ -456,14 +508,21 @@ export type EFSVolumeConfiguration = {
|
|
|
456
508
|
/**
|
|
457
509
|
* Type definition for `AWS::ECS::TaskDefinition.EnvironmentFile`.
|
|
458
510
|
* A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file should contain an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored.
|
|
459
|
-
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 [
|
|
511
|
+
If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Use a file to pass environment variables to a container](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/use-environment-file.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
512
|
+
Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations apply.
|
|
460
513
|
You must use the following platforms for the Fargate launch type:
|
|
461
|
-
+ Linux platform version ``1.4.0`` or
|
|
514
|
+
+ Linux platform version ``1.4.0`` or later.
|
|
515
|
+
+ Windows platform version ``1.0.0`` or later.
|
|
516
|
+
|
|
517
|
+
Consider the following when using the Fargate launch type:
|
|
518
|
+
+ The file is handled like a native Docker env-file.
|
|
519
|
+
+ There is no support for shell escape handling.
|
|
520
|
+
+ The container entry point interperts the ``VARIABLE`` values.
|
|
462
521
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-environmentfile.html}
|
|
463
522
|
*/
|
|
464
523
|
export type EnvironmentFile = {
|
|
465
524
|
/**
|
|
466
|
-
* The file type to use. The only supported value is ``s3``.
|
|
525
|
+
* The file type to use. Environment files are objects in Amazon S3. The only supported value is ``s3``.
|
|
467
526
|
*/
|
|
468
527
|
Type?: string;
|
|
469
528
|
/**
|
|
@@ -481,7 +540,7 @@ export type EnvironmentFile = {
|
|
|
481
540
|
*/
|
|
482
541
|
export type EphemeralStorage = {
|
|
483
542
|
/**
|
|
484
|
-
* The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is ``
|
|
543
|
+
* The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is ``20`` GiB and the maximum supported value is ``200`` GiB.
|
|
485
544
|
*/
|
|
486
545
|
SizeInGiB?: number;
|
|
487
546
|
};
|
|
@@ -494,9 +553,9 @@ export type FirelensConfiguration = {
|
|
|
494
553
|
/**
|
|
495
554
|
* The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event.
|
|
496
555
|
If specified, valid option keys are:
|
|
497
|
-
+
|
|
498
|
-
+
|
|
499
|
-
+
|
|
556
|
+
+ ``enable-ecs-log-metadata``, which can be ``true`` or ``false``
|
|
557
|
+
+ ``config-file-type``, which can be ``s3`` or ``file``
|
|
558
|
+
+ ``config-file-value``, which is either an S3 ARN or a file path
|
|
500
559
|
*/
|
|
501
560
|
Options?: Record<string, string>;
|
|
502
561
|
/**
|
|
@@ -504,11 +563,32 @@ export type FirelensConfiguration = {
|
|
|
504
563
|
*/
|
|
505
564
|
Type?: string;
|
|
506
565
|
};
|
|
566
|
+
/**
|
|
567
|
+
* Type definition for `AWS::ECS::TaskDefinition.FSxAuthorizationConfig`.
|
|
568
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-fsxauthorizationconfig.html}
|
|
569
|
+
*/
|
|
570
|
+
export type FSxAuthorizationConfig = {
|
|
571
|
+
CredentialsParameter: string;
|
|
572
|
+
Domain: string;
|
|
573
|
+
};
|
|
574
|
+
/**
|
|
575
|
+
* Type definition for `AWS::ECS::TaskDefinition.FSxWindowsFileServerVolumeConfiguration`.
|
|
576
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-fsxwindowsfileservervolumeconfiguration.html}
|
|
577
|
+
*/
|
|
578
|
+
export type FSxWindowsFileServerVolumeConfiguration = {
|
|
579
|
+
AuthorizationConfig?: FSxAuthorizationConfig;
|
|
580
|
+
FileSystemId: string;
|
|
581
|
+
RootDirectory: string;
|
|
582
|
+
};
|
|
507
583
|
/**
|
|
508
584
|
* Type definition for `AWS::ECS::TaskDefinition.HealthCheck`.
|
|
509
585
|
* The ``HealthCheck`` property specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to the ``HEALTHCHECK`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/).
|
|
510
586
|
The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
|
|
511
|
-
If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a
|
|
587
|
+
If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.
|
|
588
|
+
The following are notes about container health check support:
|
|
589
|
+
+ Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html).
|
|
590
|
+
+ Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see [Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html).
|
|
591
|
+
+ Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.
|
|
512
592
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html}
|
|
513
593
|
*/
|
|
514
594
|
export type HealthCheck = {
|
|
@@ -583,19 +663,19 @@ export type InferenceAccelerator = {
|
|
|
583
663
|
};
|
|
584
664
|
/**
|
|
585
665
|
* Type definition for `AWS::ECS::TaskDefinition.KernelCapabilities`.
|
|
586
|
-
* The
|
|
666
|
+
* The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see [Runtime privilege and Linux capabilities](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) in the *Docker run reference*. For more detailed information about these Linux capabilities, see the [capabilities(7)](https://docs.aws.amazon.com/http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page.
|
|
587
667
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-kernelcapabilities.html}
|
|
588
668
|
*/
|
|
589
669
|
export type KernelCapabilities = {
|
|
590
670
|
/**
|
|
591
671
|
* The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to ``CapAdd`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cap-add`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).
|
|
592
672
|
Tasks launched on FARGATElong only support adding the ``SYS_PTRACE`` kernel capability.
|
|
593
|
-
Valid values: ``"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT"
|
|
673
|
+
Valid values: ``"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"``
|
|
594
674
|
*/
|
|
595
675
|
Add?: string[];
|
|
596
676
|
/**
|
|
597
677
|
* The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to ``CapDrop`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cap-drop`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).
|
|
598
|
-
Valid values: ``"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO"
|
|
678
|
+
Valid values: ``"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"``
|
|
599
679
|
*/
|
|
600
680
|
Drop?: string[];
|
|
601
681
|
};
|
|
@@ -670,7 +750,7 @@ export type LogConfiguration = {
|
|
|
670
750
|
For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``.
|
|
671
751
|
For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
672
752
|
For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
673
|
-
If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs
|
|
753
|
+
If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) 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.
|
|
674
754
|
*/
|
|
675
755
|
LogDriver: string;
|
|
676
756
|
/**
|
|
@@ -713,7 +793,7 @@ export type PortMapping = {
|
|
|
713
793
|
* The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.
|
|
714
794
|
If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
|
|
715
795
|
``appProtocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.
|
|
716
|
-
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS
|
|
796
|
+
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
717
797
|
*/
|
|
718
798
|
AppProtocol?: "http" | "http2" | "grpc";
|
|
719
799
|
/**
|
|
@@ -732,7 +812,17 @@ export type PortMapping = {
|
|
|
732
812
|
+ You can specify a maximum of 100 port ranges per container.
|
|
733
813
|
+ You do not specify a ``hostPortRange``. The value of the ``hostPortRange`` is set as follows:
|
|
734
814
|
+ For containers in a task with the ``awsvpc`` network mode, the ``hostPortRange`` is set to the same value as the ``containerPortRange``. This is a static mapping strategy.
|
|
735
|
-
+ For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open host
|
|
815
|
+
+ For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.
|
|
816
|
+
|
|
817
|
+
+ The ``containerPortRange`` valid values are between 1 and 65535.
|
|
818
|
+
+ A port can only be included in one port mapping per container.
|
|
819
|
+
+ You cannot specify overlapping port ranges.
|
|
820
|
+
+ The first port in the range must be less than last port in the range.
|
|
821
|
+
+ Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.
|
|
822
|
+
For more information, see [Issue #11185](https://docs.aws.amazon.com/https://github.com/moby/moby/issues/11185) on the Github website.
|
|
823
|
+
For information about how to turn off the docker-proxy in the Docker daemon config file, see [Docker daemon](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon) in the *Amazon ECS Developer Guide*.
|
|
824
|
+
|
|
825
|
+
You can call [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) to view the ``hostPortRange`` which are the host ports that are bound to the container ports.
|
|
736
826
|
*/
|
|
737
827
|
ContainerPortRange?: string;
|
|
738
828
|
/**
|
|
@@ -742,7 +832,9 @@ export type PortMapping = {
|
|
|
742
832
|
+ For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy.
|
|
743
833
|
|
|
744
834
|
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``.
|
|
745
|
-
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
|
|
835
|
+
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.
|
|
836
|
+
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 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
|
|
837
|
+
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](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) 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.
|
|
746
838
|
*/
|
|
747
839
|
HostPort?: number;
|
|
748
840
|
/**
|
|
@@ -772,7 +864,9 @@ export type ProxyConfiguration = {
|
|
|
772
864
|
+ ``IgnoredGID`` - (Required) The group ID (GID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredUID`` is specified, this field can be empty.
|
|
773
865
|
+ ``AppPorts`` - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ``ProxyIngressPort`` and ``ProxyEgressPort``.
|
|
774
866
|
+ ``ProxyIngressPort`` - (Required) Specifies the port that incoming traffic to the ``AppPorts`` is directed to.
|
|
775
|
-
+ ``ProxyEgressPort`` - (Required) Specifies the port that
|
|
867
|
+
+ ``ProxyEgressPort`` - (Required) Specifies the port that outgoing traffic from the ``AppPorts`` is directed to.
|
|
868
|
+
+ ``EgressIgnoredPorts`` - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list.
|
|
869
|
+
+ ``EgressIgnoredIPs`` - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list.
|
|
776
870
|
*/
|
|
777
871
|
ProxyConfigurationProperties?: KeyValuePair[];
|
|
778
872
|
/**
|
|
@@ -851,7 +945,15 @@ export type Secret = {
|
|
|
851
945
|
* Type definition for `AWS::ECS::TaskDefinition.SystemControl`.
|
|
852
946
|
* A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--sysctl`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections.
|
|
853
947
|
We don't recommend that you specify network-related ``systemControls`` parameters for multiple containers in a single task that also uses either the ``awsvpc`` or ``host`` network mode. Doing this has the following disadvantages:
|
|
854
|
-
+ For tasks that use the ``awsvpc`` network mode including Fargate, if you set ``systemControls`` for any container, it applies to all containers in the task. If you set different ``
|
|
948
|
+
+ For tasks that use the ``awsvpc`` network mode including Fargate, if you set ``systemControls`` for any container, it applies to all containers in the task. If you set different ``systemControls`` for multiple containers in a single task, the container that's started last determines which ``systemControls`` take effect.
|
|
949
|
+
+ For tasks that use the ``host`` network mode, the network namespace ``systemControls`` aren't supported.
|
|
950
|
+
|
|
951
|
+
If you're setting an IPC resource namespace to use for the containers in the task, the following conditions apply to your system controls. For more information, see [IPC mode](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_definition_ipcmode).
|
|
952
|
+
+ For tasks that use the ``host`` IPC mode, IPC namespace ``systemControls`` aren't supported.
|
|
953
|
+
+ For tasks that use the ``task`` IPC mode, IPC namespace ``systemControls`` values apply to all containers within a task.
|
|
954
|
+
|
|
955
|
+
This parameter is not supported for Windows containers.
|
|
956
|
+
This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.
|
|
855
957
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-systemcontrol.html}
|
|
856
958
|
*/
|
|
857
959
|
export type SystemControl = {
|
|
@@ -877,7 +979,7 @@ export type SystemControl = {
|
|
|
877
979
|
+ Maximum value length - 256 Unicode characters in UTF-8
|
|
878
980
|
+ 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: + - = . _ : / @.
|
|
879
981
|
+ Tag keys and values are case-sensitive.
|
|
880
|
-
+ 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 AWS use. You cannot edit or delete tag keys or values with this prefix
|
|
982
|
+
+ 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 AWS 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.
|
|
881
983
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-tag.html}
|
|
882
984
|
*/
|
|
883
985
|
export type Tag = {
|
|
@@ -968,6 +1070,7 @@ export type Volume = {
|
|
|
968
1070
|
* This parameter is specified when you use an Amazon Elastic File System file system for task storage.
|
|
969
1071
|
*/
|
|
970
1072
|
EFSVolumeConfiguration?: EFSVolumeConfiguration;
|
|
1073
|
+
FSxWindowsFileServerVolumeConfiguration?: FSxWindowsFileServerVolumeConfiguration;
|
|
971
1074
|
/**
|
|
972
1075
|
* 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.
|
|
973
1076
|
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``.
|
|
@@ -1000,7 +1103,9 @@ export type VolumeFrom = {
|
|
|
1000
1103
|
* Resource type definition for `AWS::ECS::TaskDefinition`.
|
|
1001
1104
|
* 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
1002
1105
|
You can specify a role for your task with the ``taskRoleArn`` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
1003
|
-
You can specify a Docker networking mode for the containers in your task definition with the ``
|
|
1106
|
+
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](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#/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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
1107
|
+
In the following example or examples, the Authorization header contents (``AUTHPARAMS``) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*.
|
|
1108
|
+
You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.
|
|
1004
1109
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html}
|
|
1005
1110
|
*/
|
|
1006
1111
|
export declare class ECSTaskDefinition extends $Resource<"AWS::ECS::TaskDefinition", ECSTaskDefinitionProperties, ECSTaskDefinitionAttributes> {
|
|
@@ -3,7 +3,9 @@ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/re
|
|
|
3
3
|
* Resource type definition for `AWS::ECS::TaskDefinition`.
|
|
4
4
|
* 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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
5
5
|
You can specify a role for your task with the ``taskRoleArn`` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
6
|
-
You can specify a Docker networking mode for the containers in your task definition with the ``
|
|
6
|
+
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](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#/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](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
|
|
7
|
+
In the following example or examples, the Authorization header contents (``AUTHPARAMS``) must be replaced with an AWS Signature Version 4 signature. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *General Reference*.
|
|
8
|
+
You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the [](https://docs.aws.amazon.com/cli/) or one of the [SDKs](https://docs.aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.
|
|
7
9
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html}
|
|
8
10
|
*/
|
|
9
11
|
export class ECSTaskDefinition extends $Resource {
|