1. Packages
  2. Sumologic Provider
  3. API Docs
  4. CseTagSchema
Sumo Logic v1.0.7 published on Friday, Apr 11, 2025 by Pulumi

sumologic.CseTagSchema

Explore with Pulumi AI

Provides a Sumologic CSE Tag Schema.

Example Usage

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

const tagSchema = new sumologic.CseTagSchema("tag_schema", {
    key: "location",
    label: "label",
    contentTypes: ["entity"],
    freeForm: true,
    valueOptions: [{
        value: "option value",
        label: "option label",
        link: "http://foo.bar.com",
    }],
});
Copy
import pulumi
import pulumi_sumologic as sumologic

tag_schema = sumologic.CseTagSchema("tag_schema",
    key="location",
    label="label",
    content_types=["entity"],
    free_form=True,
    value_options=[{
        "value": "option value",
        "label": "option label",
        "link": "http://foo.bar.com",
    }])
Copy
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.NewCseTagSchema(ctx, "tag_schema", &sumologic.CseTagSchemaArgs{
			Key:   pulumi.String("location"),
			Label: pulumi.String("label"),
			ContentTypes: pulumi.StringArray{
				pulumi.String("entity"),
			},
			FreeForm: pulumi.Bool(true),
			ValueOptions: sumologic.CseTagSchemaValueOptionArray{
				&sumologic.CseTagSchemaValueOptionArgs{
					Value: pulumi.String("option value"),
					Label: pulumi.String("option label"),
					Link:  pulumi.String("http://foo.bar.com"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SumoLogic = Pulumi.SumoLogic;

return await Deployment.RunAsync(() => 
{
    var tagSchema = new SumoLogic.CseTagSchema("tag_schema", new()
    {
        Key = "location",
        Label = "label",
        ContentTypes = new[]
        {
            "entity",
        },
        FreeForm = true,
        ValueOptions = new[]
        {
            new SumoLogic.Inputs.CseTagSchemaValueOptionArgs
            {
                Value = "option value",
                Label = "option label",
                Link = "http://foo.bar.com",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sumologic.CseTagSchema;
import com.pulumi.sumologic.CseTagSchemaArgs;
import com.pulumi.sumologic.inputs.CseTagSchemaValueOptionArgs;
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 tagSchema = new CseTagSchema("tagSchema", CseTagSchemaArgs.builder()
            .key("location")
            .label("label")
            .contentTypes("entity")
            .freeForm(true)
            .valueOptions(CseTagSchemaValueOptionArgs.builder()
                .value("option value")
                .label("option label")
                .link("http://foo.bar.com")
                .build())
            .build());

    }
}
Copy
resources:
  tagSchema:
    type: sumologic:CseTagSchema
    name: tag_schema
    properties:
      key: location
      label: label
      contentTypes:
        - entity
      freeForm: 'true'
      valueOptions:
        - value: option value
          label: option label
          link: http://foo.bar.com
Copy

Create CseTagSchema Resource

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

Constructor syntax

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

@overload
def CseTagSchema(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 free_form: Optional[bool] = None,
                 key: Optional[str] = None,
                 label: Optional[str] = None,
                 content_types: Optional[Sequence[str]] = None,
                 value_options: Optional[Sequence[CseTagSchemaValueOptionArgs]] = None)
func NewCseTagSchema(ctx *Context, name string, args CseTagSchemaArgs, opts ...ResourceOption) (*CseTagSchema, error)
public CseTagSchema(string name, CseTagSchemaArgs args, CustomResourceOptions? opts = null)
public CseTagSchema(String name, CseTagSchemaArgs args)
public CseTagSchema(String name, CseTagSchemaArgs args, CustomResourceOptions options)
type: sumologic:CseTagSchema
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CseTagSchemaArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CseTagSchemaArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CseTagSchemaArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CseTagSchemaArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CseTagSchemaArgs
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 cseTagSchemaResource = new SumoLogic.CseTagSchema("cseTagSchemaResource", new()
{
    FreeForm = false,
    Key = "string",
    Label = "string",
    ContentTypes = new[]
    {
        "string",
    },
    ValueOptions = new[]
    {
        new SumoLogic.Inputs.CseTagSchemaValueOptionArgs
        {
            Value = "string",
            Label = "string",
            Link = "string",
        },
    },
});
Copy
example, err := sumologic.NewCseTagSchema(ctx, "cseTagSchemaResource", &sumologic.CseTagSchemaArgs{
	FreeForm: pulumi.Bool(false),
	Key:      pulumi.String("string"),
	Label:    pulumi.String("string"),
	ContentTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	ValueOptions: sumologic.CseTagSchemaValueOptionArray{
		&sumologic.CseTagSchemaValueOptionArgs{
			Value: pulumi.String("string"),
			Label: pulumi.String("string"),
			Link:  pulumi.String("string"),
		},
	},
})
Copy
var cseTagSchemaResource = new CseTagSchema("cseTagSchemaResource", CseTagSchemaArgs.builder()
    .freeForm(false)
    .key("string")
    .label("string")
    .contentTypes("string")
    .valueOptions(CseTagSchemaValueOptionArgs.builder()
        .value("string")
        .label("string")
        .link("string")
        .build())
    .build());
Copy
cse_tag_schema_resource = sumologic.CseTagSchema("cseTagSchemaResource",
    free_form=False,
    key="string",
    label="string",
    content_types=["string"],
    value_options=[{
        "value": "string",
        "label": "string",
        "link": "string",
    }])
Copy
const cseTagSchemaResource = new sumologic.CseTagSchema("cseTagSchemaResource", {
    freeForm: false,
    key: "string",
    label: "string",
    contentTypes: ["string"],
    valueOptions: [{
        value: "string",
        label: "string",
        link: "string",
    }],
});
Copy
type: sumologic:CseTagSchema
properties:
    contentTypes:
        - string
    freeForm: false
    key: string
    label: string
    valueOptions:
        - label: string
          link: string
          value: string
Copy

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

FreeForm This property is required. bool
Whether the tag schema accepts free form custom values.
Key This property is required. string
Tag Schema key.
Label This property is required. string
Tag Schema label.
ContentTypes List<string>
Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
ValueOptions List<Pulumi.SumoLogic.Inputs.CseTagSchemaValueOption>
FreeForm This property is required. bool
Whether the tag schema accepts free form custom values.
Key This property is required. string
Tag Schema key.
Label This property is required. string
Tag Schema label.
ContentTypes []string
Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
ValueOptions []CseTagSchemaValueOptionArgs
freeForm This property is required. Boolean
Whether the tag schema accepts free form custom values.
key This property is required. String
Tag Schema key.
label This property is required. String
Tag Schema label.
contentTypes List<String>
Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
valueOptions List<CseTagSchemaValueOption>
freeForm This property is required. boolean
Whether the tag schema accepts free form custom values.
key This property is required. string
Tag Schema key.
label This property is required. string
Tag Schema label.
contentTypes string[]
Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
valueOptions CseTagSchemaValueOption[]
free_form This property is required. bool
Whether the tag schema accepts free form custom values.
key This property is required. str
Tag Schema key.
label This property is required. str
Tag Schema label.
content_types Sequence[str]
Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
value_options Sequence[CseTagSchemaValueOptionArgs]
freeForm This property is required. Boolean
Whether the tag schema accepts free form custom values.
key This property is required. String
Tag Schema key.
label This property is required. String
Tag Schema label.
contentTypes List<String>
Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
valueOptions List<Property Map>

Outputs

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

Get an existing CseTagSchema 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?: CseTagSchemaState, opts?: CustomResourceOptions): CseTagSchema
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        content_types: Optional[Sequence[str]] = None,
        free_form: Optional[bool] = None,
        key: Optional[str] = None,
        label: Optional[str] = None,
        value_options: Optional[Sequence[CseTagSchemaValueOptionArgs]] = None) -> CseTagSchema
func GetCseTagSchema(ctx *Context, name string, id IDInput, state *CseTagSchemaState, opts ...ResourceOption) (*CseTagSchema, error)
public static CseTagSchema Get(string name, Input<string> id, CseTagSchemaState? state, CustomResourceOptions? opts = null)
public static CseTagSchema get(String name, Output<String> id, CseTagSchemaState state, CustomResourceOptions options)
resources:  _:    type: sumologic:CseTagSchema    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ContentTypes List<string>
Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
FreeForm bool
Whether the tag schema accepts free form custom values.
Key string
Tag Schema key.
Label string
Tag Schema label.
ValueOptions List<Pulumi.SumoLogic.Inputs.CseTagSchemaValueOption>
ContentTypes []string
Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
FreeForm bool
Whether the tag schema accepts free form custom values.
Key string
Tag Schema key.
Label string
Tag Schema label.
ValueOptions []CseTagSchemaValueOptionArgs
contentTypes List<String>
Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
freeForm Boolean
Whether the tag schema accepts free form custom values.
key String
Tag Schema key.
label String
Tag Schema label.
valueOptions List<CseTagSchemaValueOption>
contentTypes string[]
Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
freeForm boolean
Whether the tag schema accepts free form custom values.
key string
Tag Schema key.
label string
Tag Schema label.
valueOptions CseTagSchemaValueOption[]
content_types Sequence[str]
Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
free_form bool
Whether the tag schema accepts free form custom values.
key str
Tag Schema key.
label str
Tag Schema label.
value_options Sequence[CseTagSchemaValueOptionArgs]
contentTypes List<String>
Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
freeForm Boolean
Whether the tag schema accepts free form custom values.
key String
Tag Schema key.
label String
Tag Schema label.
valueOptions List<Property Map>

Supporting Types

CseTagSchemaValueOption
, CseTagSchemaValueOptionArgs

Value This property is required. string
Value option value.
Label string
Value option label.
Link string

Value option link.

The following attributes are exported:

Value This property is required. string
Value option value.
Label string
Value option label.
Link string

Value option link.

The following attributes are exported:

value This property is required. String
Value option value.
label String
Value option label.
link String

Value option link.

The following attributes are exported:

value This property is required. string
Value option value.
label string
Value option label.
link string

Value option link.

The following attributes are exported:

value This property is required. str
Value option value.
label str
Value option label.
link str

Value option link.

The following attributes are exported:

value This property is required. String
Value option value.
label String
Value option label.
link String

Value option link.

The following attributes are exported:

Import

Tag Schema can be imported using the field id, e.g.:

hcl

$ pulumi import sumologic:index/cseTagSchema:CseTagSchema tag_schema id
Copy

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.