Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tailscale Provider
  3. API Docs
  4. LogstreamConfiguration
Tailscale v0.18.0 published on Thursday, Feb 27, 2025 by Pulumi
pulumi/pulumi-tailscale

tailscale.LogstreamConfiguration

Explore with Pulumi AI

tailscale logo
Tailscale v0.18.0 published on Thursday, Feb 27, 2025 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";

// Example configuration for a non-S3 logstreaming endpoint
const sampleLogstreamConfiguration = new tailscale.LogstreamConfiguration("sample_logstream_configuration", {
    logType: "configuration",
    destinationType: "panther",
    url: "https://example.com",
    token: "some-token",
});
// Example configuration for an AWS S3 logstreaming endpoint
const sampleLogstreamConfigurationS3 = new tailscale.LogstreamConfiguration("sample_logstream_configuration_s3", {
    logType: "configuration",
    destinationType: "s3",
    s3Bucket: tailscaleLogs.id,
    s3Region: "us-west-2",
    s3AuthenticationType: "rolearn",
    s3RoleArn: tailscaleLogsWriter.arn,
    s3ExternalId: prod.externalId,
});
// Example configuration for an S3-compatible logstreaming endpoint
const sampleLogstreamConfigurationS3Compatible = new tailscale.LogstreamConfiguration("sample_logstream_configuration_s3_compatible", {
    logType: "configuration",
    destinationType: "s3",
    url: "https://s3.example.com",
    s3Bucket: "example-bucket",
    s3Region: "us-west-2",
    s3AuthenticationType: "accesskey",
    s3AccessKeyId: "some-access-key",
    s3SecretAccessKey: "some-secret-key",
});

    import pulumi
import pulumi_tailscale as tailscale

# Example configuration for a non-S3 logstreaming endpoint
sample_logstream_configuration = tailscale.LogstreamConfiguration("sample_logstream_configuration",
    log_type="configuration",
    destination_type="panther",
    url="https://example.com",
    token="some-token")
# Example configuration for an AWS S3 logstreaming endpoint
sample_logstream_configuration_s3 = tailscale.LogstreamConfiguration("sample_logstream_configuration_s3",
    log_type="configuration",
    destination_type="s3",
    s3_bucket=tailscale_logs["id"],
    s3_region="us-west-2",
    s3_authentication_type="rolearn",
    s3_role_arn=tailscale_logs_writer["arn"],
    s3_external_id=prod["externalId"])
