Components
Type: aws:core:batchExecActivity
Description
Allows custom code to be run inside a Docker image on AWS Batch on a schedule.
When using an aws:core:batchExecActivity, a compute environment is required to execute the Docker image.
Currently only Fargate is supported.
The "command" is the same as that would be sent to a docker image on execution.
schedule: Fourths|Sixth|Twelfths|etc or a cron(...) or rate(...) expression
Either a lot unit can be provided, or a cron expression or rate expression.
See https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html
enabled: true|false
Whether to enable the rule that schedules the activity.
Toggle this value to simply disable the schedule without deleting/removing the activity.
imagePath: A relative path
The path to the Docker image to build.
imageBuildArgs: {key: value, ...}
The arguments to pass to the Docker build tool.
imageBuildCacheEnabled: true|false
Whether to enable the Docker build cache. Disable to force a rebuild of the image specified by
the imagePath.
imageExtraHash: A string value
An extra value to include in the image hash. Use this to force a rebuild of the image.
environment: {key: value, ...}
The environment variables to set in the Docker image.
command: [command, ...]
The command to execute in the Docker image.
batchRuntimeProps: These only apply to the AWS Batch job that executes the Docker image.
Template
Required
{
"type" : "aws:core:batchExecActivity",
"name" : null,
"schedule" : null,
"computeEnvironmentRef" : null,
"imagePath" : null,
"pathURI" : null
}
All
{
"type" : "aws:core:batchExecActivity",
"name" : null,
"exclude" : false,
"schedule" : null,
"enabled" : true,
"batchRuntimeProps" : {
"memorySizeMB" : 1024,
"vCpu" : 0.25,
"retryAttempts" : 1,
"timeoutMin" : 60,
"architecture" : "X86_64"
},
"computeEnvironmentRef" : null,
"imagePath" : null,
"imageBuildArgs" : { },
"imageBuildCacheEnabled" : true,
"imageExtraHash" : null,
"environment" : { },
"command" : [ ],
"bucketRef" : null,
"pathURI" : null
}