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 9cd10e24473c9d82ce3fe2574204467f4a25b9d4
Author: Otavio Rodolfo Piske <angusyo...@gmail.com>
AuthorDate: Fri Feb 9 15:04:50 2024 +0100
(chores) camel-aws2-cw: documentation fixes
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../org/apache/camel/catalog/components/aws2-cw.json | 20 ++++++++++----------
.../org/apache/camel/component/aws2/cw/aws2-cw.json | 20 ++++++++++----------
.../src/main/docs/aws2-cw-component.adoc | 12 ++++++------
.../camel/component/aws2/cw/Cw2Configuration.java | 12 ++++++------
4 files changed, 32 insertions(+), 32 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-cw.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-cw.json
index b01e1404b66..6135e9ef5f0 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-cw.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-cw.json
@@ -26,8 +26,8 @@
"configuration": { "index": 0, "kind": "property", "displayName":
"Configuration", "group": "producer", "label": "", "required": false, "type":
"object", "javaType": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"deprecated": false, "autowired": false, "secret": false, "description": "The
component configuration" },
"lazyStartProducer": { "index": 1, "kind": "property", "displayName":
"Lazy Start Producer", "group": "producer", "label": "producer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Whether the producer should be started lazy (on the first message). By
starting lazy you can use this to allow CamelContext and routes to startup in
situations where a producer may otherwise fail [...]
"name": { "index": 2, "kind": "property", "displayName": "Name", "group":
"producer", "label": "", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "The metric name" },
- "overrideEndpoint": { "index": 3, "kind": "property", "displayName":
"Override Endpoint", "group": "producer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set the need for overidding the endpoint. This
option needs to be used in combination with [...]
- "region": { "index": 4, "kind": "property", "displayName": "Region",
"group": "producer", "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 [...]
+ "overrideEndpoint": { "index": 3, "kind": "property", "displayName":
"Override Endpoint", "group": "producer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set the need for overriding the endpoint. This
option needs to be used in combination with [...]
+ "region": { "index": 4, "kind": "property", "displayName": "Region",
"group": "producer", "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 [...]
"timestamp": { "index": 5, "kind": "property", "displayName": "Timestamp",
"group": "producer", "label": "", "required": false, "type": "object",
"javaType": "java.time.Instant", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "The metric timestamp" },
"unit": { "index": 6, "kind": "property", "displayName": "Unit", "group":
"producer", "label": "", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "The metric unit" },
"uriEndpointOverride": { "index": 7, "kind": "property", "displayName":
"Uri Endpoint Override", "group": "producer", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set the overriding uri endpoint. This option
needs to be used in combination with overrideEndpoint [...]
@@ -40,13 +40,13 @@
"proxyPort": { "index": 14, "kind": "property", "displayName": "Proxy
Port", "group": "proxy", "label": "proxy", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "To define a proxy port when instantiating the
CW client" },
"proxyProtocol": { "index": 15, "kind": "property", "displayName": "Proxy
Protocol", "group": "proxy", "label": "proxy", "required": false, "type":
"object", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP",
"HTTPS" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "HTTPS", "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "To define a proxy protocol when in [...]
"accessKey": { "index": 16, "kind": "property", "displayName": "Access
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Access Key" },
- "profileCredentialsName": { "index": 17, "kind": "property",
"displayName": "Profile Credentials Name", "group": "security", "label":
"security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "If using a profile
credentials provider this parameter will set the profile name" },
+ "profileCredentialsName": { "index": 17, "kind": "property",
"displayName": "Profile Credentials Name", "group": "security", "label":
"security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "If using a profile
credentials provider, this parameter will set the profile name" },
"secretKey": { "index": 18, "kind": "property", "displayName": "Secret
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Secret Key" },
- "sessionToken": { "index": 19, "kind": "property", "displayName": "Session
Token", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Session Token used when the user
needs to assume a IAM role" },
+ "sessionToken": { "index": 19, "kind": "property", "displayName": "Session
Token", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Session Token used when the user
needs to assume an IAM role" },
"trustAllCertificates": { "index": 20, "kind": "property", "displayName":
"Trust All Certificates", "group": "security", "label": "security", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "If we want to trust all
certificates in case of overriding the endpoint" },
"useDefaultCredentialsProvider": { "index": 21, "kind": "property",
"displayName": "Use Default Credentials Provider", "group": "security",
"label": "security", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set whether the S3 client should expect to
load crede [...]
"useProfileCredentialsProvider": { "index": 22, "kind": "property",
"displayName": "Use Profile Credentials Provider", "group": "security",
"label": "security", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set whether the Cloudwatch client should
expect to lo [...]
- "useSessionCredentials": { "index": 23, "kind": "property", "displayName":
"Use Session Credentials", "group": "security", "label": "security",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "Set whether the
CloudWatch client should expect to use Session Credent [...]
+ "useSessionCredentials": { "index": 23, "kind": "property", "displayName":
"Use Session Credentials", "group": "security", "label": "security",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "Set whether the
CloudWatch client should expect to use Session Credent [...]
},
"headers": {
"CamelAwsCwMetricNamespace": { "index": 0, "kind": "header",
"displayName": "", "group": "producer", "label": "", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The Amazon CW metric namespace.",
"constantName":
"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_NAMESPACE" },
@@ -61,8 +61,8 @@
"properties": {
"namespace": { "index": 0, "kind": "path", "displayName": "Namespace",
"group": "producer", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "deprecationNote": "",
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "The metric namespace" },
"name": { "index": 1, "kind": "parameter", "displayName": "Name", "group":
"producer", "label": "", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "The metric name" },
- "overrideEndpoint": { "index": 2, "kind": "parameter", "displayName":
"Override Endpoint", "group": "producer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set the need for overidding the endpoint. This
option needs to be used in combination wit [...]
- "region": { "index": 3, "kind": "parameter", "displayName": "Region",
"group": "producer", "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 [...]
+ "overrideEndpoint": { "index": 2, "kind": "parameter", "displayName":
"Override Endpoint", "group": "producer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set the need for overriding the endpoint. This
option needs to be used in combination wit [...]
+ "region": { "index": 3, "kind": "parameter", "displayName": "Region",
"group": "producer", "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 [...]
"timestamp": { "index": 4, "kind": "parameter", "displayName":
"Timestamp", "group": "producer", "label": "", "required": false, "type":
"object", "javaType": "java.time.Instant", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "The metric timestamp" },
"unit": { "index": 5, "kind": "parameter", "displayName": "Unit", "group":
"producer", "label": "", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "The metric unit" },
"uriEndpointOverride": { "index": 6, "kind": "parameter", "displayName":
"Uri Endpoint Override", "group": "producer", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set the overriding uri endpoint. This option
needs to be used in combination with overrideEndpoin [...]
@@ -73,12 +73,12 @@
"proxyPort": { "index": 11, "kind": "parameter", "displayName": "Proxy
Port", "group": "proxy", "label": "proxy", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "To define a proxy port when instantiating the
CW client" },
"proxyProtocol": { "index": 12, "kind": "parameter", "displayName": "Proxy
Protocol", "group": "proxy", "label": "proxy", "required": false, "type":
"object", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP",
"HTTPS" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "HTTPS", "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "To define a proxy protocol when i [...]
"accessKey": { "index": 13, "kind": "parameter", "displayName": "Access
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Access Key" },
- "profileCredentialsName": { "index": 14, "kind": "parameter",
"displayName": "Profile Credentials Name", "group": "security", "label":
"security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "If using a profile
credentials provider this parameter will set the profile name" },
+ "profileCredentialsName": { "index": 14, "kind": "parameter",
"displayName": "Profile Credentials Name", "group": "security", "label":
"security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "If using a profile
credentials provider, this parameter will set the profile name" },
"secretKey": { "index": 15, "kind": "parameter", "displayName": "Secret
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Secret Key" },
- "sessionToken": { "index": 16, "kind": "parameter", "displayName":
"Session Token", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Session Token used when the user
needs to assume a IAM role" },
+ "sessionToken": { "index": 16, "kind": "parameter", "displayName":
"Session Token", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Session Token used when the user
needs to assume an IAM role" },
"trustAllCertificates": { "index": 17, "kind": "parameter", "displayName":
"Trust All Certificates", "group": "security", "label": "security", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "If we want to trust all
certificates in case of overriding the endpoint" },
"useDefaultCredentialsProvider": { "index": 18, "kind": "parameter",
"displayName": "Use Default Credentials Provider", "group": "security",
"label": "security", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set whether the S3 client should expect to
load cred [...]
"useProfileCredentialsProvider": { "index": 19, "kind": "parameter",
"displayName": "Use Profile Credentials Provider", "group": "security",
"label": "security", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set whether the Cloudwatch client should
expect to l [...]
- "useSessionCredentials": { "index": 20, "kind": "parameter",
"displayName": "Use Session Credentials", "group": "security", "label":
"security", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set whether the CloudWatch client should
expect to use Session Creden [...]
+ "useSessionCredentials": { "index": 20, "kind": "parameter",
"displayName": "Use Session Credentials", "group": "security", "label":
"security", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set whether the CloudWatch client should
expect to use Session Creden [...]
}
}
diff --git
a/components/camel-aws/camel-aws2-cw/src/generated/resources/org/apache/camel/component/aws2/cw/aws2-cw.json
b/components/camel-aws/camel-aws2-cw/src/generated/resources/org/apache/camel/component/aws2/cw/aws2-cw.json
index b01e1404b66..6135e9ef5f0 100644
---
a/components/camel-aws/camel-aws2-cw/src/generated/resources/org/apache/camel/component/aws2/cw/aws2-cw.json
+++
b/components/camel-aws/camel-aws2-cw/src/generated/resources/org/apache/camel/component/aws2/cw/aws2-cw.json
@@ -26,8 +26,8 @@
"configuration": { "index": 0, "kind": "property", "displayName":
"Configuration", "group": "producer", "label": "", "required": false, "type":
"object", "javaType": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"deprecated": false, "autowired": false, "secret": false, "description": "The
component configuration" },
"lazyStartProducer": { "index": 1, "kind": "property", "displayName":
"Lazy Start Producer", "group": "producer", "label": "producer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Whether the producer should be started lazy (on the first message). By
starting lazy you can use this to allow CamelContext and routes to startup in
situations where a producer may otherwise fail [...]
"name": { "index": 2, "kind": "property", "displayName": "Name", "group":
"producer", "label": "", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "The metric name" },
- "overrideEndpoint": { "index": 3, "kind": "property", "displayName":
"Override Endpoint", "group": "producer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set the need for overidding the endpoint. This
option needs to be used in combination with [...]
- "region": { "index": 4, "kind": "property", "displayName": "Region",
"group": "producer", "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 [...]
+ "overrideEndpoint": { "index": 3, "kind": "property", "displayName":
"Override Endpoint", "group": "producer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set the need for overriding the endpoint. This
option needs to be used in combination with [...]
+ "region": { "index": 4, "kind": "property", "displayName": "Region",
"group": "producer", "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 [...]
"timestamp": { "index": 5, "kind": "property", "displayName": "Timestamp",
"group": "producer", "label": "", "required": false, "type": "object",
"javaType": "java.time.Instant", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "The metric timestamp" },
"unit": { "index": 6, "kind": "property", "displayName": "Unit", "group":
"producer", "label": "", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "The metric unit" },
"uriEndpointOverride": { "index": 7, "kind": "property", "displayName":
"Uri Endpoint Override", "group": "producer", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set the overriding uri endpoint. This option
needs to be used in combination with overrideEndpoint [...]
@@ -40,13 +40,13 @@
"proxyPort": { "index": 14, "kind": "property", "displayName": "Proxy
Port", "group": "proxy", "label": "proxy", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "To define a proxy port when instantiating the
CW client" },
"proxyProtocol": { "index": 15, "kind": "property", "displayName": "Proxy
Protocol", "group": "proxy", "label": "proxy", "required": false, "type":
"object", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP",
"HTTPS" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "HTTPS", "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "To define a proxy protocol when in [...]
"accessKey": { "index": 16, "kind": "property", "displayName": "Access
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Access Key" },
- "profileCredentialsName": { "index": 17, "kind": "property",
"displayName": "Profile Credentials Name", "group": "security", "label":
"security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "If using a profile
credentials provider this parameter will set the profile name" },
+ "profileCredentialsName": { "index": 17, "kind": "property",
"displayName": "Profile Credentials Name", "group": "security", "label":
"security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "If using a profile
credentials provider, this parameter will set the profile name" },
"secretKey": { "index": 18, "kind": "property", "displayName": "Secret
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Secret Key" },
- "sessionToken": { "index": 19, "kind": "property", "displayName": "Session
Token", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Session Token used when the user
needs to assume a IAM role" },
+ "sessionToken": { "index": 19, "kind": "property", "displayName": "Session
Token", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Session Token used when the user
needs to assume an IAM role" },
"trustAllCertificates": { "index": 20, "kind": "property", "displayName":
"Trust All Certificates", "group": "security", "label": "security", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "If we want to trust all
certificates in case of overriding the endpoint" },
"useDefaultCredentialsProvider": { "index": 21, "kind": "property",
"displayName": "Use Default Credentials Provider", "group": "security",
"label": "security", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set whether the S3 client should expect to
load crede [...]
"useProfileCredentialsProvider": { "index": 22, "kind": "property",
"displayName": "Use Profile Credentials Provider", "group": "security",
"label": "security", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set whether the Cloudwatch client should
expect to lo [...]
- "useSessionCredentials": { "index": 23, "kind": "property", "displayName":
"Use Session Credentials", "group": "security", "label": "security",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "Set whether the
CloudWatch client should expect to use Session Credent [...]
+ "useSessionCredentials": { "index": 23, "kind": "property", "displayName":
"Use Session Credentials", "group": "security", "label": "security",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "Set whether the
CloudWatch client should expect to use Session Credent [...]
},
"headers": {
"CamelAwsCwMetricNamespace": { "index": 0, "kind": "header",
"displayName": "", "group": "producer", "label": "", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The Amazon CW metric namespace.",
"constantName":
"org.apache.camel.component.aws2.cw.Cw2Constants#METRIC_NAMESPACE" },
@@ -61,8 +61,8 @@
"properties": {
"namespace": { "index": 0, "kind": "path", "displayName": "Namespace",
"group": "producer", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "deprecationNote": "",
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "The metric namespace" },
"name": { "index": 1, "kind": "parameter", "displayName": "Name", "group":
"producer", "label": "", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "The metric name" },
- "overrideEndpoint": { "index": 2, "kind": "parameter", "displayName":
"Override Endpoint", "group": "producer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set the need for overidding the endpoint. This
option needs to be used in combination wit [...]
- "region": { "index": 3, "kind": "parameter", "displayName": "Region",
"group": "producer", "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 [...]
+ "overrideEndpoint": { "index": 2, "kind": "parameter", "displayName":
"Override Endpoint", "group": "producer", "label": "", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set the need for overriding the endpoint. This
option needs to be used in combination wit [...]
+ "region": { "index": 3, "kind": "parameter", "displayName": "Region",
"group": "producer", "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 [...]
"timestamp": { "index": 4, "kind": "parameter", "displayName":
"Timestamp", "group": "producer", "label": "", "required": false, "type":
"object", "javaType": "java.time.Instant", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "The metric timestamp" },
"unit": { "index": 5, "kind": "parameter", "displayName": "Unit", "group":
"producer", "label": "", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "The metric unit" },
"uriEndpointOverride": { "index": 6, "kind": "parameter", "displayName":
"Uri Endpoint Override", "group": "producer", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set the overriding uri endpoint. This option
needs to be used in combination with overrideEndpoin [...]
@@ -73,12 +73,12 @@
"proxyPort": { "index": 11, "kind": "parameter", "displayName": "Proxy
Port", "group": "proxy", "label": "proxy", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "To define a proxy port when instantiating the
CW client" },
"proxyProtocol": { "index": 12, "kind": "parameter", "displayName": "Proxy
Protocol", "group": "proxy", "label": "proxy", "required": false, "type":
"object", "javaType": "software.amazon.awssdk.core.Protocol", "enum": [ "HTTP",
"HTTPS" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "HTTPS", "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "To define a proxy protocol when i [...]
"accessKey": { "index": 13, "kind": "parameter", "displayName": "Access
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Access Key" },
- "profileCredentialsName": { "index": 14, "kind": "parameter",
"displayName": "Profile Credentials Name", "group": "security", "label":
"security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "If using a profile
credentials provider this parameter will set the profile name" },
+ "profileCredentialsName": { "index": 14, "kind": "parameter",
"displayName": "Profile Credentials Name", "group": "security", "label":
"security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "If using a profile
credentials provider, this parameter will set the profile name" },
"secretKey": { "index": 15, "kind": "parameter", "displayName": "Secret
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Secret Key" },
- "sessionToken": { "index": 16, "kind": "parameter", "displayName":
"Session Token", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Session Token used when the user
needs to assume a IAM role" },
+ "sessionToken": { "index": 16, "kind": "parameter", "displayName":
"Session Token", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Session Token used when the user
needs to assume an IAM role" },
"trustAllCertificates": { "index": 17, "kind": "parameter", "displayName":
"Trust All Certificates", "group": "security", "label": "security", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false,
"configurationClass": "org.apache.camel.component.aws2.cw.Cw2Configuration",
"configurationField": "configuration", "description": "If we want to trust all
certificates in case of overriding the endpoint" },
"useDefaultCredentialsProvider": { "index": 18, "kind": "parameter",
"displayName": "Use Default Credentials Provider", "group": "security",
"label": "security", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set whether the S3 client should expect to
load cred [...]
"useProfileCredentialsProvider": { "index": 19, "kind": "parameter",
"displayName": "Use Profile Credentials Provider", "group": "security",
"label": "security", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set whether the Cloudwatch client should
expect to l [...]
- "useSessionCredentials": { "index": 20, "kind": "parameter",
"displayName": "Use Session Credentials", "group": "security", "label":
"security", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set whether the CloudWatch client should
expect to use Session Creden [...]
+ "useSessionCredentials": { "index": 20, "kind": "parameter",
"displayName": "Use Session Credentials", "group": "security", "label":
"security", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
false, "configurationClass":
"org.apache.camel.component.aws2.cw.Cw2Configuration", "configurationField":
"configuration", "description": "Set whether the CloudWatch client should
expect to use Session Creden [...]
}
}
diff --git
a/components/camel-aws/camel-aws2-cw/src/main/docs/aws2-cw-component.adoc
b/components/camel-aws/camel-aws2-cw/src/main/docs/aws2-cw-component.adoc
index c724e8163c2..7e873096be4 100644
--- a/components/camel-aws/camel-aws2-cw/src/main/docs/aws2-cw-component.adoc
+++ b/components/camel-aws/camel-aws2-cw/src/main/docs/aws2-cw-component.adoc
@@ -32,9 +32,9 @@ https://aws.amazon.com/cloudwatch/[Amazon CloudWatch].
aws2-cw://namespace[?options]
----------------------------
-The metrics will be created if they don't already exists. +
- You can append query options to the URI in the following format,
-`?options=value&option2=value&...`
+The metrics will be created if they don't already exist.
+
+You can append query options to the URI in the following format:
`?options=value&option2=value&...`
// component-configure options: START
@@ -60,12 +60,12 @@ the https://aws.amazon.com/cloudwatch/[Amazon's CloudWatch].
=== 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.
diff --git
a/components/camel-aws/camel-aws2-cw/src/main/java/org/apache/camel/component/aws2/cw/Cw2Configuration.java
b/components/camel-aws/camel-aws2-cw/src/main/java/org/apache/camel/component/aws2/cw/Cw2Configuration.java
index be772d53482..9b2ad670b06 100644
---
a/components/camel-aws/camel-aws2-cw/src/main/java/org/apache/camel/component/aws2/cw/Cw2Configuration.java
+++
b/components/camel-aws/camel-aws2-cw/src/main/java/org/apache/camel/component/aws2/cw/Cw2Configuration.java
@@ -99,7 +99,7 @@ public class Cw2Configuration implements Cloneable {
}
/**
- * Amazon AWS Session Token used when the user needs to assume a IAM role
+ * Amazon AWS Session Token used when the user needs to assume an IAM role
*/
public void setSessionToken(String sessionToken) {
this.sessionToken = sessionToken;
@@ -210,7 +210,7 @@ public class Cw2Configuration implements Cloneable {
/**
* The region in which CW client needs to work. When using this parameter,
the configuration will expect the
- * lowercase name of the region (for example ap-east-1) You'll need to use
the name Region.EU_WEST_1.id()
+ * lowercase name of the region (for example, ap-east-1) You'll need to
use the name Region.EU_WEST_1.id()
*/
public void setRegion(String region) {
this.region = region;
@@ -232,7 +232,7 @@ public class Cw2Configuration implements Cloneable {
}
/**
- * Set the need for overidding the endpoint. This option needs to be used
in combination with uriEndpointOverride
+ * Set the need for overriding the endpoint. This option needs to be used
in combination with the uriEndpointOverride
* option
*/
public void setOverrideEndpoint(boolean overrideEndpoint) {
@@ -278,8 +278,8 @@ public class Cw2Configuration implements Cloneable {
}
/**
- * Set whether the CloudWatch client should expect to use Session
Credentials. This is useful in situation in which
- * the user needs to assume a IAM role for doing operations in CloudWatch.
+ * Set whether the CloudWatch client should expect to use Session
Credentials. This is useful in a situation in which
+ * the user needs to assume an IAM role for doing operations in CloudWatch.
*/
public void setUseSessionCredentials(boolean useSessionCredentials) {
this.useSessionCredentials = useSessionCredentials;
@@ -290,7 +290,7 @@ public class Cw2Configuration implements Cloneable {
}
/**
- * If using a profile credentials provider this parameter will set the
profile name
+ * If using a profile credentials provider, this parameter will set the
profile name
*/
public void setProfileCredentialsName(String profileCredentialsName) {
this.profileCredentialsName = profileCredentialsName;
