1. Packages
  2. Elasticstack Provider
  3. API Docs
  4. KibanaDataView
elasticstack 0.11.14 published on Monday, Apr 14, 2025 by elastic

elasticstack.KibanaDataView

Explore with Pulumi AI

Creates and manages Kibana data views

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.KibanaDataView;
import com.pulumi.elasticstack.KibanaDataViewArgs;
import com.pulumi.elasticstack.inputs.KibanaDataViewDataViewArgs;
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 myDataView = new KibanaDataView("myDataView", KibanaDataViewArgs.builder()
            .dataView(KibanaDataViewDataViewArgs.builder()
                .name("logs-*")
                .namespaces("backend")
                .time_field_name("@timestamp")
                .title("logs-*")
                .build())
            .build());

        var customFieldsDataView = new KibanaDataView("customFieldsDataView", KibanaDataViewArgs.builder()
            .dataView(KibanaDataViewDataViewArgs.builder()
                .field_attrs(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .field_formats(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .id("custom-data-view")
                .name("custom-data-view")
                .namespaces("default")
                .time_field_name("@timestamp")
                .title("logs-*")
                .build())
            .build());

    }
}
Copy
resources:
  myDataView:
    type: elasticstack:KibanaDataView
    properties:
      dataView:
        name: logs-*
        namespaces:
          - backend
        time_field_name: '@timestamp'
        title: logs-*
  customFieldsDataView:
    type: elasticstack:KibanaDataView
    properties:
      dataView:
        field_attrs:
          response.code:
            - count: 0
              customLabel: Response Code
        field_formats:
          host.name:
            - id: string
              params:
                - transform: upper
          host.uptime:
            - id: duration
              params:
                - includeSpaceWithSuffix: true
                  inputFormat: hours
                  outputFormat: humanizePrecise
                  outputPrecision: 2
                  useShortSuffix: true
          response.code:
            - id: static_lookup
              params:
                - lookupEntries:
                    - key: '200'
                      value: OK
                    - key: '404'
                      value: Not Found
                  unknownKeyValue: Unknown
          url.original:
            - id: url
              params:
                - labeltemplate: '{{value}}'
                  type: a
                  urltemplate: https://test.com/{{value}}
          user.answering_message:
            - id: url
              params:
                - labeltemplate: '{{value}}'
                  type: audio
                  urltemplate: https://test.com/{{value}}
          user.is_active:
            - id: boolean
              params:
                - {}
          user.last_login:
            - id: date
              params:
                - pattern: MMM D, YYYY @ HH:mm:ss.SSS
                  timezone: America/New_York
          user.last_password_change:
            - id: relative_date
              params:
                - {}
          user.message:
            - id: truncate
              params:
                - fieldLength: 10
          user.profile_picture:
            - id: url
              params:
                - height: 4
                  labeltemplate: '{{value}}'
                  type: img
                  urltemplate: https://test.com/{{value}}
                  width: 6
          user.status:
            - id: color
              params:
                - colors:
                    - background: '#ffffff'
                      range: -Infinity:Infinity
                      regex: inactive*
                      text: '#000000'
                  fieldType: string
        id: custom-data-view
        name: custom-data-view
        namespaces:
          - default
        time_field_name: '@timestamp'
        title: logs-*
Copy

Create KibanaDataView Resource

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

Constructor syntax

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

@overload
def KibanaDataView(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   data_view: Optional[KibanaDataViewDataViewArgs] = None,
                   override: Optional[bool] = None,
                   space_id: Optional[str] = None)
