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

sumologic.CseTagSchema

Explore with Pulumi AI

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

    Provides a Sumologic CSE Tag Schema.

    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 string
    The unique name of the resource.
    args CseTagSchemaArgs
    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 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 string
    The unique name of the resource.
    args CseTagSchemaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CseTagSchemaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
            },
        },
    });
    
    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"),
    		},
    	},
    })
    
    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());
    
    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",
        }])
    
    const cseTagSchemaResource = new sumologic.CseTagSchema("cseTagSchemaResource", {
        freeForm: false,
        key: "string",
        label: "string",
        contentTypes: ["string"],
        valueOptions: [{
            value: "string",
            label: "string",
            link: "string",
        }],
    });
    
    type: sumologic:CseTagSchema
    properties:
        contentTypes:
            - string
        freeForm: false
        key: string
        label: string
        valueOptions:
            - label: string
              link: string
              value: string
    

    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 bool
    Whether the tag schema accepts free form custom values.
    Key string
    Tag Schema key.
    Label string
    Tag Schema label.
    ContentTypes List<string>
    Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
    ValueOptions List<Pulumi.SumoLogic.Inputs.CseTagSchemaValueOption>
    FreeForm bool
    Whether the tag schema accepts free form custom values.
    Key string
    Tag Schema key.
    Label string
    Tag Schema label.
    ContentTypes []string
    Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
    ValueOptions []CseTagSchemaValueOptionArgs
    freeForm Boolean
    Whether the tag schema accepts free form custom values.
    key String
    Tag Schema key.
    label String
    Tag Schema label.
    contentTypes List<String>
    Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
    valueOptions List<CseTagSchemaValueOption>
    freeForm boolean
    Whether the tag schema accepts free form custom values.
    key string
    Tag Schema key.
    label string
    Tag Schema label.
    contentTypes string[]
    Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
    valueOptions CseTagSchemaValueOption[]
    free_form bool
    Whether the tag schema accepts free form custom values.
    key str
    Tag Schema key.
    label str
    Tag Schema label.
    content_types Sequence[str]
    Applicable content types. Valid values: "customInsight", "entity", "rule", "threatIntelligence".
    value_options Sequence[CseTagSchemaValueOptionArgs]
    freeForm Boolean
    Whether the tag schema accepts free form custom values.
    key String
    Tag Schema key.
    label 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)
    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:
    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 string
    Value option value.
    Label string
    Value option label.
    Link string

    Value option link.

    The following attributes are exported:

    Value string
    Value option value.
    Label string
    Value option label.
    Link string

    Value option link.

    The following attributes are exported:

    value String
    Value option value.
    label String
    Value option label.
    link String

    Value option link.

    The following attributes are exported:

    value string
    Value option value.
    label string
    Value option label.
    link string

    Value option link.

    The following attributes are exported:

    value str
    Value option value.
    label str
    Value option label.
    link str

    Value option link.

    The following attributes are exported:

    value 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
    

    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