Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Sumologic Provider
  3. API Docs
  4. KinesisLogSource
Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi
pulumi/pulumi-sumologic

sumologic.KinesisLogSource

Explore with Pulumi AI

sumologic logo
Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi
pulumi/pulumi-sumologic

    Provides a Sumologic Kinesis Log source. This source is used to ingest log via Kinesis Firehose from AWS.

    IMPORTANT: The AWS credentials are stored in plain-text in the state. This is a potential security issue.

    Example Usage

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

const collector = new sumologic.Collector("collector", {
    name: "my-collector",
    description: "Just testing this",
});
const kinesisLogAccessKey = new sumologic.KinesisLogSource("kinesis_log_access_key", {
    name: "Kinesis Log",
    description: "Description for Kinesis Log Source",
    category: "prod/kinesis/log",
    contentType: "KinesisLog",
    collectorId: collector.id,
    authentication: {
        type: "S3BucketAuthentication",
        accessKey: "someKey",
        secretKey: "******",
    },
    path: {
        type: "KinesisLogPath",
        bucketName: "testBucket",
        pathExpression: "http-endpoint-failed/*",
        scanInterval: 30000,
    },
});
const kinesisLogRoleArn = new sumologic.KinesisLogSource("kinesis_log_role_arn", {
    name: "Kinesis Log",
    description: "Description for Kinesis Log Source",
    category: "prod/kinesis/log",
    contentType: "KinesisLog",
    collectorId: collector.id,
    authentication: {
        type: "AWSRoleBasedAuthentication",
        roleArn: "arn:aws:iam::604066827510:role/cw-role-SumoRole-4AOLS73TGKYI",
    },
    path: {
        type: "KinesisLogPath",
        bucketName: "testBucket",
        pathExpression: "http-endpoint-failed/*",
        scanInterval: 30000,
    },
});

    import pulumi
import pulumi_sumologic as sumologic

collector = sumologic.Collector("collector",
    name="my-collector",
    description="Just testing this")
kinesis_log_access_key = sumologic.KinesisLogSource("kinesis_log_access_key",
    name="Kinesis Log",
    description="Description for Kinesis Log Source",
    category="prod/kinesis/log",
    content_type="KinesisLog",
    collector_id=collector.id,
    authentication={
        "type": "S3BucketAuthentication",
        "access_key": "someKey",
        "secret_key": "******",
    },
    path={
        "type": "KinesisLogPath",
        "bucket_name": "testBucket",
        "path_expression": "http-endpoint-failed/*",
        "scan_interval": 30000,
    })
