Package org.apache.camel.main

Class AwsVaultConfigurationProperties

java.lang.Object

org.apache.camel.vault.VaultConfiguration

org.apache.camel.vault.AwsVaultConfiguration

org.apache.camel.main.AwsVaultConfigurationProperties

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.camel.spi.BootstrapCloseable

@Configurer(extended=true)
public class AwsVaultConfigurationProperties
extends org.apache.camel.vault.AwsVaultConfiguration
implements org.apache.camel.spi.BootstrapCloseable

Configuration for access to AWS Secret.

Constructor Summary

Constructors

Constructor	Description
AwsVaultConfigurationProperties(MainConfigurationProperties parent)

Method Summary

Modifier and Type	Method	Description
void	close()
MainConfigurationProperties	end()
AwsVaultConfigurationProperties	isOverrideEndpoint(boolean overrideEndpoint)	Set the need for overriding the endpoint.
AwsVaultConfigurationProperties	withAccessKey(String accessKey)	The AWS access key
AwsVaultConfigurationProperties	withDefaultCredentialsProvider(boolean defaultCredentialsProvider)	Define if we want to use the AWS Default Credentials Provider or not
AwsVaultConfigurationProperties	withProfileCredentialsProvider(boolean profileCredentialsProvider)	Define if we want to use the AWS Profile Credentials Provider or not
AwsVaultConfigurationProperties	withProfileName(String profileName)	Define the profile name if we are using the Profile Credentials Provider
AwsVaultConfigurationProperties	withRefreshEnabled(boolean refreshEnabled)	Whether to automatically reload Camel upon secrets being updated in AWS.
AwsVaultConfigurationProperties	withRefreshPeriod(long refreshPeriod)	The period (millis) between checking AWS for updated secrets.
AwsVaultConfigurationProperties	withRegion(String region)	The AWS region
AwsVaultConfigurationProperties	withSecretKey(String secretKey)	The AWS secret key
AwsVaultConfigurationProperties	withSecrets(String secrets)	Specify the secret names (or pattern) to check for updates.
AwsVaultConfigurationProperties	withSqsQueueName(String sqsQueueUrl)	In case of usage of SQS notification this field will specified the Queue URL to use
AwsVaultConfigurationProperties	withUriEndpointOverride(String uriEndpointOverride)	Set the overriding uri endpoint.
AwsVaultConfigurationProperties	withUseSqsNotification(boolean useSqsNotification)	Whether to use AWS SQS for secrets updates notification, this will require setting up Eventbridge/Cloudtrail/SQS communication

Methods inherited from class org.apache.camel.vault.AwsVaultConfiguration

getAccessKey, getProfileName, getRefreshPeriod, getRegion, getSecretKey, getSecrets, getSqsQueueUrl, getUriEndpointOverride, isDefaultCredentialsProvider, isOverrideEndpoint, isProfileCredentialsProvider, isRefreshEnabled, isUseSqsNotification, setAccessKey, setDefaultCredentialsProvider, setOverrideEndpoint, setProfileCredentialsProvider, setProfileName, setRefreshEnabled, setRefreshPeriod, setRegion, setSecretKey, setSecrets, setSqsQueueUrl, setUriEndpointOverride, setUseSqsNotification

Methods inherited from class org.apache.camel.vault.VaultConfiguration

aws, azure, gcp, getAwsVaultConfiguration, getAzureVaultConfiguration, getGcpVaultConfiguration, getHashicorpVaultConfiguration, getIBMSecretsManagerVaultConfiguration, getKubernetesConfigMapVaultConfiguration, getKubernetesVaultConfiguration, getSpringCloudConfigConfiguration, hashicorp, ibmSecretsManager, kubernetes, kubernetesConfigmaps, setAwsVaultConfiguration, setAzureVaultConfiguration, setGcpVaultConfiguration, setHashicorpVaultConfiguration, setIBMSecretsManagerVaultConfiguration, setKubernetesConfigMapVaultConfiguration, setKubernetesVaultConfiguration, setSpringCloudConfigConfiguration, springConfig

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AwsVaultConfigurationProperties

public AwsVaultConfigurationProperties(MainConfigurationProperties parent)

Method Details

end

public MainConfigurationProperties end()

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

withAccessKey

public AwsVaultConfigurationProperties withAccessKey(String accessKey)

The AWS access key

withSecretKey

public AwsVaultConfigurationProperties withSecretKey(String secretKey)

The AWS secret key

withRegion

public AwsVaultConfigurationProperties withRegion(String region)

The AWS region

withDefaultCredentialsProvider

public AwsVaultConfigurationProperties withDefaultCredentialsProvider(boolean defaultCredentialsProvider)

Define if we want to use the AWS Default Credentials Provider or not

withProfileCredentialsProvider

public AwsVaultConfigurationProperties withProfileCredentialsProvider(boolean profileCredentialsProvider)

Define if we want to use the AWS Profile Credentials Provider or not

withProfileName

public AwsVaultConfigurationProperties withProfileName(String profileName)

Define the profile name if we are using the Profile Credentials Provider

withRefreshEnabled

public AwsVaultConfigurationProperties withRefreshEnabled(boolean refreshEnabled)

Whether to automatically reload Camel upon secrets being updated in AWS.

withRefreshPeriod

public AwsVaultConfigurationProperties withRefreshPeriod(long refreshPeriod)

The period (millis) between checking AWS for updated secrets.

withSecrets

public AwsVaultConfigurationProperties withSecrets(String secrets)

Specify the secret names (or pattern) to check for updates. Multiple secrets can be separated by comma.

withUseSqsNotification

public AwsVaultConfigurationProperties withUseSqsNotification(boolean useSqsNotification)

Whether to use AWS SQS for secrets updates notification, this will require setting up Eventbridge/Cloudtrail/SQS communication

withSqsQueueName

public AwsVaultConfigurationProperties withSqsQueueName(String sqsQueueUrl)

In case of usage of SQS notification this field will specified the Queue URL to use

isOverrideEndpoint

public AwsVaultConfigurationProperties isOverrideEndpoint(boolean overrideEndpoint)

Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option

withUriEndpointOverride

public AwsVaultConfigurationProperties withUriEndpointOverride(String uriEndpointOverride)

Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option