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
To run tests against a specific folder in VSCode, do any one of:
195
+
196
+
- Add the TEST_DIR environment variable to one of the testing launch configs and run it
197
+
- Run in your terminal
198
+
- Unix/macOS/POSIX shell:
199
+
```
200
+
TEST_DIR=src/test/foo npm run test
201
+
```
202
+
- Powershell:
203
+
```
204
+
$Env:TEST_DIR = "src/test/foo"; npm run test
205
+
```
206
+
192
207
### Browser Support
193
208
194
209
Running the extension in the browser (eg: [vscode.dev](https://vscode.dev/)).
@@ -329,7 +344,7 @@ Example:
329
344
}
330
345
```
331
346
332
-
Overrides specifically for CodeCatalyst can be set using the `aws.dev.codecatalystService` setting. This is a JSON object consisting of keys/values required to override API calls to CodeCatalyst: `region`, `endpoint`, `hostname`, and `gitHostname`. If this setting is present, then all keys need to be explicitly provided.
347
+
<aname="codecatalyst-settings">Overrides specifically for CodeCatalyst can be set using the `aws.dev.codecatalystService` setting. This is a JSON object consisting of keys/values required to override API calls to CodeCatalyst: `region`, `endpoint`, `hostname`, and `gitHostname`. If this setting is present, then all keys need to be explicitly provided.</a>
333
348
334
349
Example:
335
350
@@ -342,6 +357,85 @@ Example:
342
357
}
343
358
```
344
359
360
+
<aname="codewhisperer-settings">Overrides specifically for CodeWhisperer/Amazon Q can be set using the `aws.dev.codewhispererService` setting. This is a JSON object consisting of keys/values required to override API calls to CodeWhisperer/Amazon Q: `region` and `endpoint`. If this setting is present, then all keys need to be explicitly provided.</a>
Environment variables can be used to modify the behaviour of VSCode. The following are environment variables that can be used to configure the extension:
374
+
375
+
#### General AWS
376
+
377
+
-`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)
378
+
-`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)
379
+
-`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)
380
+
-`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)
381
+
-`AWS_SHARED_CREDENTIALS_FILE`: The location of the file that the AWS CLI uses to store access keys. The default path is `~/.aws/credentials`
382
+
-`AWS_CONFIG_FILE`: The location of the file that the AWS CLI uses to store configuration profiles. The default path is `~/.aws/config`
383
+
384
+
#### General OS
385
+
386
+
-`HOME`: The home directory location for the current user in Linux and other Unix-like operating systems.
387
+
-`SSH_AUTH_SOCK`: The location of a UNIX domain socket used by ssh-agent and SSH clients for agent-based authentication
388
+
-`USERPROFILE`: The absolute path to the profile folder for the current user in Windows
389
+
-`HOMEPATH`: The path to the home directory for the current user in Windows, without including the drive letter
390
+
-`PROGRAMFILES/PROGRAMFILES(X86)`: The default installation directory for Windows
391
+
-`WINDIR`: The location of the Windows installation directory
392
+
-`PATH`: The set of directories where executable programs live
393
+
394
+
#### Codecatalyst
395
+
396
+
-`__DEV_ENVIRONMENT_ID`: The ID of the running development environment. Automatically set when running the toolkit in Codecatalyst
397
+
-`__DEV_ENVIRONMENT_PROJECT_NAME`: The project name associated with the running development environment. Automatically set when running the toolkit in Codecatalyst
398
+
-`__DEV_ENVIRONMENT_SPACE_NAME`: The space name associated with the running development environment. Automatically set when running the toolkit in Codecatalyst
399
+
-`__DEV_ENVIRONMENT_ORGANIZATION_NAME`: The organization name associated with the running development environment. Automatically set when running the toolkit in Codecatalyst
400
+
401
+
The following are environment variable versions of the user `settings.json` overrides mentioned [here](#codecatalyst-settings). These will always override the toolkit defaults and those defined in `settings.json`.
402
+
Unlike the user setting overrides, not all of these environment variables have to be set to make use of them.
403
+
404
+
-`__CODECATALYST_REGION`: for aws.dev.codecatalystService.region
405
+
-`__CODECATALYST_ENDPOINT`: for aws.dev.codecatalystService.endpoint
406
+
-`__CODECATALYST_HOSTNAME`: for aws.dev.codecatalystService.hostname
407
+
-`__CODECATALYST_GIT_HOSTNAME`: for aws.dev.codecatalystService.gitHostname
408
+
409
+
#### Codewhisperer/Amazon Q
410
+
411
+
The following are environment variable versions of the user `settings.json` overrides mentioned [here](#codewhisperer-settings). These will always override the toolkit defaults and those defined in `settings.json`.
412
+
Unlike the user setting overrides, not all of these environment variables have to be set to make use of them.
413
+
414
+
-`__CODEWHISPERER_REGION`: for aws.dev.codewhispererService.region
415
+
-`__CODEWHISPERER_ENDPOINT`: for aws.dev.codewhispererService.endpoint
416
+
417
+
#### Lambda
418
+
419
+
-`AUTH_UTIL_LAMBDA_ARN`: The Amazon Resource Name (ARN) of the lambda function
420
+
421
+
#### ECS
422
+
423
+
-`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)
424
+
-`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)
425
+
426
+
#### Step functions
427
+
428
+
-`SSMDOCUMENT_LANGUAGESERVER_PORT`: The port the ssm document language server should start debugging on
429
+
430
+
#### CI/Testing
431
+
432
+
-`GITHUB_ACTION`: The name of the current GitHub Action workflow step that is running
433
+
-`CODEBUILD_BUILD_ID`: The unique ID of the current CodeBuild build that is executing
434
+
-`AWS_TOOLKIT_AUTOMATION`: If tests are currently being ran
435
+
-`DEVELOPMENT_PATH`: The path to the aws toolkit vscode project
436
+
-`AWS_TOOLKIT_TEST_NO_COLOR`: If the tests should include colour in their output
437
+
-`TEST_DIR` - The directory where the test runner should find the tests
438
+
345
439
### SAM/CFN ("goformation") JSON schema
346
440
347
441
See [docs/cfn-schema-support.md](./docs/cfn-schema-support.md) for how to fix
0 commit comments