Skip to content

azurermSentinelWatchlistItem

Manages a Sentinel Watchlist Item.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
new azurerm.provider.AzurermProvider(this, "azurerm", {
  features: [{}],
});
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
  this,
  "example",
  {
    location: "West Europe",
    name: "example-rg",
  }
);
const azurermLogAnalyticsWorkspaceExample =
  new azurerm.logAnalyticsWorkspace.LogAnalyticsWorkspace(this, "example_2", {
    location: azurermResourceGroupExample.location,
    name: "example-workspace",
    resource_group_name: azurermResourceGroupExample.name,
    sku: "PerGB2018",
  });
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermLogAnalyticsWorkspaceExample.overrideLogicalId("example");
const azurermSentinelLogAnalyticsWorkspaceOnboardingExample =
  new azurerm.sentinelLogAnalyticsWorkspaceOnboarding.SentinelLogAnalyticsWorkspaceOnboarding(
    this,
    "example_3",
    {
      workspace_id: azurermLogAnalyticsWorkspaceExample.id,
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermSentinelLogAnalyticsWorkspaceOnboardingExample.overrideLogicalId(
  "example"
);
const azurermSentinelWatchlistExample =
  new azurerm.sentinelWatchlist.SentinelWatchlist(this, "example_4", {
    display_name: "example-wl",
    item_search_key: "Key",
    log_analytics_workspace_id:
      azurermSentinelLogAnalyticsWorkspaceOnboardingExample.workspaceId,
    name: "example-watchlist",
  });
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermSentinelWatchlistExample.overrideLogicalId("example");
const azurermSentinelWatchlistItemExample =
  new azurerm.sentinelWatchlistItem.SentinelWatchlistItem(this, "example_5", {
    name: "0aac6fa5-223e-49cf-9bfd-3554dc9d2b76",
    properties: [
      {
        k1: "v1",
        k2: "v2",
      },
    ],
    watchlist_id: azurermSentinelWatchlistExample.id,
  });
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermSentinelWatchlistItemExample.overrideLogicalId("example");

Arguments Reference

The following arguments are supported:

  • watchlistId - (Required) The ID of the Sentinel Watchlist that this Item resides in. Changing this forces a new Sentinel Watchlist Item to be created.

  • properties - (Required) The key value pairs of the Sentinel Watchlist Item.


  • name - (Optional) The name in UUID format which should be used for this Sentinel Watchlist Item. Changing this forces a new Sentinel Watchlist Item to be created.

Attributes Reference

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the Sentinel Watchlist Item.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 30 minutes) Used when creating the Sentinel Watchlist Item.
  • read - (Defaults to 5 minutes) Used when retrieving the Sentinel Watchlist Item.
  • update - (Defaults to 30 minutes) Used when updating the Sentinel Watchlist Item.
  • delete - (Defaults to 30 minutes) Used when deleting the Sentinel Watchlist Item.

Import

Sentinel Watchlist Items can be imported using the resourceId, e.g.

terraform import azurerm_sentinel_watchlist_item.example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.OperationalInsights/workspaces/workspace1/providers/Microsoft.SecurityInsights/watchlists/list1/watchlistItems/item1