Skip to content

Commit 9689663

Browse files
Address Review Comment
1 parent 4267371 commit 9689663

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

ojdbc-provider-aws/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -161,19 +161,21 @@ configuration parameters should be loaded using AWS AppConfig. Users need to spe
161161
A URL with the following format is valid:
162162

163163
<pre>
164-
jdbc:oracle:thin:@config-awsappconfig://{application-identifier}[?appconfig_environment={your-environment}&appconfig_profile={your-profile}]
164+
jdbc:oracle:thin:@config-awsappconfig://{application-identifier}[?appconfig_environment={environment-id-or-name}&appconfig_profile={profile-id-or-name}]
165165
</pre>
166166

167+
All three values are required for the AppConfig Freeform Configuration Provider:
167168

168-
The `{application-identifier}` can be either the application ID or name as defined in [AWS AppConfig](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/appconfigdata/AppConfigDataClient.html).
169-
The environment and configuration profile can be specified in the URL,
169+
- `{application-identifier}`: the name or ID of your AppConfig application, as defined in [AWS AppConfig](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/appconfigdata/AppConfigDataClient.html). This must be provided directly in the URL.
170+
- `{environment-id-or-name}`: the name or ID of the environment within the application (e.g., dev, prod). This can be provided as a URL parameter (`appconfig_environment`), a system property (`aws.appconfig.environment`), or an environment variable (`AWS_APP_CONFIG_ENVIRONMENT`).
171+
- `{profile-id-or-name}`: the name or ID of the configuration profile that contains your settings. This can be provided as a URL parameter (`appconfig_profile`), a system property (`aws.appconfig.profile`), or an environment variable (`AWS_APP_CONFIG_PROFILE`).
170172

171-
for example:
173+
Example using all parameters in the URL:
172174
<pre>
173175
jdbc:oracle:thin:@config-awsappconfig://app-name?appconfig_environment=your-environment&appconfig_profile=your-profile
174176
</pre>
175177

176-
Alternatively, you can set them via system properties (`aws.appconfig.environment, aws.appconfig.profile`) or
178+
Alternatively, you can set the environment and profile via system properties (`aws.appconfig.environment, aws.appconfig.profile`) or
177179
environment variables (`AWS_APP_CONFIG_ENVIRONMENT, AWS_APP_CONFIG_PROFILE`).
178180

179181
## Common Parameters for Centralized Config Providers

0 commit comments

Comments
 (0)