1. Packages
  2. Lacework Provider
  3. API Docs
  4. AlertChannelServiceNow
lacework 2.0.6 published on Monday, Apr 14, 2025 by lacework

lacework.AlertChannelServiceNow

Explore with Pulumi AI

lacework logo
lacework 2.0.6 published on Monday, Apr 14, 2025 by lacework

    You can configure Lacework to forward alerts to Service Now using the ServiceNow REST API.

    To find more information see the Lacework support documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as lacework from "@pulumi/lacework";
    
    const example = new lacework.AlertChannelServiceNow("example", {
        instanceUrl: "snow-lacework.com",
        password: "snow-pass",
        username: "snow-user",
    });
    
    import pulumi
    import pulumi_lacework as lacework
    
    example = lacework.AlertChannelServiceNow("example",
        instance_url="snow-lacework.com",
        password="snow-pass",
        username="snow-user")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/lacework/v2/lacework"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := lacework.NewAlertChannelServiceNow(ctx, "example", &lacework.AlertChannelServiceNowArgs{
    			InstanceUrl: pulumi.String("snow-lacework.com"),
    			Password:    pulumi.String("snow-pass"),
    			Username:    pulumi.String("snow-user"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Lacework = Pulumi.Lacework;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Lacework.AlertChannelServiceNow("example", new()
        {
            InstanceUrl = "snow-lacework.com",
            Password = "snow-pass",
            Username = "snow-user",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.lacework.AlertChannelServiceNow;
    import com.pulumi.lacework.AlertChannelServiceNowArgs;
    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 AlertChannelServiceNow("example", AlertChannelServiceNowArgs.builder()
                .instanceUrl("snow-lacework.com")
                .password("snow-pass")
                .username("snow-user")
                .build());
    
        }
    }
    
    resources:
      example:
        type: lacework:AlertChannelServiceNow
        properties:
          instanceUrl: snow-lacework.com
          password: snow-pass
          username: snow-user
    

    Create AlertChannelServiceNow Resource

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

    Constructor syntax

    new AlertChannelServiceNow(name: string, args: AlertChannelServiceNowArgs, opts?: CustomResourceOptions);
    @overload
    def AlertChannelServiceNow(resource_name: str,
                               args: AlertChannelServiceNowArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def AlertChannelServiceNow(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               instance_url: Optional[str] = None,
                               password: Optional[str] = None,
                               username: Optional[str] = None,
                               alert_channel_service_now_id: Optional[str] = None,
                               custom_template_file: Optional[str] = None,
                               enabled: Optional[bool] = None,
                               issue_grouping: Optional[str] = None,
                               name: Optional[str] = None,
                               test_integration: Optional[bool] = None)
    func NewAlertChannelServiceNow(ctx *Context, name string, args AlertChannelServiceNowArgs, opts ...ResourceOption) (*AlertChannelServiceNow, error)
    public AlertChannelServiceNow(string name, AlertChannelServiceNowArgs args, CustomResourceOptions? opts = null)
    public AlertChannelServiceNow(String name, AlertChannelServiceNowArgs args)
    public AlertChannelServiceNow(String name, AlertChannelServiceNowArgs args, CustomResourceOptions options)
    
    type: lacework:AlertChannelServiceNow
    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 AlertChannelServiceNowArgs
    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 AlertChannelServiceNowArgs
    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 AlertChannelServiceNowArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlertChannelServiceNowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlertChannelServiceNowArgs
    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 alertChannelServiceNowResource = new Lacework.AlertChannelServiceNow("alertChannelServiceNowResource", new()
    {
        InstanceUrl = "string",
        Password = "string",
        Username = "string",
        AlertChannelServiceNowId = "string",
        CustomTemplateFile = "string",
        Enabled = false,
        IssueGrouping = "string",
        Name = "string",
        TestIntegration = false,
    });
    
    example, err := lacework.NewAlertChannelServiceNow(ctx, "alertChannelServiceNowResource", &lacework.AlertChannelServiceNowArgs{
    	InstanceUrl:              pulumi.String("string"),
    	Password:                 pulumi.String("string"),
    	Username:                 pulumi.String("string"),
    	AlertChannelServiceNowId: pulumi.String("string"),
    	CustomTemplateFile:       pulumi.String("string"),
    	Enabled:                  pulumi.Bool(false),
    	IssueGrouping:            pulumi.String("string"),
    	Name:                     pulumi.String("string"),
    	TestIntegration:          pulumi.Bool(false),
    })
    
    var alertChannelServiceNowResource = new AlertChannelServiceNow("alertChannelServiceNowResource", AlertChannelServiceNowArgs.builder()
        .instanceUrl("string")
        .password("string")
        .username("string")
        .alertChannelServiceNowId("string")
        .customTemplateFile("string")
        .enabled(false)
        .issueGrouping("string")
        .name("string")
        .testIntegration(false)
        .build());
    
    alert_channel_service_now_resource = lacework.AlertChannelServiceNow("alertChannelServiceNowResource",
        instance_url="string",
        password="string",
        username="string",
        alert_channel_service_now_id="string",
        custom_template_file="string",
        enabled=False,
        issue_grouping="string",
        name="string",
        test_integration=False)
    
    const alertChannelServiceNowResource = new lacework.AlertChannelServiceNow("alertChannelServiceNowResource", {
        instanceUrl: "string",
        password: "string",
        username: "string",
        alertChannelServiceNowId: "string",
        customTemplateFile: "string",
        enabled: false,
        issueGrouping: "string",
        name: "string",
        testIntegration: false,
    });
    
    type: lacework:AlertChannelServiceNow
    properties:
        alertChannelServiceNowId: string
        customTemplateFile: string
        enabled: false
        instanceUrl: string
        issueGrouping: string
        name: string
        password: string
        testIntegration: false
        username: string
    

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

    InstanceUrl string
    The ServiceNow instance URL.
    Password string
    The ServiceNow password.
    Username string
    The ServiceNow user name.
    AlertChannelServiceNowId string
    CustomTemplateFile string
    Populate fields in the ServiceNow incident with values from a custom template JSON file.
    Enabled bool
    The state of the external integration. Defaults to true.
    IssueGrouping string
    Defines how Lacework compliance events get grouped. Must be one of Events or Resources. Defaults to Events.
    Name string
    The Alert Channel integration name.
    TestIntegration bool
    Whether to test the integration of an alert channel upon creation and modification
    InstanceUrl string
    The ServiceNow instance URL.
    Password string
    The ServiceNow password.
    Username string
    The ServiceNow user name.
    AlertChannelServiceNowId string
    CustomTemplateFile string
    Populate fields in the ServiceNow incident with values from a custom template JSON file.
    Enabled bool
    The state of the external integration. Defaults to true.
    IssueGrouping string
    Defines how Lacework compliance events get grouped. Must be one of Events or Resources. Defaults to Events.
    Name string
    The Alert Channel integration name.
    TestIntegration bool
    Whether to test the integration of an alert channel upon creation and modification
    instanceUrl String
    The ServiceNow instance URL.
    password String
    The ServiceNow password.
    username String
    The ServiceNow user name.
    alertChannelServiceNowId String
    customTemplateFile String
    Populate fields in the ServiceNow incident with values from a custom template JSON file.
    enabled Boolean
    The state of the external integration. Defaults to true.
    issueGrouping String
    Defines how Lacework compliance events get grouped. Must be one of Events or Resources. Defaults to Events.
    name String
    The Alert Channel integration name.
    testIntegration Boolean
    Whether to test the integration of an alert channel upon creation and modification
    instanceUrl string
    The ServiceNow instance URL.
    password string
    The ServiceNow password.
    username string
    The ServiceNow user name.
    alertChannelServiceNowId string
    customTemplateFile string
    Populate fields in the ServiceNow incident with values from a custom template JSON file.
    enabled boolean
    The state of the external integration. Defaults to true.
    issueGrouping string
    Defines how Lacework compliance events get grouped. Must be one of Events or Resources. Defaults to Events.
    name string
    The Alert Channel integration name.
    testIntegration boolean
    Whether to test the integration of an alert channel upon creation and modification
    instance_url str
    The ServiceNow instance URL.
    password str
    The ServiceNow password.
    username str
    The ServiceNow user name.
    alert_channel_service_now_id str
    custom_template_file str
    Populate fields in the ServiceNow incident with values from a custom template JSON file.
    enabled bool
    The state of the external integration. Defaults to true.
    issue_grouping str
    Defines how Lacework compliance events get grouped. Must be one of Events or Resources. Defaults to Events.
    name str
    The Alert Channel integration name.
    test_integration bool
    Whether to test the integration of an alert channel upon creation and modification
    instanceUrl String
    The ServiceNow instance URL.
    password String
    The ServiceNow password.
    username String
    The ServiceNow user name.
    alertChannelServiceNowId String
    customTemplateFile String
    Populate fields in the ServiceNow incident with values from a custom template JSON file.
    enabled Boolean
    The state of the external integration. Defaults to true.
    issueGrouping String
    Defines how Lacework compliance events get grouped. Must be one of Events or Resources. Defaults to Events.
    name String
    The Alert Channel integration name.
    testIntegration Boolean
    Whether to test the integration of an alert channel upon creation and modification

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AlertChannelServiceNow resource produces the following output properties:

    CreatedOrUpdatedBy string
    CreatedOrUpdatedTime string
    Id string
    The provider-assigned unique ID for this managed resource.
    IntgGuid string
    OrgLevel bool
    TypeName string
    CreatedOrUpdatedBy string
    CreatedOrUpdatedTime string
    Id string
    The provider-assigned unique ID for this managed resource.
    IntgGuid string
    OrgLevel bool
    TypeName string
    createdOrUpdatedBy String
    createdOrUpdatedTime String
    id String
    The provider-assigned unique ID for this managed resource.
    intgGuid String
    orgLevel Boolean
    typeName String
    createdOrUpdatedBy string
    createdOrUpdatedTime string
    id string
    The provider-assigned unique ID for this managed resource.
    intgGuid string
    orgLevel boolean
    typeName string
    created_or_updated_by str
    created_or_updated_time str
    id str
    The provider-assigned unique ID for this managed resource.
    intg_guid str
    org_level bool
    type_name str
    createdOrUpdatedBy String
    createdOrUpdatedTime String
    id String
    The provider-assigned unique ID for this managed resource.
    intgGuid String
    orgLevel Boolean
    typeName String

    Look up Existing AlertChannelServiceNow Resource

    Get an existing AlertChannelServiceNow 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?: AlertChannelServiceNowState, opts?: CustomResourceOptions): AlertChannelServiceNow
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alert_channel_service_now_id: Optional[str] = None,
            created_or_updated_by: Optional[str] = None,
            created_or_updated_time: Optional[str] = None,
            custom_template_file: Optional[str] = None,
            enabled: Optional[bool] = None,
            instance_url: Optional[str] = None,
            intg_guid: Optional[str] = None,
            issue_grouping: Optional[str] = None,
            name: Optional[str] = None,
            org_level: Optional[bool] = None,
            password: Optional[str] = None,
            test_integration: Optional[bool] = None,
            type_name: Optional[str] = None,
            username: Optional[str] = None) -> AlertChannelServiceNow
    func GetAlertChannelServiceNow(ctx *Context, name string, id IDInput, state *AlertChannelServiceNowState, opts ...ResourceOption) (*AlertChannelServiceNow, error)
    public static AlertChannelServiceNow Get(string name, Input<string> id, AlertChannelServiceNowState? state, CustomResourceOptions? opts = null)
    public static AlertChannelServiceNow get(String name, Output<String> id, AlertChannelServiceNowState state, CustomResourceOptions options)
    resources:  _:    type: lacework:AlertChannelServiceNow    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:
    AlertChannelServiceNowId string
    CreatedOrUpdatedBy string
    CreatedOrUpdatedTime string
    CustomTemplateFile string
    Populate fields in the ServiceNow incident with values from a custom template JSON file.
    Enabled bool
    The state of the external integration. Defaults to true.
    InstanceUrl string
    The ServiceNow instance URL.
    IntgGuid string
    IssueGrouping string
    Defines how Lacework compliance events get grouped. Must be one of Events or Resources. Defaults to Events.
    Name string
    The Alert Channel integration name.
    OrgLevel bool
    Password string
    The ServiceNow password.
    TestIntegration bool
    Whether to test the integration of an alert channel upon creation and modification
    TypeName string
    Username string
    The ServiceNow user name.
    AlertChannelServiceNowId string
    CreatedOrUpdatedBy string
    CreatedOrUpdatedTime string
    CustomTemplateFile string
    Populate fields in the ServiceNow incident with values from a custom template JSON file.
    Enabled bool
    The state of the external integration. Defaults to true.
    InstanceUrl string
    The ServiceNow instance URL.
    IntgGuid string
    IssueGrouping string
    Defines how Lacework compliance events get grouped. Must be one of Events or Resources. Defaults to Events.
    Name string
    The Alert Channel integration name.
    OrgLevel bool
    Password string
    The ServiceNow password.
    TestIntegration bool
    Whether to test the integration of an alert channel upon creation and modification
    TypeName string
    Username string
    The ServiceNow user name.
    alertChannelServiceNowId String
    createdOrUpdatedBy String
    createdOrUpdatedTime String
    customTemplateFile String
    Populate fields in the ServiceNow incident with values from a custom template JSON file.
    enabled Boolean
    The state of the external integration. Defaults to true.
    instanceUrl String
    The ServiceNow instance URL.
    intgGuid String
    issueGrouping String
    Defines how Lacework compliance events get grouped. Must be one of Events or Resources. Defaults to Events.
    name String
    The Alert Channel integration name.
    orgLevel Boolean
    password String
    The ServiceNow password.
    testIntegration Boolean
    Whether to test the integration of an alert channel upon creation and modification
    typeName String
    username String
    The ServiceNow user name.
    alertChannelServiceNowId string
    createdOrUpdatedBy string
    createdOrUpdatedTime string
    customTemplateFile string
    Populate fields in the ServiceNow incident with values from a custom template JSON file.
    enabled boolean
    The state of the external integration. Defaults to true.
    instanceUrl string
    The ServiceNow instance URL.
    intgGuid string
    issueGrouping string
    Defines how Lacework compliance events get grouped. Must be one of Events or Resources. Defaults to Events.
    name string
    The Alert Channel integration name.
    orgLevel boolean
    password string
    The ServiceNow password.
    testIntegration boolean
    Whether to test the integration of an alert channel upon creation and modification
    typeName string
    username string
    The ServiceNow user name.
    alert_channel_service_now_id str
    created_or_updated_by str
    created_or_updated_time str
    custom_template_file str
    Populate fields in the ServiceNow incident with values from a custom template JSON file.
    enabled bool
    The state of the external integration. Defaults to true.
    instance_url str
    The ServiceNow instance URL.
    intg_guid str
    issue_grouping str
    Defines how Lacework compliance events get grouped. Must be one of Events or Resources. Defaults to Events.
    name str
    The Alert Channel integration name.
    org_level bool
    password str
    The ServiceNow password.
    test_integration bool
    Whether to test the integration of an alert channel upon creation and modification
    type_name str
    username str
    The ServiceNow user name.
    alertChannelServiceNowId String
    createdOrUpdatedBy String
    createdOrUpdatedTime String
    customTemplateFile String
    Populate fields in the ServiceNow incident with values from a custom template JSON file.
    enabled Boolean
    The state of the external integration. Defaults to true.
    instanceUrl String
    The ServiceNow instance URL.
    intgGuid String
    issueGrouping String
    Defines how Lacework compliance events get grouped. Must be one of Events or Resources. Defaults to Events.
    name String
    The Alert Channel integration name.
    orgLevel Boolean
    password String
    The ServiceNow password.
    testIntegration Boolean
    Whether to test the integration of an alert channel upon creation and modification
    typeName String
    username String
    The ServiceNow user name.

    Import

    A Lacework Service Now Alert Channel integration can be imported using a INT_GUID, e.g.

    $ pulumi import lacework:index/alertChannelServiceNow:AlertChannelServiceNow ops_critical EXAMPLE_1234BAE1E42182964D23973F44CFEA3C4AB63B99E9A1EC5
    

    -> Note: To retrieve the INT_GUID from existing integrations in your account, use the Lacework CLI command lacework alert-channel list. To install this tool follow this documentation.

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

    Package Details

    Repository
    lacework lacework/terraform-provider-lacework
    License
    Notes
    This Pulumi package is based on the lacework Terraform Provider.
    lacework logo
    lacework 2.0.6 published on Monday, Apr 14, 2025 by lacework