Skip to content

Commit a368928

Browse files
dreamorosidreamorosi
committed
docs: fix parameters beta notice
1 parent 65cf9ac commit a368928

File tree

3 files changed

+14
-13
lines changed

3 files changed

+14
-13
lines changed

Diff for: ‎docs/index.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https:
3939

4040
??? note "Note: Click to expand and copy any regional Lambda Layer ARN"
4141

42-
| Region | Layer ARN |
43-
| ---------------- | ----------------------------------------------------------------------------------------------------------- |
42+
| Region | Layer ARN |
43+
| ---------------- | ------------------------------------------------------------------------------------------------------------ |
4444
| `us-east-1` | [arn:aws:lambda:us-east-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:10](#){: .copyMe}:clipboard: |
4545
| `us-east-2` | [arn:aws:lambda:us-east-2:094274105915:layer:AWSLambdaPowertoolsTypeScript:10](#){: .copyMe}:clipboard: |
4646
| `us-west-1` | [arn:aws:lambda:us-west-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:10](#){: .copyMe}:clipboard: |
@@ -281,11 +281,12 @@ If instead you want to see Powertools for TypeScript in a slightly more complex
281281

282282
Core utilities such as Tracing, Logging, and Metrics will be available across all Lambda Powertools languages. Additional utilities are subjective to each language ecosystem and customer demand.
283283

284-
| Utility | Description |
285-
| ---------------------------- | ------------------------------------------------------------------------------------------------------------- |
286-
| [Tracer](./core/tracer.md) | Decorators and utilities to trace Lambda function handlers, and both synchronous and asynchronous functions |
287-
| [Logger](./core/logger.md) | Structured logging made easier, and a middleware to enrich structured logging with key Lambda context details |
288-
| [Metrics](./core/metrics.md) | Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) |
284+
| Utility | Description |
285+
| ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
286+
| [Tracer](./core/tracer.md) | Decorators and utilities to trace Lambda function handlers, and both synchronous and asynchronous functions |
287+
| [Logger](./core/logger.md) | Structured logging made easier, and a middleware to enrich structured logging with key Lambda context details |
288+
| [Metrics](./core/metrics.md) | Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) |
289+
| [Parameters (beta)](./utilities/parameters.md) | High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB |
289290

290291
## Environment variables
291292

Diff for: ‎docs/utilities/parameters.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ description: Utility
44
---
55

66
???+ warning
7-
This page refers to an **unreleased and upcoming utility**. Please refer to this [GitHub milestone](https://github.com/awslabs/aws-lambda-powertools-typescript/milestone/8) for the latest updates.
7+
**This utility is currently released as beta developer preview** and is intended strictly for feedback and testing purposes **and not for production workloads**.. The version and all future versions tagged with the `-beta` suffix should be treated as not stable. Up until before the [General Availability release](https://github.com/awslabs/aws-lambda-powertools-typescript/milestone/10) we might introduce significant breaking changes and improvements in response to customers feedback.
88

99
The Parameters utility provides high-level functions to retrieve one or multiple parameter values from [AWS Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html){target="_blank"}, [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html){target="_blank"}, [AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html){target="_blank"}, [Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Introduction.html){target="_blank"}, or your own parameter store.
1010

1111
## Key features
1212

1313
* Retrieve one or multiple parameters from the underlying provider
1414
* Cache parameter values for a given amount of time (defaults to 5 seconds)
15-
* Transform parameter values from JSON or base 64 encoded strings
15+
* Transform parameter values from JSON or base64 encoded strings
1616
* Bring Your Own Parameter Store Provider
1717

1818
## Getting started
@@ -22,7 +22,7 @@ The Parameters Utility helps to retrieve parameters from the System Manager Para
2222
### Installation
2323

2424
???+ note
25-
This utility supports **[AWS SDK v3 for JavaScript](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/) only**. This allows the utility to be modular, and you to install only the SDK packages you need and keep your bundle size small.
25+
This utility supports **[AWS SDK for JavaScript v3](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/) only**. This allows the utility to be modular, and you to install only the SDK packages you need and keep your bundle size small.
2626

2727
Depending on the provider you want to use, install the library and the corresponding AWS SDK package:
2828

Diff for: ‎packages/parameters/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# AWS Lambda Powertools for TypeScript <!-- omit in toc -->
22

3-
| ⚠️ **WARNING: Do not use this utility in production just yet!** ⚠️ |
4-
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5-
| This AWS Lambda Powertools for TypeScript utility is currently released as beta developer preview and is intended strictly for feedback and testing purposes only. <br/>This version is not stable, and significant breaking changes might incur before going [before the GA release](https://github.com/awslabs/aws-lambda-powertools-typescript/milestone/10). | _ |
3+
| ⚠️ **WARNING: Do not use this utility in production just yet!** ⚠️ |
4+
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
5+
| **This utility is currently released as beta developer preview** and is intended strictly for feedback and testing purposes **and not for production workloads**.. The version and all future versions tagged with the `-beta` suffix should be treated as not stable. Up until before the [General Availability release](https://github.com/awslabs/aws-lambda-powertools-typescript/milestone/10) we might introduce significant breaking changes and improvements in response to customers feedback. | _ |
66

77
Powertools is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#features).
88

0 commit comments

Comments
 (0)