Docs Packages
  1. Packages
  2. Auth0
  3. API Docs
  4. LogStream
Auth0 v3.4.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-auth0

auth0.LogStream

Explore with Pulumi AI

auth0 logo
Auth0 v3.4.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-auth0

    With this resource, you can manage your Auth0 log streams.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";

// This is an example of an http log stream.
const myWebhook = new auth0.LogStream("my_webhook", {
    name: "HTTP log stream",
    type: "http",
    filters: [
        {
            type: "category",
            name: "auth.login.fail",
        },
        {
            type: "category",
            name: "auth.signup.fail",
        },
    ],
    sink: {
        httpEndpoint: "https://example.com/logs",
        httpContentType: "application/json",
        httpContentFormat: "JSONOBJECT",
        httpAuthorization: "AKIAXXXXXXXXXXXXXXXX",
        httpCustomHeaders: [{
            header: "foo",
            value: "bar",
        }],
    },
});
// This is an example of an Amazon EventBridge log stream.
const exampleAws = new auth0.LogStream("example_aws", {
    name: "AWS Eventbridge",
    type: "eventbridge",
    status: "active",
    sink: {
        awsAccountId: "my_account_id",
        awsRegion: "us-east-2",
    },
});

    import pulumi
import pulumi_auth0 as auth0

# This is an example of an http log stream.
my_webhook = auth0.LogStream("my_webhook",
    name="HTTP log stream",
    type="http",
    filters=[
        {
            "type": "category",
            "name": "auth.login.fail",
        },
        {
            "type": "category",
            "name": "auth.signup.fail",
        },
    ],
    sink=auth0.LogStreamSinkArgs(
        http_endpoint="https://example.com/logs",
        http_content_type="application/json",
        http_content_format="JSONOBJECT",
        http_authorization="AKIAXXXXXXXXXXXXXXXX",
        http_custom_headers=[{
            "header": "foo",
            "value": "bar",
        }],
    ))
