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

Interface SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    Enclosing interface:
    SecretsManagerEndpointBuilderFactory
    public static interface SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint for the AWS Secrets Manager component.

    • Method Detail

      • lazyStartProducer

        default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder 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 SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder 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 SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder operation​(String operation)
        The operation to perform. The option will be converted to a <code>org.apache.camel.component.aws.secretsmanager.SecretsManagerOperations</code> type. Required: true Group: producer
        Parameters:
        operation - the value to set
        Returns:
        the dsl builder

      • overrideEndpoint

        default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder 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 SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder 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

      • proxyProtocol

        default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder proxyProtocol​(String proxyProtocol)
        To define a proxy protocol when instantiating the Secrets Manager 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 SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder region​(String region)
        The region in which Secrets Manager 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. Group: producer
        Parameters:
        region - the value to set
        Returns:
        the dsl builder

      • secretsManagerClient

        default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder secretsManagerClient​(Object secretsManagerClient)
        To use a existing configured AWS Secrets Manager as client. The option is a: <code>software.amazon.awssdk.services.secretsmanager.SecretsManagerClient</code> type. Group: producer
        Parameters:
        secretsManagerClient - the value to set
        Returns:
        the dsl builder

      • secretsManagerClient

        default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder secretsManagerClient​(String secretsManagerClient)
        To use a existing configured AWS Secrets Manager as client. The option will be converted to a <code>software.amazon.awssdk.services.secretsmanager.SecretsManagerClient</code> type. Group: producer
        Parameters:
        secretsManagerClient - the value to set
        Returns:
        the dsl builder

      • trustAllCertificates

        default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder 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 SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder 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 SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder 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 SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder useDefaultCredentialsProvider​(boolean useDefaultCredentialsProvider)
        Set whether the Translate 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 SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder useDefaultCredentialsProvider​(String useDefaultCredentialsProvider)
        Set whether the Translate 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