org.apache.camel.builder.endpoint.dsl

Interface IAMEndpointBuilderFactory.IAMEndpointBuilder

All Superinterfaces:

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

Enclosing interface:

IAMEndpointBuilderFactory

public static interface IAMEndpointBuilderFactory.IAMEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the AWS Identity and Access Management (IAM) component.

Method Summary

Modifier and Type	Method and Description
default IAMEndpointBuilderFactory.IAMEndpointBuilder	accessKey(String accessKey) Amazon AWS Access Key.
default IAMEndpointBuilderFactory.AdvancedIAMEndpointBuilder	advanced()
default IAMEndpointBuilderFactory.IAMEndpointBuilder	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 IAMEndpointBuilderFactory.IAMEndpointBuilder	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 IAMEndpointBuilderFactory.IAMEndpointBuilder	iamClient(Object iamClient) To use a existing configured AWS IAM as client.
default IAMEndpointBuilderFactory.IAMEndpointBuilder	iamClient(String iamClient) To use a existing configured AWS IAM as client.
default IAMEndpointBuilderFactory.IAMEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default IAMEndpointBuilderFactory.IAMEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default IAMEndpointBuilderFactory.IAMEndpointBuilder	operation(IAMEndpointBuilderFactory.IAMOperations operation) The operation to perform.
default IAMEndpointBuilderFactory.IAMEndpointBuilder	operation(String operation) The operation to perform.
default IAMEndpointBuilderFactory.IAMEndpointBuilder	proxyHost(String proxyHost) To define a proxy host when instantiating the IAM client.
default IAMEndpointBuilderFactory.IAMEndpointBuilder	proxyPort(Integer proxyPort) To define a proxy port when instantiating the IAM client.
default IAMEndpointBuilderFactory.IAMEndpointBuilder	proxyPort(String proxyPort) To define a proxy port when instantiating the IAM client.
default IAMEndpointBuilderFactory.IAMEndpointBuilder	proxyProtocol(IAMEndpointBuilderFactory.Protocol proxyProtocol) To define a proxy protocol when instantiating the IAM client.
default IAMEndpointBuilderFactory.IAMEndpointBuilder	proxyProtocol(String proxyProtocol) To define a proxy protocol when instantiating the IAM client.
default IAMEndpointBuilderFactory.IAMEndpointBuilder	region(String region) The region in which IAM client needs to work.
default IAMEndpointBuilderFactory.IAMEndpointBuilder	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 IAMEndpointBuilderFactory.AdvancedIAMEndpointBuilder advanced()

autoDiscoverClient

default IAMEndpointBuilderFactory.IAMEndpointBuilder 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

autoDiscoverClient

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

Parameters:

autoDiscoverClient - the value to set

Returns:

the dsl builder

accessKey

default IAMEndpointBuilderFactory.IAMEndpointBuilder 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

iamClient

default IAMEndpointBuilderFactory.IAMEndpointBuilder iamClient(Object iamClient)

To use a existing configured AWS IAM as client. The option is a: <code>com.amazonaws.services.identitymanagement.AmazonIdentityManagement</code> type. Group: producer

Parameters:

iamClient - the value to set

Returns:

the dsl builder

iamClient

default IAMEndpointBuilderFactory.IAMEndpointBuilder iamClient(String iamClient)

To use a existing configured AWS IAM as client. The option will be converted to a <code>com.amazonaws.services.identitymanagement.AmazonIdentityManagement</code> type. Group: producer

Parameters:

iamClient - the value to set

Returns:

the dsl builder

lazyStartProducer

default IAMEndpointBuilderFactory.IAMEndpointBuilder 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 IAMEndpointBuilderFactory.IAMEndpointBuilder 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 IAMEndpointBuilderFactory.IAMEndpointBuilder operation(IAMEndpointBuilderFactory.IAMOperations operation)

The operation to perform. The option is a: <code>org.apache.camel.component.aws.iam.IAMOperations</code> type. Required: true Group: producer

Parameters:

operation - the value to set

Returns:

the dsl builder

operation

default IAMEndpointBuilderFactory.IAMEndpointBuilder operation(String operation)

The operation to perform. The option will be converted to a <code>org.apache.camel.component.aws.iam.IAMOperations</code> type. Required: true Group: producer

Parameters:

operation - the value to set

Returns:

the dsl builder

proxyHost

default IAMEndpointBuilderFactory.IAMEndpointBuilder proxyHost(String proxyHost)

To define a proxy host when instantiating the IAM 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 IAMEndpointBuilderFactory.IAMEndpointBuilder proxyPort(Integer proxyPort)

To define a proxy port when instantiating the IAM 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 IAMEndpointBuilderFactory.IAMEndpointBuilder proxyPort(String proxyPort)

To define a proxy port when instantiating the IAM 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 IAMEndpointBuilderFactory.IAMEndpointBuilder proxyProtocol(IAMEndpointBuilderFactory.Protocol proxyProtocol)

To define a proxy protocol when instantiating the IAM 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

proxyProtocol

default IAMEndpointBuilderFactory.IAMEndpointBuilder proxyProtocol(String proxyProtocol)

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

Parameters:

proxyProtocol - the value to set

Returns:

the dsl builder

region

default IAMEndpointBuilderFactory.IAMEndpointBuilder region(String region)

The region in which IAM 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 IAMEndpointBuilderFactory.IAMEndpointBuilder 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