OptionalassignThe CloudWatch Container Insights setting
OptionalcpuOptionalcustomOptionalenableWhether to give the task IAM role access to the account's dist bucket.
This is enabled by default to avoid breaking changes, but consumers of this pattern
that pull a container image that doesn't need extra dependencies from S3
shoud set this value to false.
OptionalenvironmentOptionalmemoryOptionalsecurityOptionalstorageOptionaltaskOptionaltask
Configuration options for the [[
GuEcsTask]] pattern.Note it is recommended to use GuVpc.subnetsFromParameterFixedNumber for the subnets prop rather than GuVpc.subnetsFromParameter, as using the latter can result a custom resource being required
See [[
ContainerConfiguration]] for details of how to configure the container used to run the task.taskTimeoutInMinutesdoes what is says on the tin. The default timeout is 15 minutes.The
taskCommandprop allows you to specify a command to run when the task starts (this can also be done via a CMD statement in your Dockerfile). For example:const props = { //other props taskCommand: `aws s3 cp s3://${distbucket}/${stack}/${stage}/${app}/task.sh . && ./task.sh }
It is advisable to configure alarms for when the job fails/times out. To do this specify the alarmSnsTopicArn prop.
customTaskPoliciesallows your task to interact with other AWS services. By default a task will have read access to the distribution bucket for your account.You can specify security groups to apply to task using the
securityGroupsprop.You can also set the memory and cpu units for your task. See https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size for further details.
If you want to pass input from the step function into your EcsTask you can do so via the
environmentOverridesprop, which allows you to wire up step function input JSON to environment variables set on the container. For example, const props = { ...otherProps environmentOverrides: [ { name: "VERSION", value: JsonPath.stringAt("$.version"), }, } With the above override, your task will attempt to find aversionproperty in the JSON input passed to the step function, and apply it to the VERSION environment variable. Alternatively, you could hard code a value for the variable in CDK. See https://docs.aws.amazon.com/step-functions/latest/dg/connect-ecs.html for further detail and other override options - this construct currently only supports environment variables.