Manages a Kibana Exception List. Exception lists are containers for exception items used to prevent security rules from generating alerts.
See the Kibana Exceptions API documentation for more details.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as elasticstack from "@pulumi/elasticstack";
const endpoint = new elasticstack.KibanaSecurityExceptionList("endpoint", {
listId: "my-endpoint-exception-list",
name: "My Endpoint Exception List",
description: "List of endpoint exceptions",
type: "endpoint",
namespaceType: "agnostic",
osTypes: [
"linux",
"windows",
"macos",
],
tags: [
"endpoint",
"security",
],
});
import pulumi
import pulumi_elasticstack as elasticstack
endpoint = elasticstack.KibanaSecurityExceptionList("endpoint",
list_id="my-endpoint-exception-list",
name="My Endpoint Exception List",
description="List of endpoint exceptions",
type="endpoint",
namespace_type="agnostic",
os_types=[
"linux",
"windows",
"macos",
],
tags=[
"endpoint",
"security",
])
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.NewKibanaSecurityExceptionList(ctx, "endpoint", &elasticstack.KibanaSecurityExceptionListArgs{
ListId: pulumi.String("my-endpoint-exception-list"),
Name: pulumi.String("My Endpoint Exception List"),
Description: pulumi.String("List of endpoint exceptions"),
Type: pulumi.String("endpoint"),
NamespaceType: pulumi.String("agnostic"),
OsTypes: pulumi.StringArray{
pulumi.String("linux"),
pulumi.String("windows"),
pulumi.String("macos"),
},
Tags: pulumi.StringArray{
pulumi.String("endpoint"),
pulumi.String("security"),
},
})
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 endpoint = new Elasticstack.KibanaSecurityExceptionList("endpoint", new()
{
ListId = "my-endpoint-exception-list",
Name = "My Endpoint Exception List",
Description = "List of endpoint exceptions",
Type = "endpoint",
NamespaceType = "agnostic",
OsTypes = new[]
{
"linux",
"windows",
"macos",
},
Tags = new[]
{
"endpoint",
"security",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.KibanaSecurityExceptionList;
import com.pulumi.elasticstack.KibanaSecurityExceptionListArgs;
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 endpoint = new KibanaSecurityExceptionList("endpoint", KibanaSecurityExceptionListArgs.builder()
.listId("my-endpoint-exception-list")
.name("My Endpoint Exception List")
.description("List of endpoint exceptions")
.type("endpoint")
.namespaceType("agnostic")
.osTypes(
"linux",
"windows",
"macos")
.tags(
"endpoint",
"security")
.build());
}
}
resources:
endpoint:
type: elasticstack:KibanaSecurityExceptionList
properties:
listId: my-endpoint-exception-list
name: My Endpoint Exception List
description: List of endpoint exceptions
type: endpoint
namespaceType: agnostic
osTypes:
- linux
- windows
- macos
tags:
- endpoint
- security
Create KibanaSecurityExceptionList Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new KibanaSecurityExceptionList(name: string, args: KibanaSecurityExceptionListArgs, opts?: CustomResourceOptions);@overload
def KibanaSecurityExceptionList(resource_name: str,
args: KibanaSecurityExceptionListArgs,
opts: Optional[ResourceOptions] = None)
@overload
def KibanaSecurityExceptionList(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
type: Optional[str] = None,
list_id: Optional[str] = None,
meta: Optional[str] = None,
name: Optional[str] = None,
namespace_type: Optional[str] = None,
os_types: Optional[Sequence[str]] = None,
space_id: Optional[str] = None,
tags: Optional[Sequence[str]] = None)func NewKibanaSecurityExceptionList(ctx *Context, name string, args KibanaSecurityExceptionListArgs, opts ...ResourceOption) (*KibanaSecurityExceptionList, error)public KibanaSecurityExceptionList(string name, KibanaSecurityExceptionListArgs args, CustomResourceOptions? opts = null)
public KibanaSecurityExceptionList(String name, KibanaSecurityExceptionListArgs args)
public KibanaSecurityExceptionList(String name, KibanaSecurityExceptionListArgs args, CustomResourceOptions options)
type: elasticstack:KibanaSecurityExceptionList
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 KibanaSecurityExceptionListArgs
- 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 KibanaSecurityExceptionListArgs
- 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 KibanaSecurityExceptionListArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KibanaSecurityExceptionListArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args KibanaSecurityExceptionListArgs
- 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 kibanaSecurityExceptionListResource = new Elasticstack.KibanaSecurityExceptionList("kibanaSecurityExceptionListResource", new()
{
Description = "string",
Type = "string",
ListId = "string",
Meta = "string",
Name = "string",
NamespaceType = "string",
OsTypes = new[]
{
"string",
},
SpaceId = "string",
Tags = new[]
{
"string",
},
});
example, err := elasticstack.NewKibanaSecurityExceptionList(ctx, "kibanaSecurityExceptionListResource", &elasticstack.KibanaSecurityExceptionListArgs{
Description: pulumi.String("string"),
Type: pulumi.String("string"),
ListId: pulumi.String("string"),
Meta: pulumi.String("string"),
Name: pulumi.String("string"),
NamespaceType: pulumi.String("string"),
OsTypes: pulumi.StringArray{
pulumi.String("string"),
},
SpaceId: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
var kibanaSecurityExceptionListResource = new KibanaSecurityExceptionList("kibanaSecurityExceptionListResource", KibanaSecurityExceptionListArgs.builder()
.description("string")
.type("string")
.listId("string")
.meta("string")
.name("string")
.namespaceType("string")
.osTypes("string")
.spaceId("string")
.tags("string")
.build());
kibana_security_exception_list_resource = elasticstack.KibanaSecurityExceptionList("kibanaSecurityExceptionListResource",
description="string",
type="string",
list_id="string",
meta="string",
name="string",
namespace_type="string",
os_types=["string"],
space_id="string",
tags=["string"])
const kibanaSecurityExceptionListResource = new elasticstack.KibanaSecurityExceptionList("kibanaSecurityExceptionListResource", {
description: "string",
type: "string",
listId: "string",
meta: "string",
name: "string",
namespaceType: "string",
osTypes: ["string"],
spaceId: "string",
tags: ["string"],
});
type: elasticstack:KibanaSecurityExceptionList
properties:
description: string
listId: string
meta: string
name: string
namespaceType: string
osTypes:
- string
spaceId: string
tags:
- string
type: string
KibanaSecurityExceptionList 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 KibanaSecurityExceptionList resource accepts the following input properties:
- Description string
- Describes the exception list.
- Type string
- The type of exception list. Can be one of:
detection,endpoint,endpoint_trusted_apps,endpoint_events,endpoint_host_isolation_exceptions,endpoint_blocklists. - List
Id string - The exception list's human readable string identifier.
- Meta string
- Placeholder for metadata about the list container as JSON string.
- Name string
- The name of the exception list.
- Namespace
Type string - Determines whether the exception list is available in all Kibana spaces or just the space in which it is created. Can be
single(default) oragnostic. - Os
Types List<string> - Array of OS types for which the exceptions apply. Valid values:
linux,macos,windows. - Space
Id string - An identifier for the space. If space_id is not provided, the default space is used.
- List<string>
- String array containing words and phrases to help categorize exception containers.
- Description string
- Describes the exception list.
- Type string
- The type of exception list. Can be one of:
detection,endpoint,endpoint_trusted_apps,endpoint_events,endpoint_host_isolation_exceptions,endpoint_blocklists. - List
Id string - The exception list's human readable string identifier.
- Meta string
- Placeholder for metadata about the list container as JSON string.
- Name string
- The name of the exception list.
- Namespace
Type string - Determines whether the exception list is available in all Kibana spaces or just the space in which it is created. Can be
single(default) oragnostic. - Os
Types []string - Array of OS types for which the exceptions apply. Valid values:
linux,macos,windows. - Space
Id string - An identifier for the space. If space_id is not provided, the default space is used.
- []string
- String array containing words and phrases to help categorize exception containers.
- description String
- Describes the exception list.
- type String
- The type of exception list. Can be one of:
detection,endpoint,endpoint_trusted_apps,endpoint_events,endpoint_host_isolation_exceptions,endpoint_blocklists. - list
Id String - The exception list's human readable string identifier.
- meta String
- Placeholder for metadata about the list container as JSON string.
- name String
- The name of the exception list.
- namespace
Type String - Determines whether the exception list is available in all Kibana spaces or just the space in which it is created. Can be
single(default) oragnostic. - os
Types List<String> - Array of OS types for which the exceptions apply. Valid values:
linux,macos,windows. - space
Id String - An identifier for the space. If space_id is not provided, the default space is used.
- List<String>
- String array containing words and phrases to help categorize exception containers.
- description string
- Describes the exception list.
- type string
- The type of exception list. Can be one of:
detection,endpoint,endpoint_trusted_apps,endpoint_events,endpoint_host_isolation_exceptions,endpoint_blocklists. - list
Id string - The exception list's human readable string identifier.
- meta string
- Placeholder for metadata about the list container as JSON string.
- name string
- The name of the exception list.
- namespace
Type string - Determines whether the exception list is available in all Kibana spaces or just the space in which it is created. Can be
single(default) oragnostic. - os
Types string[] - Array of OS types for which the exceptions apply. Valid values:
linux,macos,windows. - space
Id string - An identifier for the space. If space_id is not provided, the default space is used.
- string[]
- String array containing words and phrases to help categorize exception containers.
- description str
- Describes the exception list.
- type str
- The type of exception list. Can be one of:
detection,endpoint,endpoint_trusted_apps,endpoint_events,endpoint_host_isolation_exceptions,endpoint_blocklists. - list_
id str - The exception list's human readable string identifier.
- meta str
- Placeholder for metadata about the list container as JSON string.
- name str
- The name of the exception list.
- namespace_
type str - Determines whether the exception list is available in all Kibana spaces or just the space in which it is created. Can be
single(default) oragnostic. - os_
types Sequence[str] - Array of OS types for which the exceptions apply. Valid values:
linux,macos,windows. - space_
id str - An identifier for the space. If space_id is not provided, the default space is used.
- Sequence[str]
- String array containing words and phrases to help categorize exception containers.
- description String
- Describes the exception list.
- type String
- The type of exception list. Can be one of:
detection,endpoint,endpoint_trusted_apps,endpoint_events,endpoint_host_isolation_exceptions,endpoint_blocklists. - list
Id String - The exception list's human readable string identifier.
- meta String
- Placeholder for metadata about the list container as JSON string.
- name String
- The name of the exception list.
- namespace
Type String - Determines whether the exception list is available in all Kibana spaces or just the space in which it is created. Can be
single(default) oragnostic. - os
Types List<String> - Array of OS types for which the exceptions apply. Valid values:
linux,macos,windows. - space
Id String - An identifier for the space. If space_id is not provided, the default space is used.
- List<String>
- String array containing words and phrases to help categorize exception containers.
Outputs
All input properties are implicitly available as output properties. Additionally, the KibanaSecurityExceptionList resource produces the following output properties:
- Created
At string - The timestamp of when the exception list was created.
- Created
By string - The user who created the exception list.
- Id string
- The provider-assigned unique ID for this managed resource.
- Immutable bool
- Whether the exception list is immutable.
- Tie
Breaker stringId - Field used in search to ensure all containers are sorted and returned correctly.
- Updated
At string - The timestamp of when the exception list was last updated.
- Updated
By string - The user who last updated the exception list.
- Created
At string - The timestamp of when the exception list was created.
- Created
By string - The user who created the exception list.
- Id string
- The provider-assigned unique ID for this managed resource.
- Immutable bool
- Whether the exception list is immutable.
- Tie
Breaker stringId - Field used in search to ensure all containers are sorted and returned correctly.
- Updated
At string - The timestamp of when the exception list was last updated.
- Updated
By string - The user who last updated the exception list.
- created
At String - The timestamp of when the exception list was created.
- created
By String - The user who created the exception list.
- id String
- The provider-assigned unique ID for this managed resource.
- immutable Boolean
- Whether the exception list is immutable.
- tie
Breaker StringId - Field used in search to ensure all containers are sorted and returned correctly.
- updated
At String - The timestamp of when the exception list was last updated.
- updated
By String - The user who last updated the exception list.
- created
At string - The timestamp of when the exception list was created.
- created
By string - The user who created the exception list.
- id string
- The provider-assigned unique ID for this managed resource.
- immutable boolean
- Whether the exception list is immutable.
- tie
Breaker stringId - Field used in search to ensure all containers are sorted and returned correctly.
- updated
At string - The timestamp of when the exception list was last updated.
- updated
By string - The user who last updated the exception list.
- created_
at str - The timestamp of when the exception list was created.
- created_
by str - The user who created the exception list.
- id str
- The provider-assigned unique ID for this managed resource.
- immutable bool
- Whether the exception list is immutable.
- tie_
breaker_ strid - Field used in search to ensure all containers are sorted and returned correctly.
- updated_
at str - The timestamp of when the exception list was last updated.
- updated_
by str - The user who last updated the exception list.
- created
At String - The timestamp of when the exception list was created.
- created
By String - The user who created the exception list.
- id String
- The provider-assigned unique ID for this managed resource.
- immutable Boolean
- Whether the exception list is immutable.
- tie
Breaker StringId - Field used in search to ensure all containers are sorted and returned correctly.
- updated
At String - The timestamp of when the exception list was last updated.
- updated
By String - The user who last updated the exception list.
Look up Existing KibanaSecurityExceptionList Resource
Get an existing KibanaSecurityExceptionList 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?: KibanaSecurityExceptionListState, opts?: CustomResourceOptions): KibanaSecurityExceptionList@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
created_at: Optional[str] = None,
created_by: Optional[str] = None,
description: Optional[str] = None,
immutable: Optional[bool] = None,
list_id: Optional[str] = None,
meta: Optional[str] = None,
name: Optional[str] = None,
namespace_type: Optional[str] = None,
os_types: Optional[Sequence[str]] = None,
space_id: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
tie_breaker_id: Optional[str] = None,
type: Optional[str] = None,
updated_at: Optional[str] = None,
updated_by: Optional[str] = None) -> KibanaSecurityExceptionListfunc GetKibanaSecurityExceptionList(ctx *Context, name string, id IDInput, state *KibanaSecurityExceptionListState, opts ...ResourceOption) (*KibanaSecurityExceptionList, error)public static KibanaSecurityExceptionList Get(string name, Input<string> id, KibanaSecurityExceptionListState? state, CustomResourceOptions? opts = null)public static KibanaSecurityExceptionList get(String name, Output<String> id, KibanaSecurityExceptionListState state, CustomResourceOptions options)resources: _: type: elasticstack:KibanaSecurityExceptionList 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.
- Created
At string - The timestamp of when the exception list was created.
- Created
By string - The user who created the exception list.
- Description string
- Describes the exception list.
- Immutable bool
- Whether the exception list is immutable.
- List
Id string - The exception list's human readable string identifier.
- Meta string
- Placeholder for metadata about the list container as JSON string.
- Name string
- The name of the exception list.
- Namespace
Type string - Determines whether the exception list is available in all Kibana spaces or just the space in which it is created. Can be
single(default) oragnostic. - Os
Types List<string> - Array of OS types for which the exceptions apply. Valid values:
linux,macos,windows. - Space
Id string - An identifier for the space. If space_id is not provided, the default space is used.
- List<string>
- String array containing words and phrases to help categorize exception containers.
- Tie
Breaker stringId - Field used in search to ensure all containers are sorted and returned correctly.
- Type string
- The type of exception list. Can be one of:
detection,endpoint,endpoint_trusted_apps,endpoint_events,endpoint_host_isolation_exceptions,endpoint_blocklists. - Updated
At string - The timestamp of when the exception list was last updated.
- Updated
By string - The user who last updated the exception list.
- Created
At string - The timestamp of when the exception list was created.
- Created
By string - The user who created the exception list.
- Description string
- Describes the exception list.
- Immutable bool
- Whether the exception list is immutable.
- List
Id string - The exception list's human readable string identifier.
- Meta string
- Placeholder for metadata about the list container as JSON string.
- Name string
- The name of the exception list.
- Namespace
Type string - Determines whether the exception list is available in all Kibana spaces or just the space in which it is created. Can be
single(default) oragnostic. - Os
Types []string - Array of OS types for which the exceptions apply. Valid values:
linux,macos,windows. - Space
Id string - An identifier for the space. If space_id is not provided, the default space is used.
- []string
- String array containing words and phrases to help categorize exception containers.
- Tie
Breaker stringId - Field used in search to ensure all containers are sorted and returned correctly.
- Type string
- The type of exception list. Can be one of:
detection,endpoint,endpoint_trusted_apps,endpoint_events,endpoint_host_isolation_exceptions,endpoint_blocklists. - Updated
At string - The timestamp of when the exception list was last updated.
- Updated
By string - The user who last updated the exception list.
- created
At String - The timestamp of when the exception list was created.
- created
By String - The user who created the exception list.
- description String
- Describes the exception list.
- immutable Boolean
- Whether the exception list is immutable.
- list
Id String - The exception list's human readable string identifier.
- meta String
- Placeholder for metadata about the list container as JSON string.
- name String
- The name of the exception list.
- namespace
Type String - Determines whether the exception list is available in all Kibana spaces or just the space in which it is created. Can be
single(default) oragnostic. - os
Types List<String> - Array of OS types for which the exceptions apply. Valid values:
linux,macos,windows. - space
Id String - An identifier for the space. If space_id is not provided, the default space is used.
- List<String>
- String array containing words and phrases to help categorize exception containers.
- tie
Breaker StringId - Field used in search to ensure all containers are sorted and returned correctly.
- type String
- The type of exception list. Can be one of:
detection,endpoint,endpoint_trusted_apps,endpoint_events,endpoint_host_isolation_exceptions,endpoint_blocklists. - updated
At String - The timestamp of when the exception list was last updated.
- updated
By String - The user who last updated the exception list.
- created
At string - The timestamp of when the exception list was created.
- created
By string - The user who created the exception list.
- description string
- Describes the exception list.
- immutable boolean
- Whether the exception list is immutable.
- list
Id string - The exception list's human readable string identifier.
- meta string
- Placeholder for metadata about the list container as JSON string.
- name string
- The name of the exception list.
- namespace
Type string - Determines whether the exception list is available in all Kibana spaces or just the space in which it is created. Can be
single(default) oragnostic. - os
Types string[] - Array of OS types for which the exceptions apply. Valid values:
linux,macos,windows. - space
Id string - An identifier for the space. If space_id is not provided, the default space is used.
- string[]
- String array containing words and phrases to help categorize exception containers.
- tie
Breaker stringId - Field used in search to ensure all containers are sorted and returned correctly.
- type string
- The type of exception list. Can be one of:
detection,endpoint,endpoint_trusted_apps,endpoint_events,endpoint_host_isolation_exceptions,endpoint_blocklists. - updated
At string - The timestamp of when the exception list was last updated.
- updated
By string - The user who last updated the exception list.
- created_
at str - The timestamp of when the exception list was created.
- created_
by str - The user who created the exception list.
- description str
- Describes the exception list.
- immutable bool
- Whether the exception list is immutable.
- list_
id str - The exception list's human readable string identifier.
- meta str
- Placeholder for metadata about the list container as JSON string.
- name str
- The name of the exception list.
- namespace_
type str - Determines whether the exception list is available in all Kibana spaces or just the space in which it is created. Can be
single(default) oragnostic. - os_
types Sequence[str] - Array of OS types for which the exceptions apply. Valid values:
linux,macos,windows. - space_
id str - An identifier for the space. If space_id is not provided, the default space is used.
- Sequence[str]
- String array containing words and phrases to help categorize exception containers.
- tie_
breaker_ strid - Field used in search to ensure all containers are sorted and returned correctly.
- type str
- The type of exception list. Can be one of:
detection,endpoint,endpoint_trusted_apps,endpoint_events,endpoint_host_isolation_exceptions,endpoint_blocklists. - updated_
at str - The timestamp of when the exception list was last updated.
- updated_
by str - The user who last updated the exception list.
- created
At String - The timestamp of when the exception list was created.
- created
By String - The user who created the exception list.
- description String
- Describes the exception list.
- immutable Boolean
- Whether the exception list is immutable.
- list
Id String - The exception list's human readable string identifier.
- meta String
- Placeholder for metadata about the list container as JSON string.
- name String
- The name of the exception list.
- namespace
Type String - Determines whether the exception list is available in all Kibana spaces or just the space in which it is created. Can be
single(default) oragnostic. - os
Types List<String> - Array of OS types for which the exceptions apply. Valid values:
linux,macos,windows. - space
Id String - An identifier for the space. If space_id is not provided, the default space is used.
- List<String>
- String array containing words and phrases to help categorize exception containers.
- tie
Breaker StringId - Field used in search to ensure all containers are sorted and returned correctly.
- type String
- The type of exception list. Can be one of:
detection,endpoint,endpoint_trusted_apps,endpoint_events,endpoint_host_isolation_exceptions,endpoint_blocklists. - updated
At String - The timestamp of when the exception list was last updated.
- updated
By String - The user who last updated the exception list.
Package Details
- Repository
- elasticstack elastic/terraform-provider-elasticstack
- License
- Notes
- This Pulumi package is based on the
elasticstackTerraform Provider.
