Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Elasticstack Provider
  3. API Docs
  4. KibanaSpace
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic
elastic/terraform-provider-elasticstack

elasticstack.KibanaSpace

Explore with Pulumi AI

elasticstack logo
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic
elastic/terraform-provider-elasticstack

    Creates or updates a Kibana space. See https://www.elastic.co/guide/en/kibana/master/xpack-spaces.html

    Example Usage

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

const example = new elasticstack.KibanaSpace("example", {
    description: "A fresh space for testing visualisations",
    disabledFeatures: [
        "ingestManager",
        "enterpriseSearch",
    ],
    initials: "ts",
    spaceId: "test_space",
});

    import pulumi
import pulumi_elasticstack as elasticstack

example = elasticstack.KibanaSpace("example",
    description="A fresh space for testing visualisations",
    disabled_features=[
        "ingestManager",
        "enterpriseSearch",
    ],
    initials="ts",
    space_id="test_space")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/elasticstack/elasticstack"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := elasticstack.NewKibanaSpace(ctx, "example", &elasticstack.KibanaSpaceArgs{
			Description: pulumi.String("A fresh space for testing visualisations"),
			DisabledFeatures: pulumi.StringArray{
				pulumi.String("ingestManager"),
				pulumi.String("enterpriseSearch"),
			},
			Initials: pulumi.String("ts"),
			SpaceId:  pulumi.String("test_space"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;

return await Deployment.RunAsync(() => 
{
    var example = new Elasticstack.KibanaSpace("example", new()
    {
        Description = "A fresh space for testing visualisations",
        DisabledFeatures = new[]
        {
            "ingestManager",
            "enterpriseSearch",
        },
        Initials = "ts",
        SpaceId = "test_space",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.KibanaSpace;
import com.pulumi.elasticstack.KibanaSpaceArgs;
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 example = new KibanaSpace("example", KibanaSpaceArgs.builder()
            .description("A fresh space for testing visualisations")
            .disabledFeatures(            
                "ingestManager",
                "enterpriseSearch")
            .initials("ts")
            .spaceId("test_space")
            .build());

    }
}

    resources:
  example:
    type: elasticstack:KibanaSpace
    properties:
      description: A fresh space for testing visualisations
      disabledFeatures:
        - ingestManager
        - enterpriseSearch
      initials: ts
      spaceId: test_space

    Create KibanaSpace Resource

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

    Constructor syntax

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

@overload
def KibanaSpace(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                space_id: Optional[str] = None,
                color: Optional[str] = None,
                description: Optional[str] = None,
                disabled_features: Optional[Sequence[str]] = None,
                image_url: Optional[str] = None,
                initials: Optional[str] = None,
                name: Optional[str] = None)
    func NewKibanaSpace(ctx *Context, name string, args KibanaSpaceArgs, opts ...ResourceOption) (*KibanaSpace, error)
    public KibanaSpace(string name, KibanaSpaceArgs args, CustomResourceOptions? opts = null)
    public KibanaSpace(String name, KibanaSpaceArgs args)
public KibanaSpace(String name, KibanaSpaceArgs args, CustomResourceOptions options)

    type: elasticstack:KibanaSpace
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 KibanaSpaceArgs
    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 KibanaSpaceArgs
    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 KibanaSpaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KibanaSpaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KibanaSpaceArgs
    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 kibanaSpaceResource = new Elasticstack.KibanaSpace("kibanaSpaceResource", new()
{
    SpaceId = "string",
    Color = "string",
    Description = "string",
    DisabledFeatures = new[]
    {
        "string",
    },
    ImageUrl = "string",
    Initials = "string",
    Name = "string",
});

    example, err := elasticstack.NewKibanaSpace(ctx, "kibanaSpaceResource", &elasticstack.KibanaSpaceArgs{
	SpaceId:     pulumi.String("string"),
	Color:       pulumi.String("string"),
	Description: pulumi.String("string"),
	DisabledFeatures: pulumi.StringArray{
		pulumi.String("string"),
	},
	ImageUrl: pulumi.String("string"),
	Initials: pulumi.String("string"),
	Name:     pulumi.String("string"),
})

    var kibanaSpaceResource = new KibanaSpace("kibanaSpaceResource", KibanaSpaceArgs.builder()
    .spaceId("string")
    .color("string")
    .description("string")
    .disabledFeatures("string")
    .imageUrl("string")
    .initials("string")
    .name("string")
    .build());

    kibana_space_resource = elasticstack.KibanaSpace("kibanaSpaceResource",
    space_id="string",
    color="string",
    description="string",
    disabled_features=["string"],
    image_url="string",
    initials="string",
    name="string")

    const kibanaSpaceResource = new elasticstack.KibanaSpace("kibanaSpaceResource", {
    spaceId: "string",
    color: "string",
    description: "string",
    disabledFeatures: ["string"],
    imageUrl: "string",
    initials: "string",
    name: "string",
});

    type: elasticstack:KibanaSpace
properties:
    color: string
    description: string
    disabledFeatures:
        - string
    imageUrl: string
    initials: string
    name: string
    spaceId: string

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

    SpaceId string
    The space ID that is part of the Kibana URL when inside the space.
    Color string
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    Description string
    The description for the space.
    DisabledFeatures List<string>
    The list of disabled features for the space. To get a list of available feature IDs, use the Features API (https://www.elastic.co/guide/en/kibana/master/features-api-get.html).
    ImageUrl string
    The data-URL encoded image to display in the space avatar.
    Initials string
    The initials shown in the space avatar. By default, the initials are automatically generated from the space name. Initials must be 1 or 2 characters.
    Name string
    The display name for the space.
    SpaceId string
    The space ID that is part of the Kibana URL when inside the space.
    Color string
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    Description string
    The description for the space.
    DisabledFeatures []string
    The list of disabled features for the space. To get a list of available feature IDs, use the Features API (https://www.elastic.co/guide/en/kibana/master/features-api-get.html).
    ImageUrl string
    The data-URL encoded image to display in the space avatar.
    Initials string
    The initials shown in the space avatar. By default, the initials are automatically generated from the space name. Initials must be 1 or 2 characters.
    Name string
    The display name for the space.
    spaceId String
    The space ID that is part of the Kibana URL when inside the space.
    color String
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    description String
    The description for the space.
    disabledFeatures List<String>
    The list of disabled features for the space. To get a list of available feature IDs, use the Features API (https://www.elastic.co/guide/en/kibana/master/features-api-get.html).
    imageUrl String
    The data-URL encoded image to display in the space avatar.
    initials String
    The initials shown in the space avatar. By default, the initials are automatically generated from the space name. Initials must be 1 or 2 characters.
    name String
    The display name for the space.
    spaceId string
    The space ID that is part of the Kibana URL when inside the space.
    color string
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    description string
    The description for the space.
    disabledFeatures string[]
    The list of disabled features for the space. To get a list of available feature IDs, use the Features API (https://www.elastic.co/guide/en/kibana/master/features-api-get.html).
    imageUrl string
    The data-URL encoded image to display in the space avatar.
    initials string
    The initials shown in the space avatar. By default, the initials are automatically generated from the space name. Initials must be 1 or 2 characters.
    name string
    The display name for the space.
    space_id str
    The space ID that is part of the Kibana URL when inside the space.
    color str
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    description str
    The description for the space.
    disabled_features Sequence[str]
    The list of disabled features for the space. To get a list of available feature IDs, use the Features API (https://www.elastic.co/guide/en/kibana/master/features-api-get.html).
    image_url str
    The data-URL encoded image to display in the space avatar.
    initials str
    The initials shown in the space avatar. By default, the initials are automatically generated from the space name. Initials must be 1 or 2 characters.
    name str
    The display name for the space.
    spaceId String
    The space ID that is part of the Kibana URL when inside the space.
    color String
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    description String
    The description for the space.
    disabledFeatures List<String>
    The list of disabled features for the space. To get a list of available feature IDs, use the Features API (https://www.elastic.co/guide/en/kibana/master/features-api-get.html).
    imageUrl String
    The data-URL encoded image to display in the space avatar.
    initials String
    The initials shown in the space avatar. By default, the initials are automatically generated from the space name. Initials must be 1 or 2 characters.
    name String
    The display name for the space.

    Outputs

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

    Get an existing KibanaSpace 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?: KibanaSpaceState, opts?: CustomResourceOptions): KibanaSpace
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        color: Optional[str] = None,
        description: Optional[str] = None,
        disabled_features: Optional[Sequence[str]] = None,
        image_url: Optional[str] = None,
        initials: Optional[str] = None,
        name: Optional[str] = None,
        space_id: Optional[str] = None) -> KibanaSpace
    func GetKibanaSpace(ctx *Context, name string, id IDInput, state *KibanaSpaceState, opts ...ResourceOption) (*KibanaSpace, error)
    public static KibanaSpace Get(string name, Input<string> id, KibanaSpaceState? state, CustomResourceOptions? opts = null)
    public static KibanaSpace get(String name, Output<String> id, KibanaSpaceState state, CustomResourceOptions options)
    resources:  _:    type: elasticstack:KibanaSpace    get:      id: ${id}
    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:
    Color string
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    Description string
    The description for the space.
    DisabledFeatures List<string>
    The list of disabled features for the space. To get a list of available feature IDs, use the Features API (https://www.elastic.co/guide/en/kibana/master/features-api-get.html).
    ImageUrl string
    The data-URL encoded image to display in the space avatar.
    Initials string
    The initials shown in the space avatar. By default, the initials are automatically generated from the space name. Initials must be 1 or 2 characters.
    Name string
    The display name for the space.
    SpaceId string
    The space ID that is part of the Kibana URL when inside the space.
    Color string
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    Description string
    The description for the space.
    DisabledFeatures []string
    The list of disabled features for the space. To get a list of available feature IDs, use the Features API (https://www.elastic.co/guide/en/kibana/master/features-api-get.html).
    ImageUrl string
    The data-URL encoded image to display in the space avatar.
    Initials string
    The initials shown in the space avatar. By default, the initials are automatically generated from the space name. Initials must be 1 or 2 characters.
    Name string
    The display name for the space.
    SpaceId string
    The space ID that is part of the Kibana URL when inside the space.
    color String
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    description String
    The description for the space.
    disabledFeatures List<String>
    The list of disabled features for the space. To get a list of available feature IDs, use the Features API (https://www.elastic.co/guide/en/kibana/master/features-api-get.html).
    imageUrl String
    The data-URL encoded image to display in the space avatar.
    initials String
    The initials shown in the space avatar. By default, the initials are automatically generated from the space name. Initials must be 1 or 2 characters.
    name String
    The display name for the space.
    spaceId String
    The space ID that is part of the Kibana URL when inside the space.
    color string
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    description string
    The description for the space.
    disabledFeatures string[]
    The list of disabled features for the space. To get a list of available feature IDs, use the Features API (https://www.elastic.co/guide/en/kibana/master/features-api-get.html).
    imageUrl string
    The data-URL encoded image to display in the space avatar.
    initials string
    The initials shown in the space avatar. By default, the initials are automatically generated from the space name. Initials must be 1 or 2 characters.
    name string
    The display name for the space.
    spaceId string
    The space ID that is part of the Kibana URL when inside the space.
    color str
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    description str
    The description for the space.
    disabled_features Sequence[str]
    The list of disabled features for the space. To get a list of available feature IDs, use the Features API (https://www.elastic.co/guide/en/kibana/master/features-api-get.html).
    image_url str
    The data-URL encoded image to display in the space avatar.
    initials str
    The initials shown in the space avatar. By default, the initials are automatically generated from the space name. Initials must be 1 or 2 characters.
    name str
    The display name for the space.
    space_id str
    The space ID that is part of the Kibana URL when inside the space.
    color String
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    description String
    The description for the space.
    disabledFeatures List<String>
    The list of disabled features for the space. To get a list of available feature IDs, use the Features API (https://www.elastic.co/guide/en/kibana/master/features-api-get.html).
    imageUrl String
    The data-URL encoded image to display in the space avatar.
    initials String
    The initials shown in the space avatar. By default, the initials are automatically generated from the space name. Initials must be 1 or 2 characters.
    name String
    The display name for the space.
    spaceId String
    The space ID that is part of the Kibana URL when inside the space.

    Import

    $ pulumi import elasticstack:index/kibanaSpace:KibanaSpace my_space <cluster_uuid>/<space id>

    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.
    elasticstack logo
    elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic
    elastic/terraform-provider-elasticstack