aws cloudwatch sink AWS CloudWatch Metrics Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Send data to Amazon CloudWatch metrics.

The basic authentication method for the AWS CloudWatch metrics service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider.

If you use the default credentials provider, the CloudWatch client loads the credentials through this provider and doesn’t use the basic authentication method.

You can set the following properties in the header:

metric-name / ce-metricname for the metric name. metric-value / ce-metricvalue for the metric value. metric-unit / ce-metricunit for the metric unit. metric-timestamp / ce-metrictimestamp for the metric timestamp. metric-dimension-name / ce-metricdimensionname for the dimension name. metric-dimension-value / ce-metricdimensionvalue for the dimension value.

Configuration Options

The following table summarizes the configuration options available for the aws-cloudwatch-sink Kamelet:

Property Name Description Type Default Example

cwNamespace

Cloud Watch Namespace

Required The CloudWatch metric namespace.

string

region

AWS Region

Required The AWS region to access.

Enum values:

* ap-south-1 * eu-south-1 * us-gov-east-1 * me-central-1 * ca-central-1 * eu-central-1 * us-iso-west-1 * us-west-1 * us-west-2 * af-south-1 * eu-north-1 * eu-west-3 * eu-west-2 * eu-west-1 * ap-northeast-3 * ap-northeast-2 * ap-northeast-1 * me-south-1 * sa-east-1 * ap-east-1 * cn-north-1 * us-gov-west-1 * ap-southeast-1 * ap-southeast-2 * us-iso-east-1 * ap-southeast-3 * us-east-1 * us-east-2 * cn-northwest-1 * us-isob-east-1 * aws-global * aws-cn-global * aws-us-gov-global * aws-iso-global * aws-iso-b-global

string

accessKey

Access Key

The access key obtained from AWS.

string

overrideEndpoint

Endpoint Overwrite

Select this option to override the endpoint URI. To use this option, you must also provide a URI for the uriEndpointOverride option.

boolean

false

profileCredentialsName

Profile Credentials Name

If using a profile credentials provider this parameter will set the profile name.

string

secretKey

Secret Key

The secret key obtained from AWS.

string

sessionToken

Session Token

Amazon AWS Session Token used when the user needs to assume a IAM role.

string

uriEndpointOverride

Overwrite Endpoint URI

The overriding endpoint URI. To use this option, you must also select the overrideEndpoint option.

string

useDefaultCredentialsProvider

Default Credentials Provider

If true, the Cloudwatch client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

Set whether the Cloudwatch client should expect to load credentials through a profile credentials provider.

boolean

false

useSessionCredentials

Session Credentials

Set whether the Cloudwatch client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Cloudwatch.

boolean

false

Dependencies

At runtime, the aws-cloudwatch-sink Kamelet relies upon the presence of the following dependencies:

  • camel:core

  • camel:aws2-cw

  • camel:kamelet

Camel JBang usage

Prerequisites

  • You’ve installed JBang.

  • You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:aws-cloudwatch-sink"

You can now run it directly through the following command

camel run route.yaml

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/aws-cloudwatch-sink.kamelet.yaml

Back to top