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 ec3747629f03e7c6eab72b0019563bb4c175c8ed
Author: Otavio Rodolfo Piske <angusyo...@gmail.com>
AuthorDate: Fri Feb 9 15:41:11 2024 +0100
(chores) camel-aws2-eventbridge: documentation fixes
- Fixed grammar and typos
- Fixed punctuation
- Added and/or fixed links
---
.../camel/catalog/components/aws2-eventbridge.json | 20 +++++-----
.../aws2/eventbridge/aws2-eventbridge.json | 20 +++++-----
.../src/main/docs/aws2-eventbridge-component.adoc | 43 +++++++++++-----------
.../aws2/eventbridge/EventbridgeConfiguration.java | 16 ++++----
4 files changed, 50 insertions(+), 49 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-eventbridge.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-eventbridge.json
index 6315f7257d5..778170efb90 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-eventbridge.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws2-eventbridge.json
@@ -27,12 +27,12 @@
"eventPatternFile": { "index": 1, "kind": "property", "displayName":
"Event Pattern File", "group": "producer", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"deprecationNote": "", "autowired": false, "secret": false,
"supportFileReference": true, "configurationClass":
"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "EventPattern File" },
"lazyStartProducer": { "index": 2, "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": 3, "kind": "property", "displayName": "Operation",
"group": "producer", "label": "", "required": true, "type": "object",
"javaType":
"org.apache.camel.component.aws2.eventbridge.EventbridgeOperations", "enum": [
"putRule", "putTargets", "removeTargets", "deleteRule", "enableRule",
"disableRule", "describeRule", "listRules", "listTargetsByRule",
"listRuleNamesByTarget", "putEvent" ], "deprecated": false, "deprecationNote":
"", "autowired": false, "secret": fals [...]
- "overrideEndpoint": { "index": 4, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set the need for
overidding the endpoint. This option needs to be used in [...]
+ "overrideEndpoint": { "index": 4, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set the need for
overriding the endpoint. This option needs to be used in [...]
"pojoRequest": { "index": 5, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "If we want to use a POJO
request as body or not" },
- "region": { "index": 6, "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": 6, "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": 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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set the overriding uri
endpoint. This option needs to be used in combination with [...]
"autowiredEnabled": { "index": 8, "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 [...]
- "eventbridgeClient": { "index": 9, "kind": "property", "displayName":
"Eventbridge Client", "group": "advanced", "label": "advanced", "required":
false, "type": "object", "javaType":
"software.amazon.awssdk.services.eventbridge.EventBridgeClient", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass":
"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "To use a ex [...]
+ "eventbridgeClient": { "index": 9, "kind": "property", "displayName":
"Eventbridge Client", "group": "advanced", "label": "advanced", "required":
false, "type": "object", "javaType":
"software.amazon.awssdk.services.eventbridge.EventBridgeClient", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass":
"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "To use an e [...]
"healthCheckConsumerEnabled": { "index": 10, "kind": "property",
"displayName": "Health Check Consumer Enabled", "group": "health", "label":
"health", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": true,
"description": "Used for enabling or disabling all consumer based health checks
from this component" },
"healthCheckProducerEnabled": { "index": 11, "kind": "property",
"displayName": "Health Check Producer Enabled", "group": "health", "label":
"health", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": true,
"description": "Used for enabling or disabling all producer based health checks
from this component. Notice: Camel has by default disabled all producer based
health-checks. You can turn on produce [...]
"proxyHost": { "index": 12, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "To define a proxy host
when instantiating the Eventbridge client" },
@@ -41,11 +41,11 @@
"accessKey": { "index": 15, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Amazon AWS Access Key" },
"profileCredentialsName": { "index": 16, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "If using a profile
credentials provider this parameter will set th [...]
"secretKey": { "index": 17, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Amazon AWS Secret Key" },
- "sessionToken": { "index": 18, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Amazon AWS Session Token
used when the user needs to assume a IAM role" },
+ "sessionToken": { "index": 18, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Amazon AWS Session Token
used when the user needs to assume an IAM role" },
"trustAllCertificates": { "index": 19, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "If we want to trust all
certificates in case of overrid [...]
"useDefaultCredentialsProvider": { "index": 20, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set whether the
Eventbridge client s [...]
"useProfileCredentialsProvider": { "index": 21, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set whether the
Eventbridge client s [...]
- "useSessionCredentials": { "index": 22, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set whether the
Eventbridge client should expect to u [...]
+ "useSessionCredentials": { "index": 22, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set whether the
Eventbridge client should expect to u [...]
},
"headers": {
"CamelAwsEventbridgeOperation": { "index": 0, "kind": "header",
"displayName": "", "group": "producer", "label": "", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The operation we want to perform",
"constantName":
"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#OPERATION" },
@@ -63,22 +63,22 @@
"eventbusNameOrArn": { "index": 0, "kind": "path", "displayName":
"Eventbus Name Or Arn", "group": "producer", "label": "", "required": true,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"deprecationNote": "", "autowired": false, "secret": false, "description":
"Event bus name or ARN" },
"eventPatternFile": { "index": 1, "kind": "parameter", "displayName":
"Event Pattern File", "group": "producer", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"deprecationNote": "", "autowired": false, "secret": false,
"supportFileReference": true, "configurationClass":
"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "EventPattern File" },
"operation": { "index": 2, "kind": "parameter", "displayName":
"Operation", "group": "producer", "label": "", "required": true, "type":
"object", "javaType":
"org.apache.camel.component.aws2.eventbridge.EventbridgeOperations", "enum": [
"putRule", "putTargets", "removeTargets", "deleteRule", "enableRule",
"disableRule", "describeRule", "listRules", "listTargetsByRule",
"listRuleNamesByTarget", "putEvent" ], "deprecated": false, "deprecationNote":
"", "autowired": false, "secret": fal [...]
- "overrideEndpoint": { "index": 3, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set the need for
overidding the endpoint. This option needs to be used i [...]
+ "overrideEndpoint": { "index": 3, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set the need for
overriding the endpoint. This option needs to be used i [...]
"pojoRequest": { "index": 4, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "If we want to use a POJO
request as body or not" },
- "region": { "index": 5, "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": 5, "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": 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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set the overriding uri
endpoint. This option needs to be used in combination wit [...]
"lazyStartProducer": { "index": 7, "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 [...]
- "eventbridgeClient": { "index": 8, "kind": "parameter", "displayName":
"Eventbridge Client", "group": "advanced", "label": "advanced", "required":
false, "type": "object", "javaType":
"software.amazon.awssdk.services.eventbridge.EventBridgeClient", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass":
"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "To use a e [...]
+ "eventbridgeClient": { "index": 8, "kind": "parameter", "displayName":
"Eventbridge Client", "group": "advanced", "label": "advanced", "required":
false, "type": "object", "javaType":
"software.amazon.awssdk.services.eventbridge.EventBridgeClient", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass":
"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "To use an [...]
"proxyHost": { "index": 9, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "To define a proxy host
when instantiating the Eventbridge client" },
"proxyPort": { "index": 10, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "To define a proxy port
when instantiating the Eventbridge client" },
"proxyProtocol": { "index": 11, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "To define a prox [...]
"accessKey": { "index": 12, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Amazon AWS Access Key" },
"profileCredentialsName": { "index": 13, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "If using a profile
credentials provider this parameter will set t [...]
"secretKey": { "index": 14, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Amazon AWS Secret Key" },
- "sessionToken": { "index": 15, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Amazon AWS Session Token
used when the user needs to assume a IAM role" },
+ "sessionToken": { "index": 15, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Amazon AWS Session Token
used when the user needs to assume an IAM role" },
"trustAllCertificates": { "index": 16, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "If we want to trust all
certificates in case of overri [...]
"useDefaultCredentialsProvider": { "index": 17, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set whether the
Eventbridge client [...]
"useProfileCredentialsProvider": { "index": 18, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set whether the
Eventbridge client [...]
- "useSessionCredentials": { "index": 19, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set whether the
Eventbridge client should expect to [...]
+ "useSessionCredentials": { "index": 19, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set whether the
Eventbridge client should expect to [...]
}
}
diff --git
a/components/camel-aws/camel-aws2-eventbridge/src/generated/resources/org/apache/camel/component/aws2/eventbridge/aws2-eventbridge.json
b/components/camel-aws/camel-aws2-eventbridge/src/generated/resources/org/apache/camel/component/aws2/eventbridge/aws2-eventbridge.json
index 6315f7257d5..778170efb90 100644
---
a/components/camel-aws/camel-aws2-eventbridge/src/generated/resources/org/apache/camel/component/aws2/eventbridge/aws2-eventbridge.json
+++
b/components/camel-aws/camel-aws2-eventbridge/src/generated/resources/org/apache/camel/component/aws2/eventbridge/aws2-eventbridge.json
@@ -27,12 +27,12 @@
"eventPatternFile": { "index": 1, "kind": "property", "displayName":
"Event Pattern File", "group": "producer", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"deprecationNote": "", "autowired": false, "secret": false,
"supportFileReference": true, "configurationClass":
"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "EventPattern File" },
"lazyStartProducer": { "index": 2, "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": 3, "kind": "property", "displayName": "Operation",
"group": "producer", "label": "", "required": true, "type": "object",
"javaType":
"org.apache.camel.component.aws2.eventbridge.EventbridgeOperations", "enum": [
"putRule", "putTargets", "removeTargets", "deleteRule", "enableRule",
"disableRule", "describeRule", "listRules", "listTargetsByRule",
"listRuleNamesByTarget", "putEvent" ], "deprecated": false, "deprecationNote":
"", "autowired": false, "secret": fals [...]
- "overrideEndpoint": { "index": 4, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set the need for
overidding the endpoint. This option needs to be used in [...]
+ "overrideEndpoint": { "index": 4, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set the need for
overriding the endpoint. This option needs to be used in [...]
"pojoRequest": { "index": 5, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "If we want to use a POJO
request as body or not" },
- "region": { "index": 6, "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": 6, "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": 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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set the overriding uri
endpoint. This option needs to be used in combination with [...]
"autowiredEnabled": { "index": 8, "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 [...]
- "eventbridgeClient": { "index": 9, "kind": "property", "displayName":
"Eventbridge Client", "group": "advanced", "label": "advanced", "required":
false, "type": "object", "javaType":
"software.amazon.awssdk.services.eventbridge.EventBridgeClient", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass":
"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "To use a ex [...]
+ "eventbridgeClient": { "index": 9, "kind": "property", "displayName":
"Eventbridge Client", "group": "advanced", "label": "advanced", "required":
false, "type": "object", "javaType":
"software.amazon.awssdk.services.eventbridge.EventBridgeClient", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass":
"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "To use an e [...]
"healthCheckConsumerEnabled": { "index": 10, "kind": "property",
"displayName": "Health Check Consumer Enabled", "group": "health", "label":
"health", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": true,
"description": "Used for enabling or disabling all consumer based health checks
from this component" },
"healthCheckProducerEnabled": { "index": 11, "kind": "property",
"displayName": "Health Check Producer Enabled", "group": "health", "label":
"health", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": true,
"description": "Used for enabling or disabling all producer based health checks
from this component. Notice: Camel has by default disabled all producer based
health-checks. You can turn on produce [...]
"proxyHost": { "index": 12, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "To define a proxy host
when instantiating the Eventbridge client" },
@@ -41,11 +41,11 @@
"accessKey": { "index": 15, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Amazon AWS Access Key" },
"profileCredentialsName": { "index": 16, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "If using a profile
credentials provider this parameter will set th [...]
"secretKey": { "index": 17, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Amazon AWS Secret Key" },
- "sessionToken": { "index": 18, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Amazon AWS Session Token
used when the user needs to assume a IAM role" },
+ "sessionToken": { "index": 18, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Amazon AWS Session Token
used when the user needs to assume an IAM role" },
"trustAllCertificates": { "index": 19, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "If we want to trust all
certificates in case of overrid [...]
"useDefaultCredentialsProvider": { "index": 20, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set whether the
Eventbridge client s [...]
"useProfileCredentialsProvider": { "index": 21, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set whether the
Eventbridge client s [...]
- "useSessionCredentials": { "index": 22, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set whether the
Eventbridge client should expect to u [...]
+ "useSessionCredentials": { "index": 22, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set whether the
Eventbridge client should expect to u [...]
},
"headers": {
"CamelAwsEventbridgeOperation": { "index": 0, "kind": "header",
"displayName": "", "group": "producer", "label": "", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The operation we want to perform",
"constantName":
"org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#OPERATION" },
@@ -63,22 +63,22 @@
"eventbusNameOrArn": { "index": 0, "kind": "path", "displayName":
"Eventbus Name Or Arn", "group": "producer", "label": "", "required": true,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"deprecationNote": "", "autowired": false, "secret": false, "description":
"Event bus name or ARN" },
"eventPatternFile": { "index": 1, "kind": "parameter", "displayName":
"Event Pattern File", "group": "producer", "label": "", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"deprecationNote": "", "autowired": false, "secret": false,
"supportFileReference": true, "configurationClass":
"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "EventPattern File" },
"operation": { "index": 2, "kind": "parameter", "displayName":
"Operation", "group": "producer", "label": "", "required": true, "type":
"object", "javaType":
"org.apache.camel.component.aws2.eventbridge.EventbridgeOperations", "enum": [
"putRule", "putTargets", "removeTargets", "deleteRule", "enableRule",
"disableRule", "describeRule", "listRules", "listTargetsByRule",
"listRuleNamesByTarget", "putEvent" ], "deprecated": false, "deprecationNote":
"", "autowired": false, "secret": fal [...]
- "overrideEndpoint": { "index": 3, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set the need for
overidding the endpoint. This option needs to be used i [...]
+ "overrideEndpoint": { "index": 3, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set the need for
overriding the endpoint. This option needs to be used i [...]
"pojoRequest": { "index": 4, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "If we want to use a POJO
request as body or not" },
- "region": { "index": 5, "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": 5, "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": 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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set the overriding uri
endpoint. This option needs to be used in combination wit [...]
"lazyStartProducer": { "index": 7, "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 [...]
- "eventbridgeClient": { "index": 8, "kind": "parameter", "displayName":
"Eventbridge Client", "group": "advanced", "label": "advanced", "required":
false, "type": "object", "javaType":
"software.amazon.awssdk.services.eventbridge.EventBridgeClient", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass":
"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "To use a e [...]
+ "eventbridgeClient": { "index": 8, "kind": "parameter", "displayName":
"Eventbridge Client", "group": "advanced", "label": "advanced", "required":
false, "type": "object", "javaType":
"software.amazon.awssdk.services.eventbridge.EventBridgeClient", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass":
"org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "To use an [...]
"proxyHost": { "index": 9, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "To define a proxy host
when instantiating the Eventbridge client" },
"proxyPort": { "index": 10, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "To define a proxy port
when instantiating the Eventbridge client" },
"proxyProtocol": { "index": 11, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "To define a prox [...]
"accessKey": { "index": 12, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Amazon AWS Access Key" },
"profileCredentialsName": { "index": 13, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "If using a profile
credentials provider this parameter will set t [...]
"secretKey": { "index": 14, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Amazon AWS Secret Key" },
- "sessionToken": { "index": 15, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Amazon AWS Session Token
used when the user needs to assume a IAM role" },
+ "sessionToken": { "index": 15, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Amazon AWS Session Token
used when the user needs to assume an IAM role" },
"trustAllCertificates": { "index": 16, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "If we want to trust all
certificates in case of overri [...]
"useDefaultCredentialsProvider": { "index": 17, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set whether the
Eventbridge client [...]
"useProfileCredentialsProvider": { "index": 18, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set whether the
Eventbridge client [...]
- "useSessionCredentials": { "index": 19, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set whether the
Eventbridge client should expect to [...]
+ "useSessionCredentials": { "index": 19, "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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration", "description": "Set whether the
Eventbridge client should expect to [...]
}
}
diff --git
a/components/camel-aws/camel-aws2-eventbridge/src/main/docs/aws2-eventbridge-component.adoc
b/components/camel-aws/camel-aws2-eventbridge/src/main/docs/aws2-eventbridge-component.adoc
index 51584f1560e..95e1257de22 100644
---
a/components/camel-aws/camel-aws2-eventbridge/src/main/docs/aws2-eventbridge-component.adoc
+++
b/components/camel-aws/camel-aws2-eventbridge/src/main/docs/aws2-eventbridge-component.adoc
@@ -26,7 +26,7 @@ https://aws.amazon.com/eventbridge/[Amazon Eventbridge].
[NOTE]
====
-To create a rule that triggers on an action by an AWS service that does not
emit events, you can base the rule on API calls made by that service. The API
calls are recorded by AWS CloudTrail, so you'll need to have CloudTrail
enabled. For more information
https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html[Services
Supported by CloudTrail Event History].
+To create a rule that triggers on an action by an AWS service that does not
emit events, you can base the rule on API calls made by that service. The API
calls are recorded by AWS CloudTrail, so you'll need to have CloudTrail
enabled. For more information, check
https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html[Services
Supported by CloudTrail Event History].
====
== URI Format
@@ -35,8 +35,9 @@ To create a rule that triggers on an action by an AWS service
that does not emit
aws2-eventbridge://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
@@ -54,15 +55,15 @@ include::partial$component-endpoint-options.adoc[]
=== 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.
@@ -91,7 +92,7 @@ Camel-AWS2-Eventbridge component provides the following
operation on the produce
- listRuleNamesByTarget
- putEvent
-- PutRule: this operation create a rule related to an eventbus
+- PutRule: this operation creates a rule related to an eventbus
[source,java]
--------------------------------------------------------------------------------
@@ -106,7 +107,7 @@ Camel-AWS2-Eventbridge component provides the following
operation on the produce
.to("mock:result");
--------------------------------------------------------------------------------
-This operation will create a rule named firstrule and it will use a json file
for defining the EventPattern.
+This operation will create a rule named _firstrule_, and it will use a json
file for defining the EventPattern.
- PutTargets: this operation will add a target to the rule
@@ -128,9 +129,9 @@ This operation will create a rule named firstrule and it
will use a json file fo
.to("mock:result");
--------------------------------------------------------------------------------
-This operation will add the target sqs-queue with the arn reported to the
targets of the firstrule rule.
+This operation will add the target sqs-queue with the arn reported to the
targets of the _firstrule_ rule.
-- RemoveTargets: this operation will remove a collection of target from the
rule
+- RemoveTargets: this operation will remove a collection of targets from the
rule
[source,java]
--------------------------------------------------------------------------------
@@ -148,7 +149,7 @@ This operation will add the target sqs-queue with the arn
reported to the target
.to("mock:result");
--------------------------------------------------------------------------------
-This operation will remove the target sqs-queue from the firstrule rule.
+This operation will remove the target sqs-queue from the _firstrule_ rule.
- DeleteRule: this operation will delete a rule related to an eventbus
@@ -165,7 +166,7 @@ This operation will remove the target sqs-queue from the
firstrule rule.
.to("mock:result");
--------------------------------------------------------------------------------
-This operation will remove the firstrule rule from the test eventbus.
+This operation will remove the _firstrule_ rule from the test eventbus.
- EnableRule: this operation will enable a rule related to an eventbus
@@ -182,7 +183,7 @@ This operation will remove the firstrule rule from the test
eventbus.
.to("mock:result");
--------------------------------------------------------------------------------
-This operation will enable the firstrule rule from the test eventbus.
+This operation will enable the _firstrule_ rule from the test eventbus.
- DisableRule: this operation will disable a rule related to an eventbus
@@ -199,7 +200,7 @@ This operation will enable the firstrule rule from the test
eventbus.
.to("mock:result");
--------------------------------------------------------------------------------
-This operation will disable the firstrule rule from the test eventbus.
+This operation will disable the _firstrule_ rule from the test eventbus.
- ListRules: this operation will list all the rules related to an eventbus
with prefix first
@@ -233,7 +234,7 @@ This operation will list all the rules with prefix first
from the test eventbus.
.to("mock:result");
--------------------------------------------------------------------------------
-This operation will describe the firstrule rule from the test eventbus.
+This operation will describe the _firstrule_ rule from the test eventbus.
- ListTargetsByRule: this operation will return a list of targets associated
with a rule
@@ -250,9 +251,9 @@ This operation will describe the firstrule rule from the
test eventbus.
.to("mock:result");
--------------------------------------------------------------------------------
-this operation will return a list of targets associated with the firstrule
rule.
+this operation will return a list of targets associated with the _firstrule_
rule.
-- ListRuleNamesByTarget: this operation will return a list of rule associated
with a target
+- ListRuleNamesByTarget: this operation will return a list of rules associated
with a target
[source,java]
--------------------------------------------------------------------------------
@@ -267,7 +268,7 @@ this operation will return a list of targets associated
with the firstrule rule.
.to("mock:result");
--------------------------------------------------------------------------------
-this operation will return a list of rule associated with a target.
+this operation will return a list of rules associated with a target.
- PutEvent: this operation will send an event to the Servicebus
@@ -291,8 +292,8 @@ this operation will return a list of entries with related
ID sent to servicebus.
== Updating the rule
-To update a rule you'll need to perform the putRule operation again.
-There are no explicit update rule operation in the Java SDK.
+To update a rule, you'll need to perform the putRule operation again.
+There is no explicit update rule operation in the Java SDK.
== Dependencies
diff --git
a/components/camel-aws/camel-aws2-eventbridge/src/main/java/org/apache/camel/component/aws2/eventbridge/EventbridgeConfiguration.java
b/components/camel-aws/camel-aws2-eventbridge/src/main/java/org/apache/camel/component/aws2/eventbridge/EventbridgeConfiguration.java
index 1cb82851dce..590619cd26d 100644
---
a/components/camel-aws/camel-aws2-eventbridge/src/main/java/org/apache/camel/component/aws2/eventbridge/EventbridgeConfiguration.java
+++
b/components/camel-aws/camel-aws2-eventbridge/src/main/java/org/apache/camel/component/aws2/eventbridge/EventbridgeConfiguration.java
@@ -72,7 +72,7 @@ public class EventbridgeConfiguration implements Cloneable {
}
/**
- * To use a existing configured AWS Eventbridge as client
+ * To use an existing configured AWS Eventbridge client
*/
public void setEventbridgeClient(EventBridgeClient eventbridgeClient) {
this.eventbridgeClient = eventbridgeClient;
@@ -105,7 +105,7 @@ public class EventbridgeConfiguration 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;
@@ -160,8 +160,8 @@ public class EventbridgeConfiguration implements Cloneable {
}
/**
- * The region in which Eventbridge 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 Eventbridge 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;
@@ -205,7 +205,7 @@ public class EventbridgeConfiguration implements Cloneable {
}
/**
- * The eventbus name, the default value is default and this means it will
be the AWS event bus of your account.
+ * The eventbus name, the default value is default, and this means it will
be the AWS event bus of your account.
*/
public void setEventbusName(String eventbusName) {
this.eventbusName = eventbusName;
@@ -216,7 +216,7 @@ public class EventbridgeConfiguration 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) {
@@ -262,8 +262,8 @@ public class EventbridgeConfiguration implements Cloneable {
}
/**
- * Set whether the Eventbridge 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 Eventbridge.
+ * Set whether the Eventbridge 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
Eventbridge.
*/
public void setUseSessionCredentials(boolean useSessionCredentials) {
this.useSessionCredentials = useSessionCredentials;
