Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tailscale Provider
  3. API Docs
  4. LogstreamConfiguration
Tailscale v0.17.4 published on Thursday, Oct 24, 2024 by Pulumi
pulumi/pulumi-tailscale

tailscale.LogstreamConfiguration

Explore with Pulumi AI

tailscale logo
Tailscale v0.17.4 published on Thursday, Oct 24, 2024 by Pulumi
pulumi/pulumi-tailscale

    The logstream_configuration resource allows you to configure streaming configuration or network flow logs to a supported security information and event management (SIEM) system. See https://tailscale.com/kb/1255/log-streaming for more information.

    Example Usage

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

const sampleLogstreamConfiguration = new tailscale.LogstreamConfiguration("sample_logstream_configuration", {
    logType: "configuration",
    destinationType: "panther",
    url: "https://example.com",
    token: "some-token",
});

    import pulumi
import pulumi_tailscale as tailscale

sample_logstream_configuration = tailscale.LogstreamConfiguration("sample_logstream_configuration",
    log_type="configuration",
    destination_type="panther",
    url="https://example.com",
    token="some-token")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tailscale.NewLogstreamConfiguration(ctx, "sample_logstream_configuration", &tailscale.LogstreamConfigurationArgs{
			LogType:         pulumi.String("configuration"),
			DestinationType: pulumi.String("panther"),
			Url:             pulumi.String("https://example.com"),
			Token:           pulumi.String("some-token"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var sampleLogstreamConfiguration = new Tailscale.LogstreamConfiguration("sample_logstream_configuration", new()
    {
        LogType = "configuration",
        DestinationType = "panther",
        Url = "https://example.com",
        Token = "some-token",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tailscale.LogstreamConfiguration;
import com.pulumi.tailscale.LogstreamConfigurationArgs;
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) {
        var sampleLogstreamConfiguration = new LogstreamConfiguration("sampleLogstreamConfiguration", LogstreamConfigurationArgs.builder()
            .logType("configuration")
            .destinationType("panther")
            .url("https://example.com")
            .token("some-token")
            .build());

    }
}

    resources:
  sampleLogstreamConfiguration:
    type: tailscale:LogstreamConfiguration
    name: sample_logstream_configuration
    properties:
      logType: configuration
      destinationType: panther
      url: https://example.com
      token: some-token

    Create LogstreamConfiguration Resource

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

    Constructor syntax

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

@overload
def LogstreamConfiguration(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           destination_type: Optional[str] = None,
                           log_type: Optional[str] = None,
                           token: Optional[str] = None,
                           url: Optional[str] = None,
                           user: Optional[str] = None)
    func NewLogstreamConfiguration(ctx *Context, name string, args LogstreamConfigurationArgs, opts ...ResourceOption) (*LogstreamConfiguration, error)
    public LogstreamConfiguration(string name, LogstreamConfigurationArgs args, CustomResourceOptions? opts = null)
    public LogstreamConfiguration(String name, LogstreamConfigurationArgs args)
public LogstreamConfiguration(String name, LogstreamConfigurationArgs args, CustomResourceOptions options)

    type: tailscale:LogstreamConfiguration
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 LogstreamConfigurationArgs
    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 LogstreamConfigurationArgs
    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 LogstreamConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LogstreamConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LogstreamConfigurationArgs
    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 logstreamConfigurationResource = new Tailscale.LogstreamConfiguration("logstreamConfigurationResource", new()
{
    DestinationType = "string",
    LogType = "string",
    Token = "string",
    Url = "string",
    User = "string",
});

    example, err := tailscale.NewLogstreamConfiguration(ctx, "logstreamConfigurationResource", &tailscale.LogstreamConfigurationArgs{
	DestinationType: pulumi.String("string"),
	LogType:         pulumi.String("string"),
	Token:           pulumi.String("string"),
	Url:             pulumi.String("string"),
	User:            pulumi.String("string"),
})

    var logstreamConfigurationResource = new LogstreamConfiguration("logstreamConfigurationResource", LogstreamConfigurationArgs.builder()
    .destinationType("string")
    .logType("string")
    .token("string")
    .url("string")
    .user("string")
    .build());

    logstream_configuration_resource = tailscale.LogstreamConfiguration("logstreamConfigurationResource",
    destination_type="string",
    log_type="string",
    token="string",
    url="string",
    user="string")

    const logstreamConfigurationResource = new tailscale.LogstreamConfiguration("logstreamConfigurationResource", {
    destinationType: "string",
    logType: "string",
    token: "string",
    url: "string",
    user: "string",
});

    type: tailscale:LogstreamConfiguration
properties:
    destinationType: string
    logType: string
    token: string
    url: string
    user: string

    LogstreamConfiguration Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LogstreamConfiguration resource accepts the following input properties:

    DestinationType string
    The type of system to which logs are being streamed.
    LogType string
    The type of log that is streamed to this endpoint.
    Token string
    The token/password with which log streams to this endpoint should be authenticated.
    Url string
    The URL to which log streams are being posted.
    User string
    The username with which log streams to this endpoint are authenticated. Only required if destination_type is 'elastic', defaults to 'user' if not set.
    DestinationType string
    The type of system to which logs are being streamed.
    LogType string
    The type of log that is streamed to this endpoint.
    Token string
    The token/password with which log streams to this endpoint should be authenticated.
    Url string
    The URL to which log streams are being posted.
    User string
    The username with which log streams to this endpoint are authenticated. Only required if destination_type is 'elastic', defaults to 'user' if not set.
    destinationType String
    The type of system to which logs are being streamed.
    logType String
    The type of log that is streamed to this endpoint.
    token String
    The token/password with which log streams to this endpoint should be authenticated.
    url String
    The URL to which log streams are being posted.
    user String
    The username with which log streams to this endpoint are authenticated. Only required if destination_type is 'elastic', defaults to 'user' if not set.
    destinationType string
    The type of system to which logs are being streamed.
    logType string
    The type of log that is streamed to this endpoint.
    token string
    The token/password with which log streams to this endpoint should be authenticated.
    url string
    The URL to which log streams are being posted.
    user string
    The username with which log streams to this endpoint are authenticated. Only required if destination_type is 'elastic', defaults to 'user' if not set.
    destination_type str
    The type of system to which logs are being streamed.
    log_type str
    The type of log that is streamed to this endpoint.
    token str
    The token/password with which log streams to this endpoint should be authenticated.
    url str
    The URL to which log streams are being posted.
    user str
    The username with which log streams to this endpoint are authenticated. Only required if destination_type is 'elastic', defaults to 'user' if not set.
    destinationType String
    The type of system to which logs are being streamed.
    logType String
    The type of log that is streamed to this endpoint.
    token String
    The token/password with which log streams to this endpoint should be authenticated.
    url String
    The URL to which log streams are being posted.
    user String
    The username with which log streams to this endpoint are authenticated. Only required if destination_type is 'elastic', defaults to 'user' if not set.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LogstreamConfiguration 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 LogstreamConfiguration Resource

    Get an existing LogstreamConfiguration 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?: LogstreamConfigurationState, opts?: CustomResourceOptions): LogstreamConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        destination_type: Optional[str] = None,
        log_type: Optional[str] = None,
        token: Optional[str] = None,
        url: Optional[str] = None,
        user: Optional[str] = None) -> LogstreamConfiguration
    func GetLogstreamConfiguration(ctx *Context, name string, id IDInput, state *LogstreamConfigurationState, opts ...ResourceOption) (*LogstreamConfiguration, error)
    public static LogstreamConfiguration Get(string name, Input<string> id, LogstreamConfigurationState? state, CustomResourceOptions? opts = null)
    public static LogstreamConfiguration get(String name, Output<String> id, LogstreamConfigurationState 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:
    DestinationType string
    The type of system to which logs are being streamed.
    LogType string
    The type of log that is streamed to this endpoint.
    Token string
    The token/password with which log streams to this endpoint should be authenticated.
    Url string
    The URL to which log streams are being posted.
    User string
    The username with which log streams to this endpoint are authenticated. Only required if destination_type is 'elastic', defaults to 'user' if not set.
    DestinationType string
    The type of system to which logs are being streamed.
    LogType string
    The type of log that is streamed to this endpoint.
    Token string
    The token/password with which log streams to this endpoint should be authenticated.
    Url string
    The URL to which log streams are being posted.
    User string
    The username with which log streams to this endpoint are authenticated. Only required if destination_type is 'elastic', defaults to 'user' if not set.
    destinationType String
    The type of system to which logs are being streamed.
    logType String
    The type of log that is streamed to this endpoint.
    token String
    The token/password with which log streams to this endpoint should be authenticated.
    url String
    The URL to which log streams are being posted.
    user String
    The username with which log streams to this endpoint are authenticated. Only required if destination_type is 'elastic', defaults to 'user' if not set.
    destinationType string
    The type of system to which logs are being streamed.
    logType string
    The type of log that is streamed to this endpoint.
    token string
    The token/password with which log streams to this endpoint should be authenticated.
    url string
    The URL to which log streams are being posted.
    user string
    The username with which log streams to this endpoint are authenticated. Only required if destination_type is 'elastic', defaults to 'user' if not set.
    destination_type str
    The type of system to which logs are being streamed.
    log_type str
    The type of log that is streamed to this endpoint.
    token str
    The token/password with which log streams to this endpoint should be authenticated.
    url str
    The URL to which log streams are being posted.
    user str
    The username with which log streams to this endpoint are authenticated. Only required if destination_type is 'elastic', defaults to 'user' if not set.
    destinationType String
    The type of system to which logs are being streamed.
    logType String
    The type of log that is streamed to this endpoint.
    token String
    The token/password with which log streams to this endpoint should be authenticated.
    url String
    The URL to which log streams are being posted.
    user String
    The username with which log streams to this endpoint are authenticated. Only required if destination_type is 'elastic', defaults to 'user' if not set.

    Import

    Logstream configuration can be imported using the logstream configuration id, e.g.,

    $ pulumi import tailscale:index/logstreamConfiguration:LogstreamConfiguration sample_logstream_configuration 123456789

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

    Package Details

    Repository
    tailscale pulumi/pulumi-tailscale
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the tailscale Terraform Provider.
    tailscale logo
    Tailscale v0.17.4 published on Thursday, Oct 24, 2024 by Pulumi
    pulumi/pulumi-tailscale