This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit ae600e3bcf31b9904802fa4bfc4717272fa7095f
Author: Otavio Rodolfo Piske <angusyo...@gmail.com>
AuthorDate: Fri Feb 9 17:36:39 2024 +0100
(chores) camel-aws-cloudtrail: documentation fixes
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../camel/catalog/components/aws-cloudtrail.json | 4 ++--
.../camel/component/aws/cloudtrail/aws-cloudtrail.json | 4 ++--
.../src/main/docs/aws-cloudtrail-component.adoc | 18 ++++++++++--------
.../aws/cloudtrail/CloudtrailConfiguration.java | 2 +-
4 files changed, 15 insertions(+), 13 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-cloudtrail.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-cloudtrail.json
index 55720d588a0..55c09121336 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-cloudtrail.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-cloudtrail.json
@@ -27,7 +27,7 @@
"configuration": { "index": 1, "kind": "property", "displayName":
"Configuration", "group": "consumer", "label": "", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"deprecated": false, "autowired": false, "secret": false, "description":
"Component configuration" },
"eventSource": { "index": 2, "kind": "property", "displayName": "Event
Source", "group": "consumer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Specify an event source
to select events" },
"maxResults": { "index": 3, "kind": "property", "displayName": "Max
Results", "group": "consumer", "label": "", "required": false, "type":
"integer", "javaType": "int", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": 1, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Maximum number of
records that will be fetched in each poll" },
- "overrideEndpoint": { "index": 4, "kind": "property", "displayName":
"Override Endpoint", "group": "consumer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Set the need for
overidding the endpoint. This option needs to be used in co [...]
+ "overrideEndpoint": { "index": 4, "kind": "property", "displayName":
"Override Endpoint", "group": "consumer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Set the need for
overriding the endpoint. This option needs to be used in co [...]
"region": { "index": 5, "kind": "property", "displayName": "Region",
"group": "consumer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "ap-south-2", "ap-south-1",
"eu-south-1", "eu-south-2", "us-gov-east-1", "me-central-1", "il-central-1",
"ca-central-1", "eu-central-1", "us-iso-west-1", "eu-central-2", "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-nor [...]
"uriEndpointOverride": { "index": 6, "kind": "property", "displayName":
"Uri Endpoint Override", "group": "consumer", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Set the overriding uri
endpoint. This option needs to be used in combination with ov [...]
"autowiredEnabled": { "index": 7, "kind": "property", "displayName":
"Autowired Enabled", "group": "advanced", "label": "advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"Whether autowiring is enabled. This is used for automatic autowiring options
(the option must be marked as autowired) by looking up in the registry to find
if there is a single instance of matching t [...]
@@ -56,7 +56,7 @@
"label": { "index": 0, "kind": "path", "displayName": "Label", "group":
"consumer", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "A label for indexing
cloudtrail endpoints" },
"eventSource": { "index": 1, "kind": "parameter", "displayName": "Event
Source", "group": "consumer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Specify an event source
to select events" },
"maxResults": { "index": 2, "kind": "parameter", "displayName": "Max
Results", "group": "consumer", "label": "", "required": false, "type":
"integer", "javaType": "int", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": 1, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Maximum number of
records that will be fetched in each poll" },
- "overrideEndpoint": { "index": 3, "kind": "parameter", "displayName":
"Override Endpoint", "group": "consumer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Set the need for
overidding the endpoint. This option needs to be used in c [...]
+ "overrideEndpoint": { "index": 3, "kind": "parameter", "displayName":
"Override Endpoint", "group": "consumer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Set the need for
overriding the endpoint. This option needs to be used in c [...]
"region": { "index": 4, "kind": "parameter", "displayName": "Region",
"group": "consumer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "ap-south-2", "ap-south-1",
"eu-south-1", "eu-south-2", "us-gov-east-1", "me-central-1", "il-central-1",
"ca-central-1", "eu-central-1", "us-iso-west-1", "eu-central-2", "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-no [...]
"sendEmptyMessageWhenIdle": { "index": 5, "kind": "parameter",
"displayName": "Send Empty Message When Idle", "group": "consumer", "label":
"consumer", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
false, "description": "If the polling consumer did not poll any files, you can
enable this option to send an empty message (no body) instead." },
"uriEndpointOverride": { "index": 6, "kind": "parameter", "displayName":
"Uri Endpoint Override", "group": "consumer", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Set the overriding uri
endpoint. This option needs to be used in combination with o [...]
diff --git
a/components/camel-aws/camel-aws-cloudtrail/src/generated/resources/org/apache/camel/component/aws/cloudtrail/aws-cloudtrail.json
b/components/camel-aws/camel-aws-cloudtrail/src/generated/resources/org/apache/camel/component/aws/cloudtrail/aws-cloudtrail.json
index 55720d588a0..55c09121336 100644
---
a/components/camel-aws/camel-aws-cloudtrail/src/generated/resources/org/apache/camel/component/aws/cloudtrail/aws-cloudtrail.json
+++
b/components/camel-aws/camel-aws-cloudtrail/src/generated/resources/org/apache/camel/component/aws/cloudtrail/aws-cloudtrail.json
@@ -27,7 +27,7 @@
"configuration": { "index": 1, "kind": "property", "displayName":
"Configuration", "group": "consumer", "label": "", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"deprecated": false, "autowired": false, "secret": false, "description":
"Component configuration" },
"eventSource": { "index": 2, "kind": "property", "displayName": "Event
Source", "group": "consumer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Specify an event source
to select events" },
"maxResults": { "index": 3, "kind": "property", "displayName": "Max
Results", "group": "consumer", "label": "", "required": false, "type":
"integer", "javaType": "int", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": 1, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Maximum number of
records that will be fetched in each poll" },
- "overrideEndpoint": { "index": 4, "kind": "property", "displayName":
"Override Endpoint", "group": "consumer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Set the need for
overidding the endpoint. This option needs to be used in co [...]
+ "overrideEndpoint": { "index": 4, "kind": "property", "displayName":
"Override Endpoint", "group": "consumer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Set the need for
overriding the endpoint. This option needs to be used in co [...]
"region": { "index": 5, "kind": "property", "displayName": "Region",
"group": "consumer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "ap-south-2", "ap-south-1",
"eu-south-1", "eu-south-2", "us-gov-east-1", "me-central-1", "il-central-1",
"ca-central-1", "eu-central-1", "us-iso-west-1", "eu-central-2", "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-nor [...]
"uriEndpointOverride": { "index": 6, "kind": "property", "displayName":
"Uri Endpoint Override", "group": "consumer", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Set the overriding uri
endpoint. This option needs to be used in combination with ov [...]
"autowiredEnabled": { "index": 7, "kind": "property", "displayName":
"Autowired Enabled", "group": "advanced", "label": "advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"Whether autowiring is enabled. This is used for automatic autowiring options
(the option must be marked as autowired) by looking up in the registry to find
if there is a single instance of matching t [...]
@@ -56,7 +56,7 @@
"label": { "index": 0, "kind": "path", "displayName": "Label", "group":
"consumer", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "A label for indexing
cloudtrail endpoints" },
"eventSource": { "index": 1, "kind": "parameter", "displayName": "Event
Source", "group": "consumer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Specify an event source
to select events" },
"maxResults": { "index": 2, "kind": "parameter", "displayName": "Max
Results", "group": "consumer", "label": "", "required": false, "type":
"integer", "javaType": "int", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": 1, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Maximum number of
records that will be fetched in each poll" },
- "overrideEndpoint": { "index": 3, "kind": "parameter", "displayName":
"Override Endpoint", "group": "consumer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Set the need for
overidding the endpoint. This option needs to be used in c [...]
+ "overrideEndpoint": { "index": 3, "kind": "parameter", "displayName":
"Override Endpoint", "group": "consumer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Set the need for
overriding the endpoint. This option needs to be used in c [...]
"region": { "index": 4, "kind": "parameter", "displayName": "Region",
"group": "consumer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "ap-south-2", "ap-south-1",
"eu-south-1", "eu-south-2", "us-gov-east-1", "me-central-1", "il-central-1",
"ca-central-1", "eu-central-1", "us-iso-west-1", "eu-central-2", "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-no [...]
"sendEmptyMessageWhenIdle": { "index": 5, "kind": "parameter",
"displayName": "Send Empty Message When Idle", "group": "consumer", "label":
"consumer", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
false, "description": "If the polling consumer did not poll any files, you can
enable this option to send an empty message (no body) instead." },
"uriEndpointOverride": { "index": 6, "kind": "parameter", "displayName":
"Uri Endpoint Override", "group": "consumer", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws.cloudtrail.CloudtrailConfiguration",
"configurationField": "configuration", "description": "Set the overriding uri
endpoint. This option needs to be used in combination with o [...]
diff --git
a/components/camel-aws/camel-aws-cloudtrail/src/main/docs/aws-cloudtrail-component.adoc
b/components/camel-aws/camel-aws-cloudtrail/src/main/docs/aws-cloudtrail-component.adoc
index 95d2cb8bd6b..1df1864e876 100644
---
a/components/camel-aws/camel-aws-cloudtrail/src/main/docs/aws-cloudtrail-component.adoc
+++
b/components/camel-aws/camel-aws-cloudtrail/src/main/docs/aws-cloudtrail-component.adoc
@@ -21,20 +21,20 @@ service.
Prerequisites
You must have a valid Amazon Web Services developer account, and be
-signed up to use Amazon Cloudtrail. More information are available
+signed up to use Amazon Cloudtrail. More information is available
at https://aws.amazon.com/cloudtrail/[AWS Cloudtrail]
== Static credentials, Default Credential Provider and Profile Credentials
Provider
-You have the possibility of avoiding the usage of explicit static credentials,
by specifying the useDefaultCredentialsProvider option and set it to true.
+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.
+ - 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 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.
@@ -49,9 +49,11 @@ For more information about this you can look at
https://docs.aws.amazon.com/sdk-
aws-cloudtrail://label[?options]
-----------------------------------
-The stream needs to be created prior to it being used. +
- You can append query options to the URI in the following format,
-?options=value&option2=value&...
+The stream needs to be created prior to it being used.
+
+You can append query options to the URI in the following format:
+
+`?options=value&option2=value&...`
// component-configure options: START
diff --git
a/components/camel-aws/camel-aws-cloudtrail/src/main/java/org/apache/camel/component/aws/cloudtrail/CloudtrailConfiguration.java
b/components/camel-aws/camel-aws-cloudtrail/src/main/java/org/apache/camel/component/aws/cloudtrail/CloudtrailConfiguration.java
index 4dce2dc5f2b..e42efe9e17f 100644
---
a/components/camel-aws/camel-aws-cloudtrail/src/main/java/org/apache/camel/component/aws/cloudtrail/CloudtrailConfiguration.java
+++
b/components/camel-aws/camel-aws-cloudtrail/src/main/java/org/apache/camel/component/aws/cloudtrail/CloudtrailConfiguration.java
@@ -61,7 +61,7 @@ public class CloudtrailConfiguration implements Cloneable {
@UriParam(label = "security", description = "If we want to trust all
certificates in case of overriding the endpoint")
private boolean trustAllCertificates;
@UriParam(defaultValue = "false",
- description = "Set the need for overidding the endpoint. This
option needs to be used in combination with uriEndpointOverride option")
+ description = "Set the need for overriding the endpoint. This
option needs to be used in combination with uriEndpointOverride option")
private boolean overrideEndpoint;
@UriParam(description = "Set the overriding uri endpoint. This option
needs to be used in combination with overrideEndpoint option")
private String uriEndpointOverride;
