1. Packages
  2. Elasticstack Provider
  3. API Docs
  4. getKibanaSpaces
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic

elasticstack.getKibanaSpaces

Explore with Pulumi AI

elasticstack logo
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic

    Use this data source to retrieve and get information about all existing Kibana spaces.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as elasticstack from "@pulumi/elasticstack";
    
    const allSpaces = elasticstack.getKibanaSpaces({});
    
    import pulumi
    import pulumi_elasticstack as elasticstack
    
    all_spaces = elasticstack.get_kibana_spaces()
    
    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.GetKibanaSpaces(ctx, map[string]interface{}{}, nil)
    		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 allSpaces = Elasticstack.GetKibanaSpaces.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.elasticstack.ElasticstackFunctions;
    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) {
            final var allSpaces = ElasticstackFunctions.getKibanaSpaces();
    
        }
    }
    
    variables:
      allSpaces:
        fn::invoke:
          function: elasticstack:getKibanaSpaces
          arguments: {}
    

    Using getKibanaSpaces

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getKibanaSpaces(opts?: InvokeOptions): Promise<GetKibanaSpacesResult>
    function getKibanaSpacesOutput(opts?: InvokeOptions): Output<GetKibanaSpacesResult>
    def get_kibana_spaces(opts: Optional[InvokeOptions] = None) -> GetKibanaSpacesResult
    def get_kibana_spaces_output(opts: Optional[InvokeOptions] = None) -> Output[GetKibanaSpacesResult]
    func GetKibanaSpaces(ctx *Context, opts ...InvokeOption) (*GetKibanaSpacesResult, error)
    func GetKibanaSpacesOutput(ctx *Context, opts ...InvokeOption) GetKibanaSpacesResultOutput

    > Note: This function is named GetKibanaSpaces in the Go SDK.

    public static class GetKibanaSpaces 
    {
        public static Task<GetKibanaSpacesResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetKibanaSpacesResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetKibanaSpacesResult> getKibanaSpaces(InvokeOptions options)
    public static Output<GetKibanaSpacesResult> getKibanaSpaces(InvokeOptions options)
    
    fn::invoke:
      function: elasticstack:index/getKibanaSpaces:getKibanaSpaces
      arguments:
        # arguments dictionary

    getKibanaSpaces Result

    The following output properties are available:

    Id string
    Generated ID for the spaces.
    Spaces List<GetKibanaSpacesSpace>
    The list of spaces.
    Id string
    Generated ID for the spaces.
    Spaces []GetKibanaSpacesSpace
    The list of spaces.
    id String
    Generated ID for the spaces.
    spaces List<GetKibanaSpacesSpace>
    The list of spaces.
    id string
    Generated ID for the spaces.
    spaces GetKibanaSpacesSpace[]
    The list of spaces.
    id str
    Generated ID for the spaces.
    spaces Sequence[GetKibanaSpacesSpace]
    The list of spaces.
    id String
    Generated ID for the spaces.
    spaces List<Property Map>
    The list of spaces.

    Supporting Types

    GetKibanaSpacesSpace

    Color string
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    Id string
    Internal identifier of the resource.
    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.
    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.
    Color string
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    Id string
    Internal identifier of the resource.
    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.
    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.
    color String
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    id String
    Internal identifier of the resource.
    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.
    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.
    color string
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    id string
    Internal identifier of the resource.
    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.
    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.
    color str
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    id str
    Internal identifier of the resource.
    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.
    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.
    color String
    The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
    id String
    Internal identifier of the resource.
    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.
    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.

    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