aws2-eventbridge/component.json

2070 lines
74 KiB
JSON

{
"component": {
"kind": "component",
"name": "aws2-eventbridge",
"title": "AWS Eventbridge",
"description": "Manage AWS EventBridge cluster instances and consume events via SQS-backed polling.",
"deprecated": false,
"firstVersion": "1.4.0",
"label": "cloud,management",
"javaType": "org.apache.camel.component.aws2.eventbridge.EventbridgeComponent",
"supportLevel": "Stable",
"nativeSupported": true,
"metadata": {
"quarkusVersion": "3.36.0",
"camelArtifact": "org.apache.camel:camel-aws2-eventbridge",
"camelVersion": "4.20.0"
},
"groupId": "org.apache.camel.quarkus",
"artifactId": "camel-quarkus-aws2-eventbridge",
"version": "4.20.0 (CEQ 3.36.0)",
"scheme": "aws2-eventbridge",
"extendsScheme": "",
"syntax": "aws2-eventbridge://eventbusNameOrArn",
"async": false,
"api": false,
"consumerOnly": false,
"producerOnly": false,
"lenientProperties": false,
"browsable": false,
"remote": true
},
"componentProperties": {
"configuration": {
"index": 0,
"kind": "property",
"displayName": "Configuration",
"group": "common",
"label": "",
"required": false,
"type": "object",
"javaType": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "Component configuration"
},
"eventPatternFile": {
"index": 1,
"kind": "property",
"displayName": "Event Pattern File",
"group": "common",
"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": "property",
"displayName": "Operation",
"group": "common",
"label": "",
"required": true,
"type": "enum",
"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": false,
"defaultValue": "putRule",
"configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration",
"description": "The operation to perform"
},
"overrideEndpoint": {
"index": 3,
"kind": "property",
"displayName": "Override Endpoint",
"group": "common",
"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 combination with the uriEndpointOverride option"
},
"pojoRequest": {
"index": 4,
"kind": "property",
"displayName": "Pojo Request",
"group": "common",
"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": "property",
"displayName": "Region",
"group": "common",
"label": "",
"required": false,
"type": "enum",
"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",
"eu-isoe-west-1",
"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-northeast-1",
"me-south-1",
"sa-east-1",
"ap-east-1",
"cn-north-1",
"ca-west-1",
"us-gov-west-1",
"ap-southeast-1",
"ap-southeast-2",
"us-iso-east-1",
"ap-southeast-3",
"ap-southeast-4",
"us-east-1",
"us-east-2",
"cn-northwest-1",
"us-isob-east-1",
"aws-global",
"aws-cn-global",
"aws-us-gov-global",
"aws-iso-global",
"aws-iso-b-global"
],
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration",
"description": "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()"
},
"uriEndpointOverride": {
"index": 6,
"kind": "property",
"displayName": "Uri Endpoint Override",
"group": "common",
"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 overrideEndpoint option"
},
"autoCreateQueue": {
"index": 7,
"kind": "property",
"displayName": "Auto Create Queue",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration",
"description": "Whether to auto-create an SQS queue and wire it as an EventBridge rule target."
},
"bridgeErrorHandler": {
"index": 8,
"kind": "property",
"displayName": "Bridge Error Handler",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"description": "Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored."
},
"deleteQueueOnShutdown": {
"index": 9,
"kind": "property",
"displayName": "Delete Queue On Shutdown",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration",
"description": "Whether to delete the auto-created SQS queue and remove the EventBridge target on shutdown."
},
"maxMessagesPerPoll": {
"index": 10,
"kind": "property",
"displayName": "Max Messages Per Poll",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 10,
"configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration",
"description": "The maximum number of messages to receive per poll from SQS."
},
"queueUrl": {
"index": 11,
"kind": "property",
"displayName": "Queue Url",
"group": "consumer",
"label": "consumer",
"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": "The URL of an existing SQS queue to use as EventBridge target. If not specified, a queue is auto-created when autoCreateQueue is true."
},
"ruleName": {
"index": 12,
"kind": "property",
"displayName": "Rule Name",
"group": "consumer",
"label": "consumer",
"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": "The EventBridge rule name to consume events from. Required for consumer."
},
"visibilityTimeout": {
"index": 13,
"kind": "property",
"displayName": "Visibility Timeout",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 30,
"configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration",
"description": "The duration (in seconds) that received SQS messages are hidden from subsequent receive requests."
},
"waitTimeSeconds": {
"index": 14,
"kind": "property",
"displayName": "Wait Time Seconds",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 20,
"configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration",
"description": "The duration (in seconds) for which the SQS receive call waits for messages (long polling)."
},
"lazyStartProducer": {
"index": 15,
"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 during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."
},
"autowiredEnabled": {
"index": 16,
"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 type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc."
},
"eventbridgeClient": {
"index": 17,
"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 existing configured AWS Eventbridge client"
},
"healthCheckConsumerEnabled": {
"index": 18,
"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": 19,
"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 producer checks globally by setting camel.health.producersEnabled=true."
},
"proxyHost": {
"index": 20,
"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"
},
"proxyPort": {
"index": 21,
"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.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration",
"description": "To define a proxy port when instantiating the Eventbridge client"
},
"proxyProtocol": {
"index": 22,
"kind": "property",
"displayName": "Proxy Protocol",
"group": "proxy",
"label": "proxy",
"required": false,
"type": "enum",
"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 proxy protocol when instantiating the Eventbridge client"
},
"accessKey": {
"index": 23,
"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": 24,
"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 the profile name"
},
"secretKey": {
"index": 25,
"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": 26,
"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": 27,
"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 overriding the endpoint"
},
"useDefaultCredentialsProvider": {
"index": 28,
"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 should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."
},
"useProfileCredentialsProvider": {
"index": 29,
"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 should expect to load credentials through a profile credentials provider."
},
"useSessionCredentials": {
"index": 30,
"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 use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Eventbridge."
}
},
"headers": {
"CamelAwsEventbridgeOperation": {
"index": 0,
"kind": "header",
"displayName": "",
"group": "common",
"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"
},
"CamelAwsEventbridgeRuleName": {
"index": 1,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The name of the rule.",
"constantName": "org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#RULE_NAME"
},
"CamelAwsEventbridgeRuleNamePrefix": {
"index": 2,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The prefix matching the rule name.",
"constantName": "org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#RULE_NAME_PREFIX"
},
"CamelAwsEventbridgeEventPattern": {
"index": 3,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The event pattern.",
"constantName": "org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#EVENT_PATTERN"
},
"CamelAwsEventbridgeTargets": {
"index": 4,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "Collection<Target>",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The targets to update or add to the rule.",
"constantName": "org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#TARGETS"
},
"CamelAwsEventbridgeTargetsIds": {
"index": 5,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "Collection<String>",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The IDs of the targets to remove from the rule.",
"constantName": "org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#TARGETS_IDS"
},
"CamelAwsEventbridgeTargetArn": {
"index": 6,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The Amazon Resource Name (ARN) of the target resource.",
"constantName": "org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#TARGET_ARN"
},
"CamelAwsEventbridgeResourcesArn": {
"index": 7,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Comma separated list of Amazon Resource Names (ARN) of the resources related to Event",
"constantName": "org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#EVENT_RESOURCES_ARN"
},
"CamelAwsEventbridgeSource": {
"index": 8,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The source related to Event",
"constantName": "org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#EVENT_SOURCE"
},
"CamelAwsEventbridgeDetailType": {
"index": 9,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The detail type related to Event",
"constantName": "org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#EVENT_DETAIL_TYPE"
},
"CamelAwsEventbridgeNextToken": {
"index": 10,
"kind": "header",
"displayName": "",
"group": "listRules listTargetsByRule listRuleNamesByTarget",
"label": "listRules listTargetsByRule listRuleNamesByTarget",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The token for the next set of results.",
"constantName": "org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#NEXT_TOKEN"
},
"CamelAwsEventbridgeLimit": {
"index": 11,
"kind": "header",
"displayName": "",
"group": "listRules listTargetsByRule listRuleNamesByTarget",
"label": "listRules listTargetsByRule listRuleNamesByTarget",
"required": false,
"javaType": "Integer",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The maximum number of results to return.",
"constantName": "org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#LIMIT"
},
"CamelAwsEventbridgeIsTruncated": {
"index": 12,
"kind": "header",
"displayName": "",
"group": "listRules listTargetsByRule listRuleNamesByTarget",
"label": "listRules listTargetsByRule listRuleNamesByTarget",
"required": false,
"javaType": "Boolean",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Whether the response has more results (is truncated).",
"constantName": "org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#IS_TRUNCATED"
},
"CamelAwsEventbridgeRuleArn": {
"index": 13,
"kind": "header",
"displayName": "",
"group": "putRule describeRule",
"label": "putRule describeRule",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The Amazon Resource Name (ARN) of the rule.",
"constantName": "org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#RULE_ARN"
},
"CamelAwsEventbridgeFailedEntryCount": {
"index": 14,
"kind": "header",
"displayName": "",
"group": "putEvent putTargets removeTargets",
"label": "putEvent putTargets removeTargets",
"required": false,
"javaType": "Integer",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The number of failed entries in the response.",
"constantName": "org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#FAILED_ENTRY_COUNT"
},
"CamelAwsEventbridgeMessageId": {
"index": 15,
"kind": "header",
"displayName": "",
"group": "consumer",
"label": "consumer",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The SQS message ID.",
"constantName": "org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#MESSAGE_ID"
},
"CamelAwsEventbridgeReceiptHandle": {
"index": 16,
"kind": "header",
"displayName": "",
"group": "consumer",
"label": "consumer",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The SQS receipt handle for message deletion.",
"constantName": "org.apache.camel.component.aws2.eventbridge.EventbridgeConstants#RECEIPT_HANDLE"
}
},
"properties": {
"eventbusNameOrArn": {
"index": 0,
"kind": "path",
"displayName": "Eventbus Name Or Arn",
"group": "common",
"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": "common",
"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": "common",
"label": "",
"required": true,
"type": "enum",
"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": false,
"defaultValue": "putRule",
"configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration",
"description": "The operation to perform"
},
"overrideEndpoint": {
"index": 3,
"kind": "parameter",
"displayName": "Override Endpoint",
"group": "common",
"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 combination with the uriEndpointOverride option"
},
"pojoRequest": {
"index": 4,
"kind": "parameter",
"displayName": "Pojo Request",
"group": "common",
"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": "common",
"label": "",
"required": false,
"type": "enum",
"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",
"eu-isoe-west-1",
"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-northeast-1",
"me-south-1",
"sa-east-1",
"ap-east-1",
"cn-north-1",
"ca-west-1",
"us-gov-west-1",
"ap-southeast-1",
"ap-southeast-2",
"us-iso-east-1",
"ap-southeast-3",
"ap-southeast-4",
"us-east-1",
"us-east-2",
"cn-northwest-1",
"us-isob-east-1",
"aws-global",
"aws-cn-global",
"aws-us-gov-global",
"aws-iso-global",
"aws-iso-b-global"
],
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration",
"description": "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()"
},
"uriEndpointOverride": {
"index": 6,
"kind": "parameter",
"displayName": "Uri Endpoint Override",
"group": "common",
"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 overrideEndpoint option"
},
"autoCreateQueue": {
"index": 7,
"kind": "parameter",
"displayName": "Auto Create Queue",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration",
"description": "Whether to auto-create an SQS queue and wire it as an EventBridge rule target."
},
"deleteQueueOnShutdown": {
"index": 8,
"kind": "parameter",
"displayName": "Delete Queue On Shutdown",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration",
"description": "Whether to delete the auto-created SQS queue and remove the EventBridge target on shutdown."
},
"maxMessagesPerPoll": {
"index": 9,
"kind": "parameter",
"displayName": "Max Messages Per Poll",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 10,
"configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration",
"description": "The maximum number of messages to receive per poll from SQS."
},
"queueUrl": {
"index": 10,
"kind": "parameter",
"displayName": "Queue Url",
"group": "consumer",
"label": "consumer",
"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": "The URL of an existing SQS queue to use as EventBridge target. If not specified, a queue is auto-created when autoCreateQueue is true."
},
"ruleName": {
"index": 11,
"kind": "parameter",
"displayName": "Rule Name",
"group": "consumer",
"label": "consumer",
"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": "The EventBridge rule name to consume events from. Required for consumer."
},
"sendEmptyMessageWhenIdle": {
"index": 12,
"kind": "parameter",
"displayName": "Send Empty Message When Idle",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"description": "If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."
},
"visibilityTimeout": {
"index": 13,
"kind": "parameter",
"displayName": "Visibility Timeout",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 30,
"configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration",
"description": "The duration (in seconds) that received SQS messages are hidden from subsequent receive requests."
},
"waitTimeSeconds": {
"index": 14,
"kind": "parameter",
"displayName": "Wait Time Seconds",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 20,
"configurationClass": "org.apache.camel.component.aws2.eventbridge.EventbridgeConfiguration",
"configurationField": "configuration",
"description": "The duration (in seconds) for which the SQS receive call waits for messages (long polling)."
},
"bridgeErrorHandler": {
"index": 15,
"kind": "parameter",
"displayName": "Bridge Error Handler",
"group": "consumer (advanced)",
"label": "consumer,advanced",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"description": "Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored."
},
"exceptionHandler": {
"index": 16,
"kind": "parameter",
"displayName": "Exception Handler",
"group": "consumer (advanced)",
"label": "consumer,advanced",
"required": false,
"type": "object",
"javaType": "org.apache.camel.spi.ExceptionHandler",
"optionalPrefix": "consumer.",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored."
},
"exchangePattern": {
"index": 17,
"kind": "parameter",
"displayName": "Exchange Pattern",
"group": "consumer (advanced)",
"label": "consumer,advanced",
"required": false,
"type": "enum",
"javaType": "org.apache.camel.ExchangePattern",
"enum": [
"InOnly",
"InOut"
],
"deprecated": false,
"autowired": false,
"secret": false,
"description": "Sets the exchange pattern when the consumer creates an exchange."
},
"pollStrategy": {
"index": 18,
"kind": "parameter",
"displayName": "Poll Strategy",
"group": "consumer (advanced)",
"label": "consumer,advanced",
"required": false,
"type": "object",
"javaType": "org.apache.camel.spi.PollingConsumerPollStrategy",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel."
},
"lazyStartProducer": {
"index": 19,
"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 producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."
},
"eventbridgeClient": {
"index": 20,
"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 existing configured AWS Eventbridge client"
},
"proxyHost": {
"index": 21,
"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": 22,
"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": 23,
"kind": "parameter",
"displayName": "Proxy Protocol",
"group": "proxy",
"label": "proxy",
"required": false,
"type": "enum",
"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 proxy protocol when instantiating the Eventbridge client"
},
"backoffErrorThreshold": {
"index": 24,
"kind": "parameter",
"displayName": "Backoff Error Threshold",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."
},
"backoffIdleThreshold": {
"index": 25,
"kind": "parameter",
"displayName": "Backoff Idle Threshold",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."
},
"backoffMultiplier": {
"index": 26,
"kind": "parameter",
"displayName": "Backoff Multiplier",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured."
},
"delay": {
"index": 27,
"kind": "parameter",
"displayName": "Delay",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "integer",
"javaType": "long",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 500,
"description": "Milliseconds before the next poll."
},
"greedy": {
"index": 28,
"kind": "parameter",
"displayName": "Greedy",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."
},
"initialDelay": {
"index": 29,
"kind": "parameter",
"displayName": "Initial Delay",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "integer",
"javaType": "long",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 1000,
"description": "Milliseconds before the first poll starts."
},
"repeatCount": {
"index": 30,
"kind": "parameter",
"displayName": "Repeat Count",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "integer",
"javaType": "long",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 0,
"description": "Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever."
},
"runLoggingLevel": {
"index": 31,
"kind": "parameter",
"displayName": "Run Logging Level",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "enum",
"javaType": "org.apache.camel.LoggingLevel",
"enum": [
"TRACE",
"DEBUG",
"INFO",
"WARN",
"ERROR",
"OFF"
],
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": "TRACE",
"description": "The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."
},
"scheduledExecutorService": {
"index": 32,
"kind": "parameter",
"displayName": "Scheduled Executor Service",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "object",
"javaType": "java.util.concurrent.ScheduledExecutorService",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool."
},
"scheduler": {
"index": 33,
"kind": "parameter",
"displayName": "Scheduler",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "object",
"javaType": "java.lang.Object",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": "none",
"description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"
},
"schedulerProperties": {
"index": 34,
"kind": "parameter",
"displayName": "Scheduler Properties",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "object",
"javaType": "java.util.Map<java.lang.String, java.lang.Object>",
"prefix": "scheduler.",
"multiValue": true,
"deprecated": false,
"autowired": false,
"secret": false,
"description": "To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. This is a multi-value option with prefix: scheduler."
},
"startScheduler": {
"index": 35,
"kind": "parameter",
"displayName": "Start Scheduler",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"description": "Whether the scheduler should be auto started."
},
"timeUnit": {
"index": 36,
"kind": "parameter",
"displayName": "Time Unit",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "enum",
"javaType": "java.util.concurrent.TimeUnit",
"enum": [
"NANOSECONDS",
"MICROSECONDS",
"MILLISECONDS",
"SECONDS",
"MINUTES",
"HOURS",
"DAYS"
],
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": "MILLISECONDS",
"description": "Time unit for initialDelay and delay options."
},
"useFixedDelay": {
"index": 37,
"kind": "parameter",
"displayName": "Use Fixed Delay",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."
},
"accessKey": {
"index": 38,
"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": 39,
"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 the profile name"
},
"secretKey": {
"index": 40,
"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": 41,
"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": 42,
"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 overriding the endpoint"
},
"useDefaultCredentialsProvider": {
"index": 43,
"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 should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."
},
"useProfileCredentialsProvider": {
"index": 44,
"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 should expect to load credentials through a profile credentials provider."
},
"useSessionCredentials": {
"index": 45,
"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 use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Eventbridge."
}
},
"propertiesSchema": {
"properties": {
"eventbusNameOrArn": {
"title": "Eventbus Name Or Arn",
"description": "Event bus name or ARN",
"type": "string",
"$comment": "group:common"
},
"eventPatternFile": {
"title": "Event Pattern File",
"description": "EventPattern File",
"type": "string",
"$comment": "group:common"
},
"operation": {
"title": "Operation",
"description": "The operation to perform",
"type": "string",
"enum": [
"putRule",
"putTargets",
"removeTargets",
"deleteRule",
"enableRule",
"disableRule",
"describeRule",
"listRules",
"listTargetsByRule",
"listRuleNamesByTarget",
"putEvent"
],
"$comment": "group:common",
"default": "putRule"
},
"overrideEndpoint": {
"title": "Override Endpoint",
"description": "Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option",
"type": "boolean",
"$comment": "group:common",
"default": false
},
"pojoRequest": {
"title": "Pojo Request",
"description": "If we want to use a POJO request as body or not",
"type": "boolean",
"$comment": "group:common",
"default": false
},
"region": {
"title": "Region",
"description": "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()",
"type": "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",
"eu-isoe-west-1",
"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-northeast-1",
"me-south-1",
"sa-east-1",
"ap-east-1",
"cn-north-1",
"ca-west-1",
"us-gov-west-1",
"ap-southeast-1",
"ap-southeast-2",
"us-iso-east-1",
"ap-southeast-3",
"ap-southeast-4",
"us-east-1",
"us-east-2",
"cn-northwest-1",
"us-isob-east-1",
"aws-global",
"aws-cn-global",
"aws-us-gov-global",
"aws-iso-global",
"aws-iso-b-global"
],
"$comment": "group:common"
},
"uriEndpointOverride": {
"title": "Uri Endpoint Override",
"description": "Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option",
"type": "string",
"$comment": "group:common"
},
"autoCreateQueue": {
"title": "Auto Create Queue",
"description": "Whether to auto-create an SQS queue and wire it as an EventBridge rule target.",
"type": "boolean",
"$comment": "group:consumer",
"default": true
},
"deleteQueueOnShutdown": {
"title": "Delete Queue On Shutdown",
"description": "Whether to delete the auto-created SQS queue and remove the EventBridge target on shutdown.",
"type": "boolean",
"$comment": "group:consumer",
"default": true
},
"maxMessagesPerPoll": {
"title": "Max Messages Per Poll",
"description": "The maximum number of messages to receive per poll from SQS.",
"type": "integer",
"$comment": "group:consumer",
"default": 10
},
"queueUrl": {
"title": "Queue Url",
"description": "The URL of an existing SQS queue to use as EventBridge target. If not specified, a queue is auto-created when autoCreateQueue is true.",
"type": "string",
"$comment": "group:consumer"
},
"ruleName": {
"title": "Rule Name",
"description": "The EventBridge rule name to consume events from. Required for consumer.",
"type": "string",
"$comment": "group:consumer"
},
"sendEmptyMessageWhenIdle": {
"title": "Send Empty Message When Idle",
"description": "If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.",
"type": "boolean",
"$comment": "group:consumer",
"default": false
},
"visibilityTimeout": {
"title": "Visibility Timeout",
"description": "The duration (in seconds) that received SQS messages are hidden from subsequent receive requests.",
"type": "integer",
"$comment": "group:consumer",
"default": 30
},
"waitTimeSeconds": {
"title": "Wait Time Seconds",
"description": "The duration (in seconds) for which the SQS receive call waits for messages (long polling).",
"type": "integer",
"$comment": "group:consumer",
"default": 20
},
"bridgeErrorHandler": {
"title": "Bridge Error Handler",
"description": "Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.",
"type": "boolean",
"$comment": "group:consumer (advanced)",
"default": false
},
"exceptionHandler": {
"title": "Exception Handler",
"description": "To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.",
"type": "string",
"$comment": "group:consumer (advanced)",
"format": "bean:org.apache.camel.spi.ExceptionHandler"
},
"exchangePattern": {
"title": "Exchange Pattern",
"description": "Sets the exchange pattern when the consumer creates an exchange.",
"type": "string",
"enum": [
"InOnly",
"InOut"
],
"$comment": "group:consumer (advanced)"
},
"pollStrategy": {
"title": "Poll Strategy",
"description": "A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.",
"type": "string",
"$comment": "group:consumer (advanced)",
"format": "bean:org.apache.camel.spi.PollingConsumerPollStrategy"
},
"lazyStartProducer": {
"title": "Lazy Start Producer",
"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 during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.",
"type": "boolean",
"$comment": "group:producer (advanced)",
"default": false
},
"eventbridgeClient": {
"title": "Eventbridge Client",
"description": "To use an existing configured AWS Eventbridge client",
"type": "string",
"$comment": "group:advanced",
"format": "bean:software.amazon.awssdk.services.eventbridge.EventBridgeClient"
},
"proxyHost": {
"title": "Proxy Host",
"description": "To define a proxy host when instantiating the Eventbridge client",
"type": "string",
"$comment": "group:proxy"
},
"proxyPort": {
"title": "Proxy Port",
"description": "To define a proxy port when instantiating the Eventbridge client",
"type": "integer",
"$comment": "group:proxy"
},
"proxyProtocol": {
"title": "Proxy Protocol",
"description": "To define a proxy protocol when instantiating the Eventbridge client",
"type": "string",
"enum": [
"HTTP",
"HTTPS"
],
"$comment": "group:proxy",
"default": "HTTPS"
},
"backoffErrorThreshold": {
"title": "Backoff Error Threshold",
"description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.",
"type": "integer",
"$comment": "group:scheduler"
},
"backoffIdleThreshold": {
"title": "Backoff Idle Threshold",
"description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.",
"type": "integer",
"$comment": "group:scheduler"
},
"backoffMultiplier": {
"title": "Backoff Multiplier",
"description": "To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.",
"type": "integer",
"$comment": "group:scheduler"
},
"delay": {
"title": "Delay",
"description": "Milliseconds before the next poll.",
"type": "integer",
"$comment": "group:scheduler",
"default": 500
},
"greedy": {
"title": "Greedy",
"description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.",
"type": "boolean",
"$comment": "group:scheduler",
"default": false
},
"initialDelay": {
"title": "Initial Delay",
"description": "Milliseconds before the first poll starts.",
"type": "integer",
"$comment": "group:scheduler",
"default": 1000
},
"repeatCount": {
"title": "Repeat Count",
"description": "Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.",
"type": "integer",
"$comment": "group:scheduler",
"default": 0
},
"runLoggingLevel": {
"title": "Run Logging Level",
"description": "The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.",
"type": "string",
"enum": [
"TRACE",
"DEBUG",
"INFO",
"WARN",
"ERROR",
"OFF"
],
"$comment": "group:scheduler",
"default": "TRACE"
},
"scheduledExecutorService": {
"title": "Scheduled Executor Service",
"description": "Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.",
"type": "string",
"$comment": "group:scheduler",
"format": "bean:java.util.concurrent.ScheduledExecutorService"
},
"scheduler": {
"title": "Scheduler",
"description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler",
"type": "string",
"$comment": "group:scheduler",
"format": "bean:java.lang.Object",
"default": "none"
},
"schedulerProperties": {
"title": "Scheduler Properties",
"description": "To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. This is a multi-value option with prefix: scheduler.",
"type": "object",
"$comment": "group:scheduler"
},
"startScheduler": {
"title": "Start Scheduler",
"description": "Whether the scheduler should be auto started.",
"type": "boolean",
"$comment": "group:scheduler",
"default": true
},
"timeUnit": {
"title": "Time Unit",
"description": "Time unit for initialDelay and delay options.",
"type": "string",
"enum": [
"NANOSECONDS",
"MICROSECONDS",
"MILLISECONDS",
"SECONDS",
"MINUTES",
"HOURS",
"DAYS"
],
"$comment": "group:scheduler",
"default": "MILLISECONDS"
},
"useFixedDelay": {
"title": "Use Fixed Delay",
"description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.",
"type": "boolean",
"$comment": "group:scheduler",
"default": true
},
"accessKey": {
"title": "Access Key",
"description": "Amazon AWS Access Key",
"type": "string",
"$comment": "group:security",
"format": "password"
},
"profileCredentialsName": {
"title": "Profile Credentials Name",
"description": "If using a profile credentials provider this parameter will set the profile name",
"type": "string",
"$comment": "group:security"
},
"secretKey": {
"title": "Secret Key",
"description": "Amazon AWS Secret Key",
"type": "string",
"$comment": "group:security",
"format": "password"
},
"sessionToken": {
"title": "Session Token",
"description": "Amazon AWS Session Token used when the user needs to assume an IAM role",
"type": "string",
"$comment": "group:security",
"format": "password"
},
"trustAllCertificates": {
"title": "Trust All Certificates",
"description": "If we want to trust all certificates in case of overriding the endpoint",
"type": "boolean",
"$comment": "group:security",
"default": false
},
"useDefaultCredentialsProvider": {
"title": "Use Default Credentials Provider",
"description": "Set whether the Eventbridge client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.",
"type": "boolean",
"$comment": "group:security",
"default": false
},
"useProfileCredentialsProvider": {
"title": "Use Profile Credentials Provider",
"description": "Set whether the Eventbridge client should expect to load credentials through a profile credentials provider.",
"type": "boolean",
"$comment": "group:security",
"default": false
},
"useSessionCredentials": {
"title": "Use Session Credentials",
"description": "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.",
"type": "boolean",
"$comment": "group:security",
"default": false
}
},
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"required": [
"eventbusNameOrArn",
"operation"
]
}
}