builtin_fields

Creates, updates, deletes, gets or lists a builtin_fields resource.

Overview

Name	builtin_fields
Type	Resource
Id	sumologic.fields.builtin_fields

Fields

The following fields are returned by SELECT queries:

get

The details of the built-in field.

Name	Datatype	Description
field_id	string	Identifier of the field. (example: 00000000031D02DA) (wire: fieldId)
field_name	string	Field name. (example: hostIP) (wire: fieldName)
data_type	string	Field type. Possible values are String, Long, Int, Double, and Boolean. (pattern: <code>^(String|Long|Int|Double|Boolean)$</code>, example: String, x-pattern-message: Must be String, Long, Int, Double or Boolean) (wire: dataType)
state	string	Indicates whether the field is enabled and its values are being accepted. Possible values are Enabled and Disabled. (pattern: <code>^(Enabled|Disabled)$</code>, example: Enabled, x-pattern-message: Must be Enabled or Disabled)

list

List of all built-in fields.

Name	Datatype	Description
field_id	string	Identifier of the field. (example: 00000000031D02DA) (wire: fieldId)
field_name	string	Field name. (example: hostIP) (wire: fieldName)
data_type	string	Field type. Possible values are String, Long, Int, Double, and Boolean. (pattern: <code>^(String|Long|Int|Double|Boolean)$</code>, example: String, x-pattern-message: Must be String, Long, Int, Double or Boolean) (wire: dataType)
state	string	Indicates whether the field is enabled and its values are being accepted. Possible values are Enabled and Disabled. (pattern: <code>^(Enabled|Disabled)$</code>, example: Enabled, x-pattern-message: Must be Enabled or Disabled)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, region		Get the details of a built-in field.
list	select	region		Built-in fields are created automatically by Sumo Logic for standard configuration purposes. They include _sourceHost and _sourceCategory. Built-in fields can't be deleted or disabled.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	Identifier of a built-in field. (example: 000000000000000A)
region	string	Sumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT)

SELECT examples

get

Get the details of a built-in field.

SELECT
field_id,
field_name,
data_type,
state
FROM sumologic.fields.builtin_fields
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;

list

Built-in fields are created automatically by Sumo Logic for standard configuration purposes. They include _sourceHost and _sourceCategory. Built-in fields can't be deleted or disabled.

SELECT
field_id,
field_name,
data_type,
state
FROM sumologic.fields.builtin_fields
WHERE region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;