Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Google Cloud (GCP) Classic
  4. API Docs
  5. chronicle
  6. Environment
Viewing docs for Google Cloud v9.28.0
published on Monday, Jun 22, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

gcp.chronicle.Environment

gcp logo
Viewing docs for Google Cloud v9.28.0
published on Monday, Jun 22, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

    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.

    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 Environment, see:

    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: "example@example.com",
    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="example@example.com",
    contact_phone="00000",
    aliases_json=json.dumps([]),
    data_access_scopes_json=json.dumps([]),
    retention_duration=3,
    deletion_protection=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("example@example.com"),
			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
	})
}

    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 = "example@example.com",
        ContactPhone = "00000",
        AliasesJson = JsonSerializer.Serialize(new[]
        {
        }),
        DataAccessScopesJson = JsonSerializer.Serialize(new[]
        {
        }),
        RetentionDuration = 3,
        DeletionProtection = 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("example@example.com")
            .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: example@example.com
      contactPhone: '00000'
      aliasesJson:
        fn::toJSON: []
      dataAccessScopesJson:
        fn::toJSON: []
      retentionDuration: 3
      deletionProtection: false

    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          = "example@example.com"
  contact_phone           = "00000"
  aliases_json            = jsonencode([])
  data_access_scopes_json = jsonencode([])
  retention_duration      = 3
  deletion_protection     = false
}

    Create Environment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);
    @overload
def Environment(resource_name: str,
                args: EnvironmentArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                instance: Optional[str] = None,
                contact: Optional[str] = None,
                contact_emails: Optional[str] = None,
                contact_phone: Optional[str] = None,
                description: Optional[str] = None,
                display_name: Optional[str] = None,
                location: Optional[str] = None,
                retention_duration: Optional[int] = None,
                data_access_scopes_json: Optional[str] = None,
                deletion_policy: Optional[str] = None,
                deletion_protection: Optional[bool] = None,
                aliases_json: Optional[str] = None,
                project: Optional[str] = None)
    func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
    public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
    public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)

    type: gcp:chronicle:Environment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "gcp_chronicle_environment" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var gcpEnvironmentResource = new Gcp.Chronicle.Environment("gcpEnvironmentResource", new()
{
    Instance = "string",
    Contact = "string",
    ContactEmails = "string",
    ContactPhone = "string",
    Description = "string",
    DisplayName = "string",
    Location = "string",
    RetentionDuration = 0,
    DataAccessScopesJson = "string",
    DeletionPolicy = "string",
    DeletionProtection = false,
    AliasesJson = "string",
    Project = "string",
});

    example, err := chronicle.NewEnvironment(ctx, "gcpEnvironmentResource", &chronicle.EnvironmentArgs{
	Instance:             pulumi.String("string"),
	Contact:              pulumi.String("string"),
	ContactEmails:        pulumi.String("string"),
	ContactPhone:         pulumi.String("string"),
	Description:          pulumi.String("string"),
	DisplayName:          pulumi.String("string"),
	Location:             pulumi.String("string"),
	RetentionDuration:    pulumi.Int(0),
	DataAccessScopesJson: pulumi.String("string"),
	DeletionPolicy:       pulumi.String("string"),
	DeletionProtection:   pulumi.Bool(false),
	AliasesJson:          pulumi.String("string"),
	Project:              pulumi.String("string"),
})

    resource "gcp_chronicle_environment" "gcpEnvironmentResource" {
  instance                = "string"
  contact                 = "string"
  contact_emails          = "string"
  contact_phone           = "string"
  description             = "string"
  display_name            = "string"
  location                = "string"
  retention_duration      = 0
  data_access_scopes_json = "string"
  deletion_policy         = "string"
  deletion_protection     = false
  aliases_json            = "string"
  project                 = "string"
}

    var gcpEnvironmentResource = new com.pulumi.gcp.chronicle.Environment("gcpEnvironmentResource", com.pulumi.gcp.chronicle.EnvironmentArgs.builder()
    .instance("string")
    .contact("string")
    .contactEmails("string")
    .contactPhone("string")
    .description("string")
    .displayName("string")
    .location("string")
    .retentionDuration(0)
    .dataAccessScopesJson("string")
    .deletionPolicy("string")
    .deletionProtection(false)
    .aliasesJson("string")
    .project("string")
    .build());

    gcp_environment_resource = gcp.chronicle.Environment("gcpEnvironmentResource",
    instance="string",
    contact="string",
    contact_emails="string",
    contact_phone="string",
    description="string",
    display_name="string",
    location="string",
    retention_duration=0,
    data_access_scopes_json="string",
    deletion_policy="string",
    deletion_protection=False,
    aliases_json="string",
    project="string")

    const gcpEnvironmentResource = new gcp.chronicle.Environment("gcpEnvironmentResource", {
    instance: "string",
    contact: "string",
    contactEmails: "string",
    contactPhone: "string",
    description: "string",
    displayName: "string",
    location: "string",
    retentionDuration: 0,
    dataAccessScopesJson: "string",
    deletionPolicy: "string",
    deletionProtection: false,
    aliasesJson: "string",
    project: "string",
});

    type: gcp:chronicle:Environment
properties:
    aliasesJson: string
    contact: string
    contactEmails: string
    contactPhone: string
    dataAccessScopesJson: string
    deletionPolicy: string
    deletionProtection: false
    description: string
    displayName: string
    instance: string
    location: string
    project: string
    retentionDuration: 0

    Environment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Environment resource accepts the following input properties:

    Contact string
    MAX_NAME_LENGTH = 256 Name of the contact for the environment.
    ContactEmails string
    MAX_NAME_LENGTH = 256 Email of the contact for the environment. Multiple emails can be sepereated with the ; character.
    ContactPhone string
    MAX_NAME_LENGTH = 256 Phone number of the contact for the environment.
    Description string
    MAX_NAME_LENGTH = 256 Description of the environment.
    DisplayName string
    Name of the environment MAX_NAME_LENGTH = 256
    Instance string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    RetentionDuration int
    Environment data retention in months.
    AliasesJson string
    Environment nicknames.
    DataAccessScopesJson string
    data access scopes.
    DeletionPolicy 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.
    DeletionProtection 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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Contact string
    MAX_NAME_LENGTH = 256 Name of the contact for the environment.
    ContactEmails string
    MAX_NAME_LENGTH = 256 Email of the contact for the environment. Multiple emails can be sepereated with the ; character.
    ContactPhone string
    MAX_NAME_LENGTH = 256 Phone number of the contact for the environment.
    Description string
    MAX_NAME_LENGTH = 256 Description of the environment.
    DisplayName string
    Name of the environment MAX_NAME_LENGTH = 256
    Instance string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    RetentionDuration int
    Environment data retention in months.
    AliasesJson string
    Environment nicknames.
    DataAccessScopesJson string
    data access scopes.
    DeletionPolicy 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.
    DeletionProtection 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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    contact string
    MAX_NAME_LENGTH = 256 Name of the contact for the environment.
    contact_emails string
    MAX_NAME_LENGTH = 256 Email of the contact for the environment. Multiple emails can be sepereated with the ; character.
    contact_phone string
    MAX_NAME_LENGTH = 256 Phone number of the contact for the environment.
    description string
    MAX_NAME_LENGTH = 256 Description of the environment.
    display_name string
    Name of the environment MAX_NAME_LENGTH = 256
    instance string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    retention_duration number
    Environment data retention in months.
    aliases_json string
    Environment nicknames.
    data_access_scopes_json string
    data access scopes.
    deletion_policy 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.
    deletion_protection 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.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    contact String
    MAX_NAME_LENGTH = 256 Name of the contact for the environment.
    contactEmails String
    MAX_NAME_LENGTH = 256 Email of the contact for the environment. Multiple emails can be sepereated with the ; character.
    contactPhone String
    MAX_NAME_LENGTH = 256 Phone number of the contact for the environment.
    description String
    MAX_NAME_LENGTH = 256 Description of the environment.
    displayName String
    Name of the environment MAX_NAME_LENGTH = 256
    instance String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    retentionDuration Integer
    Environment data retention in months.
    aliasesJson String
    Environment nicknames.
    dataAccessScopesJson String
    data access scopes.
    deletionPolicy 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.
    deletionProtection Boolean
    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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    contact string
    MAX_NAME_LENGTH = 256 Name of the contact for the environment.
    contactEmails string
    MAX_NAME_LENGTH = 256 Email of the contact for the environment. Multiple emails can be sepereated with the ; character.
    contactPhone string
    MAX_NAME_LENGTH = 256 Phone number of the contact for the environment.
    description string
    MAX_NAME_LENGTH = 256 Description of the environment.
    displayName string
    Name of the environment MAX_NAME_LENGTH = 256
    instance string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    retentionDuration number
    Environment data retention in months.
    aliasesJson string
    Environment nicknames.
    dataAccessScopesJson string
    data access scopes.
    deletionPolicy 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.
    deletionProtection boolean
    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.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    contact str
    MAX_NAME_LENGTH = 256 Name of the contact for the environment.
    contact_emails str
    MAX_NAME_LENGTH = 256 Email of the contact for the environment. Multiple emails can be sepereated with the ; character.
    contact_phone str
    MAX_NAME_LENGTH = 256 Phone number of the contact for the environment.
    description str
    MAX_NAME_LENGTH = 256 Description of the environment.
    display_name str
    Name of the environment MAX_NAME_LENGTH = 256
    instance str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    location str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    retention_duration int
    Environment data retention in months.
    aliases_json str
    Environment nicknames.
    data_access_scopes_json str
    data access scopes.
    deletion_policy str
    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.
    deletion_protection 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.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    contact String
    MAX_NAME_LENGTH = 256 Name of the contact for the environment.
    contactEmails String
    MAX_NAME_LENGTH = 256 Email of the contact for the environment. Multiple emails can be sepereated with the ; character.
    contactPhone String
    MAX_NAME_LENGTH = 256 Phone number of the contact for the environment.
    description String
    MAX_NAME_LENGTH = 256 Description of the environment.
    displayName String
    Name of the environment MAX_NAME_LENGTH = 256
    instance String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    retentionDuration Number
    Environment data retention in months.
    aliasesJson String
    Environment nicknames.
    dataAccessScopesJson String
    data access scopes.
    deletionPolicy 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.
    deletionProtection Boolean
    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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Environment resource produces the following output properties:

    EnvironmentId string
    Id of the environment record.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Identifier. The unique name(ID) of the Environment. Format: projects/{project}/locations/{location}/instances/{instance}/environments/{environment}
    EnvironmentId string
    Id of the environment record.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Identifier. The unique name(ID) of the Environment. Format: projects/{project}/locations/{location}/instances/{instance}/environments/{environment}
    environment_id string
    Id of the environment record.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Identifier. The unique name(ID) of the Environment. Format: projects/{project}/locations/{location}/instances/{instance}/environments/{environment}
    environmentId String
    Id of the environment record.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Identifier. The unique name(ID) of the Environment. Format: projects/{project}/locations/{location}/instances/{instance}/environments/{environment}
    environmentId string
    Id of the environment record.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Identifier. The unique name(ID) of the Environment. Format: projects/{project}/locations/{location}/instances/{instance}/environments/{environment}
    environment_id str
    Id of the environment record.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Identifier. The unique name(ID) of the Environment. Format: projects/{project}/locations/{location}/instances/{instance}/environments/{environment}
    environmentId String
    Id of the environment record.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Identifier. The unique name(ID) of the Environment. Format: projects/{project}/locations/{location}/instances/{instance}/environments/{environment}

    Look up Existing Environment Resource

    Get an existing Environment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EnvironmentState, opts?: CustomResourceOptions): Environment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aliases_json: Optional[str] = None,
        contact: Optional[str] = None,
        contact_emails: Optional[str] = None,
        contact_phone: Optional[str] = None,
        data_access_scopes_json: Optional[str] = None,
        deletion_policy: Optional[str] = None,
        deletion_protection: Optional[bool] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        environment_id: Optional[str] = None,
        instance: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        retention_duration: Optional[int] = None) -> Environment
    func GetEnvironment(ctx *Context, name string, id IDInput, state *EnvironmentState, opts ...ResourceOption) (*Environment, error)
    public static Environment Get(string name, Input<string> id, EnvironmentState? state, CustomResourceOptions? opts = null)
    public static Environment get(String name, Output<String> id, EnvironmentState state, CustomResourceOptions options)
    resources:  _:    type: gcp:chronicle:Environment    get:      id: ${id}
    import {
  to = gcp_chronicle_environment.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AliasesJson string
    Environment nicknames.
    Contact string
    MAX_NAME_LENGTH = 256 Name of the contact for the environment.
    ContactEmails string
    MAX_NAME_LENGTH = 256 Email of the contact for the environment. Multiple emails can be sepereated with the ; character.
    ContactPhone string
    MAX_NAME_LENGTH = 256 Phone number of the contact for the environment.
    DataAccessScopesJson string
    data access scopes.
    DeletionPolicy 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.
    DeletionProtection 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.
    Description string
    MAX_NAME_LENGTH = 256 Description of the environment.
    DisplayName string
    Name of the environment MAX_NAME_LENGTH = 256
    EnvironmentId string
    Id of the environment record.
    Instance string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    Name string
    Identifier. The unique name(ID) of the Environment. Format: projects/{project}/locations/{location}/instances/{instance}/environments/{environment}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    RetentionDuration int
    Environment data retention in months.
    AliasesJson string
    Environment nicknames.
    Contact string
    MAX_NAME_LENGTH = 256 Name of the contact for the environment.
    ContactEmails string
    MAX_NAME_LENGTH = 256 Email of the contact for the environment. Multiple emails can be sepereated with the ; character.
    ContactPhone string
    MAX_NAME_LENGTH = 256 Phone number of the contact for the environment.
    DataAccessScopesJson string
    data access scopes.
    DeletionPolicy 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.
    DeletionProtection 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.
    Description string
    MAX_NAME_LENGTH = 256 Description of the environment.
    DisplayName string
    Name of the environment MAX_NAME_LENGTH = 256
    EnvironmentId string
    Id of the environment record.
    Instance string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    Name string
    Identifier. The unique name(ID) of the Environment. Format: projects/{project}/locations/{location}/instances/{instance}/environments/{environment}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    RetentionDuration int
    Environment data retention in months.
    aliases_json string
    Environment nicknames.
    contact string
    MAX_NAME_LENGTH = 256 Name of the contact for the environment.
    contact_emails string
    MAX_NAME_LENGTH = 256 Email of the contact for the environment. Multiple emails can be sepereated with the ; character.
    contact_phone string
    MAX_NAME_LENGTH = 256 Phone number of the contact for the environment.
    data_access_scopes_json string
    data access scopes.
    deletion_policy 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.
    deletion_protection 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.
    description string
    MAX_NAME_LENGTH = 256 Description of the environment.
    display_name string
    Name of the environment MAX_NAME_LENGTH = 256
    environment_id string
    Id of the environment record.
    instance string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    name string
    Identifier. The unique name(ID) of the Environment. Format: projects/{project}/locations/{location}/instances/{instance}/environments/{environment}
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    retention_duration number
    Environment data retention in months.
    aliasesJson String
    Environment nicknames.
    contact String
    MAX_NAME_LENGTH = 256 Name of the contact for the environment.
    contactEmails String
    MAX_NAME_LENGTH = 256 Email of the contact for the environment. Multiple emails can be sepereated with the ; character.
    contactPhone String
    MAX_NAME_LENGTH = 256 Phone number of the contact for the environment.
    dataAccessScopesJson String
    data access scopes.
    deletionPolicy 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.
    deletionProtection Boolean
    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.
    description String
    MAX_NAME_LENGTH = 256 Description of the environment.
    displayName String
    Name of the environment MAX_NAME_LENGTH = 256
    environmentId String
    Id of the environment record.
    instance String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    name String
    Identifier. The unique name(ID) of the Environment. Format: projects/{project}/locations/{location}/instances/{instance}/environments/{environment}
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    retentionDuration Integer
    Environment data retention in months.
    aliasesJson string
    Environment nicknames.
    contact string
    MAX_NAME_LENGTH = 256 Name of the contact for the environment.
    contactEmails string
    MAX_NAME_LENGTH = 256 Email of the contact for the environment. Multiple emails can be sepereated with the ; character.
    contactPhone string
    MAX_NAME_LENGTH = 256 Phone number of the contact for the environment.
    dataAccessScopesJson string
    data access scopes.
    deletionPolicy 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.
    deletionProtection boolean
    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.
    description string
    MAX_NAME_LENGTH = 256 Description of the environment.
    displayName string
    Name of the environment MAX_NAME_LENGTH = 256
    environmentId string
    Id of the environment record.
    instance string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    name string
    Identifier. The unique name(ID) of the Environment. Format: projects/{project}/locations/{location}/instances/{instance}/environments/{environment}
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    retentionDuration number
    Environment data retention in months.
    aliases_json str
    Environment nicknames.
    contact str
    MAX_NAME_LENGTH = 256 Name of the contact for the environment.
    contact_emails str
    MAX_NAME_LENGTH = 256 Email of the contact for the environment. Multiple emails can be sepereated with the ; character.
    contact_phone str
    MAX_NAME_LENGTH = 256 Phone number of the contact for the environment.
    data_access_scopes_json str
    data access scopes.
    deletion_policy str
    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.
    deletion_protection 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.
    description str
    MAX_NAME_LENGTH = 256 Description of the environment.
    display_name str
    Name of the environment MAX_NAME_LENGTH = 256
    environment_id str
    Id of the environment record.
    instance str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    location str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    name str
    Identifier. The unique name(ID) of the Environment. Format: projects/{project}/locations/{location}/instances/{instance}/environments/{environment}
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    retention_duration int
    Environment data retention in months.
    aliasesJson String
    Environment nicknames.
    contact String
    MAX_NAME_LENGTH = 256 Name of the contact for the environment.
    contactEmails String
    MAX_NAME_LENGTH = 256 Email of the contact for the environment. Multiple emails can be sepereated with the ; character.
    contactPhone String
    MAX_NAME_LENGTH = 256 Phone number of the contact for the environment.
    dataAccessScopesJson String
    data access scopes.
    deletionPolicy 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.
    deletionProtection Boolean
    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.
    description String
    MAX_NAME_LENGTH = 256 Description of the environment.
    displayName String
    Name of the environment MAX_NAME_LENGTH = 256
    environmentId String
    Id of the environment record.
    instance String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    name String
    Identifier. The unique name(ID) of the Environment. Format: projects/{project}/locations/{location}/instances/{instance}/environments/{environment}
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    retentionDuration Number
    Environment data retention in months.

    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}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Viewing docs for Google Cloud v9.28.0
    published on Monday, Jun 22, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gcp

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial