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 a2a0bc0e9e14e65b7f8716b9a240143b4449a0d2
Author: Otavio Rodolfo Piske <angusyo...@gmail.com>
AuthorDate: Fri Feb 9 17:38:41 2024 +0100
(chores) camel-aws2-sts: documentation fixes
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../apache/camel/catalog/components/aws2-sts.json | 16 ++++++++--------
.../apache/camel/component/aws2/sts/aws2-sts.json | 16 ++++++++--------
.../src/main/docs/aws2-sts-component.adoc | 21 +++++++++++----------
.../camel/component/aws2/sts/STS2Configuration.java | 10 +++++-----
4 files changed, 32 insertions(+), 31 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-sts.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-sts.json
index c1e179aa3e8..7e021c70c5d 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-sts.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-sts.json
@@ -26,17 +26,17 @@
"configuration": { "index": 0, "kind": "property", "displayName":
"Configuration", "group": "producer", "label": "", "required": false, "type":
"object", "javaType": "org.apache.camel.component.aws2.sts.STS2Configuration",
"deprecated": false, "autowired": false, "secret": false, "description":
"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 [...]
"operation": { "index": 2, "kind": "property", "displayName": "Operation",
"group": "producer", "label": "", "required": true, "type": "object",
"javaType": "org.apache.camel.component.aws2.sts.STS2Operations", "enum": [
"assumeRole", "getSessionToken", "getFederationToken" ], "deprecated": false,
"deprecationNote": "", "autowired": false, "secret": false, "defaultValue":
"assumeRole", "configurationClass":
"org.apache.camel.component.aws2.sts.STS2Configuration", "configurationField"
[...]
- "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Set the need for overidding the endpoint. This
option needs to be used in combination wi [...]
+ "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Set the need for overriding the endpoint. This
option needs to be used in combination wi [...]
"pojoRequest": { "index": 4, "kind": "property", "displayName": "Pojo
Request", "group": "producer", "label": "", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.sts.STS2Configuration", "configurationField":
"configuration", "description": "If we want to use a POJO request as body or
not" },
- "region": { "index": 5, "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 [...]
+ "region": { "index": 5, "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 [...]
"uriEndpointOverride": { "index": 6, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Set the overriding uri endpoint. This option
needs to be used in combination with overrideEndpoi [...]
"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 [...]
- "stsClient": { "index": 8, "kind": "property", "displayName": "Sts
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "software.amazon.awssdk.services.sts.StsClient",
"deprecated": false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.sts.STS2Configuration",
"configurationField": "configuration", "description": "To use a existing
configured AWS STS as client" },
+ "stsClient": { "index": 8, "kind": "property", "displayName": "Sts
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "software.amazon.awssdk.services.sts.StsClient",
"deprecated": false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.sts.STS2Configuration",
"configurationField": "configuration", "description": "To use an existing
configured AWS STS client" },
"proxyHost": { "index": 9, "kind": "property", "displayName": "Proxy
Host", "group": "proxy", "label": "proxy", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.aws2.sts.STS2Configuration", "configurationField":
"configuration", "description": "To define a proxy host when instantiating the
STS client" },
"proxyPort": { "index": 10, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "To define a proxy port when instantiating the
STS client" },
"proxyProtocol": { "index": 11, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "To define a proxy protocol when [...]
"accessKey": { "index": 12, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Access Key" },
- "profileCredentialsName": { "index": 13, "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.sts.STS2Configuration",
"configurationField": "configuration", "description": "If using a profile
credentials provider this parameter will set the profile name" },
+ "profileCredentialsName": { "index": 13, "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.sts.STS2Configuration",
"configurationField": "configuration", "description": "If using a profile
credentials provider, this parameter will set the profile name" },
"secretKey": { "index": 14, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Secret Key" },
"trustAllCertificates": { "index": 15, "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.sts.STS2Configuration",
"configurationField": "configuration", "description": "If we want to trust all
certificates in case of overriding the endpoint" },
"useDefaultCredentialsProvider": { "index": 16, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Set whether the STS client should expect to
load cr [...]
@@ -51,17 +51,17 @@
"properties": {
"label": { "index": 0, "kind": "path", "displayName": "Label", "group":
"producer", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.sts.STS2Configuration", "configurationField":
"configuration", "description": "Logical name" },
"operation": { "index": 1, "kind": "parameter", "displayName":
"Operation", "group": "producer", "label": "", "required": true, "type":
"object", "javaType": "org.apache.camel.component.aws2.sts.STS2Operations",
"enum": [ "assumeRole", "getSessionToken", "getFederationToken" ],
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "defaultValue": "assumeRole", "configurationClass":
"org.apache.camel.component.aws2.sts.STS2Configuration", "configurationField
[...]
- "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Set the need for overidding the endpoint. This
option needs to be used in combination w [...]
+ "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Set the need for overriding the endpoint. This
option needs to be used in combination w [...]
"pojoRequest": { "index": 3, "kind": "parameter", "displayName": "Pojo
Request", "group": "producer", "label": "", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.sts.STS2Configuration", "configurationField":
"configuration", "description": "If we want to use a POJO request as body or
not" },
- "region": { "index": 4, "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 [...]
+ "region": { "index": 4, "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 [...]
"uriEndpointOverride": { "index": 5, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Set the overriding uri endpoint. This option
needs to be used in combination with overrideEndpo [...]
"lazyStartProducer": { "index": 6, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "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 produc [...]
- "stsClient": { "index": 7, "kind": "parameter", "displayName": "Sts
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "software.amazon.awssdk.services.sts.StsClient",
"deprecated": false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.sts.STS2Configuration",
"configurationField": "configuration", "description": "To use a existing
configured AWS STS as client" },
+ "stsClient": { "index": 7, "kind": "parameter", "displayName": "Sts
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "software.amazon.awssdk.services.sts.StsClient",
"deprecated": false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.sts.STS2Configuration",
"configurationField": "configuration", "description": "To use an existing
configured AWS STS client" },
"proxyHost": { "index": 8, "kind": "parameter", "displayName": "Proxy
Host", "group": "proxy", "label": "proxy", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.aws2.sts.STS2Configuration", "configurationField":
"configuration", "description": "To define a proxy host when instantiating the
STS client" },
"proxyPort": { "index": 9, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "To define a proxy port when instantiating the
STS client" },
"proxyProtocol": { "index": 10, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "To define a proxy protocol when [...]
"accessKey": { "index": 11, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Access Key" },
- "profileCredentialsName": { "index": 12, "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.sts.STS2Configuration",
"configurationField": "configuration", "description": "If using a profile
credentials provider this parameter will set the profile name" },
+ "profileCredentialsName": { "index": 12, "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.sts.STS2Configuration",
"configurationField": "configuration", "description": "If using a profile
credentials provider, this parameter will set the profile name" },
"secretKey": { "index": 13, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Secret Key" },
"trustAllCertificates": { "index": 14, "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.sts.STS2Configuration",
"configurationField": "configuration", "description": "If we want to trust all
certificates in case of overriding the endpoint" },
"useDefaultCredentialsProvider": { "index": 15, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Set whether the STS client should expect to
load c [...]
diff --git
a/components/camel-aws/camel-aws2-sts/src/generated/resources/org/apache/camel/component/aws2/sts/aws2-sts.json
b/components/camel-aws/camel-aws2-sts/src/generated/resources/org/apache/camel/component/aws2/sts/aws2-sts.json
index c1e179aa3e8..7e021c70c5d 100644
---
a/components/camel-aws/camel-aws2-sts/src/generated/resources/org/apache/camel/component/aws2/sts/aws2-sts.json
+++
b/components/camel-aws/camel-aws2-sts/src/generated/resources/org/apache/camel/component/aws2/sts/aws2-sts.json
@@ -26,17 +26,17 @@
"configuration": { "index": 0, "kind": "property", "displayName":
"Configuration", "group": "producer", "label": "", "required": false, "type":
"object", "javaType": "org.apache.camel.component.aws2.sts.STS2Configuration",
"deprecated": false, "autowired": false, "secret": false, "description":
"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 [...]
"operation": { "index": 2, "kind": "property", "displayName": "Operation",
"group": "producer", "label": "", "required": true, "type": "object",
"javaType": "org.apache.camel.component.aws2.sts.STS2Operations", "enum": [
"assumeRole", "getSessionToken", "getFederationToken" ], "deprecated": false,
"deprecationNote": "", "autowired": false, "secret": false, "defaultValue":
"assumeRole", "configurationClass":
"org.apache.camel.component.aws2.sts.STS2Configuration", "configurationField"
[...]
- "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Set the need for overidding the endpoint. This
option needs to be used in combination wi [...]
+ "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Set the need for overriding the endpoint. This
option needs to be used in combination wi [...]
"pojoRequest": { "index": 4, "kind": "property", "displayName": "Pojo
Request", "group": "producer", "label": "", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.sts.STS2Configuration", "configurationField":
"configuration", "description": "If we want to use a POJO request as body or
not" },
- "region": { "index": 5, "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 [...]
+ "region": { "index": 5, "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 [...]
"uriEndpointOverride": { "index": 6, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Set the overriding uri endpoint. This option
needs to be used in combination with overrideEndpoi [...]
"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 [...]
- "stsClient": { "index": 8, "kind": "property", "displayName": "Sts
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "software.amazon.awssdk.services.sts.StsClient",
"deprecated": false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.sts.STS2Configuration",
"configurationField": "configuration", "description": "To use a existing
configured AWS STS as client" },
+ "stsClient": { "index": 8, "kind": "property", "displayName": "Sts
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "software.amazon.awssdk.services.sts.StsClient",
"deprecated": false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.sts.STS2Configuration",
"configurationField": "configuration", "description": "To use an existing
configured AWS STS client" },
"proxyHost": { "index": 9, "kind": "property", "displayName": "Proxy
Host", "group": "proxy", "label": "proxy", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.aws2.sts.STS2Configuration", "configurationField":
"configuration", "description": "To define a proxy host when instantiating the
STS client" },
"proxyPort": { "index": 10, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "To define a proxy port when instantiating the
STS client" },
"proxyProtocol": { "index": 11, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "To define a proxy protocol when [...]
"accessKey": { "index": 12, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Access Key" },
- "profileCredentialsName": { "index": 13, "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.sts.STS2Configuration",
"configurationField": "configuration", "description": "If using a profile
credentials provider this parameter will set the profile name" },
+ "profileCredentialsName": { "index": 13, "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.sts.STS2Configuration",
"configurationField": "configuration", "description": "If using a profile
credentials provider, this parameter will set the profile name" },
"secretKey": { "index": 14, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Secret Key" },
"trustAllCertificates": { "index": 15, "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.sts.STS2Configuration",
"configurationField": "configuration", "description": "If we want to trust all
certificates in case of overriding the endpoint" },
"useDefaultCredentialsProvider": { "index": 16, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Set whether the STS client should expect to
load cr [...]
@@ -51,17 +51,17 @@
"properties": {
"label": { "index": 0, "kind": "path", "displayName": "Label", "group":
"producer", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.aws2.sts.STS2Configuration", "configurationField":
"configuration", "description": "Logical name" },
"operation": { "index": 1, "kind": "parameter", "displayName":
"Operation", "group": "producer", "label": "", "required": true, "type":
"object", "javaType": "org.apache.camel.component.aws2.sts.STS2Operations",
"enum": [ "assumeRole", "getSessionToken", "getFederationToken" ],
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "defaultValue": "assumeRole", "configurationClass":
"org.apache.camel.component.aws2.sts.STS2Configuration", "configurationField
[...]
- "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Set the need for overidding the endpoint. This
option needs to be used in combination w [...]
+ "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Set the need for overriding the endpoint. This
option needs to be used in combination w [...]
"pojoRequest": { "index": 3, "kind": "parameter", "displayName": "Pojo
Request", "group": "producer", "label": "", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.aws2.sts.STS2Configuration", "configurationField":
"configuration", "description": "If we want to use a POJO request as body or
not" },
- "region": { "index": 4, "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 [...]
+ "region": { "index": 4, "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 [...]
"uriEndpointOverride": { "index": 5, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Set the overriding uri endpoint. This option
needs to be used in combination with overrideEndpo [...]
"lazyStartProducer": { "index": 6, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "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 produc [...]
- "stsClient": { "index": 7, "kind": "parameter", "displayName": "Sts
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "software.amazon.awssdk.services.sts.StsClient",
"deprecated": false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.sts.STS2Configuration",
"configurationField": "configuration", "description": "To use a existing
configured AWS STS as client" },
+ "stsClient": { "index": 7, "kind": "parameter", "displayName": "Sts
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "software.amazon.awssdk.services.sts.StsClient",
"deprecated": false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass": "org.apache.camel.component.aws2.sts.STS2Configuration",
"configurationField": "configuration", "description": "To use an existing
configured AWS STS client" },
"proxyHost": { "index": 8, "kind": "parameter", "displayName": "Proxy
Host", "group": "proxy", "label": "proxy", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.aws2.sts.STS2Configuration", "configurationField":
"configuration", "description": "To define a proxy host when instantiating the
STS client" },
"proxyPort": { "index": 9, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "To define a proxy port when instantiating the
STS client" },
"proxyProtocol": { "index": 10, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "To define a proxy protocol when [...]
"accessKey": { "index": 11, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Access Key" },
- "profileCredentialsName": { "index": 12, "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.sts.STS2Configuration",
"configurationField": "configuration", "description": "If using a profile
credentials provider this parameter will set the profile name" },
+ "profileCredentialsName": { "index": 12, "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.sts.STS2Configuration",
"configurationField": "configuration", "description": "If using a profile
credentials provider, this parameter will set the profile name" },
"secretKey": { "index": 13, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Amazon AWS Secret Key" },
"trustAllCertificates": { "index": 14, "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.sts.STS2Configuration",
"configurationField": "configuration", "description": "If we want to trust all
certificates in case of overriding the endpoint" },
"useDefaultCredentialsProvider": { "index": 15, "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.sts.STS2Configuration", "configurationField":
"configuration", "description": "Set whether the STS client should expect to
load c [...]
diff --git
a/components/camel-aws/camel-aws2-sts/src/main/docs/aws2-sts-component.adoc
b/components/camel-aws/camel-aws2-sts/src/main/docs/aws2-sts-component.adoc
index f33147f984a..86fea6bd2ba 100644
--- a/components/camel-aws/camel-aws2-sts/src/main/docs/aws2-sts-component.adoc
+++ b/components/camel-aws/camel-aws2-sts/src/main/docs/aws2-sts-component.adoc
@@ -26,7 +26,7 @@ https://aws.amazon.com/sts/[Amazon STS].
[NOTE]
====
-The AWS2 STS component works on the aws-global region and it has aws-global as
default region
+The AWS2 STS component works on the aws-global region, and it has aws-global
as the default region.
====
== URI Format
@@ -35,8 +35,9 @@ The AWS2 STS component works on the aws-global region and it
has aws-global as d
aws2-sts://label[?options]
-------------------------
-You can append query options to the URI in the following format,
-?options=value&option2=value&...
+You can append query options to the URI in the following format:
+
+`?options=value&option2=value&...`
// component-configure options: START
@@ -63,15 +64,15 @@ the https://aws.amazon.com/sts/[Amazon STS] service.
=== 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.
@@ -123,8 +124,8 @@ from("direct:getFederationToken")
== Using a POJO as body
-Sometimes build an AWS Request can be complex, because of multiple options. We
introduce the possibility to use a POJO as body.
-In AWS STS, as example for Assume Role request, you can do something like:
+Sometimes building an AWS Request can be complex because of multiple options.
We introduce the possibility to use a POJO as the body.
+In AWS STS, as an example for Assume Role request, you can do something like:
[source,java]
------------------------------------------------------------------------------------------------------
@@ -133,7 +134,7 @@ from("direct:createUser")
.to("aws2-sts://test?stsClient=#amazonSTSClient&operation=assumeRole&pojoRequest=true")
------------------------------------------------------------------------------------------------------
-In this way you'll pass the request directly without the need of passing
headers and options specifically related to this operation.
+In this way, you'll pass the request directly without the need of passing
headers and options specifically related to this operation.
== Dependencies
diff --git
a/components/camel-aws/camel-aws2-sts/src/main/java/org/apache/camel/component/aws2/sts/STS2Configuration.java
b/components/camel-aws/camel-aws2-sts/src/main/java/org/apache/camel/component/aws2/sts/STS2Configuration.java
index 35a851e4761..2644922188d 100644
---
a/components/camel-aws/camel-aws2-sts/src/main/java/org/apache/camel/component/aws2/sts/STS2Configuration.java
+++
b/components/camel-aws/camel-aws2-sts/src/main/java/org/apache/camel/component/aws2/sts/STS2Configuration.java
@@ -70,7 +70,7 @@ public class STS2Configuration implements Cloneable {
}
/**
- * To use a existing configured AWS STS as client
+ * To use an existing configured AWS STS client
*/
public void setStsClient(StsClient stsClient) {
this.stsClient = stsClient;
@@ -147,8 +147,8 @@ public class STS2Configuration implements Cloneable {
}
/**
- * The region in which STS 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()
+ * The region in which the STS 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()
*/
public void setRegion(String region) {
this.region = region;
@@ -181,7 +181,7 @@ public class STS2Configuration 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) {
@@ -227,7 +227,7 @@ public class STS2Configuration 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;
