Sumo Logic v0.23.4, Sep 20 24

Sumo Logic v0.23.4 published on Friday, Sep 20, 2024 by Pulumi

sumologic.Field

Explore with Pulumi AI

Sumo Logic v0.23.4 published on Friday, Sep 20, 2024 by Pulumi

Create Field Resource

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

Constructor syntax

new Field(name: string, args: FieldArgs, opts?: CustomResourceOptions);

@overload
def Field(resource_name: str,
          args: FieldArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Field(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          field_name: Optional[str] = None,
          data_type: Optional[str] = None,
          state: Optional[str] = None)

func NewField(ctx *Context, name string, args FieldArgs, opts ...ResourceOption) (*Field, error)

public Field(string name, FieldArgs args, CustomResourceOptions? opts = null)

public Field(String name, FieldArgs args)
public Field(String name, FieldArgs args, CustomResourceOptions options)

type: sumologic:Field
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 FieldArgs: 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 FieldArgs: 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 FieldArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args FieldArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args FieldArgs: 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 fieldResource = new SumoLogic.Field("fieldResource", new()
{
    FieldName = "string",
    DataType = "string",
    State = "string",
});

example, err := sumologic.NewField(ctx, "fieldResource", &sumologic.FieldArgs{
	FieldName: pulumi.String("string"),
	DataType:  pulumi.String("string"),
	State:     pulumi.String("string"),
})

var fieldResource = new Field("fieldResource", FieldArgs.builder()
    .fieldName("string")
    .dataType("string")
    .state("string")
    .build());

field_resource = sumologic.Field("fieldResource",
    field_name="string",
    data_type="string",
    state="string")

const fieldResource = new sumologic.Field("fieldResource", {
    fieldName: "string",
    dataType: "string",
    state: "string",
});

type: sumologic:Field
properties:
    dataType: string
    fieldName: string
    state: string

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

FieldName string: Name of the field.
DataType string
State string: State of the field (either Enabled or Disabled).

FieldName string: Name of the field.
DataType string
State string: State of the field (either Enabled or Disabled).

fieldName String: Name of the field.
dataType String
state String: State of the field (either Enabled or Disabled).

fieldName string: Name of the field.
dataType string
state string: State of the field (either Enabled or Disabled).

field_name str: Name of the field.
data_type str
state str: State of the field (either Enabled or Disabled).

fieldName String: Name of the field.
dataType String
state String: State of the field (either Enabled or Disabled).

Outputs

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

FieldId string: Field identifier.
Id string: The provider-assigned unique ID for this managed resource.

FieldId string: Field identifier.
Id string: The provider-assigned unique ID for this managed resource.

fieldId String: Field identifier.
id String: The provider-assigned unique ID for this managed resource.

fieldId string: Field identifier.
id string: The provider-assigned unique ID for this managed resource.

field_id str: Field identifier.
id str: The provider-assigned unique ID for this managed resource.

fieldId String: Field identifier.
id String: The provider-assigned unique ID for this managed resource.

Look up Existing Field Resource

Get an existing Field 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?: FieldState, opts?: CustomResourceOptions): Field

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_type: Optional[str] = None,
        field_id: Optional[str] = None,
        field_name: Optional[str] = None,
        state: Optional[str] = None) -> Field

func GetField(ctx *Context, name string, id IDInput, state *FieldState, opts ...ResourceOption) (*Field, error)

public static Field Get(string name, Input<string> id, FieldState? state, CustomResourceOptions? opts = null)

public static Field get(String name, Output<String> id, FieldState 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:

DataType string
FieldId string: Field identifier.
FieldName string: Name of the field.
State string: State of the field (either Enabled or Disabled).

DataType string
FieldId string: Field identifier.
FieldName string: Name of the field.
State string: State of the field (either Enabled or Disabled).

dataType String
fieldId String: Field identifier.
fieldName String: Name of the field.
state String: State of the field (either Enabled or Disabled).

dataType string
fieldId string: Field identifier.
fieldName string: Name of the field.
state string: State of the field (either Enabled or Disabled).

data_type str
field_id str: Field identifier.
field_name str: Name of the field.
state str: State of the field (either Enabled or Disabled).

dataType String
fieldId String: Field identifier.
fieldName String: Name of the field.
state String: State of the field (either Enabled or Disabled).

Import

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

hcl

$ pulumi import sumologic:index/field:Field field 000000000ABC1234

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.

Sumo Logic v0.23.4 published on Friday, Sep 20, 2024 by Pulumi

pulumi/pulumi-sumologic

sumologic.Field

On this page

On this page

Create Field Resource

Constructor syntax

Parameters

Constructor example

Field Resource Properties

Inputs

Outputs

Look up Existing Field Resource

Import

Package Details

On this page

On this page