aws eventbridge sink AWS Eventbridge Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Send events to an Amazon Eventbridge Eventbus.

The basic authentication method for the Eventbridge 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 Eventbridge client loads the credentials through this provider and doesn’t use the basic authentication method.

In the headers, you need to set the resources-arn / ce-resources-arn property to specify the ARN of resources related to the event.

In the headers, you need to set the detail-type / ce-detail-type property to specify the detail type related to the event.

In the headers, you need to set the event-source / ce-event-source property to specify the event source related to the event.

If you do not set the property in the header, the Kamelet uses the exchange ID for the file name.

Configuration Options

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

Property Name Description Type Default Example

eventbusNameOrArn

Eventbus Name

Required The Eventbridge Eventbus name or Amazon Resource Name (ARN).

string

region

AWS Region

Required The AWS region to access.

Enum values:

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

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

secretKey

Secret Key

The secret key obtained from AWS.

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 Eventbridge client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).

boolean

false

Dependencies

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

  • camel:core

  • camel:aws2-eventbridge

  • camel:kamelet

Usage

This section describes how you can use the aws-eventbridge-sink.

Knative sink

You can use the aws-eventbridge-sink Kamelet as a Knative sink by binding it to a Knative object.

aws-eventbridge-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: aws-eventbridge-sink-binding
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: aws-eventbridge-sink
    properties:
      eventbusNameOrArn: The Eventbus Name
      region: The AWS Region

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the aws-eventbridge-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f aws-eventbridge-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind aws-eventbridge-sink -p "sink.eventbusNameOrArn=The Eventbus Name" -p "sink.region=The AWS Region" channel:mychannel

This command creates the KameletBinding in the current namespace on the cluster.

Kafka sink

You can use the aws-eventbridge-sink Kamelet as a Kafka sink by binding it to a Kafka topic.

aws-eventbridge-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: aws-eventbridge-sink-binding
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: aws-eventbridge-sink
    properties:
      eventbusNameOrArn: The Eventbus Name
      region: The AWS Region

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the aws-eventbridge-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f aws-eventbridge-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind aws-eventbridge-sink -p "sink.eventbusNameOrArn=The Eventbus Name" -p "sink.region=The AWS Region" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This command creates the KameletBinding in the current namespace on the cluster.