software.amazon.awscdk.services.events.targets

Class BatchJobProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<BatchJobProps>

Enclosing interface:

BatchJobProps

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

A builder for BatchJobProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
BatchJobProps.Builder	attempts(Number attempts) Sets the value of BatchJobProps.getAttempts()
BatchJobProps	build() Builds the configured instance.
BatchJobProps.Builder	deadLetterQueue(IQueue deadLetterQueue) Sets the value of TargetBaseProps.getDeadLetterQueue()
BatchJobProps.Builder	event(RuleTargetInput event) Sets the value of BatchJobProps.getEvent()
BatchJobProps.Builder	jobName(String jobName) Sets the value of BatchJobProps.getJobName()
BatchJobProps.Builder	maxEventAge(Duration maxEventAge) Sets the value of TargetBaseProps.getMaxEventAge()
BatchJobProps.Builder	retryAttempts(Number retryAttempts) Sets the value of TargetBaseProps.getRetryAttempts()
BatchJobProps.Builder	size(Number size) Sets the value of BatchJobProps.getSize()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

attempts

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

Sets the value of BatchJobProps.getAttempts()

Parameters:

attempts - The number of times to attempt to retry, if the job fails. Valid values are 1–10.

Returns:

this

event

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

Sets the value of BatchJobProps.getEvent()

Parameters:

event - The event to send to the Lambda. This will be the payload sent to the Lambda Function.

Returns:

this

jobName

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

Sets the value of BatchJobProps.getJobName()

Parameters:

jobName - The name of the submitted job.

Returns:

this

size

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

Sets the value of BatchJobProps.getSize()

Parameters:

size - The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.

Returns:

this

deadLetterQueue

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

Sets the value of TargetBaseProps.getDeadLetterQueue()

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). 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.

Returns:

this

maxEventAge

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

Sets the value of TargetBaseProps.getMaxEventAge()

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. Minimum value of 60. Maximum value of 86400.

Returns:

this

retryAttempts

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

Sets the value of TargetBaseProps.getRetryAttempts()

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. Minimum value of 0. Maximum value of 185.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of BatchJobProps

Throws:

NullPointerException - if any required attribute was not provided