SoarNetwork class

Manage networks in the platform using the Classless Inter-Domain Routing (CIDR) format. The system identifies network subnets to help Google Security Operations recognize internal assets and consider network sensitivity during playbook execution.

To get more information about SoarNetwork, see:

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

Example Usage

Chronicle Soarnetwork Basic

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

const sample = new gcp.chronicle.SoarNetwork("sample", {
    location: "us",
    instance: "00000000-0000-0000-0000-000000000000",
    displayName: "Internal",
    address: "192.168.1.0/24",
    environmentsJson: JSON.stringify(["*"]),
    priority: 1,
});

import pulumi
import json
import pulumi_gcp as gcp

sample = gcp.chronicle.SoarNetwork("sample",
    location="us",
    instance="00000000-0000-0000-0000-000000000000",
    display_name="Internal",
    address="192.168.1.0/24",
    environments_json=json.dumps(["*"]),
    priority=1)

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

return await Deployment.RunAsync(() =>
{
    var sample = new Gcp.Chronicle.SoarNetwork("sample", new()
    {
        Location = "us",
        Instance = "00000000-0000-0000-0000-000000000000",
        DisplayName = "Internal",
        Address = "192.168.1.0/24",
        EnvironmentsJson = JsonSerializer.Serialize(new[]
        {
            "*",
        }),
        Priority = 1,
    });

});

package main

import (
	"encoding/json"

	"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 {
		tmpJSON0, err := json.Marshal([]string{
			"*",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = chronicle.NewSoarNetwork(ctx, "sample", &chronicle.SoarNetworkArgs{
			Location:         pulumi.String("us"),
			Instance:         pulumi.String("00000000-0000-0000-0000-000000000000"),
			DisplayName:      pulumi.String("Internal"),
			Address:          pulumi.String("192.168.1.0/24"),
			EnvironmentsJson: pulumi.String(json0),
			Priority:         pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_chronicle_soarnetwork" "sample" {
  location          = "us"
  instance          = "00000000-0000-0000-0000-000000000000"
  display_name      = "Internal"
  address           = "192.168.1.0/24"
  environments_json = jsonencode(["*"])
  priority          = 1
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.chronicle.SoarNetwork;
import com.pulumi.gcp.chronicle.SoarNetworkArgs;
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 sample = new SoarNetwork("sample", SoarNetworkArgs.builder()
            .location("us")
            .instance("00000000-0000-0000-0000-000000000000")
            .displayName("Internal")
            .address("192.168.1.0/24")
            .environmentsJson(serializeJson(
                jsonArray("*")))
            .priority(1)
            .build());

    }
}

resources:
  sample:
    type: gcp:chronicle:SoarNetwork
    properties:
      location: us
      instance: 00000000-0000-0000-0000-000000000000
      displayName: Internal
      address: 192.168.1.0/24
      environmentsJson:
        fn::toJSON:
          - '*'
      priority: 1

Import

SoarNetwork can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/instances/{{instance}}/soarNetworks/{{soar_network_id}}
• {{project}}/{{location}}/{{instance}}/{{soar_network_id}}
• {{location}}/{{instance}}/{{soar_network_id}}

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

$ pulumi import gcp:chronicle/soarNetwork:SoarNetwork default projects/{{project}}/locations/{{location}}/instances/{{instance}}/soarNetworks/{{soar_network_id}}
$ pulumi import gcp:chronicle/soarNetwork:SoarNetwork default {{project}}/{{location}}/{{instance}}/{{soar_network_id}}
$ pulumi import gcp:chronicle/soarNetwork:SoarNetwork default {{location}}/{{instance}}/{{soar_network_id}}

Constructors

SoarNetwork(String name, {SoarNetworkArgs? args, CustomResourceOptions? options})

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

SoarNetwork.reference(String urn)

Creates a typed reference to an existing SoarNetwork resource.

Properties

address ↔ Output<String>

Subnet in CIDR format.

late, final

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>

SoarNetwork name, limited to 4096 characters.

late, final

environmentsJson ↔ Output<String>

SoarNetwork associated logical environments.

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 resource name of the SoarNetwork. Format: projects/{project}/locations/{location}/instances/{instance}/soarNetworks/{soar_network}

late, final

priority ↔ Output<int?>

SoarNetwork priority.

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

soarNetworkId ↔ Output<String>

Id of the soarNetwork 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, {SoarNetworkState? state, CustomResourceOptions? options}) → SoarNetwork

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