1. Packages
  2. Auth0 Provider
  3. API Docs
  4. getEventStream
Auth0 v3.27.0 published on Wednesday, Sep 10, 2025 by Pulumi

auth0.getEventStream

Explore with Pulumi AI

auth0 logo
Auth0 v3.27.0 published on Wednesday, Sep 10, 2025 by Pulumi

    Data source to retrieve a specific Auth0 Event Stream by id.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as auth0 from "@pulumi/auth0";
    
    // An Auth0 Event Stream loaded using its ID.
    const test = auth0.getEventStream({
        id: "est_XXXXXXXXXXXXXXX",
    });
    
    import pulumi
    import pulumi_auth0 as auth0
    
    # An Auth0 Event Stream loaded using its ID.
    test = auth0.get_event_stream(id="est_XXXXXXXXXXXXXXX")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-auth0/sdk/v3/go/auth0"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// An Auth0 Event Stream loaded using its ID.
    		_, err := auth0.LookupEventStream(ctx, &auth0.LookupEventStreamArgs{
    			Id: "est_XXXXXXXXXXXXXXX",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Auth0 = Pulumi.Auth0;
    
    return await Deployment.RunAsync(() => 
    {
        // An Auth0 Event Stream loaded using its ID.
        var test = Auth0.GetEventStream.Invoke(new()
        {
            Id = "est_XXXXXXXXXXXXXXX",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.auth0.Auth0Functions;
    import com.pulumi.auth0.inputs.GetEventStreamArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            // An Auth0 Event Stream loaded using its ID.
            final var test = Auth0Functions.getEventStream(GetEventStreamArgs.builder()
                .id("est_XXXXXXXXXXXXXXX")
                .build());
    
        }
    }
    
    variables:
      # An Auth0 Event Stream loaded using its ID.
      test:
        fn::invoke:
          function: auth0:getEventStream
          arguments:
            id: est_XXXXXXXXXXXXXXX
    

    Using getEventStream

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEventStream(args: GetEventStreamArgs, opts?: InvokeOptions): Promise<GetEventStreamResult>
    function getEventStreamOutput(args: GetEventStreamOutputArgs, opts?: InvokeOptions): Output<GetEventStreamResult>
    def get_event_stream(id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetEventStreamResult
    def get_event_stream_output(id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetEventStreamResult]
    func LookupEventStream(ctx *Context, args *LookupEventStreamArgs, opts ...InvokeOption) (*LookupEventStreamResult, error)
    func LookupEventStreamOutput(ctx *Context, args *LookupEventStreamOutputArgs, opts ...InvokeOption) LookupEventStreamResultOutput

    > Note: This function is named LookupEventStream in the Go SDK.

    public static class GetEventStream 
    {
        public static Task<GetEventStreamResult> InvokeAsync(GetEventStreamArgs args, InvokeOptions? opts = null)
        public static Output<GetEventStreamResult> Invoke(GetEventStreamInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEventStreamResult> getEventStream(GetEventStreamArgs args, InvokeOptions options)
    public static Output<GetEventStreamResult> getEventStream(GetEventStreamArgs args, InvokeOptions options)
    
    fn::invoke:
      function: auth0:index/getEventStream:getEventStream
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of the Event Stream.
    Id string
    The ID of the Event Stream.
    id String
    The ID of the Event Stream.
    id string
    The ID of the Event Stream.
    id str
    The ID of the Event Stream.
    id String
    The ID of the Event Stream.

    getEventStream Result

    The following output properties are available:

    CreatedAt string
    The ISO 8601 timestamp when the stream was created.
    DestinationType string
    The type of event stream destination (either 'eventbridge' or 'webhook').
    EventbridgeConfigurations List<GetEventStreamEventbridgeConfiguration>
    Configuration for the EventBridge destination. This block is only applicable when destination_type is set to eventbridge. EventBridge configurations cannot be updated after creation. Any change to this block will force the resource to be recreated.
    Id string
    The ID of the Event Stream.
    Name string
    The name of the event stream.
    Status string
    The current status of the event stream.
    Subscriptions List<string>
    List of event types this stream is subscribed to.
    UpdatedAt string
    The ISO 8601 timestamp when the stream was last updated.
    WebhookConfigurations List<GetEventStreamWebhookConfiguration>
    Configuration for the Webhook destination. This block is only applicable when destination_type is set to webhook. Webhook configurations can be updated after creation, including the endpoint and authorization fields.
    CreatedAt string
    The ISO 8601 timestamp when the stream was created.
    DestinationType string
    The type of event stream destination (either 'eventbridge' or 'webhook').
    EventbridgeConfigurations []GetEventStreamEventbridgeConfiguration
    Configuration for the EventBridge destination. This block is only applicable when destination_type is set to eventbridge. EventBridge configurations cannot be updated after creation. Any change to this block will force the resource to be recreated.
    Id string
    The ID of the Event Stream.
    Name string
    The name of the event stream.
    Status string
    The current status of the event stream.
    Subscriptions []string
    List of event types this stream is subscribed to.
    UpdatedAt string
    The ISO 8601 timestamp when the stream was last updated.
    WebhookConfigurations []GetEventStreamWebhookConfiguration
    Configuration for the Webhook destination. This block is only applicable when destination_type is set to webhook. Webhook configurations can be updated after creation, including the endpoint and authorization fields.
    createdAt String
    The ISO 8601 timestamp when the stream was created.
    destinationType String
    The type of event stream destination (either 'eventbridge' or 'webhook').
    eventbridgeConfigurations List<GetEventStreamEventbridgeConfiguration>
    Configuration for the EventBridge destination. This block is only applicable when destination_type is set to eventbridge. EventBridge configurations cannot be updated after creation. Any change to this block will force the resource to be recreated.
    id String
    The ID of the Event Stream.
    name String
    The name of the event stream.
    status String
    The current status of the event stream.
    subscriptions List<String>
    List of event types this stream is subscribed to.
    updatedAt String
    The ISO 8601 timestamp when the stream was last updated.
    webhookConfigurations List<GetEventStreamWebhookConfiguration>
    Configuration for the Webhook destination. This block is only applicable when destination_type is set to webhook. Webhook configurations can be updated after creation, including the endpoint and authorization fields.
    createdAt string
    The ISO 8601 timestamp when the stream was created.
    destinationType string
    The type of event stream destination (either 'eventbridge' or 'webhook').
    eventbridgeConfigurations GetEventStreamEventbridgeConfiguration[]
    Configuration for the EventBridge destination. This block is only applicable when destination_type is set to eventbridge. EventBridge configurations cannot be updated after creation. Any change to this block will force the resource to be recreated.
    id string
    The ID of the Event Stream.
    name string
    The name of the event stream.
    status string
    The current status of the event stream.
    subscriptions string[]
    List of event types this stream is subscribed to.
    updatedAt string
    The ISO 8601 timestamp when the stream was last updated.
    webhookConfigurations GetEventStreamWebhookConfiguration[]
    Configuration for the Webhook destination. This block is only applicable when destination_type is set to webhook. Webhook configurations can be updated after creation, including the endpoint and authorization fields.
    created_at str
    The ISO 8601 timestamp when the stream was created.
    destination_type str
    The type of event stream destination (either 'eventbridge' or 'webhook').
    eventbridge_configurations Sequence[GetEventStreamEventbridgeConfiguration]
    Configuration for the EventBridge destination. This block is only applicable when destination_type is set to eventbridge. EventBridge configurations cannot be updated after creation. Any change to this block will force the resource to be recreated.
    id str
    The ID of the Event Stream.
    name str
    The name of the event stream.
    status str
    The current status of the event stream.
    subscriptions Sequence[str]
    List of event types this stream is subscribed to.
    updated_at str
    The ISO 8601 timestamp when the stream was last updated.
    webhook_configurations Sequence[GetEventStreamWebhookConfiguration]
    Configuration for the Webhook destination. This block is only applicable when destination_type is set to webhook. Webhook configurations can be updated after creation, including the endpoint and authorization fields.
    createdAt String
    The ISO 8601 timestamp when the stream was created.
    destinationType String
    The type of event stream destination (either 'eventbridge' or 'webhook').
    eventbridgeConfigurations List<Property Map>
    Configuration for the EventBridge destination. This block is only applicable when destination_type is set to eventbridge. EventBridge configurations cannot be updated after creation. Any change to this block will force the resource to be recreated.
    id String
    The ID of the Event Stream.
    name String
    The name of the event stream.
    status String
    The current status of the event stream.
    subscriptions List<String>
    List of event types this stream is subscribed to.
    updatedAt String
    The ISO 8601 timestamp when the stream was last updated.
    webhookConfigurations List<Property Map>
    Configuration for the Webhook destination. This block is only applicable when destination_type is set to webhook. Webhook configurations can be updated after creation, including the endpoint and authorization fields.

    Supporting Types

    GetEventStreamEventbridgeConfiguration

    GetEventStreamWebhookConfiguration

    WebhookAuthorizations List<GetEventStreamWebhookConfigurationWebhookAuthorization>
    Authorization details for the webhook endpoint. Supports basic authentication using username and password, or bearer authentication using a token. The appropriate fields must be set based on the chosen method.
    WebhookEndpoint string
    The HTTPS endpoint that will receive the webhook events. Must be a valid, publicly accessible URL.
    WebhookAuthorizations []GetEventStreamWebhookConfigurationWebhookAuthorization
    Authorization details for the webhook endpoint. Supports basic authentication using username and password, or bearer authentication using a token. The appropriate fields must be set based on the chosen method.
    WebhookEndpoint string
    The HTTPS endpoint that will receive the webhook events. Must be a valid, publicly accessible URL.
    webhookAuthorizations List<GetEventStreamWebhookConfigurationWebhookAuthorization>
    Authorization details for the webhook endpoint. Supports basic authentication using username and password, or bearer authentication using a token. The appropriate fields must be set based on the chosen method.
    webhookEndpoint String
    The HTTPS endpoint that will receive the webhook events. Must be a valid, publicly accessible URL.
    webhookAuthorizations GetEventStreamWebhookConfigurationWebhookAuthorization[]
    Authorization details for the webhook endpoint. Supports basic authentication using username and password, or bearer authentication using a token. The appropriate fields must be set based on the chosen method.
    webhookEndpoint string
    The HTTPS endpoint that will receive the webhook events. Must be a valid, publicly accessible URL.
    webhook_authorizations Sequence[GetEventStreamWebhookConfigurationWebhookAuthorization]
    Authorization details for the webhook endpoint. Supports basic authentication using username and password, or bearer authentication using a token. The appropriate fields must be set based on the chosen method.
    webhook_endpoint str
    The HTTPS endpoint that will receive the webhook events. Must be a valid, publicly accessible URL.
    webhookAuthorizations List<Property Map>
    Authorization details for the webhook endpoint. Supports basic authentication using username and password, or bearer authentication using a token. The appropriate fields must be set based on the chosen method.
    webhookEndpoint String
    The HTTPS endpoint that will receive the webhook events. Must be a valid, publicly accessible URL.

    GetEventStreamWebhookConfigurationWebhookAuthorization

    Method string
    The authorization method used to secure the webhook endpoint. Can be either basic or bearer.
    Password string
    The password for basic authentication. Required when method is set to basic.
    Token string
    The token used for bearer authentication. Required when method is set to bearer.
    Username string
    The username for basic authentication. Required when method is set to basic.
    Method string
    The authorization method used to secure the webhook endpoint. Can be either basic or bearer.
    Password string
    The password for basic authentication. Required when method is set to basic.
    Token string
    The token used for bearer authentication. Required when method is set to bearer.
    Username string
    The username for basic authentication. Required when method is set to basic.
    method String
    The authorization method used to secure the webhook endpoint. Can be either basic or bearer.
    password String
    The password for basic authentication. Required when method is set to basic.
    token String
    The token used for bearer authentication. Required when method is set to bearer.
    username String
    The username for basic authentication. Required when method is set to basic.
    method string
    The authorization method used to secure the webhook endpoint. Can be either basic or bearer.
    password string
    The password for basic authentication. Required when method is set to basic.
    token string
    The token used for bearer authentication. Required when method is set to bearer.
    username string
    The username for basic authentication. Required when method is set to basic.
    method str
    The authorization method used to secure the webhook endpoint. Can be either basic or bearer.
    password str
    The password for basic authentication. Required when method is set to basic.
    token str
    The token used for bearer authentication. Required when method is set to bearer.
    username str
    The username for basic authentication. Required when method is set to basic.
    method String
    The authorization method used to secure the webhook endpoint. Can be either basic or bearer.
    password String
    The password for basic authentication. Required when method is set to basic.
    token String
    The token used for bearer authentication. Required when method is set to bearer.
    username String
    The username for basic authentication. Required when method is set to basic.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo
    Auth0 v3.27.0 published on Wednesday, Sep 10, 2025 by Pulumi