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

Class AppSync.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static AppSync.Builder create(IGraphqlApi appsyncApi)
      Parameters:
      appsyncApi - This parameter is required.
      Returns:
      a new instance of AppSync.Builder.

    • deadLetterQueue

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

    • graphQlOperation

      @Stability(Stable) public AppSync.Builder graphQlOperation(String graphQlOperation)
      The GraphQL operation;

      that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service.

      Parameters:
      graphQlOperation - The GraphQL operation;. This parameter is required.
      Returns:
      this

    • eventRole

      @Stability(Stable) public AppSync.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 with permissions to access mutations 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

    • variables

      @Stability(Stable) public AppSync.Builder variables(RuleTargetInput variables)
      The variables that are include in the GraphQL operation.

      Default: - The entire event is used

      Parameters:
      variables - The variables that are include in the GraphQL operation. This parameter is required.
      Returns:
      this

    • build

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