Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
545 changes: 545 additions & 0 deletions agents.md

Large diffs are not rendered by default.

19 changes: 15 additions & 4 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,13 @@ export default defineConfig({
collapsed: true,
items: [{ autogenerate: { directory: '/aws/getting-started' } }],
},
{
label: 'Quickstart Library',
collapsed: true,
items: [
{ autogenerate: { directory: '/aws/quickstart-library' } },
],
},
{
label: 'Local AWS Services',
slug: 'aws/services',
Expand Down Expand Up @@ -604,7 +611,8 @@ export default defineConfig({
items: [
{
autogenerate: {
directory: '/aws/customization/integrations/extensions',
directory:
'/aws/customization/integrations/extensions',
},
},
{
Expand All @@ -619,7 +627,8 @@ export default defineConfig({
items: [
{
autogenerate: {
directory: '/aws/customization/integrations/localstack-sdks',
directory:
'/aws/customization/integrations/localstack-sdks',
},
},
],
Expand All @@ -630,7 +639,8 @@ export default defineConfig({
items: [
{
autogenerate: {
directory: '/aws/customization/integrations/app-frameworks',
directory:
'/aws/customization/integrations/app-frameworks',
},
},
],
Expand All @@ -641,7 +651,8 @@ export default defineConfig({
items: [
{
autogenerate: {
directory: '/aws/customization/integrations/testing',
directory:
'/aws/customization/integrations/testing',
},
},
],
Expand Down
160 changes: 75 additions & 85 deletions public/_redirects

Large diffs are not rendered by default.

Binary file added public/images/aws/app-inspector-operations.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/aws/lambda-resource-browser.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/aws/load-state-from-pod.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed public/images/aws/merge-strategies.png
Binary file not shown.
Binary file removed public/images/aws/persistence-pods-remote.png
Binary file not shown.
Binary file added public/images/aws/running-instance-sidebar.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/aws/snapshot-merge-service.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/aws/stack-overview.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/aws/verify-cloud-pod-save.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions public/js/icon-loader.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
const iconMappings = {
Welcome: 'cube-icon',
'Getting Started': 'rocket-icon',
'Quickstart Library': 'lightning-icon',
'Local AWS Services': 'cube-icon',
'Local Azure Services': 'cube-icon',
Features: 'cube-icon',
Expand Down
7 changes: 6 additions & 1 deletion scripts/redirects/redirects_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -1975,7 +1975,12 @@
},
{
"old_link": "/getting-started/quickstart/",
"new_link": "/aws/getting-started/quickstart",
"new_link": "/aws/getting-started/local-development/",
"status_code": 301
},
{
"old_link": "/aws/getting-started/quickstart/",
"new_link": "/aws/getting-started/local-development/",
"status_code": 301
},
{
Expand Down
3 changes: 3 additions & 0 deletions src/assets/images/lightning.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/content/docs/aws/ci-pipelines/circleci.md
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,7 @@ jobs:
- localstack-load-state
```

More information about Localstack's [state import/export](/aws/developer-tools/snapshots/export-import-state).
More information about Localstack's [state import/export](/aws/developer-tools/snapshots/save-snapshots-locally).

#### Cache

Expand Down Expand Up @@ -586,4 +586,4 @@ workflows:
...
```

More information about [state management](/aws/developer-tools/snapshots/export-import-state).
More information about [state management](/aws/developer-tools/snapshots/save-snapshots-locally).
4 changes: 2 additions & 2 deletions src/content/docs/aws/ci-pipelines/codebuild.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ Find out more about [ephemeral instances](/aws/developer-tools/cloud-sandbox/eph

#### Artifact

Find out more about [state management](/aws/developer-tools/snapshots/export-import-state/).
Find out more about [state management](/aws/developer-tools/snapshots/save-snapshots-locally/).

```yml showshowLineNumbers
...
Expand Down Expand Up @@ -274,7 +274,7 @@ To use previously stored artifacts as inputs, set them as a source in the projec

#### Cache

Additional information about [state export and import](/aws/developer-tools/snapshots/export-import-state/).
Additional information about [state export and import](/aws/developer-tools/snapshots/save-snapshots-locally/).

##### Native Runner

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/aws/ci-pipelines/github-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Find out more about ephemeral instances [here](/aws/developer-tools/cloud-sandbo
...
```

More information about state import and export [here](/aws/developer-tools/snapshots/export-import-state).
More information about state import and export [here](/aws/developer-tools/snapshots/save-snapshots-locally).

## Current Limitations

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/aws/ci-pipelines/gitlab-ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ job:
...
```

More info about Localstack's state export and import [here](/aws/developer-tools/snapshots/export-import-state/).
More info about Localstack's state export and import [here](/aws/developer-tools/snapshots/save-snapshots-locally/).

#### Cache

Expand All @@ -159,7 +159,7 @@ job:
...
```

Additional information about state export and import [here](/aws/developer-tools/snapshots/export-import-state/).
Additional information about state export and import [here](/aws/developer-tools/snapshots/save-snapshots-locally/).

#### Cloud Pod

Expand Down
8 changes: 4 additions & 4 deletions src/content/docs/aws/customization/configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Options that affect the core LocalStack system.
| `DEBUG` | `0` (default) \|`1`| Flag to increase log level and print more verbose logs (useful for troubleshooting issues)|
| `IMAGE_NAME`| `localstack/localstack` (default), `localstack/localstack:0.11.0` | Specific name and tag of LocalStack Docker image to use.|
| `LOCALSTACK_HOST`| `localhost.localstack.cloud:4566` (default) | This is interpolated into URLs and addresses that are returned by LocalStack. It has the form `<hostname>:<port>`. |
| `GATEWAY_LISTEN` | `0.0.0.0:4566` (default in Docker mode), `127.0.0.1:4566` (default in host mode) | Configures the bind addresses of LocalStack. It has the form `<ip address>:<port>(,<ip address>:<port>)*`. LocalStack for AWS adds port `443`. |
| `GATEWAY_LISTEN` | `0.0.0.0:4566,0.0.0.0:443` (default in Docker mode), `127.0.0.1:4566,127.0.0.1:443` (default in host mode) | Configures the bind addresses of LocalStack. It has the form `<ip address>:<port>(,<ip address>:<port>)*`. When unset, LocalStack listens on both the HTTP edge port (`4566`) and HTTPS (`443`). |
| `USE_SSL` | `0` (default) | Whether to return URLs using HTTP (`0`) or HTTPS (`1`). Changed with 3.0.0. In earlier versions this was toggling SSL support on or off. |
| `PERSISTENCE` | `0` (default) | Enable persistence. See [Persistence Mechanism](/aws/developer-tools/snapshots/persistence) and [Filesystem Layout](/aws/customization/advanced/filesystem). |
| `MAIN_CONTAINER_NAME` | `localstack-main` (default) | Specify the main docker container name |
Expand Down Expand Up @@ -397,7 +397,7 @@ To learn more about these configuration options, see [Persistence](/aws/develope
| `SNAPSHOT_SAVE_STRATEGY` | `ON_SHUTDOWN`\|`ON_REQUEST`\|`SCHEDULED`\|`MANUAL` | Strategy that governs when LocalStack should make state snapshots |
| `SNAPSHOT_LOAD_STRATEGY` | `ON_STARTUP`\|`ON_REQUEST`\|`MANUAL` | Strategy that governs when LocalStack restores state snapshots |
| `SNAPSHOT_FLUSH_INTERVAL` | 15 (default) | The interval (in seconds) between persistence snapshots. It only applies to a `SCHEDULED` save strategy (see [Persistence Mechanism](/aws/developer-tools/snapshots/persistence))|
| `DISABLE_COMPATIBILITY_RULES` | `0` (default) \| `1` | Disable the [state compatibility rules](/aws/developer-tools/snapshots/persistence#state-compatibility) that prevent loading incompatible state into LocalStack. Applies to both snapshot persistence and Cloud Pods. |
| `DISABLE_COMPATIBILITY_RULES` | `0` (default) \| `1` | Disable the [snapshot compatibility rules](/aws/developer-tools/snapshots/service-coverage#state-compatibility) that prevent loading incompatible state into LocalStack. Applies to both snapshot persistence and Cloud Pods. |

## Cloud Pods

Expand All @@ -409,7 +409,7 @@ To learn more about these configuration options, see [Cloud Pods](/aws/developer
| `POD_LOAD_CLI_TIMEOUT` | 60 (default) | Timeout in seconds to wait before returning from load operations on the Cloud Pods CLI |
| `POD_ENCRYPTION` | `0` (default) \| `1` | Whether to encrypt the Cloud Pods artifacts at rest. |
| `ENABLE_POD_RESOURCES=1` | `0` (default) \| `1` | Whether to save a detailed Stack Overview including available resources for the Cloud Pod |
| `MERGE_STRATEGY` | `account-region-merge` (default) \| `service-merge` \| `overwrite` | The merge strategy to apply when loading a Cloud Pod into LocalStack (see [state merging](/aws/developer-tools/snapshots/cloud-pods/#state-merging)) |
| `MERGE_STRATEGY` | `account-region-merge` (default) \| `service-merge` \| `overwrite` | The merge strategy to apply when loading a Cloud Pod into LocalStack (see [snapshot merging](/aws/developer-tools/snapshots/save-snapshots-locally/#snapshot-merging)) |

## Extensions

Expand Down Expand Up @@ -462,7 +462,6 @@ To learn more about these configuration options, see [DNS Server](/aws/customiza

| Variable | Example Values | Description |
|----------------------|----------------|-------------|
| `ACTIVATE_PRO` | `0` \| `1`&nbsp;(default) | Whether Pro should be activated or not. This is set to true by default if using the `localstack/localstack-pro` container image. If set to `1`, LocalStack will fail to start if the license key activation did not work. If set to `0`, an attempt is made to start LocalStack without Pro features. |
| `LOCALSTACK_AUTH_TOKEN` | | [Auth token](/aws/getting-started/auth-token) to activate LocalStack for AWS. |
| `LOCALSTACK_API_KEY` | | **Deprecated since 3.0.0** API key to activate LocalStack for AWS.<br/> **Use the `LOCALSTACK_AUTH_TOKEN` instead (except for [CI environments](/aws/ci-pipelines/)).** |
| `LOG_LICENSE_ISSUES` | `0` \| `1`&nbsp;(default) | Whether to log issues with the license activation to the console. |
Expand All @@ -476,6 +475,7 @@ These configurations have already been removed and **won't have any effect** on

| Variable | Removed in | Example Values | Description |
| - | - | - | - |
| `ACTIVATE_PRO` | 2026.7.0 | `0` \| `1` (default) | Whether Pro should be activated or not. Previously allowed starting LocalStack without Pro features when set to `0`. The flag had no remaining effect and was removed; use the community image (`localstack/localstack`) if you do not need Pro features. |
| `EVENT_RULE_ENGINE` | 4.1.0 | `python` (default) \| `java` (deprecated) | Engine for [event pattern matching](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns-content-based-filtering.html) used in EventBridge, EventBridge Pipes, and Lambda Event Source Mapping. Our new `python` implementation introduced with version `4.0.3` makes the `java` engine (previously in preview) using AWS [event-ruler](https://github.com/aws/event-ruler) obsolete. |
| `LAMBDA_EVENT_SOURCE_MAPPING` | 4.0.0 | `v2` (default since [3.8.0](https://blog.localstack.cloud/localstack-release-v-3-8-0/#new-default-lambda-event-source-mapping-implementation)) \| `v1` | Feature flag to switch Lambda Event Source Mapping (ESM) implementations. |
| `PROVIDER_OVERRIDE_STEPFUNCTIONS` | 4.0.0 | `v2` (default) \| `legacy` | The new LocalStack-native StepFunctions provider (v2) is active by default since LocalStack 3.0. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,6 @@ The `devcontainer.json` will look similar to the following:
"LOCALSTACK_AUTH_TOKEN": "${localEnv:LOCALSTACK_AUTH_TOKEN}", // required for Pro, not processed via template due to security reasons
"LOCALSTACK_API_KEY": "${localEnv:LOCALSTACK_API_KEY}",
// LocalStack configuration: https://docs.localstack.cloud/references/configuration/
"ACTIVATE_PRO": false,
"DEBUG": true,
"LS_LOG": "debug",
"PERSISTENCE": false,
Expand Down Expand Up @@ -414,7 +413,6 @@ FROM mcr.microsoft.com/devcontainers/base:bookworm
LOCALSTACK_AUTH_TOKEN=${LOCALSTACK_AUTH_TOKEN:-} # required for Pro, not processed via template due to security reasons
LOCALSTACK_API_KEY=${LOCALSTACK_API_KEY:-}
# LocalStack configuration: https://docs.localstack.cloud/references/configuration/
ACTIVATE_PRO=false
DEBUG=true
LS_LOG=debug
PERSISTENCE=false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The main integrations are:

- **License activation**: The standard image performs online activation using your `LOCALSTACK_AUTH_TOKEN`. See [Auth Token](/aws/getting-started/auth-token) for activation behavior and fallbacks.
- **Event reporting (telemetry)**: Used for Stack Insights and related usage analytics. You can disable this via `DISABLE_EVENTS=1`.
- **Cloud Pods (platform remote)**: Saving/loading pods against the default platform remote uses LocalStack-managed infrastructure. For stricter data residency, configure your own Cloud Pods [remote storage](/aws/developer-tools/snapshots/cloud-pods#remotes).
- **Cloud Pods (platform remote)**: Saving/loading pods against the default platform remote uses LocalStack-managed infrastructure. For stricter data residency, configure your own Cloud Pods [remote storage](/aws/developer-tools/snapshots/other-snapshot-storage-options#remotes).
- **Ephemeral instances**: These are managed cloud instances and therefore require connectivity to LocalStack Cloud services.

### Recommended setup for offline environments
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ A valid `LOCALSTACK_AUTH_TOKEN` must be configured to start the LocalStack for A

:::note
The Replicator is in limited preview and is available from LocalStack CLI version 4.2.0.
If you encounter issues, update your [LocalStack CLI](/aws/getting-started/installation/#updating-localstack-cli).
If you encounter issues, update your [LocalStack CLI](/aws/getting-started/installation/#update-localstack-cli).
:::

### Retrieve credentials to access AWS
Expand Down Expand Up @@ -85,7 +85,7 @@ The replication type and explore strategy are independent: `replication_type` se

The Replicator CLI is part of the LocalStack CLI.

Follow the [installation instructions](/aws/getting-started/installation/#installing-localstack-cli) to set it up.
Follow the [installation instructions](/aws/getting-started/installation/#install-localstack-cli) to set it up.

To start a replication job, get the ARN of the resource to replicate. Then, trigger the job using the command:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ If you have created a Cloud Pod from an older version of LocalStack, you need to

## Ephemeral Instances CLI

The Ephemeral Instances CLI is included in the [LocalStack CLI installation](/aws/getting-started/installation/#installing-localstack-cli), so no additional installations are needed to start using it.
The Ephemeral Instances CLI is included in the [LocalStack CLI installation](/aws/getting-started/installation/#install-localstack-cli), so no additional installations are needed to start using it.
If you're a licensed user, setting the `LOCALSTACK_AUTH_TOKEN` as an environment variable is recommended to access all features of the Ephemeral Instances CLI.

Access the Ephemeral Instances CLI by running the `localstack ephemeral` command from your terminal.
Expand Down
Loading