blob: 55ea14b6c06b08a4a569c15228decae805bec111 [file] [log] [blame]
{"component":{"kind":"component","name":"aws2-sts","title":"AWS Security Token Service (STS)","description":"Manage AWS STS cluster instances using AWS SDK version 2.x.","deprecated":false,"firstVersion":"3.5.0","label":"cloud,management","javaType":"org.apache.camel.component.aws2.sts.STS2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-sts","version":"3.18.1","scheme":"aws2-sts","extendsScheme":"","syntax":"aws2-sts:label","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelAwsStsOperation":{"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.sts.STS2Constants#OPERATION"},"CamelAwsStsRoleArn":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon Resource Name (ARN) of the role to assume.","constantName":"org.apache.camel.component.aws2.sts.STS2Constants#ROLE_ARN"},"CamelAwsStsRoleSessionName":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"An identifier for the assumed role session.","constantName":"org.apache.camel.component.aws2.sts.STS2Constants#ROLE_SESSION_NAME"},"CamelAwsStsFederatedName":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the federated user.","constantName":"org.apache.camel.component.aws2.sts.STS2Constants#FEDERATED_NAME"}},"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.sts.STS2Configuration","configurationField":"configuration","description":"Logical name"},"operation":{"kind":"parameter","displayName":"Operation","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.aws2.sts.STS2Operations","enum":["assumeRole","getSessionToken","getFederationToken"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"assumeRole","configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"The operation to perform"},"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.sts.STS2Configuration","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.sts.STS2Configuration","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.sts.STS2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the STS 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.sts.STS2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the STS 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.sts.STS2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the STS client"},"region":{"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"aws-global","configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"The region in which STS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"stsClient":{"kind":"parameter","displayName":"Sts Client","group":"producer","label":"","required":false,"type":"object","javaType":"software.amazon.awssdk.services.sts.StsClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.sts.STS2Configuration","configurationField":"configuration","description":"To use a existing configured AWS STS as client"},"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.sts.STS2Configuration","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.sts.STS2Configuration","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.sts.STS2Configuration","configurationField":"configuration","description":"Set whether the STS 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.sts.STS2Configuration","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.sts.STS2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"}}}