Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Sumo Logic
  3. API Docs
  4. DataForwardingRule
Sumo Logic v0.23.4 published on Friday, Sep 20, 2024 by Pulumi
pulumi/pulumi-sumologic

sumologic.DataForwardingRule

Explore with Pulumi AI

sumologic logo
Sumo Logic v0.23.4 published on Friday, Sep 20, 2024 by Pulumi
pulumi/pulumi-sumologic

    Provider to manage Sumologic Data Forwarding Rule

    Example Usage

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

const exampleDataForwardingRule = new sumologic.DataForwardingRule("example_data_forwarding_rule", {
    indexId: "00000000024C6155",
    destinationId: "00000000000732AA",
    enabled: true,
    fileFormat: "test/{index}/{day}/{hour}/{minute}",
    payloadSchema: "builtInFields",
    format: "json",
});

    import pulumi
import pulumi_sumologic as sumologic

example_data_forwarding_rule = sumologic.DataForwardingRule("example_data_forwarding_rule",
    index_id="00000000024C6155",
    destination_id="00000000000732AA",
    enabled=True,
    file_format="test/{index}/{day}/{hour}/{minute}",
    payload_schema="builtInFields",
    format="json")

    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 {
		_, err := sumologic.NewDataForwardingRule(ctx, "example_data_forwarding_rule", &sumologic.DataForwardingRuleArgs{
			IndexId:       pulumi.String("00000000024C6155"),
			DestinationId: pulumi.String("00000000000732AA"),
			Enabled:       pulumi.Bool(true),
			FileFormat:    pulumi.String("test/{index}/{day}/{hour}/{minute}"),
			PayloadSchema: pulumi.String("builtInFields"),
			Format:        pulumi.String("json"),
		})
		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 exampleDataForwardingRule = new SumoLogic.DataForwardingRule("example_data_forwarding_rule", new()
    {
        IndexId = "00000000024C6155",
        DestinationId = "00000000000732AA",
        Enabled = true,
        FileFormat = "test/{index}/{day}/{hour}/{minute}",
        PayloadSchema = "builtInFields",
        Format = "json",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sumologic.DataForwardingRule;
import com.pulumi.sumologic.DataForwardingRuleArgs;
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 exampleDataForwardingRule = new DataForwardingRule("exampleDataForwardingRule", DataForwardingRuleArgs.builder()
            .indexId("00000000024C6155")
            .destinationId("00000000000732AA")
            .enabled("true")
            .fileFormat("test/{index}/{day}/{hour}/{minute}")
            .payloadSchema("builtInFields")
            .format("json")
            .build());

    }
}

    resources:
  exampleDataForwardingRule:
    type: sumologic:DataForwardingRule
    name: example_data_forwarding_rule
    properties:
      indexId: 00000000024C6155
      destinationId: 00000000000732AA
      enabled: 'true'
      fileFormat: test/{index}/{day}/{hour}/{minute}
      payloadSchema: builtInFields
      format: json

    Create DataForwardingRule Resource

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

    Constructor syntax

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

@overload
def DataForwardingRule(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       destination_id: Optional[str] = None,
                       index_id: Optional[str] = None,
                       enabled: Optional[bool] = None,
                       file_format: Optional[str] = None,
                       format: Optional[str] = None,
                       payload_schema: Optional[str] = None)
    func NewDataForwardingRule(ctx *Context, name string, args DataForwardingRuleArgs, opts ...ResourceOption) (*DataForwardingRule, error)
    public DataForwardingRule(string name, DataForwardingRuleArgs args, CustomResourceOptions? opts = null)
    public DataForwardingRule(String name, DataForwardingRuleArgs args)
public DataForwardingRule(String name, DataForwardingRuleArgs args, CustomResourceOptions options)

    type: sumologic:DataForwardingRule
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 DataForwardingRuleArgs
    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 DataForwardingRuleArgs
    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 DataForwardingRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataForwardingRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataForwardingRuleArgs
    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 dataForwardingRuleResource = new SumoLogic.DataForwardingRule("dataForwardingRuleResource", new()
{
    DestinationId = "string",
    IndexId = "string",
    Enabled = false,
    FileFormat = "string",
    Format = "string",
    PayloadSchema = "string",
});

    example, err := sumologic.NewDataForwardingRule(ctx, "dataForwardingRuleResource", &sumologic.DataForwardingRuleArgs{
	DestinationId: pulumi.String("string"),
	IndexId:       pulumi.String("string"),
	Enabled:       pulumi.Bool(false),
	FileFormat:    pulumi.String("string"),
	Format:        pulumi.String("string"),
	PayloadSchema: pulumi.String("string"),
})

    var dataForwardingRuleResource = new DataForwardingRule("dataForwardingRuleResource", DataForwardingRuleArgs.builder()
    .destinationId("string")
    .indexId("string")
    .enabled(false)
    .fileFormat("string")
    .format("string")
    .payloadSchema("string")
    .build());

    data_forwarding_rule_resource = sumologic.DataForwardingRule("dataForwardingRuleResource",
    destination_id="string",
    index_id="string",
    enabled=False,
    file_format="string",
    format="string",
    payload_schema="string")

    const dataForwardingRuleResource = new sumologic.DataForwardingRule("dataForwardingRuleResource", {
    destinationId: "string",
    indexId: "string",
    enabled: false,
    fileFormat: "string",
    format: "string",
    payloadSchema: "string",
});

    type: sumologic:DataForwardingRule
properties:
    destinationId: string
    enabled: false
    fileFormat: string
    format: string
    indexId: string
    payloadSchema: string

    DataForwardingRule Resource Properties

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

    Inputs

    The DataForwardingRule resource accepts the following input properties:

    DestinationId string
    The data forwarding destination id.
    IndexId string
    The id of the Partition or Scheduled View the rule applies to.
    Enabled bool
    True when the data forwarding rule is enabled.
    FileFormat string
    Specify the path prefix to a directory in the S3 bucket and how to format the file name.
    Format string
    Format of the payload. Default format will be csv. text format should be used in conjunction with raw payloadSchema and vice versa.
    PayloadSchema string
    Schema for the payload. Default value of the payload schema is allFields for scheduled view, and builtInFields for partition. raw payloadSchema should be used in conjunction with text format and vice versa.
    DestinationId string
    The data forwarding destination id.
    IndexId string
    The id of the Partition or Scheduled View the rule applies to.
    Enabled bool
    True when the data forwarding rule is enabled.
    FileFormat string
    Specify the path prefix to a directory in the S3 bucket and how to format the file name.
    Format string
    Format of the payload. Default format will be csv. text format should be used in conjunction with raw payloadSchema and vice versa.
    PayloadSchema string
    Schema for the payload. Default value of the payload schema is allFields for scheduled view, and builtInFields for partition. raw payloadSchema should be used in conjunction with text format and vice versa.
    destinationId String
    The data forwarding destination id.
    indexId String
    The id of the Partition or Scheduled View the rule applies to.
    enabled Boolean
    True when the data forwarding rule is enabled.
    fileFormat String
    Specify the path prefix to a directory in the S3 bucket and how to format the file name.
    format String
    Format of the payload. Default format will be csv. text format should be used in conjunction with raw payloadSchema and vice versa.
    payloadSchema String
    Schema for the payload. Default value of the payload schema is allFields for scheduled view, and builtInFields for partition. raw payloadSchema should be used in conjunction with text format and vice versa.
    destinationId string
    The data forwarding destination id.
    indexId string
    The id of the Partition or Scheduled View the rule applies to.
    enabled boolean
    True when the data forwarding rule is enabled.
    fileFormat string
    Specify the path prefix to a directory in the S3 bucket and how to format the file name.
    format string
    Format of the payload. Default format will be csv. text format should be used in conjunction with raw payloadSchema and vice versa.
    payloadSchema string
    Schema for the payload. Default value of the payload schema is allFields for scheduled view, and builtInFields for partition. raw payloadSchema should be used in conjunction with text format and vice versa.
    destination_id str
    The data forwarding destination id.
    index_id str
    The id of the Partition or Scheduled View the rule applies to.
    enabled bool
    True when the data forwarding rule is enabled.
    file_format str
    Specify the path prefix to a directory in the S3 bucket and how to format the file name.
    format str
    Format of the payload. Default format will be csv. text format should be used in conjunction with raw payloadSchema and vice versa.
    payload_schema str
    Schema for the payload. Default value of the payload schema is allFields for scheduled view, and builtInFields for partition. raw payloadSchema should be used in conjunction with text format and vice versa.
    destinationId String
    The data forwarding destination id.
    indexId String
    The id of the Partition or Scheduled View the rule applies to.
    enabled Boolean
    True when the data forwarding rule is enabled.
    fileFormat String
    Specify the path prefix to a directory in the S3 bucket and how to format the file name.
    format String
    Format of the payload. Default format will be csv. text format should be used in conjunction with raw payloadSchema and vice versa.
    payloadSchema String
    Schema for the payload. Default value of the payload schema is allFields for scheduled view, and builtInFields for partition. raw payloadSchema should be used in conjunction with text format and vice versa.

    Outputs

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

    Get an existing DataForwardingRule 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?: DataForwardingRuleState, opts?: CustomResourceOptions): DataForwardingRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        destination_id: Optional[str] = None,
        enabled: Optional[bool] = None,
        file_format: Optional[str] = None,
        format: Optional[str] = None,
        index_id: Optional[str] = None,
        payload_schema: Optional[str] = None) -> DataForwardingRule
    func GetDataForwardingRule(ctx *Context, name string, id IDInput, state *DataForwardingRuleState, opts ...ResourceOption) (*DataForwardingRule, error)
    public static DataForwardingRule Get(string name, Input<string> id, DataForwardingRuleState? state, CustomResourceOptions? opts = null)
    public static DataForwardingRule get(String name, Output<String> id, DataForwardingRuleState 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:
    DestinationId string
    The data forwarding destination id.
    Enabled bool
    True when the data forwarding rule is enabled.
    FileFormat string
    Specify the path prefix to a directory in the S3 bucket and how to format the file name.
    Format string
    Format of the payload. Default format will be csv. text format should be used in conjunction with raw payloadSchema and vice versa.
    IndexId string
    The id of the Partition or Scheduled View the rule applies to.
    PayloadSchema string
    Schema for the payload. Default value of the payload schema is allFields for scheduled view, and builtInFields for partition. raw payloadSchema should be used in conjunction with text format and vice versa.
    DestinationId string
    The data forwarding destination id.
    Enabled bool
    True when the data forwarding rule is enabled.
    FileFormat string
    Specify the path prefix to a directory in the S3 bucket and how to format the file name.
    Format string
    Format of the payload. Default format will be csv. text format should be used in conjunction with raw payloadSchema and vice versa.
    IndexId string
    The id of the Partition or Scheduled View the rule applies to.
    PayloadSchema string
    Schema for the payload. Default value of the payload schema is allFields for scheduled view, and builtInFields for partition. raw payloadSchema should be used in conjunction with text format and vice versa.
    destinationId String
    The data forwarding destination id.
    enabled Boolean
    True when the data forwarding rule is enabled.
    fileFormat String
    Specify the path prefix to a directory in the S3 bucket and how to format the file name.
    format String
    Format of the payload. Default format will be csv. text format should be used in conjunction with raw payloadSchema and vice versa.
    indexId String
    The id of the Partition or Scheduled View the rule applies to.
    payloadSchema String
    Schema for the payload. Default value of the payload schema is allFields for scheduled view, and builtInFields for partition. raw payloadSchema should be used in conjunction with text format and vice versa.
    destinationId string
    The data forwarding destination id.
    enabled boolean
    True when the data forwarding rule is enabled.
    fileFormat string
    Specify the path prefix to a directory in the S3 bucket and how to format the file name.
    format string
    Format of the payload. Default format will be csv. text format should be used in conjunction with raw payloadSchema and vice versa.
    indexId string
    The id of the Partition or Scheduled View the rule applies to.
    payloadSchema string
    Schema for the payload. Default value of the payload schema is allFields for scheduled view, and builtInFields for partition. raw payloadSchema should be used in conjunction with text format and vice versa.
    destination_id str
    The data forwarding destination id.
    enabled bool
    True when the data forwarding rule is enabled.
    file_format str
    Specify the path prefix to a directory in the S3 bucket and how to format the file name.
    format str
    Format of the payload. Default format will be csv. text format should be used in conjunction with raw payloadSchema and vice versa.
    index_id str
    The id of the Partition or Scheduled View the rule applies to.
    payload_schema str
    Schema for the payload. Default value of the payload schema is allFields for scheduled view, and builtInFields for partition. raw payloadSchema should be used in conjunction with text format and vice versa.
    destinationId String
    The data forwarding destination id.
    enabled Boolean
    True when the data forwarding rule is enabled.
    fileFormat String
    Specify the path prefix to a directory in the S3 bucket and how to format the file name.
    format String
    Format of the payload. Default format will be csv. text format should be used in conjunction with raw payloadSchema and vice versa.
    indexId String
    The id of the Partition or Scheduled View the rule applies to.
    payloadSchema String
    Schema for the payload. Default value of the payload schema is allFields for scheduled view, and builtInFields for partition. raw payloadSchema should be used in conjunction with text format and vice versa.

    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.4 published on Friday, Sep 20, 2024 by Pulumi
    pulumi/pulumi-sumologic