EventThreatDetectionCustomModule class

Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, andlast updated time. You can create a custom module at the organization level only.

To get more information about EventThreatDetectionCustomModule, see:

API documentation
How-to Guides
Overview of custom modules for Event Threat Detection

Example Usage

Scc Event Threat Detection Custom Module

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

const example = new gcp.securitycenter.EventThreatDetectionCustomModule("example", {
    organization: "123456789",
    displayName: "basic_custom_module",
    enablementState: "ENABLED",
    type: "CONFIGURABLE_BAD_IP",
    description: "My Event Threat Detection Custom Module",
    config: JSON.stringify({
        metadata: {
            severity: "LOW",
            description: "Flagged by Forcepoint as malicious",
            recommendation: "Contact the owner of the relevant project.",
        },
        ips: [
            "192.0.2.1",
            "192.0.2.0/24",
        ],
    }),
});

import pulumi
import json
import pulumi_gcp as gcp

example = gcp.securitycenter.EventThreatDetectionCustomModule("example",
    organization="123456789",
    display_name="basic_custom_module",
    enablement_state="ENABLED",
    type="CONFIGURABLE_BAD_IP",
    description="My Event Threat Detection Custom Module",
    config=json.dumps({
        "metadata": {
            "severity": "LOW",
            "description": "Flagged by Forcepoint as malicious",
            "recommendation": "Contact the owner of the relevant project.",
        },
        "ips": [
            "192.0.2.1",
            "192.0.2.0/24",
        ],
    }))

using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var example = new Gcp.SecurityCenter.EventThreatDetectionCustomModule("example", new()
    {
        Organization = "123456789",
        DisplayName = "basic_custom_module",
        EnablementState = "ENABLED",
        Type = "CONFIGURABLE_BAD_IP",
        Description = "My Event Threat Detection Custom Module",
        Config = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["metadata"] = new Dictionary<string, object?>
            {
                ["severity"] = "LOW",
                ["description"] = "Flagged by Forcepoint as malicious",
                ["recommendation"] = "Contact the owner of the relevant project.",
            },
            ["ips"] = new[]
            {
                "192.0.2.1",
                "192.0.2.0/24",
            },
        }),
    });

});

package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/securitycenter"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"metadata": map[string]string{
				"severity":       "LOW",
				"description":    "Flagged by Forcepoint as malicious",
				"recommendation": "Contact the owner of the relevant project.",
			},
			"ips": []string{
				"192.0.2.1",
				"192.0.2.0/24",
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = securitycenter.NewEventThreatDetectionCustomModule(ctx, "example", &securitycenter.EventThreatDetectionCustomModuleArgs{
			Organization:    pulumi.String("123456789"),
			DisplayName:     pulumi.String("basic_custom_module"),
			EnablementState: pulumi.String("ENABLED"),
			Type:            pulumi.String("CONFIGURABLE_BAD_IP"),
			Description:     "My Event Threat Detection Custom Module",
			Config:          pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_securitycenter_eventthreatdetectioncustommodule" "example" {
  organization     = "123456789"
  display_name     = "basic_custom_module"
  enablement_state = "ENABLED"
  type             = "CONFIGURABLE_BAD_IP"
  description      = "My Event Threat Detection Custom Module"
  config = jsonencode({
    "metadata" = {
      "severity"       = "LOW"
      "description"    = "Flagged by Forcepoint as malicious"
      "recommendation" = "Contact the owner of the relevant project."
    }
    "ips" = ["192.0.2.1", "192.0.2.0/24"]
  })
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.securitycenter.EventThreatDetectionCustomModule;
import com.pulumi.gcp.securitycenter.EventThreatDetectionCustomModuleArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
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 EventThreatDetectionCustomModule("example", EventThreatDetectionCustomModuleArgs.builder()
            .organization("123456789")
            .displayName("basic_custom_module")
            .enablementState("ENABLED")
            .type("CONFIGURABLE_BAD_IP")
            .description("My Event Threat Detection Custom Module")
            .config(serializeJson(
                jsonObject(
                    jsonProperty("metadata", jsonObject(
                        jsonProperty("severity", "LOW"),
                        jsonProperty("description", "Flagged by Forcepoint as malicious"),
                        jsonProperty("recommendation", "Contact the owner of the relevant project.")
                    )),
                    jsonProperty("ips", jsonArray(
                        "192.0.2.1",
                        "192.0.2.0/24"
                    ))
                )))
            .build());

    }
}

resources:
  example:
    type: gcp:securitycenter:EventThreatDetectionCustomModule
    properties:
      organization: '123456789'
      displayName: basic_custom_module
      enablementState: ENABLED
      type: CONFIGURABLE_BAD_IP
      description: My Event Threat Detection Custom Module
      config:
        fn::toJSON:
          metadata:
            severity: LOW
            description: Flagged by Forcepoint as malicious
            recommendation: Contact the owner of the relevant project.
          ips:
            - 192.0.2.1
            - 192.0.2.0/24

Import

EventThreatDetectionCustomModule can be imported using any of these accepted formats:

organizations/{{organization}}/eventThreatDetectionSettings/customModules/{{name}}
{{organization}}/{{name}}

When using the pulumi import command, EventThreatDetectionCustomModule can be imported using one of the formats above. For example:

$ pulumi import gcp:securitycenter/eventThreatDetectionCustomModule:EventThreatDetectionCustomModule default organizations/{{organization}}/eventThreatDetectionSettings/customModules/{{name}}
$ pulumi import gcp:securitycenter/eventThreatDetectionCustomModule:EventThreatDetectionCustomModule default {{organization}}/{{name}}

Constructors

EventThreatDetectionCustomModule(String name, {EventThreatDetectionCustomModuleArgs? args, CustomResourceOptions? options}): Creates a new EventThreatDetectionCustomModule. name The Pulumi resource name. args Arguments used to configure this EventThreatDetectionCustomModule. The set of arguments for EventThreatDetectionCustomModule. options Resource options controlling this resource's behavior.
EventThreatDetectionCustomModule.reference(String urn): Creates a typed reference to an existing EventThreatDetectionCustomModule resource.

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
config ↔ Output<String>: Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
latefinal
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
displayName ↔ Output<String?>: The human readable name to be displayed for the module.
latefinal
enablementState ↔ Output<String>: The state of enablement for the module at the given level of the hierarchy. Possible values are: ENABLED, DISABLED.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
lastEditor ↔ Output<String>: The editor that last updated the custom module
latefinal
name ↔ Output<String>: The resource name of the Event Threat Detection custom module. Its format is "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}".
latefinal
organization ↔ Output<String>: Numerical ID of the parent organization.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
type ↔ Output<String>: Immutable. Type for the module. e.g. CONFIGURABLE_BAD_IP.
latefinal
updateTime ↔ Output<String>: The time at which the custom module was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
latefinal
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {EventThreatDetectionCustomModuleState? state, CustomResourceOptions? options}) → EventThreatDetectionCustomModule: Gets an existing EventThreatDetectionCustomModule resource's state with the given name and id.