Skip to content

Commit 236ab7f

Browse files
authored
docs(parameters): clarify caching behavior of getAppConfig (#3808)
1 parent 663d328 commit 236ab7f

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ Core utilities such as Tracing, Logging, and Metrics will be available across al
366366
| -------------------------------------------- |------------------------------------------------------------------------------------------| --------------------------------------- |-------------------------------------------------|
367367
| **POWERTOOLS_SERVICE_NAME** | Set service name used for tracing namespace, metrics dimension and structured logging | All | `service_undefined` |
368368
| **POWERTOOLS_METRICS_NAMESPACE** | Set namespace used for metrics | [Metrics](core/metrics.md) | `default_namespace` |
369-
| **POWERTOOLS_METRICS_FUNCTION_NAME** | Function name used as dimension for the `ColdStart` metric | [Metrics](core/metrics.md) | [See docs](core/metrics/#setting-function-name) |
369+
| **POWERTOOLS_METRICS_FUNCTION_NAME** | Function name used as dimension for the `ColdStart` metric | [Metrics](core/metrics.md) | [See docs](core/metrics.md#setting-function-name) |
370370
| **POWERTOOLS_METRICS_ENABLED** | Explicitly disables emitting metrics to stdout | [Metrics](core/metrics.md) | `true` |
371371
| **POWERTOOLS_TRACE_ENABLED** | Explicitly disables tracing | [Tracer](core/tracer.md) | `true` |
372372
| **POWERTOOLS_TRACER_CAPTURE_RESPONSE** | Capture Lambda or method return as metadata. | [Tracer](core/tracer.md) | `true` |

docs/utilities/parameters.md

+2
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,8 @@ The following will retrieve the latest version and store it in the cache.
137137
--8<-- "examples/snippets/parameters/getAppConfig.ts"
138138
```
139139

140+
When using `getAppConfig`, the [underlying provider](#appconfigprovider) is cached. To fetch from different applications or environments, create separate `AppConfigProvider` instances for each application/environment combination.
141+
140142
## Advanced
141143

142144
### Adjusting cache TTL

packages/idempotency/src/types/IdempotencyRecord.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import type { JSONValue } from '@aws-lambda-powertools/commons/types';
22
import type { IdempotencyRecordStatus } from '../constants.js';
3-
3+
import type { DynamoDBPersistenceLayer } from '../persistence/DynamoDBPersistenceLayer.js';
44
/**
55
* The status of an IdempotencyRecord
66
*/
@@ -22,7 +22,7 @@ type IdempotencyRecordOptions = {
2222
/**
2323
* The idempotency record status can be COMPLETED, IN_PROGRESS or EXPIRED.
2424
* We check the status during idempotency processing to make sure we don't process an expired record and handle concurrent requests.
25-
* {@link constants.IdempotencyRecordStatusValue | IdempotencyRecordStatusValue}
25+
* {@link IdempotencyRecordStatusValue | IdempotencyRecordStatusValue}
2626
*/
2727
status: IdempotencyRecordStatusValue;
2828
/**

0 commit comments

Comments
 (0)