This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
commit bdec994d7bda1a81ea1daa97a547f9059d1c72e7 Author: MelissaFlinn <[email protected]> AuthorDate: Mon Jul 11 17:51:18 2022 -0400 doc-config-descriptions-edit aws and misc --- kamelets/aws-cloudwatch-sink.kamelet.yaml | 23 +++++++------- kamelets/aws-ddb-sink.kamelet.yaml | 30 ++++++++----------- kamelets/aws-ddb-streams-source.kamelet.yaml | 24 +++++++-------- kamelets/aws-ec2-sink.kamelet.yaml | 14 ++++----- kamelets/aws-kinesis-firehose-sink.kamelet.yaml | 12 ++++---- kamelets/aws-kinesis-sink.kamelet.yaml | 31 ++++++++----------- kamelets/aws-kinesis-source.kamelet.yaml | 20 ++++++------- kamelets/aws-lambda-sink.kamelet.yaml | 14 ++++----- kamelets/aws-s3-sink.kamelet.yaml | 24 +++++++-------- kamelets/aws-s3-source.kamelet.yaml | 35 +++++++++++----------- kamelets/aws-s3-streaming-upload-sink.kamelet.yaml | 10 +++---- kamelets/aws-secrets-manager-sink.kamelet.yaml | 4 +-- kamelets/aws-ses-sink.kamelet.yaml | 24 +++++++-------- kamelets/aws-sns-fifo-sink.kamelet.yaml | 12 ++++---- kamelets/aws-sns-sink.kamelet.yaml | 24 +++++++-------- kamelets/aws-sqs-batch-sink.kamelet.yaml | 12 ++++---- kamelets/aws-sqs-fifo-sink.kamelet.yaml | 12 ++++---- kamelets/aws-sqs-sink.kamelet.yaml | 24 +++++++-------- kamelets/aws-sqs-source.kamelet.yaml | 16 +++++----- kamelets/aws-translate-action.kamelet.yaml | 4 +-- kamelets/elasticsearch-search-source.kamelet.yaml | 2 +- kamelets/google-mail-source.kamelet.yaml | 2 +- kamelets/google-sheets-source.kamelet.yaml | 2 +- kamelets/salesforce-create-sink.kamelet.yaml | 2 +- kamelets/splunk-source.kamelet.yaml | 2 +- kamelets/ssh-source.kamelet.yaml | 2 +- kamelets/websocket-source.kamelet.yaml | 2 +- 27 files changed, 183 insertions(+), 200 deletions(-) diff --git a/kamelets/aws-cloudwatch-sink.kamelet.yaml b/kamelets/aws-cloudwatch-sink.kamelet.yaml index 96a5092d..2f2b7cc4 100644 --- a/kamelets/aws-cloudwatch-sink.kamelet.yaml +++ b/kamelets/aws-cloudwatch-sink.kamelet.yaml @@ -31,16 +31,13 @@ spec: definition: title: "AWS CloudWatch Metrics Sink" description: |- - Send messages to AWS CloudWatch metrics. + Send data to Amazon CloudWatch metrics. - Access Key/Secret Key are the basic method for authenticating to the AWS CloudWatch Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + 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. - When using a default Credentials Provider the CloudWatch 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. - - The Kamelet expects the following headers to be set: - - - There are several properties you can set in the headers, such as: + 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. @@ -55,7 +52,7 @@ spec: properties: cwNamespace: title: Cloud Watch Namespace - description: The cloud watch metric namespace. + description: The CloudWatch metric namespace. type: string accessKey: title: Access Key @@ -75,24 +72,24 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to. + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the CloudWatch client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: 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). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-ddb-sink.kamelet.yaml b/kamelets/aws-ddb-sink.kamelet.yaml index 32bb78b0..c8cec8e3 100644 --- a/kamelets/aws-ddb-sink.kamelet.yaml +++ b/kamelets/aws-ddb-sink.kamelet.yaml @@ -31,17 +31,13 @@ spec: definition: title: "AWS DynamoDB Sink" description: |- - Send data to AWS DynamoDB service. The sent data will insert/update/delete an item on the given AWS DynamoDB table. + Send data to Amazon DynamoDB. The sent data inserts, updates, or deletes an item on the specified AWS DynamoDB table. - Access Key/Secret Key are the basic method for authenticating to the AWS DynamoDB service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + 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. - When using a default Credentials Provider the AWS DynamoDB 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. + If you use the default credentials provider, the CloudWatch client loads the credentials through this provider and doesn't use the basic authentication method. - This Kamelet expects a JSON as body. The mapping between the JSON fields and table attribute values is done by key, so if you have the input: - - '{"username":"oscerd", "city":"Rome"}' - - The Kamelet will insert/update an item in the given AWS DynamoDB table and set the attributes 'username' and 'city' respectively. Please note that the JSON object must include the primary key values that define the item. + This Kamelet expects a JSON-formatted body and it must include the primary key values that define the DynamoDB item. The mapping between the JSON fields and table attribute values is done by key. For example, for '{"username":"oscerd", "city":"Rome"}' input, the Kamelet inserts or update an item in the specified AWS DynamoDB table and sets the values for the 'username' and 'city' attributes. required: - table - region @@ -49,11 +45,11 @@ spec: properties: table: title: Table - description: Name of the DynamoDB table to look at + description: The name of the DynamoDB table. type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -61,7 +57,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -69,35 +65,35 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] operation: title: Operation - description: The operation to perform (one of PutItem, UpdateItem, DeleteItem) + description: The operation to perform: `PutItem`, `UpdateItem`, or DeleteItem. type: string default: PutItem example: PutItem writeCapacity: title: Write Capacity - description: The provisioned throughput to reserved for writing resources to your table + description: The provisioned throughput to reserve for writing resources to your table type: integer default: 1 useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the DynamoDB client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the DynamoDB client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-ddb-streams-source.kamelet.yaml b/kamelets/aws-ddb-streams-source.kamelet.yaml index d33b50ed..e09f4e51 100644 --- a/kamelets/aws-ddb-streams-source.kamelet.yaml +++ b/kamelets/aws-ddb-streams-source.kamelet.yaml @@ -31,11 +31,11 @@ spec: definition: title: "AWS DynamoDB Streams Source" description: |- - Receive events from AWS DynamoDB Streams. + Receive events from Amazon DynamoDB Streams. - Access Key/Secret Key are the basic method for authenticating to the AWS DynamoDB Streams Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the AWS DynamoDB Streams service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the AWS DynamoDB Streams 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. + If you use the default credentials provider, the DynamoDB Streams client loads the credentials through this provider and doesn't use the basic authentication method. required: - table - region @@ -43,11 +43,11 @@ spec: properties: table: title: Table - description: Name of the DynamoDB table to look at + description: The name of the DynamoDB table. type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -55,7 +55,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -63,36 +63,36 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] streamIteratorType: title: Stream Iterator Type - description: Defines where in the DynamoDB stream to start getting records. Note that using FROM_START can cause a significant delay before the stream has caught up to real-time. There are 2 enums and the value can be one of FROM_LATEST and FROM_START + description: Defines where in the DynamoDB stream to start getting records. There are two enums and the value can be one of FROM_LATEST and FROM_START. Note that using FROM_START can cause a significant delay before the stream has caught up to real-time. type: string default: FROM_LATEST useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the AWS DynamoDB Streams client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the DynamoDB client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false delay: title: Delay - description: Milliseconds before the next poll from database + description: The number of milliseconds before the next poll from the database. type: integer default: 500 types: diff --git a/kamelets/aws-ec2-sink.kamelet.yaml b/kamelets/aws-ec2-sink.kamelet.yaml index 3ae26053..23272623 100644 --- a/kamelets/aws-ec2-sink.kamelet.yaml +++ b/kamelets/aws-ec2-sink.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- Check the status of EC2 instances - Access Key/Secret Key are the basic method for authenticating to the AWS EC2 Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + Access Key/Secret Key are the basic method for authenticating to the AWS EC2 Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. When using a default Credentials Provider the EC2 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. @@ -46,7 +46,7 @@ spec: properties: accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -54,7 +54,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -62,24 +62,24 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the EC2 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: 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). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-kinesis-firehose-sink.kamelet.yaml b/kamelets/aws-kinesis-firehose-sink.kamelet.yaml index 2756edd7..a66eaa1a 100644 --- a/kamelets/aws-kinesis-firehose-sink.kamelet.yaml +++ b/kamelets/aws-kinesis-firehose-sink.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- Send message to an AWS Kinesis Firehose Stream - Access Key/Secret Key are the basic method for authenticating to the AWS Kinesis Firehose Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + Access Key/Secret Key are the basic method for authenticating to the AWS Kinesis Firehose Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. When using a default Credentials Provider the Kinesis Firehose 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. required: @@ -47,7 +47,7 @@ spec: type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -55,7 +55,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -63,7 +63,7 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] @@ -76,11 +76,11 @@ spec: default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-kinesis-sink.kamelet.yaml b/kamelets/aws-kinesis-sink.kamelet.yaml index c4a2c9bd..cdb165b1 100644 --- a/kamelets/aws-kinesis-sink.kamelet.yaml +++ b/kamelets/aws-kinesis-sink.kamelet.yaml @@ -33,21 +33,16 @@ spec: description: |- Send data to AWS Kinesis. - Access Key/Secret Key are the basic method for authenticating to the AWS Kinesis Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the Kinesis 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. - - The Kamelet expects the following header: - - - `partition` / `ce-partition`: to set the Kinesis partition key - - If the header won't be set the exchange ID will be used. + If you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn't use the basic authentication method. + + In the header, you can optionally set the `file` / `ce-partition` property to set the Kinesis partition key. - The Kamelet is also able to recognize the following header: + If you do not set the property in the header, the Kamelet uses the exchange ID for the partition key. - - `sequence-number` / `ce-sequencenumber`: to set the Sequence number + You can also set the `sequence-number` / `ce-sequencenumber` property in the header to specify the Sequence number. - This header is optional. required: - stream - region @@ -55,11 +50,11 @@ spec: properties: stream: title: Stream Name - description: The Kinesis stream that you want to access (needs to be created in advance) + description: The Kinesis stream that you want to access. The Kinesis stream that you specify must already exist. type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -67,7 +62,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -75,24 +70,24 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the Kinesis client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the Kinesis client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-kinesis-source.kamelet.yaml b/kamelets/aws-kinesis-source.kamelet.yaml index e21e97db..d0b1f0cd 100644 --- a/kamelets/aws-kinesis-source.kamelet.yaml +++ b/kamelets/aws-kinesis-source.kamelet.yaml @@ -33,9 +33,9 @@ spec: description: |- Receive data from AWS Kinesis. - Access Key/Secret Key are the basic method for authenticating to the AWS Kinesis Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the Kinesis 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. + If you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn't use the basic authentication method. required: - stream - region @@ -43,11 +43,11 @@ spec: properties: stream: title: Stream Name - description: The Kinesis stream that you want to access (needs to be created in advance) + description: The Kinesis stream that you want to access. The Kinesis stream that you specify must already exist. type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -55,7 +55,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -63,31 +63,31 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the Kinesis client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the Kinesis client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false delay: title: Delay - description: Milliseconds before the next poll of the selected stream + description: The number of milliseconds before the next poll of the selected stream. type: integer default: 500 types: diff --git a/kamelets/aws-lambda-sink.kamelet.yaml b/kamelets/aws-lambda-sink.kamelet.yaml index ac87254c..6a422f47 100644 --- a/kamelets/aws-lambda-sink.kamelet.yaml +++ b/kamelets/aws-lambda-sink.kamelet.yaml @@ -33,9 +33,9 @@ spec: description: |- Send a payload to an AWS Lambda function. - Access Key/Secret Key are the basic method for authenticating to the AWS Lambda Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the Lambda 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. + If you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn't use the basic authentication method. required: - function - region @@ -43,11 +43,11 @@ spec: properties: function: title: Function Name - description: The Lambda Function name + description: The Lambda Function name. type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -55,7 +55,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -63,13 +63,13 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the Lambda client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the Lambda client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-s3-sink.kamelet.yaml b/kamelets/aws-s3-sink.kamelet.yaml index 595cecc8..c29b913c 100644 --- a/kamelets/aws-s3-sink.kamelet.yaml +++ b/kamelets/aws-s3-sink.kamelet.yaml @@ -31,17 +31,15 @@ spec: definition: title: "AWS S3 Sink" description: |- - Upload data to AWS S3 Bucket. + Upload data to an Amazon S3 Bucket. - Access Key/Secret Key are the basic method for authenticating to the AWS S3 Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the S3 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. + If you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn't use the basic authentication method. - The Kamelet can use the following headers to be set to: + In the header, you can optionally set the `file` / `ce-partition` property to specify the name of the file to upload. - - `file` / `ce-file`: as the file name to be uploaded - - If neither of those headers are set and the Kamelet parameter `keyName` is not populated, then the default file name used will be the `exchange id`. + If you do not set the property in the header, the Kamelet uses the exchange ID for the file name. required: - bucketNameOrArn - region @@ -49,7 +47,7 @@ spec: properties: bucketNameOrArn: title: Bucket Name - description: The S3 Bucket name or ARN. + description: The S3 Bucket name or Amazon Resource Name (ARN). type: string accessKey: title: Access Key @@ -69,31 +67,31 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to. + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] autoCreateBucket: title: Autocreate Bucket - description: Setting the autocreation of the S3 bucket bucketName. + description: Specifies to automatically create the S3 bucket. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the S3 client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-s3-source.kamelet.yaml b/kamelets/aws-s3-source.kamelet.yaml index b1ced663..41c47cba 100644 --- a/kamelets/aws-s3-source.kamelet.yaml +++ b/kamelets/aws-s3-source.kamelet.yaml @@ -14,11 +14,11 @@ spec: definition: title: "AWS S3 Source" description: |- - Receive data from AWS S3 Bucket. + Receive data from an Amazon S3 Bucket. - Access Key/Secret Key are the basic method for authenticating to the AWS S3 Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. - - When using a default Credentials Provider the S3 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. + The basic authentication method for the Kinesis 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 Kinesis client loads the credentials through this provider and doesn't use the basic authentication method. required: - bucketNameOrArn - region @@ -26,18 +26,18 @@ spec: properties: bucketNameOrArn: title: Bucket Name - description: The S3 Bucket name or ARN + description: The S3 Bucket name or Amazon Resource Name (ARN). type: string deleteAfterRead: title: Auto-delete Objects - description: Delete objects after consuming them + description: Specifies to delete objects after consuming them. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: true accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -45,7 +45,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -53,57 +53,58 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] autoCreateBucket: title: Autocreate Bucket - description: Setting the autocreation of the S3 bucket bucketName. + description: Specifies to automatically create the S3 bucket. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false includeBody: title: Include Body - description: If it is true, the exchange will be consumed and put into the body and closed. If false the S3Object stream will be put raw into the body and the headers will be set with the S3 object metadata. + description: If true, the exchange is consumed and put into the body and closed. If false, the S3Object stream is put raw into the body and the headers are set with the S3 object metadata. + "type" : "boolean", type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: true prefix: title: Prefix - description: The AWS S3 bucket prefix to consider while searching + description: The AWS S3 bucket prefix to consider while searching. type: string example: 'folder/' ignoreBody: title: Ignore Body - description: If it is true, the S3 Object Body will be ignored completely, if it is set to false the S3 Object will be put in the body. Setting this to true, will override any behavior defined by includeBody option. + description: If true, the S3 Object body is ignored. Setting this to true overrides any behavior defined by the `includeBody` option. If false, the S3 object is put in the body. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the S3 client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false delay: title: Delay - description: Milliseconds before the next poll of the selected bucket + description: The number of milliseconds before the next poll of the selected bucket. type: integer default: 500 dependencies: diff --git a/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml b/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml index f07c6172..e03068f8 100644 --- a/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml +++ b/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- Upload data to AWS S3 in streaming upload mode. - Access Key/Secret Key are the basic method for authenticating to the AWS S3 Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + Access Key/Secret Key are the basic method for authenticating to the AWS S3 Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. When using a default Credentials Provider the S3 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. required: @@ -44,7 +44,7 @@ spec: properties: bucketNameOrArn: title: Bucket Name - description: The S3 Bucket name or ARN. + description: The S3 Bucket name or Amazon Resource Name (ARN).. type: string accessKey: title: Access Key @@ -64,7 +64,7 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to. + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] @@ -119,11 +119,11 @@ spec: default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-secrets-manager-sink.kamelet.yaml b/kamelets/aws-secrets-manager-sink.kamelet.yaml index fe97378f..2f468afe 100644 --- a/kamelets/aws-secrets-manager-sink.kamelet.yaml +++ b/kamelets/aws-secrets-manager-sink.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- Create a secret in AWS Secrets Manager. - Access Key/Secret Key are the basic method for authenticating to the AWS Secrets Manager Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + Access Key/Secret Key are the basic method for authenticating to the AWS Secrets Manager Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. When using a default Credentials Provider the Secrets Manager 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. @@ -64,7 +64,7 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to. + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] diff --git a/kamelets/aws-ses-sink.kamelet.yaml b/kamelets/aws-ses-sink.kamelet.yaml index e4e89143..86e3c186 100644 --- a/kamelets/aws-ses-sink.kamelet.yaml +++ b/kamelets/aws-ses-sink.kamelet.yaml @@ -31,21 +31,19 @@ spec: definition: title: "AWS SES Sink" description: |- - Send Email through AWS SES Service. + Send email through the Amazon Simple Email Service (SES). - Access Key/Secret Key are the basic method for authenticating to the AWS SES Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the SES 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. - - The Kamelet expects the following headers to be set: - - - `subject` / `ce-subject`: The email subject - - If the header won't be set the exchange ID will be used as email subject. + If you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn't use the basic authentication method. + + In the header, you can optionally set the following properties: + + - `subject` / `ce-subject` property to specify the email subject. If you do not set this property in the header, the Kamelet uses the exchange ID for the email subject. - - `to` / `ce-to`: a comma separated list of email addresses + - `to` / `ce-to` to provide a comma-separated list of email addresses. - - `reply-to-addresses` / `ce-reply-to-addresses`: a comma separated list of reply-to email addresses + - `reply-to-addresses` / `ce-reply-to-addresses`to provider a comma-separated list of reply-to email addresses. required: - from @@ -75,13 +73,13 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to. + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the SES client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the SES client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-sns-fifo-sink.kamelet.yaml b/kamelets/aws-sns-fifo-sink.kamelet.yaml index 17d4a8f4..f4df0f31 100644 --- a/kamelets/aws-sns-fifo-sink.kamelet.yaml +++ b/kamelets/aws-sns-fifo-sink.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- Send message to an AWS SNS FIFO Topic. - Access Key/Secret Key are the basic method for authenticating to the AWS SNS Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + Access Key/Secret Key are the basic method for authenticating to the AWS SNS Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. When using a default Credentials Provider the SNS 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. @@ -51,7 +51,7 @@ spec: type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -59,7 +59,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -67,7 +67,7 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] @@ -94,11 +94,11 @@ spec: default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-sns-sink.kamelet.yaml b/kamelets/aws-sns-sink.kamelet.yaml index 84c1cb0d..79c0072d 100644 --- a/kamelets/aws-sns-sink.kamelet.yaml +++ b/kamelets/aws-sns-sink.kamelet.yaml @@ -31,15 +31,13 @@ spec: definition: title: AWS SNS Sink description: |- - Send message to an AWS SNS Topic. + Send message to an Amazon Simple Notification Service (SNS) topic. - Access Key/Secret Key are the basic method for authenticating to the AWS SNS Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - When using a default Credentials Provider the SNS 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. + If you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn't use the basic authentication method. - The Kamelet expects the following headers to be set: - - - `subject` / `ce-subject`: the subject of the message + In the header, you can optionally set the `subject` / `ce-subject` property to specify the subject of the message. required: - topicNameOrArn - region @@ -47,11 +45,11 @@ spec: properties: topicNameOrArn: title: Topic Name - description: The SQS Topic name or ARN + description: The SNS topic name name or Amazon Resource Name (ARN). type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -59,7 +57,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -67,7 +65,7 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] @@ -80,18 +78,18 @@ spec: default: false useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the SNS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the SNS client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-sqs-batch-sink.kamelet.yaml b/kamelets/aws-sqs-batch-sink.kamelet.yaml index 9b85a829..3e9a39ee 100644 --- a/kamelets/aws-sqs-batch-sink.kamelet.yaml +++ b/kamelets/aws-sqs-batch-sink.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- Send Batch message to an AWS SQS Queue. - Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + 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. required: @@ -48,7 +48,7 @@ spec: type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -56,7 +56,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -64,7 +64,7 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] @@ -100,11 +100,11 @@ spec: default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-sqs-fifo-sink.kamelet.yaml b/kamelets/aws-sqs-fifo-sink.kamelet.yaml index b282c75d..2bb86413 100644 --- a/kamelets/aws-sqs-fifo-sink.kamelet.yaml +++ b/kamelets/aws-sqs-fifo-sink.kamelet.yaml @@ -34,7 +34,7 @@ spec: Send message to an AWS SQS FIFO Queue. - Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + 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. required: @@ -48,7 +48,7 @@ spec: type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -56,7 +56,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -64,7 +64,7 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] @@ -102,11 +102,11 @@ spec: default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-sqs-sink.kamelet.yaml b/kamelets/aws-sqs-sink.kamelet.yaml index 25b344a4..7b1ab311 100644 --- a/kamelets/aws-sqs-sink.kamelet.yaml +++ b/kamelets/aws-sqs-sink.kamelet.yaml @@ -31,11 +31,11 @@ spec: definition: title: AWS SQS Sink description: |- - Send message to an AWS SQS Queue. + Send messages to an Amazon Simple Queue Service (SQS) queue. - Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + The basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. - 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. + If you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn't use the basic authentication method. required: - queueNameOrArn - region @@ -43,11 +43,11 @@ spec: properties: queueNameOrArn: title: Queue Name - description: The SQS Queue name or ARN + description: The SQS Queue name or or Amazon Resource Name (ARN). type: string accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -55,7 +55,7 @@ spec: - urn:camel:group:credentials secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -63,13 +63,13 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] autoCreateQueue: title: Autocreate Queue - description: Setting the autocreation of the SQS queue. + description: Automatically create the SQS queue. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' @@ -81,24 +81,24 @@ spec: default: amazonaws.com protocol: title: Protocol - description: The underlying protocol used to communicate with SQS + description: The underlying protocol used to communicate with SQS. type: string example: http or https default: https useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the SQS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the SQS client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' diff --git a/kamelets/aws-sqs-source.kamelet.yaml b/kamelets/aws-sqs-source.kamelet.yaml index 7d0d56e9..d8e1182b 100644 --- a/kamelets/aws-sqs-source.kamelet.yaml +++ b/kamelets/aws-sqs-source.kamelet.yaml @@ -34,7 +34,7 @@ spec: 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 provide also the 'useDefaultCredentialsProvider'. + 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. required: @@ -55,7 +55,7 @@ spec: default: true accessKey: title: Access Key - description: The access key obtained from AWS + description: The access key obtained from AWS. type: string format: password x-descriptors: @@ -65,7 +65,7 @@ spec: - urn:keda:required secretKey: title: Secret Key - description: The secret key obtained from AWS + description: The secret key obtained from AWS. type: string format: password x-descriptors: @@ -75,7 +75,7 @@ spec: - urn:keda:required region: title: AWS Region - description: The AWS region to connect to + description: The AWS region to access. type: string example: eu-west-1 x-descriptors: @@ -109,25 +109,25 @@ spec: - urn:keda:required useDefaultCredentialsProvider: title: Default Credentials Provider - description: Set whether the SQS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. + description: If true, the SQS client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false uriEndpointOverride: title: Overwrite Endpoint URI - description: Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. + description: The overriding endpoint URI. To use this option, you must also select the `overrideEndpoint` option. type: string overrideEndpoint: title: Endpoint Overwrite - description: Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. + description: Select this option to override the endpoint URI. To use this option, you must also provide a URI for the `uriEndpointOverride` option. type: boolean x-descriptors: - 'urn:alm:descriptor:com.tectonic.ui:checkbox' default: false delay: title: Delay - description: Milliseconds before the next poll of the selected stream + description: The number of milliseconds before the next poll of the selected stream type: integer default: 500 dependencies: diff --git a/kamelets/aws-translate-action.kamelet.yaml b/kamelets/aws-translate-action.kamelet.yaml index fced614e..18279ca0 100644 --- a/kamelets/aws-translate-action.kamelet.yaml +++ b/kamelets/aws-translate-action.kamelet.yaml @@ -33,7 +33,7 @@ spec: description: |- Translate a text in a specific language. - Access Key/Secret Key are the basic method for authenticating to the AWS Translate Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'. + Access Key/Secret Key are the basic method for authenticating to the AWS Translate Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. When using a default Credentials Provider the Translate 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. required: @@ -60,7 +60,7 @@ spec: - urn:camel:group:credentials region: title: AWS Region - description: The AWS region to connect to. + description: The AWS region to access. type: string example: eu-west-1 enum: ["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 [...] diff --git a/kamelets/elasticsearch-search-source.kamelet.yaml b/kamelets/elasticsearch-search-source.kamelet.yaml index 9ace230b..13c3d261 100644 --- a/kamelets/elasticsearch-search-source.kamelet.yaml +++ b/kamelets/elasticsearch-search-source.kamelet.yaml @@ -78,7 +78,7 @@ spec: type: string clusterName: title: ElasticSearch Cluster Name - description: Name of the cluster. + description: The name of the cluster. type: string types: out: diff --git a/kamelets/google-mail-source.kamelet.yaml b/kamelets/google-mail-source.kamelet.yaml index 7acd0299..7b36c7f6 100644 --- a/kamelets/google-mail-source.kamelet.yaml +++ b/kamelets/google-mail-source.kamelet.yaml @@ -78,7 +78,7 @@ spec: - urn:camel:group:credentials delay: title: Delay - description: Milliseconds before the next poll + description: The number of milliseconds before the next poll type: integer default: 500 applicationName: diff --git a/kamelets/google-sheets-source.kamelet.yaml b/kamelets/google-sheets-source.kamelet.yaml index 675d0395..186643a3 100644 --- a/kamelets/google-sheets-source.kamelet.yaml +++ b/kamelets/google-sheets-source.kamelet.yaml @@ -77,7 +77,7 @@ spec: - urn:camel:group:credentials delay: title: Delay - description: Milliseconds before the next poll + description: The number of milliseconds before the next poll type: integer default: 500 repeatCount: diff --git a/kamelets/salesforce-create-sink.kamelet.yaml b/kamelets/salesforce-create-sink.kamelet.yaml index 1b018d78..2abff764 100644 --- a/kamelets/salesforce-create-sink.kamelet.yaml +++ b/kamelets/salesforce-create-sink.kamelet.yaml @@ -32,7 +32,7 @@ spec: description: |- Creates an object in Salesforce. - The body of the message must contain the JSON of the Salesforce object. For example: `{ "Phone": "555", "Name": "Antonia", "LastName": "Garcia" }` + The body of the message must contain the JSON of the Salesforce object. For example: `{ "Phone": "555", "Name": "Antonia", "LastName": "Garcia" }`. required: - clientId - clientSecret diff --git a/kamelets/splunk-source.kamelet.yaml b/kamelets/splunk-source.kamelet.yaml index 3440990b..40fc705a 100644 --- a/kamelets/splunk-source.kamelet.yaml +++ b/kamelets/splunk-source.kamelet.yaml @@ -99,7 +99,7 @@ spec: type: integer delay: title: Delay - description: Milliseconds before the next poll. + description: The number of milliseconds before the next poll. type: integer query: title: Query diff --git a/kamelets/ssh-source.kamelet.yaml b/kamelets/ssh-source.kamelet.yaml index 3398bc4e..be16f666 100644 --- a/kamelets/ssh-source.kamelet.yaml +++ b/kamelets/ssh-source.kamelet.yaml @@ -64,7 +64,7 @@ spec: - urn:camel:group:credentials delay: title: Delay - description: Milliseconds before the next poll + description: The number of milliseconds before the next poll type: integer default: 500 pollCommand: diff --git a/kamelets/websocket-source.kamelet.yaml b/kamelets/websocket-source.kamelet.yaml index 38e7a455..c551cdab 100644 --- a/kamelets/websocket-source.kamelet.yaml +++ b/kamelets/websocket-source.kamelet.yaml @@ -30,7 +30,7 @@ spec: default: 9292 resourceUri: title: Resource Uri - description: Name of the websocket channel to use. + description: The name of the websocket channel to use. type: string maxBinaryMessageSize: title: Max Binary Message Size
