TechDocs/AWS: Enable authentication using env variables and ~/.aws/config shared file

If authentication secrets are provided in app-config.yaml, it will be used. If not, environment variables AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_REGION will be used. If not present, ~/.aws/config will be used to read the configs.

https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-environment.html
https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-shared.html
https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-region.html
This commit is contained in:
Himanshu Mishra
2021-01-12 11:41:00 +01:00
parent 1c7771871e
commit 16b73697a3
3 changed files with 58 additions and 28 deletions
+10 -5
View File
@@ -78,10 +78,13 @@ export interface Config {
*/
awsS3?: {
/**
* Credentials used to access a storage bucket
* (Optional) Credentials used to access a storage bucket.
* If not set, environment variables or aws config file will be used to authenticate.
* https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-environment.html
* https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-shared.html
* @visibility secret
*/
credentials: {
credentials?: {
/**
* User access key id
* attr: 'accessKeyId' - accepts a string value
@@ -98,11 +101,13 @@ export interface Config {
/**
* Cloud Storage Bucket Name
* attr: 'bucketName' - accepts a string value
* @visibility secret
* @visibility backend
*/
bucketName: string;
/**
* AWS Region
* (Optional) AWS Region.
* If not set, AWS_REGION environment variable or aws config file will be used.
* https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-region.html
* attr: 'region' - accepts a string value
* @visibility secret
*/
@@ -125,7 +130,7 @@ export interface Config {
/**
* (Required) Cloud Storage Bucket Name
* attr: 'bucketName' - accepts a string value
* @visibility secret
* @visibility backend
*/
bucketName: string;
/**