1. Packages
  2. Packages
  3. Elasticstack Provider
  4. API Docs
  5. KibanaInstallPrebuiltRules
Viewing docs for elasticstack 0.15.0
published on Thursday, May 14, 2026 by elastic
Viewing docs for elasticstack 0.15.0
published on Thursday, May 14, 2026 by elastic

    Manages Elastic prebuilt detection rules. This resource installs and updates Elastic prebuilt rules and timelines. See https://www.elastic.co/guide/en/security/current/prebuilt-rules.html

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as elasticstack from "@pulumi/elasticstack";
    
    const example = new elasticstack.KibanaInstallPrebuiltRules("example", {spaceId: "default"});
    
    import pulumi
    import pulumi_elasticstack as elasticstack
    
    example = elasticstack.KibanaInstallPrebuiltRules("example", space_id="default")
    
    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.NewKibanaInstallPrebuiltRules(ctx, "example", &elasticstack.KibanaInstallPrebuiltRulesArgs{
    			SpaceId: pulumi.String("default"),
    		})
    		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.KibanaInstallPrebuiltRules("example", new()
        {
            SpaceId = "default",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.elasticstack.KibanaInstallPrebuiltRules;
    import com.pulumi.elasticstack.KibanaInstallPrebuiltRulesArgs;
    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 KibanaInstallPrebuiltRules("example", KibanaInstallPrebuiltRulesArgs.builder()
                .spaceId("default")
                .build());
    
        }
    }
    
    resources:
      example:
        type: elasticstack:KibanaInstallPrebuiltRules
        properties:
          spaceId: default
    
    Example coming soon!
    

    Create KibanaInstallPrebuiltRules Resource

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

    Constructor syntax

    new KibanaInstallPrebuiltRules(name: string, args?: KibanaInstallPrebuiltRulesArgs, opts?: CustomResourceOptions);
    @overload
    def KibanaInstallPrebuiltRules(resource_name: str,
                                   args: Optional[KibanaInstallPrebuiltRulesArgs] = None,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def KibanaInstallPrebuiltRules(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   kibana_connections: Optional[Sequence[KibanaInstallPrebuiltRulesKibanaConnectionArgs]] = None,
                                   space_id: Optional[str] = None)
    func NewKibanaInstallPrebuiltRules(ctx *Context, name string, args *KibanaInstallPrebuiltRulesArgs, opts ...ResourceOption) (*KibanaInstallPrebuiltRules, error)
    public KibanaInstallPrebuiltRules(string name, KibanaInstallPrebuiltRulesArgs? args = null, CustomResourceOptions? opts = null)
    public KibanaInstallPrebuiltRules(String name, KibanaInstallPrebuiltRulesArgs args)
    public KibanaInstallPrebuiltRules(String name, KibanaInstallPrebuiltRulesArgs args, CustomResourceOptions options)
    
    type: elasticstack:KibanaInstallPrebuiltRules
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "elasticstack_kibanainstallprebuiltrules" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args KibanaInstallPrebuiltRulesArgs
    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 KibanaInstallPrebuiltRulesArgs
    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 KibanaInstallPrebuiltRulesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KibanaInstallPrebuiltRulesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KibanaInstallPrebuiltRulesArgs
    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 kibanaInstallPrebuiltRulesResource = new Elasticstack.KibanaInstallPrebuiltRules("kibanaInstallPrebuiltRulesResource", new()
    {
        KibanaConnections = new[]
        {
            new Elasticstack.Inputs.KibanaInstallPrebuiltRulesKibanaConnectionArgs
            {
                ApiKey = "string",
                BearerToken = "string",
                CaCerts = new[]
                {
                    "string",
                },
                Endpoints = new[]
                {
                    "string",
                },
                Insecure = false,
                Password = "string",
                Username = "string",
            },
        },
        SpaceId = "string",
    });
    
    example, err := elasticstack.NewKibanaInstallPrebuiltRules(ctx, "kibanaInstallPrebuiltRulesResource", &elasticstack.KibanaInstallPrebuiltRulesArgs{
    	KibanaConnections: elasticstack.KibanaInstallPrebuiltRulesKibanaConnectionArray{
    		&elasticstack.KibanaInstallPrebuiltRulesKibanaConnectionArgs{
    			ApiKey:      pulumi.String("string"),
    			BearerToken: pulumi.String("string"),
    			CaCerts: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			Endpoints: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			Insecure: pulumi.Bool(false),
    			Password: pulumi.String("string"),
    			Username: pulumi.String("string"),
    		},
    	},
    	SpaceId: pulumi.String("string"),
    })
    
    resource "elasticstack_kibanainstallprebuiltrules" "kibanaInstallPrebuiltRulesResource" {
      kibana_connections {
        api_key      = "string"
        bearer_token = "string"
        ca_certs     = ["string"]
        endpoints    = ["string"]
        insecure     = false
        password     = "string"
        username     = "string"
      }
      space_id = "string"
    }
    
    var kibanaInstallPrebuiltRulesResource = new KibanaInstallPrebuiltRules("kibanaInstallPrebuiltRulesResource", KibanaInstallPrebuiltRulesArgs.builder()
        .kibanaConnections(KibanaInstallPrebuiltRulesKibanaConnectionArgs.builder()
            .apiKey("string")
            .bearerToken("string")
            .caCerts("string")
            .endpoints("string")
            .insecure(false)
            .password("string")
            .username("string")
            .build())
        .spaceId("string")
        .build());
    
    kibana_install_prebuilt_rules_resource = elasticstack.KibanaInstallPrebuiltRules("kibanaInstallPrebuiltRulesResource",
        kibana_connections=[{
            "api_key": "string",
            "bearer_token": "string",
            "ca_certs": ["string"],
            "endpoints": ["string"],
            "insecure": False,
            "password": "string",
            "username": "string",
        }],
        space_id="string")
    
    const kibanaInstallPrebuiltRulesResource = new elasticstack.KibanaInstallPrebuiltRules("kibanaInstallPrebuiltRulesResource", {
        kibanaConnections: [{
            apiKey: "string",
            bearerToken: "string",
            caCerts: ["string"],
            endpoints: ["string"],
            insecure: false,
            password: "string",
            username: "string",
        }],
        spaceId: "string",
    });
    
    type: elasticstack:KibanaInstallPrebuiltRules
    properties:
        kibanaConnections:
            - apiKey: string
              bearerToken: string
              caCerts:
                - string
              endpoints:
                - string
              insecure: false
              password: string
              username: string
        spaceId: string
    

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

    KibanaConnections List<KibanaInstallPrebuiltRulesKibanaConnection>
    Kibana connection configuration block.
    SpaceId string
    An identifier for the space. If space_id is not provided, the default space is used.
    KibanaConnections []KibanaInstallPrebuiltRulesKibanaConnectionArgs
    Kibana connection configuration block.
    SpaceId string
    An identifier for the space. If space_id is not provided, the default space is used.
    kibana_connections list(object)
    Kibana connection configuration block.
    space_id string
    An identifier for the space. If space_id is not provided, the default space is used.
    kibanaConnections List<KibanaInstallPrebuiltRulesKibanaConnection>
    Kibana connection configuration block.
    spaceId String
    An identifier for the space. If space_id is not provided, the default space is used.
    kibanaConnections KibanaInstallPrebuiltRulesKibanaConnection[]
    Kibana connection configuration block.
    spaceId string
    An identifier for the space. If space_id is not provided, the default space is used.
    kibana_connections Sequence[KibanaInstallPrebuiltRulesKibanaConnectionArgs]
    Kibana connection configuration block.
    space_id str
    An identifier for the space. If space_id is not provided, the default space is used.
    kibanaConnections List<Property Map>
    Kibana connection configuration block.
    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 KibanaInstallPrebuiltRules resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    RulesInstalled double
    Number of prebuilt rules that are installed.
    RulesNotInstalled double
    Number of prebuilt rules that are not installed.
    RulesNotUpdated double
    Number of prebuilt rules that have updates available.
    TimelinesInstalled double
    Number of prebuilt timelines that are installed.
    TimelinesNotInstalled double
    Number of prebuilt timelines that are not installed.
    TimelinesNotUpdated double
    Number of prebuilt timelines that have updates available.
    Id string
    The provider-assigned unique ID for this managed resource.
    RulesInstalled float64
    Number of prebuilt rules that are installed.
    RulesNotInstalled float64
    Number of prebuilt rules that are not installed.
    RulesNotUpdated float64
    Number of prebuilt rules that have updates available.
    TimelinesInstalled float64
    Number of prebuilt timelines that are installed.
    TimelinesNotInstalled float64
    Number of prebuilt timelines that are not installed.
    TimelinesNotUpdated float64
    Number of prebuilt timelines that have updates available.
    id string
    The provider-assigned unique ID for this managed resource.
    rules_installed number
    Number of prebuilt rules that are installed.
    rules_not_installed number
    Number of prebuilt rules that are not installed.
    rules_not_updated number
    Number of prebuilt rules that have updates available.
    timelines_installed number
    Number of prebuilt timelines that are installed.
    timelines_not_installed number
    Number of prebuilt timelines that are not installed.
    timelines_not_updated number
    Number of prebuilt timelines that have updates available.
    id String
    The provider-assigned unique ID for this managed resource.
    rulesInstalled Double
    Number of prebuilt rules that are installed.
    rulesNotInstalled Double
    Number of prebuilt rules that are not installed.
    rulesNotUpdated Double
    Number of prebuilt rules that have updates available.
    timelinesInstalled Double
    Number of prebuilt timelines that are installed.
    timelinesNotInstalled Double
    Number of prebuilt timelines that are not installed.
    timelinesNotUpdated Double
    Number of prebuilt timelines that have updates available.
    id string
    The provider-assigned unique ID for this managed resource.
    rulesInstalled number
    Number of prebuilt rules that are installed.
    rulesNotInstalled number
    Number of prebuilt rules that are not installed.
    rulesNotUpdated number
    Number of prebuilt rules that have updates available.
    timelinesInstalled number
    Number of prebuilt timelines that are installed.
    timelinesNotInstalled number
    Number of prebuilt timelines that are not installed.
    timelinesNotUpdated number
    Number of prebuilt timelines that have updates available.
    id str
    The provider-assigned unique ID for this managed resource.
    rules_installed float
    Number of prebuilt rules that are installed.
    rules_not_installed float
    Number of prebuilt rules that are not installed.
    rules_not_updated float
    Number of prebuilt rules that have updates available.
    timelines_installed float
    Number of prebuilt timelines that are installed.
    timelines_not_installed float
    Number of prebuilt timelines that are not installed.
    timelines_not_updated float
    Number of prebuilt timelines that have updates available.
    id String
    The provider-assigned unique ID for this managed resource.
    rulesInstalled Number
    Number of prebuilt rules that are installed.
    rulesNotInstalled Number
    Number of prebuilt rules that are not installed.
    rulesNotUpdated Number
    Number of prebuilt rules that have updates available.
    timelinesInstalled Number
    Number of prebuilt timelines that are installed.
    timelinesNotInstalled Number
    Number of prebuilt timelines that are not installed.
    timelinesNotUpdated Number
    Number of prebuilt timelines that have updates available.

    Look up Existing KibanaInstallPrebuiltRules Resource

    Get an existing KibanaInstallPrebuiltRules 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?: KibanaInstallPrebuiltRulesState, opts?: CustomResourceOptions): KibanaInstallPrebuiltRules
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            kibana_connections: Optional[Sequence[KibanaInstallPrebuiltRulesKibanaConnectionArgs]] = None,
            rules_installed: Optional[float] = None,
            rules_not_installed: Optional[float] = None,
            rules_not_updated: Optional[float] = None,
            space_id: Optional[str] = None,
            timelines_installed: Optional[float] = None,
            timelines_not_installed: Optional[float] = None,
            timelines_not_updated: Optional[float] = None) -> KibanaInstallPrebuiltRules
    func GetKibanaInstallPrebuiltRules(ctx *Context, name string, id IDInput, state *KibanaInstallPrebuiltRulesState, opts ...ResourceOption) (*KibanaInstallPrebuiltRules, error)
    public static KibanaInstallPrebuiltRules Get(string name, Input<string> id, KibanaInstallPrebuiltRulesState? state, CustomResourceOptions? opts = null)
    public static KibanaInstallPrebuiltRules get(String name, Output<String> id, KibanaInstallPrebuiltRulesState state, CustomResourceOptions options)
    resources:  _:    type: elasticstack:KibanaInstallPrebuiltRules    get:      id: ${id}
    import {
      to = elasticstack_kibanainstallprebuiltrules.example
      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:
    KibanaConnections List<KibanaInstallPrebuiltRulesKibanaConnection>
    Kibana connection configuration block.
    RulesInstalled double
    Number of prebuilt rules that are installed.
    RulesNotInstalled double
    Number of prebuilt rules that are not installed.
    RulesNotUpdated double
    Number of prebuilt rules that have updates available.
    SpaceId string
    An identifier for the space. If space_id is not provided, the default space is used.
    TimelinesInstalled double
    Number of prebuilt timelines that are installed.
    TimelinesNotInstalled double
    Number of prebuilt timelines that are not installed.
    TimelinesNotUpdated double
    Number of prebuilt timelines that have updates available.
    KibanaConnections []KibanaInstallPrebuiltRulesKibanaConnectionArgs
    Kibana connection configuration block.
    RulesInstalled float64
    Number of prebuilt rules that are installed.
    RulesNotInstalled float64
    Number of prebuilt rules that are not installed.
    RulesNotUpdated float64
    Number of prebuilt rules that have updates available.
    SpaceId string
    An identifier for the space. If space_id is not provided, the default space is used.
    TimelinesInstalled float64
    Number of prebuilt timelines that are installed.
    TimelinesNotInstalled float64
    Number of prebuilt timelines that are not installed.
    TimelinesNotUpdated float64
    Number of prebuilt timelines that have updates available.
    kibana_connections list(object)
    Kibana connection configuration block.
    rules_installed number
    Number of prebuilt rules that are installed.
    rules_not_installed number
    Number of prebuilt rules that are not installed.
    rules_not_updated number
    Number of prebuilt rules that have updates available.
    space_id string
    An identifier for the space. If space_id is not provided, the default space is used.
    timelines_installed number
    Number of prebuilt timelines that are installed.
    timelines_not_installed number
    Number of prebuilt timelines that are not installed.
    timelines_not_updated number
    Number of prebuilt timelines that have updates available.
    kibanaConnections List<KibanaInstallPrebuiltRulesKibanaConnection>
    Kibana connection configuration block.
    rulesInstalled Double
    Number of prebuilt rules that are installed.
    rulesNotInstalled Double
    Number of prebuilt rules that are not installed.
    rulesNotUpdated Double
    Number of prebuilt rules that have updates available.
    spaceId String
    An identifier for the space. If space_id is not provided, the default space is used.
    timelinesInstalled Double
    Number of prebuilt timelines that are installed.
    timelinesNotInstalled Double
    Number of prebuilt timelines that are not installed.
    timelinesNotUpdated Double
    Number of prebuilt timelines that have updates available.
    kibanaConnections KibanaInstallPrebuiltRulesKibanaConnection[]
    Kibana connection configuration block.
    rulesInstalled number
    Number of prebuilt rules that are installed.
    rulesNotInstalled number
    Number of prebuilt rules that are not installed.
    rulesNotUpdated number
    Number of prebuilt rules that have updates available.
    spaceId string
    An identifier for the space. If space_id is not provided, the default space is used.
    timelinesInstalled number
    Number of prebuilt timelines that are installed.
    timelinesNotInstalled number
    Number of prebuilt timelines that are not installed.
    timelinesNotUpdated number
    Number of prebuilt timelines that have updates available.
    kibana_connections Sequence[KibanaInstallPrebuiltRulesKibanaConnectionArgs]
    Kibana connection configuration block.
    rules_installed float
    Number of prebuilt rules that are installed.
    rules_not_installed float
    Number of prebuilt rules that are not installed.
    rules_not_updated float
    Number of prebuilt rules that have updates available.
    space_id str
    An identifier for the space. If space_id is not provided, the default space is used.
    timelines_installed float
    Number of prebuilt timelines that are installed.
    timelines_not_installed float
    Number of prebuilt timelines that are not installed.
    timelines_not_updated float
    Number of prebuilt timelines that have updates available.
    kibanaConnections List<Property Map>
    Kibana connection configuration block.
    rulesInstalled Number
    Number of prebuilt rules that are installed.
    rulesNotInstalled Number
    Number of prebuilt rules that are not installed.
    rulesNotUpdated Number
    Number of prebuilt rules that have updates available.
    spaceId String
    An identifier for the space. If space_id is not provided, the default space is used.
    timelinesInstalled Number
    Number of prebuilt timelines that are installed.
    timelinesNotInstalled Number
    Number of prebuilt timelines that are not installed.
    timelinesNotUpdated Number
    Number of prebuilt timelines that have updates available.

    Supporting Types

    KibanaInstallPrebuiltRulesKibanaConnection, KibanaInstallPrebuiltRulesKibanaConnectionArgs

    ApiKey string
    API Key to use for authentication to Kibana
    BearerToken string
    Bearer Token to use for authentication to Kibana
    CaCerts List<string>
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    Endpoints List<string>
    Insecure bool
    Disable TLS certificate validation
    Password string
    Password to use for API authentication to Kibana.
    Username string
    Username to use for API authentication to Kibana.
    ApiKey string
    API Key to use for authentication to Kibana
    BearerToken string
    Bearer Token to use for authentication to Kibana
    CaCerts []string
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    Endpoints []string
    Insecure bool
    Disable TLS certificate validation
    Password string
    Password to use for API authentication to Kibana.
    Username string
    Username to use for API authentication to Kibana.
    api_key string
    API Key to use for authentication to Kibana
    bearer_token string
    Bearer Token to use for authentication to Kibana
    ca_certs list(string)
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    endpoints list(string)
    insecure bool
    Disable TLS certificate validation
    password string
    Password to use for API authentication to Kibana.
    username string
    Username to use for API authentication to Kibana.
    apiKey String
    API Key to use for authentication to Kibana
    bearerToken String
    Bearer Token to use for authentication to Kibana
    caCerts List<String>
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    endpoints List<String>
    insecure Boolean
    Disable TLS certificate validation
    password String
    Password to use for API authentication to Kibana.
    username String
    Username to use for API authentication to Kibana.
    apiKey string
    API Key to use for authentication to Kibana
    bearerToken string
    Bearer Token to use for authentication to Kibana
    caCerts string[]
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    endpoints string[]
    insecure boolean
    Disable TLS certificate validation
    password string
    Password to use for API authentication to Kibana.
    username string
    Username to use for API authentication to Kibana.
    api_key str
    API Key to use for authentication to Kibana
    bearer_token str
    Bearer Token to use for authentication to Kibana
    ca_certs Sequence[str]
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    endpoints Sequence[str]
    insecure bool
    Disable TLS certificate validation
    password str
    Password to use for API authentication to Kibana.
    username str
    Username to use for API authentication to Kibana.
    apiKey String
    API Key to use for authentication to Kibana
    bearerToken String
    Bearer Token to use for authentication to Kibana
    caCerts List<String>
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    endpoints List<String>
    insecure Boolean
    Disable TLS certificate validation
    password String
    Password to use for API authentication to Kibana.
    username String
    Username to use for API authentication to Kibana.

    Package Details

    Repository
    elasticstack elastic/terraform-provider-elasticstack
    License
    Notes
    This Pulumi package is based on the elasticstack Terraform Provider.
    Viewing docs for elasticstack 0.15.0
    published on Thursday, May 14, 2026 by elastic
      Try Pulumi Cloud free. Your team will thank you.