Interface Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws2.eventbridge.EventbridgeComponent>
All Known Implementing Classes:
Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilderImpl
Enclosing interface:
Aws2EventbridgeComponentBuilderFactory
public static interface Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder extends ComponentBuilder<org.apache.camel.component.aws2.eventbridge.EventbridgeComponent>
Builder for the AWS Eventbridge component.

  • Method Details

    • configuration

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder configuration(org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration configuration)
      Component configuration. The option is a: <code>org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration</code> type. Group: common
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • eventPatternFile

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder eventPatternFile(String eventPatternFile)
      EventPattern File. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      eventPatternFile - the value to set
      Returns:
      the dsl builder

    • operation

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder operation(org.apache.camel.component.aws2.eventbridge.EventbridgeOperations operation)
      The operation to perform. The option is a: <code>org.apache.camel.component.aws2.eventbridge.EventbridgeOperations</code> type. Default: putRule Group: common
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder overrideEndpoint(boolean overrideEndpoint)
      Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder

    • pojoRequest

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder pojoRequest(boolean pojoRequest)
      If we want to use a POJO request as body or not. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      pojoRequest - the value to set
      Returns:
      the dsl builder

    • region

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder region(String region)
      The region in which the Eventbridge client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id(). The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      region - the value to set
      Returns:
      the dsl builder

    • uriEndpointOverride

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder uriEndpointOverride(String uriEndpointOverride)
      Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      uriEndpointOverride - the value to set
      Returns:
      the dsl builder

    • autoCreateQueue

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder autoCreateQueue(boolean autoCreateQueue)
      Whether to auto-create an SQS queue and wire it as an EventBridge rule target. The option is a: <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      autoCreateQueue - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • deleteQueueOnShutdown

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder deleteQueueOnShutdown(boolean deleteQueueOnShutdown)
      Whether to delete the auto-created SQS queue and remove the EventBridge target on shutdown. The option is a: <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      deleteQueueOnShutdown - the value to set
      Returns:
      the dsl builder

    • maxMessagesPerPoll

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder maxMessagesPerPoll(int maxMessagesPerPoll)
      The maximum number of messages to receive per poll from SQS. The option is a: <code>int</code> type. Default: 10 Group: consumer
      Parameters:
      maxMessagesPerPoll - the value to set
      Returns:
      the dsl builder

    • queueUrl

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder queueUrl(String queueUrl)
      The URL of an existing SQS queue to use as EventBridge target. If not specified, a queue is auto-created when autoCreateQueue is true. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      queueUrl - the value to set
      Returns:
      the dsl builder

    • ruleName

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder ruleName(String ruleName)
      The EventBridge rule name to consume events from. Required for consumer. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      ruleName - the value to set
      Returns:
      the dsl builder

    • visibilityTimeout

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder visibilityTimeout(int visibilityTimeout)
      The duration (in seconds) that received SQS messages are hidden from subsequent receive requests. The option is a: <code>int</code> type. Default: 30 Group: consumer
      Parameters:
      visibilityTimeout - the value to set
      Returns:
      the dsl builder

    • waitTimeSeconds

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder waitTimeSeconds(int waitTimeSeconds)
      The duration (in seconds) for which the SQS receive call waits for messages (long polling). The option is a: <code>int</code> type. Default: 20 Group: consumer
      Parameters:
      waitTimeSeconds - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder lazyStartProducer(boolean lazyStartProducer)
      Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • eventbridgeClient

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder eventbridgeClient(software.amazon.awssdk.services.eventbridge.EventBridgeClient eventbridgeClient)
      To use an existing configured AWS Eventbridge client. The option is a: <code>software.amazon.awssdk.services.eventbridge.EventBridgeClient</code> type. Group: advanced
      Parameters:
      eventbridgeClient - the value to set
      Returns:
      the dsl builder

    • healthCheckConsumerEnabled

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder healthCheckConsumerEnabled(boolean healthCheckConsumerEnabled)
      Used for enabling or disabling all consumer based health checks from this component. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckConsumerEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckProducerEnabled

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder healthCheckProducerEnabled(boolean healthCheckProducerEnabled)
      Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckProducerEnabled - the value to set
      Returns:
      the dsl builder

    • proxyHost

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder proxyHost(String proxyHost)
      To define a proxy host when instantiating the Eventbridge client. The option is a: <code>java.lang.String</code> type. Group: proxy
      Parameters:
      proxyHost - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder proxyPort(Integer proxyPort)
      To define a proxy port when instantiating the Eventbridge client. The option is a: <code>java.lang.Integer</code> type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • proxyProtocol

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
      To define a proxy protocol when instantiating the Eventbridge client. The option is a: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy
      Parameters:
      proxyProtocol - the value to set
      Returns:
      the dsl builder

    • accessKey

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder accessKey(String accessKey)
      Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      accessKey - the value to set
      Returns:
      the dsl builder

    • profileCredentialsName

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder profileCredentialsName(String profileCredentialsName)
      If using a profile credentials provider this parameter will set the profile name. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      profileCredentialsName - the value to set
      Returns:
      the dsl builder

    • secretKey

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder secretKey(String secretKey)
      Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      secretKey - the value to set
      Returns:
      the dsl builder

    • sessionToken

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder sessionToken(String sessionToken)
      Amazon AWS Session Token used when the user needs to assume an IAM role. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sessionToken - the value to set
      Returns:
      the dsl builder

    • trustAllCertificates

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder trustAllCertificates(boolean trustAllCertificates)
      If we want to trust all certificates in case of overriding the endpoint. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      trustAllCertificates - the value to set
      Returns:
      the dsl builder

    • useDefaultCredentialsProvider

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
      Set whether the Eventbridge client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useProfileCredentialsProvider

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the Eventbridge client should expect to load credentials through a profile credentials provider. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useProfileCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useSessionCredentials

      default Aws2EventbridgeComponentBuilderFactory.Aws2EventbridgeComponentBuilder useSessionCredentials(boolean useSessionCredentials)
      Set whether the Eventbridge client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Eventbridge. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder