Package org.apache.camel.builder.component.dsl

Interface Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws2.sts.STS2Component>
All Known Implementing Classes:
Aws2StsComponentBuilderFactory.Aws2StsComponentBuilderImpl
Enclosing interface:
Aws2StsComponentBuilderFactory
public static interface Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder extends ComponentBuilder<org.apache.camel.component.aws2.sts.STS2Component>
Builder for the AWS Security Token Service (STS) component.

  • Method Details

    • configuration

      default Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder configuration(org.apache.camel.component.aws2.sts.STS2Configuration configuration)
      Component configuration. The option is a: <code>org.apache.camel.component.aws2.sts.STS2Configuration</code> type. Group: producer
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder lazyStartProducer(boolean lazyStartProducer)
      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. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • operation

      default Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder operation(org.apache.camel.component.aws2.sts.STS2Operations operation)
      The operation to perform. The option is a: <code>org.apache.camel.component.aws2.sts.STS2Operations</code> type. Default: assumeRole Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder overrideEndpoint(boolean overrideEndpoint)
      Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder

    • pojoRequest

      default Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder pojoRequest(boolean pojoRequest)
      If we want to use a POJO request as body or not. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      pojoRequest - the value to set
      Returns:
      the dsl builder

    • proxyHost

      default Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder proxyHost(String proxyHost)
      To define a proxy host when instantiating the STS client. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      proxyHost - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder proxyPort(Integer proxyPort)
      To define a proxy port when instantiating the STS client. The option is a: <code>java.lang.Integer</code> type. Group: producer
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • proxyProtocol

      default Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
      To define a proxy protocol when instantiating the STS client. The option is a: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: producer
      Parameters:
      proxyProtocol - the value to set
      Returns:
      the dsl builder

    • region

      default Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder region(String region)
      The region in which STS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id(). The option is a: <code>java.lang.String</code> type. Default: aws-global Group: producer
      Parameters:
      region - the value to set
      Returns:
      the dsl builder

    • stsClient

      default Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder stsClient(software.amazon.awssdk.services.sts.StsClient stsClient)
      To use a existing configured AWS STS as client. The option is a: <code>software.amazon.awssdk.services.sts.StsClient</code> type. Group: producer
      Parameters:
      stsClient - the value to set
      Returns:
      the dsl builder

    • trustAllCertificates

      default Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder trustAllCertificates(boolean trustAllCertificates)
      If we want to trust all certificates in case of overriding the endpoint. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      trustAllCertificates - the value to set
      Returns:
      the dsl builder

    • uriEndpointOverride

      default Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder uriEndpointOverride(String uriEndpointOverride)
      Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      uriEndpointOverride - the value to set
      Returns:
      the dsl builder

    • useDefaultCredentialsProvider

      default Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
      Set whether the STS client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      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. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • accessKey

      default Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder accessKey(String accessKey)
      Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      accessKey - the value to set
      Returns:
      the dsl builder

    • secretKey

      default Aws2StsComponentBuilderFactory.Aws2StsComponentBuilder secretKey(String secretKey)
      Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      secretKey - the value to set
      Returns:
      the dsl builder