IAM2EndpointBuilderFactory.IAM2EndpointBuilder (Camel

All Superinterfaces:

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

Enclosing interface:

IAM2EndpointBuilderFactory
```
public static interface IAM2EndpointBuilderFactory.IAM2EndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
```
Builder for endpoint for the AWS Identity and Access Management (IAM) component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`accessKey(String accessKey)` Amazon AWS Access Key.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`iamClient(Object iamClient)` To use a existing configured AWS IAM as client.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`iamClient(String iamClient)` To use a existing configured AWS IAM as client.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`lazyStartProducer(String lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`operation(IAM2EndpointBuilderFactory.IAM2Operations operation)` The operation to perform.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`operation(String operation)` The operation to perform.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`overrideEndpoint(boolean overrideEndpoint)` Set the need for overidding the endpoint.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`overrideEndpoint(String overrideEndpoint)` Set the need for overidding the endpoint.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`pojoRequest(boolean pojoRequest)` If we want to use a POJO request as body or not.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`pojoRequest(String pojoRequest)` If we want to use a POJO request as body or not.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`proxyHost(String proxyHost)` To define a proxy host when instantiating the IAM client.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`proxyPort(Integer proxyPort)` To define a proxy port when instantiating the IAM client.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`proxyPort(String proxyPort)` To define a proxy port when instantiating the IAM client.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`proxyProtocol(IAM2EndpointBuilderFactory.Protocol proxyProtocol)` To define a proxy protocol when instantiating the IAM client.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`proxyProtocol(String proxyProtocol)` To define a proxy protocol when instantiating the IAM client.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`region(String region)` The region in which IAM client needs to work.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`secretKey(String secretKey)` Amazon AWS Secret Key.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`trustAllCertificates(boolean trustAllCertificates)` If we want to trust all certificates in case of overriding the endpoint.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`trustAllCertificates(String trustAllCertificates)` If we want to trust all certificates in case of overriding the endpoint.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`uriEndpointOverride(String uriEndpointOverride)` Set the overriding uri endpoint.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)` Set whether the IAM client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.
`default IAM2EndpointBuilderFactory.IAM2EndpointBuilder`	`useDefaultCredentialsProvider(String useDefaultCredentialsProvider)` Set whether the IAM client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.

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
  - iamClient
```
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder iamClient(Object iamClient)
```
    To use a existing configured AWS IAM as client. The option is a: <code>software.amazon.awssdk.services.iam.IamClient</code> type. Group: producer
    
    Parameters:
    
    iamClient - the value to set
    
    Returns:
    
    the dsl builder
  - iamClient
```
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder iamClient(String iamClient)
```
    To use a existing configured AWS IAM as client. The option will be converted to a <code>software.amazon.awssdk.services.iam.IamClient</code> type. Group: producer
    
    Parameters:
    
    iamClient - the value to set
    
    Returns:
    
    the dsl builder
  - lazyStartProducer
```
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder 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 IAM2EndpointBuilderFactory.IAM2EndpointBuilder 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 IAM2EndpointBuilderFactory.IAM2EndpointBuilder operation(IAM2EndpointBuilderFactory.IAM2Operations operation)
```
    The operation to perform. You can configure a default operation on the component level, or the operation as part of the endpoint, or via a message header with the key CamelAwsIAMOperation. The option is a: <code>org.apache.camel.component.aws2.iam.IAM2Operations</code> type. Group: producer
    
    Parameters:
    
    operation - the value to set
    
    Returns:
    
    the dsl builder
  - operation
```
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder operation(String operation)
```
    The operation to perform. You can configure a default operation on the component level, or the operation as part of the endpoint, or via a message header with the key CamelAwsIAMOperation. The option will be converted to a <code>org.apache.camel.component.aws2.iam.IAM2Operations</code> type. Group: producer
    
    Parameters:
    
    operation - the value to set
    
    Returns:
    
    the dsl builder
  - overrideEndpoint
```
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder 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 IAM2EndpointBuilderFactory.IAM2EndpointBuilder 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 IAM2EndpointBuilderFactory.IAM2EndpointBuilder 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 IAM2EndpointBuilderFactory.IAM2EndpointBuilder 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 IAM2EndpointBuilderFactory.IAM2EndpointBuilder 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 IAM2EndpointBuilderFactory.IAM2EndpointBuilder 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 IAM2EndpointBuilderFactory.IAM2EndpointBuilder 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 IAM2EndpointBuilderFactory.IAM2EndpointBuilder proxyProtocol(IAM2EndpointBuilderFactory.Protocol proxyProtocol)
```
    To define a proxy protocol when instantiating the IAM 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 IAM2EndpointBuilderFactory.IAM2EndpointBuilder proxyProtocol(String proxyProtocol)
```
    To define a proxy protocol when instantiating the IAM 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 IAM2EndpointBuilderFactory.IAM2EndpointBuilder region(String region)
```
    The region in which IAM 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
  - trustAllCertificates
```
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder 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 IAM2EndpointBuilderFactory.IAM2EndpointBuilder 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 IAM2EndpointBuilderFactory.IAM2EndpointBuilder 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 IAM2EndpointBuilderFactory.IAM2EndpointBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
```
    Set whether the IAM 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 IAM2EndpointBuilderFactory.IAM2EndpointBuilder useDefaultCredentialsProvider(String useDefaultCredentialsProvider)
```
    Set whether the IAM 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
  - accessKey
```
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder accessKey(String accessKey)
```
    Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    accessKey - the value to set
    
    Returns:
    
    the dsl builder
  - secretKey
```
default IAM2EndpointBuilderFactory.IAM2EndpointBuilder secretKey(String secretKey)
```
    Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    secretKey - the value to set
    
    Returns:
    
    the dsl builder

Interface IAM2EndpointBuilderFactory.IAM2EndpointBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

iamClient

iamClient

lazyStartProducer

lazyStartProducer

operation

operation

overrideEndpoint

overrideEndpoint

pojoRequest

pojoRequest

proxyHost

proxyPort

proxyPort

proxyProtocol

proxyProtocol

region

trustAllCertificates

trustAllCertificates

uriEndpointOverride

useDefaultCredentialsProvider

useDefaultCredentialsProvider

accessKey

secretKey