Skip to content

Commit 340508f

Browse files
committed
fix: Update readme
1 parent ce34105 commit 340508f

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![AWS: CDK Construct](https://img.shields.io/badge/aws-cdk_construct-FF9900?&logo=AmazonAWS)](.)
66
[![Test Coverage](https://img.shields.io/badge/coverage-100%25-22BC22?style=flat&logo=jest)](.)
77

8-
The `cdk-global-parameter` is a CDK (AWS Cloud Development Kit) Construct that allows users to create a Systems Manager String Parameter in multiple AWS regions.
8+
The `cdk-global-parameter` is a CDK (AWS Cloud Development Kit) Construct that allows users to create a Systems Manager String Parameter and replicated to additional AWS regions.
99

1010
## Table of Contents
1111

@@ -35,7 +35,7 @@ const globalParameter = new GlobalStringParameter(this, 'MyGlobalParameter', {
3535
description: 'A global parameter example',
3636
},
3737
tags: [{ Key: 'key1', Value: 'value1' }],
38-
regions: ['us-east-1', 'us-west-2'],
38+
replicaRegions: ['us-east-1', 'us-west-2'],
3939
});
4040
```
4141

@@ -46,8 +46,8 @@ This will create a Systems Manager String Parameter with the specified name, val
4646
The `GlobalStringParameter` construct supports the following configuration options:
4747

4848
- `parameterProps`: [StringParameterProps](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html) - The properties for the parameter to be created.
49-
- `tags`: { [key: string]: string }[]; - Optional tags to be added to the string parameter.
50-
- `regions`: string[] - The list of AWS regions where the string parameter should be created.
49+
- `tags`: { [key: string]: string }[]; - Optional tags to be added to the regional replicated string parameter.
50+
- `replicaRegions`: `string[]` - The list of AWS regions where the string parameter should be created.
5151

5252
## FAQs
5353

0 commit comments

Comments
 (0)