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

Commit bc93bfd

Browse files
authored
document legacy flags for apigw & eventbridge (#1570)
1 parent 71a62dc commit bc93bfd

File tree

3 files changed

+6
-11
lines changed

3 files changed

+6
-11
lines changed

content/en/references/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ See [here](#opensearch).
198198

199199
| Variable | Example Values | Description |
200200
| - | - | - |
201-
| `PROVIDER_OVERRIDE_EVENTS` | `v2` | Use the new EventBridge provider. |
201+
| `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. |
202202

203203
### IAM
204204

content/en/user-guide/aws/apigateway/index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -216,12 +216,11 @@ $ curl -X GET http://localhost:4566/_aws/execute-api/<REST_API_ID>/dev/test
216216
## New API Gateway implementation
217217

218218
{{< callout >}}
219+
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.
220+
If you were using the `PROVIDER_OVERRIDE_APIGATEWAY=next_gen` flag, please remove it as it is no longer required.
219221

220-
Since `4.0`, LocalStack uses a new API Gateway implementation for both API Gateway v1 (REST API) and v2 (HTTP API) by default.
221-
222-
It was released in [3.8.0](https://blog.localstack.cloud/localstack-release-v-3-8-0/#new-api-gateway-provider).
223-
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.
224-
222+
The legacy provider (`PROVIDER_OVERRIDE_APIGATEWAY=legacy`) is temporarily available but deprecated and will be removed in the next major release.
223+
We strongly recommend migrating to the new implementation.
225224
{{< /callout >}}
226225

227226
We're entirely reworked how REST and HTTP APIs are invoked, to closely match the behavior on AWS.

content/en/user-guide/aws/events/index.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@ The supported APIs are available on our [API coverage page](https://docs.localst
1616
For information on EventBridge Pipes, please refer to the [EventBridge Pipes]({{< ref "user-guide/aws/pipes" >}}) section.
1717

1818
{{< callout >}}
19-
We have introduced an all-new LocalStack-native EventBridge provider available behind a feature flag.
20-
You can activate it by configuring `PROVIDER_OVERRIDE_EVENTS=v2` in your LocalStack configuration.
21-
Learn more about the new provider in the [EventBridge v2 Discuss post](https://discuss.localstack.cloud/t/introducing-eventbridge-v2-in-localstack/946).
19+
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.
2220
{{< /callout >}}
2321

2422
## Getting Started
@@ -136,8 +134,6 @@ $ localstack logs
136134
{{< callout >}}
137135
LocalStack supports a new event rule engine for [EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html).
138136
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.
139-
140-
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.
141137
{{< /callout >}}
142138

143139
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:

0 commit comments

Comments
 (0)