kinesis_log_role_arn = sumologic.KinesisLogSource("kinesis_log_role_arn",
    name="Kinesis Log",
    description="Description for Kinesis Log Source",
    category="prod/kinesis/log",
    content_type="KinesisLog",
    collector_id=collector.id,
    authentication={
        "type": "AWSRoleBasedAuthentication",
        "role_arn": "arn:aws:iam::604066827510:role/cw-role-SumoRole-4AOLS73TGKYI",
    },
    path={
        "type": "KinesisLogPath",
        "bucket_name": "testBucket",
        "path_expression": "http-endpoint-failed/*",
        "scan_interval": 30000,
    })

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		collector, err := sumologic.NewCollector(ctx, "collector", &sumologic.CollectorArgs{
			Name:        pulumi.String("my-collector"),
			Description: pulumi.String("Just testing this"),
		})
		if err != nil {
			return err
		}
		_, err = sumologic.NewKinesisLogSource(ctx, "kinesis_log_access_key", &sumologic.KinesisLogSourceArgs{
			Name:        pulumi.String("Kinesis Log"),
			Description: pulumi.String("Description for Kinesis Log Source"),
			Category:    pulumi.String("prod/kinesis/log"),
			ContentType: pulumi.String("KinesisLog"),
			CollectorId: collector.ID(),
			Authentication: &sumologic.KinesisLogSourceAuthenticationArgs{
				Type:      pulumi.String("S3BucketAuthentication"),
				AccessKey: pulumi.String("someKey"),
				SecretKey: pulumi.String("******"),
			},
			Path: &sumologic.KinesisLogSourcePathArgs{
				Type:           pulumi.String("KinesisLogPath"),
				BucketName:     pulumi.String("testBucket"),
				PathExpression: pulumi.String("http-endpoint-failed/*"),
				ScanInterval:   pulumi.Int(30000),
			},
		})
		if err != nil {
			return err
		}
		_, err = sumologic.NewKinesisLogSource(ctx, "kinesis_log_role_arn", &sumologic.KinesisLogSourceArgs{
			Name:        pulumi.String("Kinesis Log"),
			Description: pulumi.String("Description for Kinesis Log Source"),
			Category:    pulumi.String("prod/kinesis/log"),
			ContentType: pulumi.String("KinesisLog"),
			CollectorId: collector.ID(),
			Authentication: &sumologic.KinesisLogSourceAuthenticationArgs{
				Type:    pulumi.String("AWSRoleBasedAuthentication"),
				RoleArn: pulumi.String("arn:aws:iam::604066827510:role/cw-role-SumoRole-4AOLS73TGKYI"),
			},
			Path: &sumologic.KinesisLogSourcePathArgs{
				Type:           pulumi.String("KinesisLogPath"),
				BucketName:     pulumi.String("testBucket"),
				PathExpression: pulumi.String("http-endpoint-failed/*"),
				ScanInterval:   pulumi.Int(30000),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var collector = new SumoLogic.Collector("collector", new()
    {
        Name = "my-collector",
        Description = "Just testing this",
    });

    var kinesisLogAccessKey = new SumoLogic.KinesisLogSource("kinesis_log_access_key", new()
    {
        Name = "Kinesis Log",
        Description = "Description for Kinesis Log Source",
        Category = "prod/kinesis/log",
        ContentType = "KinesisLog",
        CollectorId = collector.Id,
        Authentication = new SumoLogic.Inputs.KinesisLogSourceAuthenticationArgs
        {
            Type = "S3BucketAuthentication",
            AccessKey = "someKey",
            SecretKey = "******",
        },
        Path = new SumoLogic.Inputs.KinesisLogSourcePathArgs
        {
            Type = "KinesisLogPath",
            BucketName = "testBucket",
            PathExpression = "http-endpoint-failed/*",
            ScanInterval = 30000,
        },
    });

    var kinesisLogRoleArn = new SumoLogic.KinesisLogSource("kinesis_log_role_arn", new()
    {
        Name = "Kinesis Log",
        Description = "Description for Kinesis Log Source",
        Category = "prod/kinesis/log",
        ContentType = "KinesisLog",
        CollectorId = collector.Id,
        Authentication = new SumoLogic.Inputs.KinesisLogSourceAuthenticationArgs
        {
            Type = "AWSRoleBasedAuthentication",
            RoleArn = "arn:aws:iam::604066827510:role/cw-role-SumoRole-4AOLS73TGKYI",
        },
        Path = new SumoLogic.Inputs.KinesisLogSourcePathArgs
        {
            Type = "KinesisLogPath",
            BucketName = "testBucket",
            PathExpression = "http-endpoint-failed/*",
            ScanInterval = 30000,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sumologic.Collector;
import com.pulumi.sumologic.CollectorArgs;
import com.pulumi.sumologic.KinesisLogSource;
import com.pulumi.sumologic.KinesisLogSourceArgs;
import com.pulumi.sumologic.inputs.KinesisLogSourceAuthenticationArgs;
import com.pulumi.sumologic.inputs.KinesisLogSourcePathArgs;
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 collector = new Collector("collector", CollectorArgs.builder()
            .name("my-collector")
            .description("Just testing this")
            .build());

        var kinesisLogAccessKey = new KinesisLogSource("kinesisLogAccessKey", KinesisLogSourceArgs.builder()
            .name("Kinesis Log")
            .description("Description for Kinesis Log Source")
            .category("prod/kinesis/log")
            .contentType("KinesisLog")
            .collectorId(collector.id())
            .authentication(KinesisLogSourceAuthenticationArgs.builder()
                .type("S3BucketAuthentication")
                .accessKey("someKey")
                .secretKey("******")
                .build())
            .path(KinesisLogSourcePathArgs.builder()
                .type("KinesisLogPath")
                .bucketName("testBucket")
                .pathExpression("http-endpoint-failed/*")
                .scanInterval(30000)
                .build())
            .build());

        var kinesisLogRoleArn = new KinesisLogSource("kinesisLogRoleArn", KinesisLogSourceArgs.builder()
            .name("Kinesis Log")
            .description("Description for Kinesis Log Source")
            .category("prod/kinesis/log")
            .contentType("KinesisLog")
            .collectorId(collector.id())
            .authentication(KinesisLogSourceAuthenticationArgs.builder()
                .type("AWSRoleBasedAuthentication")
                .roleArn("arn:aws:iam::604066827510:role/cw-role-SumoRole-4AOLS73TGKYI")
                .build())
            .path(KinesisLogSourcePathArgs.builder()
                .type("KinesisLogPath")
                .bucketName("testBucket")
                .pathExpression("http-endpoint-failed/*")
                .scanInterval(30000)
                .build())
            .build());

    }
}

    resources:
  kinesisLogAccessKey:
    type: sumologic:KinesisLogSource
    name: kinesis_log_access_key
    properties:
      name: Kinesis Log
      description: Description for Kinesis Log Source
      category: prod/kinesis/log
      contentType: KinesisLog
      collectorId: ${collector.id}
      authentication:
        type: S3BucketAuthentication
        accessKey: someKey
        secretKey: '******'
      path:
        type: KinesisLogPath
        bucketName: testBucket
        pathExpression: http-endpoint-failed/*
        scanInterval: 30000
  kinesisLogRoleArn:
    type: sumologic:KinesisLogSource
    name: kinesis_log_role_arn
    properties:
      name: Kinesis Log
      description: Description for Kinesis Log Source
      category: prod/kinesis/log
      contentType: KinesisLog
      collectorId: ${collector.id}
      authentication:
        type: AWSRoleBasedAuthentication
        roleArn: arn:aws:iam::604066827510:role/cw-role-SumoRole-4AOLS73TGKYI
      path:
        type: KinesisLogPath
        bucketName: testBucket
        pathExpression: http-endpoint-failed/*
        scanInterval: 30000
  collector:
    type: sumologic:Collector
    properties:
      name: my-collector
      description: Just testing this

    Create KinesisLogSource Resource

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

    Constructor syntax

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

@overload
def KinesisLogSource(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     collector_id: Optional[int] = None,
                     content_type: Optional[str] = None,
                     filters: Optional[Sequence[KinesisLogSourceFilterArgs]] = None,
                     force_timezone: Optional[bool] = None,
                     automatic_date_parsing: Optional[bool] = None,
                     cutoff_relative_time: Optional[str] = None,
                     cutoff_timestamp: Optional[int] = None,
                     default_date_formats: Optional[Sequence[KinesisLogSourceDefaultDateFormatArgs]] = None,
                     description: Optional[str] = None,
                     fields: Optional[Mapping[str, str]] = None,
                     authentication: Optional[KinesisLogSourceAuthenticationArgs] = None,
                     category: Optional[str] = None,
                     hash_algorithm: Optional[str] = None,
                     host_name: Optional[str] = None,
                     manual_prefix_regexp: Optional[str] = None,
                     message_per_request: Optional[bool] = None,
                     multiline_processing_enabled: Optional[bool] = None,
                     name: Optional[str] = None,
                     path: Optional[KinesisLogSourcePathArgs] = None,
                     timezone: Optional[str] = None,
                     use_autoline_matching: Optional[bool] = None)
    func NewKinesisLogSource(ctx *Context, name string, args KinesisLogSourceArgs, opts ...ResourceOption) (*KinesisLogSource, error)
    public KinesisLogSource(string name, KinesisLogSourceArgs args, CustomResourceOptions? opts = null)
    public KinesisLogSource(String name, KinesisLogSourceArgs args)
public KinesisLogSource(String name, KinesisLogSourceArgs args, CustomResourceOptions options)

    type: sumologic:KinesisLogSource
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 KinesisLogSourceArgs
    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 KinesisLogSourceArgs
    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 KinesisLogSourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KinesisLogSourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KinesisLogSourceArgs
    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 kinesisLogSourceResource = new SumoLogic.KinesisLogSource("kinesisLogSourceResource", new()
{
    CollectorId = 0,
    ContentType = "string",
    Filters = new[]
    {
        new SumoLogic.Inputs.KinesisLogSourceFilterArgs
        {
            FilterType = "string",
            Name = "string",
            Regexp = "string",
            Mask = "string",
        },
    },
    ForceTimezone = false,
    AutomaticDateParsing = false,
    CutoffRelativeTime = "string",
    CutoffTimestamp = 0,
    DefaultDateFormats = new[]
    {
        new SumoLogic.Inputs.KinesisLogSourceDefaultDateFormatArgs
        {
            Format = "string",
            Locator = "string",
        },
    },
    Description = "string",
    Fields = 
    {
        { "string", "string" },
    },
    Authentication = new SumoLogic.Inputs.KinesisLogSourceAuthenticationArgs
    {
        AccessKey = "string",
        RoleArn = "string",
        SecretKey = "string",
        Type = "string",
    },
    Category = "string",
    HashAlgorithm = "string",
    HostName = "string",
    ManualPrefixRegexp = "string",
    MessagePerRequest = false,
    MultilineProcessingEnabled = false,
    Name = "string",
    Path = new SumoLogic.Inputs.KinesisLogSourcePathArgs
    {
        BucketName = "string",
        PathExpression = "string",
        ScanInterval = 0,
        Type = "string",
    },
    Timezone = "string",
    UseAutolineMatching = false,
});

    example, err := sumologic.NewKinesisLogSource(ctx, "kinesisLogSourceResource", &sumologic.KinesisLogSourceArgs{
	CollectorId: pulumi.Int(0),
	ContentType: pulumi.String("string"),
	Filters: sumologic.KinesisLogSourceFilterArray{
		&sumologic.KinesisLogSourceFilterArgs{
			FilterType: pulumi.String("string"),
			Name:       pulumi.String("string"),
			Regexp:     pulumi.String("string"),
			Mask:       pulumi.String("string"),
		},
	},
	ForceTimezone:        pulumi.Bool(false),
	AutomaticDateParsing: pulumi.Bool(false),
	CutoffRelativeTime:   pulumi.String("string"),
	CutoffTimestamp:      pulumi.Int(0),
	DefaultDateFormats: sumologic.KinesisLogSourceDefaultDateFormatArray{
		&sumologic.KinesisLogSourceDefaultDateFormatArgs{
			Format:  pulumi.String("string"),
			Locator: pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Fields: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Authentication: &sumologic.KinesisLogSourceAuthenticationArgs{
		AccessKey: pulumi.String("string"),
		RoleArn:   pulumi.String("string"),
		SecretKey: pulumi.String("string"),
		Type:      pulumi.String("string"),
	},
	Category:                   pulumi.String("string"),
	HashAlgorithm:              pulumi.String("string"),
	HostName:                   pulumi.String("string"),
	ManualPrefixRegexp:         pulumi.String("string"),
	MessagePerRequest:          pulumi.Bool(false),
	MultilineProcessingEnabled: pulumi.Bool(false),
	Name:                       pulumi.String("string"),
	Path: &sumologic.KinesisLogSourcePathArgs{
		BucketName:     pulumi.String("string"),
		PathExpression: pulumi.String("string"),
		ScanInterval:   pulumi.Int(0),
		Type:           pulumi.String("string"),
	},
	Timezone:            pulumi.String("string"),
	UseAutolineMatching: pulumi.Bool(false),
})

    var kinesisLogSourceResource = new KinesisLogSource("kinesisLogSourceResource", KinesisLogSourceArgs.builder()
    .collectorId(0)
    .contentType("string")
    .filters(KinesisLogSourceFilterArgs.builder()
        .filterType("string")
        .name("string")
        .regexp("string")
        .mask("string")
        .build())
    .forceTimezone(false)
    .automaticDateParsing(false)
    .cutoffRelativeTime("string")
    .cutoffTimestamp(0)
    .defaultDateFormats(KinesisLogSourceDefaultDateFormatArgs.builder()
        .format("string")
        .locator("string")
        .build())
    .description("string")
    .fields(Map.of("string", "string"))
    .authentication(KinesisLogSourceAuthenticationArgs.builder()
        .accessKey("string")
        .roleArn("string")
        .secretKey("string")
        .type("string")
        .build())
    .category("string")
    .hashAlgorithm("string")
    .hostName("string")
    .manualPrefixRegexp("string")
    .messagePerRequest(false)
    .multilineProcessingEnabled(false)
    .name("string")
    .path(KinesisLogSourcePathArgs.builder()
        .bucketName("string")
        .pathExpression("string")
        .scanInterval(0)
        .type("string")
        .build())
    .timezone("string")
    .useAutolineMatching(false)
    .build());

    kinesis_log_source_resource = sumologic.KinesisLogSource("kinesisLogSourceResource",
    collector_id=0,
    content_type="string",
    filters=[{
        "filter_type": "string",
        "name": "string",
        "regexp": "string",
        "mask": "string",
    }],
    force_timezone=False,
    automatic_date_parsing=False,
    cutoff_relative_time="string",
    cutoff_timestamp=0,
    default_date_formats=[{
        "format": "string",
        "locator": "string",
    }],
    description="string",
    fields={
        "string": "string",
    },
    authentication={
        "access_key": "string",
        "role_arn": "string",
        "secret_key": "string",
        "type": "string",
    },
    category="string",
    hash_algorithm="string",
    host_name="string",
    manual_prefix_regexp="string",
    message_per_request=False,
    multiline_processing_enabled=False,
    name="string",
    path={
        "bucket_name": "string",
        "path_expression": "string",
        "scan_interval": 0,
        "type": "string",
    },
    timezone="string",
    use_autoline_matching=False)

    const kinesisLogSourceResource = new sumologic.KinesisLogSource("kinesisLogSourceResource", {
    collectorId: 0,
    contentType: "string",
    filters: [{
        filterType: "string",
        name: "string",
        regexp: "string",
        mask: "string",
    }],
    forceTimezone: false,
    automaticDateParsing: false,
    cutoffRelativeTime: "string",
    cutoffTimestamp: 0,
    defaultDateFormats: [{
        format: "string",
        locator: "string",
    }],
    description: "string",
    fields: {
        string: "string",
    },
    authentication: {
        accessKey: "string",
        roleArn: "string",
        secretKey: "string",
        type: "string",
    },
    category: "string",
    hashAlgorithm: "string",
    hostName: "string",
    manualPrefixRegexp: "string",
    messagePerRequest: false,
    multilineProcessingEnabled: false,
    name: "string",
    path: {
        bucketName: "string",
        pathExpression: "string",
        scanInterval: 0,
        type: "string",
    },
    timezone: "string",
    useAutolineMatching: false,
});

    type: sumologic:KinesisLogSource
properties:
    authentication:
        accessKey: string
        roleArn: string
        secretKey: string
        type: string
    automaticDateParsing: false
    category: string
    collectorId: 0
    contentType: string
    cutoffRelativeTime: string
    cutoffTimestamp: 0
    defaultDateFormats:
        - format: string
          locator: string
    description: string
    fields:
        string: string
    filters:
        - filterType: string
          mask: string
          name: string
          regexp: string
    forceTimezone: false
    hashAlgorithm: string
    hostName: string
    manualPrefixRegexp: string
    messagePerRequest: false
    multilineProcessingEnabled: false
    name: string
    path:
        bucketName: string
        pathExpression: string
        scanInterval: 0
        type: string
    timezone: string
    useAutolineMatching: false

    KinesisLogSource 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 KinesisLogSource resource accepts the following input properties:

    CollectorId int
    ContentType string
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    Authentication Pulumi.SumoLogic.Inputs.KinesisLogSourceAuthentication
    Authentication details for connecting to the S3 bucket.
    AutomaticDateParsing bool
    Category string
    CutoffRelativeTime string
    CutoffTimestamp int
    DefaultDateFormats List<Pulumi.SumoLogic.Inputs.KinesisLogSourceDefaultDateFormat>
    Description string
    Fields Dictionary<string, string>
    Filters List<Pulumi.SumoLogic.Inputs.KinesisLogSourceFilter>
    ForceTimezone bool
    HashAlgorithm string
    HostName string
    ManualPrefixRegexp string
    MessagePerRequest bool
    MultilineProcessingEnabled bool
    Name string
    Path Pulumi.SumoLogic.Inputs.KinesisLogSourcePath
    The location of S3 bucket for failed Kinesis log data.
    Timezone string
    UseAutolineMatching bool
    CollectorId int
    ContentType string
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    Authentication KinesisLogSourceAuthenticationArgs
    Authentication details for connecting to the S3 bucket.
    AutomaticDateParsing bool
    Category string
    CutoffRelativeTime string
    CutoffTimestamp int
    DefaultDateFormats []KinesisLogSourceDefaultDateFormatArgs
    Description string
    Fields map[string]string
    Filters []KinesisLogSourceFilterArgs
    ForceTimezone bool
    HashAlgorithm string
    HostName string
    ManualPrefixRegexp string
    MessagePerRequest bool
    MultilineProcessingEnabled bool
    Name string
    Path KinesisLogSourcePathArgs
    The location of S3 bucket for failed Kinesis log data.
    Timezone string
    UseAutolineMatching bool
    collectorId Integer
    contentType String
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    authentication KinesisLogSourceAuthentication
    Authentication details for connecting to the S3 bucket.
    automaticDateParsing Boolean
    category String
    cutoffRelativeTime String
    cutoffTimestamp Integer
    defaultDateFormats List<KinesisLogSourceDefaultDateFormat>
    description String
    fields Map<String,String>
    filters List<KinesisLogSourceFilter>
    forceTimezone Boolean
    hashAlgorithm String
    hostName String
    manualPrefixRegexp String
    messagePerRequest Boolean
    multilineProcessingEnabled Boolean
    name String
    path KinesisLogSourcePath
    The location of S3 bucket for failed Kinesis log data.
    timezone String
    useAutolineMatching Boolean
    collectorId number
    contentType string
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    authentication KinesisLogSourceAuthentication
    Authentication details for connecting to the S3 bucket.
    automaticDateParsing boolean
    category string
    cutoffRelativeTime string
    cutoffTimestamp number
    defaultDateFormats KinesisLogSourceDefaultDateFormat[]
    description string
    fields {[key: string]: string}
    filters KinesisLogSourceFilter[]
    forceTimezone boolean
    hashAlgorithm string
    hostName string
    manualPrefixRegexp string
    messagePerRequest boolean
    multilineProcessingEnabled boolean
    name string
    path KinesisLogSourcePath
    The location of S3 bucket for failed Kinesis log data.
    timezone string
    useAutolineMatching boolean
    collectorId Number
    contentType String
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    authentication Property Map
    Authentication details for connecting to the S3 bucket.
    automaticDateParsing Boolean
    category String
    cutoffRelativeTime String
    cutoffTimestamp Number
    defaultDateFormats List<Property Map>
    description String
    fields Map<String>
    filters List<Property Map>
    forceTimezone Boolean
    hashAlgorithm String
    hostName String
    manualPrefixRegexp String
    messagePerRequest Boolean
    multilineProcessingEnabled Boolean
    name String
    path Property Map
    The location of S3 bucket for failed Kinesis log data.
    timezone String
    useAutolineMatching Boolean

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    The HTTP endpoint to be used while creating Kinesis Firehose on AWS.
    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    The HTTP endpoint to be used while creating Kinesis Firehose on AWS.
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    The HTTP endpoint to be used while creating Kinesis Firehose on AWS.
    id string
    The provider-assigned unique ID for this managed resource.
    url string
    The HTTP endpoint to be used while creating Kinesis Firehose on AWS.
    id str
    The provider-assigned unique ID for this managed resource.
    url str
    The HTTP endpoint to be used while creating Kinesis Firehose on AWS.
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    The HTTP endpoint to be used while creating Kinesis Firehose on AWS.

    Look up Existing KinesisLogSource Resource

    Get an existing KinesisLogSource 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?: KinesisLogSourceState, opts?: CustomResourceOptions): KinesisLogSource
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication: Optional[KinesisLogSourceAuthenticationArgs] = None,
        automatic_date_parsing: Optional[bool] = None,
        category: Optional[str] = None,
        collector_id: Optional[int] = None,
        content_type: Optional[str] = None,
        cutoff_relative_time: Optional[str] = None,
        cutoff_timestamp: Optional[int] = None,
        default_date_formats: Optional[Sequence[KinesisLogSourceDefaultDateFormatArgs]] = None,
        description: Optional[str] = None,
        fields: Optional[Mapping[str, str]] = None,
        filters: Optional[Sequence[KinesisLogSourceFilterArgs]] = None,
        force_timezone: Optional[bool] = None,
        hash_algorithm: Optional[str] = None,
        host_name: Optional[str] = None,
        manual_prefix_regexp: Optional[str] = None,
        message_per_request: Optional[bool] = None,
        multiline_processing_enabled: Optional[bool] = None,
        name: Optional[str] = None,
        path: Optional[KinesisLogSourcePathArgs] = None,
        timezone: Optional[str] = None,
        url: Optional[str] = None,
        use_autoline_matching: Optional[bool] = None) -> KinesisLogSource
    func GetKinesisLogSource(ctx *Context, name string, id IDInput, state *KinesisLogSourceState, opts ...ResourceOption) (*KinesisLogSource, error)
    public static KinesisLogSource Get(string name, Input<string> id, KinesisLogSourceState? state, CustomResourceOptions? opts = null)
    public static KinesisLogSource get(String name, Output<String> id, KinesisLogSourceState 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:
    Authentication Pulumi.SumoLogic.Inputs.KinesisLogSourceAuthentication
    Authentication details for connecting to the S3 bucket.
    AutomaticDateParsing bool
    Category string
    CollectorId int
    ContentType string
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    CutoffRelativeTime string
    CutoffTimestamp int
    DefaultDateFormats List<Pulumi.SumoLogic.Inputs.KinesisLogSourceDefaultDateFormat>
    Description string
    Fields Dictionary<string, string>
    Filters List<Pulumi.SumoLogic.Inputs.KinesisLogSourceFilter>
    ForceTimezone bool
    HashAlgorithm string
    HostName string
    ManualPrefixRegexp string
    MessagePerRequest bool
    MultilineProcessingEnabled bool
    Name string
    Path Pulumi.SumoLogic.Inputs.KinesisLogSourcePath
    The location of S3 bucket for failed Kinesis log data.
    Timezone string
    Url string
    The HTTP endpoint to be used while creating Kinesis Firehose on AWS.
    UseAutolineMatching bool
    Authentication KinesisLogSourceAuthenticationArgs
    Authentication details for connecting to the S3 bucket.
    AutomaticDateParsing bool
    Category string
    CollectorId int
    ContentType string
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    CutoffRelativeTime string
    CutoffTimestamp int
    DefaultDateFormats []KinesisLogSourceDefaultDateFormatArgs
    Description string
    Fields map[string]string
    Filters []KinesisLogSourceFilterArgs
    ForceTimezone bool
    HashAlgorithm string
    HostName string
    ManualPrefixRegexp string
    MessagePerRequest bool
    MultilineProcessingEnabled bool
    Name string
    Path KinesisLogSourcePathArgs
    The location of S3 bucket for failed Kinesis log data.
    Timezone string
    Url string
    The HTTP endpoint to be used while creating Kinesis Firehose on AWS.
    UseAutolineMatching bool
    authentication KinesisLogSourceAuthentication
    Authentication details for connecting to the S3 bucket.
    automaticDateParsing Boolean
    category String
    collectorId Integer
    contentType String
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    cutoffRelativeTime String
    cutoffTimestamp Integer
    defaultDateFormats List<KinesisLogSourceDefaultDateFormat>
    description String
    fields Map<String,String>
    filters List<KinesisLogSourceFilter>
    forceTimezone Boolean
    hashAlgorithm String
    hostName String
    manualPrefixRegexp String
    messagePerRequest Boolean
    multilineProcessingEnabled Boolean
    name String
    path KinesisLogSourcePath
    The location of S3 bucket for failed Kinesis log data.
    timezone String
    url String
    The HTTP endpoint to be used while creating Kinesis Firehose on AWS.
    useAutolineMatching Boolean
    authentication KinesisLogSourceAuthentication
    Authentication details for connecting to the S3 bucket.
    automaticDateParsing boolean
    category string
    collectorId number
    contentType string
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    cutoffRelativeTime string
    cutoffTimestamp number
    defaultDateFormats KinesisLogSourceDefaultDateFormat[]
    description string
    fields {[key: string]: string}
    filters KinesisLogSourceFilter[]
    forceTimezone boolean
    hashAlgorithm string
    hostName string
    manualPrefixRegexp string
    messagePerRequest boolean
    multilineProcessingEnabled boolean
    name string
    path KinesisLogSourcePath
    The location of S3 bucket for failed Kinesis log data.
    timezone string
    url string
    The HTTP endpoint to be used while creating Kinesis Firehose on AWS.
    useAutolineMatching boolean
    authentication KinesisLogSourceAuthenticationArgs
    Authentication details for connecting to the S3 bucket.
    automatic_date_parsing bool
    category str
    collector_id int
    content_type str
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    cutoff_relative_time str
    cutoff_timestamp int
    default_date_formats Sequence[KinesisLogSourceDefaultDateFormatArgs]
    description str
    fields Mapping[str, str]
    filters Sequence[KinesisLogSourceFilterArgs]
    force_timezone bool
    hash_algorithm str
    host_name str
    manual_prefix_regexp str
    message_per_request bool
    multiline_processing_enabled bool
    name str
    path KinesisLogSourcePathArgs
    The location of S3 bucket for failed Kinesis log data.
    timezone str
    url str
    The HTTP endpoint to be used while creating Kinesis Firehose on AWS.
    use_autoline_matching bool
    authentication Property Map
    Authentication details for connecting to the S3 bucket.
    automaticDateParsing Boolean
    category String
    collectorId Number
    contentType String
    The content-type of the collected data. Details can be found in the Sumologic documentation for hosted sources.
    cutoffRelativeTime String
    cutoffTimestamp Number
    defaultDateFormats List<Property Map>
    description String
    fields Map<String>
    filters List<Property Map>
    forceTimezone Boolean
    hashAlgorithm String
    hostName String
    manualPrefixRegexp String
    messagePerRequest Boolean
    multilineProcessingEnabled Boolean
    name String
    path Property Map
    The location of S3 bucket for failed Kinesis log data.
    timezone String
    url String
    The HTTP endpoint to be used while creating Kinesis Firehose on AWS.
    useAutolineMatching Boolean

    Supporting Types

    KinesisLogSourceAuthentication, KinesisLogSourceAuthenticationArgs

    AccessKey string
    Your AWS access key if using type S3BucketAuthentication
    RoleArn string
    Your AWS role ARN if using type AWSRoleBasedAuthentication
    SecretKey string
    Your AWS secret key if using type S3BucketAuthentication
    Type string
    Must be either S3BucketAuthentication or AWSRoleBasedAuthentication or NoAuthentication
    AccessKey string
    Your AWS access key if using type S3BucketAuthentication
    RoleArn string
    Your AWS role ARN if using type AWSRoleBasedAuthentication
    SecretKey string
    Your AWS secret key if using type S3BucketAuthentication
    Type string
    Must be either S3BucketAuthentication or AWSRoleBasedAuthentication or NoAuthentication
    accessKey String
    Your AWS access key if using type S3BucketAuthentication
    roleArn String
    Your AWS role ARN if using type AWSRoleBasedAuthentication
    secretKey String
    Your AWS secret key if using type S3BucketAuthentication
    type String
    Must be either S3BucketAuthentication or AWSRoleBasedAuthentication or NoAuthentication
    accessKey string
    Your AWS access key if using type S3BucketAuthentication
    roleArn string
    Your AWS role ARN if using type AWSRoleBasedAuthentication
    secretKey string
    Your AWS secret key if using type S3BucketAuthentication
    type string
    Must be either S3BucketAuthentication or AWSRoleBasedAuthentication or NoAuthentication
    access_key str
    Your AWS access key if using type S3BucketAuthentication
    role_arn str
    Your AWS role ARN if using type AWSRoleBasedAuthentication
    secret_key str
    Your AWS secret key if using type S3BucketAuthentication
    type str
    Must be either S3BucketAuthentication or AWSRoleBasedAuthentication or NoAuthentication
    accessKey String
    Your AWS access key if using type S3BucketAuthentication
    roleArn String
    Your AWS role ARN if using type AWSRoleBasedAuthentication
    secretKey String
    Your AWS secret key if using type S3BucketAuthentication
    type String
    Must be either S3BucketAuthentication or AWSRoleBasedAuthentication or NoAuthentication

    KinesisLogSourceDefaultDateFormat, KinesisLogSourceDefaultDateFormatArgs

    Format string
    Locator string
    Format string
    Locator string
    format String
    locator String
    format string
    locator string
    format String
    locator String

    KinesisLogSourceFilter, KinesisLogSourceFilterArgs

    FilterType string
    Name string
    Regexp string
    Mask string
    FilterType string
    Name string
    Regexp string
    Mask string
    filterType String
    name String
    regexp String
    mask String
    filterType string
    name string
    regexp string
    mask string
    filterType String
    name String
    regexp String
    mask String

    KinesisLogSourcePath, KinesisLogSourcePathArgs

    BucketName string
    The name of the bucket. This is needed if using type KinesisLogPath.
    PathExpression string
    The path to the data. This is needed if using type KinesisLogPath. For Kinesis log source, it must include http-endpoint-failed/.
    ScanInterval int
    The Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    Type string
    Must be either KinesisLogPath or NoPathExpression
    BucketName string
    The name of the bucket. This is needed if using type KinesisLogPath.
    PathExpression string
    The path to the data. This is needed if using type KinesisLogPath. For Kinesis log source, it must include http-endpoint-failed/.
    ScanInterval int
    The Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    Type string
    Must be either KinesisLogPath or NoPathExpression
    bucketName String
    The name of the bucket. This is needed if using type KinesisLogPath.
    pathExpression String
    The path to the data. This is needed if using type KinesisLogPath. For Kinesis log source, it must include http-endpoint-failed/.
    scanInterval Integer
    The Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    type String
    Must be either KinesisLogPath or NoPathExpression
    bucketName string
    The name of the bucket. This is needed if using type KinesisLogPath.
    pathExpression string
    The path to the data. This is needed if using type KinesisLogPath. For Kinesis log source, it must include http-endpoint-failed/.
    scanInterval number
    The Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    type string
    Must be either KinesisLogPath or NoPathExpression
    bucket_name str
    The name of the bucket. This is needed if using type KinesisLogPath.
    path_expression str
    The path to the data. This is needed if using type KinesisLogPath. For Kinesis log source, it must include http-endpoint-failed/.
    scan_interval int
    The Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    type str
    Must be either KinesisLogPath or NoPathExpression
    bucketName String
    The name of the bucket. This is needed if using type KinesisLogPath.
    pathExpression String
    The path to the data. This is needed if using type KinesisLogPath. For Kinesis log source, it must include http-endpoint-failed/.
    scanInterval Number
    The Time interval in milliseconds of scans for new data. The default is 300000 and the minimum value is 1000 milliseconds.
    type String
    Must be either KinesisLogPath or NoPathExpression

    Import

    Kinesis Log sources can be imported using the collector and source IDs (collector/source), e.g.:

    hcl

    $ pulumi import sumologic:index/kinesisLogSource:KinesisLogSource test 123/456

    HTTP sources can be imported using the collector name and source name (collectorName/sourceName), e.g.:

    hcl

    $ pulumi import sumologic:index/kinesisLogSource:KinesisLogSource test my-test-collector/my-test-source

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

    Package Details

    Repository
    Sumo Logic pulumi/pulumi-sumologic
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sumologic Terraform Provider.
    sumologic logo
    Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi
    pulumi/pulumi-sumologic