Package org.apache.camel.builder.endpoint.dsl

Interface STS2EndpointBuilderFactory.STS2EndpointBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    Enclosing interface:
    STS2EndpointBuilderFactory
    public static interface STS2EndpointBuilderFactory.STS2EndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint for the AWS Security Token Service (STS) component.

    • Method Detail

      • lazyStartProducer

        default STS2EndpointBuilderFactory.STS2EndpointBuilder 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

      • lazyStartProducer

        default STS2EndpointBuilderFactory.STS2EndpointBuilder lazyStartProducer​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • operation

        default STS2EndpointBuilderFactory.STS2EndpointBuilder 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. Required: true Default: assumeRole Group: producer
        Parameters:
        operation - the value to set
        Returns:
        the dsl builder

      • operation

        default STS2EndpointBuilderFactory.STS2EndpointBuilder operation​(String operation)
        The operation to perform. The option will be converted to a <code>org.apache.camel.component.aws2.sts.STS2Operations</code> type. Required: true Default: assumeRole Group: producer
        Parameters:
        operation - the value to set
        Returns:
        the dsl builder

      • overrideEndpoint

        default STS2EndpointBuilderFactory.STS2EndpointBuilder 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

      • overrideEndpoint

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

      • pojoRequest

        default STS2EndpointBuilderFactory.STS2EndpointBuilder 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

      • pojoRequest

        default STS2EndpointBuilderFactory.STS2EndpointBuilder pojoRequest​(String pojoRequest)
        If we want to use a POJO request as body or not. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        pojoRequest - the value to set
        Returns:
        the dsl builder

      • proxyHost

        default STS2EndpointBuilderFactory.STS2EndpointBuilder 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 STS2EndpointBuilderFactory.STS2EndpointBuilder 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

      • proxyPort

        default STS2EndpointBuilderFactory.STS2EndpointBuilder proxyPort​(String proxyPort)
        To define a proxy port when instantiating the STS client. The option will be converted to a <code>java.lang.Integer</code> type. Group: producer
        Parameters:
        proxyPort - the value to set
        Returns:
        the dsl builder

      • proxyProtocol

        default STS2EndpointBuilderFactory.STS2EndpointBuilder 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

      • proxyProtocol

        default STS2EndpointBuilderFactory.STS2EndpointBuilder proxyProtocol​(String proxyProtocol)
        To define a proxy protocol when instantiating the STS client. The option will be converted to 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 STS2EndpointBuilderFactory.STS2EndpointBuilder 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 STS2EndpointBuilderFactory.STS2EndpointBuilder 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

      • stsClient

        default STS2EndpointBuilderFactory.STS2EndpointBuilder stsClient​(String stsClient)
        To use a existing configured AWS STS as client. The option will be converted to a <code>software.amazon.awssdk.services.sts.StsClient</code> type. Group: producer
        Parameters:
        stsClient - the value to set
        Returns:
        the dsl builder

      • trustAllCertificates

        default STS2EndpointBuilderFactory.STS2EndpointBuilder 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

      • trustAllCertificates

        default STS2EndpointBuilderFactory.STS2EndpointBuilder trustAllCertificates​(String trustAllCertificates)
        If we want to trust all certificates in case of overriding the endpoint. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        trustAllCertificates - the value to set
        Returns:
        the dsl builder

      • uriEndpointOverride

        default STS2EndpointBuilderFactory.STS2EndpointBuilder 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 STS2EndpointBuilderFactory.STS2EndpointBuilder 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

      • useDefaultCredentialsProvider

        default STS2EndpointBuilderFactory.STS2EndpointBuilder useDefaultCredentialsProvider​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        useDefaultCredentialsProvider - the value to set
        Returns:
        the dsl builder