blob: fb483889da43f3928df307f987db32e8572082b2 [file] [log] [blame]
{"component":{"kind":"component","name":"aws2-mq","title":"AWS MQ","description":"Manage AWS MQ instances using AWS SDK version 2.x.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,messaging","javaType":"org.apache.camel.component.aws2.mq.MQ2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-mq","version":"3.18.1","scheme":"aws2-mq","extendsScheme":"","syntax":"aws2-mq:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelAwsMQOperation":{"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.mq.MQ2Constants#OPERATION"},"CamelAwsMQMaxResults":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The number of results that must be retrieved from listBrokers operation","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#MAX_RESULTS"},"CamelAwsMQBrokerName":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The broker name","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_NAME"},"CamelAwsMQBrokerEngine":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Broker Engine for MQ.","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_ENGINE"},"CamelAwsMQBrokerEngineVersion":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Broker Engine Version for MQ. Currently you can choose between 5.15.6 and 5.15.0 of ACTIVEMQ","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_ENGINE_VERSION"},"CamelAwsMQBrokerID":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The broker id","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_ID"},"CamelAwsMQConfigurationID":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"software.amazon.awssdk.services.mq.model.ConfigurationId","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"A list of information about the configuration.","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#CONFIGURATION_ID"},"CamelAwsMQBrokerDeploymentMode":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The deployment mode for the broker in the createBroker operation","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_DEPLOYMENT_MODE"},"CamelAwsMQBrokerInstanceType":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The instance type for the MQ machine in the createBroker operation","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_INSTANCE_TYPE"},"CamelAwsMQBrokerUsers":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List<User>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of users for MQ","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_USERS"},"CamelAwsMQBrokerPubliclyAccessible":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"If the MQ instance must be publicly available or not.","constantName":"org.apache.camel.component.aws2.mq.MQ2Constants#BROKER_PUBLICLY_ACCESSIBLE"}},"properties":{"label":{"kind":"path","displayName":"Label","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Logical name"},"amazonMqClient":{"kind":"parameter","displayName":"Amazon Mq Client","group":"producer","label":"","required":false,"type":"object","javaType":"software.amazon.awssdk.services.mq.MqClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"To use a existing configured AmazonMQClient as client"},"operation":{"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.mq.MQ2Operations","enum":["listBrokers","createBroker","deleteBroker","rebootBroker","updateBroker","describeBroker"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"The operation to perform. It can be listBrokers,createBroker,deleteBroker"},"overrideEndpoint":{"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.mq.MQ2Configuration","configurationField":"configuration","description":"Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option"},"pojoRequest":{"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.mq.MQ2Configuration","configurationField":"configuration","description":"If we want to use a POJO request as body or not"},"proxyHost":{"kind":"parameter","displayName":"Proxy Host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the MQ client"},"proxyPort":{"kind":"parameter","displayName":"Proxy Port","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the MQ client"},"proxyProtocol":{"kind":"parameter","displayName":"Proxy Protocol","group":"producer","label":"","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.mq.MQ2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the MQ client"},"region":{"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"The region in which MQ 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()"},"trustAllCertificates":{"kind":"parameter","displayName":"Trust All Certificates","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"uriEndpointOverride":{"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.mq.MQ2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.mq.MQ2Configuration","configurationField":"configuration","description":"Set whether the MQ client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"lazyStartProducer":{"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."},"accessKey":{"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.mq.MQ2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"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.mq.MQ2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"}}}