aws sns fifo sink AWS SNS FIFO Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Send message to an AWS SNS FIFO Topic.

Configuration Options

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

Property Name Description Type Default Example

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

topicNameOrArn

Topic Name

Required The SNS Topic name or ARN.

string

accessKey

Access Key

The access key obtained from AWS.

string

autoCreateTopic

Autocreate Topic

Setting the autocreation of the SNS topic.

boolean

false

contentBasedDeduplication

Content-Based Deduplication

Use content-based deduplication (should be enabled in the SQS FIFO queue first).

boolean

false

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

Set whether the SNS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.

boolean

false

useProfileCredentialsProvider

Profile Credentials Provider

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

boolean

false

useSessionCredentials

Session Credentials

Set whether the SNS 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 SNS.

boolean

false

Dependencies

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

  • camel:aws2-sns

  • camel:core

  • 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-sns-fifo-sink"

You can now run it directly through the following command

camel run route.yaml

AWS SNS FIFO Sink Kamelet Description

Authentication methods

In this Kamelet you have the possibility of avoiding the usage of explicit static credentials by specifying the useDefaultCredentialsProvider option and set it to true.

The order of evaluation for Default Credentials Provider is the following:

  • Java system properties - aws.accessKeyId and aws.secretKey.

  • Environment variables - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.

  • Web Identity Token from AWS STS.

  • The shared credentials and config files.

  • Amazon ECS container credentials - loaded from the Amazon ECS if the environment variable AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set.

  • Amazon EC2 Instance profile credentials.

You have also the possibility of using Profile Credentials Provider, by specifying the useProfileCredentialsProvider option to true and profileCredentialsName to the profile name.

Only one of access key/secret key or default credentials provider could be used

For more information about this you can look at AWS credentials documentation

Optional Headers

In the Kamelet you can optionally set the following header:

  • subject / ce-subject: the subject of the message

Kamelet source file

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

Back to top