Interface AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws.config.AWSConfigComponent>
- All Known Implementing Classes:
AwsConfigComponentBuilderFactory.AwsConfigComponentBuilderImpl
- Enclosing interface:
AwsConfigComponentBuilderFactory
public static interface AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder
extends ComponentBuilder<org.apache.camel.component.aws.config.AWSConfigComponent>
Builder for the AWS Config Service component.
-
Method Summary
Modifier and TypeMethodDescriptionAmazon AWS Access Key.autowiredEnabled
(boolean autowiredEnabled) Whether autowiring is enabled.configClient
(software.amazon.awssdk.services.config.ConfigClient configClient) Amazon AWS Config Client instance.configuration
(org.apache.camel.component.aws.config.AWSConfigConfiguration configuration) Component configuration.healthCheckConsumerEnabled
(boolean healthCheckConsumerEnabled) Used for enabling or disabling all consumer based health checks from this component.healthCheckProducerEnabled
(boolean healthCheckProducerEnabled) Used for enabling or disabling all producer based health checks from this component.lazyStartProducer
(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).operation
(org.apache.camel.component.aws.config.AWSConfigOperations operation) The operation to perform.overrideEndpoint
(boolean overrideEndpoint) Set the need for overriding the endpoint.pojoRequest
(boolean pojoRequest) If we want to use a POJO request as body or not.profileCredentialsName
(String profileCredentialsName) If using a profile credentials provider, this parameter will set the profile name.To define a proxy host when instantiating the Config client.To define a proxy port when instantiating the Config client.proxyProtocol
(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the Config client.The region in which the Config client needs to work.Amazon AWS Secret Key.sessionToken
(String sessionToken) Amazon AWS Session Token used when the user needs to assume an IAM role.trustAllCertificates
(boolean trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.uriEndpointOverride
(String uriEndpointOverride) Set the overriding uri endpoint.useDefaultCredentialsProvider
(boolean useDefaultCredentialsProvider) Set whether the Config client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.useProfileCredentialsProvider
(boolean useProfileCredentialsProvider) Set whether the Config client should expect to load credentials through a profile credentials provider.useSessionCredentials
(boolean useSessionCredentials) Set whether the Config client should expect to use Session Credentials.Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
Method Details
-
configuration
default AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder configuration(org.apache.camel.component.aws.config.AWSConfigConfiguration configuration) Component configuration. The option is a: <code>org.apache.camel.component.aws.config.AWSConfigConfiguration</code> type. Group: producer- Parameters:
configuration
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder 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 AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder operation(org.apache.camel.component.aws.config.AWSConfigOperations operation) The operation to perform. The option is a: <code>org.apache.camel.component.aws.config.AWSConfigOperations</code> type. Group: producer- Parameters:
operation
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder overrideEndpoint(boolean overrideEndpoint) Set the need for overriding the endpoint. This option needs to be used in combination with the 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
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
-
region
The region in which the Config 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. Group: producer- Parameters:
region
- the value to set- Returns:
- the dsl builder
-
uriEndpointOverride
default AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder 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
-
autowiredEnabled
default AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder 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
-
configClient
default AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder configClient(software.amazon.awssdk.services.config.ConfigClient configClient) Amazon AWS Config Client instance. The option is a: <code>software.amazon.awssdk.services.config.ConfigClient</code> type. Group: advanced- Parameters:
configClient
- the value to set- Returns:
- the dsl builder
-
healthCheckConsumerEnabled
default AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder healthCheckConsumerEnabled(boolean healthCheckConsumerEnabled) Used for enabling or disabling all consumer based health checks from this component. The option is a: <code>boolean</code> type. Default: true Group: health- Parameters:
healthCheckConsumerEnabled
- the value to set- Returns:
- the dsl builder
-
healthCheckProducerEnabled
default AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder healthCheckProducerEnabled(boolean healthCheckProducerEnabled) Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. The option is a: <code>boolean</code> type. Default: true Group: health- Parameters:
healthCheckProducerEnabled
- the value to set- Returns:
- the dsl builder
-
proxyHost
To define a proxy host when instantiating the Config client. The option is a: <code>java.lang.String</code> type. Group: proxy- Parameters:
proxyHost
- the value to set- Returns:
- the dsl builder
-
proxyPort
To define a proxy port when instantiating the Config client. The option is a: <code>java.lang.Integer</code> type. Group: proxy- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the Config client. The option is a: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
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
-
profileCredentialsName
default AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder profileCredentialsName(String profileCredentialsName) If using a profile credentials provider, this parameter will set the profile name. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
profileCredentialsName
- the value to set- Returns:
- the dsl builder
-
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
-
sessionToken
default AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder sessionToken(String sessionToken) Amazon AWS Session Token used when the user needs to assume an IAM role. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
sessionToken
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder 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: security- Parameters:
trustAllCertificates
- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider) Set whether the Config 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: security- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useProfileCredentialsProvider
default AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider) Set whether the Config client should expect to load credentials through a profile credentials provider. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
useProfileCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useSessionCredentials
default AwsConfigComponentBuilderFactory.AwsConfigComponentBuilder useSessionCredentials(boolean useSessionCredentials) Set whether the Config client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in Config. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
useSessionCredentials
- the value to set- Returns:
- the dsl builder
-