diff --git a/docs/modules/ROOT/partials/aws-sqs-sink-description.adoc b/docs/modules/ROOT/partials/aws-sqs-sink-description.adoc new file mode 100644 index 000000000..535276875 --- /dev/null +++ b/docs/modules/ROOT/partials/aws-sqs-sink-description.adoc @@ -0,0 +1,20 @@ +== AWS SQS 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 https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html[AWS credentials documentation] diff --git a/docs/modules/ROOT/partials/aws-sqs-source-description.adoc b/docs/modules/ROOT/partials/aws-sqs-source-description.adoc new file mode 100644 index 000000000..189efbb1f --- /dev/null +++ b/docs/modules/ROOT/partials/aws-sqs-source-description.adoc @@ -0,0 +1,20 @@ +== AWS SQS Source 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 https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html[AWS credentials documentation] diff --git a/kamelets/aws-sqs-sink.kamelet.yaml b/kamelets/aws-sqs-sink.kamelet.yaml index d81a76447..164b65db9 100644 --- a/kamelets/aws-sqs-sink.kamelet.yaml +++ b/kamelets/aws-sqs-sink.kamelet.yaml @@ -31,12 +31,7 @@ metadata: spec: definition: title: AWS SQS Sink - description: |- - Send messages to an Amazon Simple Queue Service (SQS) queue. - - The basic authentication method for the SQS 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 SQS client loads the credentials through this provider and doesn't use the basic authentication method. + description: Send messages to an Amazon Simple Queue Service (SQS) queue. required: - queueNameOrArn - region diff --git a/kamelets/aws-sqs-source.kamelet.yaml b/kamelets/aws-sqs-source.kamelet.yaml index dded39901..0dc1156b7 100644 --- a/kamelets/aws-sqs-source.kamelet.yaml +++ b/kamelets/aws-sqs-source.kamelet.yaml @@ -32,14 +32,7 @@ metadata: spec: definition: title: "AWS SQS Source" - description: |- - Receive data from AWS SQS. - - Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. - - When using a default Credentials Provider the SQS client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. - - Two headers will be duplicated with different names for clarity at sink level, CamelAwsSqsMessageId will be duplicated into aws.sqs.message.id and CamelAwsSqsReceiptHandle will be duplicated in aws.sqs.receipt.handle + description: Receive data from AWS SQS. required: - queueNameOrArn - region diff --git a/library/camel-kamelets/src/main/resources/kamelets/aws-sqs-sink.kamelet.yaml b/library/camel-kamelets/src/main/resources/kamelets/aws-sqs-sink.kamelet.yaml index d81a76447..164b65db9 100644 --- a/library/camel-kamelets/src/main/resources/kamelets/aws-sqs-sink.kamelet.yaml +++ b/library/camel-kamelets/src/main/resources/kamelets/aws-sqs-sink.kamelet.yaml @@ -31,12 +31,7 @@ metadata: spec: definition: title: AWS SQS Sink - description: |- - Send messages to an Amazon Simple Queue Service (SQS) queue. - - The basic authentication method for the SQS 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 SQS client loads the credentials through this provider and doesn't use the basic authentication method. + description: Send messages to an Amazon Simple Queue Service (SQS) queue. required: - queueNameOrArn - region diff --git a/library/camel-kamelets/src/main/resources/kamelets/aws-sqs-source.kamelet.yaml b/library/camel-kamelets/src/main/resources/kamelets/aws-sqs-source.kamelet.yaml index dded39901..0dc1156b7 100644 --- a/library/camel-kamelets/src/main/resources/kamelets/aws-sqs-source.kamelet.yaml +++ b/library/camel-kamelets/src/main/resources/kamelets/aws-sqs-source.kamelet.yaml @@ -32,14 +32,7 @@ metadata: spec: definition: title: "AWS SQS Source" - description: |- - Receive data from AWS SQS. - - Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. - - When using a default Credentials Provider the SQS client will load the credentials through this provider and won't use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. - - Two headers will be duplicated with different names for clarity at sink level, CamelAwsSqsMessageId will be duplicated into aws.sqs.message.id and CamelAwsSqsReceiptHandle will be duplicated in aws.sqs.receipt.handle + description: Receive data from AWS SQS. required: - queueNameOrArn - region