Constructor
# new AWSOsduSSMCredentialProvider(params)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
params |
Object | AWS configuration and SSM parameters |
|
aws_region |
string | The AWS region in which the OSDU application is deployed |
|
aws_profile |
string |
<optional> |
The AWS credential profile to use when making requests to SSM (typically only for local development) |
username_parameter |
string | SSM parameter identifier where the Cognito username is stored |
|
password_parameter |
string | SSM parameter identifier where the Cognito password is stored |
Methods
# GetCredentials() → {Promise.<Object>|string|string}
Fetch credentials from SSM and serve dynamically
- Configures AWS SDK to use provided credentials for local development or automatic credentials for hosted applications
- Brokers communication with AWS SSM to retrieve Username/Password parameters
credentials - Promise resolving with Cognito username and password
Promise.<Object>
credentials.username - Cognito username
string
credentials.password - Cognito password
string