Class CfnTaskDefinition.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTaskDefinition>
- Enclosing class:
CfnTaskDefinition
CfnTaskDefinition
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
containerDefinitions
(List<? extends Object> containerDefinitions) A list of container definitions in JSON format that describe the different containers that make up your task.containerDefinitions
(IResolvable containerDefinitions) A list of container definitions in JSON format that describe the different containers that make up your task.The number ofcpu
units used by the task.static CfnTaskDefinition.Builder
ephemeralStorage
(IResolvable ephemeralStorage) The ephemeral storage settings to use for tasks run with the task definition.ephemeralStorage
(CfnTaskDefinition.EphemeralStorageProperty ephemeralStorage) The ephemeral storage settings to use for tasks run with the task definition.executionRoleArn
(String executionRoleArn) The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf.The name of a family that this task definition is registered to.inferenceAccelerators
(List<? extends Object> inferenceAccelerators) The Elastic Inference accelerators to use for the containers in the task.inferenceAccelerators
(IResolvable inferenceAccelerators) The Elastic Inference accelerators to use for the containers in the task.The IPC resource namespace to use for the containers in the task.The amount (in MiB) of memory used by the task.networkMode
(String networkMode) The Docker networking mode to use for the containers in the task.The process namespace to use for the containers in the task.placementConstraints
(List<? extends Object> placementConstraints) An array of placement constraint objects to use for tasks.placementConstraints
(IResolvable placementConstraints) An array of placement constraint objects to use for tasks.proxyConfiguration
(IResolvable proxyConfiguration) The configuration details for the App Mesh proxy.proxyConfiguration
(CfnTaskDefinition.ProxyConfigurationProperty proxyConfiguration) The configuration details for the App Mesh proxy.requiresCompatibilities
(List<String> requiresCompatibilities) The task launch types the task definition was validated against.runtimePlatform
(IResolvable runtimePlatform) The operating system that your tasks definitions run on.runtimePlatform
(CfnTaskDefinition.RuntimePlatformProperty runtimePlatform) The operating system that your tasks definitions run on.The metadata that you apply to the task definition to help you categorize and organize them.taskRoleArn
(String taskRoleArn) The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf.The list of data volume definitions for the task.volumes
(IResolvable volumes) The list of data volume definitions for the task.
-
Method Details
-
create
@Stability(Stable) public static CfnTaskDefinition.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnTaskDefinition.Builder
.
-
containerDefinitions
@Stability(Stable) public CfnTaskDefinition.Builder containerDefinitions(IResolvable containerDefinitions) A list of container definitions in JSON format that describe the different containers that make up your task.For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .
- Parameters:
containerDefinitions
- A list of container definitions in JSON format that describe the different containers that make up your task. This parameter is required.- Returns:
this
- See Also:
-
containerDefinitions
@Stability(Stable) public CfnTaskDefinition.Builder containerDefinitions(List<? extends Object> containerDefinitions) A list of container definitions in JSON format that describe the different containers that make up your task.For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .
- Parameters:
containerDefinitions
- A list of container definitions in JSON format that describe the different containers that make up your task. This parameter is required.- Returns:
this
- See Also:
-
cpu
The number ofcpu
units used by the task.If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the
memory
parameter.If you use the EC2 launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and10240
CPU units (10
vCPUs).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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - 4096 (4 vCPU) - Available
memory
values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - 8192 (8 vCPU) - Available
memory
values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform
1.4.0
or later.- 16384 (16vCPU) - Available
memory
values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform
1.4.0
or later.- Parameters:
cpu
- The number ofcpu
units used by the task. This parameter is required.- Returns:
this
- See Also:
- 256 (.25 vCPU) - Available
-
ephemeralStorage
The ephemeral storage settings to use for tasks run with the task definition.- Parameters:
ephemeralStorage
- The ephemeral storage settings to use for tasks run with the task definition. This parameter is required.- Returns:
this
- See Also:
-
ephemeralStorage
@Stability(Stable) public CfnTaskDefinition.Builder ephemeralStorage(CfnTaskDefinition.EphemeralStorageProperty ephemeralStorage) The ephemeral storage settings to use for tasks run with the task definition.- Parameters:
ephemeralStorage
- The ephemeral storage settings to use for tasks run with the task definition. This parameter is required.- Returns:
this
- See Also:
-
executionRoleArn
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf.For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide .
- Parameters:
executionRoleArn
- The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. This parameter is required.- Returns:
this
- See Also:
-
family
The name of a family that this task definition is registered to.Up to 255 letters (uppercase and lowercase), 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.
To use revision numbers when you update a task definition, specify this property. If you don't specify a value, AWS CloudFormation generates a new task definition each time that you update it.
- Parameters:
family
- The name of a family that this task definition is registered to. This parameter is required.- Returns:
this
- See Also:
-
inferenceAccelerators
@Stability(Stable) public CfnTaskDefinition.Builder inferenceAccelerators(IResolvable inferenceAccelerators) The Elastic Inference accelerators to use for the containers in the task.- Parameters:
inferenceAccelerators
- The Elastic Inference accelerators to use for the containers in the task. This parameter is required.- Returns:
this
- See Also:
-
inferenceAccelerators
@Stability(Stable) public CfnTaskDefinition.Builder inferenceAccelerators(List<? extends Object> inferenceAccelerators) The Elastic Inference accelerators to use for the containers in the task.- Parameters:
inferenceAccelerators
- The Elastic Inference accelerators to use for the containers in the task. This parameter is required.- Returns:
this
- See Also:
-
ipcMode
The IPC resource namespace to use for the containers in the task.The valid values are
host
,task
, ornone
. Ifhost
is specified, then all containers within the tasks that specified thehost
IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. Iftask
is specified, all containers within the specified task share the same IPC resources. Ifnone
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.If the
host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose.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 in the Amazon Elastic Container Service Developer Guide .- For tasks that use the
host
IPC mode, IPC namespace relatedsystemControls
are not supported. - For tasks that use the
task
IPC mode, IPC namespace relatedsystemControls
will apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on AWS Fargate .
- Parameters:
ipcMode
- The IPC resource namespace to use for the containers in the task. This parameter is required.- Returns:
this
- See Also:
- For tasks that use the
-
memory
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 AWS 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) - Between 16 GB and 60 GB in 4 GB increments - Available
cpu
values: 8192 (8 vCPU)
This option requires Linux platform
1.4.0
or later.- Between 32GB and 120 GB in 8 GB increments - Available
cpu
values: 16384 (16 vCPU)
This option requires Linux platform
1.4.0
or later.- Parameters:
memory
- The amount (in MiB) of memory used by the task. This parameter is required.- Returns:
this
- See Also:
- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
-
networkMode
The Docker networking mode to use for the containers in the task.The valid values are
none
,bridge
,awsvpc
, andhost
. If no network mode is specified, the default isbridge
.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>
orawsvpc
can be used. If the network mode is set tonone
, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. Thehost
andawsvpc
network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by thebridge
mode.With the
host
andawsvpc
network modes, exposed container ports are mapped directly to the corresponding host port (for thehost
network mode) or the attached elastic network interface port (for theawsvpc
network mode), so you cannot take advantage of dynamic host port mappings.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.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 in the Amazon Elastic Container Service Developer Guide .If the network mode is
host
, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.- Parameters:
networkMode
- The Docker networking mode to use for the containers in the task. This parameter is required.- Returns:
this
- See Also:
-
pidMode
The process namespace to use for the containers in the task.The valid values are
host
ortask
. On Fargate for Linux containers, the only valid value istask
. For example, monitoring sidecars might needpidMode
to access information about other containers running in the same task.If
host
is specified, all containers within the tasks that specified thehost
PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.If
task
is specified, all containers within the specified task share the same process namespace.If no value is specified, the default is a private namespace for each container.
If the
host
PID mode is used, there's a heightened risk of undesired process namespace exposure.This parameter is not supported for Windows containers. > This parameter is only supported for tasks that are hosted on AWS Fargate if the tasks are using platform version
1.4.0
or later (Linux). This isn't supported for Windows containers on Fargate.- Parameters:
pidMode
- The process namespace to use for the containers in the task. This parameter is required.- Returns:
this
- See Also:
-
placementConstraints
@Stability(Stable) public CfnTaskDefinition.Builder placementConstraints(IResolvable placementConstraints) An array of placement constraint objects to use for tasks.This parameter isn't supported for tasks run on AWS Fargate .
- Parameters:
placementConstraints
- An array of placement constraint objects to use for tasks. This parameter is required.- Returns:
this
- See Also:
-
placementConstraints
@Stability(Stable) public CfnTaskDefinition.Builder placementConstraints(List<? extends Object> placementConstraints) An array of placement constraint objects to use for tasks.This parameter isn't supported for tasks run on AWS Fargate .
- Parameters:
placementConstraints
- An array of placement constraint objects to use for tasks. This parameter is required.- Returns:
this
- See Also:
-
proxyConfiguration
@Stability(Stable) public CfnTaskDefinition.Builder proxyConfiguration(IResolvable proxyConfiguration) 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 use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301
or later, they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide .- Parameters:
proxyConfiguration
- The configuration details for the App Mesh proxy. This parameter is required.- Returns:
this
- See Also:
-
proxyConfiguration
@Stability(Stable) public CfnTaskDefinition.Builder proxyConfiguration(CfnTaskDefinition.ProxyConfigurationProperty proxyConfiguration) 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 use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301
or later, they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide .- Parameters:
proxyConfiguration
- The configuration details for the App Mesh proxy. This parameter is required.- Returns:
this
- See Also:
-
requiresCompatibilities
@Stability(Stable) public CfnTaskDefinition.Builder requiresCompatibilities(List<String> requiresCompatibilities) The task launch types the task definition was validated against.The valid values are
EC2
,FARGATE
, andEXTERNAL
. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide .- Parameters:
requiresCompatibilities
- The task launch types the task definition was validated against. This parameter is required.- Returns:
this
- See Also:
-
runtimePlatform
The operating system that your tasks definitions run on.A platform family is specified only for tasks using the Fargate launch type.
- Parameters:
runtimePlatform
- The operating system that your tasks definitions run on. This parameter is required.- Returns:
this
- See Also:
-
runtimePlatform
@Stability(Stable) public CfnTaskDefinition.Builder runtimePlatform(CfnTaskDefinition.RuntimePlatformProperty runtimePlatform) The operating system that your tasks definitions run on.A platform family is specified only for tasks using the Fargate launch type.
- Parameters:
runtimePlatform
- The operating system that your tasks definitions run on. This parameter is required.- Returns:
this
- See Also:
-
tags
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: + - = . _ : /
- Parameters:
tags
- The metadata that you apply to the task definition to help you categorize and organize them. This parameter is required.- Returns:
this
- See Also:
-
taskRoleArn
The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS 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 .String validation is done on the ECS side. If an invalid string value is given for
TaskRoleArn
, it may cause the Cloudformation job to hang.- Parameters:
taskRoleArn
- The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf. This parameter is required.- Returns:
this
- See Also:
-
volumes
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
andsourcePath
parameters aren't supported for tasks run on AWS Fargate .- Parameters:
volumes
- The list of data volume definitions for the task. This parameter is required.- Returns:
this
- See Also:
-
volumes
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
andsourcePath
parameters aren't supported for tasks run on AWS Fargate .- Parameters:
volumes
- The list of data volume definitions for the task. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnTaskDefinition>
- Returns:
- a newly built instance of
CfnTaskDefinition
.
-