1. Packages
  2. Sumologic Provider
  3. API Docs
  4. CloudSyslogSource
Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi

sumologic.CloudSyslogSource

Explore with Pulumi AI

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

    Provides a Sumo Logic Cloud Syslog source.

    IMPORTANT: The token is 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 cloudsyslogSource = new sumologic.CloudSyslogSource("cloudsyslog_source", {
        name: "CLOUDSYSLOG",
        description: "My description",
        category: "my/source/category",
        collectorId: collector.id,
    });
    
    import pulumi
    import pulumi_sumologic as sumologic
    
    collector = sumologic.Collector("collector",
        name="my-collector",
        description="Just testing this")
    cloudsyslog_source = sumologic.CloudSyslogSource("cloudsyslog_source",
        name="CLOUDSYSLOG",
        description="My description",
        category="my/source/category",
        collector_id=collector.id)
    
    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.NewCloudSyslogSource(ctx, "cloudsyslog_source", &sumologic.CloudSyslogSourceArgs{
    			Name:        pulumi.String("CLOUDSYSLOG"),
    			Description: pulumi.String("My description"),
    			Category:    pulumi.String("my/source/category"),
    			CollectorId: collector.ID(),
    		})
    		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 cloudsyslogSource = new SumoLogic.CloudSyslogSource("cloudsyslog_source", new()
        {
            Name = "CLOUDSYSLOG",
            Description = "My description",
            Category = "my/source/category",
            CollectorId = collector.Id,
        });
    
    });
    
    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.CloudSyslogSource;
    import com.pulumi.sumologic.CloudSyslogSourceArgs;
    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 cloudsyslogSource = new CloudSyslogSource("cloudsyslogSource", CloudSyslogSourceArgs.builder()
                .name("CLOUDSYSLOG")
                .description("My description")
                .category("my/source/category")
                .collectorId(collector.id())
                .build());
    
        }
    }
    
    resources:
      cloudsyslogSource:
        type: sumologic:CloudSyslogSource
        name: cloudsyslog_source
        properties:
          name: CLOUDSYSLOG
          description: My description
          category: my/source/category
          collectorId: ${collector.id}
      collector:
        type: sumologic:Collector
        properties:
          name: my-collector
          description: Just testing this
    

    Attributes reference

    The following attributes are exported:

    • id - The internal ID of the source.
    • token - The token to use for sending data to this source.

    Create CloudSyslogSource Resource

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

    Constructor syntax

    new CloudSyslogSource(name: string, args: CloudSyslogSourceArgs, opts?: CustomResourceOptions);
    @overload
    def CloudSyslogSource(resource_name: str,
                          args: CloudSyslogSourceArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def CloudSyslogSource(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          collector_id: Optional[int] = None,
                          fields: Optional[Mapping[str, str]] = None,
                          cutoff_timestamp: Optional[int] = None,
                          filters: Optional[Sequence[CloudSyslogSourceFilterArgs]] = None,
                          cutoff_relative_time: Optional[str] = None,
                          force_timezone: Optional[bool] = None,
                          default_date_formats: Optional[Sequence[CloudSyslogSourceDefaultDateFormatArgs]] = None,
                          description: Optional[str] = None,
                          hash_algorithm: Optional[str] = None,
                          content_type: Optional[str] = None,
                          category: Optional[str] = None,
                          automatic_date_parsing: Optional[bool] = None,
                          host_name: Optional[str] = None,
                          manual_prefix_regexp: Optional[str] = None,
                          multiline_processing_enabled: Optional[bool] = None,
                          name: Optional[str] = None,
                          timezone: Optional[str] = None,
                          use_autoline_matching: Optional[bool] = None)
    func NewCloudSyslogSource(ctx *Context, name string, args CloudSyslogSourceArgs, opts ...ResourceOption) (*CloudSyslogSource, error)
    public CloudSyslogSource(string name, CloudSyslogSourceArgs args, CustomResourceOptions? opts = null)
    public CloudSyslogSource(String name, CloudSyslogSourceArgs args)
    public CloudSyslogSource(String name, CloudSyslogSourceArgs args, CustomResourceOptions options)
    
    type: sumologic:CloudSyslogSource
    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 CloudSyslogSourceArgs
    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 CloudSyslogSourceArgs
    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 CloudSyslogSourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudSyslogSourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudSyslogSourceArgs
    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 cloudSyslogSourceResource = new SumoLogic.CloudSyslogSource("cloudSyslogSourceResource", new()
    {
        CollectorId = 0,
        Fields = 
        {
            { "string", "string" },
        },
        CutoffTimestamp = 0,
        Filters = new[]
        {
            new SumoLogic.Inputs.CloudSyslogSourceFilterArgs
            {
                FilterType = "string",
                Name = "string",
                Regexp = "string",
                Mask = "string",
            },
        },
        CutoffRelativeTime = "string",
        ForceTimezone = false,
        DefaultDateFormats = new[]
        {
            new SumoLogic.Inputs.CloudSyslogSourceDefaultDateFormatArgs
            {
                Format = "string",
                Locator = "string",
            },
        },
        Description = "string",
        HashAlgorithm = "string",
        ContentType = "string",
        Category = "string",
        AutomaticDateParsing = false,
        HostName = "string",
        ManualPrefixRegexp = "string",
        MultilineProcessingEnabled = false,
        Name = "string",
        Timezone = "string",
        UseAutolineMatching = false,
    });
    
    example, err := sumologic.NewCloudSyslogSource(ctx, "cloudSyslogSourceResource", &sumologic.CloudSyslogSourceArgs{
    	CollectorId: pulumi.Int(0),
    	Fields: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	CutoffTimestamp: pulumi.Int(0),
    	Filters: sumologic.CloudSyslogSourceFilterArray{
    		&sumologic.CloudSyslogSourceFilterArgs{
    			FilterType: pulumi.String("string"),
    			Name:       pulumi.String("string"),
    			Regexp:     pulumi.String("string"),
    			Mask:       pulumi.String("string"),
    		},
    	},
    	CutoffRelativeTime: pulumi.String("string"),
    	ForceTimezone:      pulumi.Bool(false),
    	DefaultDateFormats: sumologic.CloudSyslogSourceDefaultDateFormatArray{
    		&sumologic.CloudSyslogSourceDefaultDateFormatArgs{
    			Format:  pulumi.String("string"),
    			Locator: pulumi.String("string"),
    		},
    	},
    	Description:                pulumi.String("string"),
    	HashAlgorithm:              pulumi.String("string"),
    	ContentType:                pulumi.String("string"),
    	Category:                   pulumi.String("string"),
    	AutomaticDateParsing:       pulumi.Bool(false),
    	HostName:                   pulumi.String("string"),
    	ManualPrefixRegexp:         pulumi.String("string"),
    	MultilineProcessingEnabled: pulumi.Bool(false),
    	Name:                       pulumi.String("string"),
    	Timezone:                   pulumi.String("string"),
    	UseAutolineMatching:        pulumi.Bool(false),
    })
    
    var cloudSyslogSourceResource = new CloudSyslogSource("cloudSyslogSourceResource", CloudSyslogSourceArgs.builder()
        .collectorId(0)
        .fields(Map.of("string", "string"))
        .cutoffTimestamp(0)
        .filters(CloudSyslogSourceFilterArgs.builder()
            .filterType("string")
            .name("string")
            .regexp("string")
            .mask("string")
            .build())
        .cutoffRelativeTime("string")
        .forceTimezone(false)
        .defaultDateFormats(CloudSyslogSourceDefaultDateFormatArgs.builder()
            .format("string")
            .locator("string")
            .build())
        .description("string")
        .hashAlgorithm("string")
        .contentType("string")
        .category("string")
        .automaticDateParsing(false)
        .hostName("string")
        .manualPrefixRegexp("string")
        .multilineProcessingEnabled(false)
        .name("string")
        .timezone("string")
        .useAutolineMatching(false)
        .build());
    
    cloud_syslog_source_resource = sumologic.CloudSyslogSource("cloudSyslogSourceResource",
        collector_id=0,
        fields={
            "string": "string",
        },
        cutoff_timestamp=0,
        filters=[{
            "filter_type": "string",
            "name": "string",
            "regexp": "string",
            "mask": "string",
        }],
        cutoff_relative_time="string",
        force_timezone=False,
        default_date_formats=[{
            "format": "string",
            "locator": "string",
        }],
        description="string",
        hash_algorithm="string",
        content_type="string",
        category="string",
        automatic_date_parsing=False,
        host_name="string",
        manual_prefix_regexp="string",
        multiline_processing_enabled=False,
        name="string",
        timezone="string",
        use_autoline_matching=False)
    
    const cloudSyslogSourceResource = new sumologic.CloudSyslogSource("cloudSyslogSourceResource", {
        collectorId: 0,
        fields: {
            string: "string",
        },
        cutoffTimestamp: 0,
        filters: [{
            filterType: "string",
            name: "string",
            regexp: "string",
            mask: "string",
        }],
        cutoffRelativeTime: "string",
        forceTimezone: false,
        defaultDateFormats: [{
            format: "string",
            locator: "string",
        }],
        description: "string",
        hashAlgorithm: "string",
        contentType: "string",
        category: "string",
        automaticDateParsing: false,
        hostName: "string",
        manualPrefixRegexp: "string",
        multilineProcessingEnabled: false,
        name: "string",
        timezone: "string",
        useAutolineMatching: false,
    });
    
    type: sumologic:CloudSyslogSource
    properties:
        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
        multilineProcessingEnabled: false
        name: string
        timezone: string
        useAutolineMatching: false
    

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

    Outputs

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

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

    Look up Existing CloudSyslogSource Resource

    Get an existing CloudSyslogSource 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?: CloudSyslogSourceState, opts?: CustomResourceOptions): CloudSyslogSource
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = 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[CloudSyslogSourceDefaultDateFormatArgs]] = None,
            description: Optional[str] = None,
            fields: Optional[Mapping[str, str]] = None,
            filters: Optional[Sequence[CloudSyslogSourceFilterArgs]] = None,
            force_timezone: Optional[bool] = None,
            hash_algorithm: Optional[str] = None,
            host_name: Optional[str] = None,
            manual_prefix_regexp: Optional[str] = None,
            multiline_processing_enabled: Optional[bool] = None,
            name: Optional[str] = None,
            timezone: Optional[str] = None,
            token: Optional[str] = None,
            use_autoline_matching: Optional[bool] = None) -> CloudSyslogSource
    func GetCloudSyslogSource(ctx *Context, name string, id IDInput, state *CloudSyslogSourceState, opts ...ResourceOption) (*CloudSyslogSource, error)
    public static CloudSyslogSource Get(string name, Input<string> id, CloudSyslogSourceState? state, CustomResourceOptions? opts = null)
    public static CloudSyslogSource get(String name, Output<String> id, CloudSyslogSourceState 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:

    Supporting Types

    CloudSyslogSourceDefaultDateFormat, CloudSyslogSourceDefaultDateFormatArgs

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

    CloudSyslogSourceFilter, CloudSyslogSourceFilterArgs

    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

    Import

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

    hcl

    $ pulumi import sumologic:index/cloudSyslogSource:CloudSyslogSource test 123/456
    

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

    hcl

    $ pulumi import sumologic:index/cloudSyslogSource:CloudSyslogSource 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