software.amazon.awscdk.services.events.targets

Class ApiGatewayProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiGatewayProps>

Enclosing interface:

ApiGatewayProps

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

A builder for ApiGatewayProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ApiGatewayProps	build() Builds the configured instance.
ApiGatewayProps.Builder	deadLetterQueue(IQueue deadLetterQueue) Sets the value of TargetBaseProps.getDeadLetterQueue()
ApiGatewayProps.Builder	eventRole(IRole eventRole) Sets the value of ApiGatewayProps.getEventRole()
ApiGatewayProps.Builder	headerParameters(Map<String,String> headerParameters) Sets the value of ApiGatewayProps.getHeaderParameters()
ApiGatewayProps.Builder	maxEventAge(Duration maxEventAge) Sets the value of TargetBaseProps.getMaxEventAge()
ApiGatewayProps.Builder	method(String method) Sets the value of ApiGatewayProps.getMethod()
ApiGatewayProps.Builder	path(String path) Sets the value of ApiGatewayProps.getPath()
ApiGatewayProps.Builder	pathParameterValues(List<String> pathParameterValues) Sets the value of ApiGatewayProps.getPathParameterValues()
ApiGatewayProps.Builder	postBody(RuleTargetInput postBody) Sets the value of ApiGatewayProps.getPostBody()
ApiGatewayProps.Builder	queryStringParameters(Map<String,String> queryStringParameters) Sets the value of ApiGatewayProps.getQueryStringParameters()
ApiGatewayProps.Builder	retryAttempts(Number retryAttempts) Sets the value of TargetBaseProps.getRetryAttempts()
ApiGatewayProps.Builder	stage(String stage) Sets the value of ApiGatewayProps.getStage()

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

eventRole

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

Sets the value of ApiGatewayProps.getEventRole()

Parameters:

eventRole - The role to assume before invoking the target (i.e., the pipeline) when the given rule is triggered.

Returns:

this

headerParameters

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

Sets the value of ApiGatewayProps.getHeaderParameters()

Parameters:

headerParameters - The headers to be set when requesting API.

Returns:

this

method

@Stability(value=Stable)
public ApiGatewayProps.Builder method(String method)

Sets the value of ApiGatewayProps.getMethod()

Parameters:

method - The method for api resource invoked by the rule.

Returns:

this

path

@Stability(value=Stable)
public ApiGatewayProps.Builder path(String path)

Sets the value of ApiGatewayProps.getPath()

Parameters:

path - The api resource invoked by the rule. We can use wildcards('*') to specify the path. In that case, an equal number of real values must be specified for pathParameterValues.

Returns:

this

pathParameterValues

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

Sets the value of ApiGatewayProps.getPathParameterValues()

Parameters:

pathParameterValues - The path parameter values to be used to populate to wildcards("*") of requesting api path.

Returns:

this

postBody

@Stability(value=Stable)
public ApiGatewayProps.Builder postBody(RuleTargetInput postBody)

Sets the value of ApiGatewayProps.getPostBody()

Parameters:

postBody - This will be the post request body send to the API.

Returns:

this

queryStringParameters

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

Sets the value of ApiGatewayProps.getQueryStringParameters()

Parameters:

queryStringParameters - The query parameters to be set when requesting API.

Returns:

this

stage

@Stability(value=Stable)
public ApiGatewayProps.Builder stage(String stage)

Sets the value of ApiGatewayProps.getStage()

Parameters:

stage - The deploy stage of api gateway invoked by the rule.

Returns:

this

deadLetterQueue

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ApiGatewayProps

Throws:

NullPointerException - if any required attribute was not provided