Class CfnTaskDefinitionProps
Properties for defining a CfnTaskDefinition.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.AWS.ECS.dll
Syntax (csharp)
public class CfnTaskDefinitionProps : Object, ICfnTaskDefinitionPropsSyntax (vb)
Public Class CfnTaskDefinitionProps
Inherits Object
Implements ICfnTaskDefinitionPropsRemarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ECS;
var cfnTaskDefinitionProps = new CfnTaskDefinitionProps {
ContainerDefinitions = new [] { new ContainerDefinitionProperty {
Image = "image",
Name = "name",
// the properties below are optional
Command = new [] { "command" },
Cpu = 123,
DependsOn = new [] { new ContainerDependencyProperty {
Condition = "condition",
ContainerName = "containerName"
} },
DisableNetworking = false,
DnsSearchDomains = new [] { "dnsSearchDomains" },
DnsServers = new [] { "dnsServers" },
DockerLabels = new Dictionary<string, string> {
{ "dockerLabelsKey", "dockerLabels" }
},
DockerSecurityOptions = new [] { "dockerSecurityOptions" },
EntryPoint = new [] { "entryPoint" },
Environment = new [] { new KeyValuePairProperty {
Name = "name",
Value = "value"
} },
EnvironmentFiles = new [] { new EnvironmentFileProperty {
Type = "type",
Value = "value"
} },
Essential = false,
ExtraHosts = new [] { new HostEntryProperty {
Hostname = "hostname",
IpAddress = "ipAddress"
} },
FirelensConfiguration = new FirelensConfigurationProperty {
Options = new Dictionary<string, string> {
{ "optionsKey", "options" }
},
Type = "type"
},
HealthCheck = new HealthCheckProperty {
Command = new [] { "command" },
Interval = 123,
Retries = 123,
StartPeriod = 123,
Timeout = 123
},
Hostname = "hostname",
Interactive = false,
Links = new [] { "links" },
LinuxParameters = new LinuxParametersProperty {
Capabilities = new KernelCapabilitiesProperty {
Add = new [] { "add" },
Drop = new [] { "drop" }
},
Devices = new [] { new DeviceProperty {
ContainerPath = "containerPath",
HostPath = "hostPath",
Permissions = new [] { "permissions" }
} },
InitProcessEnabled = false,
MaxSwap = 123,
SharedMemorySize = 123,
Swappiness = 123,
Tmpfs = new [] { new TmpfsProperty {
Size = 123,
// the properties below are optional
ContainerPath = "containerPath",
MountOptions = new [] { "mountOptions" }
} }
},
LogConfiguration = new LogConfigurationProperty {
LogDriver = "logDriver",
// the properties below are optional
Options = new Dictionary<string, string> {
{ "optionsKey", "options" }
},
SecretOptions = new [] { new SecretProperty {
Name = "name",
ValueFrom = "valueFrom"
} }
},
Memory = 123,
MemoryReservation = 123,
MountPoints = new [] { new MountPointProperty {
ContainerPath = "containerPath",
ReadOnly = false,
SourceVolume = "sourceVolume"
} },
PortMappings = new [] { new PortMappingProperty {
AppProtocol = "appProtocol",
ContainerPort = 123,
ContainerPortRange = "containerPortRange",
HostPort = 123,
Name = "name",
Protocol = "protocol"
} },
Privileged = false,
PseudoTerminal = false,
ReadonlyRootFilesystem = false,
RepositoryCredentials = new RepositoryCredentialsProperty {
CredentialsParameter = "credentialsParameter"
},
ResourceRequirements = new [] { new ResourceRequirementProperty {
Type = "type",
Value = "value"
} },
Secrets = new [] { new SecretProperty {
Name = "name",
ValueFrom = "valueFrom"
} },
StartTimeout = 123,
StopTimeout = 123,
SystemControls = new [] { new SystemControlProperty {
Namespace = "namespace",
Value = "value"
} },
Ulimits = new [] { new UlimitProperty {
HardLimit = 123,
Name = "name",
SoftLimit = 123
} },
User = "user",
VolumesFrom = new [] { new VolumeFromProperty {
ReadOnly = false,
SourceContainer = "sourceContainer"
} },
WorkingDirectory = "workingDirectory"
} },
Cpu = "cpu",
EphemeralStorage = new EphemeralStorageProperty {
SizeInGiB = 123
},
ExecutionRoleArn = "executionRoleArn",
Family = "family",
InferenceAccelerators = new [] { new InferenceAcceleratorProperty {
DeviceName = "deviceName",
DeviceType = "deviceType"
} },
IpcMode = "ipcMode",
Memory = "memory",
NetworkMode = "networkMode",
PidMode = "pidMode",
PlacementConstraints = new [] { new TaskDefinitionPlacementConstraintProperty {
Type = "type",
// the properties below are optional
Expression = "expression"
} },
ProxyConfiguration = new ProxyConfigurationProperty {
ContainerName = "containerName",
// the properties below are optional
ProxyConfigurationProperties = new [] { new KeyValuePairProperty {
Name = "name",
Value = "value"
} },
Type = "type"
},
RequiresCompatibilities = new [] { "requiresCompatibilities" },
RuntimePlatform = new RuntimePlatformProperty {
CpuArchitecture = "cpuArchitecture",
OperatingSystemFamily = "operatingSystemFamily"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TaskRoleArn = "taskRoleArn",
Volumes = new [] { new VolumeProperty {
DockerVolumeConfiguration = new DockerVolumeConfigurationProperty {
Autoprovision = false,
Driver = "driver",
DriverOpts = new Dictionary<string, string> {
{ "driverOptsKey", "driverOpts" }
},
Labels = new Dictionary<string, string> {
{ "labelsKey", "labels" }
},
Scope = "scope"
},
EfsVolumeConfiguration = new EFSVolumeConfigurationProperty {
FilesystemId = "filesystemId",
// the properties below are optional
AuthorizationConfig = new AuthorizationConfigProperty {
AccessPointId = "accessPointId",
Iam = "iam"
},
RootDirectory = "rootDirectory",
TransitEncryption = "transitEncryption",
TransitEncryptionPort = 123
},
Host = new HostVolumePropertiesProperty {
SourcePath = "sourcePath"
},
Name = "name"
} }
};Synopsis
Constructors
| CfnTaskDefinitionProps() |
Properties
| ContainerDefinitions | A list of container definitions in JSON format that describe the different containers that make up your task. |
| Cpu | The number of |
| EphemeralStorage | The ephemeral storage settings to use for tasks run with the task definition. |
| 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. |
| Family | The name of a family that this task definition is registered to. |
| InferenceAccelerators | The Elastic Inference accelerators to use for the containers in the task. |
| IpcMode | The IPC resource namespace to use for the containers in the task. |
| Memory | The amount (in MiB) of memory used by the task. |
| NetworkMode | The Docker networking mode to use for the containers in the task. |
| PidMode | The process namespace to use for the containers in the task. |
| PlacementConstraints | An array of placement constraint objects to use for tasks. |
| ProxyConfiguration | The configuration details for the App Mesh proxy. |
| RequiresCompatibilities | The task launch types the task definition was validated against. |
| RuntimePlatform | The operating system that your tasks definitions run on. |
| Tags | The metadata that you apply to the task definition to help you categorize and organize them. |
| 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. |
| Volumes | The list of data volume definitions for the task. |
Constructors
CfnTaskDefinitionProps()
public CfnTaskDefinitionProps()Properties
ContainerDefinitions
A list of container definitions in JSON format that describe the different containers that make up your task.
public object ContainerDefinitions { get; set; }Property Value
System.Object
Remarks
For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .
Cpu
The number of cpu units used by the task.
public string Cpu { get; set; }Property Value
System.String
Remarks
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.
This option requires Linux platform 1.4.0 or later.
This option requires Linux platform 1.4.0 or later.
EphemeralStorage
The ephemeral storage settings to use for tasks run with the task definition.
public object EphemeralStorage { get; set; }Property Value
System.Object
Remarks
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.
public string ExecutionRoleArn { get; set; }Property Value
System.String
Remarks
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 .
Family
The name of a family that this task definition is registered to.
public string Family { get; set; }Property Value
System.String
Remarks
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.
InferenceAccelerators
The Elastic Inference accelerators to use for the containers in the task.
public object InferenceAccelerators { get; set; }Property Value
System.Object
Remarks
IpcMode
The IPC resource namespace to use for the containers in the task.
public string IpcMode { get; set; }Property Value
System.String
Remarks
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 .
This parameter is not supported for Windows containers or tasks run on AWS Fargate .
Memory
The amount (in MiB) of memory used by the task.
public string Memory { get; set; }Property Value
System.String
Remarks
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.
This option requires Linux platform 1.4.0 or later.
This option requires Linux platform 1.4.0 or later.
NetworkMode
The Docker networking mode to use for the containers in the task.
public string NetworkMode { get; set; }Property Value
System.String
Remarks
The valid values are none , bridge , awsvpc , and host . If no network mode is specified, the default is bridge .
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.
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.
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.
For more information, see Network settings in the Docker run reference .
PidMode
The process namespace to use for the containers in the task.
public string PidMode { get; set; }Property Value
System.String
Remarks
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 .
PlacementConstraints
An array of placement constraint objects to use for tasks.
public object PlacementConstraints { get; set; }Property Value
System.Object
Remarks
This parameter isn't supported for tasks run on AWS Fargate .
ProxyConfiguration
The configuration details for the App Mesh proxy.
public object ProxyConfiguration { get; set; }Property Value
System.Object
Remarks
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 version 20190301 or later, they contain the required versions of the container agent and ecs-init . For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide .
RequiresCompatibilities
The task launch types the task definition was validated against.
public string[] RequiresCompatibilities { get; set; }Property Value
System.String[]
Remarks
For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide .
RuntimePlatform
The operating system that your tasks definitions run on.
public object RuntimePlatform { get; set; }Property Value
System.Object
Remarks
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.
Tags
The metadata that you apply to the task definition to help you categorize and organize them.
public ICfnTag[] Tags { get; set; }Property Value
ICfnTag[]
Remarks
Each tag consists of a key and an optional value. You define both of them.
The following basic restrictions apply to tags:
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.
public string TaskRoleArn { get; set; }Property Value
System.String
Remarks
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 .
Volumes
The list of data volume definitions for the task.
public object Volumes { get; set; }Property Value
System.Object
Remarks
For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide .
The host and sourcePath parameters aren't supported for tasks run on AWS Fargate .