software.amazon.awscdk.services.events.targets

Class ApiDestinationProps.Builder

java.lang.Object

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

Enclosing interface:

ApiDestinationProps

public static final class ApiDestinationProps.Builder
extends java.lang.Object

A builder for ApiDestinationProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ApiDestinationProps	build() Builds the configured instance.
ApiDestinationProps.Builder	deadLetterQueue(IQueue deadLetterQueue) Sets the value of TargetBaseProps.getDeadLetterQueue()
ApiDestinationProps.Builder	event(RuleTargetInput event) Sets the value of ApiDestinationProps.getEvent()
ApiDestinationProps.Builder	eventRole(IRole eventRole) Sets the value of ApiDestinationProps.getEventRole()
ApiDestinationProps.Builder	headerParameters(java.util.Map<java.lang.String,java.lang.String> headerParameters) Sets the value of ApiDestinationProps.getHeaderParameters()
ApiDestinationProps.Builder	maxEventAge(Duration maxEventAge) Sets the value of TargetBaseProps.getMaxEventAge()
ApiDestinationProps.Builder	pathParameterValues(java.util.List<java.lang.String> pathParameterValues) Sets the value of ApiDestinationProps.getPathParameterValues()
ApiDestinationProps.Builder	queryStringParameters(java.util.Map<java.lang.String,java.lang.String> queryStringParameters) Sets the value of ApiDestinationProps.getQueryStringParameters()
ApiDestinationProps.Builder	retryAttempts(java.lang.Number retryAttempts) Sets the value of TargetBaseProps.getRetryAttempts()

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

event

public ApiDestinationProps.Builder event(RuleTargetInput event)

Sets the value of ApiDestinationProps.getEvent()

Parameters:

event - The event to send.

Returns:

this

eventRole

public ApiDestinationProps.Builder eventRole(IRole eventRole)

Sets the value of ApiDestinationProps.getEventRole()

Parameters:

eventRole - The role to assume before invoking the target.

Returns:

this

headerParameters

public ApiDestinationProps.Builder headerParameters(java.util.Map<java.lang.String,java.lang.String> headerParameters)

Sets the value of ApiDestinationProps.getHeaderParameters()

Parameters:

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.

Returns:

this

pathParameterValues

public ApiDestinationProps.Builder pathParameterValues(java.util.List<java.lang.String> pathParameterValues)

Sets the value of ApiDestinationProps.getPathParameterValues()

Parameters:

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.

Returns:

this

queryStringParameters

public ApiDestinationProps.Builder queryStringParameters(java.util.Map<java.lang.String,java.lang.String> queryStringParameters)

Sets the value of ApiDestinationProps.getQueryStringParameters()

Parameters:

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.

Returns:

this

deadLetterQueue

public ApiDestinationProps.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

public ApiDestinationProps.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

public ApiDestinationProps.Builder retryAttempts(java.lang.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

public ApiDestinationProps build()

Builds the configured instance.

Returns:

a new instance of ApiDestinationProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided