Environment class

An environment is logical container for different networks or customers that are managed by the SOC or MSSP. This is useful for SOCs who provide services to several different networks, customers or business units within the organization. The Platform comes with a predefined environment named Default Environment.

To get more information about Environment, see:

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

Example Usage

Chronicle Environment Basic

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

const sample = new gcp.chronicle.Environment("sample", {
    location: "us",
    instance: "00000000-0000-0000-0000-000000000000",
    displayName: "MyEnvironment",
    description: "MyEnvironment is managed with Terraform",
    contact: "Contact",
    contactEmails: "[e-mail]",
    contactPhone: "00000",
    aliasesJson: JSON.stringify([]),
    dataAccessScopesJson: JSON.stringify([]),
    retentionDuration: 3,
    deletionProtection: false,
});

import pulumi
import json
import pulumi_gcp as gcp

sample = gcp.chronicle.Environment("sample",
    location="us",
    instance="00000000-0000-0000-0000-000000000000",
    display_name="MyEnvironment",
    description="MyEnvironment is managed with Terraform",
    contact="Contact",
    contact_emails="[e-mail]",
    contact_phone="00000",
    aliases_json=json.dumps([]),
    data_access_scopes_json=json.dumps([]),
    retention_duration=3,
    deletion_protection=False)

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.Environment("sample", new()
    {
        Location = "us",
        Instance = "00000000-0000-0000-0000-000000000000",
        DisplayName = "MyEnvironment",
        Description = "MyEnvironment is managed with Terraform",
        Contact = "Contact",
        ContactEmails = "[e-mail]",
        ContactPhone = "00000",
        AliasesJson = JsonSerializer.Serialize(new[]
        {
        }),
        DataAccessScopesJson = JsonSerializer.Serialize(new[]
        {
        }),
        RetentionDuration = 3,
        DeletionProtection = false,
    });

});

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([]interface{}{})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		tmpJSON1, err := json.Marshal([]interface{}{})
		if err != nil {
			return err
		}
		json1 := string(tmpJSON1)
		_, err = chronicle.NewEnvironment(ctx, "sample", &chronicle.EnvironmentArgs{
			Location:             pulumi.String("us"),
			Instance:             pulumi.String("00000000-0000-0000-0000-000000000000"),
			DisplayName:          pulumi.String("MyEnvironment"),
			Description:          pulumi.String("MyEnvironment is managed with Terraform"),
			Contact:              pulumi.String("Contact"),
			ContactEmails:        pulumi.String("[e-mail]"),
			ContactPhone:         pulumi.String("00000"),
			AliasesJson:          pulumi.String(json0),
			DataAccessScopesJson: pulumi.String(json1),
			RetentionDuration:    pulumi.Int(3),
			DeletionProtection:   pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_chronicle_environment" "sample" {
  location                = "us"
  instance                = "00000000-0000-0000-0000-000000000000"
  display_name            = "MyEnvironment"
  description             = "MyEnvironment is managed with Terraform"
  contact                 = "Contact"
  contact_emails          = "[e-mail]"
  contact_phone           = "00000"
  aliases_json            = jsonencode([])
  data_access_scopes_json = jsonencode([])
  retention_duration      = 3
  deletion_protection     = false
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.chronicle.Environment;
import com.pulumi.gcp.chronicle.EnvironmentArgs;
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 Environment("sample", EnvironmentArgs.builder()
            .location("us")
            .instance("00000000-0000-0000-0000-000000000000")
            .displayName("MyEnvironment")
            .description("MyEnvironment is managed with Terraform")
            .contact("Contact")
            .contactEmails("[e-mail]")
            .contactPhone("00000")
            .aliasesJson(serializeJson(
                jsonArray(
                )))
            .dataAccessScopesJson(serializeJson(
                jsonArray(
                )))
            .retentionDuration(3)
            .deletionProtection(false)
            .build());

    }
}

resources:
  sample:
    type: gcp:chronicle:Environment
    properties:
      location: us
      instance: 00000000-0000-0000-0000-000000000000
      displayName: MyEnvironment
      description: MyEnvironment is managed with Terraform
      contact: Contact
      contactEmails: [e-mail]
      contactPhone: '00000'
      aliasesJson:
        fn::toJSON: []
      dataAccessScopesJson:
        fn::toJSON: []
      retentionDuration: 3
      deletionProtection: false

Import

Environment can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/instances/{{instance}}/environments/{{environment_id}}
• {{project}}/{{location}}/{{instance}}/{{environment_id}}
• {{location}}/{{instance}}/{{environment_id}}

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

$ pulumi import gcp:chronicle/environment:Environment default projects/{{project}}/locations/{{location}}/instances/{{instance}}/environments/{{environment_id}}
$ pulumi import gcp:chronicle/environment:Environment default {{project}}/{{location}}/{{instance}}/{{environment_id}}
$ pulumi import gcp:chronicle/environment:Environment default {{location}}/{{instance}}/{{environment_id}}

Constructors

Environment(String name, {EnvironmentArgs? args, CustomResourceOptions? options})

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

Environment.reference(String urn)

Creates a typed reference to an existing Environment resource.

Properties

aliasesJson ↔ Output<String?>

Environment nicknames.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

contact ↔ Output<String>

MAX_NAME_LENGTH = 256 Name of the contact for the environment.

late, final

contactEmails ↔ Output<String>

MAX_NAME_LENGTH = 256 Email of the contact for the environment. Multiple emails can be sepereated with the ; character.

late, final

contactPhone ↔ Output<String>

MAX_NAME_LENGTH = 256 Phone number of the contact for the environment.

late, final

dataAccessScopesJson ↔ Output<String?>

data access scopes.

late, final

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

deletionProtection ↔ Output<bool?>

Whether Terraform will be prevented from destroying the environment. Deleting an environment will remove all its data and all playbooks, environments, integrations instances, reports and agents related to the environment. Once you delete an environment, it cannot be reversed. Deleting environments via terraform destroy or pulumi up will only succeed if this field is false in the Terraform state.

late, final

description ↔ Output<String>

MAX_NAME_LENGTH = 256 Description of the environment.

late, final

displayName ↔ Output<String>

Name of the environment MAX_NAME_LENGTH = 256

late, final

environmentId ↔ Output<String>

Id of the environment record.

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 Environment. Format: projects/{project}/locations/{location}/instances/{instance}/environments/{environment}

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

retentionDuration ↔ Output<int>

Environment data retention in months.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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

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