Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Lacework Provider
  3. API Docs
  4. AlertChannelEmail
lacework 2.0.6 published on Monday, Apr 14, 2025 by lacework
lacework/terraform-provider-lacework

lacework.AlertChannelEmail

Explore with Pulumi AI

lacework logo
lacework 2.0.6 published on Monday, Apr 14, 2025 by lacework
lacework/terraform-provider-lacework

    Lacework can generate and send alert summaries and reports to email addresses using an email alert channel. By default, Lacework creates a single email alert channel during the initial Lacework onboarding process and new members are added automatically. The default channel cannot be edited. You can add more email alert channels.

    To find more information about the Email alert channel integration, see the Lacework support documentation.

    Example Usage

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

const auditors = new lacework.AlertChannelEmail("auditors", {recipients: [
    "my@example.com",
    "alias@example.com",
]});

    import pulumi
import pulumi_lacework as lacework

auditors = lacework.AlertChannelEmail("auditors", recipients=[
    "my@example.com",
    "alias@example.com",
])

    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.NewAlertChannelEmail(ctx, "auditors", &lacework.AlertChannelEmailArgs{
			Recipients: pulumi.StringArray{
				pulumi.String("my@example.com"),
				pulumi.String("alias@example.com"),
			},
		})
		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 auditors = new Lacework.AlertChannelEmail("auditors", new()
    {
        Recipients = new[]
        {
            "my@example.com",
            "alias@example.com",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.lacework.AlertChannelEmail;
import com.pulumi.lacework.AlertChannelEmailArgs;
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 auditors = new AlertChannelEmail("auditors", AlertChannelEmailArgs.builder()
            .recipients(            
                "my@example.com",
                "alias@example.com")
            .build());

    }
}

    resources:
  auditors:
    type: lacework:AlertChannelEmail
    properties:
      recipients:
        - my@example.com
        - alias@example.com

    Create AlertChannelEmail Resource

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

    Constructor syntax

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

@overload
def AlertChannelEmail(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      recipients: Optional[Sequence[str]] = None,
                      alert_channel_email_id: Optional[str] = None,
                      enabled: Optional[bool] = None,
                      name: Optional[str] = None,
                      test_integration: Optional[bool] = None)
    func NewAlertChannelEmail(ctx *Context, name string, args AlertChannelEmailArgs, opts ...ResourceOption) (*AlertChannelEmail, error)
    public AlertChannelEmail(string name, AlertChannelEmailArgs args, CustomResourceOptions? opts = null)
    public AlertChannelEmail(String name, AlertChannelEmailArgs args)
public AlertChannelEmail(String name, AlertChannelEmailArgs args, CustomResourceOptions options)

    type: lacework:AlertChannelEmail
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 AlertChannelEmailArgs
    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 AlertChannelEmailArgs
    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 AlertChannelEmailArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlertChannelEmailArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlertChannelEmailArgs
    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 alertChannelEmailResource = new Lacework.AlertChannelEmail("alertChannelEmailResource", new()
{
    Recipients = new[]
    {
        "string",
    },
    AlertChannelEmailId = "string",
    Enabled = false,
    Name = "string",
    TestIntegration = false,
});

    example, err := lacework.NewAlertChannelEmail(ctx, "alertChannelEmailResource", &lacework.AlertChannelEmailArgs{
	Recipients: pulumi.StringArray{
		pulumi.String("string"),
	},
	AlertChannelEmailId: pulumi.String("string"),
	Enabled:             pulumi.Bool(false),
	Name:                pulumi.String("string"),
	TestIntegration:     pulumi.Bool(false),
})

    var alertChannelEmailResource = new AlertChannelEmail("alertChannelEmailResource", AlertChannelEmailArgs.builder()
    .recipients("string")
    .alertChannelEmailId("string")
    .enabled(false)
    .name("string")
    .testIntegration(false)
    .build());

    alert_channel_email_resource = lacework.AlertChannelEmail("alertChannelEmailResource",
    recipients=["string"],
    alert_channel_email_id="string",
    enabled=False,
    name="string",
    test_integration=False)

    const alertChannelEmailResource = new lacework.AlertChannelEmail("alertChannelEmailResource", {
    recipients: ["string"],
    alertChannelEmailId: "string",
    enabled: false,
    name: "string",
    testIntegration: false,
});

    type: lacework:AlertChannelEmail
properties:
    alertChannelEmailId: string
    enabled: false
    name: string
    recipients:
        - string
    testIntegration: false

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

    Recipients List<string>
    The list of email addresses that you want to receive the alerts.
    AlertChannelEmailId string
    Enabled bool
    The state of the external integration. Defaults to true.
    Name string
    The Alert Channel integration name.
    TestIntegration bool
    Whether to test the integration of an alert channel upon creation and modification
    Recipients []string
    The list of email addresses that you want to receive the alerts.
    AlertChannelEmailId string
    Enabled bool
    The state of the external integration. Defaults to true.
    Name string
    The Alert Channel integration name.
    TestIntegration bool
    Whether to test the integration of an alert channel upon creation and modification
    recipients List<String>
    The list of email addresses that you want to receive the alerts.
    alertChannelEmailId String
    enabled Boolean
    The state of the external integration. Defaults to true.
    name String
    The Alert Channel integration name.
    testIntegration Boolean
    Whether to test the integration of an alert channel upon creation and modification
    recipients string[]
    The list of email addresses that you want to receive the alerts.
    alertChannelEmailId string
    enabled boolean
    The state of the external integration. Defaults to true.
    name string
    The Alert Channel integration name.
    testIntegration boolean
    Whether to test the integration of an alert channel upon creation and modification
    recipients Sequence[str]
    The list of email addresses that you want to receive the alerts.
    alert_channel_email_id str
    enabled bool
    The state of the external integration. Defaults to true.
    name str
    The Alert Channel integration name.
    test_integration bool
    Whether to test the integration of an alert channel upon creation and modification
    recipients List<String>
    The list of email addresses that you want to receive the alerts.
    alertChannelEmailId String
    enabled Boolean
    The state of the external integration. Defaults to true.
    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 AlertChannelEmail 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 AlertChannelEmail Resource

    Get an existing AlertChannelEmail 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?: AlertChannelEmailState, opts?: CustomResourceOptions): AlertChannelEmail
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alert_channel_email_id: Optional[str] = None,
        created_or_updated_by: Optional[str] = None,
        created_or_updated_time: Optional[str] = None,
        enabled: Optional[bool] = None,
        intg_guid: Optional[str] = None,
        name: Optional[str] = None,
        org_level: Optional[bool] = None,
        recipients: Optional[Sequence[str]] = None,
        test_integration: Optional[bool] = None,
        type_name: Optional[str] = None) -> AlertChannelEmail
    func GetAlertChannelEmail(ctx *Context, name string, id IDInput, state *AlertChannelEmailState, opts ...ResourceOption) (*AlertChannelEmail, error)
    public static AlertChannelEmail Get(string name, Input<string> id, AlertChannelEmailState? state, CustomResourceOptions? opts = null)
    public static AlertChannelEmail get(String name, Output<String> id, AlertChannelEmailState state, CustomResourceOptions options)
    resources:  _:    type: lacework:AlertChannelEmail    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:
    AlertChannelEmailId string
    CreatedOrUpdatedBy string
    CreatedOrUpdatedTime string
    Enabled bool
    The state of the external integration. Defaults to true.
    IntgGuid string
    Name string
    The Alert Channel integration name.
    OrgLevel bool
    Recipients List<string>
    The list of email addresses that you want to receive the alerts.
    TestIntegration bool
    Whether to test the integration of an alert channel upon creation and modification
    TypeName string
    AlertChannelEmailId string
    CreatedOrUpdatedBy string
    CreatedOrUpdatedTime string
    Enabled bool
    The state of the external integration. Defaults to true.
    IntgGuid string
    Name string
    The Alert Channel integration name.
    OrgLevel bool
    Recipients []string
    The list of email addresses that you want to receive the alerts.
    TestIntegration bool
    Whether to test the integration of an alert channel upon creation and modification
    TypeName string
    alertChannelEmailId String
    createdOrUpdatedBy String
    createdOrUpdatedTime String
    enabled Boolean
    The state of the external integration. Defaults to true.
    intgGuid String
    name String
    The Alert Channel integration name.
    orgLevel Boolean
    recipients List<String>
    The list of email addresses that you want to receive the alerts.
    testIntegration Boolean
    Whether to test the integration of an alert channel upon creation and modification
    typeName String
    alertChannelEmailId string
    createdOrUpdatedBy string
    createdOrUpdatedTime string
    enabled boolean
    The state of the external integration. Defaults to true.
    intgGuid string
    name string
    The Alert Channel integration name.
    orgLevel boolean
    recipients string[]
    The list of email addresses that you want to receive the alerts.
    testIntegration boolean
    Whether to test the integration of an alert channel upon creation and modification
    typeName string
    alert_channel_email_id str
    created_or_updated_by str
    created_or_updated_time str
    enabled bool
    The state of the external integration. Defaults to true.
    intg_guid str
    name str
    The Alert Channel integration name.
    org_level bool
    recipients Sequence[str]
    The list of email addresses that you want to receive the alerts.
    test_integration bool
    Whether to test the integration of an alert channel upon creation and modification
    type_name str
    alertChannelEmailId String
    createdOrUpdatedBy String
    createdOrUpdatedTime String
    enabled Boolean
    The state of the external integration. Defaults to true.
    intgGuid String
    name String
    The Alert Channel integration name.
    orgLevel Boolean
    recipients List<String>
    The list of email addresses that you want to receive the alerts.
    testIntegration Boolean
    Whether to test the integration of an alert channel upon creation and modification
    typeName String

    Import

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

    $ pulumi import lacework:index/alertChannelEmail:AlertChannelEmail auditors 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
    lacework/terraform-provider-lacework