camel-aws2-cw-kafka-connector sink configuration
Connector Description: Sending metrics to AWS CloudWatch using AWS SDK version 2.x.
When using camel-aws2-cw-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-aws2-cw-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
To use this Sink connector in Kafka connect you’ll need to set the following connector.class
connector.class=org.apache.camel.kafkaconnector.aws2cw.CamelAws2cwSinkConnector
The camel-aws2-cw sink connector supports 35 options, which are listed below.
Name | Description | Default | Required | Priority |
---|---|---|---|---|
camel.sink.path.namespace |
The metric namespace |
null |
true |
HIGH |
camel.sink.endpoint.amazonCwClient |
To use the AmazonCloudWatch as the client |
null |
false |
MEDIUM |
camel.sink.endpoint.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. |
false |
false |
MEDIUM |
camel.sink.endpoint.name |
The metric name |
null |
false |
MEDIUM |
camel.sink.endpoint.overrideEndpoint |
Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option |
false |
false |
MEDIUM |
camel.sink.endpoint.proxyHost |
To define a proxy host when instantiating the CW client |
null |
false |
MEDIUM |
camel.sink.endpoint.proxyPort |
To define a proxy port when instantiating the CW client |
null |
false |
MEDIUM |
camel.sink.endpoint.proxyProtocol |
To define a proxy protocol when instantiating the CW client One of: [HTTP] [HTTPS] |
"HTTPS" |
false |
MEDIUM |
camel.sink.endpoint.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() |
null |
false |
MEDIUM |
camel.sink.endpoint.timestamp |
The metric timestamp |
null |
false |
MEDIUM |
camel.sink.endpoint.trustAllCertificates |
If we want to trust all certificates in case of overriding the endpoint |
false |
false |
MEDIUM |
camel.sink.endpoint.unit |
The metric unit |
null |
false |
MEDIUM |
camel.sink.endpoint.uriEndpointOverride |
Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option |
null |
false |
MEDIUM |
camel.sink.endpoint.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. |
false |
false |
MEDIUM |
camel.sink.endpoint.value |
The metric value |
null |
false |
MEDIUM |
camel.sink.endpoint.accessKey |
Amazon AWS Access Key |
null |
false |
MEDIUM |
camel.sink.endpoint.secretKey |
Amazon AWS Secret Key |
null |
false |
MEDIUM |
camel.component.aws2-cw.amazonCwClient |
To use the AmazonCloudWatch as the client |
null |
false |
MEDIUM |
camel.component.aws2-cw.configuration |
The component configuration |
null |
false |
MEDIUM |
camel.component.aws2-cw.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. |
false |
false |
MEDIUM |
camel.component.aws2-cw.name |
The metric name |
null |
false |
MEDIUM |
camel.component.aws2-cw.overrideEndpoint |
Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option |
false |
false |
MEDIUM |
camel.component.aws2-cw.proxyHost |
To define a proxy host when instantiating the CW client |
null |
false |
MEDIUM |
camel.component.aws2-cw.proxyPort |
To define a proxy port when instantiating the CW client |
null |
false |
MEDIUM |
camel.component.aws2-cw.proxyProtocol |
To define a proxy protocol when instantiating the CW client One of: [HTTP] [HTTPS] |
"HTTPS" |
false |
MEDIUM |
camel.component.aws2-cw.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() |
null |
false |
MEDIUM |
camel.component.aws2-cw.timestamp |
The metric timestamp |
null |
false |
MEDIUM |
camel.component.aws2-cw.trustAllCertificates |
If we want to trust all certificates in case of overriding the endpoint |
false |
false |
MEDIUM |
camel.component.aws2-cw.unit |
The metric unit |
null |
false |
MEDIUM |
camel.component.aws2-cw.uriEndpointOverride |
Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option |
null |
false |
MEDIUM |
camel.component.aws2-cw.useDefaultCredentials Provider |
Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. |
false |
false |
MEDIUM |
camel.component.aws2-cw.value |
The metric value |
null |
false |
MEDIUM |
camel.component.aws2-cw.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. |
true |
false |
MEDIUM |
camel.component.aws2-cw.accessKey |
Amazon AWS Access Key |
null |
false |
MEDIUM |
camel.component.aws2-cw.secretKey |
Amazon AWS Secret Key |
null |
false |
MEDIUM |
The camel-aws2-cw sink connector has no converters out of the box.
The camel-aws2-cw sink connector has no transforms out of the box.
The camel-aws2-cw sink connector has no aggregation strategies out of the box.