Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.
Merged
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
2 changes: 1 addition & 1 deletion content/en/references/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ Please consult the [migration guide]({{< ref "user-guide/aws/lambda#migrating-to
| Variable | Example Values | Description |
| - | - | - |
| `RDS_CLUSTER_ENDPOINT_HOST_ONLY` | `1` (default) \| `0` | Whether the cluster endpoint returns the host only (which is AWS parity). If set to `0` it will return `<host>:<port>`. |
| `RDS_PG_CUSTOM_VERSIONS` | `0` \| `1` (default) | Whether to install and use custom Postgres versions for RDS (or alternatively, use default version 11). |
| `RDS_PG_CUSTOM_VERSIONS` | `0` \| `1` (default) | Whether to install and use custom Postgres versions for RDS (or alternatively, use default version 15). |
| `RDS_MYSQL_DOCKER` | `1` (default) \| `0` | Whether to disable MySQL engines (and use MariaDB instead). MySQL engine for cluster/instances will start in a new docker container. If you have troubles running MySQL in docker, you can disable the feature. |
| `MYSQL_IMAGE` | `mysql:8.0` | Defines a specific MySQL image that should be used when spinning up the MySQL engine. Only available if `RDS_MYSQL_DOCKER` is enabled. |
| `MSSQL_IMAGE` | `mcr.microsoft.com/mssql/server:2022-latest` | Defines a specific image that should be used when spinning up a SQL server engine. |
Expand Down
6 changes: 3 additions & 3 deletions content/en/user-guide/aws/rds/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,12 +179,12 @@ For instance, the `storage-encrypted` flag is returned as configured, but active
### PostgreSQL Engine

When you establish an RDS DB cluster or instance using the `postgres`/`aurora-postgresql` DB engine along with a specified `EngineVersion`, LocalStack will dynamically install and configure the corresponding PostgreSQL version as required.
Presently, you have the option to choose major versions ranging from 11 to 15.
If you select a major version beyond this range, the system will automatically default to version 11.
Presently, you have the option to choose major versions ranging from 11 to 16.
If you select a major version beyond this range, the system will automatically default to version 15.

It's important to note that the selection of minor versions is not available.
The latest major version will be installed within the Docker environment.
If you wish to prevent the installation of customized versions, adjusting the `RDS_PG_CUSTOM_VERSIONS` environment variable to `0` will enforce the use of the default PostgreSQL version 11.
If you wish to prevent the installation of customized versions, adjusting the `RDS_PG_CUSTOM_VERSIONS` environment variable to `0` will enforce the use of the default PostgreSQL version 15.

{{< callout >}}
While the [`DescribeDbCluster`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html) and [`DescribeDbInstances`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) APIs will still reflect the initially defined `engine-version`, the actual installed PostgreSQL engine might differ.
Expand Down
19 changes: 10 additions & 9 deletions content/en/user-guide/aws/stepfunctions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,8 @@ The key components are:
- **Test cases**: Executions of your state machine that use mocked responses.
- **Mock configuration file**: A JSON file that defines test cases, mocked states, and their response payloads.

During execution, each Task state listed in the mock file returns its associated mocked response. States not included in the file continue to invoke the corresponding emulated services, allowing a mix of mocked and real interactions.
During execution, each Task state listed in the mock file returns its associated mocked response.
States not included in the file continue to invoke the corresponding emulated services, allowing a mix of mocked and real interactions.

You can define one or more mocked payloads per Task state.

Expand All @@ -166,7 +167,8 @@ Ensure the payload structure in the mocked responses matches what the real servi

### Identify a State Machine for Mocked Integrations

Mocked service integrations apply to specific state machine definitions. The first step is to select the state machine where mocked responses should be applied.
Mocked service integrations apply to specific state machine definitions.
The first step is to select the state machine where mocked responses should be applied.

In this example, we'll use a state machine named `LambdaSQSIntegration`, defined as follows:

Expand Down Expand Up @@ -220,7 +222,6 @@ This file contains two top-level sections:
- **StateMachines** – Maps each state machine to its test cases, specifying which states use which mocked responses.
- **MockedResponses** – Defines reusable mock payloads, each identified by a `ResponseID`, which test cases can reference.


#### `StateMachines`

This section specifies the Step Functions state machines to mock, along with their corresponding test cases.
Expand All @@ -245,11 +246,11 @@ In the example above:
- **`StateMachineName`**: Must exactly match the name used when the state machine was created in LocalStack.
- **`TestCases`**: Named scenarios that define mocked behavior for specific `Task` states.

Each test case maps `Task` states to mock responses that define their expected behavior.
Each test case maps `Task` states to mock responses that define their expected behavior.

At runtime, if a test case is selected, the state uses the mocked response (if defined); otherwise, it falls back to calling the emulated service.

Below is a complete example of the `StateMachines` section:
Below is a complete example of the `StateMachines` section:

```json
"LambdaSQSIntegration": {
Expand Down Expand Up @@ -280,9 +281,10 @@ Each `ResponseID` includes one or more step keys and defines either a `Return` v
In the example above:

- `ResponseID`: A unique identifier used in test cases to reference a specific mock response.
- `step-key`: Indicates the attempt number. For example, `"0"` refers to the first try, while `"1-2"` covers a range of attempts.
- `step-key`: Indicates the attempt number.
For example, `"0"` refers to the first try, while `"1-2"` covers a range of attempts.
- `Return`: Simulates a successful response by returning a predefined payload.
- `Throw`: Simulates a failure by returning an `Error` and an optional `Cause`.
- `Throw`: Simulates a failure by returning an `Error` and an optional `Cause`.

{{< callout >}}
Each entry must have **either** `Return` or `Throw`, but cannot have both.
Expand Down Expand Up @@ -432,7 +434,6 @@ This tells LocalStack to apply the corresponding mocked responses from the confi

For example, to run the `BaseCase` test case:


{{< command >}}
$ awslocal stepfunctions start-execution \
--state-machine arn:aws:states:us-east-1:000000000000:stateMachine:LambdaSQSIntegration#BaseCase \
Expand Down Expand Up @@ -516,7 +517,7 @@ This will return the full execution history, including entries that indicate how

## Resource Browser

The LocalStack Web Application includes a **Resource Browser** for managing Step Functions state machines.
The LocalStack Web Application includes a **Resource Browser** for managing Step Functions state machines.

To access it, open the LocalStack Web UI in your browser, navigate to the **Resource Browser** section, and click **Step Functions** under **App Integration**.

Expand Down