Interface Aws2KmsComponentBuilderFactory.Aws2KmsComponentBuilder
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws2.kms.KMS2Component>
- All Known Implementing Classes:
Aws2KmsComponentBuilderFactory.Aws2KmsComponentBuilderImpl
- Enclosing interface:
- Aws2KmsComponentBuilderFactory
public static interface Aws2KmsComponentBuilderFactory.Aws2KmsComponentBuilder
extends ComponentBuilder<org.apache.camel.component.aws2.kms.KMS2Component>
Builder for the AWS Key Management Service (KMS) component.
-
Method Summary
Modifier and TypeMethodDescriptionAmazon AWS Access Key.autowiredEnabled
(boolean autowiredEnabled) Whether autowiring is enabled.configuration
(org.apache.camel.component.aws2.kms.KMS2Configuration configuration) Component configuration.kmsClient
(software.amazon.awssdk.services.kms.KmsClient kmsClient) To use a existing configured AWS KMS as client.lazyStartProducer
(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).operation
(org.apache.camel.component.aws2.kms.KMS2Operations operation) The operation to perform.overrideEndpoint
(boolean overrideEndpoint) Set the need for overidding 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 KMS client.To define a proxy port when instantiating the KMS client.proxyProtocol
(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the KMS client.The region in which EKS client needs to work.Amazon AWS Secret Key.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 KMS 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 KMS client should expect to load credentials through a profile credentials provider.Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
Method Details
-
configuration
default Aws2KmsComponentBuilderFactory.Aws2KmsComponentBuilder configuration(org.apache.camel.component.aws2.kms.KMS2Configuration configuration) Component configuration. The option is a: <code>org.apache.camel.component.aws2.kms.KMS2Configuration</code> type. Group: producer- Parameters:
configuration
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default Aws2KmsComponentBuilderFactory.Aws2KmsComponentBuilder 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 Aws2KmsComponentBuilderFactory.Aws2KmsComponentBuilder operation(org.apache.camel.component.aws2.kms.KMS2Operations operation) The operation to perform. The option is a: <code>org.apache.camel.component.aws2.kms.KMS2Operations</code> type. Group: producer- Parameters:
operation
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default Aws2KmsComponentBuilderFactory.Aws2KmsComponentBuilder 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
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 EKS 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 Aws2KmsComponentBuilderFactory.Aws2KmsComponentBuilder 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 Aws2KmsComponentBuilderFactory.Aws2KmsComponentBuilder 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
-
kmsClient
default Aws2KmsComponentBuilderFactory.Aws2KmsComponentBuilder kmsClient(software.amazon.awssdk.services.kms.KmsClient kmsClient) To use a existing configured AWS KMS as client. The option is a: <code>software.amazon.awssdk.services.kms.KmsClient</code> type. Group: advanced- Parameters:
kmsClient
- the value to set- Returns:
- the dsl builder
-
proxyHost
To define a proxy host when instantiating the KMS 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 KMS 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 Aws2KmsComponentBuilderFactory.Aws2KmsComponentBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the KMS 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 Aws2KmsComponentBuilderFactory.Aws2KmsComponentBuilder 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
-
trustAllCertificates
default Aws2KmsComponentBuilderFactory.Aws2KmsComponentBuilder 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 Aws2KmsComponentBuilderFactory.Aws2KmsComponentBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider) Set whether the KMS 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 Aws2KmsComponentBuilderFactory.Aws2KmsComponentBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider) Set whether the KMS 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
-