Package software.amazon.awscdk.services.events.targets

Class ApiGateway.Builder

java.lang.Object
software.amazon.awscdk.services.events.targets.ApiGateway.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<ApiGateway>
Enclosing class:
ApiGateway
@Stability(Stable) public static final class ApiGateway.Builder extends Object implements software.amazon.jsii.Builder<ApiGateway>
A fluent builder for ApiGateway.

  • Method Details

    • create

      @Stability(Stable) public static ApiGateway.Builder create(RestApi restApi)
      Parameters:
      restApi - This parameter is required.
      Returns:
      a new instance of ApiGateway.Builder.

    • deadLetterQueue

      @Stability(Stable) public ApiGateway.Builder deadLetterQueue(IQueue deadLetterQueue)
      The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue.

      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. This parameter is required.
      Returns:
      this

    • maxEventAge

      @Stability(Stable) public ApiGateway.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(Stable) public ApiGateway.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

    • eventRole

      @Stability(Stable) public ApiGateway.Builder eventRole(IRole eventRole)
      The role to assume before invoking the target (i.e., the pipeline) when the given rule is triggered.

      Default: - a new role will be created

      Parameters:
      eventRole - The role to assume before invoking the target (i.e., the pipeline) when the given rule is triggered. This parameter is required.
      Returns:
      this

    • headerParameters

      @Stability(Stable) public ApiGateway.Builder headerParameters(Map<String,String> headerParameters)
      The headers to be set when requesting API.

      Default: no header parameters

      Parameters:
      headerParameters - The headers to be set when requesting API. This parameter is required.
      Returns:
      this

    • method

      @Stability(Stable) public ApiGateway.Builder method(String method)
      The method for api resource invoked by the rule.

      Default: '*' that treated as ANY

      Parameters:
      method - The method for api resource invoked by the rule. This parameter is required.
      Returns:
      this

    • path

      @Stability(Stable) public ApiGateway.Builder path(String 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.

      Default: '/'

      Parameters:
      path - The api resource invoked by the rule. This parameter is required.
      Returns:
      this

    • pathParameterValues

      @Stability(Stable) public ApiGateway.Builder pathParameterValues(List<String> pathParameterValues)
      The path parameter values to be used to populate to wildcards("*") of requesting api path.

      Default: no path parameters

      Parameters:
      pathParameterValues - The path parameter values to be used to populate to wildcards("*") of requesting api path. This parameter is required.
      Returns:
      this

    • postBody

      @Stability(Stable) public ApiGateway.Builder postBody(RuleTargetInput postBody)
      This will be the post request body send to the API.

      Default: the entire EventBridge event

      Parameters:
      postBody - This will be the post request body send to the API. This parameter is required.
      Returns:
      this

    • queryStringParameters

      @Stability(Stable) public ApiGateway.Builder queryStringParameters(Map<String,String> queryStringParameters)
      The query parameters to be set when requesting API.

      Default: no querystring parameters

      Parameters:
      queryStringParameters - The query parameters to be set when requesting API. This parameter is required.
      Returns:
      this

    • stage

      @Stability(Stable) public ApiGateway.Builder stage(String stage)
      The deploy stage of api gateway invoked by the rule.

      Default: the value of deploymentStage.stageName of target api gateway.

      Parameters:
      stage - The deploy stage of api gateway invoked by the rule. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public ApiGateway build()
      Specified by:
      build in interface software.amazon.jsii.Builder<ApiGateway>
      Returns:
      a newly built instance of ApiGateway.