func NewKibanaDataView(ctx *Context, name string, args KibanaDataViewArgs, opts ...ResourceOption) (*KibanaDataView, error)
public KibanaDataView(string name, KibanaDataViewArgs args, CustomResourceOptions? opts = null)
public KibanaDataView(String name, KibanaDataViewArgs args)
public KibanaDataView(String name, KibanaDataViewArgs args, CustomResourceOptions options)
type: elasticstack:KibanaDataView
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. KibanaDataViewArgs
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. KibanaDataViewArgs
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. KibanaDataViewArgs
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. KibanaDataViewArgs
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. KibanaDataViewArgs
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 kibanaDataViewResource = new Elasticstack.KibanaDataView("kibanaDataViewResource", new()
{
    DataView = new Elasticstack.Inputs.KibanaDataViewDataViewArgs
    {
        Title = "string",
        AllowNoIndex = false,
        FieldAttrs = 
        {
            { "string", new Elasticstack.Inputs.KibanaDataViewDataViewFieldAttrsArgs
            {
                Count = 0,
                CustomLabel = "string",
            } },
        },
        FieldFormats = 
        {
            { "string", new Elasticstack.Inputs.KibanaDataViewDataViewFieldFormatsArgs
            {
                Id = "string",
                Params = new Elasticstack.Inputs.KibanaDataViewDataViewFieldFormatsParamsArgs
                {
                    Colors = new[]
                    {
                        new Elasticstack.Inputs.KibanaDataViewDataViewFieldFormatsParamsColorArgs
                        {
                            Background = "string",
                            Range = "string",
                            Regex = "string",
                            Text = "string",
                        },
                    },
                    FieldLength = 0,
                    FieldType = "string",
                    Height = 0,
                    IncludeSpaceWithSuffix = false,
                    InputFormat = "string",
                    Labeltemplate = "string",
                    LookupEntries = new[]
                    {
                        new Elasticstack.Inputs.KibanaDataViewDataViewFieldFormatsParamsLookupEntryArgs
                        {
                            Key = "string",
                            Value = "string",
                        },
                    },
                    OutputFormat = "string",
                    OutputPrecision = 0,
                    Pattern = "string",
                    Timezone = "string",
                    Transform = "string",
                    Type = "string",
                    UnknownKeyValue = "string",
                    Urltemplate = "string",
                    UseShortSuffix = false,
                    Width = 0,
                },
            } },
        },
        Id = "string",
        Name = "string",
        Namespaces = new[]
        {
            "string",
        },
        RuntimeFieldMap = 
        {
            { "string", new Elasticstack.Inputs.KibanaDataViewDataViewRuntimeFieldMapArgs
            {
                ScriptSource = "string",
                Type = "string",
            } },
        },
        SourceFilters = new[]
        {
            "string",
        },
        TimeFieldName = "string",
    },
    Override = false,
    SpaceId = "string",
});
Copy
example, err := elasticstack.NewKibanaDataView(ctx, "kibanaDataViewResource", &elasticstack.KibanaDataViewArgs{
DataView: &.KibanaDataViewDataViewArgs{
Title: pulumi.String("string"),
AllowNoIndex: pulumi.Bool(false),
FieldAttrs: .KibanaDataViewDataViewFieldAttrsMap{
"string": &.KibanaDataViewDataViewFieldAttrsArgs{
Count: pulumi.Float64(0),
CustomLabel: pulumi.String("string"),
},
},
FieldFormats: .KibanaDataViewDataViewFieldFormatsMap{
"string": &.KibanaDataViewDataViewFieldFormatsArgs{
Id: pulumi.String("string"),
Params: &.KibanaDataViewDataViewFieldFormatsParamsArgs{
Colors: .KibanaDataViewDataViewFieldFormatsParamsColorArray{
&.KibanaDataViewDataViewFieldFormatsParamsColorArgs{
Background: pulumi.String("string"),
Range: pulumi.String("string"),
Regex: pulumi.String("string"),
Text: pulumi.String("string"),
},
},
FieldLength: pulumi.Float64(0),
FieldType: pulumi.String("string"),
Height: pulumi.Float64(0),
IncludeSpaceWithSuffix: pulumi.Bool(false),
InputFormat: pulumi.String("string"),
Labeltemplate: pulumi.String("string"),
LookupEntries: .KibanaDataViewDataViewFieldFormatsParamsLookupEntryArray{
&.KibanaDataViewDataViewFieldFormatsParamsLookupEntryArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
OutputFormat: pulumi.String("string"),
OutputPrecision: pulumi.Float64(0),
Pattern: pulumi.String("string"),
Timezone: pulumi.String("string"),
Transform: pulumi.String("string"),
Type: pulumi.String("string"),
UnknownKeyValue: pulumi.String("string"),
Urltemplate: pulumi.String("string"),
UseShortSuffix: pulumi.Bool(false),
Width: pulumi.Float64(0),
},
},
},
Id: pulumi.String("string"),
Name: pulumi.String("string"),
Namespaces: pulumi.StringArray{
pulumi.String("string"),
},
RuntimeFieldMap: .KibanaDataViewDataViewRuntimeFieldMapMap{
"string": &.KibanaDataViewDataViewRuntimeFieldMapArgs{
ScriptSource: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
SourceFilters: pulumi.StringArray{
pulumi.String("string"),
},
TimeFieldName: pulumi.String("string"),
},
Override: pulumi.Bool(false),
SpaceId: pulumi.String("string"),
})
Copy
var kibanaDataViewResource = new KibanaDataView("kibanaDataViewResource", KibanaDataViewArgs.builder()
    .dataView(KibanaDataViewDataViewArgs.builder()
        .title("string")
        .allowNoIndex(false)
        .fieldAttrs(Map.of("string", Map.ofEntries(
            Map.entry("count", 0),
            Map.entry("customLabel", "string")
        )))
        .fieldFormats(Map.of("string", Map.ofEntries(
            Map.entry("id", "string"),
            Map.entry("params", Map.ofEntries(
                Map.entry("colors", Map.ofEntries(
                    Map.entry("background", "string"),
                    Map.entry("range", "string"),
                    Map.entry("regex", "string"),
                    Map.entry("text", "string")
                )),
                Map.entry("fieldLength", 0),
                Map.entry("fieldType", "string"),
                Map.entry("height", 0),
                Map.entry("includeSpaceWithSuffix", false),
                Map.entry("inputFormat", "string"),
                Map.entry("labeltemplate", "string"),
                Map.entry("lookupEntries", Map.ofEntries(
                    Map.entry("key", "string"),
                    Map.entry("value", "string")
                )),
                Map.entry("outputFormat", "string"),
                Map.entry("outputPrecision", 0),
                Map.entry("pattern", "string"),
                Map.entry("timezone", "string"),
                Map.entry("transform", "string"),
                Map.entry("type", "string"),
                Map.entry("unknownKeyValue", "string"),
                Map.entry("urltemplate", "string"),
                Map.entry("useShortSuffix", false),
                Map.entry("width", 0)
            ))
        )))
        .id("string")
        .name("string")
        .namespaces("string")
        .runtimeFieldMap(Map.of("string", Map.ofEntries(
            Map.entry("scriptSource", "string"),
            Map.entry("type", "string")
        )))
        .sourceFilters("string")
        .timeFieldName("string")
        .build())
    .override(false)
    .spaceId("string")
    .build());
Copy
kibana_data_view_resource = elasticstack.KibanaDataView("kibanaDataViewResource",
    data_view={
        "title": "string",
        "allow_no_index": False,
        "field_attrs": {
            "string": {
                "count": 0,
                "custom_label": "string",
            },
        },
        "field_formats": {
            "string": {
                "id": "string",
                "params": {
                    "colors": [{
                        "background": "string",
                        "range": "string",
                        "regex": "string",
                        "text": "string",
                    }],
                    "field_length": 0,
                    "field_type": "string",
                    "height": 0,
                    "include_space_with_suffix": False,
                    "input_format": "string",
                    "labeltemplate": "string",
                    "lookup_entries": [{
                        "key": "string",
                        "value": "string",
                    }],
                    "output_format": "string",
                    "output_precision": 0,
                    "pattern": "string",
                    "timezone": "string",
                    "transform": "string",
                    "type": "string",
                    "unknown_key_value": "string",
                    "urltemplate": "string",
                    "use_short_suffix": False,
                    "width": 0,
                },
            },
        },
        "id": "string",
        "name": "string",
        "namespaces": ["string"],
        "runtime_field_map": {
            "string": {
                "script_source": "string",
                "type": "string",
            },
        },
        "source_filters": ["string"],
        "time_field_name": "string",
    },
    override=False,
    space_id="string")
Copy
const kibanaDataViewResource = new elasticstack.KibanaDataView("kibanaDataViewResource", {
    dataView: {
        title: "string",
        allowNoIndex: false,
        fieldAttrs: {
            string: {
                count: 0,
                customLabel: "string",
            },
        },
        fieldFormats: {
            string: {
                id: "string",
                params: {
                    colors: [{
                        background: "string",
                        range: "string",
                        regex: "string",
                        text: "string",
                    }],
                    fieldLength: 0,
                    fieldType: "string",
                    height: 0,
                    includeSpaceWithSuffix: false,
                    inputFormat: "string",
                    labeltemplate: "string",
                    lookupEntries: [{
                        key: "string",
                        value: "string",
                    }],
                    outputFormat: "string",
                    outputPrecision: 0,
                    pattern: "string",
                    timezone: "string",
                    transform: "string",
                    type: "string",
                    unknownKeyValue: "string",
                    urltemplate: "string",
                    useShortSuffix: false,
                    width: 0,
                },
            },
        },
        id: "string",
        name: "string",
        namespaces: ["string"],
        runtimeFieldMap: {
            string: {
                scriptSource: "string",
                type: "string",
            },
        },
        sourceFilters: ["string"],
        timeFieldName: "string",
    },
    override: false,
    spaceId: "string",
});
Copy
type: elasticstack:KibanaDataView
properties:
    dataView:
        allowNoIndex: false
        fieldAttrs:
            string:
                count: 0
                customLabel: string
        fieldFormats:
            string:
                id: string
                params:
                    colors:
                        - background: string
                          range: string
                          regex: string
                          text: string
                    fieldLength: 0
                    fieldType: string
                    height: 0
                    includeSpaceWithSuffix: false
                    inputFormat: string
                    labeltemplate: string
                    lookupEntries:
                        - key: string
                          value: string
                    outputFormat: string
                    outputPrecision: 0
                    pattern: string
                    timezone: string
                    transform: string
                    type: string
                    unknownKeyValue: string
                    urltemplate: string
                    useShortSuffix: false
                    width: 0
        id: string
        name: string
        namespaces:
            - string
        runtimeFieldMap:
            string:
                scriptSource: string
                type: string
        sourceFilters:
            - string
        timeFieldName: string
        title: string
    override: false
    spaceId: string
Copy

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

DataView This property is required. KibanaDataViewDataView
Override bool
Overrides an existing data view if a data view with the provided title already exists.
SpaceId string
An identifier for the space. If space_id is not provided, the default space is used.
DataView This property is required. KibanaDataViewDataViewArgs
Override bool
Overrides an existing data view if a data view with the provided title already exists.
SpaceId string
An identifier for the space. If space_id is not provided, the default space is used.
dataView This property is required. KibanaDataViewDataView
override Boolean
Overrides an existing data view if a data view with the provided title already exists.
spaceId String
An identifier for the space. If space_id is not provided, the default space is used.
dataView This property is required. KibanaDataViewDataView
override boolean
Overrides an existing data view if a data view with the provided title already exists.
spaceId string
An identifier for the space. If space_id is not provided, the default space is used.
data_view This property is required. KibanaDataViewDataViewArgs
override bool
Overrides an existing data view if a data view with the provided title already exists.
space_id str
An identifier for the space. If space_id is not provided, the default space is used.
dataView This property is required. Property Map
override Boolean
Overrides an existing data view if a data view with the provided title already exists.
spaceId String
An identifier for the space. If space_id is not provided, the default space is used.

Outputs

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

Get an existing KibanaDataView 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?: KibanaDataViewState, opts?: CustomResourceOptions): KibanaDataView
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_view: Optional[KibanaDataViewDataViewArgs] = None,
        override: Optional[bool] = None,
        space_id: Optional[str] = None) -> KibanaDataView
func GetKibanaDataView(ctx *Context, name string, id IDInput, state *KibanaDataViewState, opts ...ResourceOption) (*KibanaDataView, error)
public static KibanaDataView Get(string name, Input<string> id, KibanaDataViewState? state, CustomResourceOptions? opts = null)
public static KibanaDataView get(String name, Output<String> id, KibanaDataViewState state, CustomResourceOptions options)
resources:  _:    type: elasticstack:KibanaDataView    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:
DataView KibanaDataViewDataView
Override bool
Overrides an existing data view if a data view with the provided title already exists.
SpaceId string
An identifier for the space. If space_id is not provided, the default space is used.
DataView KibanaDataViewDataViewArgs
Override bool
Overrides an existing data view if a data view with the provided title already exists.
SpaceId string
An identifier for the space. If space_id is not provided, the default space is used.
dataView KibanaDataViewDataView
override Boolean
Overrides an existing data view if a data view with the provided title already exists.
spaceId String
An identifier for the space. If space_id is not provided, the default space is used.
dataView KibanaDataViewDataView
override boolean
Overrides an existing data view if a data view with the provided title already exists.
spaceId string
An identifier for the space. If space_id is not provided, the default space is used.
data_view KibanaDataViewDataViewArgs
override bool
Overrides an existing data view if a data view with the provided title already exists.
space_id str
An identifier for the space. If space_id is not provided, the default space is used.
dataView Property Map
override Boolean
Overrides an existing data view if a data view with the provided title already exists.
spaceId String
An identifier for the space. If space_id is not provided, the default space is used.

Supporting Types

KibanaDataViewDataView
, KibanaDataViewDataViewArgs

Title This property is required. string
Comma-separated list of data streams, indices, and aliases that you want to search. Supports wildcards (*).
AllowNoIndex bool
Allows the Data view saved object to exist before the data is available.
FieldAttrs Dictionary<string, KibanaDataViewDataViewFieldAttrs>
Map of field attributes by field name.
FieldFormats Dictionary<string, KibanaDataViewDataViewFieldFormats>
Map of field formats by field name.
Id string
Saved object ID.
Name string
The Data view name.
Namespaces List<string>
Array of space IDs for sharing the Data view between multiple spaces.
RuntimeFieldMap Dictionary<string, KibanaDataViewDataViewRuntimeFieldMap>
Map of runtime field definitions by field name.
SourceFilters List<string>
List of field names you want to filter out in Discover.
TimeFieldName string
Timestamp field name, which you use for time-based Data views.
Title This property is required. string
Comma-separated list of data streams, indices, and aliases that you want to search. Supports wildcards (*).
AllowNoIndex bool
Allows the Data view saved object to exist before the data is available.
FieldAttrs map[string]KibanaDataViewDataViewFieldAttrs
Map of field attributes by field name.
FieldFormats map[string]KibanaDataViewDataViewFieldFormats
Map of field formats by field name.
Id string
Saved object ID.
Name string
The Data view name.
Namespaces []string
Array of space IDs for sharing the Data view between multiple spaces.
RuntimeFieldMap map[string]KibanaDataViewDataViewRuntimeFieldMap
Map of runtime field definitions by field name.
SourceFilters []string
List of field names you want to filter out in Discover.
TimeFieldName string
Timestamp field name, which you use for time-based Data views.
title This property is required. String
Comma-separated list of data streams, indices, and aliases that you want to search. Supports wildcards (*).
allowNoIndex Boolean
Allows the Data view saved object to exist before the data is available.
fieldAttrs Map<String,KibanaDataViewDataViewFieldAttrs>
Map of field attributes by field name.
fieldFormats Map<String,KibanaDataViewDataViewFieldFormats>
Map of field formats by field name.
id String
Saved object ID.
name String
The Data view name.
namespaces List<String>
Array of space IDs for sharing the Data view between multiple spaces.
runtimeFieldMap Map<String,KibanaDataViewDataViewRuntimeFieldMap>
Map of runtime field definitions by field name.
sourceFilters List<String>
List of field names you want to filter out in Discover.
timeFieldName String
Timestamp field name, which you use for time-based Data views.
title This property is required. string
Comma-separated list of data streams, indices, and aliases that you want to search. Supports wildcards (*).
allowNoIndex boolean
Allows the Data view saved object to exist before the data is available.
fieldAttrs {[key: string]: KibanaDataViewDataViewFieldAttrs}
Map of field attributes by field name.
fieldFormats {[key: string]: KibanaDataViewDataViewFieldFormats}
Map of field formats by field name.
id string
Saved object ID.
name string
The Data view name.
namespaces string[]
Array of space IDs for sharing the Data view between multiple spaces.
runtimeFieldMap {[key: string]: KibanaDataViewDataViewRuntimeFieldMap}
Map of runtime field definitions by field name.
sourceFilters string[]
List of field names you want to filter out in Discover.
timeFieldName string
Timestamp field name, which you use for time-based Data views.
title This property is required. str
Comma-separated list of data streams, indices, and aliases that you want to search. Supports wildcards (*).
allow_no_index bool
Allows the Data view saved object to exist before the data is available.
field_attrs Mapping[str, KibanaDataViewDataViewFieldAttrs]
Map of field attributes by field name.
field_formats Mapping[str, KibanaDataViewDataViewFieldFormats]
Map of field formats by field name.
id str
Saved object ID.
name str
The Data view name.
namespaces Sequence[str]
Array of space IDs for sharing the Data view between multiple spaces.
runtime_field_map Mapping[str, KibanaDataViewDataViewRuntimeFieldMap]
Map of runtime field definitions by field name.
source_filters Sequence[str]
List of field names you want to filter out in Discover.
time_field_name str
Timestamp field name, which you use for time-based Data views.
title This property is required. String
Comma-separated list of data streams, indices, and aliases that you want to search. Supports wildcards (*).
allowNoIndex Boolean
Allows the Data view saved object to exist before the data is available.
fieldAttrs Map<Property Map>
Map of field attributes by field name.
fieldFormats Map<Property Map>
Map of field formats by field name.
id String
Saved object ID.
name String
The Data view name.
namespaces List<String>
Array of space IDs for sharing the Data view between multiple spaces.
runtimeFieldMap Map<Property Map>
Map of runtime field definitions by field name.
sourceFilters List<String>
List of field names you want to filter out in Discover.
timeFieldName String
Timestamp field name, which you use for time-based Data views.

KibanaDataViewDataViewFieldAttrs
, KibanaDataViewDataViewFieldAttrsArgs

Count double
Popularity count for the field.
CustomLabel string
Custom label for the field.
Count float64
Popularity count for the field.
CustomLabel string
Custom label for the field.
count Double
Popularity count for the field.
customLabel String
Custom label for the field.
count number
Popularity count for the field.
customLabel string
Custom label for the field.
count float
Popularity count for the field.
custom_label str
Custom label for the field.
count Number
Popularity count for the field.
customLabel String
Custom label for the field.

KibanaDataViewDataViewFieldFormats
, KibanaDataViewDataViewFieldFormatsArgs

Id This property is required. string
The ID of the field format. Valid values include: boolean, color, date, duration, number, percent, relative_date, static_lookup, string, truncate, url.
Params KibanaDataViewDataViewFieldFormatsParams
Id This property is required. string
The ID of the field format. Valid values include: boolean, color, date, duration, number, percent, relative_date, static_lookup, string, truncate, url.
Params KibanaDataViewDataViewFieldFormatsParams
id This property is required. String
The ID of the field format. Valid values include: boolean, color, date, duration, number, percent, relative_date, static_lookup, string, truncate, url.
params KibanaDataViewDataViewFieldFormatsParams
id This property is required. string
The ID of the field format. Valid values include: boolean, color, date, duration, number, percent, relative_date, static_lookup, string, truncate, url.
params KibanaDataViewDataViewFieldFormatsParams
id This property is required. str
The ID of the field format. Valid values include: boolean, color, date, duration, number, percent, relative_date, static_lookup, string, truncate, url.
params KibanaDataViewDataViewFieldFormatsParams
id This property is required. String
The ID of the field format. Valid values include: boolean, color, date, duration, number, percent, relative_date, static_lookup, string, truncate, url.
params Property Map

KibanaDataViewDataViewFieldFormatsParams
, KibanaDataViewDataViewFieldFormatsParamsArgs

Colors List<KibanaDataViewDataViewFieldFormatsParamsColor>
Color rules for the field.
FieldLength double
Length to truncate the field value.
FieldType string
Field type for color formatting (e.g., string, number).
Height double
Height for image type URLs.
IncludeSpaceWithSuffix bool
Whether to include a space before the suffix in duration format.
InputFormat string
Input format for duration fields (e.g., hours, minutes).
Labeltemplate string
Label template for the field value.
LookupEntries List<KibanaDataViewDataViewFieldFormatsParamsLookupEntry>
Key-value pairs for static lookup.
OutputFormat string
Output format for duration fields (e.g., humanizePrecise, humanize).
OutputPrecision double
Precision for duration output.
Pattern string
Pattern for formatting the field value.
Timezone string
Timezone for date formatting (e.g., America/New_York).
Transform string
Transform to apply to string fields (e.g., upper, lower).
Type string
Type of URL format (e.g., a, img, audio).
UnknownKeyValue string
Value to display when key is not found in lookup.
Urltemplate string
URL template for the field value.
UseShortSuffix bool
Whether to use short suffixes in duration format.
Width double
Width for image type URLs.
Colors []KibanaDataViewDataViewFieldFormatsParamsColor
Color rules for the field.
FieldLength float64
Length to truncate the field value.
FieldType string
Field type for color formatting (e.g., string, number).
Height float64
Height for image type URLs.
IncludeSpaceWithSuffix bool
Whether to include a space before the suffix in duration format.
InputFormat string
Input format for duration fields (e.g., hours, minutes).
Labeltemplate string
Label template for the field value.
LookupEntries []KibanaDataViewDataViewFieldFormatsParamsLookupEntry
Key-value pairs for static lookup.
OutputFormat string
Output format for duration fields (e.g., humanizePrecise, humanize).
OutputPrecision float64
Precision for duration output.
Pattern string
Pattern for formatting the field value.
Timezone string
Timezone for date formatting (e.g., America/New_York).
Transform string
Transform to apply to string fields (e.g., upper, lower).
Type string
Type of URL format (e.g., a, img, audio).
UnknownKeyValue string
Value to display when key is not found in lookup.
Urltemplate string
URL template for the field value.
UseShortSuffix bool
Whether to use short suffixes in duration format.
Width float64
Width for image type URLs.
colors List<KibanaDataViewDataViewFieldFormatsParamsColor>
Color rules for the field.
fieldLength Double
Length to truncate the field value.
fieldType String
Field type for color formatting (e.g., string, number).
height Double
Height for image type URLs.
includeSpaceWithSuffix Boolean
Whether to include a space before the suffix in duration format.
inputFormat String
Input format for duration fields (e.g., hours, minutes).
labeltemplate String
Label template for the field value.
lookupEntries List<KibanaDataViewDataViewFieldFormatsParamsLookupEntry>
Key-value pairs for static lookup.
outputFormat String
Output format for duration fields (e.g., humanizePrecise, humanize).
outputPrecision Double
Precision for duration output.
pattern String
Pattern for formatting the field value.
timezone String
Timezone for date formatting (e.g., America/New_York).
transform String
Transform to apply to string fields (e.g., upper, lower).
type String
Type of URL format (e.g., a, img, audio).
unknownKeyValue String
Value to display when key is not found in lookup.
urltemplate String
URL template for the field value.
useShortSuffix Boolean
Whether to use short suffixes in duration format.
width Double
Width for image type URLs.
colors KibanaDataViewDataViewFieldFormatsParamsColor[]
Color rules for the field.
fieldLength number
Length to truncate the field value.
fieldType string
Field type for color formatting (e.g., string, number).
height number
Height for image type URLs.
includeSpaceWithSuffix boolean
Whether to include a space before the suffix in duration format.
inputFormat string
Input format for duration fields (e.g., hours, minutes).
labeltemplate string
Label template for the field value.
lookupEntries KibanaDataViewDataViewFieldFormatsParamsLookupEntry[]
Key-value pairs for static lookup.
outputFormat string
Output format for duration fields (e.g., humanizePrecise, humanize).
outputPrecision number
Precision for duration output.
pattern string
Pattern for formatting the field value.
timezone string
Timezone for date formatting (e.g., America/New_York).
transform string
Transform to apply to string fields (e.g., upper, lower).
type string
Type of URL format (e.g., a, img, audio).
unknownKeyValue string
Value to display when key is not found in lookup.
urltemplate string
URL template for the field value.
useShortSuffix boolean
Whether to use short suffixes in duration format.
width number
Width for image type URLs.
colors Sequence[KibanaDataViewDataViewFieldFormatsParamsColor]
Color rules for the field.
field_length float
Length to truncate the field value.
field_type str
Field type for color formatting (e.g., string, number).
height float
Height for image type URLs.
include_space_with_suffix bool
Whether to include a space before the suffix in duration format.
input_format str
Input format for duration fields (e.g., hours, minutes).
labeltemplate str
Label template for the field value.
lookup_entries Sequence[KibanaDataViewDataViewFieldFormatsParamsLookupEntry]
Key-value pairs for static lookup.
output_format str
Output format for duration fields (e.g., humanizePrecise, humanize).
output_precision float
Precision for duration output.
pattern str
Pattern for formatting the field value.
timezone str
Timezone for date formatting (e.g., America/New_York).
transform str
Transform to apply to string fields (e.g., upper, lower).
type str
Type of URL format (e.g., a, img, audio).
unknown_key_value str
Value to display when key is not found in lookup.
urltemplate str
URL template for the field value.
use_short_suffix bool
Whether to use short suffixes in duration format.
width float
Width for image type URLs.
colors List<Property Map>
Color rules for the field.
fieldLength Number
Length to truncate the field value.
fieldType String
Field type for color formatting (e.g., string, number).
height Number
Height for image type URLs.
includeSpaceWithSuffix Boolean
Whether to include a space before the suffix in duration format.
inputFormat String
Input format for duration fields (e.g., hours, minutes).
labeltemplate String
Label template for the field value.
lookupEntries List<Property Map>
Key-value pairs for static lookup.
outputFormat String
Output format for duration fields (e.g., humanizePrecise, humanize).
outputPrecision Number
Precision for duration output.
pattern String
Pattern for formatting the field value.
timezone String
Timezone for date formatting (e.g., America/New_York).
transform String
Transform to apply to string fields (e.g., upper, lower).
type String
Type of URL format (e.g., a, img, audio).
unknownKeyValue String
Value to display when key is not found in lookup.
urltemplate String
URL template for the field value.
useShortSuffix Boolean
Whether to use short suffixes in duration format.
width Number
Width for image type URLs.

KibanaDataViewDataViewFieldFormatsParamsColor
, KibanaDataViewDataViewFieldFormatsParamsColorArgs

Background string
Background color in hex format.
Range string
Range for the color rule (e.g., -Infinity:Infinity).
Regex string
Regex pattern for the color rule.
Text string
Text color in hex format.
Background string
Background color in hex format.
Range string
Range for the color rule (e.g., -Infinity:Infinity).
Regex string
Regex pattern for the color rule.
Text string
Text color in hex format.
background String
Background color in hex format.
range String
Range for the color rule (e.g., -Infinity:Infinity).
regex String
Regex pattern for the color rule.
text String
Text color in hex format.
background string
Background color in hex format.
range string
Range for the color rule (e.g., -Infinity:Infinity).
regex string
Regex pattern for the color rule.
text string
Text color in hex format.
background str
Background color in hex format.
range str
Range for the color rule (e.g., -Infinity:Infinity).
regex str
Regex pattern for the color rule.
text str
Text color in hex format.
background String
Background color in hex format.
range String
Range for the color rule (e.g., -Infinity:Infinity).
regex String
Regex pattern for the color rule.
text String
Text color in hex format.

KibanaDataViewDataViewFieldFormatsParamsLookupEntry
, KibanaDataViewDataViewFieldFormatsParamsLookupEntryArgs

Key This property is required. string
Key for the lookup entry.
Value This property is required. string
Value for the lookup entry.
Key This property is required. string
Key for the lookup entry.
Value This property is required. string
Value for the lookup entry.
key This property is required. String
Key for the lookup entry.
value This property is required. String
Value for the lookup entry.
key This property is required. string
Key for the lookup entry.
value This property is required. string
Value for the lookup entry.
key This property is required. str
Key for the lookup entry.
value This property is required. str
Value for the lookup entry.
key This property is required. String
Key for the lookup entry.
value This property is required. String
Value for the lookup entry.

KibanaDataViewDataViewRuntimeFieldMap
, KibanaDataViewDataViewRuntimeFieldMapArgs

ScriptSource This property is required. string
Script of the runtime field.
Type This property is required. string
Mapping type of the runtime field. For more information, check Field data types.
ScriptSource This property is required. string
Script of the runtime field.
Type This property is required. string
Mapping type of the runtime field. For more information, check Field data types.
scriptSource This property is required. String
Script of the runtime field.
type This property is required. String
Mapping type of the runtime field. For more information, check Field data types.
scriptSource This property is required. string
Script of the runtime field.
type This property is required. string
Mapping type of the runtime field. For more information, check Field data types.
script_source This property is required. str
Script of the runtime field.
type This property is required. str
Mapping type of the runtime field. For more information, check Field data types.
scriptSource This property is required. String
Script of the runtime field.
type This property is required. String
Mapping type of the runtime field. For more information, check Field data types.

Import

$ pulumi import elasticstack:index/kibanaDataView:KibanaDataView my_data_view <space id>/<data view id>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
elasticstack elastic/terraform-provider-elasticstack
License
Notes
This Pulumi package is based on the elasticstack Terraform Provider.