software.amazon.awscdk.services.events.targets

Class BatchJob.Builder

java.lang.Object

software.amazon.awscdk.services.events.targets.BatchJob.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BatchJob>

Enclosing class:

BatchJob

@Stability(value=Stable)
public static final class BatchJob.Builder
extends Object
implements software.amazon.jsii.Builder<BatchJob>

A fluent builder for BatchJob.

Method Summary

Modifier and Type	Method and Description
BatchJob.Builder	attempts(Number attempts) The number of times to attempt to retry, if the job fails.
BatchJob	build()
static BatchJob.Builder	create(String jobQueueArn, software.constructs.IConstruct jobQueueScope, String jobDefinitionArn, software.constructs.IConstruct jobDefinitionScope)
BatchJob.Builder	deadLetterQueue(IQueue deadLetterQueue) The SQS queue to be used as deadLetterQueue.
BatchJob.Builder	event(RuleTargetInput event) The event to send to the Lambda.
BatchJob.Builder	jobName(String jobName) The name of the submitted job.
BatchJob.Builder	maxEventAge(Duration maxEventAge) The maximum age of a request that Lambda sends to a function for processing.
BatchJob.Builder	retryAttempts(Number retryAttempts) The maximum number of times to retry when the function returns an error.
BatchJob.Builder	size(Number size) The size of the array, if this is an array batch job.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static BatchJob.Builder create(String jobQueueArn,
                                                               software.constructs.IConstruct jobQueueScope,
                                                               String jobDefinitionArn,
                                                               software.constructs.IConstruct jobDefinitionScope)

Parameters:

jobQueueArn - The JobQueue arn. This parameter is required.

jobQueueScope - The JobQueue Resource. This parameter is required.

jobDefinitionArn - The jobDefinition arn. This parameter is required.

jobDefinitionScope - The JobQueue Resource. This parameter is required.

Returns:

a new instance of BatchJob.Builder.

deadLetterQueue

@Stability(value=Stable)
public BatchJob.Builder deadLetterQueue(IQueue deadLetterQueue)

The SQS queue to be used as deadLetterQueue. Check out the [considerations for using a dead-letter queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations).

The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.

Default: - no dead-letter queue

Parameters:

deadLetterQueue - The SQS queue to be used as deadLetterQueue. Check out the [considerations for using a dead-letter queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations). This parameter is required.

Returns:

this

maxEventAge

@Stability(value=Stable)
public BatchJob.Builder maxEventAge(Duration maxEventAge)

The maximum age of a request that Lambda sends to a function for processing.

Minimum value of 60. Maximum value of 86400.

Default: Duration.hours(24)

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. This parameter is required.

Returns:

this

retryAttempts

@Stability(value=Stable)
public BatchJob.Builder retryAttempts(Number retryAttempts)

The maximum number of times to retry when the function returns an error.

Minimum value of 0. Maximum value of 185.

Default: 185

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. This parameter is required.

Returns:

this

attempts

@Stability(value=Stable)
public BatchJob.Builder attempts(Number attempts)

The number of times to attempt to retry, if the job fails.

Valid values are 1–10.

Default: no retryStrategy is set

Parameters:

attempts - The number of times to attempt to retry, if the job fails. This parameter is required.

Returns:

this

event

@Stability(value=Stable)
public BatchJob.Builder event(RuleTargetInput event)

The event to send to the Lambda.

This will be the payload sent to the Lambda Function.

Default: the entire EventBridge event

Parameters:

event - The event to send to the Lambda. This parameter is required.

Returns:

this

jobName

@Stability(value=Stable)
public BatchJob.Builder jobName(String jobName)

The name of the submitted job.

Default: - Automatically generated

Parameters:

jobName - The name of the submitted job. This parameter is required.

Returns:

this

size

@Stability(value=Stable)
public BatchJob.Builder size(Number size)

The size of the array, if this is an array batch job.

Valid values are integers between 2 and 10,000.

Default: no arrayProperties are set

Parameters:

size - The size of the array, if this is an array batch job. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public BatchJob build()

Specified by:

build in interface software.amazon.jsii.Builder<BatchJob>