Interface Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
-
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws2.iam.IAM2Component>
- All Known Implementing Classes:
Aws2IamComponentBuilderFactory.Aws2IamComponentBuilderImpl
- Enclosing interface:
- Aws2IamComponentBuilderFactory
public static interface Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder extends ComponentBuilder<org.apache.camel.component.aws2.iam.IAM2Component>
Builder for the AWS Identity and Access Management (IAM) component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
accessKey(String accessKey)
Amazon AWS Access Key.default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
autowiredEnabled(boolean autowiredEnabled)
Whether autowiring is enabled.default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
configuration(org.apache.camel.component.aws2.iam.IAM2Configuration configuration)
Component configuration.default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
iamClient(software.amazon.awssdk.services.iam.IamClient iamClient)
To use a existing configured AWS IAM as client.default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
operation(org.apache.camel.component.aws2.iam.IAM2Operations operation)
The operation to perform.default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
overrideEndpoint(boolean overrideEndpoint)
Set the need for overidding the endpoint.default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
pojoRequest(boolean pojoRequest)
If we want to use a POJO request as body or not.default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
proxyHost(String proxyHost)
To define a proxy host when instantiating the IAM client.default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
proxyPort(Integer proxyPort)
To define a proxy port when instantiating the IAM client.default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
To define a proxy protocol when instantiating the IAM client.default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
region(String region)
The region in which IAM client needs to work.default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
secretKey(String secretKey)
Amazon AWS Secret Key.default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
trustAllCertificates(boolean trustAllCertificates)
If we want to trust all certificates in case of overriding the endpoint.default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
uriEndpointOverride(String uriEndpointOverride)
Set the overriding uri endpoint.default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder
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.-
Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
-
-
-
Method Detail
-
configuration
default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder configuration(org.apache.camel.component.aws2.iam.IAM2Configuration configuration)
Component configuration. The option is a: <code>org.apache.camel.component.aws2.iam.IAM2Configuration</code> type. Group: producer- Parameters:
configuration
- the value to set- Returns:
- the dsl builder
-
iamClient
default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder iamClient(software.amazon.awssdk.services.iam.IamClient 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
-
lazyStartProducer
default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder 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 Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder operation(org.apache.camel.component.aws2.iam.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
-
overrideEndpoint
default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder 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
-
pojoRequest
default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder 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
-
proxyHost
default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder 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 Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder 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
-
proxyProtocol
default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder proxyProtocol(software.amazon.awssdk.core.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
-
region
default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder 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 Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder 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
-
uriEndpointOverride
default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder 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 Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder 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
-
autowiredEnabled
default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder 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
-
accessKey
default Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder 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 Aws2IamComponentBuilderFactory.Aws2IamComponentBuilder 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
-
-