org.apache.camel.builder.component.dsl

Interface AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.aws.kms.KMSComponent>

All Known Implementing Classes:

AwsKmsComponentBuilderFactory.AwsKmsComponentBuilderImpl

Enclosing interface:

AwsKmsComponentBuilderFactory

public static interface AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder
extends ComponentBuilder<org.apache.camel.component.aws.kms.KMSComponent>

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

Method Summary

Modifier and Type	Method and Description
default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder	accessKey(String accessKey) Amazon AWS Access Key.
default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder	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 AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder	autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.
default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder	configuration(org.apache.camel.component.aws.kms.KMSConfiguration configuration) The Component configuration.
default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder	kmsClient(com.amazonaws.services.kms.AWSKMS kmsClient) To use a existing configured AWS KMS as client.
default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder	operation(org.apache.camel.component.aws.kms.KMSOperations operation) The operation to perform.
default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder	proxyHost(String proxyHost) To define a proxy host when instantiating the KMS client.
default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder	proxyPort(Integer proxyPort) To define a proxy port when instantiating the KMS client.
default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder	proxyProtocol(com.amazonaws.Protocol proxyProtocol) To define a proxy protocol when instantiating the KMS client.
default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder	region(String region) The region in which KMS client needs to work.
default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder	secretKey(String secretKey) Amazon AWS Secret Key.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

build, build, doSetProperty, register

Method Detail

autoDiscoverClient

default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder 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: <code>boolean</code> type. Default: true Group: common

Parameters:

autoDiscoverClient - the value to set

Returns:

the dsl builder

accessKey

default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder accessKey(String accessKey)

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

Parameters:

accessKey - the value to set

Returns:

the dsl builder

configuration

default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder configuration(org.apache.camel.component.aws.kms.KMSConfiguration configuration)

The Component configuration. The option is a: <code>org.apache.camel.component.aws.kms.KMSConfiguration</code> type. Group: producer

Parameters:

configuration - the value to set

Returns:

the dsl builder

kmsClient

default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder kmsClient(com.amazonaws.services.kms.AWSKMS kmsClient)

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

Parameters:

kmsClient - the value to set

Returns:

the dsl builder

lazyStartProducer

default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder 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 AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder operation(org.apache.camel.component.aws.kms.KMSOperations operation)

The operation to perform. The option is a: <code>org.apache.camel.component.aws.kms.KMSOperations</code> type. Group: producer

Parameters:

operation - the value to set

Returns:

the dsl builder

proxyHost

default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder proxyHost(String proxyHost)

To define a proxy host when instantiating the KMS 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 AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder proxyPort(Integer proxyPort)

To define a proxy port when instantiating the KMS 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 AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder proxyProtocol(com.amazonaws.Protocol proxyProtocol)

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

Parameters:

proxyProtocol - the value to set

Returns:

the dsl builder

region

default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder 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: <code>java.lang.String</code> type. Group: producer

Parameters:

region - the value to set

Returns:

the dsl builder

secretKey

default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder secretKey(String secretKey)

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

Parameters:

secretKey - the value to set

Returns:

the dsl builder

autowiredEnabled

default AwsKmsComponentBuilderFactory.AwsKmsComponentBuilder 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