EcsContainerDefinitionProps Struct
Props to configure an EcsContainerDefinition.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_batch as batch } from 'aws-cdk-lib';
import { aws_ecs as ecs } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
declare const containerImage: ecs.ContainerImage;
declare const ecsVolume: batch.EcsVolume;
declare const linuxParameters: batch.LinuxParameters;
declare const logDriver: ecs.LogDriver;
declare const role: iam.Role;
declare const secret: batch.Secret;
declare const size: cdk.Size;
const ecsContainerDefinitionProps: batch.EcsContainerDefinitionProps = {
cpu: 123,
image: containerImage,
memory: size,
// the properties below are optional
command: ['command'],
enableExecuteCommand: false,
environment: {
environmentKey: 'environment',
},
executionRole: role,
jobRole: role,
linuxParameters: linuxParameters,
logging: logDriver,
readonlyRootFilesystem: false,
secrets: {
secretsKey: secret,
},
user: 'user',
volumes: [ecsVolume],
};
Properties
commandoptionalstring[]commandoptionaltyping.List[str]commandoptionalList<String>Commandoptionalstring[]Commandoptional*[]*string#Default: no command
Each vCPU is equivalent to 1,024 CPU shares. For containers running on EC2 resources, you must specify at least one vCPU.
enableExecuteCommandoptionalbooleanenable_execute_commandoptionalboolenableExecuteCommandoptionalBooleanEnableExecuteCommandoptionalboolEnableExecuteCommandoptional*bool#Default: undefined - AWS Batch default is false
notes
If true, execute command functionality is turned on all the containers in the task.
This allows you to use ECS Exec to access containers interactively. When enabled, a job role with required SSM permissions will be created automatically if no job role is provided. If a job role is alreadyprovided, the required permissions will be added to it.
environmentoptional{ [key: string]: string }environmentoptionaltyping.Mapping[str, str]environmentoptionalMap<String, String>EnvironmentoptionalIDictionary<string, string>Environmentoptional*map[string]*string#Default: no environment variables
Cannot start with AWS_BATCH. We don't recommend using plaintext environment variables for sensitive information, such as credential data.
executionRoleoptionalIRoleexecution_roleoptionalIRoleexecutionRoleoptionalIRoleExecutionRoleoptionalIRoleExecutionRoleoptionalIRole#Default: a Role will be created
imageContainerImageimageContainerImageimageContainerImageImageContainerImageImageContainerImagerequired#jobRoleoptionalIRolejob_roleoptionalIRolejobRoleoptionalIRoleJobRoleoptionalIRoleJobRoleoptionalIRole#Default: no job role
linuxParametersoptionalLinuxParameterslinux_parametersoptionalLinuxParameterslinuxParametersoptionalLinuxParametersLinuxParametersoptionalLinuxParametersLinuxParametersoptionalLinuxParameters= none#loggingoptionalLogDriverloggingoptionalLogDriverloggingoptionalLogDriverLoggingoptionalLogDriverLoggingoptionalLogDriver#Default: the log configuration of the Docker daemon
If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job.
readonlyRootFilesystemoptionalbooleanreadonly_root_filesystemoptionalboolreadonlyRootFilesystemoptionalBooleanReadonlyRootFilesystemoptionalboolReadonlyRootFilesystemoptional*bool= false#secretsoptional{ [key: string]: Secret }secretsoptionaltyping.Mapping[str, Secret]secretsoptionalMap<String, Secret>SecretsoptionalIDictionary<string, Secret>Secretsoptional*map[string]Secret#Default: no secrets
Allows your job definitions to reference the secret by the environment variable name defined in this property.
Default: no user