org.apache.camel.builder.endpoint.dsl

Interface KMSEndpointBuilderFactory.KMSEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

KMSEndpointBuilderFactory

public static interface KMSEndpointBuilderFactory.KMSEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the AWS Key Management Service (KMS) component.

Method Summary

Modifier and Type	Method and Description
default KMSEndpointBuilderFactory.KMSEndpointBuilder	accessKey(String accessKey) Amazon AWS Access Key.
default KMSEndpointBuilderFactory.AdvancedKMSEndpointBuilder	advanced()
default KMSEndpointBuilderFactory.KMSEndpointBuilder	autoDiscoverClient(boolean autoDiscoverClient) Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.
default KMSEndpointBuilderFactory.KMSEndpointBuilder	autoDiscoverClient(String autoDiscoverClient) Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.
default KMSEndpointBuilderFactory.KMSEndpointBuilder	kmsClient(Object kmsClient) To use a existing configured AWS KMS as client.
default KMSEndpointBuilderFactory.KMSEndpointBuilder	kmsClient(String kmsClient) To use a existing configured AWS KMS as client.
default KMSEndpointBuilderFactory.KMSEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default KMSEndpointBuilderFactory.KMSEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default KMSEndpointBuilderFactory.KMSEndpointBuilder	operation(KMSEndpointBuilderFactory.KMSOperations operation) The operation to perform.
default KMSEndpointBuilderFactory.KMSEndpointBuilder	operation(String operation) The operation to perform.
default KMSEndpointBuilderFactory.KMSEndpointBuilder	proxyHost(String proxyHost) To define a proxy host when instantiating the KMS client.
default KMSEndpointBuilderFactory.KMSEndpointBuilder	proxyPort(Integer proxyPort) To define a proxy port when instantiating the KMS client.
default KMSEndpointBuilderFactory.KMSEndpointBuilder	proxyPort(String proxyPort) To define a proxy port when instantiating the KMS client.
default KMSEndpointBuilderFactory.KMSEndpointBuilder	proxyProtocol(KMSEndpointBuilderFactory.Protocol proxyProtocol) To define a proxy protocol when instantiating the KMS client.
default KMSEndpointBuilderFactory.KMSEndpointBuilder	proxyProtocol(String proxyProtocol) To define a proxy protocol when instantiating the KMS client.
default KMSEndpointBuilderFactory.KMSEndpointBuilder	region(String region) The region in which KMS client needs to work.
default KMSEndpointBuilderFactory.KMSEndpointBuilder	secretKey(String secretKey) Amazon AWS Secret Key.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default KMSEndpointBuilderFactory.AdvancedKMSEndpointBuilder advanced()

autoDiscoverClient

default KMSEndpointBuilderFactory.KMSEndpointBuilder autoDiscoverClient(boolean autoDiscoverClient)

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option is a: boolean type. Default: true Group: common

autoDiscoverClient

default KMSEndpointBuilderFactory.KMSEndpointBuilder autoDiscoverClient(String autoDiscoverClient)

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option will be converted to a boolean type. Default: true Group: common

accessKey

default KMSEndpointBuilderFactory.KMSEndpointBuilder accessKey(String accessKey)

Amazon AWS Access Key. The option is a: java.lang.String type. Group: producer

kmsClient

default KMSEndpointBuilderFactory.KMSEndpointBuilder kmsClient(Object kmsClient)

To use a existing configured AWS KMS as client. The option is a: com.amazonaws.services.kms.AWSKMS type. Group: producer

kmsClient

default KMSEndpointBuilderFactory.KMSEndpointBuilder kmsClient(String kmsClient)

To use a existing configured AWS KMS as client. The option will be converted to a com.amazonaws.services.kms.AWSKMS type. Group: producer

lazyStartProducer

default KMSEndpointBuilderFactory.KMSEndpointBuilder 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: boolean type. Default: false Group: producer

lazyStartProducer

default KMSEndpointBuilderFactory.KMSEndpointBuilder 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 boolean type. Default: false Group: producer

operation

default KMSEndpointBuilderFactory.KMSEndpointBuilder operation(KMSEndpointBuilderFactory.KMSOperations operation)

The operation to perform. The option is a: org.apache.camel.component.aws.kms.KMSOperations type. Required: true Group: producer

operation

default KMSEndpointBuilderFactory.KMSEndpointBuilder operation(String operation)

The operation to perform. The option will be converted to a org.apache.camel.component.aws.kms.KMSOperations type. Required: true Group: producer

proxyHost

default KMSEndpointBuilderFactory.KMSEndpointBuilder proxyHost(String proxyHost)

To define a proxy host when instantiating the KMS client. The option is a: java.lang.String type. Group: producer

proxyPort

default KMSEndpointBuilderFactory.KMSEndpointBuilder proxyPort(Integer proxyPort)

To define a proxy port when instantiating the KMS client. The option is a: java.lang.Integer type. Group: producer

proxyPort

default KMSEndpointBuilderFactory.KMSEndpointBuilder proxyPort(String proxyPort)

To define a proxy port when instantiating the KMS client. The option will be converted to a java.lang.Integer type. Group: producer

proxyProtocol

default KMSEndpointBuilderFactory.KMSEndpointBuilder proxyProtocol(KMSEndpointBuilderFactory.Protocol proxyProtocol)

To define a proxy protocol when instantiating the KMS client. The option is a: com.amazonaws.Protocol type. Default: HTTPS Group: producer

proxyProtocol

default KMSEndpointBuilderFactory.KMSEndpointBuilder proxyProtocol(String proxyProtocol)

To define a proxy protocol when instantiating the KMS client. The option will be converted to a com.amazonaws.Protocol type. Default: HTTPS Group: producer

region

default KMSEndpointBuilderFactory.KMSEndpointBuilder region(String region)

The region in which KMS client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name(). The option is a: java.lang.String type. Group: producer

secretKey

default KMSEndpointBuilderFactory.KMSEndpointBuilder secretKey(String secretKey)

Amazon AWS Secret Key. The option is a: java.lang.String type. Group: producer