Package org.apache.camel.builder.component.dsl

Interface Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws2.ses.Ses2Component>
All Known Implementing Classes:
Aws2SesComponentBuilderFactory.Aws2SesComponentBuilderImpl
Enclosing interface:
Aws2SesComponentBuilderFactory
public static interface Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder extends ComponentBuilder<org.apache.camel.component.aws2.ses.Ses2Component>
Builder for the AWS Simple Email Service (SES) component.

  • Method Details

    • bcc

      default Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder bcc(String bcc)
      List of comma separated destination blind carbon copy (bcc) email address. Can be overridden with 'CamelAwsSesBcc' header. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      bcc - the value to set
      Returns:
      the dsl builder

    • cc

      default Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder cc(String cc)
      List of comma separated destination carbon copy (cc) email address. Can be overridden with 'CamelAwsSesCc' header. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      cc - the value to set
      Returns:
      the dsl builder

    • configuration

      default Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder configuration(org.apache.camel.component.aws2.ses.Ses2Configuration configuration)
      component configuration. The option is a: <code>org.apache.camel.component.aws2.ses.Ses2Configuration</code> type. Group: producer
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • configurationSet

      default Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder configurationSet(String configurationSet)
      Set the configuration set to send with every request. Override it with 'CamelAwsSesConfigurationSet' header. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      configurationSet - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder 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

    • overrideEndpoint

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

    • region

      default Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder region(String region)
      The region in which SES 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: producer
      Parameters:
      region - the value to set
      Returns:
      the dsl builder

    • replyToAddresses

      default Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder replyToAddresses(String replyToAddresses)
      List of comma separated reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' header. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      replyToAddresses - the value to set
      Returns:
      the dsl builder

    • returnPath

      default Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder returnPath(String returnPath)
      The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      returnPath - the value to set
      Returns:
      the dsl builder

    • subject

      default Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder subject(String subject)
      The subject which is used if the message header 'CamelAwsSesSubject' is not present. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      subject - the value to set
      Returns:
      the dsl builder

    • to

      default Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder to(String to)
      List of comma separated destination email address. Can be overridden with 'CamelAwsSesTo' header. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      to - the value to set
      Returns:
      the dsl builder

    • uriEndpointOverride

      default Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder 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: producer
      Parameters:
      uriEndpointOverride - the value to set
      Returns:
      the dsl builder

    • amazonSESClient

      default Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder amazonSESClient(software.amazon.awssdk.services.ses.SesClient amazonSESClient)
      To use the AmazonSimpleEmailService as the client. The option is a: <code>software.amazon.awssdk.services.ses.SesClient</code> type. Group: advanced
      Parameters:
      amazonSESClient - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder 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

    • healthCheckConsumerEnabled

      default Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder 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 Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder 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 Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder proxyHost(String proxyHost)
      To define a proxy host when instantiating the SES 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 Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder proxyPort(Integer proxyPort)
      To define a proxy port when instantiating the SES 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 Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
      To define a proxy protocol when instantiating the SES 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 Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder 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 Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder 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 Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder 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

    • trustAllCertificates

      default Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder 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 Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
      Set whether the Ses 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 Aws2SesComponentBuilderFactory.Aws2SesComponentBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the SES 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