@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-02-09T02:14:38.299Z") public class CfnTaskDefinition extends CfnResource implements IInspectable
The AWS::ECS::TaskDefinition
resource describes the container and volume definitions of an Amazon Elastic Container Service (Amazon ECS) task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.ecs.*; CfnTaskDefinition cfnTaskDefinition = CfnTaskDefinition.Builder.create(this, "MyCfnTaskDefinition") .containerDefinitions(List.of(ContainerDefinitionProperty.builder() .image("image") .name("name") // the properties below are optional .command(List.of("command")) .cpu(123) .dependsOn(List.of(ContainerDependencyProperty.builder() .condition("condition") .containerName("containerName") .build())) .disableNetworking(false) .dnsSearchDomains(List.of("dnsSearchDomains")) .dnsServers(List.of("dnsServers")) .dockerLabels(Map.of( "dockerLabelsKey", "dockerLabels")) .dockerSecurityOptions(List.of("dockerSecurityOptions")) .entryPoint(List.of("entryPoint")) .environment(List.of(KeyValuePairProperty.builder() .name("name") .value("value") .build())) .environmentFiles(List.of(EnvironmentFileProperty.builder() .type("type") .value("value") .build())) .essential(false) .extraHosts(List.of(HostEntryProperty.builder() .hostname("hostname") .ipAddress("ipAddress") .build())) .firelensConfiguration(FirelensConfigurationProperty.builder() .options(Map.of( "optionsKey", "options")) .type("type") .build()) .healthCheck(HealthCheckProperty.builder() .command(List.of("command")) .interval(123) .retries(123) .startPeriod(123) .timeout(123) .build()) .hostname("hostname") .interactive(false) .links(List.of("links")) .linuxParameters(LinuxParametersProperty.builder() .capabilities(KernelCapabilitiesProperty.builder() .add(List.of("add")) .drop(List.of("drop")) .build()) .devices(List.of(DeviceProperty.builder() .containerPath("containerPath") .hostPath("hostPath") .permissions(List.of("permissions")) .build())) .initProcessEnabled(false) .maxSwap(123) .sharedMemorySize(123) .swappiness(123) .tmpfs(List.of(TmpfsProperty.builder() .size(123) // the properties below are optional .containerPath("containerPath") .mountOptions(List.of("mountOptions")) .build())) .build()) .logConfiguration(LogConfigurationProperty.builder() .logDriver("logDriver") // the properties below are optional .options(Map.of( "optionsKey", "options")) .secretOptions(List.of(SecretProperty.builder() .name("name") .valueFrom("valueFrom") .build())) .build()) .memory(123) .memoryReservation(123) .mountPoints(List.of(MountPointProperty.builder() .containerPath("containerPath") .readOnly(false) .sourceVolume("sourceVolume") .build())) .portMappings(List.of(PortMappingProperty.builder() .appProtocol("appProtocol") .containerPort(123) .containerPortRange("containerPortRange") .hostPort(123) .name("name") .protocol("protocol") .build())) .privileged(false) .pseudoTerminal(false) .readonlyRootFilesystem(false) .repositoryCredentials(RepositoryCredentialsProperty.builder() .credentialsParameter("credentialsParameter") .build()) .resourceRequirements(List.of(ResourceRequirementProperty.builder() .type("type") .value("value") .build())) .secrets(List.of(SecretProperty.builder() .name("name") .valueFrom("valueFrom") .build())) .startTimeout(123) .stopTimeout(123) .systemControls(List.of(SystemControlProperty.builder() .namespace("namespace") .value("value") .build())) .ulimits(List.of(UlimitProperty.builder() .hardLimit(123) .name("name") .softLimit(123) .build())) .user("user") .volumesFrom(List.of(VolumeFromProperty.builder() .readOnly(false) .sourceContainer("sourceContainer") .build())) .workingDirectory("workingDirectory") .build())) .cpu("cpu") .ephemeralStorage(EphemeralStorageProperty.builder() .sizeInGiB(123) .build()) .executionRoleArn("executionRoleArn") .family("family") .inferenceAccelerators(List.of(InferenceAcceleratorProperty.builder() .deviceName("deviceName") .deviceType("deviceType") .build())) .ipcMode("ipcMode") .memory("memory") .networkMode("networkMode") .pidMode("pidMode") .placementConstraints(List.of(TaskDefinitionPlacementConstraintProperty.builder() .type("type") // the properties below are optional .expression("expression") .build())) .proxyConfiguration(ProxyConfigurationProperty.builder() .containerName("containerName") // the properties below are optional .proxyConfigurationProperties(List.of(KeyValuePairProperty.builder() .name("name") .value("value") .build())) .type("type") .build()) .requiresCompatibilities(List.of("requiresCompatibilities")) .runtimePlatform(RuntimePlatformProperty.builder() .cpuArchitecture("cpuArchitecture") .operatingSystemFamily("operatingSystemFamily") .build()) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .taskRoleArn("taskRoleArn") .volumes(List.of(VolumeProperty.builder() .dockerVolumeConfiguration(DockerVolumeConfigurationProperty.builder() .autoprovision(false) .driver("driver") .driverOpts(Map.of( "driverOptsKey", "driverOpts")) .labels(Map.of( "labelsKey", "labels")) .scope("scope") .build()) .efsVolumeConfiguration(EFSVolumeConfigurationProperty.builder() .filesystemId("filesystemId") // the properties below are optional .authorizationConfig(AuthorizationConfigProperty.builder() .accessPointId("accessPointId") .iam("iam") .build()) .rootDirectory("rootDirectory") .transitEncryption("transitEncryption") .transitEncryptionPort(123) .build()) .host(HostVolumePropertiesProperty.builder() .sourcePath("sourcePath") .build()) .name("name") .build())) .build();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnTaskDefinition.AuthorizationConfigProperty
The authorization configuration details for the Amazon EFS file system.
|
static class |
CfnTaskDefinition.Builder
A fluent builder for
CfnTaskDefinition . |
static interface |
CfnTaskDefinition.ContainerDefinitionProperty
The `ContainerDefinition` property specifies a container definition.
|
static interface |
CfnTaskDefinition.ContainerDependencyProperty
The `ContainerDependency` property specifies the dependencies defined for container startup and shutdown.
|
static interface |
CfnTaskDefinition.DeviceProperty
The `Device` property specifies an object representing a container instance host device.
|
static interface |
CfnTaskDefinition.DockerVolumeConfigurationProperty
The `DockerVolumeConfiguration` property specifies a Docker volume configuration and is used when you use Docker volumes.
|
static interface |
CfnTaskDefinition.EFSVolumeConfigurationProperty
This parameter is specified when you're using an Amazon Elastic File System file system for task storage.
|
static interface |
CfnTaskDefinition.EnvironmentFileProperty
A list of files containing the environment variables to pass to a container.
|
static interface |
CfnTaskDefinition.EphemeralStorageProperty
The amount of ephemeral storage to allocate for the task.
|
static interface |
CfnTaskDefinition.FirelensConfigurationProperty
The FireLens configuration for the container.
|
static interface |
CfnTaskDefinition.HealthCheckProperty
The `HealthCheck` property specifies an object representing a container health check.
|
static interface |
CfnTaskDefinition.HostEntryProperty
The `HostEntry` property specifies a hostname and an IP address that are added to the `/etc/hosts` file of a container through the `extraHosts` parameter of its `ContainerDefinition` resource.
|
static interface |
CfnTaskDefinition.HostVolumePropertiesProperty
The `HostVolumeProperties` property specifies details on a container instance bind mount host volume.
|
static interface |
CfnTaskDefinition.InferenceAcceleratorProperty
Details on an Elastic Inference accelerator.
|
static interface |
CfnTaskDefinition.KernelCapabilitiesProperty
The `KernelCapabilities` property specifies the Linux capabilities for the container that are added to or dropped from the default configuration that is provided by Docker.
|
static interface |
CfnTaskDefinition.KeyValuePairProperty
The `KeyValuePair` property specifies a key-value pair object.
|
static interface |
CfnTaskDefinition.LinuxParametersProperty
The `LinuxParameters` property specifies Linux-specific options that are applied to the container, such as Linux [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html) .
|
static interface |
CfnTaskDefinition.LogConfigurationProperty
The `LogConfiguration` property specifies log configuration options to send to a custom log driver for the container.
|
static interface |
CfnTaskDefinition.MountPointProperty
The `MountPoint` property specifies details on a volume mount point that is used in a container definition.
|
static interface |
CfnTaskDefinition.PortMappingProperty
The `PortMapping` property specifies a port mapping.
|
static interface |
CfnTaskDefinition.ProxyConfigurationProperty
The `ProxyConfiguration` property specifies the details for the App Mesh proxy.
|
static interface |
CfnTaskDefinition.RepositoryCredentialsProperty
The `RepositoryCredentials` property specifies the repository credentials for private registry authentication.
|
static interface |
CfnTaskDefinition.ResourceRequirementProperty
The `ResourceRequirement` property specifies the type and amount of a resource to assign to a container.
|
static interface |
CfnTaskDefinition.RuntimePlatformProperty
Information about the platform for the Amazon ECS service or task.
|
static interface |
CfnTaskDefinition.SecretProperty
The `Secret` property specifies an object representing the secret to expose to your container.
|
static interface |
CfnTaskDefinition.SystemControlProperty
A list of namespaced kernel parameters to set in the container.
|
static interface |
CfnTaskDefinition.TaskDefinitionPlacementConstraintProperty
The `TaskDefinitionPlacementConstraint` property specifies an object representing a constraint on task placement in the task definition.
|
static interface |
CfnTaskDefinition.TmpfsProperty
The `Tmpfs` property specifies the container path, mount options, and size of the tmpfs mount.
|
static interface |
CfnTaskDefinition.UlimitProperty
The `Ulimit` property specifies the `ulimit` settings to pass to the container.
|
static interface |
CfnTaskDefinition.VolumeFromProperty
The `VolumeFrom` property specifies details on a data volume from another container in the same task definition.
|
static interface |
CfnTaskDefinition.VolumeProperty
The `Volume` property specifies a data volume used in a task definition.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnTaskDefinition(Construct scope,
java.lang.String id)
Create a new `AWS::ECS::TaskDefinition`.
|
|
CfnTaskDefinition(Construct scope,
java.lang.String id,
CfnTaskDefinitionProps props)
Create a new `AWS::ECS::TaskDefinition`.
|
protected |
CfnTaskDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnTaskDefinition(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrTaskDefinitionArn() |
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getContainerDefinitions()
A list of container definitions in JSON format that describe the different containers that make up your task.
|
java.lang.String |
getCpu()
The number of `cpu` units used by the task.
|
java.lang.Object |
getEphemeralStorage()
The ephemeral storage settings to use for tasks run with the task definition.
|
java.lang.String |
getExecutionRoleArn()
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.
|
java.lang.String |
getFamily()
The name of a family that this task definition is registered to.
|
java.lang.Object |
getInferenceAccelerators()
The Elastic Inference accelerators to use for the containers in the task.
|
java.lang.String |
getIpcMode()
The IPC resource namespace to use for the containers in the task.
|
java.lang.String |
getMemory()
The amount (in MiB) of memory used by the task.
|
java.lang.String |
getNetworkMode()
The Docker networking mode to use for the containers in the task.
|
java.lang.String |
getPidMode()
The process namespace to use for the containers in the task.
|
java.lang.Object |
getPlacementConstraints()
An array of placement constraint objects to use for tasks.
|
java.lang.Object |
getProxyConfiguration()
The `ProxyConfiguration` property specifies the configuration details for the App Mesh proxy.
|
java.util.List<java.lang.String> |
getRequiresCompatibilities()
The task launch types the task definition was validated against.
|
java.lang.Object |
getRuntimePlatform()
The operating system that your tasks definitions run on.
|
TagManager |
getTags()
The metadata that you apply to the task definition to help you categorize and organize them.
|
java.lang.String |
getTaskRoleArn()
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.
|
java.lang.Object |
getVolumes()
The list of data volume definitions for the task.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setContainerDefinitions(IResolvable value)
A list of container definitions in JSON format that describe the different containers that make up your task.
|
void |
setContainerDefinitions(java.util.List<java.lang.Object> value)
A list of container definitions in JSON format that describe the different containers that make up your task.
|
void |
setCpu(java.lang.String value)
The number of `cpu` units used by the task.
|
void |
setEphemeralStorage(CfnTaskDefinition.EphemeralStorageProperty value)
The ephemeral storage settings to use for tasks run with the task definition.
|
void |
setEphemeralStorage(IResolvable value)
The ephemeral storage settings to use for tasks run with the task definition.
|
void |
setExecutionRoleArn(java.lang.String value)
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.
|
void |
setFamily(java.lang.String value)
The name of a family that this task definition is registered to.
|
void |
setInferenceAccelerators(IResolvable value)
The Elastic Inference accelerators to use for the containers in the task.
|
void |
setInferenceAccelerators(java.util.List<java.lang.Object> value)
The Elastic Inference accelerators to use for the containers in the task.
|
void |
setIpcMode(java.lang.String value)
The IPC resource namespace to use for the containers in the task.
|
void |
setMemory(java.lang.String value)
The amount (in MiB) of memory used by the task.
|
void |
setNetworkMode(java.lang.String value)
The Docker networking mode to use for the containers in the task.
|
void |
setPidMode(java.lang.String value)
The process namespace to use for the containers in the task.
|
void |
setPlacementConstraints(IResolvable value)
An array of placement constraint objects to use for tasks.
|
void |
setPlacementConstraints(java.util.List<java.lang.Object> value)
An array of placement constraint objects to use for tasks.
|
void |
setProxyConfiguration(CfnTaskDefinition.ProxyConfigurationProperty value)
The `ProxyConfiguration` property specifies the configuration details for the App Mesh proxy.
|
void |
setProxyConfiguration(IResolvable value)
The `ProxyConfiguration` property specifies the configuration details for the App Mesh proxy.
|
void |
setRequiresCompatibilities(java.util.List<java.lang.String> value)
The task launch types the task definition was validated against.
|
void |
setRuntimePlatform(CfnTaskDefinition.RuntimePlatformProperty value)
The operating system that your tasks definitions run on.
|
void |
setRuntimePlatform(IResolvable value)
The operating system that your tasks definitions run on.
|
void |
setTaskRoleArn(java.lang.String value)
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.
|
void |
setVolumes(IResolvable value)
The list of data volume definitions for the task.
|
void |
setVolumes(java.util.List<java.lang.Object> value)
The list of data volume definitions for the task.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnTaskDefinition(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnTaskDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnTaskDefinition(Construct scope, java.lang.String id, CfnTaskDefinitionProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties.public CfnTaskDefinition(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrTaskDefinitionArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
Each tag consists of a key and an optional value. You define both of them.
The following basic restrictions apply to tags:
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.public java.lang.Object getContainerDefinitions()
For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .
public void setContainerDefinitions(IResolvable value)
For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .
public void setContainerDefinitions(java.util.List<java.lang.Object> value)
For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .
public java.lang.String getCpu()
If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory
parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)memory
values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)memory
values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)memory
values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0
or later.
memory
values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0
or later.
public void setCpu(java.lang.String value)
If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory
parameter.
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)memory
values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)memory
values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)memory
values: 16 GB and 60 GB in 4 GB increments
This option requires Linux platform 1.4.0
or later.
memory
values: 32GB and 120 GB in 8 GB increments
This option requires Linux platform 1.4.0
or later.
public java.lang.Object getEphemeralStorage()
public void setEphemeralStorage(IResolvable value)
public void setEphemeralStorage(CfnTaskDefinition.EphemeralStorageProperty value)
public java.lang.String getExecutionRoleArn()
The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide .
public void setExecutionRoleArn(java.lang.String value)
The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide .
public java.lang.String getFamily()
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.
public void setFamily(java.lang.String value)
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.
public java.lang.Object getInferenceAccelerators()
public void setInferenceAccelerators(IResolvable value)
public void setInferenceAccelerators(java.util.List<java.lang.Object> value)
public java.lang.String getIpcMode()
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 in the Docker run reference .
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security .
If you are setting namespaced kernel parameters using 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 .
host
IPC mode, IPC namespace related systemControls
are not supported.task
IPC mode, IPC namespace related systemControls
will apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on AWS Fargate .
public void setIpcMode(java.lang.String value)
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 in the Docker run reference .
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security .
If you are setting namespaced kernel parameters using 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 .
host
IPC mode, IPC namespace related systemControls
are not supported.task
IPC mode, IPC namespace related systemControls
will apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on AWS Fargate .
public java.lang.String getMemory()
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.
cpu
values: 256 (.25 vCPU)cpu
values: 512 (.5 vCPU)cpu
values: 1024 (1 vCPU)cpu
values: 2048 (2 vCPU)cpu
values: 4096 (4 vCPU)cpu
values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0
or later.
cpu
values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0
or later.
public void setMemory(java.lang.String value)
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.
cpu
values: 256 (.25 vCPU)cpu
values: 512 (.5 vCPU)cpu
values: 1024 (1 vCPU)cpu
values: 2048 (2 vCPU)cpu
values: 4096 (4 vCPU)cpu
values: 8192 (8 vCPU)
This option requires Linux platform 1.4.0
or later.
cpu
values: 16384 (16 vCPU)
This option requires Linux platform 1.4.0
or later.
public java.lang.String getNetworkMode()
The valid values are none
, bridge
, awsvpc
, and host
. The default Docker network mode is bridge
. If you are using the Fargate launch type, the awsvpc
network mode is required. If you are using the EC2 launch type, any network mode 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.
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.
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 .
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the
ecs-init
package, or AWS Fargate infrastructure support theawsvpc
network mode.
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.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default>
network mode object.
For more information, see Network settings in the Docker run reference .
public void setNetworkMode(java.lang.String value)
The valid values are none
, bridge
, awsvpc
, and host
. The default Docker network mode is bridge
. If you are using the Fargate launch type, the awsvpc
network mode is required. If you are using the EC2 launch type, any network mode 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.
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.
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 .
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the
ecs-init
package, or AWS Fargate infrastructure support theawsvpc
network mode.
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.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default>
network mode object.
For more information, see Network settings in the Docker run reference .
public java.lang.String getPidMode()
The valid values are host
or task
. If host
is specified, then 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. 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 more information, see PID settings in the Docker run reference .
If the host
PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security .
This parameter is not supported for Windows containers or tasks run on AWS Fargate .
public void setPidMode(java.lang.String value)
The valid values are host
or task
. If host
is specified, then 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. 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 more information, see PID settings in the Docker run reference .
If the host
PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security .
This parameter is not supported for Windows containers or tasks run on AWS Fargate .
public java.lang.Object getPlacementConstraints()
This parameter isn't supported for tasks run on AWS Fargate .
public void setPlacementConstraints(IResolvable value)
This parameter isn't supported for tasks run on AWS Fargate .
public void setPlacementConstraints(java.util.List<java.lang.Object> value)
This parameter isn't supported for tasks run on AWS Fargate .
public java.lang.Object getProxyConfiguration()
Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init
package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301
or later, then they contain the required versions of the container agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide .
public void setProxyConfiguration(CfnTaskDefinition.ProxyConfigurationProperty value)
Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init
package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301
or later, then they contain the required versions of the container agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide .
public void setProxyConfiguration(IResolvable value)
Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init
package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301
or later, then they contain the required versions of the container agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide .
public java.util.List<java.lang.String> getRequiresCompatibilities()
To determine which task launch types the task definition is validated for, see the TaskDefinition$compatibilities
parameter.
The valid values are:
EC2
- The EC2 launch typeFARGATE
- The Fargate launch typeEXTERNAL
- The external instance (ECS Anywhere) launch typepublic void setRequiresCompatibilities(java.util.List<java.lang.String> value)
To determine which task launch types the task definition is validated for, see the TaskDefinition$compatibilities
parameter.
The valid values are:
EC2
- The EC2 launch typeFARGATE
- The Fargate launch typeEXTERNAL
- The external instance (ECS Anywhere) launch typepublic java.lang.Object getRuntimePlatform()
A platform family is specified only for tasks using the Fargate launch type.
When you specify a task definition in a service, this value must match the runtimePlatform
value of the service.
public void setRuntimePlatform(IResolvable value)
A platform family is specified only for tasks using the Fargate launch type.
When you specify a task definition in a service, this value must match the runtimePlatform
value of the service.
public void setRuntimePlatform(CfnTaskDefinition.RuntimePlatformProperty value)
A platform family is specified only for tasks using the Fargate launch type.
When you specify a task definition in a service, this value must match the runtimePlatform
value of the service.
public java.lang.String getTaskRoleArn()
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 .
public void setTaskRoleArn(java.lang.String value)
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 .
public java.lang.Object getVolumes()
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 .
public void setVolumes(IResolvable value)
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 .
public void setVolumes(java.util.List<java.lang.Object> value)
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 .