software.amazon.awscdk.services.events.targets

Class ApiDestination.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiDestination>

Enclosing class:

ApiDestination

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

A fluent builder for ApiDestination.

Method Summary

Modifier and Type	Method and Description
ApiDestination	build()
static ApiDestination.Builder	create(IApiDestination apiDestination)
ApiDestination.Builder	deadLetterQueue(IQueue deadLetterQueue) The SQS queue to be used as deadLetterQueue.
ApiDestination.Builder	event(RuleTargetInput event) The event to send.
ApiDestination.Builder	eventRole(IRole eventRole) The role to assume before invoking the target.
ApiDestination.Builder	headerParameters(Map<String,String> headerParameters) Additional headers sent to the API Destination.
ApiDestination.Builder	maxEventAge(Duration maxEventAge) The maximum age of a request that Lambda sends to a function for processing.
ApiDestination.Builder	pathParameterValues(List<String> pathParameterValues) Path parameters to insert in place of path wildcards (`*`).
ApiDestination.Builder	queryStringParameters(Map<String,String> queryStringParameters) Additional query string parameters sent to the API Destination.
ApiDestination.Builder	retryAttempts(Number retryAttempts) The maximum number of times to retry when the function returns an error.

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 ApiDestination.Builder create(IApiDestination apiDestination)

Parameters:

apiDestination - This parameter is required.

Returns:

a new instance of ApiDestination.Builder.

deadLetterQueue

@Stability(value=Stable)
public ApiDestination.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 ApiDestination.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 ApiDestination.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

event

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

The event to send.

Default: - the entire EventBridge event

Parameters:

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

Returns:

this

eventRole

@Stability(value=Stable)
public ApiDestination.Builder eventRole(IRole eventRole)

The role to assume before invoking the target.

Default: - a new role will be created

Parameters:

eventRole - The role to assume before invoking the target. This parameter is required.

Returns:

this

headerParameters

@Stability(value=Stable)
public ApiDestination.Builder headerParameters(Map<String,String> headerParameters)

Additional headers sent to the API Destination.

These are merged with headers specified on the Connection, with the headers on the Connection taking precedence.

You can only specify secret values on the Connection.

Default: - none

Parameters:

headerParameters - Additional headers sent to the API Destination. This parameter is required.

Returns:

this

pathParameterValues

@Stability(value=Stable)
public ApiDestination.Builder pathParameterValues(List<String> pathParameterValues)

Path parameters to insert in place of path wildcards (`*`).

If the API destination has a wilcard in the path, these path parts will be inserted in that place.

Default: - none

Parameters:

pathParameterValues - Path parameters to insert in place of path wildcards (`*`). This parameter is required.

Returns:

this

queryStringParameters

@Stability(value=Stable)
public ApiDestination.Builder queryStringParameters(Map<String,String> queryStringParameters)

Additional query string parameters sent to the API Destination.

These are merged with headers specified on the Connection, with the headers on the Connection taking precedence.

You can only specify secret values on the Connection.

Default: - none

Parameters:

queryStringParameters - Additional query string parameters sent to the API Destination. This parameter is required.

Returns:

this

build

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

Specified by:

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