Auth0

Pulumi Official
Package maintained by Pulumi
v2.9.0 published on Thursday, May 26, 2022 by Pulumi

LogStream

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

Example Usage

using Pulumi;
using Auth0 = Pulumi.Auth0;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Auth0.LogStream("example", new Auth0.LogStreamArgs
        {
            Filters = 
            {
                
                {
                    { "name", "auth.login.fail" },
                    { "type", "category" },
                },
                
                {
                    { "name", "auth.signup.fail" },
                    { "type", "category" },
                },
            },
            Sink = new Auth0.Inputs.LogStreamSinkArgs
            {
                AwsAccountId = "my_account_id",
                AwsRegion = "us-east-2",
            },
            Status = "active",
            Type = "eventbridge",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-auth0/sdk/v2/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth0.NewLogStream(ctx, "example", &auth0.LogStreamArgs{
			Filters: pulumi.StringMapArray{
				pulumi.StringMap{
					"name": pulumi.String("auth.login.fail"),
					"type": pulumi.String("category"),
				},
				pulumi.StringMap{
					"name": pulumi.String("auth.signup.fail"),
					"type": pulumi.String("category"),
				},
			},
			Sink: &LogStreamSinkArgs{
				AwsAccountId: pulumi.String("my_account_id"),
				AwsRegion:    pulumi.String("us-east-2"),
			},
			Status: pulumi.String("active"),
			Type:   pulumi.String("eventbridge"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new LogStream("example", LogStreamArgs.builder()        
            .filters(            
                Map.ofEntries(
                    Map.entry("name", "auth.login.fail"),
                    Map.entry("type", "category")
                ),
                Map.ofEntries(
                    Map.entry("name", "auth.signup.fail"),
                    Map.entry("type", "category")
                ))
            .sink(LogStreamSinkArgs.builder()
                .awsAccountId("my_account_id")
                .awsRegion("us-east-2")
                .build())
            .status("active")
            .type("eventbridge")
            .build());

    }
}
import pulumi
import pulumi_auth0 as auth0

example = auth0.LogStream("example",
    filters=[
        {
            "name": "auth.login.fail",
            "type": "category",
        },
        {
            "name": "auth.signup.fail",
            "type": "category",
        },
    ],
    sink=auth0.LogStreamSinkArgs(
        aws_account_id="my_account_id",
        aws_region="us-east-2",
    ),
    status="active",
    type="eventbridge")
import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";

const example = new auth0.LogStream("example", {
    filters: [
        {
            name: "auth.login.fail",
            type: "category",
        },
        {
            name: "auth.signup.fail",
            type: "category",
        },
    ],
    sink: {
        awsAccountId: "my_account_id",
        awsRegion: "us-east-2",
    },
    status: "active",
    type: "eventbridge",
});
resources:
  example:
    type: auth0:LogStream
    properties:
      filters:
        - name: auth.login.fail
          type: category
        - name: auth.signup.fail
          type: category
      sink:
        awsAccountId: my_account_id
        awsRegion: us-east-2
      status: active
      type: eventbridge

Create a LogStream Resource

new LogStream(name: string, args: LogStreamArgs, opts?: CustomResourceOptions);
@overload
def LogStream(resource_name: 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)
@overload
def LogStream(resource_name: str,
              args: LogStreamArgs,
              opts: Optional[ResourceOptions] = 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.

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.

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 LogStreamSinkArgs

List(Resource) The sink configuration for the log stream. For details, see Sink Configuration.

Type string

The type of log stream. Options are "eventbridge", "eventgrid", "http", "datadog", "splunk", "sumo"

Filters List<ImmutableDictionary<string, string>>

Only logs events matching these filters will be delivered by the stream.

Name string

Name of the log stream

Status string

The current status of the log stream. Options are "active", "paused", "suspended"

Sink LogStreamSinkArgs

List(Resource) The sink configuration for the log stream. For details, see Sink Configuration.

Type string

The type of log stream. Options are "eventbridge", "eventgrid", "http", "datadog", "splunk", "sumo"

Filters []map[string]string

Only logs events matching these filters will be delivered by the stream.

Name string

Name of the log stream

Status string

The current status of the log stream. Options are "active", "paused", "suspended"

sink LogStreamSinkArgs

List(Resource) The sink configuration for the log stream. For details, see Sink Configuration.

type String

The type of log stream. Options are "eventbridge", "eventgrid", "http", "datadog", "splunk", "sumo"

filters List<Map<String,String>>

Only logs events matching these filters will be delivered by the stream.

name String

Name of the log stream

status String

The current status of the log stream. Options are "active", "paused", "suspended"

sink LogStreamSinkArgs

List(Resource) The sink configuration for the log stream. For details, see Sink Configuration.

type string

The type of log stream. Options are "eventbridge", "eventgrid", "http", "datadog", "splunk", "sumo"

filters {[key: string]: string}[]

Only logs events matching these filters will be delivered by the stream.

name string

Name of the log stream

status string

The current status of the log stream. Options are "active", "paused", "suspended"

sink LogStreamSinkArgs

List(Resource) The sink configuration for the log stream. For details, see Sink Configuration.

type str

The type of log stream. Options are "eventbridge", "eventgrid", "http", "datadog", "splunk", "sumo"

filters Sequence[Mapping[str, str]]

Only logs events matching these filters will be delivered by the stream.

name str

Name of the log stream

status str

The current status of the log stream. Options are "active", "paused", "suspended"

sink Property Map

List(Resource) The sink configuration for the log stream. For details, see Sink Configuration.

type String

The type of log stream. Options are "eventbridge", "eventgrid", "http", "datadog", "splunk", "sumo"

filters List<Map<String>>

Only logs events matching these filters will be delivered by the stream.

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 an 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.

Name string

Name of the log stream

Sink LogStreamSinkArgs

List(Resource) The sink configuration for the log stream. For details, see Sink Configuration.

Status string

The current status of the log stream. Options are "active", "paused", "suspended"

Type string

The type of log stream. Options are "eventbridge", "eventgrid", "http", "datadog", "splunk", "sumo"

Filters []map[string]string

Only logs events matching these filters will be delivered by the stream.

Name string

Name of the log stream

Sink LogStreamSinkArgs

List(Resource) The sink configuration for the log stream. For details, see Sink Configuration.

Status string

The current status of the log stream. Options are "active", "paused", "suspended"

Type string

The type of log stream. Options are "eventbridge", "eventgrid", "http", "datadog", "splunk", "sumo"

filters List<Map<String,String>>

Only logs events matching these filters will be delivered by the stream.

name String

Name of the log stream

sink LogStreamSinkArgs

List(Resource) The sink configuration for the log stream. For details, see Sink Configuration.

status String

The current status of the log stream. Options are "active", "paused", "suspended"

type String

The type of log stream. Options are "eventbridge", "eventgrid", "http", "datadog", "splunk", "sumo"

filters {[key: string]: string}[]

Only logs events matching these filters will be delivered by the stream.

name string

Name of the log stream

sink LogStreamSinkArgs

List(Resource) The sink configuration for the log stream. For details, see Sink Configuration.

status string

The current status of the log stream. Options are "active", "paused", "suspended"

type string

The type of log stream. Options are "eventbridge", "eventgrid", "http", "datadog", "splunk", "sumo"

filters Sequence[Mapping[str, str]]

Only logs events matching these filters will be delivered by the stream.

name str

Name of the log stream

sink LogStreamSinkArgs

List(Resource) The sink configuration for the log stream. For details, see Sink Configuration.

status str

The current status of the log stream. Options are "active", "paused", "suspended"

type str

The type of log stream. Options are "eventbridge", "eventgrid", "http", "datadog", "splunk", "sumo"

filters List<Map<String>>

Only logs events matching these filters will be delivered by the stream.

name String

Name of the log stream

sink Property Map

List(Resource) The sink configuration for the log stream. For details, see Sink Configuration.

status String

The current status of the log stream. Options are "active", "paused", "suspended"

type String

The type of log stream. Options are "eventbridge", "eventgrid", "http", "datadog", "splunk", "sumo"

Supporting Types

LogStreamSink

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 generally be an output attribute.

AwsRegion string

The AWS Region (i.e "us-east-2")

AzurePartnerTopic string

Name of the Partner Topic to be used with Azure. Generally should not be specified.

AzureRegion string

The Azure region code (i.e. "ne")

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

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 ContentType 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

SplunkDomain string

The Splunk domain name

SplunkPort string
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 generally be an output attribute.

AwsRegion string

The AWS Region (i.e "us-east-2")

AzurePartnerTopic string

Name of the Partner Topic to be used with Azure. Generally should not be specified.

AzureRegion string

The Azure region code (i.e. "ne")

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

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 ContentType 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

SplunkDomain string

The Splunk domain name

SplunkPort string
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 generally be an output attribute.

awsRegion String

The AWS Region (i.e "us-east-2")

azurePartnerTopic String

Name of the Partner Topic to be used with Azure. Generally should not be specified.

azureRegion String

The Azure region code (i.e. "ne")

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

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 ContentType 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

splunkDomain String

The Splunk domain name

splunkPort String
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 generally be an output attribute.

awsRegion string

The AWS Region (i.e "us-east-2")

azurePartnerTopic string

Name of the Partner Topic to be used with Azure. Generally should not be specified.

azureRegion string

The Azure region code (i.e. "ne")

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

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 ContentType 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

splunkDomain string

The Splunk domain name

splunkPort string
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 generally be an output attribute.

aws_region str

The AWS Region (i.e "us-east-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 (i.e. "ne")

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

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 ContentType 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

splunk_domain str

The Splunk domain name

splunk_port str
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 generally be an output attribute.

awsRegion String

The AWS Region (i.e "us-east-2")

azurePartnerTopic String

Name of the Partner Topic to be used with Azure. Generally should not be specified.

azureRegion String

The Azure region code (i.e. "ne")

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

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 ContentType 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

splunkDomain String

The Splunk domain name

splunkPort String
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

Existing log stream can be imported using log stream id, e.g.

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

Package Details

Repository
https://github.com/pulumi/pulumi-auth0
License
Apache-2.0
Notes

This Pulumi package is based on the auth0 Terraform Provider.