# This is an example of an Amazon EventBridge log stream.
example_aws = auth0.LogStream("example_aws",
    name="AWS Eventbridge",
    type="eventbridge",
    status="active",
    sink=auth0.LogStreamSinkArgs(
        aws_account_id="my_account_id",
        aws_region="us-east-2",
    ))

    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 {
		// This is an example of an http log stream.
		_, err := auth0.NewLogStream(ctx, "my_webhook", &auth0.LogStreamArgs{
			Name: pulumi.String("HTTP log stream"),
			Type: pulumi.String("http"),
			Filters: pulumi.StringMapArray{
				pulumi.StringMap{
					"type": pulumi.String("category"),
					"name": pulumi.String("auth.login.fail"),
				},
				pulumi.StringMap{
					"type": pulumi.String("category"),
					"name": pulumi.String("auth.signup.fail"),
				},
			},
			Sink: &auth0.LogStreamSinkArgs{
				HttpEndpoint:      pulumi.String("https://example.com/logs"),
				HttpContentType:   pulumi.String("application/json"),
				HttpContentFormat: pulumi.String("JSONOBJECT"),
				HttpAuthorization: pulumi.String("AKIAXXXXXXXXXXXXXXXX"),
				HttpCustomHeaders: pulumi.StringMapArray{
					pulumi.StringMap{
						"header": pulumi.String("foo"),
						"value":  pulumi.String("bar"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		// This is an example of an Amazon EventBridge log stream.
		_, err = auth0.NewLogStream(ctx, "example_aws", &auth0.LogStreamArgs{
			Name:   pulumi.String("AWS Eventbridge"),
			Type:   pulumi.String("eventbridge"),
			Status: pulumi.String("active"),
			Sink: &auth0.LogStreamSinkArgs{
				AwsAccountId: pulumi.String("my_account_id"),
				AwsRegion:    pulumi.String("us-east-2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    // This is an example of an http log stream.
    var myWebhook = new Auth0.LogStream("my_webhook", new()
    {
        Name = "HTTP log stream",
        Type = "http",
        Filters = new[]
        {
            
            {
                { "type", "category" },
                { "name", "auth.login.fail" },
            },
            
            {
                { "type", "category" },
                { "name", "auth.signup.fail" },
            },
        },
        Sink = new Auth0.Inputs.LogStreamSinkArgs
        {
            HttpEndpoint = "https://example.com/logs",
            HttpContentType = "application/json",
            HttpContentFormat = "JSONOBJECT",
            HttpAuthorization = "AKIAXXXXXXXXXXXXXXXX",
            HttpCustomHeaders = new[]
            {
                
                {
                    { "header", "foo" },
                    { "value", "bar" },
                },
            },
        },
    });

    // This is an example of an Amazon EventBridge log stream.
    var exampleAws = new Auth0.LogStream("example_aws", new()
    {
        Name = "AWS Eventbridge",
        Type = "eventbridge",
        Status = "active",
        Sink = new Auth0.Inputs.LogStreamSinkArgs
        {
            AwsAccountId = "my_account_id",
            AwsRegion = "us-east-2",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.LogStream;
import com.pulumi.auth0.LogStreamArgs;
import com.pulumi.auth0.inputs.LogStreamSinkArgs;
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) {
        // This is an example of an http log stream.
        var myWebhook = new LogStream("myWebhook", LogStreamArgs.builder()
            .name("HTTP log stream")
            .type("http")
            .filters(            
                Map.ofEntries(
                    Map.entry("type", "category"),
                    Map.entry("name", "auth.login.fail")
                ),
                Map.ofEntries(
                    Map.entry("type", "category"),
                    Map.entry("name", "auth.signup.fail")
                ))
            .sink(LogStreamSinkArgs.builder()
                .httpEndpoint("https://example.com/logs")
                .httpContentType("application/json")
                .httpContentFormat("JSONOBJECT")
                .httpAuthorization("AKIAXXXXXXXXXXXXXXXX")
                .httpCustomHeaders(Map.ofEntries(
                    Map.entry("header", "foo"),
                    Map.entry("value", "bar")
                ))
                .build())
            .build());

        // This is an example of an Amazon EventBridge log stream.
        var exampleAws = new LogStream("exampleAws", LogStreamArgs.builder()
            .name("AWS Eventbridge")
            .type("eventbridge")
            .status("active")
            .sink(LogStreamSinkArgs.builder()
                .awsAccountId("my_account_id")
                .awsRegion("us-east-2")
                .build())
            .build());

    }
}

    resources:
  # This is an example of an http log stream.
  myWebhook:
    type: auth0:LogStream
    name: my_webhook
    properties:
      name: HTTP log stream
      type: http
      filters:
        - type: category
          name: auth.login.fail
        - type: category
          name: auth.signup.fail
      sink:
        httpEndpoint: https://example.com/logs
        httpContentType: application/json
        httpContentFormat: JSONOBJECT
        httpAuthorization: AKIAXXXXXXXXXXXXXXXX
        httpCustomHeaders:
          - header: foo
            value: bar
  # This is an example of an Amazon EventBridge log stream.
  exampleAws:
    type: auth0:LogStream
    name: example_aws
    properties:
      name: AWS Eventbridge
      type: eventbridge
      status: active
      sink:
        awsAccountId: my_account_id
        awsRegion: us-east-2

    Create LogStream Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LogStream(name: string, args: LogStreamArgs, opts?: CustomResourceOptions);
    @overload
def LogStream(resource_name: str,
              args: LogStreamArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def LogStream(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              sink: Optional[LogStreamSinkArgs] = None,
              type: Optional[str] = None,
              filters: Optional[Sequence[Mapping[str, str]]] = None,
              name: Optional[str] = None,
              status: Optional[str] = None)
    func NewLogStream(ctx *Context, name string, args LogStreamArgs, opts ...ResourceOption) (*LogStream, error)
    public LogStream(string name, LogStreamArgs args, CustomResourceOptions? opts = null)
    public LogStream(String name, LogStreamArgs args)
public LogStream(String name, LogStreamArgs args, CustomResourceOptions options)

    type: auth0:LogStream
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args LogStreamArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LogStreamArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LogStreamArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LogStreamArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LogStreamArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var logStreamResource = new Auth0.LogStream("logStreamResource", new()
{
    Sink = new Auth0.Inputs.LogStreamSinkArgs
    {
        AwsAccountId = "string",
        AwsPartnerEventSource = "string",
        AwsRegion = "string",
        AzurePartnerTopic = "string",
        AzureRegion = "string",
        AzureResourceGroup = "string",
        AzureSubscriptionId = "string",
        DatadogApiKey = "string",
        DatadogRegion = "string",
        HttpAuthorization = "string",
        HttpContentFormat = "string",
        HttpContentType = "string",
        HttpCustomHeaders = new[]
        {
            
            {
                { "string", "string" },
            },
        },
        HttpEndpoint = "string",
        MixpanelProjectId = "string",
        MixpanelRegion = "string",
        MixpanelServiceAccountPassword = "string",
        MixpanelServiceAccountUsername = "string",
        SegmentWriteKey = "string",
        SplunkDomain = "string",
        SplunkPort = "string",
        SplunkSecure = false,
        SplunkToken = "string",
        SumoSourceAddress = "string",
    },
    Type = "string",
    Filters = new[]
    {
        
        {
            { "string", "string" },
        },
    },
    Name = "string",
    Status = "string",
});

    example, err := auth0.NewLogStream(ctx, "logStreamResource", &auth0.LogStreamArgs{
	Sink: &auth0.LogStreamSinkArgs{
		AwsAccountId:          pulumi.String("string"),
		AwsPartnerEventSource: pulumi.String("string"),
		AwsRegion:             pulumi.String("string"),
		AzurePartnerTopic:     pulumi.String("string"),
		AzureRegion:           pulumi.String("string"),
		AzureResourceGroup:    pulumi.String("string"),
		AzureSubscriptionId:   pulumi.String("string"),
		DatadogApiKey:         pulumi.String("string"),
		DatadogRegion:         pulumi.String("string"),
		HttpAuthorization:     pulumi.String("string"),
		HttpContentFormat:     pulumi.String("string"),
		HttpContentType:       pulumi.String("string"),
		HttpCustomHeaders: pulumi.StringMapArray{
			pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
		HttpEndpoint:                   pulumi.String("string"),
		MixpanelProjectId:              pulumi.String("string"),
		MixpanelRegion:                 pulumi.String("string"),
		MixpanelServiceAccountPassword: pulumi.String("string"),
		MixpanelServiceAccountUsername: pulumi.String("string"),
		SegmentWriteKey:                pulumi.String("string"),
		SplunkDomain:                   pulumi.String("string"),
		SplunkPort:                     pulumi.String("string"),
		SplunkSecure:                   pulumi.Bool(false),
		SplunkToken:                    pulumi.String("string"),
		SumoSourceAddress:              pulumi.String("string"),
	},
	Type: pulumi.String("string"),
	Filters: pulumi.StringMapArray{
		pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	Name:   pulumi.String("string"),
	Status: pulumi.String("string"),
})

    var logStreamResource = new LogStream("logStreamResource", LogStreamArgs.builder()
    .sink(LogStreamSinkArgs.builder()
        .awsAccountId("string")
        .awsPartnerEventSource("string")
        .awsRegion("string")
        .azurePartnerTopic("string")
        .azureRegion("string")
        .azureResourceGroup("string")
        .azureSubscriptionId("string")
        .datadogApiKey("string")
        .datadogRegion("string")
        .httpAuthorization("string")
        .httpContentFormat("string")
        .httpContentType("string")
        .httpCustomHeaders(Map.of("string", "string"))
        .httpEndpoint("string")
        .mixpanelProjectId("string")
        .mixpanelRegion("string")
        .mixpanelServiceAccountPassword("string")
        .mixpanelServiceAccountUsername("string")
        .segmentWriteKey("string")
        .splunkDomain("string")
        .splunkPort("string")
        .splunkSecure(false)
        .splunkToken("string")
        .sumoSourceAddress("string")
        .build())
    .type("string")
    .filters(Map.of("string", "string"))
    .name("string")
    .status("string")
    .build());

    log_stream_resource = auth0.LogStream("logStreamResource",
    sink=auth0.LogStreamSinkArgs(
        aws_account_id="string",
        aws_partner_event_source="string",
        aws_region="string",
        azure_partner_topic="string",
        azure_region="string",
        azure_resource_group="string",
        azure_subscription_id="string",
        datadog_api_key="string",
        datadog_region="string",
        http_authorization="string",
        http_content_format="string",
        http_content_type="string",
        http_custom_headers=[{
            "string": "string",
        }],
        http_endpoint="string",
        mixpanel_project_id="string",
        mixpanel_region="string",
        mixpanel_service_account_password="string",
        mixpanel_service_account_username="string",
        segment_write_key="string",
        splunk_domain="string",
        splunk_port="string",
        splunk_secure=False,
        splunk_token="string",
        sumo_source_address="string",
    ),
    type="string",
    filters=[{
        "string": "string",
    }],
    name="string",
    status="string")

    const logStreamResource = new auth0.LogStream("logStreamResource", {
    sink: {
        awsAccountId: "string",
        awsPartnerEventSource: "string",
        awsRegion: "string",
        azurePartnerTopic: "string",
        azureRegion: "string",
        azureResourceGroup: "string",
        azureSubscriptionId: "string",
        datadogApiKey: "string",
        datadogRegion: "string",
        httpAuthorization: "string",
        httpContentFormat: "string",
        httpContentType: "string",
        httpCustomHeaders: [{
            string: "string",
        }],
        httpEndpoint: "string",
        mixpanelProjectId: "string",
        mixpanelRegion: "string",
        mixpanelServiceAccountPassword: "string",
        mixpanelServiceAccountUsername: "string",
        segmentWriteKey: "string",
        splunkDomain: "string",
        splunkPort: "string",
        splunkSecure: false,
        splunkToken: "string",
        sumoSourceAddress: "string",
    },
    type: "string",
    filters: [{
        string: "string",
    }],
    name: "string",
    status: "string",
});

    type: auth0:LogStream
properties:
    filters:
        - string: string
    name: string
    sink:
        awsAccountId: string
        awsPartnerEventSource: string
        awsRegion: string
        azurePartnerTopic: string
        azureRegion: string
        azureResourceGroup: string
        azureSubscriptionId: string
        datadogApiKey: string
        datadogRegion: string
        httpAuthorization: string
        httpContentFormat: string
        httpContentType: string
        httpCustomHeaders:
            - string: string
        httpEndpoint: string
        mixpanelProjectId: string
        mixpanelRegion: string
        mixpanelServiceAccountPassword: string
        mixpanelServiceAccountUsername: string
        segmentWriteKey: string
        splunkDomain: string
        splunkPort: string
        splunkSecure: false
        splunkToken: string
        sumoSourceAddress: string
    status: string
    type: string

    LogStream Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The LogStream resource accepts the following input properties:

    Sink LogStreamSink
    The sink configuration for the log stream.
    Type string
    Type of the log stream, which indicates the sink provider. Options include: eventbridge, eventgrid, http, datadog, splunk, sumo, mixpanel, segment.
    Filters List<ImmutableDictionary<string, string>>
    Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. Filters available: auth.ancillary.fail, auth.ancillary.success, auth.login.fail, auth.login.notification, auth.login.success, auth.logout.fail, auth.logout.success, auth.signup.fail, auth.signup.success, auth.silent_auth.fail, auth.silent_auth.success, auth.token_exchange.fail, auth.token_exchange.success, management.fail, management.success, system.notification, user.fail, user.notification, user.success, other.
    Name string
    Name of the log stream.
    Status string
    The current status of the log stream. Options are "active", "paused", "suspended".
    Sink LogStreamSinkArgs
    The sink configuration for the log stream.
    Type string
    Type of the log stream, which indicates the sink provider. Options include: eventbridge, eventgrid, http, datadog, splunk, sumo, mixpanel, segment.
    Filters []map[string]string
    Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. Filters available: auth.ancillary.fail, auth.ancillary.success, auth.login.fail, auth.login.notification, auth.login.success, auth.logout.fail, auth.logout.success, auth.signup.fail, auth.signup.success, auth.silent_auth.fail, auth.silent_auth.success, auth.token_exchange.fail, auth.token_exchange.success, management.fail, management.success, system.notification, user.fail, user.notification, user.success, other.
    Name string
    Name of the log stream.
    Status string
    The current status of the log stream. Options are "active", "paused", "suspended".
    sink LogStreamSink
    The sink configuration for the log stream.
    type String
    Type of the log stream, which indicates the sink provider. Options include: eventbridge, eventgrid, http, datadog, splunk, sumo, mixpanel, segment.
    filters List<Map<String,String>>
    Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. Filters available: auth.ancillary.fail, auth.ancillary.success, auth.login.fail, auth.login.notification, auth.login.success, auth.logout.fail, auth.logout.success, auth.signup.fail, auth.signup.success, auth.silent_auth.fail, auth.silent_auth.success, auth.token_exchange.fail, auth.token_exchange.success, management.fail, management.success, system.notification, user.fail, user.notification, user.success, other.
    name String
    Name of the log stream.
    status String
    The current status of the log stream. Options are "active", "paused", "suspended".
    sink LogStreamSink
    The sink configuration for the log stream.
    type string
    Type of the log stream, which indicates the sink provider. Options include: eventbridge, eventgrid, http, datadog, splunk, sumo, mixpanel, segment.
    filters {[key: string]: string}[]
    Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. Filters available: auth.ancillary.fail, auth.ancillary.success, auth.login.fail, auth.login.notification, auth.login.success, auth.logout.fail, auth.logout.success, auth.signup.fail, auth.signup.success, auth.silent_auth.fail, auth.silent_auth.success, auth.token_exchange.fail, auth.token_exchange.success, management.fail, management.success, system.notification, user.fail, user.notification, user.success, other.
    name string
    Name of the log stream.
    status string
    The current status of the log stream. Options are "active", "paused", "suspended".
    sink LogStreamSinkArgs
    The sink configuration for the log stream.
    type str
    Type of the log stream, which indicates the sink provider. Options include: eventbridge, eventgrid, http, datadog, splunk, sumo, mixpanel, segment.
    filters Sequence[Mapping[str, str]]
    Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. Filters available: auth.ancillary.fail, auth.ancillary.success, auth.login.fail, auth.login.notification, auth.login.success, auth.logout.fail, auth.logout.success, auth.signup.fail, auth.signup.success, auth.silent_auth.fail, auth.silent_auth.success, auth.token_exchange.fail, auth.token_exchange.success, management.fail, management.success, system.notification, user.fail, user.notification, user.success, other.
    name str
    Name of the log stream.
    status str
    The current status of the log stream. Options are "active", "paused", "suspended".
    sink Property Map
    The sink configuration for the log stream.
    type String
    Type of the log stream, which indicates the sink provider. Options include: eventbridge, eventgrid, http, datadog, splunk, sumo, mixpanel, segment.
    filters List<Map<String>>
    Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. Filters available: auth.ancillary.fail, auth.ancillary.success, auth.login.fail, auth.login.notification, auth.login.success, auth.logout.fail, auth.logout.success, auth.signup.fail, auth.signup.success, auth.silent_auth.fail, auth.silent_auth.success, auth.token_exchange.fail, auth.token_exchange.success, management.fail, management.success, system.notification, user.fail, user.notification, user.success, other.
    name String
    Name of the log stream.
    status String
    The current status of the log stream. Options are "active", "paused", "suspended".

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LogStream resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing LogStream Resource

    Get an existing LogStream resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: LogStreamState, opts?: CustomResourceOptions): LogStream
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        filters: Optional[Sequence[Mapping[str, str]]] = None,
        name: Optional[str] = None,
        sink: Optional[LogStreamSinkArgs] = None,
        status: Optional[str] = None,
        type: Optional[str] = None) -> LogStream
    func GetLogStream(ctx *Context, name string, id IDInput, state *LogStreamState, opts ...ResourceOption) (*LogStream, error)
    public static LogStream Get(string name, Input<string> id, LogStreamState? state, CustomResourceOptions? opts = null)
    public static LogStream get(String name, Output<String> id, LogStreamState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Filters List<ImmutableDictionary<string, string>>
    Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. Filters available: auth.ancillary.fail, auth.ancillary.success, auth.login.fail, auth.login.notification, auth.login.success, auth.logout.fail, auth.logout.success, auth.signup.fail, auth.signup.success, auth.silent_auth.fail, auth.silent_auth.success, auth.token_exchange.fail, auth.token_exchange.success, management.fail, management.success, system.notification, user.fail, user.notification, user.success, other.
    Name string
    Name of the log stream.
    Sink LogStreamSink
    The sink configuration for the log stream.
    Status string
    The current status of the log stream. Options are "active", "paused", "suspended".
    Type string
    Type of the log stream, which indicates the sink provider. Options include: eventbridge, eventgrid, http, datadog, splunk, sumo, mixpanel, segment.
    Filters []map[string]string
    Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. Filters available: auth.ancillary.fail, auth.ancillary.success, auth.login.fail, auth.login.notification, auth.login.success, auth.logout.fail, auth.logout.success, auth.signup.fail, auth.signup.success, auth.silent_auth.fail, auth.silent_auth.success, auth.token_exchange.fail, auth.token_exchange.success, management.fail, management.success, system.notification, user.fail, user.notification, user.success, other.
    Name string
    Name of the log stream.
    Sink LogStreamSinkArgs
    The sink configuration for the log stream.
    Status string
    The current status of the log stream. Options are "active", "paused", "suspended".
    Type string
    Type of the log stream, which indicates the sink provider. Options include: eventbridge, eventgrid, http, datadog, splunk, sumo, mixpanel, segment.
    filters List<Map<String,String>>
    Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. Filters available: auth.ancillary.fail, auth.ancillary.success, auth.login.fail, auth.login.notification, auth.login.success, auth.logout.fail, auth.logout.success, auth.signup.fail, auth.signup.success, auth.silent_auth.fail, auth.silent_auth.success, auth.token_exchange.fail, auth.token_exchange.success, management.fail, management.success, system.notification, user.fail, user.notification, user.success, other.
    name String
    Name of the log stream.
    sink LogStreamSink
    The sink configuration for the log stream.
    status String
    The current status of the log stream. Options are "active", "paused", "suspended".
    type String
    Type of the log stream, which indicates the sink provider. Options include: eventbridge, eventgrid, http, datadog, splunk, sumo, mixpanel, segment.
    filters {[key: string]: string}[]
    Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. Filters available: auth.ancillary.fail, auth.ancillary.success, auth.login.fail, auth.login.notification, auth.login.success, auth.logout.fail, auth.logout.success, auth.signup.fail, auth.signup.success, auth.silent_auth.fail, auth.silent_auth.success, auth.token_exchange.fail, auth.token_exchange.success, management.fail, management.success, system.notification, user.fail, user.notification, user.success, other.
    name string
    Name of the log stream.
    sink LogStreamSink
    The sink configuration for the log stream.
    status string
    The current status of the log stream. Options are "active", "paused", "suspended".
    type string
    Type of the log stream, which indicates the sink provider. Options include: eventbridge, eventgrid, http, datadog, splunk, sumo, mixpanel, segment.
    filters Sequence[Mapping[str, str]]
    Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. Filters available: auth.ancillary.fail, auth.ancillary.success, auth.login.fail, auth.login.notification, auth.login.success, auth.logout.fail, auth.logout.success, auth.signup.fail, auth.signup.success, auth.silent_auth.fail, auth.silent_auth.success, auth.token_exchange.fail, auth.token_exchange.success, management.fail, management.success, system.notification, user.fail, user.notification, user.success, other.
    name str
    Name of the log stream.
    sink LogStreamSinkArgs
    The sink configuration for the log stream.
    status str
    The current status of the log stream. Options are "active", "paused", "suspended".
    type str
    Type of the log stream, which indicates the sink provider. Options include: eventbridge, eventgrid, http, datadog, splunk, sumo, mixpanel, segment.
    filters List<Map<String>>
    Only logs events matching these filters will be delivered by the stream. If omitted or empty, all events will be delivered. Filters available: auth.ancillary.fail, auth.ancillary.success, auth.login.fail, auth.login.notification, auth.login.success, auth.logout.fail, auth.logout.success, auth.signup.fail, auth.signup.success, auth.silent_auth.fail, auth.silent_auth.success, auth.token_exchange.fail, auth.token_exchange.success, management.fail, management.success, system.notification, user.fail, user.notification, user.success, other.
    name String
    Name of the log stream.
    sink Property Map
    The sink configuration for the log stream.
    status String
    The current status of the log stream. Options are "active", "paused", "suspended".
    type String
    Type of the log stream, which indicates the sink provider. Options include: eventbridge, eventgrid, http, datadog, splunk, sumo, mixpanel, segment.

    Supporting Types

    LogStreamSink, LogStreamSinkArgs

    AwsAccountId string
    The AWS Account ID.
    AwsPartnerEventSource string
    Name of the Partner Event Source to be used with AWS. Generally generated by Auth0 and passed to AWS, so this should be an output attribute.
    AwsRegion string
    The region in which the EventBridge event source will be created. Possible values: ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, cn-north-1, cn-northwest-1, eu-central-1, eu-north-1, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-gov-east-1, us-gov-west-1, us-east-1, us-east-2, us-west-1, us-west-2.
    AzurePartnerTopic string
    Name of the Partner Topic to be used with Azure. Generally should not be specified.
    AzureRegion string
    The Azure region code. Possible values: australiacentral, australiaeast, australiasoutheast, brazilsouth, canadacentral, canadaeast, centralindia, centralus, eastasia, eastus, eastus2, francecentral, germanywestcentral, japaneast, japanwest, koreacentral, koreasouth, northcentralus, northeurope, norwayeast, southafricanorth, southcentralus, southeastasia, southindia, switzerlandnorth, uaenorth, uksouth, ukwest, westcentralus, westeurope, westindia, westus, westus2.
    AzureResourceGroup string
    The Azure EventGrid resource group which allows you to manage all Azure assets within one subscription.
    AzureSubscriptionId string
    The unique alphanumeric string that identifies your Azure subscription.
    DatadogApiKey string
    The Datadog API key.
    DatadogRegion string
    The Datadog region. Possible values: us, eu, us3, us5.
    HttpAuthorization string
    Sent in the HTTP "Authorization" header with each request.
    HttpContentFormat string
    The format of data sent over HTTP. Options are "JSONLINES", "JSONARRAY" or "JSONOBJECT"
    HttpContentType string
    The "Content-Type" header to send over HTTP. Common value is "application/json".
    HttpCustomHeaders List<ImmutableDictionary<string, string>>
    Additional HTTP headers to be included as part of the HTTP request.
    HttpEndpoint string
    The HTTP endpoint to send streaming logs.
    MixpanelProjectId string
    The Mixpanel project ID, found on the Project Settings page.
    MixpanelRegion string
    The Mixpanel region. Options are ["us", "eu"]. EU is required for customers with EU data residency requirements.
    MixpanelServiceAccountPassword string
    The Mixpanel Service Account password.
    MixpanelServiceAccountUsername string
    The Mixpanel Service Account username. Services Accounts can be created in the Project Settings page.
    SegmentWriteKey string
    The Segment Write Key.
    SplunkDomain string
    The Splunk domain name.
    SplunkPort string
    The Splunk port.
    SplunkSecure bool
    This toggle should be turned off when using self-signed certificates.
    SplunkToken string
    The Splunk access token.
    SumoSourceAddress string
    Generated URL for your defined HTTP source in Sumo Logic for collecting streaming data from Auth0.
    AwsAccountId string
    The AWS Account ID.
    AwsPartnerEventSource string
    Name of the Partner Event Source to be used with AWS. Generally generated by Auth0 and passed to AWS, so this should be an output attribute.
    AwsRegion string
    The region in which the EventBridge event source will be created. Possible values: ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, cn-north-1, cn-northwest-1, eu-central-1, eu-north-1, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-gov-east-1, us-gov-west-1, us-east-1, us-east-2, us-west-1, us-west-2.
    AzurePartnerTopic string
    Name of the Partner Topic to be used with Azure. Generally should not be specified.
    AzureRegion string
    The Azure region code. Possible values: australiacentral, australiaeast, australiasoutheast, brazilsouth, canadacentral, canadaeast, centralindia, centralus, eastasia, eastus, eastus2, francecentral, germanywestcentral, japaneast, japanwest, koreacentral, koreasouth, northcentralus, northeurope, norwayeast, southafricanorth, southcentralus, southeastasia, southindia, switzerlandnorth, uaenorth, uksouth, ukwest, westcentralus, westeurope, westindia, westus, westus2.
    AzureResourceGroup string
    The Azure EventGrid resource group which allows you to manage all Azure assets within one subscription.
    AzureSubscriptionId string
    The unique alphanumeric string that identifies your Azure subscription.
    DatadogApiKey string
    The Datadog API key.
    DatadogRegion string
    The Datadog region. Possible values: us, eu, us3, us5.
    HttpAuthorization string
    Sent in the HTTP "Authorization" header with each request.
    HttpContentFormat string
    The format of data sent over HTTP. Options are "JSONLINES", "JSONARRAY" or "JSONOBJECT"
    HttpContentType string
    The "Content-Type" header to send over HTTP. Common value is "application/json".
    HttpCustomHeaders []map[string]string
    Additional HTTP headers to be included as part of the HTTP request.
    HttpEndpoint string
    The HTTP endpoint to send streaming logs.
    MixpanelProjectId string
    The Mixpanel project ID, found on the Project Settings page.
    MixpanelRegion string
    The Mixpanel region. Options are ["us", "eu"]. EU is required for customers with EU data residency requirements.
    MixpanelServiceAccountPassword string
    The Mixpanel Service Account password.
    MixpanelServiceAccountUsername string
    The Mixpanel Service Account username. Services Accounts can be created in the Project Settings page.
    SegmentWriteKey string
    The Segment Write Key.
    SplunkDomain string
    The Splunk domain name.
    SplunkPort string
    The Splunk port.
    SplunkSecure bool
    This toggle should be turned off when using self-signed certificates.
    SplunkToken string
    The Splunk access token.
    SumoSourceAddress string
    Generated URL for your defined HTTP source in Sumo Logic for collecting streaming data from Auth0.
    awsAccountId String
    The AWS Account ID.
    awsPartnerEventSource String
    Name of the Partner Event Source to be used with AWS. Generally generated by Auth0 and passed to AWS, so this should be an output attribute.
    awsRegion String
    The region in which the EventBridge event source will be created. Possible values: ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, cn-north-1, cn-northwest-1, eu-central-1, eu-north-1, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-gov-east-1, us-gov-west-1, us-east-1, us-east-2, us-west-1, us-west-2.
    azurePartnerTopic String
    Name of the Partner Topic to be used with Azure. Generally should not be specified.
    azureRegion String
    The Azure region code. Possible values: australiacentral, australiaeast, australiasoutheast, brazilsouth, canadacentral, canadaeast, centralindia, centralus, eastasia, eastus, eastus2, francecentral, germanywestcentral, japaneast, japanwest, koreacentral, koreasouth, northcentralus, northeurope, norwayeast, southafricanorth, southcentralus, southeastasia, southindia, switzerlandnorth, uaenorth, uksouth, ukwest, westcentralus, westeurope, westindia, westus, westus2.
    azureResourceGroup String
    The Azure EventGrid resource group which allows you to manage all Azure assets within one subscription.
    azureSubscriptionId String
    The unique alphanumeric string that identifies your Azure subscription.
    datadogApiKey String
    The Datadog API key.
    datadogRegion String
    The Datadog region. Possible values: us, eu, us3, us5.
    httpAuthorization String
    Sent in the HTTP "Authorization" header with each request.
    httpContentFormat String
    The format of data sent over HTTP. Options are "JSONLINES", "JSONARRAY" or "JSONOBJECT"
    httpContentType String
    The "Content-Type" header to send over HTTP. Common value is "application/json".
    httpCustomHeaders List<Map<String,String>>
    Additional HTTP headers to be included as part of the HTTP request.
    httpEndpoint String
    The HTTP endpoint to send streaming logs.
    mixpanelProjectId String
    The Mixpanel project ID, found on the Project Settings page.
    mixpanelRegion String
    The Mixpanel region. Options are ["us", "eu"]. EU is required for customers with EU data residency requirements.
    mixpanelServiceAccountPassword String
    The Mixpanel Service Account password.
    mixpanelServiceAccountUsername String
    The Mixpanel Service Account username. Services Accounts can be created in the Project Settings page.
    segmentWriteKey String
    The Segment Write Key.
    splunkDomain String
    The Splunk domain name.
    splunkPort String
    The Splunk port.
    splunkSecure Boolean
    This toggle should be turned off when using self-signed certificates.
    splunkToken String
    The Splunk access token.
    sumoSourceAddress String
    Generated URL for your defined HTTP source in Sumo Logic for collecting streaming data from Auth0.
    awsAccountId string
    The AWS Account ID.
    awsPartnerEventSource string
    Name of the Partner Event Source to be used with AWS. Generally generated by Auth0 and passed to AWS, so this should be an output attribute.
    awsRegion string
    The region in which the EventBridge event source will be created. Possible values: ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, cn-north-1, cn-northwest-1, eu-central-1, eu-north-1, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-gov-east-1, us-gov-west-1, us-east-1, us-east-2, us-west-1, us-west-2.
    azurePartnerTopic string
    Name of the Partner Topic to be used with Azure. Generally should not be specified.
    azureRegion string
    The Azure region code. Possible values: australiacentral, australiaeast, australiasoutheast, brazilsouth, canadacentral, canadaeast, centralindia, centralus, eastasia, eastus, eastus2, francecentral, germanywestcentral, japaneast, japanwest, koreacentral, koreasouth, northcentralus, northeurope, norwayeast, southafricanorth, southcentralus, southeastasia, southindia, switzerlandnorth, uaenorth, uksouth, ukwest, westcentralus, westeurope, westindia, westus, westus2.
    azureResourceGroup string
    The Azure EventGrid resource group which allows you to manage all Azure assets within one subscription.
    azureSubscriptionId string
    The unique alphanumeric string that identifies your Azure subscription.
    datadogApiKey string
    The Datadog API key.
    datadogRegion string
    The Datadog region. Possible values: us, eu, us3, us5.
    httpAuthorization string
    Sent in the HTTP "Authorization" header with each request.
    httpContentFormat string
    The format of data sent over HTTP. Options are "JSONLINES", "JSONARRAY" or "JSONOBJECT"
    httpContentType string
    The "Content-Type" header to send over HTTP. Common value is "application/json".
    httpCustomHeaders {[key: string]: string}[]
    Additional HTTP headers to be included as part of the HTTP request.
    httpEndpoint string
    The HTTP endpoint to send streaming logs.
    mixpanelProjectId string
    The Mixpanel project ID, found on the Project Settings page.
    mixpanelRegion string
    The Mixpanel region. Options are ["us", "eu"]. EU is required for customers with EU data residency requirements.
    mixpanelServiceAccountPassword string
    The Mixpanel Service Account password.
    mixpanelServiceAccountUsername string
    The Mixpanel Service Account username. Services Accounts can be created in the Project Settings page.
    segmentWriteKey string
    The Segment Write Key.
    splunkDomain string
    The Splunk domain name.
    splunkPort string
    The Splunk port.
    splunkSecure boolean
    This toggle should be turned off when using self-signed certificates.
    splunkToken string
    The Splunk access token.
    sumoSourceAddress string
    Generated URL for your defined HTTP source in Sumo Logic for collecting streaming data from Auth0.
    aws_account_id str
    The AWS Account ID.
    aws_partner_event_source str
    Name of the Partner Event Source to be used with AWS. Generally generated by Auth0 and passed to AWS, so this should be an output attribute.
    aws_region str
    The region in which the EventBridge event source will be created. Possible values: ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, cn-north-1, cn-northwest-1, eu-central-1, eu-north-1, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-gov-east-1, us-gov-west-1, us-east-1, us-east-2, us-west-1, us-west-2.
    azure_partner_topic str
    Name of the Partner Topic to be used with Azure. Generally should not be specified.
    azure_region str
    The Azure region code. Possible values: australiacentral, australiaeast, australiasoutheast, brazilsouth, canadacentral, canadaeast, centralindia, centralus, eastasia, eastus, eastus2, francecentral, germanywestcentral, japaneast, japanwest, koreacentral, koreasouth, northcentralus, northeurope, norwayeast, southafricanorth, southcentralus, southeastasia, southindia, switzerlandnorth, uaenorth, uksouth, ukwest, westcentralus, westeurope, westindia, westus, westus2.
    azure_resource_group str
    The Azure EventGrid resource group which allows you to manage all Azure assets within one subscription.
    azure_subscription_id str
    The unique alphanumeric string that identifies your Azure subscription.
    datadog_api_key str
    The Datadog API key.
    datadog_region str
    The Datadog region. Possible values: us, eu, us3, us5.
    http_authorization str
    Sent in the HTTP "Authorization" header with each request.
    http_content_format str
    The format of data sent over HTTP. Options are "JSONLINES", "JSONARRAY" or "JSONOBJECT"
    http_content_type str
    The "Content-Type" header to send over HTTP. Common value is "application/json".
    http_custom_headers Sequence[Mapping[str, str]]
    Additional HTTP headers to be included as part of the HTTP request.
    http_endpoint str
    The HTTP endpoint to send streaming logs.
    mixpanel_project_id str
    The Mixpanel project ID, found on the Project Settings page.
    mixpanel_region str
    The Mixpanel region. Options are ["us", "eu"]. EU is required for customers with EU data residency requirements.
    mixpanel_service_account_password str
    The Mixpanel Service Account password.
    mixpanel_service_account_username str
    The Mixpanel Service Account username. Services Accounts can be created in the Project Settings page.
    segment_write_key str
    The Segment Write Key.
    splunk_domain str
    The Splunk domain name.
    splunk_port str
    The Splunk port.
    splunk_secure bool
    This toggle should be turned off when using self-signed certificates.
    splunk_token str
    The Splunk access token.
    sumo_source_address str
    Generated URL for your defined HTTP source in Sumo Logic for collecting streaming data from Auth0.
    awsAccountId String
    The AWS Account ID.
    awsPartnerEventSource String
    Name of the Partner Event Source to be used with AWS. Generally generated by Auth0 and passed to AWS, so this should be an output attribute.
    awsRegion String
    The region in which the EventBridge event source will be created. Possible values: ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, cn-north-1, cn-northwest-1, eu-central-1, eu-north-1, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-gov-east-1, us-gov-west-1, us-east-1, us-east-2, us-west-1, us-west-2.
    azurePartnerTopic String
    Name of the Partner Topic to be used with Azure. Generally should not be specified.
    azureRegion String
    The Azure region code. Possible values: australiacentral, australiaeast, australiasoutheast, brazilsouth, canadacentral, canadaeast, centralindia, centralus, eastasia, eastus, eastus2, francecentral, germanywestcentral, japaneast, japanwest, koreacentral, koreasouth, northcentralus, northeurope, norwayeast, southafricanorth, southcentralus, southeastasia, southindia, switzerlandnorth, uaenorth, uksouth, ukwest, westcentralus, westeurope, westindia, westus, westus2.
    azureResourceGroup String
    The Azure EventGrid resource group which allows you to manage all Azure assets within one subscription.
    azureSubscriptionId String
    The unique alphanumeric string that identifies your Azure subscription.
    datadogApiKey String
    The Datadog API key.
    datadogRegion String
    The Datadog region. Possible values: us, eu, us3, us5.
    httpAuthorization String
    Sent in the HTTP "Authorization" header with each request.
    httpContentFormat String
    The format of data sent over HTTP. Options are "JSONLINES", "JSONARRAY" or "JSONOBJECT"
    httpContentType String
    The "Content-Type" header to send over HTTP. Common value is "application/json".
    httpCustomHeaders List<Map<String>>
    Additional HTTP headers to be included as part of the HTTP request.
    httpEndpoint String
    The HTTP endpoint to send streaming logs.
    mixpanelProjectId String
    The Mixpanel project ID, found on the Project Settings page.
    mixpanelRegion String
    The Mixpanel region. Options are ["us", "eu"]. EU is required for customers with EU data residency requirements.
    mixpanelServiceAccountPassword String
    The Mixpanel Service Account password.
    mixpanelServiceAccountUsername String
    The Mixpanel Service Account username. Services Accounts can be created in the Project Settings page.
    segmentWriteKey String
    The Segment Write Key.
    splunkDomain String
    The Splunk domain name.
    splunkPort String
    The Splunk port.
    splunkSecure Boolean
    This toggle should be turned off when using self-signed certificates.
    splunkToken String
    The Splunk access token.
    sumoSourceAddress String
    Generated URL for your defined HTTP source in Sumo Logic for collecting streaming data from Auth0.

    Import

    This resource can be imported by specifying the log stream ID.

    Example:

    $ pulumi import auth0:index/logStream:LogStream example "lst_XXXXXXXXXXXXXXXX"

    To learn more about importing existing cloud resources, see Importing resources.

    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.4.0 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-auth0