paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 26 Packages Projects Releases Wiki Activity

Use integration-aws-node for credentials in S3 Techdocs

Browse Source 
Signed-off-by: Clare Liguori <liguori@amazon.com>
This commit is contained in:
Clare Liguori
2022-11-28 13:23:26 -08:00
parent 13278732f6
commit e40790d0c2
9 changed files with 198 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/techdocs-backend/config.d.ts
Vendored
+15 -1
View File
@@ -81,9 +81,23 @@ export interface Config {
* Required when 'type' is set to awsS3
*/
awsS3?: {
/**
* (Optional) The AWS account ID where the storage bucket is located.
* Credentials for the account ID will be sourced from the 'aws' app config section.
* See the
* [integration-aws-node package](https://github.com/backstage/backstage/blob/master/packages/integration-aws-node/README.md)
* for details on how to configure the credentials in the app config.
* If account ID is not set and no credentials are set, environment variables or aws config file will be used to authenticate.
* @see https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-environment.html
* @see https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-shared.html
* @visibility secret
*/
accountId?: string;
/**
* (Optional) Credentials used to access a storage bucket.
* If not set, environment variables or aws config file will be used to authenticate.
* This section is now deprecated. Configuring the account ID is now preferred, with credentials in the 'aws'
* app config section.
* If not set and no account ID is set, environment variables or aws config file will be used to authenticate.
* @see https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-environment.html
* @see https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-shared.html
* @visibility secret