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

Interface Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws2.cw.Cw2Component>
All Known Implementing Classes:
Aws2CwComponentBuilderFactory.Aws2CwComponentBuilderImpl
Enclosing interface:
Aws2CwComponentBuilderFactory
public static interface Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder extends ComponentBuilder<org.apache.camel.component.aws2.cw.Cw2Component>
Builder for the AWS CloudWatch component.

  • Method Details

    • configuration

      default Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder configuration(org.apache.camel.component.aws2.cw.Cw2Configuration configuration)
      The component configuration. The option is a: <code>org.apache.camel.component.aws2.cw.Cw2Configuration</code> type. Group: producer
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder 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

    • name

      default Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder name(String name)
      The metric name. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      name - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder 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 Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder region(String region)
      The region in which CW 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

    • timestamp

      default Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder timestamp(Instant timestamp)
      The metric timestamp. The option is a: <code>java.time.Instant</code> type. Group: producer
      Parameters:
      timestamp - the value to set
      Returns:
      the dsl builder

    • unit

      default Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder unit(String unit)
      The metric unit. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      unit - the value to set
      Returns:
      the dsl builder

    • uriEndpointOverride

      default Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder 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

    • value

      default Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder value(Double value)
      The metric value. The option is a: <code>java.lang.Double</code> type. Group: producer
      Parameters:
      value - the value to set
      Returns:
      the dsl builder

    • amazonCwClient

      default Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder amazonCwClient(software.amazon.awssdk.services.cloudwatch.CloudWatchClient amazonCwClient)
      To use the AmazonCloudWatch as the client. The option is a: <code>software.amazon.awssdk.services.cloudwatch.CloudWatchClient</code> type. Group: advanced
      Parameters:
      amazonCwClient - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder 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 Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder 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 Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder 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 Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder proxyHost(String proxyHost)
      To define a proxy host when instantiating the CW 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 Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder proxyPort(Integer proxyPort)
      To define a proxy port when instantiating the CW 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 Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
      To define a proxy protocol when instantiating the CW 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 Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder 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 Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder 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 Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder 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 Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder 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 Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
      Set whether the S3 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 Aws2CwComponentBuilderFactory.Aws2CwComponentBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the Cloudwatch 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