Interface CfnTaskDefinitionProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTaskDefinitionProps.Jsii$Proxy
CfnTaskDefinition.
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.*;
CfnTaskDefinitionProps cfnTaskDefinitionProps = CfnTaskDefinitionProps.builder()
.containerDefinitions(List.of(ContainerDefinitionProperty.builder()
.image("image")
.name("name")
// the properties below are optional
.command(List.of("command"))
.cpu(123)
.credentialSpecs(List.of("credentialSpecs"))
.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()))
.restartPolicy(RestartPolicyProperty.builder()
.enabled(false)
.ignoredExitCodes(List.of(123))
.restartAttemptPeriod(123)
.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")
.versionConsistency("versionConsistency")
.volumesFrom(List.of(VolumeFromProperty.builder()
.readOnly(false)
.sourceContainer("sourceContainer")
.build()))
.workingDirectory("workingDirectory")
.build()))
.cpu("cpu")
.enableFaultInjection(false)
.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()
.configuredAtLaunch(false)
.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())
.fSxWindowsFileServerVolumeConfiguration(FSxWindowsFileServerVolumeConfigurationProperty.builder()
.fileSystemId("fileSystemId")
.rootDirectory("rootDirectory")
// the properties below are optional
.authorizationConfig(FSxAuthorizationConfigProperty.builder()
.credentialsParameter("credentialsParameter")
.domain("domain")
.build())
.build())
.host(HostVolumePropertiesProperty.builder()
.sourcePath("sourcePath")
.build())
.name("name")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnTaskDefinitionPropsstatic final classAn implementation forCfnTaskDefinitionProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectA list of container definitions in JSON format that describe the different containers that make up your task.default StringgetCpu()The number ofcpuunits used by the task.default ObjectEnables fault injection and allows for fault injection requests to be accepted from the task's containers.default ObjectThe ephemeral storage settings to use for tasks run with the task definition.default StringThe 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.default StringThe name of a family that this task definition is registered to.default ObjectDeprecated.this property has been deprecateddefault StringThe IPC resource namespace to use for the containers in the task.default StringThe amount (in MiB) of memory used by the task.default StringThe Docker networking mode to use for the containers in the task.default StringThe process namespace to use for the containers in the task.default ObjectAn array of placement constraint objects to use for tasks.default ObjectThe configuration details for the App Mesh proxy.The task launch types the task definition was validated against.default ObjectThe operating system that your tasks definitions run on.getTags()The metadata that you apply to the task definition to help you categorize and organize them.default StringThe 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.default ObjectThe list of data volume definitions for the task.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getContainerDefinitions
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 .
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnTaskDefinition.ContainerDefinitionProperty>- See Also:
-
getCpu
The number ofcpuunits 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
memoryparameter.If you're using the EC2 launch type or the external launch type, this field is optional. Supported values are between
128CPU units (0.125vCPUs) and196608CPU units (192vCPUs).This field is required for Fargate. For information about the valid values, see Task size in the Amazon Elastic Container Service Developer Guide .
- See Also:
-
getEnableFaultInjection
Enables fault injection and allows for fault injection requests to be accepted from the task's containers.The default value is
false.Returns union: either
BooleanorIResolvable- See Also:
-
getEphemeralStorage
The ephemeral storage settings to use for tasks run with the task definition.Returns union: either
IResolvableorCfnTaskDefinition.EphemeralStorageProperty- See Also:
-
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.For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide .
- See Also:
-
getFamily
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.
- See Also:
-
getInferenceAccelerators
Deprecated.this property has been deprecatedReturns union: eitherIResolvableor Listinvalid input: '<'eitherIResolvableorCfnTaskDefinition.InferenceAcceleratorProperty>- See Also:
-
getIpcMode
The IPC resource namespace to use for the containers in the task.The valid values are
host,task, ornone. Ifhostis specified, then all containers within the tasks that specified thehostIPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. Iftaskis specified, all containers within the specified task share the same IPC resources. Ifnoneis 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
hostIPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose.If you are setting namespaced kernel parameters using
systemControlsfor 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
hostIPC mode, IPC namespace relatedsystemControlsare not supported. - For tasks that use the
taskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on AWS Fargate .
- See Also:
- For tasks that use the
-
getMemory
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
cpuparameter.- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpuvalues: 256 (.25 vCPU) - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpuvalues: 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
cpuvalues: 1024 (1 vCPU) - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available
cpuvalues: 2048 (2 vCPU) - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available
cpuvalues: 4096 (4 vCPU) - Between 16 GB and 60 GB in 4 GB increments - Available
cpuvalues: 8192 (8 vCPU)
This option requires Linux platform
1.4.0or later.- Between 32GB and 120 GB in 8 GB increments - Available
cpuvalues: 16384 (16 vCPU)
This option requires Linux platform
1.4.0or later.- See Also:
- 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
-
getNetworkMode
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
awsvpcnetwork 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>orawsvpccan 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. Thehostandawsvpcnetwork modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by thebridgemode.With the
hostandawsvpcnetwork modes, exposed container ports are mapped directly to the corresponding host port (for thehostnetwork mode) or the attached elastic network interface port (for theawsvpcnetwork mode), so you cannot take advantage of dynamic host port mappings.When using the
hostnetwork 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.- See Also:
-
getPidMode
The process namespace to use for the containers in the task.The valid values are
hostortask. On Fargate for Linux containers, the only valid value istask. For example, monitoring sidecars might needpidModeto access information about other containers running in the same task.If
hostis specified, all containers within the tasks that specified thehostPID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.If
taskis specified, all containers within the specified task share the same process namespace.If no value is specified, the The default is a private namespace for each container.
If the
hostPID 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.0or later (Linux). This isn't supported for Windows containers on Fargate.- See Also:
-
getPlacementConstraints
An array of placement constraint objects to use for tasks.This parameter isn't supported for tasks run on AWS Fargate .
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnTaskDefinition.TaskDefinitionPlacementConstraintProperty>- See Also:
-
getProxyConfiguration
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-initpackage to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301or 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 .Returns union: either
IResolvableorCfnTaskDefinition.ProxyConfigurationProperty- See Also:
-
getRequiresCompatibilities
The task launch types the task definition was validated against.The valid values are
MANAGED_INSTANCES,EC2,FARGATE, andEXTERNAL. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide .- See Also:
-
getRuntimePlatform
The operating system that your tasks definitions run on.Returns union: either
IResolvableorCfnTaskDefinition.RuntimePlatformProperty- See Also:
-
getTags
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: + - = . _ : /
- See Also:
-
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.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
-EnableTaskIAMRoleoption 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.- See Also:
-
getVolumes
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
hostandsourcePathparameters aren't supported for tasks run on AWS Fargate .Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnTaskDefinition.VolumeProperty>- See Also:
-
builder
- Returns:
- a
CfnTaskDefinitionProps.BuilderofCfnTaskDefinitionProps
-