Waiting for engine...
Skip to main content

eventStreamsEnvironmentUpdate

Update the current environment for selected region. Calling this mutation indicates that the user agrees to the terms of using this functionality of the product.

Description: This mutation updates the mapping of an environment to a region in Event Streams. Typically used when moving or aligning an environment to a specific region. Calling this mutation indicates that the user agrees to the terms of using this functionality of the product.

Input Parameters (EventStreamsEnvironmentInput):

  • environmentId (ID!) – The unique identifier of the environment that needs to be updated.
  • regionId (ID!) – The region identifier to which the environment should be mapped.

Return: Returns the updated EventStreamsEnvironment object, which includes environment details and its associated region.

Example:

mutation {
eventStreamsEnvironmentUpdate(
input: {
environmentId: "abc7af73-a3c0-4624-80a9-71ff6fe54599"
regionId: "us-east-1"
}
) {
region
__typename
}
}

eventStreamsEnvironmentUpdate(
input: EventStreamsEnvironmentInput!
): EventStreamsEnvironment!

Arguments

eventStreamsEnvironmentUpdate.input ● EventStreamsEnvironmentInput! non-null input event-streams-admin

Type

EventStreamsEnvironment object event-streams-admin

Represents an Event Streams environment with metadata including region, topic and subscription counts, producer metrics, authentication tokens, and REST API base URLs for message production.

On this Page