Skip to content

Commit 70f6ab5

Browse files
sdelamotimyates
andauthoredFeb 1, 2024
doc: improve paramterstore configuration reference (#2034)
* doc: improve paramterstore configuration reference * Add description for AwsDistributedConfigurationProperties#prefixes as well --------- Co-authored-by: Tim Yates <tim.yates@gmail.com>
1 parent 7c7301c commit 70f6ab5

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed
 

‎aws-distributed-configuration/src/main/java/io/micronaut/aws/distributedconfiguration/AwsDistributedConfigurationProperties.java

+8-2
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ public void setDelimiter(@NonNull String delimiter) {
7777
}
7878

7979
/**
80+
* Search additional paths suffixed with each active environment. e.g. /config/application_ec2 Default value ({@value #DEFAULT_SEARCH_ACTIVE_ENVIRONMENTS}).
8081
* @return Search active environment paths
8182
*/
8283
@Override
@@ -96,7 +97,7 @@ public void setSearchActiveEnvironments(boolean searchActiveEnvironments) {
9697
}
9798

9899
/**
99-
*
100+
* Whether paths for the Default Application name should be searched or not. Default value ({@value #DEFAULT_SEARCH_COMMON_APPLICATION}).
100101
* @return Whether paths for the {@link AwsDistributedConfiguration#getCommonApplicationName()} should be searched or not.
101102
*/
102103
@Override
@@ -118,6 +119,11 @@ public List<String> getPrefixes() {
118119
return prefixes;
119120
}
120121

122+
/**
123+
* List of prefixes for AWS Distributed Configuration resources names. If it is non-empty, {@link AwsDistributedConfiguration#getPrefix()} is not used.
124+
*
125+
* @param prefixes the list of prefixes
126+
*/
121127
public void setPrefixes(@NonNull List<String> prefixes) {
122128
this.prefixes = prefixes;
123129
}
@@ -143,7 +149,7 @@ public String getCommonApplicationName() {
143149
}
144150

145151
/**
146-
* Default Application name. Default value ({@value #DEFAULT_COMMON_APPLICATION_NAME}.
152+
* Default Application name. Default value ({@value #DEFAULT_COMMON_APPLICATION_NAME}).
147153
* @param commonApplicationName Default Application name. e.g. application
148154
*/
149155
public void setCommonApplicationName(@NonNull String commonApplicationName) {

0 commit comments

Comments
 (0)
Please sign in to comment.