Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update README.md #1

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72db645
Update README.md
nabrajkhatri Dec 1, 2022
2baef09
updated installation section
nabrajkhatri Dec 1, 2022
0098c44
Update README.md
nabrajkhatri Dec 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ This module will be used to override properties during deployment. This will wor
- properties placeholder
- secure properties placeholder

## Deploying to Exchange
Clone the project to your local, change the groupId to point your orgId. Issue `mvn deploy`.
Ensure that there is an entry in your settings.xml pertaining to Exchange2

## Local Install
For local install, give any groupId. Issue `mvn clean install`
## Installation
- Clone the aws-secrets-manager-properties-provider
- Update the GroupId with your organization Id in Pom.xml.
- Ensure that there is an entry in your settings.xml pertaining to Exchange2
- Install to the Local Maven Repository - use mvn clean install
- Installing to Organization's Exchange - use mvn clean deploy

## Using the module in a Mule4 Project
Add this dependency to your application pom.xml
Expand Down Expand Up @@ -127,6 +127,9 @@ Set this field to true to obtain credentials from the AWS environment, See: http
- There can be `n` number of secrets in AWS Secrets Manager. The best way to access a particular key
`${aws-secrets::key}`

### Caching vs Real-Time
Accessing via "`${aws-secrets::key}`" gives you cached value that is retrieved by a connector when mule app was deployed. Use dataweave ::p expression to get the secrets from aws "real-time". Example is : '#[Mule::p(“aws-secrets::db1-pass”)]'

### Example Usage

```
Expand All @@ -142,4 +145,4 @@ Set this field to true to obtain credentials from the AWS environment, See: http
```

## Contributors
Biswa Mohanty, Rahul Dureja, Srinivasan Raghunathan, Sai Parnandi, Sudhish Sikhamani
Biswa Mohanty, Rahul Dureja, Srinivasan Raghunathan, Sai Parnandi, Sudhish Sikhamani, Nabraj Khatri