You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Add documentation for environment variables #4327
Problem:
- It isn't obvious what environment variables are used internally and what they are
Solution:
- Pull them into the contributing.md documentation
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+51Lines changed: 51 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -342,6 +342,57 @@ Example:
342
342
}
343
343
```
344
344
345
+
### Environment variables
346
+
347
+
Environment variables can be used to modify the behaviour of VSCode. The following are environment variables that can be used to configure the extension:
348
+
349
+
#### General AWS
350
+
351
+
-`AWS_ACCESS_KEY_ID`: The AWS access key associated with an IAM account. If defined, this environment variable overrides the value for the profile setting aws_access_key_id. For more information see [environment variables to configure the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html)
352
+
-`AWS_SECRET_ACCESS_KEY`: The secret key associated with the access key. This is essentially the "password" for the access key. If defined, this environment variable overrides the value for the profile setting aws_secret_access_key. For more information see [environment variables to configure the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html)
353
+
-`AWS_REGION`: The AWS Region to send the request to. If defined, this environment variable overrides the values in the environment variable AWS_DEFAULT_REGION and the profile setting region. For more information see [environment variables to configure the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html)
354
+
-`AWS_SDK_LOAD_CONFIG`: Controls how the AWS SDK for javascript loads it's configuration when initialized. If the AWS_SDK_LOAD_CONFIG environment variable has been set to a truthy value, the SDK for JavaScript automatically searches for a config file when it loads. For more information see [the shared config file documentation](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-region.html#setting-region-config-file)
355
+
-`AWS_SHARED_CREDENTIALS_FILE`: The location of the file that the AWS CLI uses to store access keys. The default path is `~/.aws/credentials`
356
+
-`AWS_CONFIG_FILE`: The location of the file that the AWS CLI uses to store configuration profiles. The default path is `~/.aws/config`
357
+
358
+
#### General OS
359
+
360
+
-`HOME`: The home directory location for the current user in Linux and other Unix-like operating systems.
361
+
-`SSH_AUTH_SOCK`: The location of a UNIX domain socket used by ssh-agent and SSH clients for agent-based authentication
362
+
-`USERPROFILE`: The absolute path to the profile folder for the current user in Windows
363
+
-`HOMEPATH`: The path to the home directory for the current user in Windows, without including the drive letter
364
+
-`PROGRAMFILES/PROGRAMFILES(X86)`: The default installation directory for Windows
365
+
-`WINDIR`: The location of the Windows installation directory
366
+
-`PATH`: The set of directories where executable programs live
367
+
368
+
#### Codecatalyst
369
+
370
+
-`__DEV_ENVIRONMENT_ID`: The ID of the running development environment. Automatically set when running the toolkit in Codecatalyst
371
+
-`__DEV_ENVIRONMENT_PROJECT_NAME`: The project name associated with the running development environment. Automatically set when running the toolkit in Codecatalyst
372
+
-`__DEV_ENVIRONMENT_SPACE_NAME`: The space name associated with the running development environment. Automatically set when running the toolkit in Codecatalyst
373
+
-`__DEV_ENVIRONMENT_ORGANIZATION_NAME`: The organization name associated with the running development environment. Automatically set when running the toolkit in Codecatalyst
374
+
375
+
#### Lambda
376
+
377
+
-`AUTH_UTIL_LAMBDA_ARN`: The Amazon Resource Name (ARN) of the lambda function
378
+
379
+
#### ECS
380
+
381
+
-`AWS_CONTAINER_CREDENTIALS_RELATIVE_URI`: The relative HTTP URL endpoint for the SDK to use when making a request for credentials. The value is appended to the default Amazon ECS hostname of 169.254.170.2. For more information see [container credential provider](https://docs.aws.amazon.com/sdkref/latest/guide/feature-container-credentials.html)
382
+
-`AWS_CONTAINER_CREDENTIALS_FULL_URI`: The full HTTP URL endpoint for the SDK to use when making a request for credentials. This includes both the scheme and the host. For more information see [container credential provider](https://docs.aws.amazon.com/sdkref/latest/guide/feature-container-credentials.html)
383
+
384
+
#### Step functions
385
+
386
+
-`SSMDOCUMENT_LANGUAGESERVER_PORT`: The port the ssm document language server should start debugging on
387
+
388
+
#### CI/Testing
389
+
390
+
-`GITHUB_ACTION`: The name of the current GitHub Action workflow step that is running
391
+
-`CODEBUILD_BUILD_ID`: The unique ID of the current CodeBuild build that is executing
392
+
-`AWS_TOOLKIT_AUTOMATION`: If tests are currently being ran
393
+
-`DEVELOPMENT_PATH`: The path to the aws toolkit vscode project
394
+
-`AWS_TOOLKIT_TEST_NO_COLOR`: If the tests should include colour in their output
395
+
345
396
### SAM/CFN ("goformation") JSON schema
346
397
347
398
See [docs/cfn-schema-support.md](./docs/cfn-schema-support.md) for how to fix
0 commit comments