SoarDomain class

A SOAR domain designate a domain as internal, ensuring that entities associated with it are treated as organizational assets rather than external threats during ingestion.

> Warning: This resource is in beta, and should be used with the terraform-provider-google-beta provider. See Provider Versions for more details on beta resources.

To get more information about SoarDomain, see:

• API documentation
• How-to Guides
• Google SecOps Guides

Example Usage

Chronicle Soardomain Basic

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

const example = new gcp.chronicle.SoarDomain("example", {
    location: "us",
    instance: "00000000-0000-0000-0000-000000000000",
    displayName: "test.com",
    environmentsJson: "[\"Default Environment\"]",
});

import pulumi
import pulumi_gcp as gcp

example = gcp.chronicle.SoarDomain("example",
    location="us",
    instance="00000000-0000-0000-0000-000000000000",
    display_name="test.com",
    environments_json="[\"Default Environment\"]")

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

return await Deployment.RunAsync(() =>
{
    var example = new Gcp.Chronicle.SoarDomain("example", new()
    {
        Location = "us",
        Instance = "00000000-0000-0000-0000-000000000000",
        DisplayName = "test.com",
        EnvironmentsJson = "[\"Default Environment\"]",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/chronicle"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := chronicle.NewSoarDomain(ctx, "example", &chronicle.SoarDomainArgs{
			Location:         pulumi.String("us"),
			Instance:         pulumi.String("00000000-0000-0000-0000-000000000000"),
			DisplayName:      pulumi.String("test.com"),
			EnvironmentsJson: pulumi.String("[\"Default Environment\"]"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_chronicle_soardomain" "example" {
  location          = "us"
  instance          = "00000000-0000-0000-0000-000000000000"
  display_name      = "test.com"
  environments_json = "[\"Default Environment\"]"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.chronicle.SoarDomain;
import com.pulumi.gcp.chronicle.SoarDomainArgs;
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 SoarDomain("example", SoarDomainArgs.builder()
            .location("us")
            .instance("00000000-0000-0000-0000-000000000000")
            .displayName("test.com")
            .environmentsJson("[\"Default Environment\"]")
            .build());

    }
}

resources:
  example:
    type: gcp:chronicle:SoarDomain
    properties:
      location: us
      instance: 00000000-0000-0000-0000-000000000000
      displayName: test.com
      environmentsJson: '["Default Environment"]'

Import

SoarDomain can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/instances/{{instance}}/soarDomains/{{soar_domain_id}}
• {{project}}/{{location}}/{{instance}}/{{soar_domain_id}}
• {{location}}/{{instance}}/{{soar_domain_id}}

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

$ pulumi import gcp:chronicle/soarDomain:SoarDomain default projects/{{project}}/locations/{{location}}/instances/{{instance}}/soarDomains/{{soar_domain_id}}
$ pulumi import gcp:chronicle/soarDomain:SoarDomain default {{project}}/{{location}}/{{instance}}/{{soar_domain_id}}
$ pulumi import gcp:chronicle/soarDomain:SoarDomain default {{location}}/{{instance}}/{{soar_domain_id}}

Constructors

SoarDomain(String name, {SoarDomainArgs? args, CustomResourceOptions? options})

Creates a new SoarDomain. name The Pulumi resource name. args Arguments used to configure this SoarDomain. The set of arguments for SoarDomain. options Resource options controlling this resource's behavior.

SoarDomain.reference(String urn)

Creates a typed reference to an existing SoarDomain resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

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.

late, final

displayName ↔ Output<String>

SoarDomain display name, limited to 4096 characters.

late, final

environmentsJson ↔ Output<String>

SoarDomain associated logical environments (json).

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

instance ↔ Output<String>

Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

location ↔ Output<String>

Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.

late, final

name ↔ Output<String>

Identifier. The unique name(ID) of the SoarDomain. Format: projects/{project}/locations/{location}/instances/{instance}/soarDomains/{soar_domain_id}

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

soarDomainId ↔ Output<String>

Id of the domain record.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

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, {SoarDomainState? state, CustomResourceOptions? options}) → SoarDomain

Gets an existing SoarDomain resource's state with the given name and id.