Skip to content

Commit b8e0e6f

Browse files
committed
added important information section
1 parent bfbef98 commit b8e0e6f

File tree

1 file changed

+8
-1
lines changed
  • src/OpenFeature.Contrib.Providers.AwsAppConfig

1 file changed

+8
-1
lines changed

src/OpenFeature.Contrib.Providers.AwsAppConfig/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,11 @@ Additionally, at this point Required Minimum Polling Interval in seconds can als
5656
In this stage, to retrieve the AWS AppConfig feature flag, the key should be supplied in the format `configurationProfileId:flagKey[:attributeKey]`. If the AttributeKey is not included, all attributes will be returned as a structured object.
5757

5858
## Important information about the implementation
59-
As per AWS AppConfig documentation, the recommended way to access AWS AppConfig is by using
59+
As per AWS [AppConfig documentation](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-agent-how-to-use.html), **the recommended way for retrieving configuration data from AWS AppConfig is by using AWS AppConfig Agent, but this implemntation is not using the agents, rather uses AWS AppConfig APIs** in order to have more control around caching and parsing the returned response.
60+
61+
This implementation uses in-memory IMemoryCache implementation, but any other cache can be easily swapped with if needed.
62+
63+
*For detailed AWS appconfig documentation refer AWS documentation page. (link provided in References Section below).*
6064

6165
## Usage
6266

@@ -150,3 +154,6 @@ app.MapGet("/protected-feature", async (IFeatureClient featureClient) =>
150154
.WithName("ProtectedFeature")
151155
.WithOpenApi();
152156
```
157+
158+
## References
159+
1. [AWS AppConfig documentation](https://docs.aws.amazon.com/appconfig/)

0 commit comments

Comments
 (0)