Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.

document legacy flags for apigw & eventbridge #1570

Merged
merged 1 commit into from
Nov 21, 2024
Merged

document legacy flags for apigw & eventbridge #1570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ See [here](#opensearch).

| Variable | Example Values | Description |
| - | - | - |
| `PROVIDER_OVERRIDE_EVENTS` | `v2` | Use the new EventBridge provider. |
| `PROVIDER_OVERRIDE_EVENTS` | `legacy`\|`v2` (default) | The [new EventBridge provider](https://discuss.localstack.cloud/t/introducing-eventbridge-v2-in-localstack/946) is active by default since LocalStack 4.0. |

### IAM

Expand Down
9 changes: 4 additions & 5 deletions content/en/user-guide/aws/apigateway/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,12 +216,11 @@ $ curl -X GET http://localhost:4566/_aws/execute-api/<REST_API_ID>/dev/test
## New API Gateway implementation

{{< callout >}}
The new API Gateway implementation for both v1 (REST API) and v2 (HTTP API), introduced in [LocalStack 3.8.0](https://blog.localstack.cloud/localstack-release-v-3-8-0/#new-api-gateway-provider), is now the default in 4.0.
If you were using the `PROVIDER_OVERRIDE_APIGATEWAY=next_gen` flag, please remove it as it is no longer required.

Since `4.0`, LocalStack uses a new API Gateway implementation for both API Gateway v1 (REST API) and v2 (HTTP API) by default.

It was released in [3.8.0](https://blog.localstack.cloud/localstack-release-v-3-8-0/#new-api-gateway-provider).
If you are using LocalStack 4.0 and have been using the new implementation, please remove the [following flag]({{< ref "configuration#api-gateway" >}}) `PROVIDER_OVERRIDE_APIGATEWAY=next_gen` as it is now default.

The legacy provider (`PROVIDER_OVERRIDE_APIGATEWAY=legacy`) is temporarily available but deprecated and will be removed in the next major release.
We strongly recommend migrating to the new implementation.
{{< /callout >}}

We're entirely reworked how REST and HTTP APIs are invoked, to closely match the behavior on AWS.
Expand Down
6 changes: 1 addition & 5 deletions content/en/user-guide/aws/events/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ The supported APIs are available on our [API coverage page](https://docs.localst
For information on EventBridge Pipes, please refer to the [EventBridge Pipes]({{< ref "user-guide/aws/pipes" >}}) section.

{{< callout >}}
We have introduced an all-new LocalStack-native EventBridge provider available behind a feature flag.
You can activate it by configuring `PROVIDER_OVERRIDE_EVENTS=v2` in your LocalStack configuration.
Learn more about the new provider in the [EventBridge v2 Discuss post](https://discuss.localstack.cloud/t/introducing-eventbridge-v2-in-localstack/946).
The native EventBridge provider, introduced in [LocalStack 3.5.0](https://discuss.localstack.cloud/t/localstack-release-v3-5-0/947), is now the default in 4.0. The legacy provider can still be enabled using the `PROVIDER_OVERRIDE_EVENTS=v1` configuration, but it is deprecated and will be removed in the next major release. We strongly recommend migrating to the new provider.
{{< /callout >}}

## Getting Started
Expand Down Expand Up @@ -136,8 +134,6 @@ $ localstack logs
{{< callout >}}
LocalStack supports a new event rule engine for [EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html).
You can [configure]({{< ref "configuration" >}}) `EVENT_RULE_ENGINE=java` (preview) to use the AWS [event-ruler](https://github.com/aws/event-ruler), which offers better parity with AWS.

If you are using the new EventBridge provider (`PROVIDER_OVERRIDE_EVENTS=v2`), you do not need to set this configuration separately. This setting is only required if you are using the old provider.
{{< /callout >}}

At this time LocalStack supports the following [target types](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html#eb-console-targets) for EventBridge rules:
Expand Down