# Example configuration for an S3-compatible logstreaming endpoint
sample_logstream_configuration_s3_compatible = tailscale.LogstreamConfiguration("sample_logstream_configuration_s3_compatible",
    log_type="configuration",
    destination_type="s3",
    url="https://s3.example.com",
    s3_bucket="example-bucket",
    s3_region="us-west-2",
    s3_authentication_type="accesskey",
    s3_access_key_id="some-access-key",
    s3_secret_access_key="some-secret-key")

    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 {
		// Example configuration for a non-S3 logstreaming endpoint
		_, 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
		}
		// Example configuration for an AWS S3 logstreaming endpoint
		_, err = tailscale.NewLogstreamConfiguration(ctx, "sample_logstream_configuration_s3", &tailscale.LogstreamConfigurationArgs{
			LogType:              pulumi.String("configuration"),
			DestinationType:      pulumi.String("s3"),
			S3Bucket:             pulumi.Any(tailscaleLogs.Id),
			S3Region:             pulumi.String("us-west-2"),
			S3AuthenticationType: pulumi.String("rolearn"),
			S3RoleArn:            pulumi.Any(tailscaleLogsWriter.Arn),
			S3ExternalId:         pulumi.Any(prod.ExternalId),
		})
		if err != nil {
			return err
		}
		// Example configuration for an S3-compatible logstreaming endpoint
		_, err = tailscale.NewLogstreamConfiguration(ctx, "sample_logstream_configuration_s3_compatible", &tailscale.LogstreamConfigurationArgs{
			LogType:              pulumi.String("configuration"),
			DestinationType:      pulumi.String("s3"),
			Url:                  pulumi.String("https://s3.example.com"),
			S3Bucket:             pulumi.String("example-bucket"),
			S3Region:             pulumi.String("us-west-2"),
			S3AuthenticationType: pulumi.String("accesskey"),
			S3AccessKeyId:        pulumi.String("some-access-key"),
			S3SecretAccessKey:    pulumi.String("some-secret-key"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

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

    // Example configuration for an AWS S3 logstreaming endpoint
    var sampleLogstreamConfigurationS3 = new Tailscale.LogstreamConfiguration("sample_logstream_configuration_s3", new()
    {
        LogType = "configuration",
        DestinationType = "s3",
        S3Bucket = tailscaleLogs.Id,
        S3Region = "us-west-2",
        S3AuthenticationType = "rolearn",
        S3RoleArn = tailscaleLogsWriter.Arn,
        S3ExternalId = prod.ExternalId,
    });

    // Example configuration for an S3-compatible logstreaming endpoint
    var sampleLogstreamConfigurationS3Compatible = new Tailscale.LogstreamConfiguration("sample_logstream_configuration_s3_compatible", new()
    {
        LogType = "configuration",
        DestinationType = "s3",
        Url = "https://s3.example.com",
        S3Bucket = "example-bucket",
        S3Region = "us-west-2",
        S3AuthenticationType = "accesskey",
        S3AccessKeyId = "some-access-key",
        S3SecretAccessKey = "some-secret-key",
    });

});

    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) {
        // Example configuration for a non-S3 logstreaming endpoint
        var sampleLogstreamConfiguration = new LogstreamConfiguration("sampleLogstreamConfiguration", LogstreamConfigurationArgs.builder()
            .logType("configuration")
            .destinationType("panther")
            .url("https://example.com")
            .token("some-token")
            .build());

        // Example configuration for an AWS S3 logstreaming endpoint
        var sampleLogstreamConfigurationS3 = new LogstreamConfiguration("sampleLogstreamConfigurationS3", LogstreamConfigurationArgs.builder()
            .logType("configuration")
            .destinationType("s3")
            .s3Bucket(tailscaleLogs.id())
            .s3Region("us-west-2")
            .s3AuthenticationType("rolearn")
            .s3RoleArn(tailscaleLogsWriter.arn())
            .s3ExternalId(prod.externalId())
            .build());

        // Example configuration for an S3-compatible logstreaming endpoint
        var sampleLogstreamConfigurationS3Compatible = new LogstreamConfiguration("sampleLogstreamConfigurationS3Compatible", LogstreamConfigurationArgs.builder()
            .logType("configuration")
            .destinationType("s3")
            .url("https://s3.example.com")
            .s3Bucket("example-bucket")
            .s3Region("us-west-2")
            .s3AuthenticationType("accesskey")
            .s3AccessKeyId("some-access-key")
            .s3SecretAccessKey("some-secret-key")
            .build());

    }
}

    resources:
  # Example configuration for a non-S3 logstreaming endpoint
  sampleLogstreamConfiguration:
    type: tailscale:LogstreamConfiguration
    name: sample_logstream_configuration
    properties:
      logType: configuration
      destinationType: panther
      url: https://example.com
      token: some-token
  # Example configuration for an AWS S3 logstreaming endpoint
  sampleLogstreamConfigurationS3:
    type: tailscale:LogstreamConfiguration
    name: sample_logstream_configuration_s3
    properties:
      logType: configuration
      destinationType: s3
      s3Bucket: ${tailscaleLogs.id}
      s3Region: us-west-2
      s3AuthenticationType: rolearn
      s3RoleArn: ${tailscaleLogsWriter.arn}
      s3ExternalId: ${prod.externalId}
  # Example configuration for an S3-compatible logstreaming endpoint
  sampleLogstreamConfigurationS3Compatible:
    type: tailscale:LogstreamConfiguration
    name: sample_logstream_configuration_s3_compatible
    properties:
      logType: configuration
      destinationType: s3
      url: https://s3.example.com
      s3Bucket: example-bucket
      s3Region: us-west-2
      s3AuthenticationType: accesskey
      s3AccessKeyId: some-access-key
      s3SecretAccessKey: some-secret-key

    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,
                           s3_access_key_id: Optional[str] = None,
                           s3_authentication_type: Optional[str] = None,
                           s3_bucket: Optional[str] = None,
                           s3_external_id: Optional[str] = None,
                           s3_key_prefix: Optional[str] = None,
                           s3_region: Optional[str] = None,
                           s3_role_arn: Optional[str] = None,
                           s3_secret_access_key: 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",
    S3AccessKeyId = "string",
    S3AuthenticationType = "string",
    S3Bucket = "string",
    S3ExternalId = "string",
    S3KeyPrefix = "string",
    S3Region = "string",
    S3RoleArn = "string",
    S3SecretAccessKey = "string",
    Token = "string",
    Url = "string",
    User = "string",
});

    example, err := tailscale.NewLogstreamConfiguration(ctx, "logstreamConfigurationResource", &tailscale.LogstreamConfigurationArgs{
	DestinationType:      pulumi.String("string"),
	LogType:              pulumi.String("string"),
	S3AccessKeyId:        pulumi.String("string"),
	S3AuthenticationType: pulumi.String("string"),
	S3Bucket:             pulumi.String("string"),
	S3ExternalId:         pulumi.String("string"),
	S3KeyPrefix:          pulumi.String("string"),
	S3Region:             pulumi.String("string"),
	S3RoleArn:            pulumi.String("string"),
	S3SecretAccessKey:    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")
    .s3AccessKeyId("string")
    .s3AuthenticationType("string")
    .s3Bucket("string")
    .s3ExternalId("string")
    .s3KeyPrefix("string")
    .s3Region("string")
    .s3RoleArn("string")
    .s3SecretAccessKey("string")
    .token("string")
    .url("string")
    .user("string")
    .build());

    logstream_configuration_resource = tailscale.LogstreamConfiguration("logstreamConfigurationResource",
    destination_type="string",
    log_type="string",
    s3_access_key_id="string",
    s3_authentication_type="string",
    s3_bucket="string",
    s3_external_id="string",
    s3_key_prefix="string",
    s3_region="string",
    s3_role_arn="string",
    s3_secret_access_key="string",
    token="string",
    url="string",
    user="string")

    const logstreamConfigurationResource = new tailscale.LogstreamConfiguration("logstreamConfigurationResource", {
    destinationType: "string",
    logType: "string",
    s3AccessKeyId: "string",
    s3AuthenticationType: "string",
    s3Bucket: "string",
    s3ExternalId: "string",
    s3KeyPrefix: "string",
    s3Region: "string",
    s3RoleArn: "string",
    s3SecretAccessKey: "string",
    token: "string",
    url: "string",
    user: "string",
});

    type: tailscale:LogstreamConfiguration
properties:
    destinationType: string
    logType: string
    s3AccessKeyId: string
    s3AuthenticationType: string
    s3Bucket: string
    s3ExternalId: string
    s3KeyPrefix: string
    s3Region: string
    s3RoleArn: string
    s3SecretAccessKey: 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.
    S3AccessKeyId string
    The S3 access key ID. Required if destinationtype is s3 and s3authentication_type is 'accesskey'.
    S3AuthenticationType string
    What type of authentication to use for S3. Required if destination_type is 's3'. Tailscale recommends using 'rolearn'.
    S3Bucket string
    The S3 bucket name. Required if destination_type is 's3'.
    S3ExternalId string
    The AWS External ID that Tailscale supplies when authenticating using role-based authentication. Required if destinationtype is 's3' and s3authenticationtype is 'rolearn'. This can be obtained via the tailscaleawsexternalid resource.
    S3KeyPrefix string
    An optional S3 key prefix to prepend to the auto-generated S3 key name.
    S3Region string
    The region in which the S3 bucket is located. Required if destination_type is 's3'.
    S3RoleArn string
    ARN of the AWS IAM role that Tailscale should assume when using role-based authentication. Required if destinationtype is 's3' and s3authentication_type is 'rolearn'.
    S3SecretAccessKey string
    The S3 secret access key. Required if destinationtype is 's3' and s3authentication_type is 'accesskey'.
    Token string
    The token/password with which log streams to this endpoint should be authenticated, required unless destination_type is 's3'.
    Url string
    The URL to which log streams are being posted. If destination_type is 's3' and you want to use the official Amazon S3 endpoint, leave this empty.
    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.
    S3AccessKeyId string
    The S3 access key ID. Required if destinationtype is s3 and s3authentication_type is 'accesskey'.
    S3AuthenticationType string
    What type of authentication to use for S3. Required if destination_type is 's3'. Tailscale recommends using 'rolearn'.
    S3Bucket string
    The S3 bucket name. Required if destination_type is 's3'.
    S3ExternalId string
    The AWS External ID that Tailscale supplies when authenticating using role-based authentication. Required if destinationtype is 's3' and s3authenticationtype is 'rolearn'. This can be obtained via the tailscaleawsexternalid resource.
    S3KeyPrefix string
    An optional S3 key prefix to prepend to the auto-generated S3 key name.
    S3Region string
    The region in which the S3 bucket is located. Required if destination_type is 's3'.
    S3RoleArn string
    ARN of the AWS IAM role that Tailscale should assume when using role-based authentication. Required if destinationtype is 's3' and s3authentication_type is 'rolearn'.
    S3SecretAccessKey string
    The S3 secret access key. Required if destinationtype is 's3' and s3authentication_type is 'accesskey'.
    Token string
    The token/password with which log streams to this endpoint should be authenticated, required unless destination_type is 's3'.
    Url string
    The URL to which log streams are being posted. If destination_type is 's3' and you want to use the official Amazon S3 endpoint, leave this empty.
    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.
    s3AccessKeyId String
    The S3 access key ID. Required if destinationtype is s3 and s3authentication_type is 'accesskey'.
    s3AuthenticationType String
    What type of authentication to use for S3. Required if destination_type is 's3'. Tailscale recommends using 'rolearn'.
    s3Bucket String
    The S3 bucket name. Required if destination_type is 's3'.
    s3ExternalId String
    The AWS External ID that Tailscale supplies when authenticating using role-based authentication. Required if destinationtype is 's3' and s3authenticationtype is 'rolearn'. This can be obtained via the tailscaleawsexternalid resource.
    s3KeyPrefix String
    An optional S3 key prefix to prepend to the auto-generated S3 key name.
    s3Region String
    The region in which the S3 bucket is located. Required if destination_type is 's3'.
    s3RoleArn String
    ARN of the AWS IAM role that Tailscale should assume when using role-based authentication. Required if destinationtype is 's3' and s3authentication_type is 'rolearn'.
    s3SecretAccessKey String
    The S3 secret access key. Required if destinationtype is 's3' and s3authentication_type is 'accesskey'.
    token String
    The token/password with which log streams to this endpoint should be authenticated, required unless destination_type is 's3'.
    url String
    The URL to which log streams are being posted. If destination_type is 's3' and you want to use the official Amazon S3 endpoint, leave this empty.
    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.
    s3AccessKeyId string
    The S3 access key ID. Required if destinationtype is s3 and s3authentication_type is 'accesskey'.
    s3AuthenticationType string
    What type of authentication to use for S3. Required if destination_type is 's3'. Tailscale recommends using 'rolearn'.
    s3Bucket string
    The S3 bucket name. Required if destination_type is 's3'.
    s3ExternalId string
    The AWS External ID that Tailscale supplies when authenticating using role-based authentication. Required if destinationtype is 's3' and s3authenticationtype is 'rolearn'. This can be obtained via the tailscaleawsexternalid resource.
    s3KeyPrefix string
    An optional S3 key prefix to prepend to the auto-generated S3 key name.
    s3Region string
    The region in which the S3 bucket is located. Required if destination_type is 's3'.
    s3RoleArn string
    ARN of the AWS IAM role that Tailscale should assume when using role-based authentication. Required if destinationtype is 's3' and s3authentication_type is 'rolearn'.
    s3SecretAccessKey string
    The S3 secret access key. Required if destinationtype is 's3' and s3authentication_type is 'accesskey'.
    token string
    The token/password with which log streams to this endpoint should be authenticated, required unless destination_type is 's3'.
    url string
    The URL to which log streams are being posted. If destination_type is 's3' and you want to use the official Amazon S3 endpoint, leave this empty.
    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.
    s3_access_key_id str
    The S3 access key ID. Required if destinationtype is s3 and s3authentication_type is 'accesskey'.
    s3_authentication_type str
    What type of authentication to use for S3. Required if destination_type is 's3'. Tailscale recommends using 'rolearn'.
    s3_bucket str
    The S3 bucket name. Required if destination_type is 's3'.
    s3_external_id str
    The AWS External ID that Tailscale supplies when authenticating using role-based authentication. Required if destinationtype is 's3' and s3authenticationtype is 'rolearn'. This can be obtained via the tailscaleawsexternalid resource.
    s3_key_prefix str
    An optional S3 key prefix to prepend to the auto-generated S3 key name.
    s3_region str
    The region in which the S3 bucket is located. Required if destination_type is 's3'.
    s3_role_arn str
    ARN of the AWS IAM role that Tailscale should assume when using role-based authentication. Required if destinationtype is 's3' and s3authentication_type is 'rolearn'.
    s3_secret_access_key str
    The S3 secret access key. Required if destinationtype is 's3' and s3authentication_type is 'accesskey'.
    token str
    The token/password with which log streams to this endpoint should be authenticated, required unless destination_type is 's3'.
    url str
    The URL to which log streams are being posted. If destination_type is 's3' and you want to use the official Amazon S3 endpoint, leave this empty.
    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.
    s3AccessKeyId String
    The S3 access key ID. Required if destinationtype is s3 and s3authentication_type is 'accesskey'.
    s3AuthenticationType String
    What type of authentication to use for S3. Required if destination_type is 's3'. Tailscale recommends using 'rolearn'.
    s3Bucket String
    The S3 bucket name. Required if destination_type is 's3'.
    s3ExternalId String
    The AWS External ID that Tailscale supplies when authenticating using role-based authentication. Required if destinationtype is 's3' and s3authenticationtype is 'rolearn'. This can be obtained via the tailscaleawsexternalid resource.
    s3KeyPrefix String
    An optional S3 key prefix to prepend to the auto-generated S3 key name.
    s3Region String
    The region in which the S3 bucket is located. Required if destination_type is 's3'.
    s3RoleArn String
    ARN of the AWS IAM role that Tailscale should assume when using role-based authentication. Required if destinationtype is 's3' and s3authentication_type is 'rolearn'.
    s3SecretAccessKey String
    The S3 secret access key. Required if destinationtype is 's3' and s3authentication_type is 'accesskey'.
    token String
    The token/password with which log streams to this endpoint should be authenticated, required unless destination_type is 's3'.
    url String
    The URL to which log streams are being posted. If destination_type is 's3' and you want to use the official Amazon S3 endpoint, leave this empty.
    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,
        s3_access_key_id: Optional[str] = None,
        s3_authentication_type: Optional[str] = None,
        s3_bucket: Optional[str] = None,
        s3_external_id: Optional[str] = None,
        s3_key_prefix: Optional[str] = None,
        s3_region: Optional[str] = None,
        s3_role_arn: Optional[str] = None,
        s3_secret_access_key: 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)
    resources:  _:    type: tailscale:LogstreamConfiguration    get:      id: ${id}
    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.
    S3AccessKeyId string
    The S3 access key ID. Required if destinationtype is s3 and s3authentication_type is 'accesskey'.
    S3AuthenticationType string
    What type of authentication to use for S3. Required if destination_type is 's3'. Tailscale recommends using 'rolearn'.
    S3Bucket string
    The S3 bucket name. Required if destination_type is 's3'.
    S3ExternalId string
    The AWS External ID that Tailscale supplies when authenticating using role-based authentication. Required if destinationtype is 's3' and s3authenticationtype is 'rolearn'. This can be obtained via the tailscaleawsexternalid resource.
    S3KeyPrefix string
    An optional S3 key prefix to prepend to the auto-generated S3 key name.
    S3Region string
    The region in which the S3 bucket is located. Required if destination_type is 's3'.
    S3RoleArn string
    ARN of the AWS IAM role that Tailscale should assume when using role-based authentication. Required if destinationtype is 's3' and s3authentication_type is 'rolearn'.
    S3SecretAccessKey string
    The S3 secret access key. Required if destinationtype is 's3' and s3authentication_type is 'accesskey'.
    Token string
    The token/password with which log streams to this endpoint should be authenticated, required unless destination_type is 's3'.
    Url string
    The URL to which log streams are being posted. If destination_type is 's3' and you want to use the official Amazon S3 endpoint, leave this empty.
    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.
    S3AccessKeyId string
    The S3 access key ID. Required if destinationtype is s3 and s3authentication_type is 'accesskey'.
    S3AuthenticationType string
    What type of authentication to use for S3. Required if destination_type is 's3'. Tailscale recommends using 'rolearn'.
    S3Bucket string
    The S3 bucket name. Required if destination_type is 's3'.
    S3ExternalId string
    The AWS External ID that Tailscale supplies when authenticating using role-based authentication. Required if destinationtype is 's3' and s3authenticationtype is 'rolearn'. This can be obtained via the tailscaleawsexternalid resource.
    S3KeyPrefix string
    An optional S3 key prefix to prepend to the auto-generated S3 key name.
    S3Region string
    The region in which the S3 bucket is located. Required if destination_type is 's3'.
    S3RoleArn string
    ARN of the AWS IAM role that Tailscale should assume when using role-based authentication. Required if destinationtype is 's3' and s3authentication_type is 'rolearn'.
    S3SecretAccessKey string
    The S3 secret access key. Required if destinationtype is 's3' and s3authentication_type is 'accesskey'.
    Token string
    The token/password with which log streams to this endpoint should be authenticated, required unless destination_type is 's3'.
    Url string
    The URL to which log streams are being posted. If destination_type is 's3' and you want to use the official Amazon S3 endpoint, leave this empty.
    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.
    s3AccessKeyId String
    The S3 access key ID. Required if destinationtype is s3 and s3authentication_type is 'accesskey'.
    s3AuthenticationType String
    What type of authentication to use for S3. Required if destination_type is 's3'. Tailscale recommends using 'rolearn'.
    s3Bucket String
    The S3 bucket name. Required if destination_type is 's3'.
    s3ExternalId String
    The AWS External ID that Tailscale supplies when authenticating using role-based authentication. Required if destinationtype is 's3' and s3authenticationtype is 'rolearn'. This can be obtained via the tailscaleawsexternalid resource.
    s3KeyPrefix String
    An optional S3 key prefix to prepend to the auto-generated S3 key name.
    s3Region String
    The region in which the S3 bucket is located. Required if destination_type is 's3'.
    s3RoleArn String
    ARN of the AWS IAM role that Tailscale should assume when using role-based authentication. Required if destinationtype is 's3' and s3authentication_type is 'rolearn'.
    s3SecretAccessKey String
    The S3 secret access key. Required if destinationtype is 's3' and s3authentication_type is 'accesskey'.
    token String
    The token/password with which log streams to this endpoint should be authenticated, required unless destination_type is 's3'.
    url String
    The URL to which log streams are being posted. If destination_type is 's3' and you want to use the official Amazon S3 endpoint, leave this empty.
    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.
    s3AccessKeyId string
    The S3 access key ID. Required if destinationtype is s3 and s3authentication_type is 'accesskey'.
    s3AuthenticationType string
    What type of authentication to use for S3. Required if destination_type is 's3'. Tailscale recommends using 'rolearn'.
    s3Bucket string
    The S3 bucket name. Required if destination_type is 's3'.
    s3ExternalId string
    The AWS External ID that Tailscale supplies when authenticating using role-based authentication. Required if destinationtype is 's3' and s3authenticationtype is 'rolearn'. This can be obtained via the tailscaleawsexternalid resource.
    s3KeyPrefix string
    An optional S3 key prefix to prepend to the auto-generated S3 key name.
    s3Region string
    The region in which the S3 bucket is located. Required if destination_type is 's3'.
    s3RoleArn string
    ARN of the AWS IAM role that Tailscale should assume when using role-based authentication. Required if destinationtype is 's3' and s3authentication_type is 'rolearn'.
    s3SecretAccessKey string
    The S3 secret access key. Required if destinationtype is 's3' and s3authentication_type is 'accesskey'.
    token string
    The token/password with which log streams to this endpoint should be authenticated, required unless destination_type is 's3'.
    url string
    The URL to which log streams are being posted. If destination_type is 's3' and you want to use the official Amazon S3 endpoint, leave this empty.
    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.
    s3_access_key_id str
    The S3 access key ID. Required if destinationtype is s3 and s3authentication_type is 'accesskey'.
    s3_authentication_type str
    What type of authentication to use for S3. Required if destination_type is 's3'. Tailscale recommends using 'rolearn'.
    s3_bucket str
    The S3 bucket name. Required if destination_type is 's3'.
    s3_external_id str
    The AWS External ID that Tailscale supplies when authenticating using role-based authentication. Required if destinationtype is 's3' and s3authenticationtype is 'rolearn'. This can be obtained via the tailscaleawsexternalid resource.
    s3_key_prefix str
    An optional S3 key prefix to prepend to the auto-generated S3 key name.
    s3_region str
    The region in which the S3 bucket is located. Required if destination_type is 's3'.
    s3_role_arn str
    ARN of the AWS IAM role that Tailscale should assume when using role-based authentication. Required if destinationtype is 's3' and s3authentication_type is 'rolearn'.
    s3_secret_access_key str
    The S3 secret access key. Required if destinationtype is 's3' and s3authentication_type is 'accesskey'.
    token str
    The token/password with which log streams to this endpoint should be authenticated, required unless destination_type is 's3'.
    url str
    The URL to which log streams are being posted. If destination_type is 's3' and you want to use the official Amazon S3 endpoint, leave this empty.
    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.
    s3AccessKeyId String
    The S3 access key ID. Required if destinationtype is s3 and s3authentication_type is 'accesskey'.
    s3AuthenticationType String
    What type of authentication to use for S3. Required if destination_type is 's3'. Tailscale recommends using 'rolearn'.
    s3Bucket String
    The S3 bucket name. Required if destination_type is 's3'.
    s3ExternalId String
    The AWS External ID that Tailscale supplies when authenticating using role-based authentication. Required if destinationtype is 's3' and s3authenticationtype is 'rolearn'. This can be obtained via the tailscaleawsexternalid resource.
    s3KeyPrefix String
    An optional S3 key prefix to prepend to the auto-generated S3 key name.
    s3Region String
    The region in which the S3 bucket is located. Required if destination_type is 's3'.
    s3RoleArn String
    ARN of the AWS IAM role that Tailscale should assume when using role-based authentication. Required if destinationtype is 's3' and s3authentication_type is 'rolearn'.
    s3SecretAccessKey String
    The S3 secret access key. Required if destinationtype is 's3' and s3authentication_type is 'accesskey'.
    token String
    The token/password with which log streams to this endpoint should be authenticated, required unless destination_type is 's3'.
    url String
    The URL to which log streams are being posted. If destination_type is 's3' and you want to use the official Amazon S3 endpoint, leave this empty.
    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.18.0 published on Thursday, Feb 27, 2025 by Pulumi
    pulumi/pulumi-tailscale