Interface AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws.secretsmanager.SecretsManagerComponent>
- All Known Implementing Classes:
AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilderImpl
- Enclosing interface:
- AwsSecretsManagerComponentBuilderFactory
public static interface AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder
extends ComponentBuilder<org.apache.camel.component.aws.secretsmanager.SecretsManagerComponent>
Builder for the AWS Secrets Manager component.
-
Method Summary
Modifier and TypeMethodDescriptionAmazon AWS Access Key.autowiredEnabled
(boolean autowiredEnabled) Whether autowiring is enabled.binaryPayload
(boolean binaryPayload) Set if the secret is binary or not.configuration
(org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration configuration) Component configuration.lazyStartProducer
(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).operation
(org.apache.camel.component.aws.secretsmanager.SecretsManagerOperations 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 Secrets Manager client.To define a proxy port when instantiating the Secrets Manager client.proxyProtocol
(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the Secrets Manager client.The region in which Secrets Manager client needs to work.Amazon AWS Secret Key.secretsManagerClient
(software.amazon.awssdk.services.secretsmanager.SecretsManagerClient secretsManagerClient) To use a existing configured AWS Secrets Manager as client.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 Translate 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 Secrets Manager 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
-
binaryPayload
default AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder binaryPayload(boolean binaryPayload) Set if the secret is binary or not. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
binaryPayload
- the value to set- Returns:
- the dsl builder
-
configuration
default AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder configuration(org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration configuration) Component configuration. The option is a: <code>org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration</code> type. Group: producer- Parameters:
configuration
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder 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 AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder operation(org.apache.camel.component.aws.secretsmanager.SecretsManagerOperations operation) The operation to perform. The option is a: <code>org.apache.camel.component.aws.secretsmanager.SecretsManagerOperations</code> type. Group: producer- Parameters:
operation
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder 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 AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder 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
-
profileCredentialsName
default AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder 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: producer- Parameters:
profileCredentialsName
- the value to set- Returns:
- the dsl builder
-
proxyHost
default AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder proxyHost(String proxyHost) To define a proxy host when instantiating the Secrets Manager 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 AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder proxyPort(Integer proxyPort) To define a proxy port when instantiating the Secrets Manager 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 AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the Secrets Manager 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 AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder region(String region) The region in which Secrets Manager 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
-
secretsManagerClient
default AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder secretsManagerClient(software.amazon.awssdk.services.secretsmanager.SecretsManagerClient secretsManagerClient) To use a existing configured AWS Secrets Manager as client. The option is a: <code>software.amazon.awssdk.services.secretsmanager.SecretsManagerClient</code> type. Group: producer- Parameters:
secretsManagerClient
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder 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 AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder 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 AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider) Set whether the Translate 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
-
useProfileCredentialsProvider
default AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider) Set whether the Secrets Manager client should expect to load credentials through a profile credentials provider. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
useProfileCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
autowiredEnabled
default AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder 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 AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder 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 AwsSecretsManagerComponentBuilderFactory.AwsSecretsManagerComponentBuilder 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
-