Docs Home
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
azure-native-v2.awsconnector.EcsTaskDefinition
Explore with Pulumi AI
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
A Microsoft.AwsConnector resource Azure REST API version: 2024-12-01.
Create EcsTaskDefinition Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new EcsTaskDefinition(name: string, args: EcsTaskDefinitionArgs, opts?: CustomResourceOptions);@overload
def EcsTaskDefinition(resource_name: str,
args: EcsTaskDefinitionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def EcsTaskDefinition(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
properties: Optional[EcsTaskDefinitionPropertiesArgs] = None,
tags: Optional[Mapping[str, str]] = None)func NewEcsTaskDefinition(ctx *Context, name string, args EcsTaskDefinitionArgs, opts ...ResourceOption) (*EcsTaskDefinition, error)public EcsTaskDefinition(string name, EcsTaskDefinitionArgs args, CustomResourceOptions? opts = null)public EcsTaskDefinition(String name, EcsTaskDefinitionArgs args)
public EcsTaskDefinition(String name, EcsTaskDefinitionArgs args, CustomResourceOptions options)
type: azure-native:awsconnector:EcsTaskDefinition
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. EcsTaskDefinitionArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. EcsTaskDefinitionArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. EcsTaskDefinitionArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. EcsTaskDefinitionArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. EcsTaskDefinitionArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var ecsTaskDefinitionResource = new AzureNative.Awsconnector.EcsTaskDefinition("ecsTaskDefinitionResource", new()
{
ResourceGroupName = "string",
Location = "string",
Name = "string",
Properties =
{
{ "arn", "string" },
{ "awsAccountId", "string" },
{ "awsProperties",
{
{ "containerDefinitions", new[]
{
{
{ "command", new[]
{
"string",
} },
{ "cpu", 0 },
{ "credentialSpecs", new[]
{
"string",
} },
{ "dependsOn", new[]
{
{
{ "condition", "string" },
{ "containerName", "string" },
},
} },
{ "disableNetworking", false },
{ "dnsSearchDomains", new[]
{
"string",
} },
{ "dnsServers", new[]
{
"string",
} },
{ "dockerLabels", "any" },
{ "dockerSecurityOptions", new[]
{
"string",
} },
{ "entryPoint", new[]
{
"string",
} },
{ "environment", new[]
{
{
{ "name", "string" },
{ "value", "string" },
},
} },
{ "environmentFiles", new[]
{
{
{ "type", "string" },
{ "value", "string" },
},
} },
{ "essential", false },
{ "extraHosts", new[]
{
{
{ "hostname", "string" },
{ "ipAddress", "string" },
},
} },
{ "firelensConfiguration",
{
{ "options", "any" },
{ "type", "string" },
} },
{ "healthCheck",
{
{ "command", new[]
{
"string",
} },
{ "interval", 0 },
{ "retries", 0 },
{ "startPeriod", 0 },
{ "timeout", 0 },
} },
{ "hostname", "string" },
{ "image", "string" },
{ "interactive", false },
{ "links", new[]
{
"string",
} },
{ "linuxParameters",
{
{ "capabilities",
{
{ "add", new[]
{
"string",
} },
{ "drop", new[]
{
"string",
} },
} },
{ "devices", new[]
{
{
{ "containerPath", "string" },
{ "hostPath", "string" },
{ "permissions", new[]
{
"string",
} },
},
} },
{ "initProcessEnabled", false },
{ "maxSwap", 0 },
{ "sharedMemorySize", 0 },
{ "swappiness", 0 },
{ "tmpfs", new[]
{
{
{ "containerPath", "string" },
{ "mountOptions", new[]
{
"string",
} },
{ "size", 0 },
},
} },
} },
{ "logConfiguration",
{
{ "logDriver", "string" },
{ "options", "any" },
{ "secretOptions", new[]
{
{
{ "name", "string" },
{ "valueFrom", "string" },
},
} },
} },
{ "memory", 0 },
{ "memoryReservation", 0 },
{ "mountPoints", new[]
{
{
{ "containerPath", "string" },
{ "readOnly", false },
{ "sourceVolume", "string" },
},
} },
{ "name", "string" },
{ "portMappings", new[]
{
{
{ "appProtocol", "string" },
{ "containerPort", 0 },
{ "containerPortRange", "string" },
{ "hostPort", 0 },
{ "name", "string" },
{ "protocol", "string" },
},
} },
{ "privileged", false },
{ "pseudoTerminal", false },
{ "readonlyRootFilesystem", false },
{ "repositoryCredentials",
{
{ "credentialsParameter", "string" },
} },
{ "resourceRequirements", new[]
{
{
{ "type", "string" },
{ "value", "string" },
},
} },
{ "secrets", new[]
{
{
{ "name", "string" },
{ "valueFrom", "string" },
},
} },
{ "startTimeout", 0 },
{ "stopTimeout", 0 },
{ "systemControls", new[]
{
{
{ "namespace", "string" },
{ "value", "string" },
},
} },
{ "ulimits", new[]
{
{
{ "hardLimit", 0 },
{ "name", "string" },
{ "softLimit", 0 },
},
} },
{ "user", "string" },
{ "volumesFrom", new[]
{
{
{ "readOnly", false },
{ "sourceContainer", "string" },
},
} },
{ "workingDirectory", "string" },
},
} },
{ "cpu", "string" },
{ "ephemeralStorage",
{
{ "size", 0 },
{ "sizeInGiB", 0 },
} },
{ "executionRoleArn", "string" },
{ "family", "string" },
{ "inferenceAccelerators", new[]
{
{
{ "deviceName", "string" },
{ "deviceType", "string" },
},
} },
{ "ipcMode", "string" },
{ "memory", "string" },
{ "networkMode", "string" },
{ "pidMode", "string" },
{ "placementConstraints", new[]
{
{
{ "expression", "string" },
{ "type", "string" },
},
} },
{ "proxyConfiguration",
{
{ "containerName", "string" },
{ "proxyConfigurationProperties", new[]
{
{
{ "name", "string" },
{ "value", "string" },
},
} },
{ "type", "string" },
} },
{ "requiresCompatibilities", new[]
{
"string",
} },
{ "runtimePlatform",
{
{ "cpuArchitecture", "string" },
{ "operatingSystemFamily", "string" },
} },
{ "tags", new[]
{
{
{ "key", "string" },
{ "value", "string" },
},
} },
{ "taskDefinitionArn", "string" },
{ "taskRoleArn", "string" },
{ "volumes", new[]
{
{
{ "configuredAtLaunch", false },
{ "dockerVolumeConfiguration",
{
{ "autoprovision", false },
{ "driver", "string" },
{ "driverOpts", "any" },
{ "labels", "any" },
{ "scope", "string" },
} },
{ "efsVolumeConfiguration",
{
{ "authorizationConfig",
{
{ "accessPointId", "string" },
{ "iam", "string" },
} },
{ "filesystemId", "string" },
{ "rootDirectory", "string" },
{ "transitEncryption", "string" },
{ "transitEncryptionPort", 0 },
} },
{ "fSxWindowsFileServerVolumeConfiguration",
{
{ "authorizationConfig",
{
{ "credentialsParameter", "string" },
{ "domain", "string" },
} },
{ "fileSystemId", "string" },
{ "rootDirectory", "string" },
} },
{ "host",
{
{ "sourcePath", "string" },
} },
{ "name", "string" },
},
} },
} },
{ "awsRegion", "string" },
{ "awsSourceSchema", "string" },
{ "awsTags",
{
{ "string", "string" },
} },
{ "publicCloudConnectorsResourceId", "string" },
{ "publicCloudResourceName", "string" },
},
Tags =
{
{ "string", "string" },
},
});
example, err := awsconnector.NewEcsTaskDefinition(ctx, "ecsTaskDefinitionResource", &awsconnector.EcsTaskDefinitionArgs{
ResourceGroupName: "string",
Location: "string",
Name: "string",
Properties: map[string]interface{}{
"arn": "string",
"awsAccountId": "string",
"awsProperties": map[string]interface{}{
"containerDefinitions": []map[string]interface{}{
map[string]interface{}{
"command": []string{
"string",
},
"cpu": 0,
"credentialSpecs": []string{
"string",
},
"dependsOn": []map[string]interface{}{
map[string]interface{}{
"condition": "string",
"containerName": "string",
},
},
"disableNetworking": false,
"dnsSearchDomains": []string{
"string",
},
"dnsServers": []string{
"string",
},
"dockerLabels": "any",
"dockerSecurityOptions": []string{
"string",
},
"entryPoint": []string{
"string",
},
"environment": []map[string]interface{}{
map[string]interface{}{
"name": "string",
"value": "string",
},
},
"environmentFiles": []map[string]interface{}{
map[string]interface{}{
"type": "string",
"value": "string",
},
},
"essential": false,
"extraHosts": []map[string]interface{}{
map[string]interface{}{
"hostname": "string",
"ipAddress": "string",
},
},
"firelensConfiguration": map[string]interface{}{
"options": "any",
"type": "string",
},
"healthCheck": map[string]interface{}{
"command": []string{
"string",
},
"interval": 0,
"retries": 0,
"startPeriod": 0,
"timeout": 0,
},
"hostname": "string",
"image": "string",
"interactive": false,
"links": []string{
"string",
},
"linuxParameters": map[string]interface{}{
"capabilities": map[string]interface{}{
"add": []string{
"string",
},
"drop": []string{
"string",
},
},
"devices": []map[string]interface{}{
map[string]interface{}{
"containerPath": "string",
"hostPath": "string",
"permissions": []string{
"string",
},
},
},
"initProcessEnabled": false,
"maxSwap": 0,
"sharedMemorySize": 0,
"swappiness": 0,
"tmpfs": []map[string]interface{}{
map[string]interface{}{
"containerPath": "string",
"mountOptions": []string{
"string",
},
"size": 0,
},
},
},
"logConfiguration": map[string]interface{}{
"logDriver": "string",
"options": "any",
"secretOptions": []map[string]interface{}{
map[string]interface{}{
"name": "string",
"valueFrom": "string",
},
},
},
"memory": 0,
"memoryReservation": 0,
"mountPoints": []map[string]interface{}{
map[string]interface{}{
"containerPath": "string",
"readOnly": false,
"sourceVolume": "string",
},
},
"name": "string",
"portMappings": []map[string]interface{}{
map[string]interface{}{
"appProtocol": "string",
"containerPort": 0,
"containerPortRange": "string",
"hostPort": 0,
"name": "string",
"protocol": "string",
},
},
"privileged": false,
"pseudoTerminal": false,
"readonlyRootFilesystem": false,
"repositoryCredentials": map[string]interface{}{
"credentialsParameter": "string",
},
"resourceRequirements": []map[string]interface{}{
map[string]interface{}{
"type": "string",
"value": "string",
},
},
"secrets": []map[string]interface{}{
map[string]interface{}{
"name": "string",
"valueFrom": "string",
},
},
"startTimeout": 0,
"stopTimeout": 0,
"systemControls": []map[string]interface{}{
map[string]interface{}{
"namespace": "string",
"value": "string",
},
},
"ulimits": []map[string]interface{}{
map[string]interface{}{
"hardLimit": 0,
"name": "string",
"softLimit": 0,
},
},
"user": "string",
"volumesFrom": []map[string]interface{}{
map[string]interface{}{
"readOnly": false,
"sourceContainer": "string",
},
},
"workingDirectory": "string",
},
},
"cpu": "string",
"ephemeralStorage": map[string]interface{}{
"size": 0,
"sizeInGiB": 0,
},
"executionRoleArn": "string",
"family": "string",
"inferenceAccelerators": []map[string]interface{}{
map[string]interface{}{
"deviceName": "string",
"deviceType": "string",
},
},
"ipcMode": "string",
"memory": "string",
"networkMode": "string",
"pidMode": "string",
"placementConstraints": []map[string]interface{}{
map[string]interface{}{
"expression": "string",
"type": "string",
},
},
"proxyConfiguration": map[string]interface{}{
"containerName": "string",
"proxyConfigurationProperties": []map[string]interface{}{
map[string]interface{}{
"name": "string",
"value": "string",
},
},
"type": "string",
},
"requiresCompatibilities": []string{
"string",
},
"runtimePlatform": map[string]interface{}{
"cpuArchitecture": "string",
"operatingSystemFamily": "string",
},
"tags": []map[string]interface{}{
map[string]interface{}{
"key": "string",
"value": "string",
},
},
"taskDefinitionArn": "string",
"taskRoleArn": "string",
"volumes": []map[string]interface{}{
map[string]interface{}{
"configuredAtLaunch": false,
"dockerVolumeConfiguration": map[string]interface{}{
"autoprovision": false,
"driver": "string",
"driverOpts": "any",
"labels": "any",
"scope": "string",
},
"efsVolumeConfiguration": map[string]interface{}{
"authorizationConfig": map[string]interface{}{
"accessPointId": "string",
"iam": "string",
},
"filesystemId": "string",
"rootDirectory": "string",
"transitEncryption": "string",
"transitEncryptionPort": 0,
},
"fSxWindowsFileServerVolumeConfiguration": map[string]interface{}{
"authorizationConfig": map[string]interface{}{
"credentialsParameter": "string",
"domain": "string",
},
"fileSystemId": "string",
"rootDirectory": "string",
},
"host": map[string]interface{}{
"sourcePath": "string",
},
"name": "string",
},
},
},
"awsRegion": "string",
"awsSourceSchema": "string",
"awsTags": map[string]interface{}{
"string": "string",
},
"publicCloudConnectorsResourceId": "string",
"publicCloudResourceName": "string",
},
Tags: map[string]interface{}{
"string": "string",
},
})
var ecsTaskDefinitionResource = new EcsTaskDefinition("ecsTaskDefinitionResource", EcsTaskDefinitionArgs.builder()
.resourceGroupName("string")
.location("string")
.name("string")
.properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
ecs_task_definition_resource = azure_native.awsconnector.EcsTaskDefinition("ecsTaskDefinitionResource",
resource_group_name=string,
location=string,
name=string,
properties={
arn: string,
awsAccountId: string,
awsProperties: {
containerDefinitions: [{
command: [string],
cpu: 0,
credentialSpecs: [string],
dependsOn: [{
condition: string,
containerName: string,
}],
disableNetworking: False,
dnsSearchDomains: [string],
dnsServers: [string],
dockerLabels: any,
dockerSecurityOptions: [string],
entryPoint: [string],
environment: [{
name: string,
value: string,
}],
environmentFiles: [{
type: string,
value: string,
}],
essential: False,
extraHosts: [{
hostname: string,
ipAddress: string,
}],
firelensConfiguration: {
options: any,
type: string,
},
healthCheck: {
command: [string],
interval: 0,
retries: 0,
startPeriod: 0,
timeout: 0,
},
hostname: string,
image: string,
interactive: False,
links: [string],
linuxParameters: {
capabilities: {
add: [string],
drop: [string],
},
devices: [{
containerPath: string,
hostPath: string,
permissions: [string],
}],
initProcessEnabled: False,
maxSwap: 0,
sharedMemorySize: 0,
swappiness: 0,
tmpfs: [{
containerPath: string,
mountOptions: [string],
size: 0,
}],
},
logConfiguration: {
logDriver: string,
options: any,
secretOptions: [{
name: string,
valueFrom: string,
}],
},
memory: 0,
memoryReservation: 0,
mountPoints: [{
containerPath: string,
readOnly: False,
sourceVolume: string,
}],
name: string,
portMappings: [{
appProtocol: string,
containerPort: 0,
containerPortRange: string,
hostPort: 0,
name: string,
protocol: string,
}],
privileged: False,
pseudoTerminal: False,
readonlyRootFilesystem: False,
repositoryCredentials: {
credentialsParameter: string,
},
resourceRequirements: [{
type: string,
value: string,
}],
secrets: [{
name: string,
valueFrom: string,
}],
startTimeout: 0,
stopTimeout: 0,
systemControls: [{
namespace: string,
value: string,
}],
ulimits: [{
hardLimit: 0,
name: string,
softLimit: 0,
}],
user: string,
volumesFrom: [{
readOnly: False,
sourceContainer: string,
}],
workingDirectory: string,
}],
cpu: string,
ephemeralStorage: {
size: 0,
sizeInGiB: 0,
},
executionRoleArn: string,
family: string,
inferenceAccelerators: [{
deviceName: string,
deviceType: string,
}],
ipcMode: string,
memory: string,
networkMode: string,
pidMode: string,
placementConstraints: [{
expression: string,
type: string,
}],
proxyConfiguration: {
containerName: string,
proxyConfigurationProperties: [{
name: string,
value: string,
}],
type: string,
},
requiresCompatibilities: [string],
runtimePlatform: {
cpuArchitecture: string,
operatingSystemFamily: string,
},
tags: [{
key: string,
value: string,
}],
taskDefinitionArn: string,
taskRoleArn: string,
volumes: [{
configuredAtLaunch: False,
dockerVolumeConfiguration: {
autoprovision: False,
driver: string,
driverOpts: any,
labels: any,
scope: string,
},
efsVolumeConfiguration: {
authorizationConfig: {
accessPointId: string,
iam: string,
},
filesystemId: string,
rootDirectory: string,
transitEncryption: string,
transitEncryptionPort: 0,
},
fSxWindowsFileServerVolumeConfiguration: {
authorizationConfig: {
credentialsParameter: string,
domain: string,
},
fileSystemId: string,
rootDirectory: string,
},
host: {
sourcePath: string,
},
name: string,
}],
},
awsRegion: string,
awsSourceSchema: string,
awsTags: {
string: string,
},
publicCloudConnectorsResourceId: string,
publicCloudResourceName: string,
},
tags={
string: string,
})
const ecsTaskDefinitionResource = new azure_native.awsconnector.EcsTaskDefinition("ecsTaskDefinitionResource", {
resourceGroupName: "string",
location: "string",
name: "string",
properties: {
arn: "string",
awsAccountId: "string",
awsProperties: {
containerDefinitions: [{
command: ["string"],
cpu: 0,
credentialSpecs: ["string"],
dependsOn: [{
condition: "string",
containerName: "string",
}],
disableNetworking: false,
dnsSearchDomains: ["string"],
dnsServers: ["string"],
dockerLabels: "any",
dockerSecurityOptions: ["string"],
entryPoint: ["string"],
environment: [{
name: "string",
value: "string",
}],
environmentFiles: [{
type: "string",
value: "string",
}],
essential: false,
extraHosts: [{
hostname: "string",
ipAddress: "string",
}],
firelensConfiguration: {
options: "any",
type: "string",
},
healthCheck: {
command: ["string"],
interval: 0,
retries: 0,
startPeriod: 0,
timeout: 0,
},
hostname: "string",
image: "string",
interactive: false,
links: ["string"],
linuxParameters: {
capabilities: {
add: ["string"],
drop: ["string"],
},
devices: [{
containerPath: "string",
hostPath: "string",
permissions: ["string"],
}],
initProcessEnabled: false,
maxSwap: 0,
sharedMemorySize: 0,
swappiness: 0,
tmpfs: [{
containerPath: "string",
mountOptions: ["string"],
size: 0,
}],
},
logConfiguration: {
logDriver: "string",
options: "any",
secretOptions: [{
name: "string",
valueFrom: "string",
}],
},
memory: 0,
memoryReservation: 0,
mountPoints: [{
containerPath: "string",
readOnly: false,
sourceVolume: "string",
}],
name: "string",
portMappings: [{
appProtocol: "string",
containerPort: 0,
containerPortRange: "string",
hostPort: 0,
name: "string",
protocol: "string",
}],
privileged: false,
pseudoTerminal: false,
readonlyRootFilesystem: false,
repositoryCredentials: {
credentialsParameter: "string",
},
resourceRequirements: [{
type: "string",
value: "string",
}],
secrets: [{
name: "string",
valueFrom: "string",
}],
startTimeout: 0,
stopTimeout: 0,
systemControls: [{
namespace: "string",
value: "string",
}],
ulimits: [{
hardLimit: 0,
name: "string",
softLimit: 0,
}],
user: "string",
volumesFrom: [{
readOnly: false,
sourceContainer: "string",
}],
workingDirectory: "string",
}],
cpu: "string",
ephemeralStorage: {
size: 0,
sizeInGiB: 0,
},
executionRoleArn: "string",
family: "string",
inferenceAccelerators: [{
deviceName: "string",
deviceType: "string",
}],
ipcMode: "string",
memory: "string",
networkMode: "string",
pidMode: "string",
placementConstraints: [{
expression: "string",
type: "string",
}],
proxyConfiguration: {
containerName: "string",
proxyConfigurationProperties: [{
name: "string",
value: "string",
}],
type: "string",
},
requiresCompatibilities: ["string"],
runtimePlatform: {
cpuArchitecture: "string",
operatingSystemFamily: "string",
},
tags: [{
key: "string",
value: "string",
}],
taskDefinitionArn: "string",
taskRoleArn: "string",
volumes: [{
configuredAtLaunch: false,
dockerVolumeConfiguration: {
autoprovision: false,
driver: "string",
driverOpts: "any",
labels: "any",
scope: "string",
},
efsVolumeConfiguration: {
authorizationConfig: {
accessPointId: "string",
iam: "string",
},
filesystemId: "string",
rootDirectory: "string",
transitEncryption: "string",
transitEncryptionPort: 0,
},
fSxWindowsFileServerVolumeConfiguration: {
authorizationConfig: {
credentialsParameter: "string",
domain: "string",
},
fileSystemId: "string",
rootDirectory: "string",
},
host: {
sourcePath: "string",
},
name: "string",
}],
},
awsRegion: "string",
awsSourceSchema: "string",
awsTags: {
string: "string",
},
publicCloudConnectorsResourceId: "string",
publicCloudResourceName: "string",
},
tags: {
string: "string",
},
});
type: azure-native:awsconnector:EcsTaskDefinition
properties:
location: string
name: string
properties:
arn: string
awsAccountId: string
awsProperties:
containerDefinitions:
- command:
- string
cpu: 0
credentialSpecs:
- string
dependsOn:
- condition: string
containerName: string
disableNetworking: false
dnsSearchDomains:
- string
dnsServers:
- string
dockerLabels: any
dockerSecurityOptions:
- string
entryPoint:
- string
environment:
- name: string
value: string
environmentFiles:
- type: string
value: string
essential: false
extraHosts:
- hostname: string
ipAddress: string
firelensConfiguration:
options: any
type: string
healthCheck:
command:
- string
interval: 0
retries: 0
startPeriod: 0
timeout: 0
hostname: string
image: string
interactive: false
links:
- string
linuxParameters:
capabilities:
add:
- string
drop:
- string
devices:
- containerPath: string
hostPath: string
permissions:
- string
initProcessEnabled: false
maxSwap: 0
sharedMemorySize: 0
swappiness: 0
tmpfs:
- containerPath: string
mountOptions:
- string
size: 0
logConfiguration:
logDriver: string
options: any
secretOptions:
- name: string
valueFrom: string
memory: 0
memoryReservation: 0
mountPoints:
- containerPath: string
readOnly: false
sourceVolume: string
name: string
portMappings:
- appProtocol: string
containerPort: 0
containerPortRange: string
hostPort: 0
name: string
protocol: string
privileged: false
pseudoTerminal: false
readonlyRootFilesystem: false
repositoryCredentials:
credentialsParameter: string
resourceRequirements:
- type: string
value: string
secrets:
- name: string
valueFrom: string
startTimeout: 0
stopTimeout: 0
systemControls:
- namespace: string
value: string
ulimits:
- hardLimit: 0
name: string
softLimit: 0
user: string
volumesFrom:
- readOnly: false
sourceContainer: string
workingDirectory: string
cpu: string
ephemeralStorage:
size: 0
sizeInGiB: 0
executionRoleArn: string
family: string
inferenceAccelerators:
- deviceName: string
deviceType: string
ipcMode: string
memory: string
networkMode: string
pidMode: string
placementConstraints:
- expression: string
type: string
proxyConfiguration:
containerName: string
proxyConfigurationProperties:
- name: string
value: string
type: string
requiresCompatibilities:
- string
runtimePlatform:
cpuArchitecture: string
operatingSystemFamily: string
tags:
- key: string
value: string
taskDefinitionArn: string
taskRoleArn: string
volumes:
- configuredAtLaunch: false
dockerVolumeConfiguration:
autoprovision: false
driver: string
driverOpts: any
labels: any
scope: string
efsVolumeConfiguration:
authorizationConfig:
accessPointId: string
iam: string
filesystemId: string
rootDirectory: string
transitEncryption: string
transitEncryptionPort: 0
fSxWindowsFileServerVolumeConfiguration:
authorizationConfig:
credentialsParameter: string
domain: string
fileSystemId: string
rootDirectory: string
host:
sourcePath: string
name: string
awsRegion: string
awsSourceSchema: string
awsTags:
string: string
publicCloudConnectorsResourceId: string
publicCloudResourceName: string
resourceGroupName: string
tags:
string: string
EcsTaskDefinition Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The EcsTaskDefinition resource accepts the following input properties:
- Resource
Group Name stringThis property is required. 
Changes to this property will trigger replacement. - The name of the resource group. The name is case insensitive.
- Location
- The geo-location where the resource lives
- Name
- Name of EcsTaskDefinition
- Properties
Pulumi.
Azure Native. Aws Connector. Inputs. Ecs Task Definition Properties - The resource-specific properties for this resource.
- Dictionary<string, string>
- Resource tags.
- Resource
Group Name stringThis property is required. Changes to this property will trigger replacement. - The name of the resource group. The name is case insensitive.
- Location
- The geo-location where the resource lives
- Name
- Name of EcsTaskDefinition
- Properties
Ecs
Task Definition Properties Args - The resource-specific properties for this resource.
- map[string]string
- Resource tags.
- resource
Group Name StringThis property is required. Changes to this property will trigger replacement. - The name of the resource group. The name is case insensitive.
- location
- The geo-location where the resource lives
- name
- Name of EcsTaskDefinition
- properties
Ecs
Task Definition Properties - The resource-specific properties for this resource.
- Map<String,String>
- Resource tags.
- resource
Group Name stringThis property is required. Changes to this property will trigger replacement. - The name of the resource group. The name is case insensitive.
- location
- The geo-location where the resource lives
- name
- Name of EcsTaskDefinition
- properties
Ecs
Task Definition Properties - The resource-specific properties for this resource.
- {[key: string]: string}
- Resource tags.
- resource_
group_ name strThis property is required. Changes to this property will trigger replacement. - The name of the resource group. The name is case insensitive.
- location
- The geo-location where the resource lives
- name
- Name of EcsTaskDefinition
- properties
Ecs
Task Definition Properties Args - The resource-specific properties for this resource.
- Mapping[str, str]
- Resource tags.
- resource
Group Name StringThis property is required. Changes to this property will trigger replacement. - The name of the resource group. The name is case insensitive.
- location
- The geo-location where the resource lives
- name
- Name of EcsTaskDefinition
- properties Property Map
- The resource-specific properties for this resource.
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the EcsTaskDefinition resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- System
Data Pulumi.Azure Native. Aws Connector. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Id string
- The provider-assigned unique ID for this managed resource.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id string
- The provider-assigned unique ID for this managed resource.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id str
- The provider-assigned unique ID for this managed resource.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
AuthorizationConfig, AuthorizationConfigArgs
, AuthorizationConfigArgs
- Access
Point stringId - The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfigurationmust either be omitted or set to/which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in theEFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide. - Iam
string | Pulumi.
Azure Native. Aws Connector. Authorization Config IAM - Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the
EFSVolumeConfiguration. If this parameter is omitted, the default value ofDISABLEDis used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.
- Access
Point stringId - The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfigurationmust either be omitted or set to/which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in theEFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide. - Iam
string | Authorization
Config IAM - Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the
EFSVolumeConfiguration. If this parameter is omitted, the default value ofDISABLEDis used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.
- access
Point StringId - The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfigurationmust either be omitted or set to/which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in theEFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide. - iam
String | Authorization
Config IAM - Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the
EFSVolumeConfiguration. If this parameter is omitted, the default value ofDISABLEDis used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.
- access
Point stringId - The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfigurationmust either be omitted or set to/which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in theEFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide. - iam
string | Authorization
Config IAM - Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the
EFSVolumeConfiguration. If this parameter is omitted, the default value ofDISABLEDis used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.
- access_
point_ strid - The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfigurationmust either be omitted or set to/which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in theEFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide. - iam
str | Authorization
Config IAM - Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the
EFSVolumeConfiguration. If this parameter is omitted, the default value ofDISABLEDis used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.
- access
Point StringId - The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfigurationmust either be omitted or set to/which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in theEFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide. - iam String | "DISABLED" | "ENABLED"
- Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the
EFSVolumeConfiguration. If this parameter is omitted, the default value ofDISABLEDis used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.
AuthorizationConfigIAM, AuthorizationConfigIAMArgs
, AuthorizationConfigIAMArgs
- DISABLED
- DISABLEDAuthorizationConfigIAM enum DISABLED
- ENABLED
- ENABLEDAuthorizationConfigIAM enum ENABLED
- Authorization
Config IAMDISABLED - DISABLEDAuthorizationConfigIAM enum DISABLED
- Authorization
Config IAMENABLED - ENABLEDAuthorizationConfigIAM enum ENABLED
- DISABLED
- DISABLEDAuthorizationConfigIAM enum DISABLED
- ENABLED
- ENABLEDAuthorizationConfigIAM enum ENABLED
- DISABLED
- DISABLEDAuthorizationConfigIAM enum DISABLED
- ENABLED
- ENABLEDAuthorizationConfigIAM enum ENABLED
- DISABLED
- DISABLEDAuthorizationConfigIAM enum DISABLED
- ENABLED
- ENABLEDAuthorizationConfigIAM enum ENABLED
- "DISABLED"
- DISABLEDAuthorizationConfigIAM enum DISABLED
- "ENABLED"
- ENABLEDAuthorizationConfigIAM enum ENABLED
AuthorizationConfigResponse, AuthorizationConfigResponseArgs
, AuthorizationConfigResponseArgs
- Access
Point stringId - The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfigurationmust either be omitted or set to/which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in theEFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide. - Iam string
- Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the
EFSVolumeConfiguration. If this parameter is omitted, the default value ofDISABLEDis used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.
- Access
Point stringId - The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfigurationmust either be omitted or set to/which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in theEFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide. - Iam string
- Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the
EFSVolumeConfiguration. If this parameter is omitted, the default value ofDISABLEDis used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.
- access
Point StringId - The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfigurationmust either be omitted or set to/which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in theEFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide. - iam String
- Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the
EFSVolumeConfiguration. If this parameter is omitted, the default value ofDISABLEDis used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.
- access
Point stringId - The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfigurationmust either be omitted or set to/which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in theEFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide. - iam string
- Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the
EFSVolumeConfiguration. If this parameter is omitted, the default value ofDISABLEDis used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.
- access_
point_ strid - The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfigurationmust either be omitted or set to/which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in theEFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide. - iam str
- Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the
EFSVolumeConfiguration. If this parameter is omitted, the default value ofDISABLEDis used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.
- access
Point StringId - The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfigurationmust either be omitted or set to/which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in theEFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide. - iam String
- Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the
EFSVolumeConfiguration. If this parameter is omitted, the default value ofDISABLEDis used. For more information, see Using Amazon EFS access points in the Amazon Elastic Container Service Developer Guide.
AwsEcsTaskDefinitionProperties, AwsEcsTaskDefinitionPropertiesArgs
, AwsEcsTaskDefinitionPropertiesArgs
- Container
Definitions List<Pulumi.Azure Native. Aws Connector. Inputs. Container Definition> - 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.
- Cpu string
- The number of
cpuunits 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 thememoryparameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Availablememoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Availablememoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Availablememoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Availablememoryvalues: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Availablememoryvalues: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Availablememoryvalues: 16 GB and 60 GB in 4 GB increments This option requires Linux platform1.4.0or later. + 16384 (16vCPU) - Availablememoryvalues: 32GB and 120 GB in 8 GB increments This option requires Linux platform1.4.0or later. - Ephemeral
Storage Pulumi.Azure Native. Aws Connector. Inputs. Ephemeral Storage - The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide;. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version
1.4.0or later. + Windows platform version1.0.0or later. - Execution
Role stringArn - 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 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 string
- 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, CFNlong generates a new task definition each time that you update it.
- Inference
Accelerators List<Pulumi.Azure Native. Aws Connector. Inputs. Inference Accelerator> - The Elastic Inference accelerators to use for the containers in the task.
- Ipc
Mode string - 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. For more information, see IPC settings in the Docker run reference. If thehostIPC 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 usingsystemControlsfor 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 thehostIPC mode, IPC namespace relatedsystemControlsare not supported. + For tasks that use thetaskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong. - Memory string
- 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 FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpuparameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Availablecpuvalues: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Availablecpuvalues: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Availablecpuvalues: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Availablecpuvalues: 8192 (8 vCPU) This option requires Linux platform1.4.0or later. + Between 32GB and 120 GB in 8 GB increments - Availablecpuvalues: 16384 (16 vCPU) This option requires Linux platform1.4.0or later. - Network
Mode string - 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, theawsvpcnetwork 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 thehostandawsvpcnetwork 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 thehostnetwork 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 isawsvpc, 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 ishost, 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. - Pid
Mode string - 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. Ifhostis 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. Iftaskis 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. For more information, see PID settings in the Docker run reference. If thehostPID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security. This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version1.4.0or later (Linux). This isn't supported for Windows containers on Fargate. - Placement
Constraints List<Pulumi.Azure Native. Aws Connector. Inputs. Task Definition Placement Constraint> - An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong.
- Proxy
Configuration Pulumi.Azure Native. Aws Connector. Inputs. Proxy Configuration - 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. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of theecs-initpackage to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301or later, then they contain the required versions of the container agent andecs-init. For more information, see Amazon ECS-optimized Linux AMI - Requires
Compatibilities List<string> - 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. - Runtime
Platform Pulumi.Azure Native. Aws Connector. Inputs. Runtime Platform - The operating system that your tasks definitions run on. 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
runtimePlatformvalue of the service. Information about the platform for the Amazon ECS service or task. For more information aboutRuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide. -
List<Pulumi.
Azure Native. Aws Connector. Inputs. Tag> - 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: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. - Task
Definition stringArn - Property taskDefinitionArn
- Task
Role stringArn - The short name or full Amazon Resource Name (ARN) of the IAMlong 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. - Volumes
List<Pulumi.
Azure Native. Aws Connector. Inputs. Volume> - 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 FARGATElong.
- Container
Definitions []ContainerDefinition - 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.
- Cpu string
- The number of
cpuunits 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 thememoryparameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Availablememoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Availablememoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Availablememoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Availablememoryvalues: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Availablememoryvalues: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Availablememoryvalues: 16 GB and 60 GB in 4 GB increments This option requires Linux platform1.4.0or later. + 16384 (16vCPU) - Availablememoryvalues: 32GB and 120 GB in 8 GB increments This option requires Linux platform1.4.0or later. - Ephemeral
Storage EphemeralStorage - The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide;. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version
1.4.0or later. + Windows platform version1.0.0or later. - Execution
Role stringArn - 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 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 string
- 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, CFNlong generates a new task definition each time that you update it.
- Inference
Accelerators []InferenceAccelerator - The Elastic Inference accelerators to use for the containers in the task.
- Ipc
Mode string - 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. For more information, see IPC settings in the Docker run reference. If thehostIPC 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 usingsystemControlsfor 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 thehostIPC mode, IPC namespace relatedsystemControlsare not supported. + For tasks that use thetaskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong. - Memory string
- 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 FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpuparameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Availablecpuvalues: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Availablecpuvalues: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Availablecpuvalues: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Availablecpuvalues: 8192 (8 vCPU) This option requires Linux platform1.4.0or later. + Between 32GB and 120 GB in 8 GB increments - Availablecpuvalues: 16384 (16 vCPU) This option requires Linux platform1.4.0or later. - Network
Mode string - 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, theawsvpcnetwork 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 thehostandawsvpcnetwork 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 thehostnetwork 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 isawsvpc, 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 ishost, 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. - Pid
Mode string - 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. Ifhostis 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. Iftaskis 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. For more information, see PID settings in the Docker run reference. If thehostPID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security. This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version1.4.0or later (Linux). This isn't supported for Windows containers on Fargate. - Placement
Constraints []TaskDefinition Placement Constraint - An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong.
- Proxy
Configuration 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-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. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of theecs-initpackage to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301or later, then they contain the required versions of the container agent andecs-init. For more information, see Amazon ECS-optimized Linux AMI - Requires
Compatibilities []string - 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. - Runtime
Platform RuntimePlatform - The operating system that your tasks definitions run on. 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
runtimePlatformvalue of the service. Information about the platform for the Amazon ECS service or task. For more information aboutRuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide. - []Tag
- 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: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. - Task
Definition stringArn - Property taskDefinitionArn
- Task
Role stringArn - The short name or full Amazon Resource Name (ARN) of the IAMlong 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. - Volumes []Volume
- 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 FARGATElong.
- container
Definitions List<ContainerDefinition> - 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.
- cpu String
- The number of
cpuunits 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 thememoryparameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Availablememoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Availablememoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Availablememoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Availablememoryvalues: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Availablememoryvalues: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Availablememoryvalues: 16 GB and 60 GB in 4 GB increments This option requires Linux platform1.4.0or later. + 16384 (16vCPU) - Availablememoryvalues: 32GB and 120 GB in 8 GB increments This option requires Linux platform1.4.0or later. - ephemeral
Storage EphemeralStorage - The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide;. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version
1.4.0or later. + Windows platform version1.0.0or later. - execution
Role StringArn - 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 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 String
- 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, CFNlong generates a new task definition each time that you update it.
- inference
Accelerators List<InferenceAccelerator> - The Elastic Inference accelerators to use for the containers in the task.
- ipc
Mode String - 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. For more information, see IPC settings in the Docker run reference. If thehostIPC 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 usingsystemControlsfor 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 thehostIPC mode, IPC namespace relatedsystemControlsare not supported. + For tasks that use thetaskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong. - memory String
- 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 FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpuparameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Availablecpuvalues: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Availablecpuvalues: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Availablecpuvalues: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Availablecpuvalues: 8192 (8 vCPU) This option requires Linux platform1.4.0or later. + Between 32GB and 120 GB in 8 GB increments - Availablecpuvalues: 16384 (16 vCPU) This option requires Linux platform1.4.0or later. - network
Mode String - 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, theawsvpcnetwork 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 thehostandawsvpcnetwork 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 thehostnetwork 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 isawsvpc, 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 ishost, 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. - pid
Mode String - 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. Ifhostis 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. Iftaskis 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. For more information, see PID settings in the Docker run reference. If thehostPID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security. This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version1.4.0or later (Linux). This isn't supported for Windows containers on Fargate. - placement
Constraints List<TaskDefinition Placement Constraint> - An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong.
- proxy
Configuration 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-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. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of theecs-initpackage to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301or later, then they contain the required versions of the container agent andecs-init. For more information, see Amazon ECS-optimized Linux AMI - requires
Compatibilities List<String> - 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. - runtime
Platform RuntimePlatform - The operating system that your tasks definitions run on. 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
runtimePlatformvalue of the service. Information about the platform for the Amazon ECS service or task. For more information aboutRuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide. - List<Tag>
- 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: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. - task
Definition StringArn - Property taskDefinitionArn
- task
Role StringArn - The short name or full Amazon Resource Name (ARN) of the IAMlong 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. - volumes List<Volume>
- 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 FARGATElong.
- container
Definitions ContainerDefinition[] - 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.
- cpu string
- The number of
cpuunits 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 thememoryparameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Availablememoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Availablememoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Availablememoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Availablememoryvalues: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Availablememoryvalues: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Availablememoryvalues: 16 GB and 60 GB in 4 GB increments This option requires Linux platform1.4.0or later. + 16384 (16vCPU) - Availablememoryvalues: 32GB and 120 GB in 8 GB increments This option requires Linux platform1.4.0or later. - ephemeral
Storage EphemeralStorage - The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide;. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version
1.4.0or later. + Windows platform version1.0.0or later. - execution
Role stringArn - 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 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 string
- 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, CFNlong generates a new task definition each time that you update it.
- inference
Accelerators InferenceAccelerator[] - The Elastic Inference accelerators to use for the containers in the task.
- ipc
Mode string - 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. For more information, see IPC settings in the Docker run reference. If thehostIPC 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 usingsystemControlsfor 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 thehostIPC mode, IPC namespace relatedsystemControlsare not supported. + For tasks that use thetaskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong. - memory string
- 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 FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpuparameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Availablecpuvalues: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Availablecpuvalues: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Availablecpuvalues: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Availablecpuvalues: 8192 (8 vCPU) This option requires Linux platform1.4.0or later. + Between 32GB and 120 GB in 8 GB increments - Availablecpuvalues: 16384 (16 vCPU) This option requires Linux platform1.4.0or later. - network
Mode string - 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, theawsvpcnetwork 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 thehostandawsvpcnetwork 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 thehostnetwork 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 isawsvpc, 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 ishost, 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. - pid
Mode string - 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. Ifhostis 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. Iftaskis 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. For more information, see PID settings in the Docker run reference. If thehostPID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security. This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version1.4.0or later (Linux). This isn't supported for Windows containers on Fargate. - placement
Constraints TaskDefinition Placement Constraint[] - An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong.
- proxy
Configuration 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-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. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of theecs-initpackage to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301or later, then they contain the required versions of the container agent andecs-init. For more information, see Amazon ECS-optimized Linux AMI - requires
Compatibilities string[] - 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. - runtime
Platform RuntimePlatform - The operating system that your tasks definitions run on. 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
runtimePlatformvalue of the service. Information about the platform for the Amazon ECS service or task. For more information aboutRuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide. - Tag[]
- 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: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. - task
Definition stringArn - Property taskDefinitionArn
- task
Role stringArn - The short name or full Amazon Resource Name (ARN) of the IAMlong 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. - volumes Volume[]
- 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 FARGATElong.
- container_
definitions Sequence[ContainerDefinition] - 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.
- cpu str
- The number of
cpuunits 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 thememoryparameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Availablememoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Availablememoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Availablememoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Availablememoryvalues: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Availablememoryvalues: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Availablememoryvalues: 16 GB and 60 GB in 4 GB increments This option requires Linux platform1.4.0or later. + 16384 (16vCPU) - Availablememoryvalues: 32GB and 120 GB in 8 GB increments This option requires Linux platform1.4.0or later. - ephemeral_
storage EphemeralStorage - The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide;. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version
1.4.0or later. + Windows platform version1.0.0or later. - execution_
role_ strarn - 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 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 str
- 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, CFNlong generates a new task definition each time that you update it.
- inference_
accelerators Sequence[InferenceAccelerator] - The Elastic Inference accelerators to use for the containers in the task.
- ipc_
mode str - 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. For more information, see IPC settings in the Docker run reference. If thehostIPC 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 usingsystemControlsfor 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 thehostIPC mode, IPC namespace relatedsystemControlsare not supported. + For tasks that use thetaskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong. - memory str
- 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 FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpuparameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Availablecpuvalues: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Availablecpuvalues: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Availablecpuvalues: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Availablecpuvalues: 8192 (8 vCPU) This option requires Linux platform1.4.0or later. + Between 32GB and 120 GB in 8 GB increments - Availablecpuvalues: 16384 (16 vCPU) This option requires Linux platform1.4.0or later. - network_
mode str - 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, theawsvpcnetwork 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 thehostandawsvpcnetwork 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 thehostnetwork 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 isawsvpc, 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 ishost, 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. - pid_
mode str - 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. Ifhostis 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. Iftaskis 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. For more information, see PID settings in the Docker run reference. If thehostPID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security. This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version1.4.0or later (Linux). This isn't supported for Windows containers on Fargate. - placement_
constraints Sequence[TaskDefinition Placement Constraint] - An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong.
- proxy_
configuration 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-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. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of theecs-initpackage to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301or later, then they contain the required versions of the container agent andecs-init. For more information, see Amazon ECS-optimized Linux AMI - requires_
compatibilities Sequence[str] - 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. - runtime_
platform RuntimePlatform - The operating system that your tasks definitions run on. 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
runtimePlatformvalue of the service. Information about the platform for the Amazon ECS service or task. For more information aboutRuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide. - Sequence[Tag]
- 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: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. - task_
definition_ strarn - Property taskDefinitionArn
- task_
role_ strarn - The short name or full Amazon Resource Name (ARN) of the IAMlong 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. - volumes Sequence[Volume]
- 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 FARGATElong.
- container
Definitions List<Property Map> - 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.
- cpu String
- The number of
cpuunits 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 thememoryparameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Availablememoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Availablememoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Availablememoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Availablememoryvalues: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Availablememoryvalues: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Availablememoryvalues: 16 GB and 60 GB in 4 GB increments This option requires Linux platform1.4.0or later. + 16384 (16vCPU) - Availablememoryvalues: 32GB and 120 GB in 8 GB increments This option requires Linux platform1.4.0or later. - ephemeral
Storage Property Map - The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide;. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version
1.4.0or later. + Windows platform version1.0.0or later. - execution
Role StringArn - 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 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 String
- 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, CFNlong generates a new task definition each time that you update it.
- inference
Accelerators List<Property Map> - The Elastic Inference accelerators to use for the containers in the task.
- ipc
Mode String - 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. For more information, see IPC settings in the Docker run reference. If thehostIPC 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 usingsystemControlsfor 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 thehostIPC mode, IPC namespace relatedsystemControlsare not supported. + For tasks that use thetaskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong. - memory String
- 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 FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpuparameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Availablecpuvalues: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Availablecpuvalues: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Availablecpuvalues: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Availablecpuvalues: 8192 (8 vCPU) This option requires Linux platform1.4.0or later. + Between 32GB and 120 GB in 8 GB increments - Availablecpuvalues: 16384 (16 vCPU) This option requires Linux platform1.4.0or later. - network
Mode String - 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, theawsvpcnetwork 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 thehostandawsvpcnetwork 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 thehostnetwork 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 isawsvpc, 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 ishost, 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. - pid
Mode String - 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. Ifhostis 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. Iftaskis 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. For more information, see PID settings in the Docker run reference. If thehostPID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security. This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version1.4.0or later (Linux). This isn't supported for Windows containers on Fargate. - placement
Constraints List<Property Map> - An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong.
- proxy
Configuration Property Map - 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. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of theecs-initpackage to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301or later, then they contain the required versions of the container agent andecs-init. For more information, see Amazon ECS-optimized Linux AMI - requires
Compatibilities List<String> - 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. - runtime
Platform Property Map - The operating system that your tasks definitions run on. 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
runtimePlatformvalue of the service. Information about the platform for the Amazon ECS service or task. For more information aboutRuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide. - List<Property Map>
- 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: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. - task
Definition StringArn - Property taskDefinitionArn
- task
Role StringArn - The short name or full Amazon Resource Name (ARN) of the IAMlong 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. - volumes List<Property Map>
- 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 FARGATElong.
AwsEcsTaskDefinitionPropertiesResponse, AwsEcsTaskDefinitionPropertiesResponseArgs
, AwsEcsTaskDefinitionPropertiesResponseArgs
- Container
Definitions List<Pulumi.Azure Native. Aws Connector. Inputs. Container Definition Response> - 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.
- Cpu string
- The number of
cpuunits 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 thememoryparameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Availablememoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Availablememoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Availablememoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Availablememoryvalues: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Availablememoryvalues: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Availablememoryvalues: 16 GB and 60 GB in 4 GB increments This option requires Linux platform1.4.0or later. + 16384 (16vCPU) - Availablememoryvalues: 32GB and 120 GB in 8 GB increments This option requires Linux platform1.4.0or later. - Ephemeral
Storage Pulumi.Azure Native. Aws Connector. Inputs. Ephemeral Storage Response - The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide;. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version
1.4.0or later. + Windows platform version1.0.0or later. - Execution
Role stringArn - 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 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 string
- 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, CFNlong generates a new task definition each time that you update it.
- Inference
Accelerators List<Pulumi.Azure Native. Aws Connector. Inputs. Inference Accelerator Response> - The Elastic Inference accelerators to use for the containers in the task.
- Ipc
Mode string - 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. For more information, see IPC settings in the Docker run reference. If thehostIPC 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 usingsystemControlsfor 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 thehostIPC mode, IPC namespace relatedsystemControlsare not supported. + For tasks that use thetaskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong. - Memory string
- 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 FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpuparameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Availablecpuvalues: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Availablecpuvalues: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Availablecpuvalues: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Availablecpuvalues: 8192 (8 vCPU) This option requires Linux platform1.4.0or later. + Between 32GB and 120 GB in 8 GB increments - Availablecpuvalues: 16384 (16 vCPU) This option requires Linux platform1.4.0or later. - Network
Mode string - 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, theawsvpcnetwork 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 thehostandawsvpcnetwork 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 thehostnetwork 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 isawsvpc, 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 ishost, 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. - Pid
Mode string - 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. Ifhostis 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. Iftaskis 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. For more information, see PID settings in the Docker run reference. If thehostPID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security. This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version1.4.0or later (Linux). This isn't supported for Windows containers on Fargate. - Placement
Constraints List<Pulumi.Azure Native. Aws Connector. Inputs. Task Definition Placement Constraint Response> - An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong.
- Proxy
Configuration Pulumi.Azure Native. Aws Connector. Inputs. Proxy Configuration Response - 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. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of theecs-initpackage to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301or later, then they contain the required versions of the container agent andecs-init. For more information, see Amazon ECS-optimized Linux AMI - Requires
Compatibilities List<string> - 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. - Runtime
Platform Pulumi.Azure Native. Aws Connector. Inputs. Runtime Platform Response - The operating system that your tasks definitions run on. 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
runtimePlatformvalue of the service. Information about the platform for the Amazon ECS service or task. For more information aboutRuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide. -
List<Pulumi.
Azure Native. Aws Connector. Inputs. Tag Response> - 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: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. - Task
Definition stringArn - Property taskDefinitionArn
- Task
Role stringArn - The short name or full Amazon Resource Name (ARN) of the IAMlong 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. - Volumes
List<Pulumi.
Azure Native. Aws Connector. Inputs. Volume Response> - 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 FARGATElong.
- Container
Definitions []ContainerDefinition Response - 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.
- Cpu string
- The number of
cpuunits 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 thememoryparameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Availablememoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Availablememoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Availablememoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Availablememoryvalues: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Availablememoryvalues: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Availablememoryvalues: 16 GB and 60 GB in 4 GB increments This option requires Linux platform1.4.0or later. + 16384 (16vCPU) - Availablememoryvalues: 32GB and 120 GB in 8 GB increments This option requires Linux platform1.4.0or later. - Ephemeral
Storage EphemeralStorage Response - The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide;. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version
1.4.0or later. + Windows platform version1.0.0or later. - Execution
Role stringArn - 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 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 string
- 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, CFNlong generates a new task definition each time that you update it.
- Inference
Accelerators []InferenceAccelerator Response - The Elastic Inference accelerators to use for the containers in the task.
- Ipc
Mode string - 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. For more information, see IPC settings in the Docker run reference. If thehostIPC 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 usingsystemControlsfor 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 thehostIPC mode, IPC namespace relatedsystemControlsare not supported. + For tasks that use thetaskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong. - Memory string
- 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 FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpuparameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Availablecpuvalues: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Availablecpuvalues: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Availablecpuvalues: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Availablecpuvalues: 8192 (8 vCPU) This option requires Linux platform1.4.0or later. + Between 32GB and 120 GB in 8 GB increments - Availablecpuvalues: 16384 (16 vCPU) This option requires Linux platform1.4.0or later. - Network
Mode string - 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, theawsvpcnetwork 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 thehostandawsvpcnetwork 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 thehostnetwork 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 isawsvpc, 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 ishost, 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. - Pid
Mode string - 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. Ifhostis 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. Iftaskis 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. For more information, see PID settings in the Docker run reference. If thehostPID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security. This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version1.4.0or later (Linux). This isn't supported for Windows containers on Fargate. - Placement
Constraints []TaskDefinition Placement Constraint Response - An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong.
- Proxy
Configuration ProxyConfiguration Response - 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. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of theecs-initpackage to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301or later, then they contain the required versions of the container agent andecs-init. For more information, see Amazon ECS-optimized Linux AMI - Requires
Compatibilities []string - 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. - Runtime
Platform RuntimePlatform Response - The operating system that your tasks definitions run on. 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
runtimePlatformvalue of the service. Information about the platform for the Amazon ECS service or task. For more information aboutRuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide. -
[]Tag
Response - 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: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. - Task
Definition stringArn - Property taskDefinitionArn
- Task
Role stringArn - The short name or full Amazon Resource Name (ARN) of the IAMlong 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. - Volumes
[]Volume
Response - 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 FARGATElong.
- container
Definitions List<ContainerDefinition Response> - 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.
- cpu String
- The number of
cpuunits 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 thememoryparameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Availablememoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Availablememoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Availablememoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Availablememoryvalues: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Availablememoryvalues: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Availablememoryvalues: 16 GB and 60 GB in 4 GB increments This option requires Linux platform1.4.0or later. + 16384 (16vCPU) - Availablememoryvalues: 32GB and 120 GB in 8 GB increments This option requires Linux platform1.4.0or later. - ephemeral
Storage EphemeralStorage Response - The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide;. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version
1.4.0or later. + Windows platform version1.0.0or later. - execution
Role StringArn - 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 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 String
- 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, CFNlong generates a new task definition each time that you update it.
- inference
Accelerators List<InferenceAccelerator Response> - The Elastic Inference accelerators to use for the containers in the task.
- ipc
Mode String - 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. For more information, see IPC settings in the Docker run reference. If thehostIPC 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 usingsystemControlsfor 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 thehostIPC mode, IPC namespace relatedsystemControlsare not supported. + For tasks that use thetaskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong. - memory String
- 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 FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpuparameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Availablecpuvalues: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Availablecpuvalues: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Availablecpuvalues: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Availablecpuvalues: 8192 (8 vCPU) This option requires Linux platform1.4.0or later. + Between 32GB and 120 GB in 8 GB increments - Availablecpuvalues: 16384 (16 vCPU) This option requires Linux platform1.4.0or later. - network
Mode String - 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, theawsvpcnetwork 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 thehostandawsvpcnetwork 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 thehostnetwork 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 isawsvpc, 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 ishost, 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. - pid
Mode String - 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. Ifhostis 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. Iftaskis 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. For more information, see PID settings in the Docker run reference. If thehostPID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security. This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version1.4.0or later (Linux). This isn't supported for Windows containers on Fargate. - placement
Constraints List<TaskDefinition Placement Constraint Response> - An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong.
- proxy
Configuration ProxyConfiguration Response - 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. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of theecs-initpackage to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301or later, then they contain the required versions of the container agent andecs-init. For more information, see Amazon ECS-optimized Linux AMI - requires
Compatibilities List<String> - 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. - runtime
Platform RuntimePlatform Response - The operating system that your tasks definitions run on. 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
runtimePlatformvalue of the service. Information about the platform for the Amazon ECS service or task. For more information aboutRuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide. -
List<Tag
Response> - 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: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. - task
Definition StringArn - Property taskDefinitionArn
- task
Role StringArn - The short name or full Amazon Resource Name (ARN) of the IAMlong 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. - volumes
List<Volume
Response> - 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 FARGATElong.
- container
Definitions ContainerDefinition Response[] - 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.
- cpu string
- The number of
cpuunits 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 thememoryparameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Availablememoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Availablememoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Availablememoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Availablememoryvalues: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Availablememoryvalues: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Availablememoryvalues: 16 GB and 60 GB in 4 GB increments This option requires Linux platform1.4.0or later. + 16384 (16vCPU) - Availablememoryvalues: 32GB and 120 GB in 8 GB increments This option requires Linux platform1.4.0or later. - ephemeral
Storage EphemeralStorage Response - The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide;. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version
1.4.0or later. + Windows platform version1.0.0or later. - execution
Role stringArn - 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 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 string
- 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, CFNlong generates a new task definition each time that you update it.
- inference
Accelerators InferenceAccelerator Response[] - The Elastic Inference accelerators to use for the containers in the task.
- ipc
Mode string - 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. For more information, see IPC settings in the Docker run reference. If thehostIPC 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 usingsystemControlsfor 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 thehostIPC mode, IPC namespace relatedsystemControlsare not supported. + For tasks that use thetaskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong. - memory string
- 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 FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpuparameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Availablecpuvalues: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Availablecpuvalues: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Availablecpuvalues: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Availablecpuvalues: 8192 (8 vCPU) This option requires Linux platform1.4.0or later. + Between 32GB and 120 GB in 8 GB increments - Availablecpuvalues: 16384 (16 vCPU) This option requires Linux platform1.4.0or later. - network
Mode string - 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, theawsvpcnetwork 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 thehostandawsvpcnetwork 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 thehostnetwork 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 isawsvpc, 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 ishost, 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. - pid
Mode string - 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. Ifhostis 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. Iftaskis 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. For more information, see PID settings in the Docker run reference. If thehostPID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security. This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version1.4.0or later (Linux). This isn't supported for Windows containers on Fargate. - placement
Constraints TaskDefinition Placement Constraint Response[] - An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong.
- proxy
Configuration ProxyConfiguration Response - 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. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of theecs-initpackage to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301or later, then they contain the required versions of the container agent andecs-init. For more information, see Amazon ECS-optimized Linux AMI - requires
Compatibilities string[] - 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. - runtime
Platform RuntimePlatform Response - The operating system that your tasks definitions run on. 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
runtimePlatformvalue of the service. Information about the platform for the Amazon ECS service or task. For more information aboutRuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide. -
Tag
Response[] - 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: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. - task
Definition stringArn - Property taskDefinitionArn
- task
Role stringArn - The short name or full Amazon Resource Name (ARN) of the IAMlong 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. - volumes
Volume
Response[] - 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 FARGATElong.
- container_
definitions Sequence[ContainerDefinition Response] - 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.
- cpu str
- The number of
cpuunits 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 thememoryparameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Availablememoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Availablememoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Availablememoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Availablememoryvalues: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Availablememoryvalues: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Availablememoryvalues: 16 GB and 60 GB in 4 GB increments This option requires Linux platform1.4.0or later. + 16384 (16vCPU) - Availablememoryvalues: 32GB and 120 GB in 8 GB increments This option requires Linux platform1.4.0or later. - ephemeral_
storage EphemeralStorage Response - The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide;. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version
1.4.0or later. + Windows platform version1.0.0or later. - execution_
role_ strarn - 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 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 str
- 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, CFNlong generates a new task definition each time that you update it.
- inference_
accelerators Sequence[InferenceAccelerator Response] - The Elastic Inference accelerators to use for the containers in the task.
- ipc_
mode str - 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. For more information, see IPC settings in the Docker run reference. If thehostIPC 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 usingsystemControlsfor 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 thehostIPC mode, IPC namespace relatedsystemControlsare not supported. + For tasks that use thetaskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong. - memory str
- 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 FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpuparameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Availablecpuvalues: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Availablecpuvalues: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Availablecpuvalues: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Availablecpuvalues: 8192 (8 vCPU) This option requires Linux platform1.4.0or later. + Between 32GB and 120 GB in 8 GB increments - Availablecpuvalues: 16384 (16 vCPU) This option requires Linux platform1.4.0or later. - network_
mode str - 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, theawsvpcnetwork 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 thehostandawsvpcnetwork 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 thehostnetwork 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 isawsvpc, 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 ishost, 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. - pid_
mode str - 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. Ifhostis 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. Iftaskis 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. For more information, see PID settings in the Docker run reference. If thehostPID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security. This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version1.4.0or later (Linux). This isn't supported for Windows containers on Fargate. - placement_
constraints Sequence[TaskDefinition Placement Constraint Response] - An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong.
- proxy_
configuration ProxyConfiguration Response - 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. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of theecs-initpackage to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301or later, then they contain the required versions of the container agent andecs-init. For more information, see Amazon ECS-optimized Linux AMI - requires_
compatibilities Sequence[str] - 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. - runtime_
platform RuntimePlatform Response - The operating system that your tasks definitions run on. 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
runtimePlatformvalue of the service. Information about the platform for the Amazon ECS service or task. For more information aboutRuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide. -
Sequence[Tag
Response] - 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: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. - task_
definition_ strarn - Property taskDefinitionArn
- task_
role_ strarn - The short name or full Amazon Resource Name (ARN) of the IAMlong 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. - volumes
Sequence[Volume
Response] - 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 FARGATElong.
- container
Definitions List<Property Map> - 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.
- cpu String
- The number of
cpuunits 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 thememoryparameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Availablememoryvalues: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Availablememoryvalues: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Availablememoryvalues: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Availablememoryvalues: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Availablememoryvalues: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Availablememoryvalues: 16 GB and 60 GB in 4 GB increments This option requires Linux platform1.4.0or later. + 16384 (16vCPU) - Availablememoryvalues: 32GB and 120 GB in 8 GB increments This option requires Linux platform1.4.0or later. - ephemeral
Storage Property Map - The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide;. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version
1.4.0or later. + Windows platform version1.0.0or later. - execution
Role StringArn - 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 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 String
- 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, CFNlong generates a new task definition each time that you update it.
- inference
Accelerators List<Property Map> - The Elastic Inference accelerators to use for the containers in the task.
- ipc
Mode String - 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. For more information, see IPC settings in the Docker run reference. If thehostIPC 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 usingsystemControlsfor 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 thehostIPC mode, IPC namespace relatedsystemControlsare not supported. + For tasks that use thetaskIPC mode, IPC namespace relatedsystemControlswill apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong. - memory String
- 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 FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the
cpuparameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Availablecpuvalues: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Availablecpuvalues: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Availablecpuvalues: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Availablecpuvalues: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Availablecpuvalues: 8192 (8 vCPU) This option requires Linux platform1.4.0or later. + Between 32GB and 120 GB in 8 GB increments - Availablecpuvalues: 16384 (16 vCPU) This option requires Linux platform1.4.0or later. - network
Mode String - 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, theawsvpcnetwork 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 thehostandawsvpcnetwork 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 thehostnetwork 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 isawsvpc, 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 ishost, 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. - pid
Mode String - 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. Ifhostis 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. Iftaskis 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. For more information, see PID settings in the Docker run reference. If thehostPID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security. This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version1.4.0or later (Linux). This isn't supported for Windows containers on Fargate. - placement
Constraints List<Property Map> - An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong.
- proxy
Configuration Property Map - 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. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of theecs-initpackage to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version20190301or later, then they contain the required versions of the container agent andecs-init. For more information, see Amazon ECS-optimized Linux AMI - requires
Compatibilities List<String> - 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. - runtime
Platform Property Map - The operating system that your tasks definitions run on. 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
runtimePlatformvalue of the service. Information about the platform for the Amazon ECS service or task. For more information aboutRuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide. - List<Property Map>
- 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: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. - task
Definition StringArn - Property taskDefinitionArn
- task
Role StringArn - The short name or full Amazon Resource Name (ARN) of the IAMlong 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. - volumes List<Property Map>
- 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 FARGATElong.
ContainerDefinition, ContainerDefinitionArgs
, ContainerDefinitionArgs
- Command List<string>
- The command that's passed to the container. This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array. - Cpu int
- The number of
cpuunits reserved for the container. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption to docker run. This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-levelcpuvalue. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as0, which Windows interprets as 1% of one CPU. - Credential
Specs List<string> - A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of thedockerSecurityOptions. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replaceMyARNwith the ARN in SSM or Amazon S3. If you provide acredentialspecdomainless:MyARN, thecredspecmust provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers. - Depends
On List<Pulumi.Azure Native. Aws Connector. Inputs. Container Dependency> - The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-initpackage. If your container instances are launched from version20190301or later, then 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. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. If the task definition is used in a blue/green deployment that uses AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration, thedependsOnparameter is not supported. For more information see Issue #680 on the on the GitHub website. - Disable
Networking bool - When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API. This parameter is not supported for Windows containers. - Dns
Search List<string>Domains - A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run. This parameter is not supported for Windows containers. - Dns
Servers List<string> - A list of DNS servers that are presented to the container. This parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run. This parameter is not supported for Windows containers. - Docker
Labels object - A key/value map of labels to add to the container. This parameter maps to
Labelsin the Create a container section of the Docker Remote API and the--labeloption to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - Docker
Security List<string>Options - A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide. This parameter maps to
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run. The Amazon ECS container agent running on a container instance must register with theECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. For more information about valid values, see Docker Run Security Configuration. Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath' - Entry
Point List<string> - Early versions of the Amazon ECS container agent don't properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead. The entry point that's passed to the container. This parameter maps toEntrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint. - Environment
List<Pulumi.
Azure Native. Aws Connector. Inputs. Key Value Pair> - The environment variables to pass to a container. This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption to docker run. We don't recommend that you use plaintext environment variables for sensitive information, such as credential data. - Environment
Files List<Pulumi.Azure Native. Aws Connector. Inputs. Environment File> - A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-fileoption to docker run. You can specify up to ten environment files. The file must have a.envfile extension. Each line in an environment file contains an environment variable inVARIABLE=VALUEformat. Lines beginning with#are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file. If there are environment variables specified using theenvironmentparameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide. - Essential bool
- If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide. - Extra
Hosts List<Pulumi.Azure Native. Aws Connector. Inputs. Host Entry> - A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run. This parameter isn't supported for Windows containers or tasks that use theawsvpcnetwork mode. - Firelens
Configuration Pulumi.Azure Native. Aws Connector. Inputs. Firelens Configuration - The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
- Health
Check Pulumi.Azure Native. Aws Connector. Inputs. Health Check - The container health check command and associated configuration parameters for the container. This parameter maps to
HealthCheckin the Create a container section of the Docker Remote API and theHEALTHCHECKparameter of docker run. TheHealthCheckproperty specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to theHEALTHCHECKparameter of docker run. The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent. + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see Platform Versions. + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer. - Hostname string
- The hostname to use for your container. This parameter maps to
Hostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run. Thehostnameparameter is not supported if you're using theawsvpcnetwork mode. - Image string
- The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tagorrepository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run. + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the fullregistry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. + Images in official repositories on Docker Hub use a single name (for example,ubuntuormongo). + Images in other repositories on Docker Hub are qualified with an organization name (for example,amazon/amazon-ecs-agent). + Images in other online repositories are qualified further by a domain name (for example,quay.io/assemblyline/ubuntu). - Interactive bool
- When this parameter is
true, you can deploy containerized applications that requirestdinor attyto be allocated. This parameter maps toOpenStdinin the Create a container section of the Docker Remote API and the--interactiveoption to docker run. - Links List<string>
- The
linksparameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition isbridge. Thename:internalNameconstruct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption to docker run. This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. - Linux
Parameters Pulumi.Azure Native. Aws Connector. Inputs. Linux Parameters - Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities. This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
- Log
Configuration Pulumi.Azure Native. Aws Connector. Inputs. Log Configuration - The log configuration specification for the container. This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with theECS_AVAILABLE_LOGGING_DRIVERSenvironment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. TheLogConfigurationproperty specifies log configuration options to send to a custom log driver for the container. - Memory int
- The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memoryvalue, if one is specified. This parameter maps toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run. If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-levelmemoryandmemoryReservationvalue,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. - Memory
Reservation int - The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the
memoryparameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservationin the Create a container section of the Docker Remote API and the--memory-reservationoption to docker run. If a task-level memory value is not specified, you must specify a non-zero integer for one or both ofmemoryormemoryReservationin a container definition. If you specify both,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set amemoryReservationof 128 MiB, and amemoryhard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers. - Mount
Points List<Pulumi.Azure Native. Aws Connector. Inputs. Mount Point> - The mount points for data volumes in your container. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. - Name string
- The name of a container. If you're linking multiple containers together in a task definition, the
nameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run. - Port
Mappings List<Pulumi.Azure Native. Aws Connector. Inputs. Port Mapping> - The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the
awsvpcnetwork mode, you should only specify thecontainerPort. ThehostPortcan be left blank or it must be the same value as thecontainerPort. Port mappings on Windows use theNetNATgateway address rather thanlocalhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps toPortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run. If the network mode of a task definition is set tonone, then you can't specify port mappings. If the network mode of a task definition is set tohost, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches theRUNNINGstatus, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in thenetworkBindingssection DescribeTasks responses. - Privileged bool
- When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run. This parameter is not supported for Windows containers or tasks run on FARGATElong. - Pseudo
Terminal bool - When this parameter is
true, a TTY is allocated. This parameter maps toTtyin the Create a container section of the Docker Remote API and the--ttyoption to docker run. - Readonly
Root boolFilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption to docker run. This parameter is not supported for Windows containers. - Repository
Credentials Pulumi.Azure Native. Aws Connector. Inputs. Repository Credentials - The private repository authentication credentials to use. The repository credentials for private registry authentication.
- Resource
Requirements List<Pulumi.Azure Native. Aws Connector. Inputs. Resource Requirement> - The type and amount of a resource to assign to a container. The only supported resource is a GPU.
- Secrets
List<Pulumi.
Azure Native. Aws Connector. Inputs. Secret> - The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
- Start
Timeout int - Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE,SUCCESS, orHEALTHYstatus. If astartTimeoutvalue is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to aSTOPPEDstate. When theECS_CONTAINER_START_TIMEOUTcontainer agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. For tasks using the EC2 launch type, your container instances require at least version1.26.0of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version1.26.0-1of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - Stop
Timeout int - Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version
1.3.0or later. + Windows platform version1.0.0or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if thestopTimeoutparameter isn't specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUTis used. If neither thestopTimeoutparameter or theECS_CONTAINER_STOP_TIMEOUTagent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - System
Controls List<Pulumi.Azure Native. Aws Connector. Inputs. System Control> - A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctlsin the Create a container section of the Docker Remote API and the--sysctloption to docker run. For example, you can configurenet.ipv4.tcp_keepalive_timesetting to maintain longer lived connections. - Ulimits
List<Pulumi.
Azure Native. Aws Connector. Inputs. Ulimit> - A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'This parameter is not supported for Windows containers. - User string
- The user to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run. When running tasks using thehostnetwork mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify theuserusing the following formats. If specifying a UID or GID, you must specify it as a positive integer. +user+user:group+uid+uid:gid+user:gid+uid:groupThis parameter is not supported for Windows containers. - Volumes
From List<Pulumi.Azure Native. Aws Connector. Inputs. Volume From> - Data volumes to mount from another container. This parameter maps to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run. - Working
Directory string - The working directory to run commands inside the container in. This parameter maps to
WorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.
- Command []string
- The command that's passed to the container. This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array. - Cpu int
- The number of
cpuunits reserved for the container. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption to docker run. This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-levelcpuvalue. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as0, which Windows interprets as 1% of one CPU. - Credential
Specs []string - A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of thedockerSecurityOptions. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replaceMyARNwith the ARN in SSM or Amazon S3. If you provide acredentialspecdomainless:MyARN, thecredspecmust provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers. - Depends
On []ContainerDependency - The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-initpackage. If your container instances are launched from version20190301or later, then 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. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. If the task definition is used in a blue/green deployment that uses AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration, thedependsOnparameter is not supported. For more information see Issue #680 on the on the GitHub website. - Disable
Networking bool - When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API. This parameter is not supported for Windows containers. - Dns
Search []stringDomains - A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run. This parameter is not supported for Windows containers. - Dns
Servers []string - A list of DNS servers that are presented to the container. This parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run. This parameter is not supported for Windows containers. - Docker
Labels interface{} - A key/value map of labels to add to the container. This parameter maps to
Labelsin the Create a container section of the Docker Remote API and the--labeloption to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - Docker
Security []stringOptions - A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide. This parameter maps to
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run. The Amazon ECS container agent running on a container instance must register with theECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. For more information about valid values, see Docker Run Security Configuration. Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath' - Entry
Point []string - Early versions of the Amazon ECS container agent don't properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead. The entry point that's passed to the container. This parameter maps toEntrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint. - Environment
[]Key
Value Pair - The environment variables to pass to a container. This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption to docker run. We don't recommend that you use plaintext environment variables for sensitive information, such as credential data. - Environment
Files []EnvironmentFile - A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-fileoption to docker run. You can specify up to ten environment files. The file must have a.envfile extension. Each line in an environment file contains an environment variable inVARIABLE=VALUEformat. Lines beginning with#are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file. If there are environment variables specified using theenvironmentparameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide. - Essential bool
- If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide. - Extra
Hosts []HostEntry - A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run. This parameter isn't supported for Windows containers or tasks that use theawsvpcnetwork mode. - Firelens
Configuration FirelensConfiguration - The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
- Health
Check HealthCheck - The container health check command and associated configuration parameters for the container. This parameter maps to
HealthCheckin the Create a container section of the Docker Remote API and theHEALTHCHECKparameter of docker run. TheHealthCheckproperty specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to theHEALTHCHECKparameter of docker run. The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent. + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see Platform Versions. + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer. - Hostname string
- The hostname to use for your container. This parameter maps to
Hostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run. Thehostnameparameter is not supported if you're using theawsvpcnetwork mode. - Image string
- The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tagorrepository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run. + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the fullregistry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. + Images in official repositories on Docker Hub use a single name (for example,ubuntuormongo). + Images in other repositories on Docker Hub are qualified with an organization name (for example,amazon/amazon-ecs-agent). + Images in other online repositories are qualified further by a domain name (for example,quay.io/assemblyline/ubuntu). - Interactive bool
- When this parameter is
true, you can deploy containerized applications that requirestdinor attyto be allocated. This parameter maps toOpenStdinin the Create a container section of the Docker Remote API and the--interactiveoption to docker run. - Links []string
- The
linksparameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition isbridge. Thename:internalNameconstruct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption to docker run. This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. - Linux
Parameters LinuxParameters - Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities. This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
- Log
Configuration LogConfiguration - The log configuration specification for the container. This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with theECS_AVAILABLE_LOGGING_DRIVERSenvironment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. TheLogConfigurationproperty specifies log configuration options to send to a custom log driver for the container. - Memory int
- The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memoryvalue, if one is specified. This parameter maps toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run. If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-levelmemoryandmemoryReservationvalue,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. - Memory
Reservation int - The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the
memoryparameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservationin the Create a container section of the Docker Remote API and the--memory-reservationoption to docker run. If a task-level memory value is not specified, you must specify a non-zero integer for one or both ofmemoryormemoryReservationin a container definition. If you specify both,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set amemoryReservationof 128 MiB, and amemoryhard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers. - Mount
Points []MountPoint - The mount points for data volumes in your container. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. - Name string
- The name of a container. If you're linking multiple containers together in a task definition, the
nameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run. - Port
Mappings []PortMapping - The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the
awsvpcnetwork mode, you should only specify thecontainerPort. ThehostPortcan be left blank or it must be the same value as thecontainerPort. Port mappings on Windows use theNetNATgateway address rather thanlocalhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps toPortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run. If the network mode of a task definition is set tonone, then you can't specify port mappings. If the network mode of a task definition is set tohost, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches theRUNNINGstatus, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in thenetworkBindingssection DescribeTasks responses. - Privileged bool
- When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run. This parameter is not supported for Windows containers or tasks run on FARGATElong. - Pseudo
Terminal bool - When this parameter is
true, a TTY is allocated. This parameter maps toTtyin the Create a container section of the Docker Remote API and the--ttyoption to docker run. - Readonly
Root boolFilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption to docker run. This parameter is not supported for Windows containers. - Repository
Credentials RepositoryCredentials - The private repository authentication credentials to use. The repository credentials for private registry authentication.
- Resource
Requirements []ResourceRequirement - The type and amount of a resource to assign to a container. The only supported resource is a GPU.
- Secrets []Secret
- The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
- Start
Timeout int - Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE,SUCCESS, orHEALTHYstatus. If astartTimeoutvalue is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to aSTOPPEDstate. When theECS_CONTAINER_START_TIMEOUTcontainer agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. For tasks using the EC2 launch type, your container instances require at least version1.26.0of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version1.26.0-1of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - Stop
Timeout int - Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version
1.3.0or later. + Windows platform version1.0.0or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if thestopTimeoutparameter isn't specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUTis used. If neither thestopTimeoutparameter or theECS_CONTAINER_STOP_TIMEOUTagent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - System
Controls []SystemControl - A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctlsin the Create a container section of the Docker Remote API and the--sysctloption to docker run. For example, you can configurenet.ipv4.tcp_keepalive_timesetting to maintain longer lived connections. - Ulimits []Ulimit
- A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'This parameter is not supported for Windows containers. - User string
- The user to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run. When running tasks using thehostnetwork mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify theuserusing the following formats. If specifying a UID or GID, you must specify it as a positive integer. +user+user:group+uid+uid:gid+user:gid+uid:groupThis parameter is not supported for Windows containers. - Volumes
From []VolumeFrom - Data volumes to mount from another container. This parameter maps to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run. - Working
Directory string - The working directory to run commands inside the container in. This parameter maps to
WorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.
- command List<String>
- The command that's passed to the container. This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array. - cpu Integer
- The number of
cpuunits reserved for the container. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption to docker run. This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-levelcpuvalue. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as0, which Windows interprets as 1% of one CPU. - credential
Specs List<String> - A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of thedockerSecurityOptions. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replaceMyARNwith the ARN in SSM or Amazon S3. If you provide acredentialspecdomainless:MyARN, thecredspecmust provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers. - depends
On List<ContainerDependency> - The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-initpackage. If your container instances are launched from version20190301or later, then 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. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. If the task definition is used in a blue/green deployment that uses AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration, thedependsOnparameter is not supported. For more information see Issue #680 on the on the GitHub website. - disable
Networking Boolean - When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API. This parameter is not supported for Windows containers. - dns
Search List<String>Domains - A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run. This parameter is not supported for Windows containers. - dns
Servers List<String> - A list of DNS servers that are presented to the container. This parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run. This parameter is not supported for Windows containers. - docker
Labels Object - A key/value map of labels to add to the container. This parameter maps to
Labelsin the Create a container section of the Docker Remote API and the--labeloption to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - docker
Security List<String>Options - A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide. This parameter maps to
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run. The Amazon ECS container agent running on a container instance must register with theECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. For more information about valid values, see Docker Run Security Configuration. Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath' - entry
Point List<String> - Early versions of the Amazon ECS container agent don't properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead. The entry point that's passed to the container. This parameter maps toEntrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint. - environment
List<Key
Value Pair> - The environment variables to pass to a container. This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption to docker run. We don't recommend that you use plaintext environment variables for sensitive information, such as credential data. - environment
Files List<EnvironmentFile> - A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-fileoption to docker run. You can specify up to ten environment files. The file must have a.envfile extension. Each line in an environment file contains an environment variable inVARIABLE=VALUEformat. Lines beginning with#are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file. If there are environment variables specified using theenvironmentparameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide. - essential Boolean
- If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide. - extra
Hosts List<HostEntry> - A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run. This parameter isn't supported for Windows containers or tasks that use theawsvpcnetwork mode. - firelens
Configuration FirelensConfiguration - The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
- health
Check HealthCheck - The container health check command and associated configuration parameters for the container. This parameter maps to
HealthCheckin the Create a container section of the Docker Remote API and theHEALTHCHECKparameter of docker run. TheHealthCheckproperty specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to theHEALTHCHECKparameter of docker run. The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent. + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see Platform Versions. + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer. - hostname String
- The hostname to use for your container. This parameter maps to
Hostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run. Thehostnameparameter is not supported if you're using theawsvpcnetwork mode. - image String
- The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tagorrepository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run. + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the fullregistry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. + Images in official repositories on Docker Hub use a single name (for example,ubuntuormongo). + Images in other repositories on Docker Hub are qualified with an organization name (for example,amazon/amazon-ecs-agent). + Images in other online repositories are qualified further by a domain name (for example,quay.io/assemblyline/ubuntu). - interactive Boolean
- When this parameter is
true, you can deploy containerized applications that requirestdinor attyto be allocated. This parameter maps toOpenStdinin the Create a container section of the Docker Remote API and the--interactiveoption to docker run. - links List<String>
- The
linksparameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition isbridge. Thename:internalNameconstruct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption to docker run. This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. - linux
Parameters LinuxParameters - Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities. This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
- log
Configuration LogConfiguration - The log configuration specification for the container. This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with theECS_AVAILABLE_LOGGING_DRIVERSenvironment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. TheLogConfigurationproperty specifies log configuration options to send to a custom log driver for the container. - memory Integer
- The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memoryvalue, if one is specified. This parameter maps toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run. If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-levelmemoryandmemoryReservationvalue,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. - memory
Reservation Integer - The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the
memoryparameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservationin the Create a container section of the Docker Remote API and the--memory-reservationoption to docker run. If a task-level memory value is not specified, you must specify a non-zero integer for one or both ofmemoryormemoryReservationin a container definition. If you specify both,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set amemoryReservationof 128 MiB, and amemoryhard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers. - mount
Points List<MountPoint> - The mount points for data volumes in your container. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. - name String
- The name of a container. If you're linking multiple containers together in a task definition, the
nameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run. - port
Mappings List<PortMapping> - The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the
awsvpcnetwork mode, you should only specify thecontainerPort. ThehostPortcan be left blank or it must be the same value as thecontainerPort. Port mappings on Windows use theNetNATgateway address rather thanlocalhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps toPortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run. If the network mode of a task definition is set tonone, then you can't specify port mappings. If the network mode of a task definition is set tohost, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches theRUNNINGstatus, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in thenetworkBindingssection DescribeTasks responses. - privileged Boolean
- When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run. This parameter is not supported for Windows containers or tasks run on FARGATElong. - pseudo
Terminal Boolean - When this parameter is
true, a TTY is allocated. This parameter maps toTtyin the Create a container section of the Docker Remote API and the--ttyoption to docker run. - readonly
Root BooleanFilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption to docker run. This parameter is not supported for Windows containers. - repository
Credentials RepositoryCredentials - The private repository authentication credentials to use. The repository credentials for private registry authentication.
- resource
Requirements List<ResourceRequirement> - The type and amount of a resource to assign to a container. The only supported resource is a GPU.
- secrets List<Secret>
- The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
- start
Timeout Integer - Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE,SUCCESS, orHEALTHYstatus. If astartTimeoutvalue is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to aSTOPPEDstate. When theECS_CONTAINER_START_TIMEOUTcontainer agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. For tasks using the EC2 launch type, your container instances require at least version1.26.0of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version1.26.0-1of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - stop
Timeout Integer - Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version
1.3.0or later. + Windows platform version1.0.0or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if thestopTimeoutparameter isn't specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUTis used. If neither thestopTimeoutparameter or theECS_CONTAINER_STOP_TIMEOUTagent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - system
Controls List<SystemControl> - A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctlsin the Create a container section of the Docker Remote API and the--sysctloption to docker run. For example, you can configurenet.ipv4.tcp_keepalive_timesetting to maintain longer lived connections. - ulimits List<Ulimit>
- A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'This parameter is not supported for Windows containers. - user String
- The user to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run. When running tasks using thehostnetwork mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify theuserusing the following formats. If specifying a UID or GID, you must specify it as a positive integer. +user+user:group+uid+uid:gid+user:gid+uid:groupThis parameter is not supported for Windows containers. - volumes
From List<VolumeFrom> - Data volumes to mount from another container. This parameter maps to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run. - working
Directory String - The working directory to run commands inside the container in. This parameter maps to
WorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.
- command string[]
- The command that's passed to the container. This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array. - cpu number
- The number of
cpuunits reserved for the container. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption to docker run. This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-levelcpuvalue. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as0, which Windows interprets as 1% of one CPU. - credential
Specs string[] - A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of thedockerSecurityOptions. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replaceMyARNwith the ARN in SSM or Amazon S3. If you provide acredentialspecdomainless:MyARN, thecredspecmust provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers. - depends
On ContainerDependency[] - The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-initpackage. If your container instances are launched from version20190301or later, then 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. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. If the task definition is used in a blue/green deployment that uses AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration, thedependsOnparameter is not supported. For more information see Issue #680 on the on the GitHub website. - disable
Networking boolean - When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API. This parameter is not supported for Windows containers. - dns
Search string[]Domains - A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run. This parameter is not supported for Windows containers. - dns
Servers string[] - A list of DNS servers that are presented to the container. This parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run. This parameter is not supported for Windows containers. - docker
Labels any - A key/value map of labels to add to the container. This parameter maps to
Labelsin the Create a container section of the Docker Remote API and the--labeloption to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - docker
Security string[]Options - A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide. This parameter maps to
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run. The Amazon ECS container agent running on a container instance must register with theECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. For more information about valid values, see Docker Run Security Configuration. Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath' - entry
Point string[] - Early versions of the Amazon ECS container agent don't properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead. The entry point that's passed to the container. This parameter maps toEntrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint. - environment
Key
Value Pair[] - The environment variables to pass to a container. This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption to docker run. We don't recommend that you use plaintext environment variables for sensitive information, such as credential data. - environment
Files EnvironmentFile[] - A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-fileoption to docker run. You can specify up to ten environment files. The file must have a.envfile extension. Each line in an environment file contains an environment variable inVARIABLE=VALUEformat. Lines beginning with#are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file. If there are environment variables specified using theenvironmentparameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide. - essential boolean
- If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide. - extra
Hosts HostEntry[] - A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run. This parameter isn't supported for Windows containers or tasks that use theawsvpcnetwork mode. - firelens
Configuration FirelensConfiguration - The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
- health
Check HealthCheck - The container health check command and associated configuration parameters for the container. This parameter maps to
HealthCheckin the Create a container section of the Docker Remote API and theHEALTHCHECKparameter of docker run. TheHealthCheckproperty specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to theHEALTHCHECKparameter of docker run. The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent. + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see Platform Versions. + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer. - hostname string
- The hostname to use for your container. This parameter maps to
Hostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run. Thehostnameparameter is not supported if you're using theawsvpcnetwork mode. - image string
- The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tagorrepository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run. + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the fullregistry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. + Images in official repositories on Docker Hub use a single name (for example,ubuntuormongo). + Images in other repositories on Docker Hub are qualified with an organization name (for example,amazon/amazon-ecs-agent). + Images in other online repositories are qualified further by a domain name (for example,quay.io/assemblyline/ubuntu). - interactive boolean
- When this parameter is
true, you can deploy containerized applications that requirestdinor attyto be allocated. This parameter maps toOpenStdinin the Create a container section of the Docker Remote API and the--interactiveoption to docker run. - links string[]
- The
linksparameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition isbridge. Thename:internalNameconstruct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption to docker run. This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. - linux
Parameters LinuxParameters - Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities. This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
- log
Configuration LogConfiguration - The log configuration specification for the container. This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with theECS_AVAILABLE_LOGGING_DRIVERSenvironment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. TheLogConfigurationproperty specifies log configuration options to send to a custom log driver for the container. - memory number
- The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memoryvalue, if one is specified. This parameter maps toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run. If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-levelmemoryandmemoryReservationvalue,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. - memory
Reservation number - The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the
memoryparameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservationin the Create a container section of the Docker Remote API and the--memory-reservationoption to docker run. If a task-level memory value is not specified, you must specify a non-zero integer for one or both ofmemoryormemoryReservationin a container definition. If you specify both,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set amemoryReservationof 128 MiB, and amemoryhard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers. - mount
Points MountPoint[] - The mount points for data volumes in your container. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. - name string
- The name of a container. If you're linking multiple containers together in a task definition, the
nameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run. - port
Mappings PortMapping[] - The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the
awsvpcnetwork mode, you should only specify thecontainerPort. ThehostPortcan be left blank or it must be the same value as thecontainerPort. Port mappings on Windows use theNetNATgateway address rather thanlocalhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps toPortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run. If the network mode of a task definition is set tonone, then you can't specify port mappings. If the network mode of a task definition is set tohost, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches theRUNNINGstatus, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in thenetworkBindingssection DescribeTasks responses. - privileged boolean
- When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run. This parameter is not supported for Windows containers or tasks run on FARGATElong. - pseudo
Terminal boolean - When this parameter is
true, a TTY is allocated. This parameter maps toTtyin the Create a container section of the Docker Remote API and the--ttyoption to docker run. - readonly
Root booleanFilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption to docker run. This parameter is not supported for Windows containers. - repository
Credentials RepositoryCredentials - The private repository authentication credentials to use. The repository credentials for private registry authentication.
- resource
Requirements ResourceRequirement[] - The type and amount of a resource to assign to a container. The only supported resource is a GPU.
- secrets Secret[]
- The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
- start
Timeout number - Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE,SUCCESS, orHEALTHYstatus. If astartTimeoutvalue is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to aSTOPPEDstate. When theECS_CONTAINER_START_TIMEOUTcontainer agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. For tasks using the EC2 launch type, your container instances require at least version1.26.0of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version1.26.0-1of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - stop
Timeout number - Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version
1.3.0or later. + Windows platform version1.0.0or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if thestopTimeoutparameter isn't specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUTis used. If neither thestopTimeoutparameter or theECS_CONTAINER_STOP_TIMEOUTagent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - system
Controls SystemControl[] - A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctlsin the Create a container section of the Docker Remote API and the--sysctloption to docker run. For example, you can configurenet.ipv4.tcp_keepalive_timesetting to maintain longer lived connections. - ulimits Ulimit[]
- A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'This parameter is not supported for Windows containers. - user string
- The user to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run. When running tasks using thehostnetwork mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify theuserusing the following formats. If specifying a UID or GID, you must specify it as a positive integer. +user+user:group+uid+uid:gid+user:gid+uid:groupThis parameter is not supported for Windows containers. - volumes
From VolumeFrom[] - Data volumes to mount from another container. This parameter maps to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run. - working
Directory string - The working directory to run commands inside the container in. This parameter maps to
WorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.
- command Sequence[str]
- The command that's passed to the container. This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array. - cpu int
- The number of
cpuunits reserved for the container. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption to docker run. This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-levelcpuvalue. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as0, which Windows interprets as 1% of one CPU. - credential_
specs Sequence[str] - A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of thedockerSecurityOptions. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replaceMyARNwith the ARN in SSM or Amazon S3. If you provide acredentialspecdomainless:MyARN, thecredspecmust provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers. - depends_
on Sequence[ContainerDependency] - The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-initpackage. If your container instances are launched from version20190301or later, then 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. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. If the task definition is used in a blue/green deployment that uses AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration, thedependsOnparameter is not supported. For more information see Issue #680 on the on the GitHub website. - disable_
networking bool - When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API. This parameter is not supported for Windows containers. - dns_
search_ Sequence[str]domains - A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run. This parameter is not supported for Windows containers. - dns_
servers Sequence[str] - A list of DNS servers that are presented to the container. This parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run. This parameter is not supported for Windows containers. - docker_
labels Any - A key/value map of labels to add to the container. This parameter maps to
Labelsin the Create a container section of the Docker Remote API and the--labeloption to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - docker_
security_ Sequence[str]options - A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide. This parameter maps to
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run. The Amazon ECS container agent running on a container instance must register with theECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. For more information about valid values, see Docker Run Security Configuration. Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath' - entry_
point Sequence[str] - Early versions of the Amazon ECS container agent don't properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead. The entry point that's passed to the container. This parameter maps toEntrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint. - environment
Sequence[Key
Value Pair] - The environment variables to pass to a container. This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption to docker run. We don't recommend that you use plaintext environment variables for sensitive information, such as credential data. - environment_
files Sequence[EnvironmentFile] - A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-fileoption to docker run. You can specify up to ten environment files. The file must have a.envfile extension. Each line in an environment file contains an environment variable inVARIABLE=VALUEformat. Lines beginning with#are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file. If there are environment variables specified using theenvironmentparameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide. - essential bool
- If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide. - extra_
hosts Sequence[HostEntry] - A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run. This parameter isn't supported for Windows containers or tasks that use theawsvpcnetwork mode. - firelens_
configuration FirelensConfiguration - The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
- health_
check HealthCheck - The container health check command and associated configuration parameters for the container. This parameter maps to
HealthCheckin the Create a container section of the Docker Remote API and theHEALTHCHECKparameter of docker run. TheHealthCheckproperty specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to theHEALTHCHECKparameter of docker run. The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent. + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see Platform Versions. + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer. - hostname str
- The hostname to use for your container. This parameter maps to
Hostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run. Thehostnameparameter is not supported if you're using theawsvpcnetwork mode. - image str
- The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tagorrepository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run. + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the fullregistry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. + Images in official repositories on Docker Hub use a single name (for example,ubuntuormongo). + Images in other repositories on Docker Hub are qualified with an organization name (for example,amazon/amazon-ecs-agent). + Images in other online repositories are qualified further by a domain name (for example,quay.io/assemblyline/ubuntu). - interactive bool
- When this parameter is
true, you can deploy containerized applications that requirestdinor attyto be allocated. This parameter maps toOpenStdinin the Create a container section of the Docker Remote API and the--interactiveoption to docker run. - links Sequence[str]
- The
linksparameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition isbridge. Thename:internalNameconstruct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption to docker run. This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. - linux_
parameters LinuxParameters - Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities. This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
- log_
configuration LogConfiguration - The log configuration specification for the container. This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with theECS_AVAILABLE_LOGGING_DRIVERSenvironment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. TheLogConfigurationproperty specifies log configuration options to send to a custom log driver for the container. - memory int
- The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memoryvalue, if one is specified. This parameter maps toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run. If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-levelmemoryandmemoryReservationvalue,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. - memory_
reservation int - The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the
memoryparameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservationin the Create a container section of the Docker Remote API and the--memory-reservationoption to docker run. If a task-level memory value is not specified, you must specify a non-zero integer for one or both ofmemoryormemoryReservationin a container definition. If you specify both,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set amemoryReservationof 128 MiB, and amemoryhard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers. - mount_
points Sequence[MountPoint] - The mount points for data volumes in your container. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. - name str
- The name of a container. If you're linking multiple containers together in a task definition, the
nameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run. - port_
mappings Sequence[PortMapping] - The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the
awsvpcnetwork mode, you should only specify thecontainerPort. ThehostPortcan be left blank or it must be the same value as thecontainerPort. Port mappings on Windows use theNetNATgateway address rather thanlocalhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps toPortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run. If the network mode of a task definition is set tonone, then you can't specify port mappings. If the network mode of a task definition is set tohost, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches theRUNNINGstatus, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in thenetworkBindingssection DescribeTasks responses. - privileged bool
- When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run. This parameter is not supported for Windows containers or tasks run on FARGATElong. - pseudo_
terminal bool - When this parameter is
true, a TTY is allocated. This parameter maps toTtyin the Create a container section of the Docker Remote API and the--ttyoption to docker run. - readonly_
root_ boolfilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption to docker run. This parameter is not supported for Windows containers. - repository_
credentials RepositoryCredentials - The private repository authentication credentials to use. The repository credentials for private registry authentication.
- resource_
requirements Sequence[ResourceRequirement] - The type and amount of a resource to assign to a container. The only supported resource is a GPU.
- secrets Sequence[Secret]
- The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
- start_
timeout int - Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE,SUCCESS, orHEALTHYstatus. If astartTimeoutvalue is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to aSTOPPEDstate. When theECS_CONTAINER_START_TIMEOUTcontainer agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. For tasks using the EC2 launch type, your container instances require at least version1.26.0of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version1.26.0-1of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - stop_
timeout int - Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version
1.3.0or later. + Windows platform version1.0.0or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if thestopTimeoutparameter isn't specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUTis used. If neither thestopTimeoutparameter or theECS_CONTAINER_STOP_TIMEOUTagent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - system_
controls Sequence[SystemControl] - A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctlsin the Create a container section of the Docker Remote API and the--sysctloption to docker run. For example, you can configurenet.ipv4.tcp_keepalive_timesetting to maintain longer lived connections. - ulimits Sequence[Ulimit]
- A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'This parameter is not supported for Windows containers. - user str
- The user to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run. When running tasks using thehostnetwork mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify theuserusing the following formats. If specifying a UID or GID, you must specify it as a positive integer. +user+user:group+uid+uid:gid+user:gid+uid:groupThis parameter is not supported for Windows containers. - volumes_
from Sequence[VolumeFrom] - Data volumes to mount from another container. This parameter maps to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run. - working_
directory str - The working directory to run commands inside the container in. This parameter maps to
WorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.
- command List<String>
- The command that's passed to the container. This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array. - cpu Number
- The number of
cpuunits reserved for the container. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption to docker run. This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-levelcpuvalue. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as0, which Windows interprets as 1% of one CPU. - credential
Specs List<String> - A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of thedockerSecurityOptions. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replaceMyARNwith the ARN in SSM or Amazon S3. If you provide acredentialspecdomainless:MyARN, thecredspecmust provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers. - depends
On List<Property Map> - The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-initpackage. If your container instances are launched from version20190301or later, then 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. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. If the task definition is used in a blue/green deployment that uses AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration, thedependsOnparameter is not supported. For more information see Issue #680 on the on the GitHub website. - disable
Networking Boolean - When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API. This parameter is not supported for Windows containers. - dns
Search List<String>Domains - A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run. This parameter is not supported for Windows containers. - dns
Servers List<String> - A list of DNS servers that are presented to the container. This parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run. This parameter is not supported for Windows containers. - docker
Labels Any - A key/value map of labels to add to the container. This parameter maps to
Labelsin the Create a container section of the Docker Remote API and the--labeloption to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - docker
Security List<String>Options - A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide. This parameter maps to
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run. The Amazon ECS container agent running on a container instance must register with theECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. For more information about valid values, see Docker Run Security Configuration. Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath' - entry
Point List<String> - Early versions of the Amazon ECS container agent don't properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead. The entry point that's passed to the container. This parameter maps toEntrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint. - environment List<Property Map>
- The environment variables to pass to a container. This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption to docker run. We don't recommend that you use plaintext environment variables for sensitive information, such as credential data. - environment
Files List<Property Map> - A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-fileoption to docker run. You can specify up to ten environment files. The file must have a.envfile extension. Each line in an environment file contains an environment variable inVARIABLE=VALUEformat. Lines beginning with#are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file. If there are environment variables specified using theenvironmentparameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide. - essential Boolean
- If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide. - extra
Hosts List<Property Map> - A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run. This parameter isn't supported for Windows containers or tasks that use theawsvpcnetwork mode. - firelens
Configuration Property Map - The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
- health
Check Property Map - The container health check command and associated configuration parameters for the container. This parameter maps to
HealthCheckin the Create a container section of the Docker Remote API and theHEALTHCHECKparameter of docker run. TheHealthCheckproperty specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to theHEALTHCHECKparameter of docker run. The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent. + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see Platform Versions. + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer. - hostname String
- The hostname to use for your container. This parameter maps to
Hostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run. Thehostnameparameter is not supported if you're using theawsvpcnetwork mode. - image String
- The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tagorrepository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run. + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the fullregistry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. + Images in official repositories on Docker Hub use a single name (for example,ubuntuormongo). + Images in other repositories on Docker Hub are qualified with an organization name (for example,amazon/amazon-ecs-agent). + Images in other online repositories are qualified further by a domain name (for example,quay.io/assemblyline/ubuntu). - interactive Boolean
- When this parameter is
true, you can deploy containerized applications that requirestdinor attyto be allocated. This parameter maps toOpenStdinin the Create a container section of the Docker Remote API and the--interactiveoption to docker run. - links List<String>
- The
linksparameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition isbridge. Thename:internalNameconstruct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption to docker run. This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. - linux
Parameters Property Map - Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities. This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
- log
Configuration Property Map - The log configuration specification for the container. This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with theECS_AVAILABLE_LOGGING_DRIVERSenvironment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. TheLogConfigurationproperty specifies log configuration options to send to a custom log driver for the container. - memory Number
- The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memoryvalue, if one is specified. This parameter maps toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run. If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-levelmemoryandmemoryReservationvalue,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. - memory
Reservation Number - The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the
memoryparameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservationin the Create a container section of the Docker Remote API and the--memory-reservationoption to docker run. If a task-level memory value is not specified, you must specify a non-zero integer for one or both ofmemoryormemoryReservationin a container definition. If you specify both,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set amemoryReservationof 128 MiB, and amemoryhard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers. - mount
Points List<Property Map> - The mount points for data volumes in your container. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. - name String
- The name of a container. If you're linking multiple containers together in a task definition, the
nameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run. - port
Mappings List<Property Map> - The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the
awsvpcnetwork mode, you should only specify thecontainerPort. ThehostPortcan be left blank or it must be the same value as thecontainerPort. Port mappings on Windows use theNetNATgateway address rather thanlocalhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps toPortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run. If the network mode of a task definition is set tonone, then you can't specify port mappings. If the network mode of a task definition is set tohost, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches theRUNNINGstatus, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in thenetworkBindingssection DescribeTasks responses. - privileged Boolean
- When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run. This parameter is not supported for Windows containers or tasks run on FARGATElong. - pseudo
Terminal Boolean - When this parameter is
true, a TTY is allocated. This parameter maps toTtyin the Create a container section of the Docker Remote API and the--ttyoption to docker run. - readonly
Root BooleanFilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption to docker run. This parameter is not supported for Windows containers. - repository
Credentials Property Map - The private repository authentication credentials to use. The repository credentials for private registry authentication.
- resource
Requirements List<Property Map> - The type and amount of a resource to assign to a container. The only supported resource is a GPU.
- secrets List<Property Map>
- The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
- start
Timeout Number - Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE,SUCCESS, orHEALTHYstatus. If astartTimeoutvalue is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to aSTOPPEDstate. When theECS_CONTAINER_START_TIMEOUTcontainer agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. For tasks using the EC2 launch type, your container instances require at least version1.26.0of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version1.26.0-1of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - stop
Timeout Number - Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version
1.3.0or later. + Windows platform version1.0.0or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if thestopTimeoutparameter isn't specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUTis used. If neither thestopTimeoutparameter or theECS_CONTAINER_STOP_TIMEOUTagent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - system
Controls List<Property Map> - A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctlsin the Create a container section of the Docker Remote API and the--sysctloption to docker run. For example, you can configurenet.ipv4.tcp_keepalive_timesetting to maintain longer lived connections. - ulimits List<Property Map>
- A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'This parameter is not supported for Windows containers. - user String
- The user to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run. When running tasks using thehostnetwork mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify theuserusing the following formats. If specifying a UID or GID, you must specify it as a positive integer. +user+user:group+uid+uid:gid+user:gid+uid:groupThis parameter is not supported for Windows containers. - volumes
From List<Property Map> - Data volumes to mount from another container. This parameter maps to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run. - working
Directory String - The working directory to run commands inside the container in. This parameter maps to
WorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.
ContainerDefinitionResponse, ContainerDefinitionResponseArgs
, ContainerDefinitionResponseArgs
- Command List<string>
- The command that's passed to the container. This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array. - Cpu int
- The number of
cpuunits reserved for the container. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption to docker run. This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-levelcpuvalue. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as0, which Windows interprets as 1% of one CPU. - Credential
Specs List<string> - A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of thedockerSecurityOptions. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replaceMyARNwith the ARN in SSM or Amazon S3. If you provide acredentialspecdomainless:MyARN, thecredspecmust provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers. - Depends
On List<Pulumi.Azure Native. Aws Connector. Inputs. Container Dependency Response> - The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-initpackage. If your container instances are launched from version20190301or later, then 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. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. If the task definition is used in a blue/green deployment that uses AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration, thedependsOnparameter is not supported. For more information see Issue #680 on the on the GitHub website. - Disable
Networking bool - When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API. This parameter is not supported for Windows containers. - Dns
Search List<string>Domains - A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run. This parameter is not supported for Windows containers. - Dns
Servers List<string> - A list of DNS servers that are presented to the container. This parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run. This parameter is not supported for Windows containers. - Docker
Labels object - A key/value map of labels to add to the container. This parameter maps to
Labelsin the Create a container section of the Docker Remote API and the--labeloption to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - Docker
Security List<string>Options - A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide. This parameter maps to
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run. The Amazon ECS container agent running on a container instance must register with theECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. For more information about valid values, see Docker Run Security Configuration. Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath' - Entry
Point List<string> - Early versions of the Amazon ECS container agent don't properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead. The entry point that's passed to the container. This parameter maps toEntrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint. - Environment
List<Pulumi.
Azure Native. Aws Connector. Inputs. Key Value Pair Response> - The environment variables to pass to a container. This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption to docker run. We don't recommend that you use plaintext environment variables for sensitive information, such as credential data. - Environment
Files List<Pulumi.Azure Native. Aws Connector. Inputs. Environment File Response> - A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-fileoption to docker run. You can specify up to ten environment files. The file must have a.envfile extension. Each line in an environment file contains an environment variable inVARIABLE=VALUEformat. Lines beginning with#are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file. If there are environment variables specified using theenvironmentparameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide. - Essential bool
- If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide. - Extra
Hosts List<Pulumi.Azure Native. Aws Connector. Inputs. Host Entry Response> - A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run. This parameter isn't supported for Windows containers or tasks that use theawsvpcnetwork mode. - Firelens
Configuration Pulumi.Azure Native. Aws Connector. Inputs. Firelens Configuration Response - The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
- Health
Check Pulumi.Azure Native. Aws Connector. Inputs. Health Check Response - The container health check command and associated configuration parameters for the container. This parameter maps to
HealthCheckin the Create a container section of the Docker Remote API and theHEALTHCHECKparameter of docker run. TheHealthCheckproperty specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to theHEALTHCHECKparameter of docker run. The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent. + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see Platform Versions. + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer. - Hostname string
- The hostname to use for your container. This parameter maps to
Hostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run. Thehostnameparameter is not supported if you're using theawsvpcnetwork mode. - Image string
- The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tagorrepository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run. + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the fullregistry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. + Images in official repositories on Docker Hub use a single name (for example,ubuntuormongo). + Images in other repositories on Docker Hub are qualified with an organization name (for example,amazon/amazon-ecs-agent). + Images in other online repositories are qualified further by a domain name (for example,quay.io/assemblyline/ubuntu). - Interactive bool
- When this parameter is
true, you can deploy containerized applications that requirestdinor attyto be allocated. This parameter maps toOpenStdinin the Create a container section of the Docker Remote API and the--interactiveoption to docker run. - Links List<string>
- The
linksparameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition isbridge. Thename:internalNameconstruct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption to docker run. This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. - Linux
Parameters Pulumi.Azure Native. Aws Connector. Inputs. Linux Parameters Response - Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities. This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
- Log
Configuration Pulumi.Azure Native. Aws Connector. Inputs. Log Configuration Response - The log configuration specification for the container. This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with theECS_AVAILABLE_LOGGING_DRIVERSenvironment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. TheLogConfigurationproperty specifies log configuration options to send to a custom log driver for the container. - Memory int
- The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memoryvalue, if one is specified. This parameter maps toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run. If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-levelmemoryandmemoryReservationvalue,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. - Memory
Reservation int - The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the
memoryparameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservationin the Create a container section of the Docker Remote API and the--memory-reservationoption to docker run. If a task-level memory value is not specified, you must specify a non-zero integer for one or both ofmemoryormemoryReservationin a container definition. If you specify both,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set amemoryReservationof 128 MiB, and amemoryhard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers. - Mount
Points List<Pulumi.Azure Native. Aws Connector. Inputs. Mount Point Response> - The mount points for data volumes in your container. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. - Name string
- The name of a container. If you're linking multiple containers together in a task definition, the
nameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run. - Port
Mappings List<Pulumi.Azure Native. Aws Connector. Inputs. Port Mapping Response> - The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the
awsvpcnetwork mode, you should only specify thecontainerPort. ThehostPortcan be left blank or it must be the same value as thecontainerPort. Port mappings on Windows use theNetNATgateway address rather thanlocalhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps toPortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run. If the network mode of a task definition is set tonone, then you can't specify port mappings. If the network mode of a task definition is set tohost, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches theRUNNINGstatus, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in thenetworkBindingssection DescribeTasks responses. - Privileged bool
- When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run. This parameter is not supported for Windows containers or tasks run on FARGATElong. - Pseudo
Terminal bool - When this parameter is
true, a TTY is allocated. This parameter maps toTtyin the Create a container section of the Docker Remote API and the--ttyoption to docker run. - Readonly
Root boolFilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption to docker run. This parameter is not supported for Windows containers. - Repository
Credentials Pulumi.Azure Native. Aws Connector. Inputs. Repository Credentials Response - The private repository authentication credentials to use. The repository credentials for private registry authentication.
- Resource
Requirements List<Pulumi.Azure Native. Aws Connector. Inputs. Resource Requirement Response> - The type and amount of a resource to assign to a container. The only supported resource is a GPU.
- Secrets
List<Pulumi.
Azure Native. Aws Connector. Inputs. Secret Response> - The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
- Start
Timeout int - Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE,SUCCESS, orHEALTHYstatus. If astartTimeoutvalue is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to aSTOPPEDstate. When theECS_CONTAINER_START_TIMEOUTcontainer agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. For tasks using the EC2 launch type, your container instances require at least version1.26.0of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version1.26.0-1of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - Stop
Timeout int - Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version
1.3.0or later. + Windows platform version1.0.0or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if thestopTimeoutparameter isn't specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUTis used. If neither thestopTimeoutparameter or theECS_CONTAINER_STOP_TIMEOUTagent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - System
Controls List<Pulumi.Azure Native. Aws Connector. Inputs. System Control Response> - A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctlsin the Create a container section of the Docker Remote API and the--sysctloption to docker run. For example, you can configurenet.ipv4.tcp_keepalive_timesetting to maintain longer lived connections. - Ulimits
List<Pulumi.
Azure Native. Aws Connector. Inputs. Ulimit Response> - A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'This parameter is not supported for Windows containers. - User string
- The user to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run. When running tasks using thehostnetwork mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify theuserusing the following formats. If specifying a UID or GID, you must specify it as a positive integer. +user+user:group+uid+uid:gid+user:gid+uid:groupThis parameter is not supported for Windows containers. - Volumes
From List<Pulumi.Azure Native. Aws Connector. Inputs. Volume From Response> - Data volumes to mount from another container. This parameter maps to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run. - Working
Directory string - The working directory to run commands inside the container in. This parameter maps to
WorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.
- Command []string
- The command that's passed to the container. This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array. - Cpu int
- The number of
cpuunits reserved for the container. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption to docker run. This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-levelcpuvalue. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as0, which Windows interprets as 1% of one CPU. - Credential
Specs []string - A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of thedockerSecurityOptions. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replaceMyARNwith the ARN in SSM or Amazon S3. If you provide acredentialspecdomainless:MyARN, thecredspecmust provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers. - Depends
On []ContainerDependency Response - The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-initpackage. If your container instances are launched from version20190301or later, then 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. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. If the task definition is used in a blue/green deployment that uses AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration, thedependsOnparameter is not supported. For more information see Issue #680 on the on the GitHub website. - Disable
Networking bool - When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API. This parameter is not supported for Windows containers. - Dns
Search []stringDomains - A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run. This parameter is not supported for Windows containers. - Dns
Servers []string - A list of DNS servers that are presented to the container. This parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run. This parameter is not supported for Windows containers. - Docker
Labels interface{} - A key/value map of labels to add to the container. This parameter maps to
Labelsin the Create a container section of the Docker Remote API and the--labeloption to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - Docker
Security []stringOptions - A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide. This parameter maps to
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run. The Amazon ECS container agent running on a container instance must register with theECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. For more information about valid values, see Docker Run Security Configuration. Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath' - Entry
Point []string - Early versions of the Amazon ECS container agent don't properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead. The entry point that's passed to the container. This parameter maps toEntrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint. - Environment
[]Key
Value Pair Response - The environment variables to pass to a container. This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption to docker run. We don't recommend that you use plaintext environment variables for sensitive information, such as credential data. - Environment
Files []EnvironmentFile Response - A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-fileoption to docker run. You can specify up to ten environment files. The file must have a.envfile extension. Each line in an environment file contains an environment variable inVARIABLE=VALUEformat. Lines beginning with#are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file. If there are environment variables specified using theenvironmentparameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide. - Essential bool
- If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide. - Extra
Hosts []HostEntry Response - A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run. This parameter isn't supported for Windows containers or tasks that use theawsvpcnetwork mode. - Firelens
Configuration FirelensConfiguration Response - The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
- Health
Check HealthCheck Response - The container health check command and associated configuration parameters for the container. This parameter maps to
HealthCheckin the Create a container section of the Docker Remote API and theHEALTHCHECKparameter of docker run. TheHealthCheckproperty specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to theHEALTHCHECKparameter of docker run. The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent. + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see Platform Versions. + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer. - Hostname string
- The hostname to use for your container. This parameter maps to
Hostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run. Thehostnameparameter is not supported if you're using theawsvpcnetwork mode. - Image string
- The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tagorrepository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run. + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the fullregistry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. + Images in official repositories on Docker Hub use a single name (for example,ubuntuormongo). + Images in other repositories on Docker Hub are qualified with an organization name (for example,amazon/amazon-ecs-agent). + Images in other online repositories are qualified further by a domain name (for example,quay.io/assemblyline/ubuntu). - Interactive bool
- When this parameter is
true, you can deploy containerized applications that requirestdinor attyto be allocated. This parameter maps toOpenStdinin the Create a container section of the Docker Remote API and the--interactiveoption to docker run. - Links []string
- The
linksparameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition isbridge. Thename:internalNameconstruct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption to docker run. This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. - Linux
Parameters LinuxParameters Response - Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities. This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
- Log
Configuration LogConfiguration Response - The log configuration specification for the container. This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with theECS_AVAILABLE_LOGGING_DRIVERSenvironment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. TheLogConfigurationproperty specifies log configuration options to send to a custom log driver for the container. - Memory int
- The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memoryvalue, if one is specified. This parameter maps toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run. If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-levelmemoryandmemoryReservationvalue,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. - Memory
Reservation int - The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the
memoryparameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservationin the Create a container section of the Docker Remote API and the--memory-reservationoption to docker run. If a task-level memory value is not specified, you must specify a non-zero integer for one or both ofmemoryormemoryReservationin a container definition. If you specify both,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set amemoryReservationof 128 MiB, and amemoryhard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers. - Mount
Points []MountPoint Response - The mount points for data volumes in your container. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. - Name string
- The name of a container. If you're linking multiple containers together in a task definition, the
nameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run. - Port
Mappings []PortMapping Response - The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the
awsvpcnetwork mode, you should only specify thecontainerPort. ThehostPortcan be left blank or it must be the same value as thecontainerPort. Port mappings on Windows use theNetNATgateway address rather thanlocalhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps toPortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run. If the network mode of a task definition is set tonone, then you can't specify port mappings. If the network mode of a task definition is set tohost, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches theRUNNINGstatus, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in thenetworkBindingssection DescribeTasks responses. - Privileged bool
- When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run. This parameter is not supported for Windows containers or tasks run on FARGATElong. - Pseudo
Terminal bool - When this parameter is
true, a TTY is allocated. This parameter maps toTtyin the Create a container section of the Docker Remote API and the--ttyoption to docker run. - Readonly
Root boolFilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption to docker run. This parameter is not supported for Windows containers. - Repository
Credentials RepositoryCredentials Response - The private repository authentication credentials to use. The repository credentials for private registry authentication.
- Resource
Requirements []ResourceRequirement Response - The type and amount of a resource to assign to a container. The only supported resource is a GPU.
- Secrets
[]Secret
Response - The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
- Start
Timeout int - Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE,SUCCESS, orHEALTHYstatus. If astartTimeoutvalue is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to aSTOPPEDstate. When theECS_CONTAINER_START_TIMEOUTcontainer agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. For tasks using the EC2 launch type, your container instances require at least version1.26.0of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version1.26.0-1of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - Stop
Timeout int - Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version
1.3.0or later. + Windows platform version1.0.0or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if thestopTimeoutparameter isn't specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUTis used. If neither thestopTimeoutparameter or theECS_CONTAINER_STOP_TIMEOUTagent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - System
Controls []SystemControl Response - A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctlsin the Create a container section of the Docker Remote API and the--sysctloption to docker run. For example, you can configurenet.ipv4.tcp_keepalive_timesetting to maintain longer lived connections. - Ulimits
[]Ulimit
Response - A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'This parameter is not supported for Windows containers. - User string
- The user to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run. When running tasks using thehostnetwork mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify theuserusing the following formats. If specifying a UID or GID, you must specify it as a positive integer. +user+user:group+uid+uid:gid+user:gid+uid:groupThis parameter is not supported for Windows containers. - Volumes
From []VolumeFrom Response - Data volumes to mount from another container. This parameter maps to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run. - Working
Directory string - The working directory to run commands inside the container in. This parameter maps to
WorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.
- command List<String>
- The command that's passed to the container. This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array. - cpu Integer
- The number of
cpuunits reserved for the container. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption to docker run. This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-levelcpuvalue. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as0, which Windows interprets as 1% of one CPU. - credential
Specs List<String> - A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of thedockerSecurityOptions. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replaceMyARNwith the ARN in SSM or Amazon S3. If you provide acredentialspecdomainless:MyARN, thecredspecmust provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers. - depends
On List<ContainerDependency Response> - The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-initpackage. If your container instances are launched from version20190301or later, then 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. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. If the task definition is used in a blue/green deployment that uses AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration, thedependsOnparameter is not supported. For more information see Issue #680 on the on the GitHub website. - disable
Networking Boolean - When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API. This parameter is not supported for Windows containers. - dns
Search List<String>Domains - A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run. This parameter is not supported for Windows containers. - dns
Servers List<String> - A list of DNS servers that are presented to the container. This parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run. This parameter is not supported for Windows containers. - docker
Labels Object - A key/value map of labels to add to the container. This parameter maps to
Labelsin the Create a container section of the Docker Remote API and the--labeloption to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - docker
Security List<String>Options - A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide. This parameter maps to
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run. The Amazon ECS container agent running on a container instance must register with theECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. For more information about valid values, see Docker Run Security Configuration. Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath' - entry
Point List<String> - Early versions of the Amazon ECS container agent don't properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead. The entry point that's passed to the container. This parameter maps toEntrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint. - environment
List<Key
Value Pair Response> - The environment variables to pass to a container. This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption to docker run. We don't recommend that you use plaintext environment variables for sensitive information, such as credential data. - environment
Files List<EnvironmentFile Response> - A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-fileoption to docker run. You can specify up to ten environment files. The file must have a.envfile extension. Each line in an environment file contains an environment variable inVARIABLE=VALUEformat. Lines beginning with#are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file. If there are environment variables specified using theenvironmentparameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide. - essential Boolean
- If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide. - extra
Hosts List<HostEntry Response> - A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run. This parameter isn't supported for Windows containers or tasks that use theawsvpcnetwork mode. - firelens
Configuration FirelensConfiguration Response - The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
- health
Check HealthCheck Response - The container health check command and associated configuration parameters for the container. This parameter maps to
HealthCheckin the Create a container section of the Docker Remote API and theHEALTHCHECKparameter of docker run. TheHealthCheckproperty specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to theHEALTHCHECKparameter of docker run. The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent. + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see Platform Versions. + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer. - hostname String
- The hostname to use for your container. This parameter maps to
Hostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run. Thehostnameparameter is not supported if you're using theawsvpcnetwork mode. - image String
- The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tagorrepository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run. + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the fullregistry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. + Images in official repositories on Docker Hub use a single name (for example,ubuntuormongo). + Images in other repositories on Docker Hub are qualified with an organization name (for example,amazon/amazon-ecs-agent). + Images in other online repositories are qualified further by a domain name (for example,quay.io/assemblyline/ubuntu). - interactive Boolean
- When this parameter is
true, you can deploy containerized applications that requirestdinor attyto be allocated. This parameter maps toOpenStdinin the Create a container section of the Docker Remote API and the--interactiveoption to docker run. - links List<String>
- The
linksparameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition isbridge. Thename:internalNameconstruct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption to docker run. This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. - linux
Parameters LinuxParameters Response - Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities. This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
- log
Configuration LogConfiguration Response - The log configuration specification for the container. This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with theECS_AVAILABLE_LOGGING_DRIVERSenvironment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. TheLogConfigurationproperty specifies log configuration options to send to a custom log driver for the container. - memory Integer
- The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memoryvalue, if one is specified. This parameter maps toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run. If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-levelmemoryandmemoryReservationvalue,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. - memory
Reservation Integer - The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the
memoryparameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservationin the Create a container section of the Docker Remote API and the--memory-reservationoption to docker run. If a task-level memory value is not specified, you must specify a non-zero integer for one or both ofmemoryormemoryReservationin a container definition. If you specify both,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set amemoryReservationof 128 MiB, and amemoryhard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers. - mount
Points List<MountPoint Response> - The mount points for data volumes in your container. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. - name String
- The name of a container. If you're linking multiple containers together in a task definition, the
nameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run. - port
Mappings List<PortMapping Response> - The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the
awsvpcnetwork mode, you should only specify thecontainerPort. ThehostPortcan be left blank or it must be the same value as thecontainerPort. Port mappings on Windows use theNetNATgateway address rather thanlocalhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps toPortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run. If the network mode of a task definition is set tonone, then you can't specify port mappings. If the network mode of a task definition is set tohost, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches theRUNNINGstatus, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in thenetworkBindingssection DescribeTasks responses. - privileged Boolean
- When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run. This parameter is not supported for Windows containers or tasks run on FARGATElong. - pseudo
Terminal Boolean - When this parameter is
true, a TTY is allocated. This parameter maps toTtyin the Create a container section of the Docker Remote API and the--ttyoption to docker run. - readonly
Root BooleanFilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption to docker run. This parameter is not supported for Windows containers. - repository
Credentials RepositoryCredentials Response - The private repository authentication credentials to use. The repository credentials for private registry authentication.
- resource
Requirements List<ResourceRequirement Response> - The type and amount of a resource to assign to a container. The only supported resource is a GPU.
- secrets
List<Secret
Response> - The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
- start
Timeout Integer - Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE,SUCCESS, orHEALTHYstatus. If astartTimeoutvalue is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to aSTOPPEDstate. When theECS_CONTAINER_START_TIMEOUTcontainer agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. For tasks using the EC2 launch type, your container instances require at least version1.26.0of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version1.26.0-1of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - stop
Timeout Integer - Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version
1.3.0or later. + Windows platform version1.0.0or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if thestopTimeoutparameter isn't specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUTis used. If neither thestopTimeoutparameter or theECS_CONTAINER_STOP_TIMEOUTagent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - system
Controls List<SystemControl Response> - A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctlsin the Create a container section of the Docker Remote API and the--sysctloption to docker run. For example, you can configurenet.ipv4.tcp_keepalive_timesetting to maintain longer lived connections. - ulimits
List<Ulimit
Response> - A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'This parameter is not supported for Windows containers. - user String
- The user to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run. When running tasks using thehostnetwork mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify theuserusing the following formats. If specifying a UID or GID, you must specify it as a positive integer. +user+user:group+uid+uid:gid+user:gid+uid:groupThis parameter is not supported for Windows containers. - volumes
From List<VolumeFrom Response> - Data volumes to mount from another container. This parameter maps to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run. - working
Directory String - The working directory to run commands inside the container in. This parameter maps to
WorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.
- command string[]
- The command that's passed to the container. This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array. - cpu number
- The number of
cpuunits reserved for the container. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption to docker run. This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-levelcpuvalue. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as0, which Windows interprets as 1% of one CPU. - credential
Specs string[] - A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of thedockerSecurityOptions. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replaceMyARNwith the ARN in SSM or Amazon S3. If you provide acredentialspecdomainless:MyARN, thecredspecmust provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers. - depends
On ContainerDependency Response[] - The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-initpackage. If your container instances are launched from version20190301or later, then 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. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. If the task definition is used in a blue/green deployment that uses AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration, thedependsOnparameter is not supported. For more information see Issue #680 on the on the GitHub website. - disable
Networking boolean - When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API. This parameter is not supported for Windows containers. - dns
Search string[]Domains - A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run. This parameter is not supported for Windows containers. - dns
Servers string[] - A list of DNS servers that are presented to the container. This parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run. This parameter is not supported for Windows containers. - docker
Labels any - A key/value map of labels to add to the container. This parameter maps to
Labelsin the Create a container section of the Docker Remote API and the--labeloption to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - docker
Security string[]Options - A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide. This parameter maps to
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run. The Amazon ECS container agent running on a container instance must register with theECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. For more information about valid values, see Docker Run Security Configuration. Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath' - entry
Point string[] - Early versions of the Amazon ECS container agent don't properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead. The entry point that's passed to the container. This parameter maps toEntrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint. - environment
Key
Value Pair Response[] - The environment variables to pass to a container. This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption to docker run. We don't recommend that you use plaintext environment variables for sensitive information, such as credential data. - environment
Files EnvironmentFile Response[] - A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-fileoption to docker run. You can specify up to ten environment files. The file must have a.envfile extension. Each line in an environment file contains an environment variable inVARIABLE=VALUEformat. Lines beginning with#are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file. If there are environment variables specified using theenvironmentparameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide. - essential boolean
- If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide. - extra
Hosts HostEntry Response[] - A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run. This parameter isn't supported for Windows containers or tasks that use theawsvpcnetwork mode. - firelens
Configuration FirelensConfiguration Response - The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
- health
Check HealthCheck Response - The container health check command and associated configuration parameters for the container. This parameter maps to
HealthCheckin the Create a container section of the Docker Remote API and theHEALTHCHECKparameter of docker run. TheHealthCheckproperty specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to theHEALTHCHECKparameter of docker run. The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent. + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see Platform Versions. + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer. - hostname string
- The hostname to use for your container. This parameter maps to
Hostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run. Thehostnameparameter is not supported if you're using theawsvpcnetwork mode. - image string
- The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tagorrepository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run. + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the fullregistry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. + Images in official repositories on Docker Hub use a single name (for example,ubuntuormongo). + Images in other repositories on Docker Hub are qualified with an organization name (for example,amazon/amazon-ecs-agent). + Images in other online repositories are qualified further by a domain name (for example,quay.io/assemblyline/ubuntu). - interactive boolean
- When this parameter is
true, you can deploy containerized applications that requirestdinor attyto be allocated. This parameter maps toOpenStdinin the Create a container section of the Docker Remote API and the--interactiveoption to docker run. - links string[]
- The
linksparameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition isbridge. Thename:internalNameconstruct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption to docker run. This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. - linux
Parameters LinuxParameters Response - Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities. This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
- log
Configuration LogConfiguration Response - The log configuration specification for the container. This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with theECS_AVAILABLE_LOGGING_DRIVERSenvironment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. TheLogConfigurationproperty specifies log configuration options to send to a custom log driver for the container. - memory number
- The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memoryvalue, if one is specified. This parameter maps toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run. If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-levelmemoryandmemoryReservationvalue,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. - memory
Reservation number - The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the
memoryparameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservationin the Create a container section of the Docker Remote API and the--memory-reservationoption to docker run. If a task-level memory value is not specified, you must specify a non-zero integer for one or both ofmemoryormemoryReservationin a container definition. If you specify both,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set amemoryReservationof 128 MiB, and amemoryhard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers. - mount
Points MountPoint Response[] - The mount points for data volumes in your container. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. - name string
- The name of a container. If you're linking multiple containers together in a task definition, the
nameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run. - port
Mappings PortMapping Response[] - The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the
awsvpcnetwork mode, you should only specify thecontainerPort. ThehostPortcan be left blank or it must be the same value as thecontainerPort. Port mappings on Windows use theNetNATgateway address rather thanlocalhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps toPortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run. If the network mode of a task definition is set tonone, then you can't specify port mappings. If the network mode of a task definition is set tohost, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches theRUNNINGstatus, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in thenetworkBindingssection DescribeTasks responses. - privileged boolean
- When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run. This parameter is not supported for Windows containers or tasks run on FARGATElong. - pseudo
Terminal boolean - When this parameter is
true, a TTY is allocated. This parameter maps toTtyin the Create a container section of the Docker Remote API and the--ttyoption to docker run. - readonly
Root booleanFilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption to docker run. This parameter is not supported for Windows containers. - repository
Credentials RepositoryCredentials Response - The private repository authentication credentials to use. The repository credentials for private registry authentication.
- resource
Requirements ResourceRequirement Response[] - The type and amount of a resource to assign to a container. The only supported resource is a GPU.
- secrets
Secret
Response[] - The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
- start
Timeout number - Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE,SUCCESS, orHEALTHYstatus. If astartTimeoutvalue is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to aSTOPPEDstate. When theECS_CONTAINER_START_TIMEOUTcontainer agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. For tasks using the EC2 launch type, your container instances require at least version1.26.0of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version1.26.0-1of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - stop
Timeout number - Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version
1.3.0or later. + Windows platform version1.0.0or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if thestopTimeoutparameter isn't specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUTis used. If neither thestopTimeoutparameter or theECS_CONTAINER_STOP_TIMEOUTagent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - system
Controls SystemControl Response[] - A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctlsin the Create a container section of the Docker Remote API and the--sysctloption to docker run. For example, you can configurenet.ipv4.tcp_keepalive_timesetting to maintain longer lived connections. - ulimits
Ulimit
Response[] - A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'This parameter is not supported for Windows containers. - user string
- The user to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run. When running tasks using thehostnetwork mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify theuserusing the following formats. If specifying a UID or GID, you must specify it as a positive integer. +user+user:group+uid+uid:gid+user:gid+uid:groupThis parameter is not supported for Windows containers. - volumes
From VolumeFrom Response[] - Data volumes to mount from another container. This parameter maps to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run. - working
Directory string - The working directory to run commands inside the container in. This parameter maps to
WorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.
- command Sequence[str]
- The command that's passed to the container. This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array. - cpu int
- The number of
cpuunits reserved for the container. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption to docker run. This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-levelcpuvalue. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as0, which Windows interprets as 1% of one CPU. - credential_
specs Sequence[str] - A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of thedockerSecurityOptions. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replaceMyARNwith the ARN in SSM or Amazon S3. If you provide acredentialspecdomainless:MyARN, thecredspecmust provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers. - depends_
on Sequence[ContainerDependency Response] - The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-initpackage. If your container instances are launched from version20190301or later, then 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. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. If the task definition is used in a blue/green deployment that uses AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration, thedependsOnparameter is not supported. For more information see Issue #680 on the on the GitHub website. - disable_
networking bool - When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API. This parameter is not supported for Windows containers. - dns_
search_ Sequence[str]domains - A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run. This parameter is not supported for Windows containers. - dns_
servers Sequence[str] - A list of DNS servers that are presented to the container. This parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run. This parameter is not supported for Windows containers. - docker_
labels Any - A key/value map of labels to add to the container. This parameter maps to
Labelsin the Create a container section of the Docker Remote API and the--labeloption to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - docker_
security_ Sequence[str]options - A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide. This parameter maps to
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run. The Amazon ECS container agent running on a container instance must register with theECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. For more information about valid values, see Docker Run Security Configuration. Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath' - entry_
point Sequence[str] - Early versions of the Amazon ECS container agent don't properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead. The entry point that's passed to the container. This parameter maps toEntrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint. - environment
Sequence[Key
Value Pair Response] - The environment variables to pass to a container. This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption to docker run. We don't recommend that you use plaintext environment variables for sensitive information, such as credential data. - environment_
files Sequence[EnvironmentFile Response] - A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-fileoption to docker run. You can specify up to ten environment files. The file must have a.envfile extension. Each line in an environment file contains an environment variable inVARIABLE=VALUEformat. Lines beginning with#are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file. If there are environment variables specified using theenvironmentparameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide. - essential bool
- If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide. - extra_
hosts Sequence[HostEntry Response] - A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run. This parameter isn't supported for Windows containers or tasks that use theawsvpcnetwork mode. - firelens_
configuration FirelensConfiguration Response - The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
- health_
check HealthCheck Response - The container health check command and associated configuration parameters for the container. This parameter maps to
HealthCheckin the Create a container section of the Docker Remote API and theHEALTHCHECKparameter of docker run. TheHealthCheckproperty specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to theHEALTHCHECKparameter of docker run. The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent. + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see Platform Versions. + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer. - hostname str
- The hostname to use for your container. This parameter maps to
Hostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run. Thehostnameparameter is not supported if you're using theawsvpcnetwork mode. - image str
- The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tagorrepository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run. + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the fullregistry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. + Images in official repositories on Docker Hub use a single name (for example,ubuntuormongo). + Images in other repositories on Docker Hub are qualified with an organization name (for example,amazon/amazon-ecs-agent). + Images in other online repositories are qualified further by a domain name (for example,quay.io/assemblyline/ubuntu). - interactive bool
- When this parameter is
true, you can deploy containerized applications that requirestdinor attyto be allocated. This parameter maps toOpenStdinin the Create a container section of the Docker Remote API and the--interactiveoption to docker run. - links Sequence[str]
- The
linksparameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition isbridge. Thename:internalNameconstruct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption to docker run. This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. - linux_
parameters LinuxParameters Response - Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities. This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
- log_
configuration LogConfiguration Response - The log configuration specification for the container. This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with theECS_AVAILABLE_LOGGING_DRIVERSenvironment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. TheLogConfigurationproperty specifies log configuration options to send to a custom log driver for the container. - memory int
- The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memoryvalue, if one is specified. This parameter maps toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run. If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-levelmemoryandmemoryReservationvalue,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. - memory_
reservation int - The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the
memoryparameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservationin the Create a container section of the Docker Remote API and the--memory-reservationoption to docker run. If a task-level memory value is not specified, you must specify a non-zero integer for one or both ofmemoryormemoryReservationin a container definition. If you specify both,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set amemoryReservationof 128 MiB, and amemoryhard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers. - mount_
points Sequence[MountPoint Response] - The mount points for data volumes in your container. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. - name str
- The name of a container. If you're linking multiple containers together in a task definition, the
nameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run. - port_
mappings Sequence[PortMapping Response] - The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the
awsvpcnetwork mode, you should only specify thecontainerPort. ThehostPortcan be left blank or it must be the same value as thecontainerPort. Port mappings on Windows use theNetNATgateway address rather thanlocalhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps toPortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run. If the network mode of a task definition is set tonone, then you can't specify port mappings. If the network mode of a task definition is set tohost, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches theRUNNINGstatus, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in thenetworkBindingssection DescribeTasks responses. - privileged bool
- When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run. This parameter is not supported for Windows containers or tasks run on FARGATElong. - pseudo_
terminal bool - When this parameter is
true, a TTY is allocated. This parameter maps toTtyin the Create a container section of the Docker Remote API and the--ttyoption to docker run. - readonly_
root_ boolfilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption to docker run. This parameter is not supported for Windows containers. - repository_
credentials RepositoryCredentials Response - The private repository authentication credentials to use. The repository credentials for private registry authentication.
- resource_
requirements Sequence[ResourceRequirement Response] - The type and amount of a resource to assign to a container. The only supported resource is a GPU.
- secrets
Sequence[Secret
Response] - The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
- start_
timeout int - Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE,SUCCESS, orHEALTHYstatus. If astartTimeoutvalue is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to aSTOPPEDstate. When theECS_CONTAINER_START_TIMEOUTcontainer agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. For tasks using the EC2 launch type, your container instances require at least version1.26.0of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version1.26.0-1of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - stop_
timeout int - Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version
1.3.0or later. + Windows platform version1.0.0or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if thestopTimeoutparameter isn't specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUTis used. If neither thestopTimeoutparameter or theECS_CONTAINER_STOP_TIMEOUTagent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - system_
controls Sequence[SystemControl Response] - A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctlsin the Create a container section of the Docker Remote API and the--sysctloption to docker run. For example, you can configurenet.ipv4.tcp_keepalive_timesetting to maintain longer lived connections. - ulimits
Sequence[Ulimit
Response] - A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'This parameter is not supported for Windows containers. - user str
- The user to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run. When running tasks using thehostnetwork mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify theuserusing the following formats. If specifying a UID or GID, you must specify it as a positive integer. +user+user:group+uid+uid:gid+user:gid+uid:groupThis parameter is not supported for Windows containers. - volumes_
from Sequence[VolumeFrom Response] - Data volumes to mount from another container. This parameter maps to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run. - working_
directory str - The working directory to run commands inside the container in. This parameter maps to
WorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.
- command List<String>
- The command that's passed to the container. This parameter maps to
Cmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument is a separated string in the array. - cpu Number
- The number of
cpuunits reserved for the container. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption to docker run. This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-levelcpuvalue. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as0, which Windows interprets as 1% of one CPU. - credential
Specs List<String> - A list of ARNs in SSM or Amazon S3 to a credential spec (
CredSpec) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of thedockerSecurityOptions. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replaceMyARNwith the ARN in SSM or Amazon S3. If you provide acredentialspecdomainless:MyARN, thecredspecmust provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers. - depends
On List<Property Map> - The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-initpackage. If your container instances are launched from version20190301or later, then 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. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. If the task definition is used in a blue/green deployment that uses AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration, thedependsOnparameter is not supported. For more information see Issue #680 on the on the GitHub website. - disable
Networking Boolean - When this parameter is true, networking is off within the container. This parameter maps to
NetworkDisabledin the Create a container section of the Docker Remote API. This parameter is not supported for Windows containers. - dns
Search List<String>Domains - A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearchin the Create a container section of the Docker Remote API and the--dns-searchoption to docker run. This parameter is not supported for Windows containers. - dns
Servers List<String> - A list of DNS servers that are presented to the container. This parameter maps to
Dnsin the Create a container section of the Docker Remote API and the--dnsoption to docker run. This parameter is not supported for Windows containers. - docker
Labels Any - A key/value map of labels to add to the container. This parameter maps to
Labelsin the Create a container section of the Docker Remote API and the--labeloption to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - docker
Security List<String>Options - A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see Docker Run Security Configuration. This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers and Using gMSAs for Linux Containers in the Amazon Elastic Container Service Developer Guide. This parameter maps to
SecurityOptin the Create a container section of the Docker Remote API and the--security-optoption to docker run. The Amazon ECS container agent running on a container instance must register with theECS_SELINUX_CAPABLE=trueorECS_APPARMOR_CAPABLE=trueenvironment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. For more information about valid values, see Docker Run Security Configuration. Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath' - entry
Point List<String> - Early versions of the Amazon ECS container agent don't properly handle
entryPointparameters. If you have problems usingentryPoint, update your container agent or enter your commands and arguments ascommandarray items instead. The entry point that's passed to the container. This parameter maps toEntrypointin the Create a container section of the Docker Remote API and the--entrypointoption to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint. - environment List<Property Map>
- The environment variables to pass to a container. This parameter maps to
Envin the Create a container section of the Docker Remote API and the--envoption to docker run. We don't recommend that you use plaintext environment variables for sensitive information, such as credential data. - environment
Files List<Property Map> - A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-fileoption to docker run. You can specify up to ten environment files. The file must have a.envfile extension. Each line in an environment file contains an environment variable inVARIABLE=VALUEformat. Lines beginning with#are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file. If there are environment variables specified using theenvironmentparameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide. - essential Boolean
- If the
essentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessentialparameter of a container is marked asfalse, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide. - extra
Hosts List<Property Map> - A list of hostnames and IP address mappings to append to the
/etc/hostsfile on the container. This parameter maps toExtraHostsin the Create a container section of the Docker Remote API and the--add-hostoption to docker run. This parameter isn't supported for Windows containers or tasks that use theawsvpcnetwork mode. - firelens
Configuration Property Map - The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
- health
Check Property Map - The container health check command and associated configuration parameters for the container. This parameter maps to
HealthCheckin the Create a container section of the Docker Remote API and theHEALTHCHECKparameter of docker run. TheHealthCheckproperty specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to theHEALTHCHECKparameter of docker run. The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent. + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see Platform Versions. + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer. - hostname String
- The hostname to use for your container. This parameter maps to
Hostnamein the Create a container section of the Docker Remote API and the--hostnameoption to docker run. Thehostnameparameter is not supported if you're using theawsvpcnetwork mode. - image String
- The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either
repository-url/image:tagorrepository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run. + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the fullregistry/repository:tagorregistry/repository@digest. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latestor012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. + Images in official repositories on Docker Hub use a single name (for example,ubuntuormongo). + Images in other repositories on Docker Hub are qualified with an organization name (for example,amazon/amazon-ecs-agent). + Images in other online repositories are qualified further by a domain name (for example,quay.io/assemblyline/ubuntu). - interactive Boolean
- When this parameter is
true, you can deploy containerized applications that requirestdinor attyto be allocated. This parameter maps toOpenStdinin the Create a container section of the Docker Remote API and the--interactiveoption to docker run. - links List<String>
- The
linksparameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition isbridge. Thename:internalNameconstruct is analogous toname:aliasin Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps toLinksin the Create a container section of the Docker Remote API and the--linkoption to docker run. This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. - linux
Parameters Property Map - Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities. This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
- log
Configuration Property Map - The log configuration specification for the container. This parameter maps to
LogConfigin the Create a container section of the Docker Remote API and the--log-driveroption to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with theECS_AVAILABLE_LOGGING_DRIVERSenvironment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. TheLogConfigurationproperty specifies log configuration options to send to a custom log driver for the container. - memory Number
- The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memoryvalue, if one is specified. This parameter maps toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run. If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-levelmemoryandmemoryReservationvalue,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. - memory
Reservation Number - The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the
memoryparameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservationin the Create a container section of the Docker Remote API and the--memory-reservationoption to docker run. If a task-level memory value is not specified, you must specify a non-zero integer for one or both ofmemoryormemoryReservationin a container definition. If you specify both,memorymust be greater thanmemoryReservation. If you specifymemoryReservation, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value ofmemoryis used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set amemoryReservationof 128 MiB, and amemoryhard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers. - mount
Points List<Property Map> - The mount points for data volumes in your container. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. - name String
- The name of a container. If you're linking multiple containers together in a task definition, the
nameof one container can be entered in thelinksof another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps tonamein the Create a container section of the Docker Remote API and the--nameoption to docker run. - port
Mappings List<Property Map> - The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the
awsvpcnetwork mode, you should only specify thecontainerPort. ThehostPortcan be left blank or it must be the same value as thecontainerPort. Port mappings on Windows use theNetNATgateway address rather thanlocalhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps toPortBindingsin the Create a container section of the Docker Remote API and the--publishoption to docker run. If the network mode of a task definition is set tonone, then you can't specify port mappings. If the network mode of a task definition is set tohost, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches theRUNNINGstatus, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in thenetworkBindingssection DescribeTasks responses. - privileged Boolean
- When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
rootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run. This parameter is not supported for Windows containers or tasks run on FARGATElong. - pseudo
Terminal Boolean - When this parameter is
true, a TTY is allocated. This parameter maps toTtyin the Create a container section of the Docker Remote API and the--ttyoption to docker run. - readonly
Root BooleanFilesystem - When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption to docker run. This parameter is not supported for Windows containers. - repository
Credentials Property Map - The private repository authentication credentials to use. The repository credentials for private registry authentication.
- resource
Requirements List<Property Map> - The type and amount of a resource to assign to a container. The only supported resource is a GPU.
- secrets List<Property Map>
- The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
- start
Timeout Number - Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE,SUCCESS, orHEALTHYstatus. If astartTimeoutvalue is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to aSTOPPEDstate. When theECS_CONTAINER_START_TIMEOUTcontainer agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version1.3.0or later. + Windows platform version1.0.0or later. For tasks using the EC2 launch type, your container instances require at least version1.26.0of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version1.26.0-1of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - stop
Timeout Number - Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version
1.3.0or later. + Windows platform version1.0.0or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if thestopTimeoutparameter isn't specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUTis used. If neither thestopTimeoutparameter or theECS_CONTAINER_STOP_TIMEOUTagent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of theecs-initpackage. If your container instances are launched from version20190301or later, then 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. The valid values are 2-120 seconds. - system
Controls List<Property Map> - A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctlsin the Create a container section of the Docker Remote API and the--sysctloption to docker run. For example, you can configurenet.ipv4.tcp_keepalive_timesetting to maintain longer lived connections. - ulimits List<Property Map>
- A list of
ulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'This parameter is not supported for Windows containers. - user String
- The user to use inside the container. This parameter maps to
Userin the Create a container section of the Docker Remote API and the--useroption to docker run. When running tasks using thehostnetwork mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify theuserusing the following formats. If specifying a UID or GID, you must specify it as a positive integer. +user+user:group+uid+uid:gid+user:gid+uid:groupThis parameter is not supported for Windows containers. - volumes
From List<Property Map> - Data volumes to mount from another container. This parameter maps to
VolumesFromin the Create a container section of the Docker Remote API and the--volumes-fromoption to docker run. - working
Directory String - The working directory to run commands inside the container in. This parameter maps to
WorkingDirin the Create a container section of the Docker Remote API and the--workdiroption to docker run.
ContainerDependency, ContainerDependencyArgs
, ContainerDependencyArgs
- Condition string
- The dependency condition of the container. The following are the available conditions and their behavior: +
START- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. +COMPLETE- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. +SUCCESS- This condition is the same asCOMPLETE, but it also requires that the container exits with azerostatus. This condition can't be set on an essential container. +HEALTHY- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. - Container
Name string - The name of a container.
- Condition string
- The dependency condition of the container. The following are the available conditions and their behavior: +
START- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. +COMPLETE- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. +SUCCESS- This condition is the same asCOMPLETE, but it also requires that the container exits with azerostatus. This condition can't be set on an essential container. +HEALTHY- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. - Container
Name string - The name of a container.
- condition String
- The dependency condition of the container. The following are the available conditions and their behavior: +
START- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. +COMPLETE- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. +SUCCESS- This condition is the same asCOMPLETE, but it also requires that the container exits with azerostatus. This condition can't be set on an essential container. +HEALTHY- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. - container
Name String - The name of a container.
- condition string
- The dependency condition of the container. The following are the available conditions and their behavior: +
START- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. +COMPLETE- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. +SUCCESS- This condition is the same asCOMPLETE, but it also requires that the container exits with azerostatus. This condition can't be set on an essential container. +HEALTHY- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. - container
Name string - The name of a container.
- condition str
- The dependency condition of the container. The following are the available conditions and their behavior: +
START- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. +COMPLETE- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. +SUCCESS- This condition is the same asCOMPLETE, but it also requires that the container exits with azerostatus. This condition can't be set on an essential container. +HEALTHY- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. - container_
name str - The name of a container.
- condition String
- The dependency condition of the container. The following are the available conditions and their behavior: +
START- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. +COMPLETE- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. +SUCCESS- This condition is the same asCOMPLETE, but it also requires that the container exits with azerostatus. This condition can't be set on an essential container. +HEALTHY- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. - container
Name String - The name of a container.
ContainerDependencyResponse, ContainerDependencyResponseArgs
, ContainerDependencyResponseArgs
- Condition string
- The dependency condition of the container. The following are the available conditions and their behavior: +
START- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. +COMPLETE- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. +SUCCESS- This condition is the same asCOMPLETE, but it also requires that the container exits with azerostatus. This condition can't be set on an essential container. +HEALTHY- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. - Container
Name string - The name of a container.
- Condition string
- The dependency condition of the container. The following are the available conditions and their behavior: +
START- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. +COMPLETE- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. +SUCCESS- This condition is the same asCOMPLETE, but it also requires that the container exits with azerostatus. This condition can't be set on an essential container. +HEALTHY- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. - Container
Name string - The name of a container.
- condition String
- The dependency condition of the container. The following are the available conditions and their behavior: +
START- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. +COMPLETE- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. +SUCCESS- This condition is the same asCOMPLETE, but it also requires that the container exits with azerostatus. This condition can't be set on an essential container. +HEALTHY- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. - container
Name String - The name of a container.
- condition string
- The dependency condition of the container. The following are the available conditions and their behavior: +
START- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. +COMPLETE- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. +SUCCESS- This condition is the same asCOMPLETE, but it also requires that the container exits with azerostatus. This condition can't be set on an essential container. +HEALTHY- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. - container
Name string - The name of a container.
- condition str
- The dependency condition of the container. The following are the available conditions and their behavior: +
START- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. +COMPLETE- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. +SUCCESS- This condition is the same asCOMPLETE, but it also requires that the container exits with azerostatus. This condition can't be set on an essential container. +HEALTHY- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. - container_
name str - The name of a container.
- condition String
- The dependency condition of the container. The following are the available conditions and their behavior: +
START- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. +COMPLETE- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. +SUCCESS- This condition is the same asCOMPLETE, but it also requires that the container exits with azerostatus. This condition can't be set on an essential container. +HEALTHY- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. - container
Name String - The name of a container.
Device, DeviceArgs
, DeviceArgs
- Container
Path string - The path inside the container at which to expose the host device.
- Host
Path string - The path for the device on the host container instance.
- Permissions List<string>
- The explicit permissions to provide to the container for the device. By default, the container has permissions for
read,write, andmknodfor the device.
- Container
Path string - The path inside the container at which to expose the host device.
- Host
Path string - The path for the device on the host container instance.
- Permissions []string
- The explicit permissions to provide to the container for the device. By default, the container has permissions for
read,write, andmknodfor the device.
- container
Path String - The path inside the container at which to expose the host device.
- host
Path String - The path for the device on the host container instance.
- permissions List<String>
- The explicit permissions to provide to the container for the device. By default, the container has permissions for
read,write, andmknodfor the device.
- container
Path string - The path inside the container at which to expose the host device.
- host
Path string - The path for the device on the host container instance.
- permissions string[]
- The explicit permissions to provide to the container for the device. By default, the container has permissions for
read,write, andmknodfor the device.
- container_
path str - The path inside the container at which to expose the host device.
- host_
path str - The path for the device on the host container instance.
- permissions Sequence[str]
- The explicit permissions to provide to the container for the device. By default, the container has permissions for
read,write, andmknodfor the device.
- container
Path String - The path inside the container at which to expose the host device.
- host
Path String - The path for the device on the host container instance.
- permissions List<String>
- The explicit permissions to provide to the container for the device. By default, the container has permissions for
read,write, andmknodfor the device.
DeviceResponse, DeviceResponseArgs
, DeviceResponseArgs
- Container
Path string - The path inside the container at which to expose the host device.
- Host
Path string - The path for the device on the host container instance.
- Permissions List<string>
- The explicit permissions to provide to the container for the device. By default, the container has permissions for
read,write, andmknodfor the device.
- Container
Path string - The path inside the container at which to expose the host device.
- Host
Path string - The path for the device on the host container instance.
- Permissions []string
- The explicit permissions to provide to the container for the device. By default, the container has permissions for
read,write, andmknodfor the device.
- container
Path String - The path inside the container at which to expose the host device.
- host
Path String - The path for the device on the host container instance.
- permissions List<String>
- The explicit permissions to provide to the container for the device. By default, the container has permissions for
read,write, andmknodfor the device.
- container
Path string - The path inside the container at which to expose the host device.
- host
Path string - The path for the device on the host container instance.
- permissions string[]
- The explicit permissions to provide to the container for the device. By default, the container has permissions for
read,write, andmknodfor the device.
- container_
path str - The path inside the container at which to expose the host device.
- host_
path str - The path for the device on the host container instance.
- permissions Sequence[str]
- The explicit permissions to provide to the container for the device. By default, the container has permissions for
read,write, andmknodfor the device.
- container
Path String - The path inside the container at which to expose the host device.
- host
Path String - The path for the device on the host container instance.
- permissions List<String>
- The explicit permissions to provide to the container for the device. By default, the container has permissions for
read,write, andmknodfor the device.
DockerVolumeConfiguration, DockerVolumeConfigurationArgs
, DockerVolumeConfigurationArgs
- Autoprovision bool
- If this value is
true, the Docker volume is created if it doesn't already exist. This field is only used if thescopeisshared. - Driver string
- The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin lsto retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps toDriverin the Create a volume section of the Docker Remote API and thexxdriveroption to docker volume create. - Driver
Opts object - A map of Docker driver-specific options passed through. This parameter maps to
DriverOptsin the Create a volume section of the Docker Remote API and thexxoptoption to docker volume create. - Labels object
- Custom metadata to add to your Docker volume. This parameter maps to
Labelsin the Create a volume section of the Docker Remote API and thexxlabeloption to docker volume create. - Scope string
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
taskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
- Autoprovision bool
- If this value is
true, the Docker volume is created if it doesn't already exist. This field is only used if thescopeisshared. - Driver string
- The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin lsto retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps toDriverin the Create a volume section of the Docker Remote API and thexxdriveroption to docker volume create. - Driver
Opts interface{} - A map of Docker driver-specific options passed through. This parameter maps to
DriverOptsin the Create a volume section of the Docker Remote API and thexxoptoption to docker volume create. - Labels interface{}
- Custom metadata to add to your Docker volume. This parameter maps to
Labelsin the Create a volume section of the Docker Remote API and thexxlabeloption to docker volume create. - Scope string
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
taskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
- autoprovision Boolean
- If this value is
true, the Docker volume is created if it doesn't already exist. This field is only used if thescopeisshared. - driver String
- The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin lsto retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps toDriverin the Create a volume section of the Docker Remote API and thexxdriveroption to docker volume create. - driver
Opts Object - A map of Docker driver-specific options passed through. This parameter maps to
DriverOptsin the Create a volume section of the Docker Remote API and thexxoptoption to docker volume create. - labels Object
- Custom metadata to add to your Docker volume. This parameter maps to
Labelsin the Create a volume section of the Docker Remote API and thexxlabeloption to docker volume create. - scope String
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
taskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
- autoprovision boolean
- If this value is
true, the Docker volume is created if it doesn't already exist. This field is only used if thescopeisshared. - driver string
- The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin lsto retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps toDriverin the Create a volume section of the Docker Remote API and thexxdriveroption to docker volume create. - driver
Opts any - A map of Docker driver-specific options passed through. This parameter maps to
DriverOptsin the Create a volume section of the Docker Remote API and thexxoptoption to docker volume create. - labels any
- Custom metadata to add to your Docker volume. This parameter maps to
Labelsin the Create a volume section of the Docker Remote API and thexxlabeloption to docker volume create. - scope string
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
taskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
- autoprovision bool
- If this value is
true, the Docker volume is created if it doesn't already exist. This field is only used if thescopeisshared. - driver str
- The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin lsto retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps toDriverin the Create a volume section of the Docker Remote API and thexxdriveroption to docker volume create. - driver_
opts Any - A map of Docker driver-specific options passed through. This parameter maps to
DriverOptsin the Create a volume section of the Docker Remote API and thexxoptoption to docker volume create. - labels Any
- Custom metadata to add to your Docker volume. This parameter maps to
Labelsin the Create a volume section of the Docker Remote API and thexxlabeloption to docker volume create. - scope str
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
taskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
- autoprovision Boolean
- If this value is
true, the Docker volume is created if it doesn't already exist. This field is only used if thescopeisshared. - driver String
- The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin lsto retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps toDriverin the Create a volume section of the Docker Remote API and thexxdriveroption to docker volume create. - driver
Opts Any - A map of Docker driver-specific options passed through. This parameter maps to
DriverOptsin the Create a volume section of the Docker Remote API and thexxoptoption to docker volume create. - labels Any
- Custom metadata to add to your Docker volume. This parameter maps to
Labelsin the Create a volume section of the Docker Remote API and thexxlabeloption to docker volume create. - scope String
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
taskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
DockerVolumeConfigurationResponse, DockerVolumeConfigurationResponseArgs
, DockerVolumeConfigurationResponseArgs
- Autoprovision bool
- If this value is
true, the Docker volume is created if it doesn't already exist. This field is only used if thescopeisshared. - Driver string
- The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin lsto retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps toDriverin the Create a volume section of the Docker Remote API and thexxdriveroption to docker volume create. - Driver
Opts object - A map of Docker driver-specific options passed through. This parameter maps to
DriverOptsin the Create a volume section of the Docker Remote API and thexxoptoption to docker volume create. - Labels object
- Custom metadata to add to your Docker volume. This parameter maps to
Labelsin the Create a volume section of the Docker Remote API and thexxlabeloption to docker volume create. - Scope string
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
taskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
- Autoprovision bool
- If this value is
true, the Docker volume is created if it doesn't already exist. This field is only used if thescopeisshared. - Driver string
- The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin lsto retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps toDriverin the Create a volume section of the Docker Remote API and thexxdriveroption to docker volume create. - Driver
Opts interface{} - A map of Docker driver-specific options passed through. This parameter maps to
DriverOptsin the Create a volume section of the Docker Remote API and thexxoptoption to docker volume create. - Labels interface{}
- Custom metadata to add to your Docker volume. This parameter maps to
Labelsin the Create a volume section of the Docker Remote API and thexxlabeloption to docker volume create. - Scope string
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
taskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
- autoprovision Boolean
- If this value is
true, the Docker volume is created if it doesn't already exist. This field is only used if thescopeisshared. - driver String
- The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin lsto retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps toDriverin the Create a volume section of the Docker Remote API and thexxdriveroption to docker volume create. - driver
Opts Object - A map of Docker driver-specific options passed through. This parameter maps to
DriverOptsin the Create a volume section of the Docker Remote API and thexxoptoption to docker volume create. - labels Object
- Custom metadata to add to your Docker volume. This parameter maps to
Labelsin the Create a volume section of the Docker Remote API and thexxlabeloption to docker volume create. - scope String
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
taskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
- autoprovision boolean
- If this value is
true, the Docker volume is created if it doesn't already exist. This field is only used if thescopeisshared. - driver string
- The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin lsto retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps toDriverin the Create a volume section of the Docker Remote API and thexxdriveroption to docker volume create. - driver
Opts any - A map of Docker driver-specific options passed through. This parameter maps to
DriverOptsin the Create a volume section of the Docker Remote API and thexxoptoption to docker volume create. - labels any
- Custom metadata to add to your Docker volume. This parameter maps to
Labelsin the Create a volume section of the Docker Remote API and thexxlabeloption to docker volume create. - scope string
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
taskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
- autoprovision bool
- If this value is
true, the Docker volume is created if it doesn't already exist. This field is only used if thescopeisshared. - driver str
- The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin lsto retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps toDriverin the Create a volume section of the Docker Remote API and thexxdriveroption to docker volume create. - driver_
opts Any - A map of Docker driver-specific options passed through. This parameter maps to
DriverOptsin the Create a volume section of the Docker Remote API and thexxoptoption to docker volume create. - labels Any
- Custom metadata to add to your Docker volume. This parameter maps to
Labelsin the Create a volume section of the Docker Remote API and thexxlabeloption to docker volume create. - scope str
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
taskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
- autoprovision Boolean
- If this value is
true, the Docker volume is created if it doesn't already exist. This field is only used if thescopeisshared. - driver String
- The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin lsto retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps toDriverin the Create a volume section of the Docker Remote API and thexxdriveroption to docker volume create. - driver
Opts Any - A map of Docker driver-specific options passed through. This parameter maps to
DriverOptsin the Create a volume section of the Docker Remote API and thexxoptoption to docker volume create. - labels Any
- Custom metadata to add to your Docker volume. This parameter maps to
Labelsin the Create a volume section of the Docker Remote API and thexxlabeloption to docker volume create. - scope String
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
taskare automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped assharedpersist after the task stops.
EFSVolumeConfiguration, EFSVolumeConfigurationArgs
, EFSVolumeConfigurationArgs
-
Pulumi.
Azure Native. Aws Connector. Inputs. Authorization Config - The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system.
- Filesystem
Id string - The Amazon EFS file system ID to use.
- Root
Directory string - The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/will have the same effect as omitting this parameter. If an EFS access point is specified in theauthorizationConfig, the root directory parameter must either be omitted or set to/which will enforce the path set on the EFS access point. - Transit
Encryption string | Pulumi.Azure Native. Aws Connector. EFSVolume Configuration Transit Encryption - Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
DISABLEDis used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide. - Transit
Encryption intPort - The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
-
Authorization
Config - The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system.
- Filesystem
Id string - The Amazon EFS file system ID to use.
- Root
Directory string - The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/will have the same effect as omitting this parameter. If an EFS access point is specified in theauthorizationConfig, the root directory parameter must either be omitted or set to/which will enforce the path set on the EFS access point. - Transit
Encryption string | EFSVolumeConfiguration Transit Encryption - Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
DISABLEDis used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide. - Transit
Encryption intPort - The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
-
Authorization
Config - The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system.
- filesystem
Id String - The Amazon EFS file system ID to use.
- root
Directory String - The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/will have the same effect as omitting this parameter. If an EFS access point is specified in theauthorizationConfig, the root directory parameter must either be omitted or set to/which will enforce the path set on the EFS access point. - transit
Encryption String | EFSVolumeConfiguration Transit Encryption - Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
DISABLEDis used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide. - transit
Encryption IntegerPort - The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
-
Authorization
Config - The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system.
- filesystem
Id string - The Amazon EFS file system ID to use.
- root
Directory string - The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/will have the same effect as omitting this parameter. If an EFS access point is specified in theauthorizationConfig, the root directory parameter must either be omitted or set to/which will enforce the path set on the EFS access point. - transit
Encryption string | EFSVolumeConfiguration Transit Encryption - Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
DISABLEDis used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide. - transit
Encryption numberPort - The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
-
Authorization
Config - The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system.
- filesystem_
id str - The Amazon EFS file system ID to use.
- root_
directory str - The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/will have the same effect as omitting this parameter. If an EFS access point is specified in theauthorizationConfig, the root directory parameter must either be omitted or set to/which will enforce the path set on the EFS access point. - transit_
encryption str | EFSVolumeConfiguration Transit Encryption - Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
DISABLEDis used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide. - transit_
encryption_ intport - The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
- Property Map
- The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system.
- filesystem
Id String - The Amazon EFS file system ID to use.
- root
Directory String - The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/will have the same effect as omitting this parameter. If an EFS access point is specified in theauthorizationConfig, the root directory parameter must either be omitted or set to/which will enforce the path set on the EFS access point. - transit
Encryption String | "DISABLED" | "ENABLED" - Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
DISABLEDis used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide. - transit
Encryption NumberPort - The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
EFSVolumeConfigurationResponse, EFSVolumeConfigurationResponseArgs
, EFSVolumeConfigurationResponseArgs
-
Pulumi.
Azure Native. Aws Connector. Inputs. Authorization Config Response - The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system.
- Filesystem
Id string - The Amazon EFS file system ID to use.
- Root
Directory string - The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/will have the same effect as omitting this parameter. If an EFS access point is specified in theauthorizationConfig, the root directory parameter must either be omitted or set to/which will enforce the path set on the EFS access point. - Transit
Encryption string - Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
DISABLEDis used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide. - Transit
Encryption intPort - The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
-
Authorization
Config Response - The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system.
- Filesystem
Id string - The Amazon EFS file system ID to use.
- Root
Directory string - The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/will have the same effect as omitting this parameter. If an EFS access point is specified in theauthorizationConfig, the root directory parameter must either be omitted or set to/which will enforce the path set on the EFS access point. - Transit
Encryption string - Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
DISABLEDis used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide. - Transit
Encryption intPort - The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
-
Authorization
Config Response - The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system.
- filesystem
Id String - The Amazon EFS file system ID to use.
- root
Directory String - The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/will have the same effect as omitting this parameter. If an EFS access point is specified in theauthorizationConfig, the root directory parameter must either be omitted or set to/which will enforce the path set on the EFS access point. - transit
Encryption String - Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
DISABLEDis used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide. - transit
Encryption IntegerPort - The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
-
Authorization
Config Response - The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system.
- filesystem
Id string - The Amazon EFS file system ID to use.
- root
Directory string - The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/will have the same effect as omitting this parameter. If an EFS access point is specified in theauthorizationConfig, the root directory parameter must either be omitted or set to/which will enforce the path set on the EFS access point. - transit
Encryption string - Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
DISABLEDis used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide. - transit
Encryption numberPort - The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
-
Authorization
Config Response - The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system.
- filesystem_
id str - The Amazon EFS file system ID to use.
- root_
directory str - The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/will have the same effect as omitting this parameter. If an EFS access point is specified in theauthorizationConfig, the root directory parameter must either be omitted or set to/which will enforce the path set on the EFS access point. - transit_
encryption str - Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
DISABLEDis used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide. - transit_
encryption_ intport - The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
- Property Map
- The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system.
- filesystem
Id String - The Amazon EFS file system ID to use.
- root
Directory String - The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/will have the same effect as omitting this parameter. If an EFS access point is specified in theauthorizationConfig, the root directory parameter must either be omitted or set to/which will enforce the path set on the EFS access point. - transit
Encryption String - Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
DISABLEDis used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide. - transit
Encryption NumberPort - The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
EFSVolumeConfigurationTransitEncryption, EFSVolumeConfigurationTransitEncryptionArgs
, EFSVolumeConfigurationTransitEncryptionArgs
- DISABLED
- DISABLEDEFSVolumeConfigurationTransitEncryption enum DISABLED
- ENABLED
- ENABLEDEFSVolumeConfigurationTransitEncryption enum ENABLED
- EFSVolume
Configuration Transit Encryption DISABLED - DISABLEDEFSVolumeConfigurationTransitEncryption enum DISABLED
- EFSVolume
Configuration Transit Encryption ENABLED - ENABLEDEFSVolumeConfigurationTransitEncryption enum ENABLED
- DISABLED
- DISABLEDEFSVolumeConfigurationTransitEncryption enum DISABLED
- ENABLED
- ENABLEDEFSVolumeConfigurationTransitEncryption enum ENABLED
- DISABLED
- DISABLEDEFSVolumeConfigurationTransitEncryption enum DISABLED
- ENABLED
- ENABLEDEFSVolumeConfigurationTransitEncryption enum ENABLED
- DISABLED
- DISABLEDEFSVolumeConfigurationTransitEncryption enum DISABLED
- ENABLED
- ENABLEDEFSVolumeConfigurationTransitEncryption enum ENABLED
- "DISABLED"
- DISABLEDEFSVolumeConfigurationTransitEncryption enum DISABLED
- "ENABLED"
- ENABLEDEFSVolumeConfigurationTransitEncryption enum ENABLED
EcsTaskDefinitionProperties, EcsTaskDefinitionPropertiesArgs
, EcsTaskDefinitionPropertiesArgs
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties Pulumi.Azure Native. Aws Connector. Inputs. Aws Ecs Task Definition Properties - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- Dictionary<string, string>
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties AwsEcs Task Definition Properties - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- map[string]string
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties AwsEcs Task Definition Properties - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String,String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
- arn string
- Amazon Resource Name (ARN)
- aws
Account stringId - AWS Account ID
- aws
Properties AwsEcs Task Definition Properties - AWS Properties
- aws
Region string - AWS Region
- aws
Source stringSchema - AWS Source Schema
- {[key: string]: string}
- AWS Tags
- public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud stringResource Name - Public Cloud Resource Name
- arn str
- Amazon Resource Name (ARN)
- aws_
account_ strid - AWS Account ID
- aws_
properties AwsEcs Task Definition Properties - AWS Properties
- aws_
region str - AWS Region
- aws_
source_ strschema - AWS Source Schema
- Mapping[str, str]
- AWS Tags
- public_
cloud_ strconnectors_ resource_ id - Public Cloud Connectors Resource ID
- public_
cloud_ strresource_ name - Public Cloud Resource Name
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties Property Map - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
EcsTaskDefinitionPropertiesResponse, EcsTaskDefinitionPropertiesResponseArgs
, EcsTaskDefinitionPropertiesResponseArgs
- Provisioning
State This property is required. string - The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties Pulumi.Azure Native. Aws Connector. Inputs. Aws Ecs Task Definition Properties Response - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- Dictionary<string, string>
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- Provisioning
State This property is required. string - The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties AwsEcs Task Definition Properties Response - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- map[string]string
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- provisioning
State This property is required. String - The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties AwsEcs Task Definition Properties Response - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String,String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
- provisioning
State This property is required. string - The status of the last operation.
- arn string
- Amazon Resource Name (ARN)
- aws
Account stringId - AWS Account ID
- aws
Properties AwsEcs Task Definition Properties Response - AWS Properties
- aws
Region string - AWS Region
- aws
Source stringSchema - AWS Source Schema
- {[key: string]: string}
- AWS Tags
- public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud stringResource Name - Public Cloud Resource Name
- provisioning_
state This property is required. str - The status of the last operation.
- arn str
- Amazon Resource Name (ARN)
- aws_
account_ strid - AWS Account ID
- aws_
properties AwsEcs Task Definition Properties Response - AWS Properties
- aws_
region str - AWS Region
- aws_
source_ strschema - AWS Source Schema
- Mapping[str, str]
- AWS Tags
- public_
cloud_ strconnectors_ resource_ id - Public Cloud Connectors Resource ID
- public_
cloud_ strresource_ name - Public Cloud Resource Name
- provisioning
State This property is required. String - The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties Property Map - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
EnvironmentFile, EnvironmentFileArgs
, EnvironmentFileArgs
EnvironmentFileResponse, EnvironmentFileResponseArgs
, EnvironmentFileResponseArgs
EphemeralStorage, EphemeralStorageArgs
, EphemeralStorageArgs
- size int
- The size of the function's
/tmpdirectory. - size_
in_ intgi_ b - The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is
20GiB and the maximum supported value is200GiB.
EphemeralStorageResponse, EphemeralStorageResponseArgs
, EphemeralStorageResponseArgs
- size int
- The size of the function's
/tmpdirectory. - size_
in_ intgi_ b - The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is
20GiB and the maximum supported value is200GiB.
FSxAuthorizationConfig, FSxAuthorizationConfigArgs
, FSxAuthorizationConfigArgs
- Credentials
Parameter string - Property credentialsParameter
- Domain string
- Property domain
- Credentials
Parameter string - Property credentialsParameter
- Domain string
- Property domain
- credentials
Parameter String - Property credentialsParameter
- domain String
- Property domain
- credentials
Parameter string - Property credentialsParameter
- domain string
- Property domain
- credentials_
parameter str - Property credentialsParameter
- domain str
- Property domain
- credentials
Parameter String - Property credentialsParameter
- domain String
- Property domain
FSxAuthorizationConfigResponse, FSxAuthorizationConfigResponseArgs
, FSxAuthorizationConfigResponseArgs
- Credentials
Parameter string - Property credentialsParameter
- Domain string
- Property domain
- Credentials
Parameter string - Property credentialsParameter
- Domain string
- Property domain
- credentials
Parameter String - Property credentialsParameter
- domain String
- Property domain
- credentials
Parameter string - Property credentialsParameter
- domain string
- Property domain
- credentials_
parameter str - Property credentialsParameter
- domain str
- Property domain
- credentials
Parameter String - Property credentialsParameter
- domain String
- Property domain
FSxWindowsFileServerVolumeConfiguration, FSxWindowsFileServerVolumeConfigurationArgs
, FSxWindowsFileServerVolumeConfigurationArgs
-
Pulumi.
Azure Native. Aws Connector. Inputs. FSx Authorization Config - The authorization configuration details for the Amazon FSx for Windows File Server file system.
- File
System stringId - The Amazon FSx for Windows File Server file system ID to use.
- Root
Directory string - The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
-
FSx
Authorization Config - The authorization configuration details for the Amazon FSx for Windows File Server file system.
- File
System stringId - The Amazon FSx for Windows File Server file system ID to use.
- Root
Directory string - The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
-
FSx
Authorization Config - The authorization configuration details for the Amazon FSx for Windows File Server file system.
- file
System StringId - The Amazon FSx for Windows File Server file system ID to use.
- root
Directory String - The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
-
FSx
Authorization Config - The authorization configuration details for the Amazon FSx for Windows File Server file system.
- file
System stringId - The Amazon FSx for Windows File Server file system ID to use.
- root
Directory string - The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
-
FSx
Authorization Config - The authorization configuration details for the Amazon FSx for Windows File Server file system.
- file_
system_ strid - The Amazon FSx for Windows File Server file system ID to use.
- root_
directory str - The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
- Property Map
- The authorization configuration details for the Amazon FSx for Windows File Server file system.
- file
System StringId - The Amazon FSx for Windows File Server file system ID to use.
- root
Directory String - The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
FSxWindowsFileServerVolumeConfigurationResponse, FSxWindowsFileServerVolumeConfigurationResponseArgs
, FSxWindowsFileServerVolumeConfigurationResponseArgs
-
Pulumi.
Azure Native. Aws Connector. Inputs. FSx Authorization Config Response - The authorization configuration details for the Amazon FSx for Windows File Server file system.
- File
System stringId - The Amazon FSx for Windows File Server file system ID to use.
- Root
Directory string - The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
-
FSx
Authorization Config Response - The authorization configuration details for the Amazon FSx for Windows File Server file system.
- File
System stringId - The Amazon FSx for Windows File Server file system ID to use.
- Root
Directory string - The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
-
FSx
Authorization Config Response - The authorization configuration details for the Amazon FSx for Windows File Server file system.
- file
System StringId - The Amazon FSx for Windows File Server file system ID to use.
- root
Directory String - The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
-
FSx
Authorization Config Response - The authorization configuration details for the Amazon FSx for Windows File Server file system.
- file
System stringId - The Amazon FSx for Windows File Server file system ID to use.
- root
Directory string - The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
-
FSx
Authorization Config Response - The authorization configuration details for the Amazon FSx for Windows File Server file system.
- file_
system_ strid - The Amazon FSx for Windows File Server file system ID to use.
- root_
directory str - The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
- Property Map
- The authorization configuration details for the Amazon FSx for Windows File Server file system.
- file
System StringId - The Amazon FSx for Windows File Server file system ID to use.
- root
Directory String - The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
FirelensConfiguration, FirelensConfigurationArgs
, FirelensConfigurationArgs
- Options object
- The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: +
enable-ecs-log-metadata, which can betrueorfalse+config-file-type, which can bes3orfile+config-file-value, which is either an S3 ARN or a file path - Type string
- The log router to use. The valid values are
fluentdorfluentbit.
- Options interface{}
- The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: +
enable-ecs-log-metadata, which can betrueorfalse+config-file-type, which can bes3orfile+config-file-value, which is either an S3 ARN or a file path - Type string
- The log router to use. The valid values are
fluentdorfluentbit.
- options Object
- The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: +
enable-ecs-log-metadata, which can betrueorfalse+config-file-type, which can bes3orfile+config-file-value, which is either an S3 ARN or a file path - type String
- The log router to use. The valid values are
fluentdorfluentbit.
- options any
- The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: +
enable-ecs-log-metadata, which can betrueorfalse+config-file-type, which can bes3orfile+config-file-value, which is either an S3 ARN or a file path - type string
- The log router to use. The valid values are
fluentdorfluentbit.
- options Any
- The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: +
enable-ecs-log-metadata, which can betrueorfalse+config-file-type, which can bes3orfile+config-file-value, which is either an S3 ARN or a file path - type str
- The log router to use. The valid values are
fluentdorfluentbit.
- options Any
- The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: +
enable-ecs-log-metadata, which can betrueorfalse+config-file-type, which can bes3orfile+config-file-value, which is either an S3 ARN or a file path - type String
- The log router to use. The valid values are
fluentdorfluentbit.
FirelensConfigurationResponse, FirelensConfigurationResponseArgs
, FirelensConfigurationResponseArgs
- Options object
- The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: +
enable-ecs-log-metadata, which can betrueorfalse+config-file-type, which can bes3orfile+config-file-value, which is either an S3 ARN or a file path - Type string
- The log router to use. The valid values are
fluentdorfluentbit.
- Options interface{}
- The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: +
enable-ecs-log-metadata, which can betrueorfalse+config-file-type, which can bes3orfile+config-file-value, which is either an S3 ARN or a file path - Type string
- The log router to use. The valid values are
fluentdorfluentbit.
- options Object
- The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: +
enable-ecs-log-metadata, which can betrueorfalse+config-file-type, which can bes3orfile+config-file-value, which is either an S3 ARN or a file path - type String
- The log router to use. The valid values are
fluentdorfluentbit.
- options any
- The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: +
enable-ecs-log-metadata, which can betrueorfalse+config-file-type, which can bes3orfile+config-file-value, which is either an S3 ARN or a file path - type string
- The log router to use. The valid values are
fluentdorfluentbit.
- options Any
- The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: +
enable-ecs-log-metadata, which can betrueorfalse+config-file-type, which can bes3orfile+config-file-value, which is either an S3 ARN or a file path - type str
- The log router to use. The valid values are
fluentdorfluentbit.
- options Any
- The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: +
enable-ecs-log-metadata, which can betrueorfalse+config-file-type, which can bes3orfile+config-file-value, which is either an S3 ARN or a file path - type String
- The log router to use. The valid values are
fluentdorfluentbit.
HealthCheck, HealthCheckArgs
, HealthCheckArgs
- Command List<string>
- A string array representing the command that the container runs to determine if it is healthy. The string array must start with
CMDto run the command arguments directly, orCMD-SHELLto run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]You don't include the double quotes and brackets when you use the AWS Management Console.CMD-SHELL, curl -f http://localhost/ || exit 1An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, seeHealthCheckin the Create a container section of the Docker Remote API. - Interval int
- The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
- Retries int
- The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
- Start
Period int - The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the
startPeriodis off. If a health check succeeds within thestartPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. - Timeout int
- The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
- Command []string
- A string array representing the command that the container runs to determine if it is healthy. The string array must start with
CMDto run the command arguments directly, orCMD-SHELLto run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]You don't include the double quotes and brackets when you use the AWS Management Console.CMD-SHELL, curl -f http://localhost/ || exit 1An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, seeHealthCheckin the Create a container section of the Docker Remote API. - Interval int
- The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
- Retries int
- The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
- Start
Period int - The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the
startPeriodis off. If a health check succeeds within thestartPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. - Timeout int
- The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
- command List<String>
- A string array representing the command that the container runs to determine if it is healthy. The string array must start with
CMDto run the command arguments directly, orCMD-SHELLto run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]You don't include the double quotes and brackets when you use the AWS Management Console.CMD-SHELL, curl -f http://localhost/ || exit 1An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, seeHealthCheckin the Create a container section of the Docker Remote API. - interval Integer
- The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
- retries Integer
- The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
- start
Period Integer - The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the
startPeriodis off. If a health check succeeds within thestartPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. - timeout Integer
- The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
- command string[]
- A string array representing the command that the container runs to determine if it is healthy. The string array must start with
CMDto run the command arguments directly, orCMD-SHELLto run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]You don't include the double quotes and brackets when you use the AWS Management Console.CMD-SHELL, curl -f http://localhost/ || exit 1An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, seeHealthCheckin the Create a container section of the Docker Remote API. - interval number
- The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
- retries number
- The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
- start
Period number - The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the
startPeriodis off. If a health check succeeds within thestartPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. - timeout number
- The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
- command Sequence[str]
- A string array representing the command that the container runs to determine if it is healthy. The string array must start with
CMDto run the command arguments directly, orCMD-SHELLto run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]You don't include the double quotes and brackets when you use the AWS Management Console.CMD-SHELL, curl -f http://localhost/ || exit 1An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, seeHealthCheckin the Create a container section of the Docker Remote API. - interval int
- The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
- retries int
- The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
- start_
period int - The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the
startPeriodis off. If a health check succeeds within thestartPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. - timeout int
- The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
- command List<String>
- A string array representing the command that the container runs to determine if it is healthy. The string array must start with
CMDto run the command arguments directly, orCMD-SHELLto run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]You don't include the double quotes and brackets when you use the AWS Management Console.CMD-SHELL, curl -f http://localhost/ || exit 1An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, seeHealthCheckin the Create a container section of the Docker Remote API. - interval Number
- The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
- retries Number
- The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
- start
Period Number - The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the
startPeriodis off. If a health check succeeds within thestartPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. - timeout Number
- The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
HealthCheckResponse, HealthCheckResponseArgs
, HealthCheckResponseArgs
- Command List<string>
- A string array representing the command that the container runs to determine if it is healthy. The string array must start with
CMDto run the command arguments directly, orCMD-SHELLto run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]You don't include the double quotes and brackets when you use the AWS Management Console.CMD-SHELL, curl -f http://localhost/ || exit 1An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, seeHealthCheckin the Create a container section of the Docker Remote API. - Interval int
- The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
- Retries int
- The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
- Start
Period int - The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the
startPeriodis off. If a health check succeeds within thestartPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. - Timeout int
- The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
- Command []string
- A string array representing the command that the container runs to determine if it is healthy. The string array must start with
CMDto run the command arguments directly, orCMD-SHELLto run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]You don't include the double quotes and brackets when you use the AWS Management Console.CMD-SHELL, curl -f http://localhost/ || exit 1An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, seeHealthCheckin the Create a container section of the Docker Remote API. - Interval int
- The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
- Retries int
- The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
- Start
Period int - The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the
startPeriodis off. If a health check succeeds within thestartPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. - Timeout int
- The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
- command List<String>
- A string array representing the command that the container runs to determine if it is healthy. The string array must start with
CMDto run the command arguments directly, orCMD-SHELLto run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]You don't include the double quotes and brackets when you use the AWS Management Console.CMD-SHELL, curl -f http://localhost/ || exit 1An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, seeHealthCheckin the Create a container section of the Docker Remote API. - interval Integer
- The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
- retries Integer
- The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
- start
Period Integer - The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the
startPeriodis off. If a health check succeeds within thestartPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. - timeout Integer
- The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
- command string[]
- A string array representing the command that the container runs to determine if it is healthy. The string array must start with
CMDto run the command arguments directly, orCMD-SHELLto run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]You don't include the double quotes and brackets when you use the AWS Management Console.CMD-SHELL, curl -f http://localhost/ || exit 1An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, seeHealthCheckin the Create a container section of the Docker Remote API. - interval number
- The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
- retries number
- The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
- start
Period number - The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the
startPeriodis off. If a health check succeeds within thestartPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. - timeout number
- The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
- command Sequence[str]
- A string array representing the command that the container runs to determine if it is healthy. The string array must start with
CMDto run the command arguments directly, orCMD-SHELLto run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]You don't include the double quotes and brackets when you use the AWS Management Console.CMD-SHELL, curl -f http://localhost/ || exit 1An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, seeHealthCheckin the Create a container section of the Docker Remote API. - interval int
- The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
- retries int
- The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
- start_
period int - The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the
startPeriodis off. If a health check succeeds within thestartPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. - timeout int
- The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
- command List<String>
- A string array representing the command that the container runs to determine if it is healthy. The string array must start with
CMDto run the command arguments directly, orCMD-SHELLto run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]You don't include the double quotes and brackets when you use the AWS Management Console.CMD-SHELL, curl -f http://localhost/ || exit 1An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, seeHealthCheckin the Create a container section of the Docker Remote API. - interval Number
- The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
- retries Number
- The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
- start
Period Number - The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the
startPeriodis off. If a health check succeeds within thestartPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. - timeout Number
- The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
HostEntry, HostEntryArgs
, HostEntryArgs
- hostname str
- The hostname to use in the
/etc/hostsentry. - ip_
address str - The IP address to use in the
/etc/hostsentry.
HostEntryResponse, HostEntryResponseArgs
, HostEntryResponseArgs
- hostname str
- The hostname to use in the
/etc/hostsentry. - ip_
address str - The IP address to use in the
/etc/hostsentry.
HostVolumeProperties, HostVolumePropertiesArgs
, HostVolumePropertiesArgs
- Source
Path string - When the
hostparameter is used, specify asourcePathto declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehostparameter contains asourcePathfile location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePathvalue doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, thesourcePathparameter is not supported.
- Source
Path string - When the
hostparameter is used, specify asourcePathto declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehostparameter contains asourcePathfile location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePathvalue doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, thesourcePathparameter is not supported.
- source
Path String - When the
hostparameter is used, specify asourcePathto declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehostparameter contains asourcePathfile location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePathvalue doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, thesourcePathparameter is not supported.
- source
Path string - When the
hostparameter is used, specify asourcePathto declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehostparameter contains asourcePathfile location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePathvalue doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, thesourcePathparameter is not supported.
- source_
path str - When the
hostparameter is used, specify asourcePathto declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehostparameter contains asourcePathfile location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePathvalue doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, thesourcePathparameter is not supported.
- source
Path String - When the
hostparameter is used, specify asourcePathto declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehostparameter contains asourcePathfile location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePathvalue doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, thesourcePathparameter is not supported.
HostVolumePropertiesResponse, HostVolumePropertiesResponseArgs
, HostVolumePropertiesResponseArgs
- Source
Path string - When the
hostparameter is used, specify asourcePathto declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehostparameter contains asourcePathfile location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePathvalue doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, thesourcePathparameter is not supported.
- Source
Path string - When the
hostparameter is used, specify asourcePathto declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehostparameter contains asourcePathfile location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePathvalue doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, thesourcePathparameter is not supported.
- source
Path String - When the
hostparameter is used, specify asourcePathto declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehostparameter contains asourcePathfile location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePathvalue doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, thesourcePathparameter is not supported.
- source
Path string - When the
hostparameter is used, specify asourcePathto declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehostparameter contains asourcePathfile location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePathvalue doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, thesourcePathparameter is not supported.
- source_
path str - When the
hostparameter is used, specify asourcePathto declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehostparameter contains asourcePathfile location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePathvalue doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, thesourcePathparameter is not supported.
- source
Path String - When the
hostparameter is used, specify asourcePathto declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehostparameter contains asourcePathfile location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePathvalue doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, thesourcePathparameter is not supported.
InferenceAccelerator, InferenceAcceleratorArgs
, InferenceAcceleratorArgs
- Device
Name string - The Elastic Inference accelerator device name. The
deviceNamemust also be referenced in a container definition as a ResourceRequirement. - Device
Type string - The Elastic Inference accelerator type to use.
- Device
Name string - The Elastic Inference accelerator device name. The
deviceNamemust also be referenced in a container definition as a ResourceRequirement. - Device
Type string - The Elastic Inference accelerator type to use.
- device
Name String - The Elastic Inference accelerator device name. The
deviceNamemust also be referenced in a container definition as a ResourceRequirement. - device
Type String - The Elastic Inference accelerator type to use.
- device
Name string - The Elastic Inference accelerator device name. The
deviceNamemust also be referenced in a container definition as a ResourceRequirement. - device
Type string - The Elastic Inference accelerator type to use.
- device_
name str - The Elastic Inference accelerator device name. The
deviceNamemust also be referenced in a container definition as a ResourceRequirement. - device_
type str - The Elastic Inference accelerator type to use.
- device
Name String - The Elastic Inference accelerator device name. The
deviceNamemust also be referenced in a container definition as a ResourceRequirement. - device
Type String - The Elastic Inference accelerator type to use.
InferenceAcceleratorResponse, InferenceAcceleratorResponseArgs
, InferenceAcceleratorResponseArgs
- Device
Name string - The Elastic Inference accelerator device name. The
deviceNamemust also be referenced in a container definition as a ResourceRequirement. - Device
Type string - The Elastic Inference accelerator type to use.
- Device
Name string - The Elastic Inference accelerator device name. The
deviceNamemust also be referenced in a container definition as a ResourceRequirement. - Device
Type string - The Elastic Inference accelerator type to use.
- device
Name String - The Elastic Inference accelerator device name. The
deviceNamemust also be referenced in a container definition as a ResourceRequirement. - device
Type String - The Elastic Inference accelerator type to use.
- device
Name string - The Elastic Inference accelerator device name. The
deviceNamemust also be referenced in a container definition as a ResourceRequirement. - device
Type string - The Elastic Inference accelerator type to use.
- device_
name str - The Elastic Inference accelerator device name. The
deviceNamemust also be referenced in a container definition as a ResourceRequirement. - device_
type str - The Elastic Inference accelerator type to use.
- device
Name String - The Elastic Inference accelerator device name. The
deviceNamemust also be referenced in a container definition as a ResourceRequirement. - device
Type String - The Elastic Inference accelerator type to use.
KernelCapabilities, KernelCapabilitiesArgs
, KernelCapabilitiesArgs
- Add List<string>
- The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to
CapAddin the Create a container section of the Docker Remote API and the--cap-addoption to docker run. Tasks launched on FARGATElong only support adding theSYS_PTRACEkernel capability. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM' - Drop List<string>
- The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to
CapDropin the Create a container section of the Docker Remote API and the--cap-dropoption to docker run. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'
- Add []string
- The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to
CapAddin the Create a container section of the Docker Remote API and the--cap-addoption to docker run. Tasks launched on FARGATElong only support adding theSYS_PTRACEkernel capability. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM' - Drop []string
- The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to
CapDropin the Create a container section of the Docker Remote API and the--cap-dropoption to docker run. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'
- add List<String>
- The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to
CapAddin the Create a container section of the Docker Remote API and the--cap-addoption to docker run. Tasks launched on FARGATElong only support adding theSYS_PTRACEkernel capability. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM' - drop List<String>
- The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to
CapDropin the Create a container section of the Docker Remote API and the--cap-dropoption to docker run. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'
- add string[]
- The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to
CapAddin the Create a container section of the Docker Remote API and the--cap-addoption to docker run. Tasks launched on FARGATElong only support adding theSYS_PTRACEkernel capability. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM' - drop string[]
- The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to
CapDropin the Create a container section of the Docker Remote API and the--cap-dropoption to docker run. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'
- add Sequence[str]
- The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to
CapAddin the Create a container section of the Docker Remote API and the--cap-addoption to docker run. Tasks launched on FARGATElong only support adding theSYS_PTRACEkernel capability. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM' - drop Sequence[str]
- The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to
CapDropin the Create a container section of the Docker Remote API and the--cap-dropoption to docker run. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'
- add List<String>
- The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to
CapAddin the Create a container section of the Docker Remote API and the--cap-addoption to docker run. Tasks launched on FARGATElong only support adding theSYS_PTRACEkernel capability. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM' - drop List<String>
- The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to
CapDropin the Create a container section of the Docker Remote API and the--cap-dropoption to docker run. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'
KernelCapabilitiesResponse, KernelCapabilitiesResponseArgs
, KernelCapabilitiesResponseArgs
- Add List<string>
- The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to
CapAddin the Create a container section of the Docker Remote API and the--cap-addoption to docker run. Tasks launched on FARGATElong only support adding theSYS_PTRACEkernel capability. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM' - Drop List<string>
- The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to
CapDropin the Create a container section of the Docker Remote API and the--cap-dropoption to docker run. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'
- Add []string
- The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to
CapAddin the Create a container section of the Docker Remote API and the--cap-addoption to docker run. Tasks launched on FARGATElong only support adding theSYS_PTRACEkernel capability. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM' - Drop []string
- The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to
CapDropin the Create a container section of the Docker Remote API and the--cap-dropoption to docker run. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'
- add List<String>
- The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to
CapAddin the Create a container section of the Docker Remote API and the--cap-addoption to docker run. Tasks launched on FARGATElong only support adding theSYS_PTRACEkernel capability. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM' - drop List<String>
- The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to
CapDropin the Create a container section of the Docker Remote API and the--cap-dropoption to docker run. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'
- add string[]
- The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to
CapAddin the Create a container section of the Docker Remote API and the--cap-addoption to docker run. Tasks launched on FARGATElong only support adding theSYS_PTRACEkernel capability. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM' - drop string[]
- The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to
CapDropin the Create a container section of the Docker Remote API and the--cap-dropoption to docker run. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'
- add Sequence[str]
- The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to
CapAddin the Create a container section of the Docker Remote API and the--cap-addoption to docker run. Tasks launched on FARGATElong only support adding theSYS_PTRACEkernel capability. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM' - drop Sequence[str]
- The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to
CapDropin the Create a container section of the Docker Remote API and the--cap-dropoption to docker run. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'
- add List<String>
- The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to
CapAddin the Create a container section of the Docker Remote API and the--cap-addoption to docker run. Tasks launched on FARGATElong only support adding theSYS_PTRACEkernel capability. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM' - drop List<String>
- The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to
CapDropin the Create a container section of the Docker Remote API and the--cap-dropoption to docker run. Valid values:'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'
KeyValuePair, KeyValuePairArgs
, KeyValuePairArgs
KeyValuePairResponse, KeyValuePairResponseArgs
, KeyValuePairResponseArgs
LinuxParameters, LinuxParametersArgs
, LinuxParametersArgs
- Capabilities
Pulumi.
Azure Native. Aws Connector. Inputs. Kernel Capabilities - The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type,
capabilitiesis supported for all platform versions but theaddparameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page. - Devices
List<Pulumi.
Azure Native. Aws Connector. Inputs. Device> - Any host devices to expose to the container. This parameter maps to
Devicesin the Create a container section of the Docker Remote API and the--deviceoption to docker run. If you're using tasks that use the Fargate launch type, thedevicesparameter isn't supported. - Init
Process boolEnabled - Run an
initprocess inside the container that forwards signals and reaps processes. This parameter maps to the--initoption to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - Max
Swap int - The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
--memory-swapoption to docker run where the value would be the sum of the container memory plus themaxSwapvalue. If amaxSwapvalue of0is specified, the container will not use swap. Accepted values are0or any positive integer. If themaxSwapparameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwapvalue must be set for theswappinessparameter to be used. If you're using tasks that use the Fargate launch type, themaxSwapparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - int
- The value for the size (in MiB) of the
/dev/shmvolume. This parameter maps to the--shm-sizeoption to docker run. If you are using tasks that use the Fargate launch type, thesharedMemorySizeparameter is not supported. - Swappiness int
- This allows you to tune a container's memory swappiness behavior. A
swappinessvalue of0will cause swapping to not happen unless absolutely necessary. Aswappinessvalue of100will cause pages to be swapped very aggressively. Accepted values are whole numbers between0and100. If theswappinessparameter is not specified, a default value of60is used. If a value is not specified formaxSwapthen this parameter is ignored. This parameter maps to the--memory-swappinessoption to docker run. If you're using tasks that use the Fargate launch type, theswappinessparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - Tmpfs
List<Pulumi.
Azure Native. Aws Connector. Inputs. Tmpfs> - The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfsoption to docker run. If you're using tasks that use the Fargate launch type, thetmpfsparameter isn't supported.
- Capabilities
Kernel
Capabilities - The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type,
capabilitiesis supported for all platform versions but theaddparameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page. - Devices []Device
- Any host devices to expose to the container. This parameter maps to
Devicesin the Create a container section of the Docker Remote API and the--deviceoption to docker run. If you're using tasks that use the Fargate launch type, thedevicesparameter isn't supported. - Init
Process boolEnabled - Run an
initprocess inside the container that forwards signals and reaps processes. This parameter maps to the--initoption to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - Max
Swap int - The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
--memory-swapoption to docker run where the value would be the sum of the container memory plus themaxSwapvalue. If amaxSwapvalue of0is specified, the container will not use swap. Accepted values are0or any positive integer. If themaxSwapparameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwapvalue must be set for theswappinessparameter to be used. If you're using tasks that use the Fargate launch type, themaxSwapparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - int
- The value for the size (in MiB) of the
/dev/shmvolume. This parameter maps to the--shm-sizeoption to docker run. If you are using tasks that use the Fargate launch type, thesharedMemorySizeparameter is not supported. - Swappiness int
- This allows you to tune a container's memory swappiness behavior. A
swappinessvalue of0will cause swapping to not happen unless absolutely necessary. Aswappinessvalue of100will cause pages to be swapped very aggressively. Accepted values are whole numbers between0and100. If theswappinessparameter is not specified, a default value of60is used. If a value is not specified formaxSwapthen this parameter is ignored. This parameter maps to the--memory-swappinessoption to docker run. If you're using tasks that use the Fargate launch type, theswappinessparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - Tmpfs []Tmpfs
- The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfsoption to docker run. If you're using tasks that use the Fargate launch type, thetmpfsparameter isn't supported.
- capabilities
Kernel
Capabilities - The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type,
capabilitiesis supported for all platform versions but theaddparameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page. - devices List<Device>
- Any host devices to expose to the container. This parameter maps to
Devicesin the Create a container section of the Docker Remote API and the--deviceoption to docker run. If you're using tasks that use the Fargate launch type, thedevicesparameter isn't supported. - init
Process BooleanEnabled - Run an
initprocess inside the container that forwards signals and reaps processes. This parameter maps to the--initoption to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - max
Swap Integer - The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
--memory-swapoption to docker run where the value would be the sum of the container memory plus themaxSwapvalue. If amaxSwapvalue of0is specified, the container will not use swap. Accepted values are0or any positive integer. If themaxSwapparameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwapvalue must be set for theswappinessparameter to be used. If you're using tasks that use the Fargate launch type, themaxSwapparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - Integer
- The value for the size (in MiB) of the
/dev/shmvolume. This parameter maps to the--shm-sizeoption to docker run. If you are using tasks that use the Fargate launch type, thesharedMemorySizeparameter is not supported. - swappiness Integer
- This allows you to tune a container's memory swappiness behavior. A
swappinessvalue of0will cause swapping to not happen unless absolutely necessary. Aswappinessvalue of100will cause pages to be swapped very aggressively. Accepted values are whole numbers between0and100. If theswappinessparameter is not specified, a default value of60is used. If a value is not specified formaxSwapthen this parameter is ignored. This parameter maps to the--memory-swappinessoption to docker run. If you're using tasks that use the Fargate launch type, theswappinessparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - tmpfs List<Tmpfs>
- The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfsoption to docker run. If you're using tasks that use the Fargate launch type, thetmpfsparameter isn't supported.
- capabilities
Kernel
Capabilities - The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type,
capabilitiesis supported for all platform versions but theaddparameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page. - devices Device[]
- Any host devices to expose to the container. This parameter maps to
Devicesin the Create a container section of the Docker Remote API and the--deviceoption to docker run. If you're using tasks that use the Fargate launch type, thedevicesparameter isn't supported. - init
Process booleanEnabled - Run an
initprocess inside the container that forwards signals and reaps processes. This parameter maps to the--initoption to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - max
Swap number - The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
--memory-swapoption to docker run where the value would be the sum of the container memory plus themaxSwapvalue. If amaxSwapvalue of0is specified, the container will not use swap. Accepted values are0or any positive integer. If themaxSwapparameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwapvalue must be set for theswappinessparameter to be used. If you're using tasks that use the Fargate launch type, themaxSwapparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - number
- The value for the size (in MiB) of the
/dev/shmvolume. This parameter maps to the--shm-sizeoption to docker run. If you are using tasks that use the Fargate launch type, thesharedMemorySizeparameter is not supported. - swappiness number
- This allows you to tune a container's memory swappiness behavior. A
swappinessvalue of0will cause swapping to not happen unless absolutely necessary. Aswappinessvalue of100will cause pages to be swapped very aggressively. Accepted values are whole numbers between0and100. If theswappinessparameter is not specified, a default value of60is used. If a value is not specified formaxSwapthen this parameter is ignored. This parameter maps to the--memory-swappinessoption to docker run. If you're using tasks that use the Fargate launch type, theswappinessparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - tmpfs Tmpfs[]
- The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfsoption to docker run. If you're using tasks that use the Fargate launch type, thetmpfsparameter isn't supported.
- capabilities
Kernel
Capabilities - The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type,
capabilitiesis supported for all platform versions but theaddparameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page. - devices Sequence[Device]
- Any host devices to expose to the container. This parameter maps to
Devicesin the Create a container section of the Docker Remote API and the--deviceoption to docker run. If you're using tasks that use the Fargate launch type, thedevicesparameter isn't supported. - init_
process_ boolenabled - Run an
initprocess inside the container that forwards signals and reaps processes. This parameter maps to the--initoption to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - max_
swap int - The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
--memory-swapoption to docker run where the value would be the sum of the container memory plus themaxSwapvalue. If amaxSwapvalue of0is specified, the container will not use swap. Accepted values are0or any positive integer. If themaxSwapparameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwapvalue must be set for theswappinessparameter to be used. If you're using tasks that use the Fargate launch type, themaxSwapparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - int
- The value for the size (in MiB) of the
/dev/shmvolume. This parameter maps to the--shm-sizeoption to docker run. If you are using tasks that use the Fargate launch type, thesharedMemorySizeparameter is not supported. - swappiness int
- This allows you to tune a container's memory swappiness behavior. A
swappinessvalue of0will cause swapping to not happen unless absolutely necessary. Aswappinessvalue of100will cause pages to be swapped very aggressively. Accepted values are whole numbers between0and100. If theswappinessparameter is not specified, a default value of60is used. If a value is not specified formaxSwapthen this parameter is ignored. This parameter maps to the--memory-swappinessoption to docker run. If you're using tasks that use the Fargate launch type, theswappinessparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - tmpfs Sequence[Tmpfs]
- The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfsoption to docker run. If you're using tasks that use the Fargate launch type, thetmpfsparameter isn't supported.
- capabilities Property Map
- The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type,
capabilitiesis supported for all platform versions but theaddparameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page. - devices List<Property Map>
- Any host devices to expose to the container. This parameter maps to
Devicesin the Create a container section of the Docker Remote API and the--deviceoption to docker run. If you're using tasks that use the Fargate launch type, thedevicesparameter isn't supported. - init
Process BooleanEnabled - Run an
initprocess inside the container that forwards signals and reaps processes. This parameter maps to the--initoption to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - max
Swap Number - The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
--memory-swapoption to docker run where the value would be the sum of the container memory plus themaxSwapvalue. If amaxSwapvalue of0is specified, the container will not use swap. Accepted values are0or any positive integer. If themaxSwapparameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwapvalue must be set for theswappinessparameter to be used. If you're using tasks that use the Fargate launch type, themaxSwapparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - Number
- The value for the size (in MiB) of the
/dev/shmvolume. This parameter maps to the--shm-sizeoption to docker run. If you are using tasks that use the Fargate launch type, thesharedMemorySizeparameter is not supported. - swappiness Number
- This allows you to tune a container's memory swappiness behavior. A
swappinessvalue of0will cause swapping to not happen unless absolutely necessary. Aswappinessvalue of100will cause pages to be swapped very aggressively. Accepted values are whole numbers between0and100. If theswappinessparameter is not specified, a default value of60is used. If a value is not specified formaxSwapthen this parameter is ignored. This parameter maps to the--memory-swappinessoption to docker run. If you're using tasks that use the Fargate launch type, theswappinessparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - tmpfs List<Property Map>
- The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfsoption to docker run. If you're using tasks that use the Fargate launch type, thetmpfsparameter isn't supported.
LinuxParametersResponse, LinuxParametersResponseArgs
, LinuxParametersResponseArgs
- Capabilities
Pulumi.
Azure Native. Aws Connector. Inputs. Kernel Capabilities Response - The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type,
capabilitiesis supported for all platform versions but theaddparameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page. - Devices
List<Pulumi.
Azure Native. Aws Connector. Inputs. Device Response> - Any host devices to expose to the container. This parameter maps to
Devicesin the Create a container section of the Docker Remote API and the--deviceoption to docker run. If you're using tasks that use the Fargate launch type, thedevicesparameter isn't supported. - Init
Process boolEnabled - Run an
initprocess inside the container that forwards signals and reaps processes. This parameter maps to the--initoption to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - Max
Swap int - The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
--memory-swapoption to docker run where the value would be the sum of the container memory plus themaxSwapvalue. If amaxSwapvalue of0is specified, the container will not use swap. Accepted values are0or any positive integer. If themaxSwapparameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwapvalue must be set for theswappinessparameter to be used. If you're using tasks that use the Fargate launch type, themaxSwapparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - int
- The value for the size (in MiB) of the
/dev/shmvolume. This parameter maps to the--shm-sizeoption to docker run. If you are using tasks that use the Fargate launch type, thesharedMemorySizeparameter is not supported. - Swappiness int
- This allows you to tune a container's memory swappiness behavior. A
swappinessvalue of0will cause swapping to not happen unless absolutely necessary. Aswappinessvalue of100will cause pages to be swapped very aggressively. Accepted values are whole numbers between0and100. If theswappinessparameter is not specified, a default value of60is used. If a value is not specified formaxSwapthen this parameter is ignored. This parameter maps to the--memory-swappinessoption to docker run. If you're using tasks that use the Fargate launch type, theswappinessparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - Tmpfs
List<Pulumi.
Azure Native. Aws Connector. Inputs. Tmpfs Response> - The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfsoption to docker run. If you're using tasks that use the Fargate launch type, thetmpfsparameter isn't supported.
- Capabilities
Kernel
Capabilities Response - The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type,
capabilitiesis supported for all platform versions but theaddparameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page. - Devices
[]Device
Response - Any host devices to expose to the container. This parameter maps to
Devicesin the Create a container section of the Docker Remote API and the--deviceoption to docker run. If you're using tasks that use the Fargate launch type, thedevicesparameter isn't supported. - Init
Process boolEnabled - Run an
initprocess inside the container that forwards signals and reaps processes. This parameter maps to the--initoption to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - Max
Swap int - The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
--memory-swapoption to docker run where the value would be the sum of the container memory plus themaxSwapvalue. If amaxSwapvalue of0is specified, the container will not use swap. Accepted values are0or any positive integer. If themaxSwapparameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwapvalue must be set for theswappinessparameter to be used. If you're using tasks that use the Fargate launch type, themaxSwapparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - int
- The value for the size (in MiB) of the
/dev/shmvolume. This parameter maps to the--shm-sizeoption to docker run. If you are using tasks that use the Fargate launch type, thesharedMemorySizeparameter is not supported. - Swappiness int
- This allows you to tune a container's memory swappiness behavior. A
swappinessvalue of0will cause swapping to not happen unless absolutely necessary. Aswappinessvalue of100will cause pages to be swapped very aggressively. Accepted values are whole numbers between0and100. If theswappinessparameter is not specified, a default value of60is used. If a value is not specified formaxSwapthen this parameter is ignored. This parameter maps to the--memory-swappinessoption to docker run. If you're using tasks that use the Fargate launch type, theswappinessparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - Tmpfs
[]Tmpfs
Response - The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfsoption to docker run. If you're using tasks that use the Fargate launch type, thetmpfsparameter isn't supported.
- capabilities
Kernel
Capabilities Response - The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type,
capabilitiesis supported for all platform versions but theaddparameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page. - devices
List<Device
Response> - Any host devices to expose to the container. This parameter maps to
Devicesin the Create a container section of the Docker Remote API and the--deviceoption to docker run. If you're using tasks that use the Fargate launch type, thedevicesparameter isn't supported. - init
Process BooleanEnabled - Run an
initprocess inside the container that forwards signals and reaps processes. This parameter maps to the--initoption to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - max
Swap Integer - The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
--memory-swapoption to docker run where the value would be the sum of the container memory plus themaxSwapvalue. If amaxSwapvalue of0is specified, the container will not use swap. Accepted values are0or any positive integer. If themaxSwapparameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwapvalue must be set for theswappinessparameter to be used. If you're using tasks that use the Fargate launch type, themaxSwapparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - Integer
- The value for the size (in MiB) of the
/dev/shmvolume. This parameter maps to the--shm-sizeoption to docker run. If you are using tasks that use the Fargate launch type, thesharedMemorySizeparameter is not supported. - swappiness Integer
- This allows you to tune a container's memory swappiness behavior. A
swappinessvalue of0will cause swapping to not happen unless absolutely necessary. Aswappinessvalue of100will cause pages to be swapped very aggressively. Accepted values are whole numbers between0and100. If theswappinessparameter is not specified, a default value of60is used. If a value is not specified formaxSwapthen this parameter is ignored. This parameter maps to the--memory-swappinessoption to docker run. If you're using tasks that use the Fargate launch type, theswappinessparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - tmpfs
List<Tmpfs
Response> - The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfsoption to docker run. If you're using tasks that use the Fargate launch type, thetmpfsparameter isn't supported.
- capabilities
Kernel
Capabilities Response - The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type,
capabilitiesis supported for all platform versions but theaddparameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page. - devices
Device
Response[] - Any host devices to expose to the container. This parameter maps to
Devicesin the Create a container section of the Docker Remote API and the--deviceoption to docker run. If you're using tasks that use the Fargate launch type, thedevicesparameter isn't supported. - init
Process booleanEnabled - Run an
initprocess inside the container that forwards signals and reaps processes. This parameter maps to the--initoption to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - max
Swap number - The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
--memory-swapoption to docker run where the value would be the sum of the container memory plus themaxSwapvalue. If amaxSwapvalue of0is specified, the container will not use swap. Accepted values are0or any positive integer. If themaxSwapparameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwapvalue must be set for theswappinessparameter to be used. If you're using tasks that use the Fargate launch type, themaxSwapparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - number
- The value for the size (in MiB) of the
/dev/shmvolume. This parameter maps to the--shm-sizeoption to docker run. If you are using tasks that use the Fargate launch type, thesharedMemorySizeparameter is not supported. - swappiness number
- This allows you to tune a container's memory swappiness behavior. A
swappinessvalue of0will cause swapping to not happen unless absolutely necessary. Aswappinessvalue of100will cause pages to be swapped very aggressively. Accepted values are whole numbers between0and100. If theswappinessparameter is not specified, a default value of60is used. If a value is not specified formaxSwapthen this parameter is ignored. This parameter maps to the--memory-swappinessoption to docker run. If you're using tasks that use the Fargate launch type, theswappinessparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - tmpfs
Tmpfs
Response[] - The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfsoption to docker run. If you're using tasks that use the Fargate launch type, thetmpfsparameter isn't supported.
- capabilities
Kernel
Capabilities Response - The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type,
capabilitiesis supported for all platform versions but theaddparameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page. - devices
Sequence[Device
Response] - Any host devices to expose to the container. This parameter maps to
Devicesin the Create a container section of the Docker Remote API and the--deviceoption to docker run. If you're using tasks that use the Fargate launch type, thedevicesparameter isn't supported. - init_
process_ boolenabled - Run an
initprocess inside the container that forwards signals and reaps processes. This parameter maps to the--initoption to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - max_
swap int - The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
--memory-swapoption to docker run where the value would be the sum of the container memory plus themaxSwapvalue. If amaxSwapvalue of0is specified, the container will not use swap. Accepted values are0or any positive integer. If themaxSwapparameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwapvalue must be set for theswappinessparameter to be used. If you're using tasks that use the Fargate launch type, themaxSwapparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - int
- The value for the size (in MiB) of the
/dev/shmvolume. This parameter maps to the--shm-sizeoption to docker run. If you are using tasks that use the Fargate launch type, thesharedMemorySizeparameter is not supported. - swappiness int
- This allows you to tune a container's memory swappiness behavior. A
swappinessvalue of0will cause swapping to not happen unless absolutely necessary. Aswappinessvalue of100will cause pages to be swapped very aggressively. Accepted values are whole numbers between0and100. If theswappinessparameter is not specified, a default value of60is used. If a value is not specified formaxSwapthen this parameter is ignored. This parameter maps to the--memory-swappinessoption to docker run. If you're using tasks that use the Fargate launch type, theswappinessparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - tmpfs
Sequence[Tmpfs
Response] - The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfsoption to docker run. If you're using tasks that use the Fargate launch type, thetmpfsparameter isn't supported.
- capabilities Property Map
- The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type,
capabilitiesis supported for all platform versions but theaddparameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page. - devices List<Property Map>
- Any host devices to expose to the container. This parameter maps to
Devicesin the Create a container section of the Docker Remote API and the--deviceoption to docker run. If you're using tasks that use the Fargate launch type, thedevicesparameter isn't supported. - init
Process BooleanEnabled - Run an
initprocess inside the container that forwards signals and reaps processes. This parameter maps to the--initoption to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}' - max
Swap Number - The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
--memory-swapoption to docker run where the value would be the sum of the container memory plus themaxSwapvalue. If amaxSwapvalue of0is specified, the container will not use swap. Accepted values are0or any positive integer. If themaxSwapparameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwapvalue must be set for theswappinessparameter to be used. If you're using tasks that use the Fargate launch type, themaxSwapparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - Number
- The value for the size (in MiB) of the
/dev/shmvolume. This parameter maps to the--shm-sizeoption to docker run. If you are using tasks that use the Fargate launch type, thesharedMemorySizeparameter is not supported. - swappiness Number
- This allows you to tune a container's memory swappiness behavior. A
swappinessvalue of0will cause swapping to not happen unless absolutely necessary. Aswappinessvalue of100will cause pages to be swapped very aggressively. Accepted values are whole numbers between0and100. If theswappinessparameter is not specified, a default value of60is used. If a value is not specified formaxSwapthen this parameter is ignored. This parameter maps to the--memory-swappinessoption to docker run. If you're using tasks that use the Fargate launch type, theswappinessparameter isn't supported. If you're using tasks on Amazon Linux 2023 theswappinessparameter isn't supported. - tmpfs List<Property Map>
- The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfsoption to docker run. If you're using tasks that use the Fargate launch type, thetmpfsparameter isn't supported.
LogConfiguration, LogConfigurationArgs
, LogConfigurationArgs
- Log
Driver string - The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are
awslogs,splunk, andawsfirelens. For tasks hosted on Amazon EC2 instances, the supported log drivers areawslogs,fluentd,gelf,json-file,journald,logentries,syslog,splunk, andawsfirelens. For more information about using theawslogslog driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide. For more information about using theawsfirelenslog driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software. - Options object
- The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}' - Secret
Options List<Pulumi.Azure Native. Aws Connector. Inputs. Secret> - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
- Log
Driver string - The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are
awslogs,splunk, andawsfirelens. For tasks hosted on Amazon EC2 instances, the supported log drivers areawslogs,fluentd,gelf,json-file,journald,logentries,syslog,splunk, andawsfirelens. For more information about using theawslogslog driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide. For more information about using theawsfirelenslog driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software. - Options interface{}
- The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}' - Secret
Options []Secret - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
- log
Driver String - The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are
awslogs,splunk, andawsfirelens. For tasks hosted on Amazon EC2 instances, the supported log drivers areawslogs,fluentd,gelf,json-file,journald,logentries,syslog,splunk, andawsfirelens. For more information about using theawslogslog driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide. For more information about using theawsfirelenslog driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software. - options Object
- The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}' - secret
Options List<Secret> - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
- log
Driver string - The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are
awslogs,splunk, andawsfirelens. For tasks hosted on Amazon EC2 instances, the supported log drivers areawslogs,fluentd,gelf,json-file,journald,logentries,syslog,splunk, andawsfirelens. For more information about using theawslogslog driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide. For more information about using theawsfirelenslog driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software. - options any
- The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}' - secret
Options Secret[] - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
- log_
driver str - The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are
awslogs,splunk, andawsfirelens. For tasks hosted on Amazon EC2 instances, the supported log drivers areawslogs,fluentd,gelf,json-file,journald,logentries,syslog,splunk, andawsfirelens. For more information about using theawslogslog driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide. For more information about using theawsfirelenslog driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software. - options Any
- The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}' - secret_
options Sequence[Secret] - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
- log
Driver String - The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are
awslogs,splunk, andawsfirelens. For tasks hosted on Amazon EC2 instances, the supported log drivers areawslogs,fluentd,gelf,json-file,journald,logentries,syslog,splunk, andawsfirelens. For more information about using theawslogslog driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide. For more information about using theawsfirelenslog driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software. - options Any
- The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}' - secret
Options List<Property Map> - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
LogConfigurationResponse, LogConfigurationResponseArgs
, LogConfigurationResponseArgs
- Log
Driver string - The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are
awslogs,splunk, andawsfirelens. For tasks hosted on Amazon EC2 instances, the supported log drivers areawslogs,fluentd,gelf,json-file,journald,logentries,syslog,splunk, andawsfirelens. For more information about using theawslogslog driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide. For more information about using theawsfirelenslog driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software. - Options object
- The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}' - Secret
Options List<Pulumi.Azure Native. Aws Connector. Inputs. Secret Response> - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
- Log
Driver string - The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are
awslogs,splunk, andawsfirelens. For tasks hosted on Amazon EC2 instances, the supported log drivers areawslogs,fluentd,gelf,json-file,journald,logentries,syslog,splunk, andawsfirelens. For more information about using theawslogslog driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide. For more information about using theawsfirelenslog driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software. - Options interface{}
- The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}' - Secret
Options []SecretResponse - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
- log
Driver String - The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are
awslogs,splunk, andawsfirelens. For tasks hosted on Amazon EC2 instances, the supported log drivers areawslogs,fluentd,gelf,json-file,journald,logentries,syslog,splunk, andawsfirelens. For more information about using theawslogslog driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide. For more information about using theawsfirelenslog driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software. - options Object
- The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}' - secret
Options List<SecretResponse> - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
- log
Driver string - The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are
awslogs,splunk, andawsfirelens. For tasks hosted on Amazon EC2 instances, the supported log drivers areawslogs,fluentd,gelf,json-file,journald,logentries,syslog,splunk, andawsfirelens. For more information about using theawslogslog driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide. For more information about using theawsfirelenslog driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software. - options any
- The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}' - secret
Options SecretResponse[] - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
- log_
driver str - The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are
awslogs,splunk, andawsfirelens. For tasks hosted on Amazon EC2 instances, the supported log drivers areawslogs,fluentd,gelf,json-file,journald,logentries,syslog,splunk, andawsfirelens. For more information about using theawslogslog driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide. For more information about using theawsfirelenslog driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software. - options Any
- The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}' - secret_
options Sequence[SecretResponse] - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
- log
Driver String - The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are
awslogs,splunk, andawsfirelens. For tasks hosted on Amazon EC2 instances, the supported log drivers areawslogs,fluentd,gelf,json-file,journald,logentries,syslog,splunk, andawsfirelens. For more information about using theawslogslog driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide. For more information about using theawsfirelenslog driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software. - options Any
- The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}' - secret
Options List<Property Map> - The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
MountPoint, MountPointArgs
, MountPointArgs
- Container
Path string - The path on the container to mount the host volume at.
- Read
Only bool - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - Source
Volume string - The name of the volume to mount. Must be a volume name referenced in the
nameparameter of task definitionvolume.
- Container
Path string - The path on the container to mount the host volume at.
- Read
Only bool - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - Source
Volume string - The name of the volume to mount. Must be a volume name referenced in the
nameparameter of task definitionvolume.
- container
Path String - The path on the container to mount the host volume at.
- read
Only Boolean - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - source
Volume String - The name of the volume to mount. Must be a volume name referenced in the
nameparameter of task definitionvolume.
- container
Path string - The path on the container to mount the host volume at.
- read
Only boolean - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - source
Volume string - The name of the volume to mount. Must be a volume name referenced in the
nameparameter of task definitionvolume.
- container_
path str - The path on the container to mount the host volume at.
- read_
only bool - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - source_
volume str - The name of the volume to mount. Must be a volume name referenced in the
nameparameter of task definitionvolume.
- container
Path String - The path on the container to mount the host volume at.
- read
Only Boolean - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - source
Volume String - The name of the volume to mount. Must be a volume name referenced in the
nameparameter of task definitionvolume.
MountPointResponse, MountPointResponseArgs
, MountPointResponseArgs
- Container
Path string - The path on the container to mount the host volume at.
- Read
Only bool - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - Source
Volume string - The name of the volume to mount. Must be a volume name referenced in the
nameparameter of task definitionvolume.
- Container
Path string - The path on the container to mount the host volume at.
- Read
Only bool - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - Source
Volume string - The name of the volume to mount. Must be a volume name referenced in the
nameparameter of task definitionvolume.
- container
Path String - The path on the container to mount the host volume at.
- read
Only Boolean - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - source
Volume String - The name of the volume to mount. Must be a volume name referenced in the
nameparameter of task definitionvolume.
- container
Path string - The path on the container to mount the host volume at.
- read
Only boolean - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - source
Volume string - The name of the volume to mount. Must be a volume name referenced in the
nameparameter of task definitionvolume.
- container_
path str - The path on the container to mount the host volume at.
- read_
only bool - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - source_
volume str - The name of the volume to mount. Must be a volume name referenced in the
nameparameter of task definitionvolume.
- container
Path String - The path on the container to mount the host volume at.
- read
Only Boolean - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - source
Volume String - The name of the volume to mount. Must be a volume name referenced in the
nameparameter of task definitionvolume.
PortMapping, PortMappingArgs
, PortMappingArgs
- App
Protocol string | Pulumi.Azure Native. Aws Connector. Port Mapping App Protocol - The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
appProtocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - Container
Port int - The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the
awsvpcorhostnetwork mode, specify the exposed ports usingcontainerPort. If you use containers in a task with thebridgenetwork mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, seehostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. - Container
Port stringRange - The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a
containerPortRange: + You must use either thebridgenetwork mode or theawsvpcnetwork mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of theecs-initpackage + You can specify a maximum of 100 port ranges per container. + You do not specify ahostPortRange. The value of thehostPortRangeis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortRangeis set to the same value as thecontainerPortRange. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + ThecontainerPortRangevalid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see Issue #11185 on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide. You can call DescribeTasks to view thehostPortRangewhich are the host ports that are bound to the container ports. - Host
Port int - The port number on the container instance to reserve for your container. If you specify a
containerPortRange, leave this field empty and the value of thehostPortis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with theawsvpcorhostnetwork mode, thehostPortcan either be left blank or set to the same value as thecontainerPort. If you use containers in a task with thebridgenetwork mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort(or set it to0) while specifying acontainerPortand your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in theremainingResourcesof DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota. - Name string
- The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the
serviceConnectConfigurationof a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - Protocol string
- The protocol used for the port mapping. Valid values are
tcpandudp. The default istcp.protocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.
- App
Protocol string | PortMapping App Protocol - The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
appProtocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - Container
Port int - The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the
awsvpcorhostnetwork mode, specify the exposed ports usingcontainerPort. If you use containers in a task with thebridgenetwork mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, seehostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. - Container
Port stringRange - The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a
containerPortRange: + You must use either thebridgenetwork mode or theawsvpcnetwork mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of theecs-initpackage + You can specify a maximum of 100 port ranges per container. + You do not specify ahostPortRange. The value of thehostPortRangeis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortRangeis set to the same value as thecontainerPortRange. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + ThecontainerPortRangevalid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see Issue #11185 on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide. You can call DescribeTasks to view thehostPortRangewhich are the host ports that are bound to the container ports. - Host
Port int - The port number on the container instance to reserve for your container. If you specify a
containerPortRange, leave this field empty and the value of thehostPortis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with theawsvpcorhostnetwork mode, thehostPortcan either be left blank or set to the same value as thecontainerPort. If you use containers in a task with thebridgenetwork mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort(or set it to0) while specifying acontainerPortand your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in theremainingResourcesof DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota. - Name string
- The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the
serviceConnectConfigurationof a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - Protocol string
- The protocol used for the port mapping. Valid values are
tcpandudp. The default istcp.protocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.
- app
Protocol String | PortMapping App Protocol - The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
appProtocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - container
Port Integer - The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the
awsvpcorhostnetwork mode, specify the exposed ports usingcontainerPort. If you use containers in a task with thebridgenetwork mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, seehostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. - container
Port StringRange - The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a
containerPortRange: + You must use either thebridgenetwork mode or theawsvpcnetwork mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of theecs-initpackage + You can specify a maximum of 100 port ranges per container. + You do not specify ahostPortRange. The value of thehostPortRangeis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortRangeis set to the same value as thecontainerPortRange. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + ThecontainerPortRangevalid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see Issue #11185 on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide. You can call DescribeTasks to view thehostPortRangewhich are the host ports that are bound to the container ports. - host
Port Integer - The port number on the container instance to reserve for your container. If you specify a
containerPortRange, leave this field empty and the value of thehostPortis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with theawsvpcorhostnetwork mode, thehostPortcan either be left blank or set to the same value as thecontainerPort. If you use containers in a task with thebridgenetwork mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort(or set it to0) while specifying acontainerPortand your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in theremainingResourcesof DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota. - name String
- The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the
serviceConnectConfigurationof a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - protocol String
- The protocol used for the port mapping. Valid values are
tcpandudp. The default istcp.protocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.
- app
Protocol string | PortMapping App Protocol - The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
appProtocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - container
Port number - The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the
awsvpcorhostnetwork mode, specify the exposed ports usingcontainerPort. If you use containers in a task with thebridgenetwork mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, seehostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. - container
Port stringRange - The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a
containerPortRange: + You must use either thebridgenetwork mode or theawsvpcnetwork mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of theecs-initpackage + You can specify a maximum of 100 port ranges per container. + You do not specify ahostPortRange. The value of thehostPortRangeis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortRangeis set to the same value as thecontainerPortRange. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + ThecontainerPortRangevalid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see Issue #11185 on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide. You can call DescribeTasks to view thehostPortRangewhich are the host ports that are bound to the container ports. - host
Port number - The port number on the container instance to reserve for your container. If you specify a
containerPortRange, leave this field empty and the value of thehostPortis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with theawsvpcorhostnetwork mode, thehostPortcan either be left blank or set to the same value as thecontainerPort. If you use containers in a task with thebridgenetwork mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort(or set it to0) while specifying acontainerPortand your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in theremainingResourcesof DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota. - name string
- The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the
serviceConnectConfigurationof a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - protocol string
- The protocol used for the port mapping. Valid values are
tcpandudp. The default istcp.protocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.
- app_
protocol str | PortMapping App Protocol - The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
appProtocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - container_
port int - The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the
awsvpcorhostnetwork mode, specify the exposed ports usingcontainerPort. If you use containers in a task with thebridgenetwork mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, seehostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. - container_
port_ strrange - The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a
containerPortRange: + You must use either thebridgenetwork mode or theawsvpcnetwork mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of theecs-initpackage + You can specify a maximum of 100 port ranges per container. + You do not specify ahostPortRange. The value of thehostPortRangeis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortRangeis set to the same value as thecontainerPortRange. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + ThecontainerPortRangevalid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see Issue #11185 on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide. You can call DescribeTasks to view thehostPortRangewhich are the host ports that are bound to the container ports. - host_
port int - The port number on the container instance to reserve for your container. If you specify a
containerPortRange, leave this field empty and the value of thehostPortis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with theawsvpcorhostnetwork mode, thehostPortcan either be left blank or set to the same value as thecontainerPort. If you use containers in a task with thebridgenetwork mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort(or set it to0) while specifying acontainerPortand your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in theremainingResourcesof DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota. - name str
- The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the
serviceConnectConfigurationof a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - protocol str
- The protocol used for the port mapping. Valid values are
tcpandudp. The default istcp.protocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.
- app
Protocol String | "grpc" | "http" | "http2" - The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
appProtocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - container
Port Number - The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the
awsvpcorhostnetwork mode, specify the exposed ports usingcontainerPort. If you use containers in a task with thebridgenetwork mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, seehostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. - container
Port StringRange - The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a
containerPortRange: + You must use either thebridgenetwork mode or theawsvpcnetwork mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of theecs-initpackage + You can specify a maximum of 100 port ranges per container. + You do not specify ahostPortRange. The value of thehostPortRangeis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortRangeis set to the same value as thecontainerPortRange. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + ThecontainerPortRangevalid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see Issue #11185 on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide. You can call DescribeTasks to view thehostPortRangewhich are the host ports that are bound to the container ports. - host
Port Number - The port number on the container instance to reserve for your container. If you specify a
containerPortRange, leave this field empty and the value of thehostPortis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with theawsvpcorhostnetwork mode, thehostPortcan either be left blank or set to the same value as thecontainerPort. If you use containers in a task with thebridgenetwork mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort(or set it to0) while specifying acontainerPortand your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in theremainingResourcesof DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota. - name String
- The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the
serviceConnectConfigurationof a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - protocol String
- The protocol used for the port mapping. Valid values are
tcpandudp. The default istcp.protocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.
PortMappingAppProtocol, PortMappingAppProtocolArgs
, PortMappingAppProtocolArgs
- Grpc
- grpcPortMappingAppProtocol enum grpc
- Http
- httpPortMappingAppProtocol enum http
- Http2
- http2PortMappingAppProtocol enum http2
- Port
Mapping App Protocol Grpc - grpcPortMappingAppProtocol enum grpc
- Port
Mapping App Protocol Http - httpPortMappingAppProtocol enum http
- Port
Mapping App Protocol Http2 - http2PortMappingAppProtocol enum http2
- Grpc
- grpcPortMappingAppProtocol enum grpc
- Http
- httpPortMappingAppProtocol enum http
- Http2
- http2PortMappingAppProtocol enum http2
- Grpc
- grpcPortMappingAppProtocol enum grpc
- Http
- httpPortMappingAppProtocol enum http
- Http2
- http2PortMappingAppProtocol enum http2
- GRPC
- grpcPortMappingAppProtocol enum grpc
- HTTP
- httpPortMappingAppProtocol enum http
- HTTP2
- http2PortMappingAppProtocol enum http2
- "grpc"
- grpcPortMappingAppProtocol enum grpc
- "http"
- httpPortMappingAppProtocol enum http
- "http2"
- http2PortMappingAppProtocol enum http2
PortMappingResponse, PortMappingResponseArgs
, PortMappingResponseArgs
- App
Protocol string - The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
appProtocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - Container
Port int - The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the
awsvpcorhostnetwork mode, specify the exposed ports usingcontainerPort. If you use containers in a task with thebridgenetwork mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, seehostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. - Container
Port stringRange - The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a
containerPortRange: + You must use either thebridgenetwork mode or theawsvpcnetwork mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of theecs-initpackage + You can specify a maximum of 100 port ranges per container. + You do not specify ahostPortRange. The value of thehostPortRangeis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortRangeis set to the same value as thecontainerPortRange. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + ThecontainerPortRangevalid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see Issue #11185 on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide. You can call DescribeTasks to view thehostPortRangewhich are the host ports that are bound to the container ports. - Host
Port int - The port number on the container instance to reserve for your container. If you specify a
containerPortRange, leave this field empty and the value of thehostPortis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with theawsvpcorhostnetwork mode, thehostPortcan either be left blank or set to the same value as thecontainerPort. If you use containers in a task with thebridgenetwork mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort(or set it to0) while specifying acontainerPortand your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in theremainingResourcesof DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota. - Name string
- The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the
serviceConnectConfigurationof a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - Protocol string
- The protocol used for the port mapping. Valid values are
tcpandudp. The default istcp.protocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.
- App
Protocol string - The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
appProtocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - Container
Port int - The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the
awsvpcorhostnetwork mode, specify the exposed ports usingcontainerPort. If you use containers in a task with thebridgenetwork mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, seehostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. - Container
Port stringRange - The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a
containerPortRange: + You must use either thebridgenetwork mode or theawsvpcnetwork mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of theecs-initpackage + You can specify a maximum of 100 port ranges per container. + You do not specify ahostPortRange. The value of thehostPortRangeis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortRangeis set to the same value as thecontainerPortRange. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + ThecontainerPortRangevalid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see Issue #11185 on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide. You can call DescribeTasks to view thehostPortRangewhich are the host ports that are bound to the container ports. - Host
Port int - The port number on the container instance to reserve for your container. If you specify a
containerPortRange, leave this field empty and the value of thehostPortis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with theawsvpcorhostnetwork mode, thehostPortcan either be left blank or set to the same value as thecontainerPort. If you use containers in a task with thebridgenetwork mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort(or set it to0) while specifying acontainerPortand your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in theremainingResourcesof DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota. - Name string
- The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the
serviceConnectConfigurationof a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - Protocol string
- The protocol used for the port mapping. Valid values are
tcpandudp. The default istcp.protocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.
- app
Protocol String - The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
appProtocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - container
Port Integer - The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the
awsvpcorhostnetwork mode, specify the exposed ports usingcontainerPort. If you use containers in a task with thebridgenetwork mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, seehostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. - container
Port StringRange - The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a
containerPortRange: + You must use either thebridgenetwork mode or theawsvpcnetwork mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of theecs-initpackage + You can specify a maximum of 100 port ranges per container. + You do not specify ahostPortRange. The value of thehostPortRangeis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortRangeis set to the same value as thecontainerPortRange. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + ThecontainerPortRangevalid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see Issue #11185 on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide. You can call DescribeTasks to view thehostPortRangewhich are the host ports that are bound to the container ports. - host
Port Integer - The port number on the container instance to reserve for your container. If you specify a
containerPortRange, leave this field empty and the value of thehostPortis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with theawsvpcorhostnetwork mode, thehostPortcan either be left blank or set to the same value as thecontainerPort. If you use containers in a task with thebridgenetwork mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort(or set it to0) while specifying acontainerPortand your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in theremainingResourcesof DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota. - name String
- The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the
serviceConnectConfigurationof a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - protocol String
- The protocol used for the port mapping. Valid values are
tcpandudp. The default istcp.protocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.
- app
Protocol string - The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
appProtocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - container
Port number - The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the
awsvpcorhostnetwork mode, specify the exposed ports usingcontainerPort. If you use containers in a task with thebridgenetwork mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, seehostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. - container
Port stringRange - The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a
containerPortRange: + You must use either thebridgenetwork mode or theawsvpcnetwork mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of theecs-initpackage + You can specify a maximum of 100 port ranges per container. + You do not specify ahostPortRange. The value of thehostPortRangeis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortRangeis set to the same value as thecontainerPortRange. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + ThecontainerPortRangevalid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see Issue #11185 on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide. You can call DescribeTasks to view thehostPortRangewhich are the host ports that are bound to the container ports. - host
Port number - The port number on the container instance to reserve for your container. If you specify a
containerPortRange, leave this field empty and the value of thehostPortis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with theawsvpcorhostnetwork mode, thehostPortcan either be left blank or set to the same value as thecontainerPort. If you use containers in a task with thebridgenetwork mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort(or set it to0) while specifying acontainerPortand your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in theremainingResourcesof DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota. - name string
- The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the
serviceConnectConfigurationof a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - protocol string
- The protocol used for the port mapping. Valid values are
tcpandudp. The default istcp.protocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.
- app_
protocol str - The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
appProtocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - container_
port int - The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the
awsvpcorhostnetwork mode, specify the exposed ports usingcontainerPort. If you use containers in a task with thebridgenetwork mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, seehostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. - container_
port_ strrange - The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a
containerPortRange: + You must use either thebridgenetwork mode or theawsvpcnetwork mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of theecs-initpackage + You can specify a maximum of 100 port ranges per container. + You do not specify ahostPortRange. The value of thehostPortRangeis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortRangeis set to the same value as thecontainerPortRange. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + ThecontainerPortRangevalid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see Issue #11185 on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide. You can call DescribeTasks to view thehostPortRangewhich are the host ports that are bound to the container ports. - host_
port int - The port number on the container instance to reserve for your container. If you specify a
containerPortRange, leave this field empty and the value of thehostPortis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with theawsvpcorhostnetwork mode, thehostPortcan either be left blank or set to the same value as thecontainerPort. If you use containers in a task with thebridgenetwork mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort(or set it to0) while specifying acontainerPortand your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in theremainingResourcesof DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota. - name str
- The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the
serviceConnectConfigurationof a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - protocol str
- The protocol used for the port mapping. Valid values are
tcpandudp. The default istcp.protocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.
- app
Protocol String - The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.
appProtocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - container
Port Number - The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the
awsvpcorhostnetwork mode, specify the exposed ports usingcontainerPort. If you use containers in a task with thebridgenetwork mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, seehostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. - container
Port StringRange - The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a
containerPortRange: + You must use either thebridgenetwork mode or theawsvpcnetwork mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of theecs-initpackage + You can specify a maximum of 100 port ranges per container. + You do not specify ahostPortRange. The value of thehostPortRangeis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortRangeis set to the same value as thecontainerPortRange. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + ThecontainerPortRangevalid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see Issue #11185 on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see Docker daemon in the Amazon ECS Developer Guide. You can call DescribeTasks to view thehostPortRangewhich are the host ports that are bound to the container ports. - host
Port Number - The port number on the container instance to reserve for your container. If you specify a
containerPortRange, leave this field empty and the value of thehostPortis set as follows: + For containers in a task with theawsvpcnetwork mode, thehostPortis set to the same value as thecontainerPort. This is a static mapping strategy. + For containers in a task with thebridgenetwork mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with theawsvpcorhostnetwork mode, thehostPortcan either be left blank or set to the same value as thecontainerPort. If you use containers in a task with thebridgenetwork mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort(or set it to0) while specifying acontainerPortand your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under/proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in theremainingResourcesof DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota. - name String
- The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the
serviceConnectConfigurationof a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. - protocol String
- The protocol used for the port mapping. Valid values are
tcpandudp. The default istcp.protocolis immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.
ProxyConfiguration, ProxyConfigurationArgs
, ProxyConfigurationArgs
- Container
Name string - The name of the container that will serve as the App Mesh proxy.
- Proxy
Configuration List<Pulumi.Properties Azure Native. Aws Connector. Inputs. Key Value Pair> - The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. +
IgnoredUID- (Required) The user ID (UID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGIDis specified, this field can be empty. +IgnoredGID- (Required) The group ID (GID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUIDis specified, this field can be empty. +AppPorts- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPortandProxyEgressPort. +ProxyIngressPort- (Required) Specifies the port that incoming traffic to theAppPortsis directed to. +ProxyEgressPort- (Required) Specifies the port that outgoing traffic from theAppPortsis directed to. +EgressIgnoredPorts- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort. It can be an empty list. +EgressIgnoredIPs- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort. It can be an empty list. - Type string
- The proxy type. The only supported value is
APPMESH.
- Container
Name string - The name of the container that will serve as the App Mesh proxy.
- Proxy
Configuration []KeyProperties Value Pair - The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. +
IgnoredUID- (Required) The user ID (UID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGIDis specified, this field can be empty. +IgnoredGID- (Required) The group ID (GID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUIDis specified, this field can be empty. +AppPorts- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPortandProxyEgressPort. +ProxyIngressPort- (Required) Specifies the port that incoming traffic to theAppPortsis directed to. +ProxyEgressPort- (Required) Specifies the port that outgoing traffic from theAppPortsis directed to. +EgressIgnoredPorts- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort. It can be an empty list. +EgressIgnoredIPs- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort. It can be an empty list. - Type string
- The proxy type. The only supported value is
APPMESH.
- container
Name String - The name of the container that will serve as the App Mesh proxy.
- proxy
Configuration List<KeyProperties Value Pair> - The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. +
IgnoredUID- (Required) The user ID (UID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGIDis specified, this field can be empty. +IgnoredGID- (Required) The group ID (GID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUIDis specified, this field can be empty. +AppPorts- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPortandProxyEgressPort. +ProxyIngressPort- (Required) Specifies the port that incoming traffic to theAppPortsis directed to. +ProxyEgressPort- (Required) Specifies the port that outgoing traffic from theAppPortsis directed to. +EgressIgnoredPorts- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort. It can be an empty list. +EgressIgnoredIPs- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort. It can be an empty list. - type String
- The proxy type. The only supported value is
APPMESH.
- container
Name string - The name of the container that will serve as the App Mesh proxy.
- proxy
Configuration KeyProperties Value Pair[] - The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. +
IgnoredUID- (Required) The user ID (UID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGIDis specified, this field can be empty. +IgnoredGID- (Required) The group ID (GID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUIDis specified, this field can be empty. +AppPorts- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPortandProxyEgressPort. +ProxyIngressPort- (Required) Specifies the port that incoming traffic to theAppPortsis directed to. +ProxyEgressPort- (Required) Specifies the port that outgoing traffic from theAppPortsis directed to. +EgressIgnoredPorts- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort. It can be an empty list. +EgressIgnoredIPs- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort. It can be an empty list. - type string
- The proxy type. The only supported value is
APPMESH.
- container_
name str - The name of the container that will serve as the App Mesh proxy.
- proxy_
configuration_ Sequence[Keyproperties Value Pair] - The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. +
IgnoredUID- (Required) The user ID (UID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGIDis specified, this field can be empty. +IgnoredGID- (Required) The group ID (GID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUIDis specified, this field can be empty. +AppPorts- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPortandProxyEgressPort. +ProxyIngressPort- (Required) Specifies the port that incoming traffic to theAppPortsis directed to. +ProxyEgressPort- (Required) Specifies the port that outgoing traffic from theAppPortsis directed to. +EgressIgnoredPorts- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort. It can be an empty list. +EgressIgnoredIPs- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort. It can be an empty list. - type str
- The proxy type. The only supported value is
APPMESH.
- container
Name String - The name of the container that will serve as the App Mesh proxy.
- proxy
Configuration List<Property Map>Properties - The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. +
IgnoredUID- (Required) The user ID (UID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGIDis specified, this field can be empty. +IgnoredGID- (Required) The group ID (GID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUIDis specified, this field can be empty. +AppPorts- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPortandProxyEgressPort. +ProxyIngressPort- (Required) Specifies the port that incoming traffic to theAppPortsis directed to. +ProxyEgressPort- (Required) Specifies the port that outgoing traffic from theAppPortsis directed to. +EgressIgnoredPorts- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort. It can be an empty list. +EgressIgnoredIPs- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort. It can be an empty list. - type String
- The proxy type. The only supported value is
APPMESH.
ProxyConfigurationResponse, ProxyConfigurationResponseArgs
, ProxyConfigurationResponseArgs
- Container
Name string - The name of the container that will serve as the App Mesh proxy.
- Proxy
Configuration List<Pulumi.Properties Azure Native. Aws Connector. Inputs. Key Value Pair Response> - The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. +
IgnoredUID- (Required) The user ID (UID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGIDis specified, this field can be empty. +IgnoredGID- (Required) The group ID (GID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUIDis specified, this field can be empty. +AppPorts- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPortandProxyEgressPort. +ProxyIngressPort- (Required) Specifies the port that incoming traffic to theAppPortsis directed to. +ProxyEgressPort- (Required) Specifies the port that outgoing traffic from theAppPortsis directed to. +EgressIgnoredPorts- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort. It can be an empty list. +EgressIgnoredIPs- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort. It can be an empty list. - Type string
- The proxy type. The only supported value is
APPMESH.
- Container
Name string - The name of the container that will serve as the App Mesh proxy.
- Proxy
Configuration []KeyProperties Value Pair Response - The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. +
IgnoredUID- (Required) The user ID (UID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGIDis specified, this field can be empty. +IgnoredGID- (Required) The group ID (GID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUIDis specified, this field can be empty. +AppPorts- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPortandProxyEgressPort. +ProxyIngressPort- (Required) Specifies the port that incoming traffic to theAppPortsis directed to. +ProxyEgressPort- (Required) Specifies the port that outgoing traffic from theAppPortsis directed to. +EgressIgnoredPorts- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort. It can be an empty list. +EgressIgnoredIPs- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort. It can be an empty list. - Type string
- The proxy type. The only supported value is
APPMESH.
- container
Name String - The name of the container that will serve as the App Mesh proxy.
- proxy
Configuration List<KeyProperties Value Pair Response> - The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. +
IgnoredUID- (Required) The user ID (UID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGIDis specified, this field can be empty. +IgnoredGID- (Required) The group ID (GID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUIDis specified, this field can be empty. +AppPorts- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPortandProxyEgressPort. +ProxyIngressPort- (Required) Specifies the port that incoming traffic to theAppPortsis directed to. +ProxyEgressPort- (Required) Specifies the port that outgoing traffic from theAppPortsis directed to. +EgressIgnoredPorts- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort. It can be an empty list. +EgressIgnoredIPs- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort. It can be an empty list. - type String
- The proxy type. The only supported value is
APPMESH.
- container
Name string - The name of the container that will serve as the App Mesh proxy.
- proxy
Configuration KeyProperties Value Pair Response[] - The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. +
IgnoredUID- (Required) The user ID (UID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGIDis specified, this field can be empty. +IgnoredGID- (Required) The group ID (GID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUIDis specified, this field can be empty. +AppPorts- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPortandProxyEgressPort. +ProxyIngressPort- (Required) Specifies the port that incoming traffic to theAppPortsis directed to. +ProxyEgressPort- (Required) Specifies the port that outgoing traffic from theAppPortsis directed to. +EgressIgnoredPorts- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort. It can be an empty list. +EgressIgnoredIPs- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort. It can be an empty list. - type string
- The proxy type. The only supported value is
APPMESH.
- container_
name str - The name of the container that will serve as the App Mesh proxy.
- proxy_
configuration_ Sequence[Keyproperties Value Pair Response] - The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. +
IgnoredUID- (Required) The user ID (UID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGIDis specified, this field can be empty. +IgnoredGID- (Required) The group ID (GID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUIDis specified, this field can be empty. +AppPorts- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPortandProxyEgressPort. +ProxyIngressPort- (Required) Specifies the port that incoming traffic to theAppPortsis directed to. +ProxyEgressPort- (Required) Specifies the port that outgoing traffic from theAppPortsis directed to. +EgressIgnoredPorts- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort. It can be an empty list. +EgressIgnoredIPs- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort. It can be an empty list. - type str
- The proxy type. The only supported value is
APPMESH.
- container
Name String - The name of the container that will serve as the App Mesh proxy.
- proxy
Configuration List<Property Map>Properties - The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. +
IgnoredUID- (Required) The user ID (UID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGIDis specified, this field can be empty. +IgnoredGID- (Required) The group ID (GID) of the proxy container as defined by theuserparameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUIDis specified, this field can be empty. +AppPorts- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPortandProxyEgressPort. +ProxyIngressPort- (Required) Specifies the port that incoming traffic to theAppPortsis directed to. +ProxyEgressPort- (Required) Specifies the port that outgoing traffic from theAppPortsis directed to. +EgressIgnoredPorts- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort. It can be an empty list. +EgressIgnoredIPs- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort. It can be an empty list. - type String
- The proxy type. The only supported value is
APPMESH.
RepositoryCredentials, RepositoryCredentialsArgs
, RepositoryCredentialsArgs
- Credentials
Parameter string - The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.
- Credentials
Parameter string - The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.
- credentials
Parameter String - The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.
- credentials
Parameter string - The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.
- credentials_
parameter str - The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.
- credentials
Parameter String - The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.
RepositoryCredentialsResponse, RepositoryCredentialsResponseArgs
, RepositoryCredentialsResponseArgs
- Credentials
Parameter string - The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.
- Credentials
Parameter string - The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.
- credentials
Parameter String - The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.
- credentials
Parameter string - The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.
- credentials_
parameter str - The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.
- credentials
Parameter String - The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.
ResourceRequirement, ResourceRequirementArgs
, ResourceRequirementArgs
- Type string
- The type of resource to assign to a container. The supported values are
GPUorInferenceAccelerator. - Value string
- The value for the specified resource type. If the
GPUtype is used, the value is the number of physicalGPUsthe Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If theInferenceAcceleratortype is used, thevaluematches thedeviceNamefor an InferenceAccelerator specified in a task definition.
- Type string
- The type of resource to assign to a container. The supported values are
GPUorInferenceAccelerator. - Value string
- The value for the specified resource type. If the
GPUtype is used, the value is the number of physicalGPUsthe Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If theInferenceAcceleratortype is used, thevaluematches thedeviceNamefor an InferenceAccelerator specified in a task definition.
- type String
- The type of resource to assign to a container. The supported values are
GPUorInferenceAccelerator. - value String
- The value for the specified resource type. If the
GPUtype is used, the value is the number of physicalGPUsthe Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If theInferenceAcceleratortype is used, thevaluematches thedeviceNamefor an InferenceAccelerator specified in a task definition.
- type string
- The type of resource to assign to a container. The supported values are
GPUorInferenceAccelerator. - value string
- The value for the specified resource type. If the
GPUtype is used, the value is the number of physicalGPUsthe Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If theInferenceAcceleratortype is used, thevaluematches thedeviceNamefor an InferenceAccelerator specified in a task definition.
- type str
- The type of resource to assign to a container. The supported values are
GPUorInferenceAccelerator. - value str
- The value for the specified resource type. If the
GPUtype is used, the value is the number of physicalGPUsthe Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If theInferenceAcceleratortype is used, thevaluematches thedeviceNamefor an InferenceAccelerator specified in a task definition.
- type String
- The type of resource to assign to a container. The supported values are
GPUorInferenceAccelerator. - value String
- The value for the specified resource type. If the
GPUtype is used, the value is the number of physicalGPUsthe Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If theInferenceAcceleratortype is used, thevaluematches thedeviceNamefor an InferenceAccelerator specified in a task definition.
ResourceRequirementResponse, ResourceRequirementResponseArgs
, ResourceRequirementResponseArgs
- Type string
- The type of resource to assign to a container. The supported values are
GPUorInferenceAccelerator. - Value string
- The value for the specified resource type. If the
GPUtype is used, the value is the number of physicalGPUsthe Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If theInferenceAcceleratortype is used, thevaluematches thedeviceNamefor an InferenceAccelerator specified in a task definition.
- Type string
- The type of resource to assign to a container. The supported values are
GPUorInferenceAccelerator. - Value string
- The value for the specified resource type. If the
GPUtype is used, the value is the number of physicalGPUsthe Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If theInferenceAcceleratortype is used, thevaluematches thedeviceNamefor an InferenceAccelerator specified in a task definition.
- type String
- The type of resource to assign to a container. The supported values are
GPUorInferenceAccelerator. - value String
- The value for the specified resource type. If the
GPUtype is used, the value is the number of physicalGPUsthe Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If theInferenceAcceleratortype is used, thevaluematches thedeviceNamefor an InferenceAccelerator specified in a task definition.
- type string
- The type of resource to assign to a container. The supported values are
GPUorInferenceAccelerator. - value string
- The value for the specified resource type. If the
GPUtype is used, the value is the number of physicalGPUsthe Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If theInferenceAcceleratortype is used, thevaluematches thedeviceNamefor an InferenceAccelerator specified in a task definition.
- type str
- The type of resource to assign to a container. The supported values are
GPUorInferenceAccelerator. - value str
- The value for the specified resource type. If the
GPUtype is used, the value is the number of physicalGPUsthe Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If theInferenceAcceleratortype is used, thevaluematches thedeviceNamefor an InferenceAccelerator specified in a task definition.
- type String
- The type of resource to assign to a container. The supported values are
GPUorInferenceAccelerator. - value String
- The value for the specified resource type. If the
GPUtype is used, the value is the number of physicalGPUsthe Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If theInferenceAcceleratortype is used, thevaluematches thedeviceNamefor an InferenceAccelerator specified in a task definition.
RuntimePlatform, RuntimePlatformArgs
, RuntimePlatformArgs
- Cpu
Architecture string - The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to
ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate. - Operating
System stringFamily - The operating system.
- Cpu
Architecture string - The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to
ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate. - Operating
System stringFamily - The operating system.
- cpu
Architecture String - The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to
ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate. - operating
System StringFamily - The operating system.
- cpu
Architecture string - The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to
ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate. - operating
System stringFamily - The operating system.
- cpu_
architecture str - The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to
ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate. - operating_
system_ strfamily - The operating system.
- cpu
Architecture String - The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to
ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate. - operating
System StringFamily - The operating system.
RuntimePlatformResponse, RuntimePlatformResponseArgs
, RuntimePlatformResponseArgs
- Cpu
Architecture string - The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to
ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate. - Operating
System stringFamily - The operating system.
- Cpu
Architecture string - The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to
ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate. - Operating
System stringFamily - The operating system.
- cpu
Architecture String - The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to
ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate. - operating
System StringFamily - The operating system.
- cpu
Architecture string - The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to
ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate. - operating
System stringFamily - The operating system.
- cpu_
architecture str - The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to
ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate. - operating_
system_ strfamily - The operating system.
- cpu
Architecture String - The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to
ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate. - operating
System StringFamily - The operating system.
Secret, SecretArgs
, SecretArgs
- Name string
- The name of the secret.
- Value
From string - The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
- Name string
- The name of the secret.
- Value
From string - The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
- name String
- The name of the secret.
- value
From String - The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
- name string
- The name of the secret.
- value
From string - The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
- name str
- The name of the secret.
- value_
from str - The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
- name String
- The name of the secret.
- value
From String - The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
SecretResponse, SecretResponseArgs
, SecretResponseArgs
- Name string
- The name of the secret.
- Value
From string - The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
- Name string
- The name of the secret.
- Value
From string - The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
- name String
- The name of the secret.
- value
From String - The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
- name string
- The name of the secret.
- value
From string - The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
- name str
- The name of the secret.
- value_
from str - The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
- name String
- The name of the secret.
- value
From String - The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
SystemControl, SystemControlArgs
, SystemControlArgs
- Namespace string
- The namespaced kernel parameter to set a
valuefor. - Value string
- The namespaced kernel parameter to set a
valuefor. Valid IPC namespace values:'kernel.msgmax' | 'kernel.msgmnb' | 'kernel.msgmni' | 'kernel.sem' | 'kernel.shmall' | 'kernel.shmmax' | 'kernel.shmmni' | 'kernel.shm_rmid_forced', andSysctlsthat start with'fs.mqueue.*'Valid network namespace values:Sysctlsthat start with'net.*'All of these values are supported by Fargate.
- Namespace string
- The namespaced kernel parameter to set a
valuefor. - Value string
- The namespaced kernel parameter to set a
valuefor. Valid IPC namespace values:'kernel.msgmax' | 'kernel.msgmnb' | 'kernel.msgmni' | 'kernel.sem' | 'kernel.shmall' | 'kernel.shmmax' | 'kernel.shmmni' | 'kernel.shm_rmid_forced', andSysctlsthat start with'fs.mqueue.*'Valid network namespace values:Sysctlsthat start with'net.*'All of these values are supported by Fargate.
- namespace String
- The namespaced kernel parameter to set a
valuefor. - value String
- The namespaced kernel parameter to set a
valuefor. Valid IPC namespace values:'kernel.msgmax' | 'kernel.msgmnb' | 'kernel.msgmni' | 'kernel.sem' | 'kernel.shmall' | 'kernel.shmmax' | 'kernel.shmmni' | 'kernel.shm_rmid_forced', andSysctlsthat start with'fs.mqueue.*'Valid network namespace values:Sysctlsthat start with'net.*'All of these values are supported by Fargate.
- namespace string
- The namespaced kernel parameter to set a
valuefor. - value string
- The namespaced kernel parameter to set a
valuefor. Valid IPC namespace values:'kernel.msgmax' | 'kernel.msgmnb' | 'kernel.msgmni' | 'kernel.sem' | 'kernel.shmall' | 'kernel.shmmax' | 'kernel.shmmni' | 'kernel.shm_rmid_forced', andSysctlsthat start with'fs.mqueue.*'Valid network namespace values:Sysctlsthat start with'net.*'All of these values are supported by Fargate.
- namespace str
- The namespaced kernel parameter to set a
valuefor. - value str
- The namespaced kernel parameter to set a
valuefor. Valid IPC namespace values:'kernel.msgmax' | 'kernel.msgmnb' | 'kernel.msgmni' | 'kernel.sem' | 'kernel.shmall' | 'kernel.shmmax' | 'kernel.shmmni' | 'kernel.shm_rmid_forced', andSysctlsthat start with'fs.mqueue.*'Valid network namespace values:Sysctlsthat start with'net.*'All of these values are supported by Fargate.
- namespace String
- The namespaced kernel parameter to set a
valuefor. - value String
- The namespaced kernel parameter to set a
valuefor. Valid IPC namespace values:'kernel.msgmax' | 'kernel.msgmnb' | 'kernel.msgmni' | 'kernel.sem' | 'kernel.shmall' | 'kernel.shmmax' | 'kernel.shmmni' | 'kernel.shm_rmid_forced', andSysctlsthat start with'fs.mqueue.*'Valid network namespace values:Sysctlsthat start with'net.*'All of these values are supported by Fargate.
SystemControlResponse, SystemControlResponseArgs
, SystemControlResponseArgs
- Namespace string
- The namespaced kernel parameter to set a
valuefor. - Value string
- The namespaced kernel parameter to set a
valuefor. Valid IPC namespace values:'kernel.msgmax' | 'kernel.msgmnb' | 'kernel.msgmni' | 'kernel.sem' | 'kernel.shmall' | 'kernel.shmmax' | 'kernel.shmmni' | 'kernel.shm_rmid_forced', andSysctlsthat start with'fs.mqueue.*'Valid network namespace values:Sysctlsthat start with'net.*'All of these values are supported by Fargate.
- Namespace string
- The namespaced kernel parameter to set a
valuefor. - Value string
- The namespaced kernel parameter to set a
valuefor. Valid IPC namespace values:'kernel.msgmax' | 'kernel.msgmnb' | 'kernel.msgmni' | 'kernel.sem' | 'kernel.shmall' | 'kernel.shmmax' | 'kernel.shmmni' | 'kernel.shm_rmid_forced', andSysctlsthat start with'fs.mqueue.*'Valid network namespace values:Sysctlsthat start with'net.*'All of these values are supported by Fargate.
- namespace String
- The namespaced kernel parameter to set a
valuefor. - value String
- The namespaced kernel parameter to set a
valuefor. Valid IPC namespace values:'kernel.msgmax' | 'kernel.msgmnb' | 'kernel.msgmni' | 'kernel.sem' | 'kernel.shmall' | 'kernel.shmmax' | 'kernel.shmmni' | 'kernel.shm_rmid_forced', andSysctlsthat start with'fs.mqueue.*'Valid network namespace values:Sysctlsthat start with'net.*'All of these values are supported by Fargate.
- namespace string
- The namespaced kernel parameter to set a
valuefor. - value string
- The namespaced kernel parameter to set a
valuefor. Valid IPC namespace values:'kernel.msgmax' | 'kernel.msgmnb' | 'kernel.msgmni' | 'kernel.sem' | 'kernel.shmall' | 'kernel.shmmax' | 'kernel.shmmni' | 'kernel.shm_rmid_forced', andSysctlsthat start with'fs.mqueue.*'Valid network namespace values:Sysctlsthat start with'net.*'All of these values are supported by Fargate.
- namespace str
- The namespaced kernel parameter to set a
valuefor. - value str
- The namespaced kernel parameter to set a
valuefor. Valid IPC namespace values:'kernel.msgmax' | 'kernel.msgmnb' | 'kernel.msgmni' | 'kernel.sem' | 'kernel.shmall' | 'kernel.shmmax' | 'kernel.shmmni' | 'kernel.shm_rmid_forced', andSysctlsthat start with'fs.mqueue.*'Valid network namespace values:Sysctlsthat start with'net.*'All of these values are supported by Fargate.
- namespace String
- The namespaced kernel parameter to set a
valuefor. - value String
- The namespaced kernel parameter to set a
valuefor. Valid IPC namespace values:'kernel.msgmax' | 'kernel.msgmnb' | 'kernel.msgmni' | 'kernel.sem' | 'kernel.shmall' | 'kernel.shmmax' | 'kernel.shmmni' | 'kernel.shm_rmid_forced', andSysctlsthat start with'fs.mqueue.*'Valid network namespace values:Sysctlsthat start with'net.*'All of these values are supported by Fargate.
SystemDataResponse, SystemDataResponseArgs
, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Tag, TagArgs
, TagArgs
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
TagResponse, TagResponseArgs
, TagResponseArgs
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
TaskDefinitionPlacementConstraint, TaskDefinitionPlacementConstraintArgs
, TaskDefinitionPlacementConstraintArgs
- Expression string
- A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
- Type string
- The type of constraint. The
MemberOfconstraint restricts selection to be from a group of valid candidates.
- Expression string
- A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
- Type string
- The type of constraint. The
MemberOfconstraint restricts selection to be from a group of valid candidates.
- expression String
- A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
- type String
- The type of constraint. The
MemberOfconstraint restricts selection to be from a group of valid candidates.
- expression string
- A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
- type string
- The type of constraint. The
MemberOfconstraint restricts selection to be from a group of valid candidates.
- expression str
- A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
- type str
- The type of constraint. The
MemberOfconstraint restricts selection to be from a group of valid candidates.
- expression String
- A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
- type String
- The type of constraint. The
MemberOfconstraint restricts selection to be from a group of valid candidates.
TaskDefinitionPlacementConstraintResponse, TaskDefinitionPlacementConstraintResponseArgs
, TaskDefinitionPlacementConstraintResponseArgs
- Expression string
- A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
- Type string
- The type of constraint. The
MemberOfconstraint restricts selection to be from a group of valid candidates.
- Expression string
- A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
- Type string
- The type of constraint. The
MemberOfconstraint restricts selection to be from a group of valid candidates.
- expression String
- A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
- type String
- The type of constraint. The
MemberOfconstraint restricts selection to be from a group of valid candidates.
- expression string
- A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
- type string
- The type of constraint. The
MemberOfconstraint restricts selection to be from a group of valid candidates.
- expression str
- A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
- type str
- The type of constraint. The
MemberOfconstraint restricts selection to be from a group of valid candidates.
- expression String
- A cluster query language expression to apply to the constraint. For more information, see Cluster query language in the Amazon Elastic Container Service Developer Guide.
- type String
- The type of constraint. The
MemberOfconstraint restricts selection to be from a group of valid candidates.
Tmpfs, TmpfsArgs
, TmpfsArgs
- Container
Path string - The absolute file path where the tmpfs volume is to be mounted.
- Mount
Options List<string> - The list of tmpfs volume mount options.
- Size int
- The maximum size (in MiB) of the tmpfs volume.
- Container
Path string - The absolute file path where the tmpfs volume is to be mounted.
- Mount
Options []string - The list of tmpfs volume mount options.
- Size int
- The maximum size (in MiB) of the tmpfs volume.
- container
Path String - The absolute file path where the tmpfs volume is to be mounted.
- mount
Options List<String> - The list of tmpfs volume mount options.
- size Integer
- The maximum size (in MiB) of the tmpfs volume.
- container
Path string - The absolute file path where the tmpfs volume is to be mounted.
- mount
Options string[] - The list of tmpfs volume mount options.
- size number
- The maximum size (in MiB) of the tmpfs volume.
- container_
path str - The absolute file path where the tmpfs volume is to be mounted.
- mount_
options Sequence[str] - The list of tmpfs volume mount options.
- size int
- The maximum size (in MiB) of the tmpfs volume.
- container
Path String - The absolute file path where the tmpfs volume is to be mounted.
- mount
Options List<String> - The list of tmpfs volume mount options.
- size Number
- The maximum size (in MiB) of the tmpfs volume.
TmpfsResponse, TmpfsResponseArgs
, TmpfsResponseArgs
- Container
Path string - The absolute file path where the tmpfs volume is to be mounted.
- Mount
Options List<string> - The list of tmpfs volume mount options.
- Size int
- The maximum size (in MiB) of the tmpfs volume.
- Container
Path string - The absolute file path where the tmpfs volume is to be mounted.
- Mount
Options []string - The list of tmpfs volume mount options.
- Size int
- The maximum size (in MiB) of the tmpfs volume.
- container
Path String - The absolute file path where the tmpfs volume is to be mounted.
- mount
Options List<String> - The list of tmpfs volume mount options.
- size Integer
- The maximum size (in MiB) of the tmpfs volume.
- container
Path string - The absolute file path where the tmpfs volume is to be mounted.
- mount
Options string[] - The list of tmpfs volume mount options.
- size number
- The maximum size (in MiB) of the tmpfs volume.
- container_
path str - The absolute file path where the tmpfs volume is to be mounted.
- mount_
options Sequence[str] - The list of tmpfs volume mount options.
- size int
- The maximum size (in MiB) of the tmpfs volume.
- container
Path String - The absolute file path where the tmpfs volume is to be mounted.
- mount
Options List<String> - The list of tmpfs volume mount options.
- size Number
- The maximum size (in MiB) of the tmpfs volume.
Ulimit, UlimitArgs
, UlimitArgs
- hard_
limit int - The hard limit for the
ulimittype. - name str
- The
typeof theulimit. - soft_
limit int - The soft limit for the
ulimittype.
UlimitResponse, UlimitResponseArgs
, UlimitResponseArgs
- hard_
limit int - The hard limit for the
ulimittype. - name str
- The
typeof theulimit. - soft_
limit int - The soft limit for the
ulimittype.
Volume, VolumeArgs
, VolumeArgs
- Configured
At boolLaunch - Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurationsobject when calling theCreateService,UpdateService,RunTaskorStartTaskAPIs. - Docker
Volume Pulumi.Configuration Azure Native. Aws Connector. Inputs. Docker Volume Configuration - This parameter is specified when you use Docker volumes. Windows containers only support the use of the
localdriver. To use bind mounts, specify thehostparameter instead. Docker volumes aren't supported by tasks run on FARGATElong. TheDockerVolumeConfigurationproperty specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of thelocaldriver. To use bind mounts, specify ahostinstead. - Efs
Volume Pulumi.Configuration Azure Native. Aws Connector. Inputs. EFSVolume Configuration - This parameter is specified when you use an Amazon Elastic File System file system for task storage. This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.
- FSx
Windows Pulumi.File Server Volume Configuration Azure Native. Aws Connector. Inputs. FSx Windows File Server Volume Configuration - This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage. For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.
- Host
Pulumi.
Azure Native. Aws Connector. Inputs. Host Volume Properties - This parameter is specified when you use bind mount host volumes. The contents of the
hostparameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehostparameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\pathandD:\:D:\, but notD:\my\path:C:\my\pathorD:\:C:\my\path. TheHostVolumePropertiesproperty specifies details on a container instance bind mount host volume. - Name string
- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the
nameis required and must also be specified as the volume name in theServiceVolumeConfigurationorTaskVolumeConfigurationparameter when creating your service or standalone task. For all other types of volumes, this name is referenced in thesourceVolumeparameter of themountPointsobject in the container definition. When a volume is using theefsVolumeConfiguration, the name is required.
- Configured
At boolLaunch - Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurationsobject when calling theCreateService,UpdateService,RunTaskorStartTaskAPIs. - Docker
Volume DockerConfiguration Volume Configuration - This parameter is specified when you use Docker volumes. Windows containers only support the use of the
localdriver. To use bind mounts, specify thehostparameter instead. Docker volumes aren't supported by tasks run on FARGATElong. TheDockerVolumeConfigurationproperty specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of thelocaldriver. To use bind mounts, specify ahostinstead. - Efs
Volume EFSVolumeConfiguration Configuration - This parameter is specified when you use an Amazon Elastic File System file system for task storage. This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.
- FSx
Windows FSxFile Server Volume Configuration Windows File Server Volume Configuration - This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage. For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.
- Host
Host
Volume Properties - This parameter is specified when you use bind mount host volumes. The contents of the
hostparameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehostparameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\pathandD:\:D:\, but notD:\my\path:C:\my\pathorD:\:C:\my\path. TheHostVolumePropertiesproperty specifies details on a container instance bind mount host volume. - Name string
- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the
nameis required and must also be specified as the volume name in theServiceVolumeConfigurationorTaskVolumeConfigurationparameter when creating your service or standalone task. For all other types of volumes, this name is referenced in thesourceVolumeparameter of themountPointsobject in the container definition. When a volume is using theefsVolumeConfiguration, the name is required.
- configured
At BooleanLaunch - Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurationsobject when calling theCreateService,UpdateService,RunTaskorStartTaskAPIs. - docker
Volume DockerConfiguration Volume Configuration - This parameter is specified when you use Docker volumes. Windows containers only support the use of the
localdriver. To use bind mounts, specify thehostparameter instead. Docker volumes aren't supported by tasks run on FARGATElong. TheDockerVolumeConfigurationproperty specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of thelocaldriver. To use bind mounts, specify ahostinstead. - efs
Volume EFSVolumeConfiguration Configuration - This parameter is specified when you use an Amazon Elastic File System file system for task storage. This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.
- f
Sx FSxWindows File Server Volume Configuration Windows File Server Volume Configuration - This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage. For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.
- host
Host
Volume Properties - This parameter is specified when you use bind mount host volumes. The contents of the
hostparameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehostparameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\pathandD:\:D:\, but notD:\my\path:C:\my\pathorD:\:C:\my\path. TheHostVolumePropertiesproperty specifies details on a container instance bind mount host volume. - name String
- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the
nameis required and must also be specified as the volume name in theServiceVolumeConfigurationorTaskVolumeConfigurationparameter when creating your service or standalone task. For all other types of volumes, this name is referenced in thesourceVolumeparameter of themountPointsobject in the container definition. When a volume is using theefsVolumeConfiguration, the name is required.
- configured
At booleanLaunch - Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurationsobject when calling theCreateService,UpdateService,RunTaskorStartTaskAPIs. - docker
Volume DockerConfiguration Volume Configuration - This parameter is specified when you use Docker volumes. Windows containers only support the use of the
localdriver. To use bind mounts, specify thehostparameter instead. Docker volumes aren't supported by tasks run on FARGATElong. TheDockerVolumeConfigurationproperty specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of thelocaldriver. To use bind mounts, specify ahostinstead. - efs
Volume EFSVolumeConfiguration Configuration - This parameter is specified when you use an Amazon Elastic File System file system for task storage. This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.
- f
Sx FSxWindows File Server Volume Configuration Windows File Server Volume Configuration - This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage. For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.
- host
Host
Volume Properties - This parameter is specified when you use bind mount host volumes. The contents of the
hostparameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehostparameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\pathandD:\:D:\, but notD:\my\path:C:\my\pathorD:\:C:\my\path. TheHostVolumePropertiesproperty specifies details on a container instance bind mount host volume. - name string
- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the
nameis required and must also be specified as the volume name in theServiceVolumeConfigurationorTaskVolumeConfigurationparameter when creating your service or standalone task. For all other types of volumes, this name is referenced in thesourceVolumeparameter of themountPointsobject in the container definition. When a volume is using theefsVolumeConfiguration, the name is required.
- configured_
at_ boollaunch - Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurationsobject when calling theCreateService,UpdateService,RunTaskorStartTaskAPIs. - docker_
volume_ Dockerconfiguration Volume Configuration - This parameter is specified when you use Docker volumes. Windows containers only support the use of the
localdriver. To use bind mounts, specify thehostparameter instead. Docker volumes aren't supported by tasks run on FARGATElong. TheDockerVolumeConfigurationproperty specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of thelocaldriver. To use bind mounts, specify ahostinstead. - efs_
volume_ EFSVolumeconfiguration Configuration - This parameter is specified when you use an Amazon Elastic File System file system for task storage. This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.
- f_
sx_ FSxwindows_ file_ server_ volume_ configuration Windows File Server Volume Configuration - This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage. For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.
- host
Host
Volume Properties - This parameter is specified when you use bind mount host volumes. The contents of the
hostparameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehostparameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\pathandD:\:D:\, but notD:\my\path:C:\my\pathorD:\:C:\my\path. TheHostVolumePropertiesproperty specifies details on a container instance bind mount host volume. - name str
- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the
nameis required and must also be specified as the volume name in theServiceVolumeConfigurationorTaskVolumeConfigurationparameter when creating your service or standalone task. For all other types of volumes, this name is referenced in thesourceVolumeparameter of themountPointsobject in the container definition. When a volume is using theefsVolumeConfiguration, the name is required.
- configured
At BooleanLaunch - Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurationsobject when calling theCreateService,UpdateService,RunTaskorStartTaskAPIs. - docker
Volume Property MapConfiguration - This parameter is specified when you use Docker volumes. Windows containers only support the use of the
localdriver. To use bind mounts, specify thehostparameter instead. Docker volumes aren't supported by tasks run on FARGATElong. TheDockerVolumeConfigurationproperty specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of thelocaldriver. To use bind mounts, specify ahostinstead. - efs
Volume Property MapConfiguration - This parameter is specified when you use an Amazon Elastic File System file system for task storage. This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.
- f
Sx Property MapWindows File Server Volume Configuration - This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage. For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.
- host Property Map
- This parameter is specified when you use bind mount host volumes. The contents of the
hostparameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehostparameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\pathandD:\:D:\, but notD:\my\path:C:\my\pathorD:\:C:\my\path. TheHostVolumePropertiesproperty specifies details on a container instance bind mount host volume. - name String
- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the
nameis required and must also be specified as the volume name in theServiceVolumeConfigurationorTaskVolumeConfigurationparameter when creating your service or standalone task. For all other types of volumes, this name is referenced in thesourceVolumeparameter of themountPointsobject in the container definition. When a volume is using theefsVolumeConfiguration, the name is required.
VolumeFrom, VolumeFromArgs
, VolumeFromArgs
- Read
Only bool - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - Source
Container string - The name of another container within the same task definition to mount volumes from.
- Read
Only bool - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - Source
Container string - The name of another container within the same task definition to mount volumes from.
- read
Only Boolean - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - source
Container String - The name of another container within the same task definition to mount volumes from.
- read
Only boolean - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - source
Container string - The name of another container within the same task definition to mount volumes from.
- read_
only bool - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - source_
container str - The name of another container within the same task definition to mount volumes from.
- read
Only Boolean - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - source
Container String - The name of another container within the same task definition to mount volumes from.
VolumeFromResponse, VolumeFromResponseArgs
, VolumeFromResponseArgs
- Read
Only bool - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - Source
Container string - The name of another container within the same task definition to mount volumes from.
- Read
Only bool - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - Source
Container string - The name of another container within the same task definition to mount volumes from.
- read
Only Boolean - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - source
Container String - The name of another container within the same task definition to mount volumes from.
- read
Only boolean - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - source
Container string - The name of another container within the same task definition to mount volumes from.
- read_
only bool - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - source_
container str - The name of another container within the same task definition to mount volumes from.
- read
Only Boolean - If this value is
true, the container has read-only access to the volume. If this value isfalse, then the container can write to the volume. The default value isfalse. - source
Container String - The name of another container within the same task definition to mount volumes from.
VolumeResponse, VolumeResponseArgs
, VolumeResponseArgs
- Configured
At boolLaunch - Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurationsobject when calling theCreateService,UpdateService,RunTaskorStartTaskAPIs. - Docker
Volume Pulumi.Configuration Azure Native. Aws Connector. Inputs. Docker Volume Configuration Response - This parameter is specified when you use Docker volumes. Windows containers only support the use of the
localdriver. To use bind mounts, specify thehostparameter instead. Docker volumes aren't supported by tasks run on FARGATElong. TheDockerVolumeConfigurationproperty specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of thelocaldriver. To use bind mounts, specify ahostinstead. - Efs
Volume Pulumi.Configuration Azure Native. Aws Connector. Inputs. EFSVolume Configuration Response - This parameter is specified when you use an Amazon Elastic File System file system for task storage. This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.
- FSx
Windows Pulumi.File Server Volume Configuration Azure Native. Aws Connector. Inputs. FSx Windows File Server Volume Configuration Response - This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage. For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.
- Host
Pulumi.
Azure Native. Aws Connector. Inputs. Host Volume Properties Response - This parameter is specified when you use bind mount host volumes. The contents of the
hostparameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehostparameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\pathandD:\:D:\, but notD:\my\path:C:\my\pathorD:\:C:\my\path. TheHostVolumePropertiesproperty specifies details on a container instance bind mount host volume. - Name string
- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the
nameis required and must also be specified as the volume name in theServiceVolumeConfigurationorTaskVolumeConfigurationparameter when creating your service or standalone task. For all other types of volumes, this name is referenced in thesourceVolumeparameter of themountPointsobject in the container definition. When a volume is using theefsVolumeConfiguration, the name is required.
- Configured
At boolLaunch - Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurationsobject when calling theCreateService,UpdateService,RunTaskorStartTaskAPIs. - Docker
Volume DockerConfiguration Volume Configuration Response - This parameter is specified when you use Docker volumes. Windows containers only support the use of the
localdriver. To use bind mounts, specify thehostparameter instead. Docker volumes aren't supported by tasks run on FARGATElong. TheDockerVolumeConfigurationproperty specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of thelocaldriver. To use bind mounts, specify ahostinstead. - Efs
Volume EFSVolumeConfiguration Configuration Response - This parameter is specified when you use an Amazon Elastic File System file system for task storage. This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.
- FSx
Windows FSxFile Server Volume Configuration Windows File Server Volume Configuration Response - This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage. For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.
- Host
Host
Volume Properties Response - This parameter is specified when you use bind mount host volumes. The contents of the
hostparameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehostparameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\pathandD:\:D:\, but notD:\my\path:C:\my\pathorD:\:C:\my\path. TheHostVolumePropertiesproperty specifies details on a container instance bind mount host volume. - Name string
- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the
nameis required and must also be specified as the volume name in theServiceVolumeConfigurationorTaskVolumeConfigurationparameter when creating your service or standalone task. For all other types of volumes, this name is referenced in thesourceVolumeparameter of themountPointsobject in the container definition. When a volume is using theefsVolumeConfiguration, the name is required.
- configured
At BooleanLaunch - Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurationsobject when calling theCreateService,UpdateService,RunTaskorStartTaskAPIs. - docker
Volume DockerConfiguration Volume Configuration Response - This parameter is specified when you use Docker volumes. Windows containers only support the use of the
localdriver. To use bind mounts, specify thehostparameter instead. Docker volumes aren't supported by tasks run on FARGATElong. TheDockerVolumeConfigurationproperty specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of thelocaldriver. To use bind mounts, specify ahostinstead. - efs
Volume EFSVolumeConfiguration Configuration Response - This parameter is specified when you use an Amazon Elastic File System file system for task storage. This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.
- f
Sx FSxWindows File Server Volume Configuration Windows File Server Volume Configuration Response - This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage. For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.
- host
Host
Volume Properties Response - This parameter is specified when you use bind mount host volumes. The contents of the
hostparameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehostparameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\pathandD:\:D:\, but notD:\my\path:C:\my\pathorD:\:C:\my\path. TheHostVolumePropertiesproperty specifies details on a container instance bind mount host volume. - name String
- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the
nameis required and must also be specified as the volume name in theServiceVolumeConfigurationorTaskVolumeConfigurationparameter when creating your service or standalone task. For all other types of volumes, this name is referenced in thesourceVolumeparameter of themountPointsobject in the container definition. When a volume is using theefsVolumeConfiguration, the name is required.
- configured
At booleanLaunch - Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurationsobject when calling theCreateService,UpdateService,RunTaskorStartTaskAPIs. - docker
Volume DockerConfiguration Volume Configuration Response - This parameter is specified when you use Docker volumes. Windows containers only support the use of the
localdriver. To use bind mounts, specify thehostparameter instead. Docker volumes aren't supported by tasks run on FARGATElong. TheDockerVolumeConfigurationproperty specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of thelocaldriver. To use bind mounts, specify ahostinstead. - efs
Volume EFSVolumeConfiguration Configuration Response - This parameter is specified when you use an Amazon Elastic File System file system for task storage. This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.
- f
Sx FSxWindows File Server Volume Configuration Windows File Server Volume Configuration Response - This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage. For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.
- host
Host
Volume Properties Response - This parameter is specified when you use bind mount host volumes. The contents of the
hostparameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehostparameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\pathandD:\:D:\, but notD:\my\path:C:\my\pathorD:\:C:\my\path. TheHostVolumePropertiesproperty specifies details on a container instance bind mount host volume. - name string
- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the
nameis required and must also be specified as the volume name in theServiceVolumeConfigurationorTaskVolumeConfigurationparameter when creating your service or standalone task. For all other types of volumes, this name is referenced in thesourceVolumeparameter of themountPointsobject in the container definition. When a volume is using theefsVolumeConfiguration, the name is required.
- configured_
at_ boollaunch - Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurationsobject when calling theCreateService,UpdateService,RunTaskorStartTaskAPIs. - docker_
volume_ Dockerconfiguration Volume Configuration Response - This parameter is specified when you use Docker volumes. Windows containers only support the use of the
localdriver. To use bind mounts, specify thehostparameter instead. Docker volumes aren't supported by tasks run on FARGATElong. TheDockerVolumeConfigurationproperty specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of thelocaldriver. To use bind mounts, specify ahostinstead. - efs_
volume_ EFSVolumeconfiguration Configuration Response - This parameter is specified when you use an Amazon Elastic File System file system for task storage. This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.
- f_
sx_ FSxwindows_ file_ server_ volume_ configuration Windows File Server Volume Configuration Response - This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage. For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.
- host
Host
Volume Properties Response - This parameter is specified when you use bind mount host volumes. The contents of the
hostparameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehostparameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\pathandD:\:D:\, but notD:\my\path:C:\my\pathorD:\:C:\my\path. TheHostVolumePropertiesproperty specifies details on a container instance bind mount host volume. - name str
- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the
nameis required and must also be specified as the volume name in theServiceVolumeConfigurationorTaskVolumeConfigurationparameter when creating your service or standalone task. For all other types of volumes, this name is referenced in thesourceVolumeparameter of themountPointsobject in the container definition. When a volume is using theefsVolumeConfiguration, the name is required.
- configured
At BooleanLaunch - Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurationsobject when calling theCreateService,UpdateService,RunTaskorStartTaskAPIs. - docker
Volume Property MapConfiguration - This parameter is specified when you use Docker volumes. Windows containers only support the use of the
localdriver. To use bind mounts, specify thehostparameter instead. Docker volumes aren't supported by tasks run on FARGATElong. TheDockerVolumeConfigurationproperty specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of thelocaldriver. To use bind mounts, specify ahostinstead. - efs
Volume Property MapConfiguration - This parameter is specified when you use an Amazon Elastic File System file system for task storage. This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS volumes in the Amazon Elastic Container Service Developer Guide.
- f
Sx Property MapWindows File Server Volume Configuration - This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. This parameter is specified when you're using Amazon FSx for Windows File Server file system for task storage. For more information and the input format, see Amazon FSx for Windows File Server volumes in the Amazon Elastic Container Service Developer Guide.
- host Property Map
- This parameter is specified when you use bind mount host volumes. The contents of the
hostparameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If thehostparameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. Windows containers can mount whole directories on the same drive as$env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mountC:\my\path:C:\my\pathandD:\:D:\, but notD:\my\path:C:\my\pathorD:\:C:\my\path. TheHostVolumePropertiesproperty specifies details on a container instance bind mount host volume. - name String
- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the
nameis required and must also be specified as the volume name in theServiceVolumeConfigurationorTaskVolumeConfigurationparameter when creating your service or standalone task. For all other types of volumes, this name is referenced in thesourceVolumeparameter of themountPointsobject in the container definition. When a volume is using theefsVolumeConfiguration, the name is required.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:awsconnector:EcsTaskDefinition j /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ecsTaskDefinitions/{name}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi