
Create an AWS Batch job definition object.
Source:R/crew_definition_aws_batch.R
crew_definition_aws_batch.Rd
Create an R6
object to manage a job definition for AWS
Batch jobs.
Usage
crew_definition_aws_batch(
job_queue,
job_definition = paste0("crew-aws-batch-job-definition-", crew::crew_random_name()),
log_group = "/aws/batch/job",
config = NULL,
credentials = NULL,
endpoint = NULL,
region = NULL
)
Arguments
- job_queue
Character vector of names of AWS Batch job queues. As of
crew.aws.batch
version 0.0.8 and above, you can supply more than one job queue. Methods likejobs()
andactive()
will query all the job queues given.- job_definition
Character of length 1, name of the AWS Batch job definition. The job definition might or might not exist at the time
crew_definition_aws_batch()
is called. Either way is fine.- log_group
Character of length 1, AWS Batch CloudWatch log group to get job logs. The default log group is often
"/aws/batch/job"
, but not always. It is not easy to get the log group of an active job or job definition, so if you have a non-default log group and you do not know its name, please consult your system administrator.- config
Optional named list,
config
argument ofpaws.compute::batch()
with optional configuration details.- credentials
Optional named list.
credentials
argument ofpaws.compute::batch()
with optional credentials (if not already provided through environment variables such asAWS_ACCESS_KEY_ID
).- endpoint
Optional character of length 1.
endpoint
argument ofpaws.compute::batch()
with the endpoint to send HTTP requests.- region
Character of length 1.
region
argument ofpaws.compute::batch()
with an AWS region string such as"us-east-2"
. Serves as the region for both AWS Batch and CloudWatch. Tries to default topaws.common::get_config()$region
, then toSys.getenv("AWS_REGION")
if unsuccessful, thenSys.getenv("AWS_REGION")
, thenSys.getenv("AWS_DEFAULT_REGION")
.
IAM policies
In order for the AWS Batch crew
job definition class to function
properly, your IAM policy needs permission to perform the
RegisterJobDefinition
, DeregisterJobDefinition
, and
DescribeJobDefinitions
AWS Batch API calls.
For more information on AWS policies and permissions, please visit
https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html.
See also
Other definition:
crew_class_definition_aws_batch