io.micronaut.aws.distributedconfiguration

Interface AwsDistributedConfiguration

All Known Implementing Classes:

AwsDistributedConfigurationProperties

public interface AwsDistributedConfiguration

Configuration for Distributed Configuration using AWS services such as AWS Parameter Store or Secrets Manager.

Since:

2.8.0

Author:

Sergio del Amo

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommonApplicationName()
java.lang.String	getDelimiter() Delimiter after prefix and application name.
java.lang.String	getPrefix()
default java.util.List<java.lang.String>	getPrefixes()
boolean	isSearchActiveEnvironments()
boolean	isSearchCommonApplication()

Method Detail

getPrefix

@NonNull
java.lang.String getPrefix()

Returns:

Prefix for AWS Distributed Configuration resources names. For example `/config/`. If getPrefixes() returns non-empty list, this value is ignored.

getPrefixes

@NonNull
default java.util.List<java.lang.String> getPrefixes()

Returns:

List of prefixes for AWS Distributed Configuration resources names. If it is non-empty, getPrefix() is not used.

Since:

3.12.1

getDelimiter

@NonNull
java.lang.String getDelimiter()

Delimiter after prefix and application name. For /config/application_dev/micronaut.security.oauth2.clients.mycompanyauth.client-secret delimiter will be / The character between /config/application_dev and micronaut.security.oauth2.clients.mycompanyauth.client-secret

Returns:

Delimiter after getPrefix() and application name for AWS Distributed Configuration resources names.

getCommonApplicationName

@NonNull
java.lang.String getCommonApplicationName()

Returns:

Default Application name. e.g. application

isSearchCommonApplication

boolean isSearchCommonApplication()

Returns:

Whether paths for the getCommonApplicationName() should be searched or not.

isSearchActiveEnvironments

boolean isSearchActiveEnvironments()

Returns:

Whether paths with active environment names should be searched or not.