NativeDashboard class

A configuration for a native dashboard within a Google SecOps (Chronicle) instance.

To get more information about NativeDashboard, see:

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

Example Usage

Chronicle Nativedashboard Basic

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

const myBasicDashboard = new gcp.chronicle.NativeDashboard("my_basic_dashboard", {
    location: "us",
    instance: "00000000-0000-0000-0000-000000000000",
    displayName: "dashboard",
    description: "dashboard_description",
    access: "DASHBOARD_PRIVATE",
    type: "CUSTOM",
    filters: [{
        id: "GlobalTimeFilter",
        displayName: "Global Time Filter",
        dataSource: "GLOBAL",
        isStandardTimeRangeFilter: true,
        isStandardTimeRangeFilterEnabled: true,
        filterOperatorAndFieldValues: [{
            filterOperator: "PAST",
            fieldValues: [
                "1",
                "DAY",
            ],
        }],
    }],
});

import pulumi
import pulumi_gcp as gcp

my_basic_dashboard = gcp.chronicle.NativeDashboard("my_basic_dashboard",
    location="us",
    instance="00000000-0000-0000-0000-000000000000",
    display_name="dashboard",
    description="dashboard_description",
    access="DASHBOARD_PRIVATE",
    type="CUSTOM",
    filters=[{
        "id": "GlobalTimeFilter",
        "display_name": "Global Time Filter",
        "data_source": "GLOBAL",
        "is_standard_time_range_filter": True,
        "is_standard_time_range_filter_enabled": True,
        "filter_operator_and_field_values": [{
            "filter_operator": "PAST",
            "field_values": [
                "1",
                "DAY",
            ],
        }],
    }])

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

return await Deployment.RunAsync(() =>
{
    var myBasicDashboard = new Gcp.Chronicle.NativeDashboard("my_basic_dashboard", new()
    {
        Location = "us",
        Instance = "00000000-0000-0000-0000-000000000000",
        DisplayName = "dashboard",
        Description = "dashboard_description",
        Access = "DASHBOARD_PRIVATE",
        Type = "CUSTOM",
        Filters = new[]
        {
            new Gcp.Chronicle.Inputs.NativeDashboardFilterArgs
            {
                Id = "GlobalTimeFilter",
                DisplayName = "Global Time Filter",
                DataSource = "GLOBAL",
                IsStandardTimeRangeFilter = true,
                IsStandardTimeRangeFilterEnabled = true,
                FilterOperatorAndFieldValues = new[]
                {
                    new Gcp.Chronicle.Inputs.NativeDashboardFilterFilterOperatorAndFieldValueArgs
                    {
                        FilterOperator = "PAST",
                        FieldValues = new[]
                        {
                            "1",
                            "DAY",
                        },
                    },
                },
            },
        },
    });

});

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.NewNativeDashboard(ctx, "my_basic_dashboard", &chronicle.NativeDashboardArgs{
			Location:    pulumi.String("us"),
			Instance:    pulumi.String("00000000-0000-0000-0000-000000000000"),
			DisplayName: pulumi.String("dashboard"),
			Description: pulumi.String("dashboard_description"),
			Access:      pulumi.String("DASHBOARD_PRIVATE"),
			Type:        pulumi.String("CUSTOM"),
			Filters: chronicle.NativeDashboardFilterArray{
				&chronicle.NativeDashboardFilterArgs{
					Id:                               pulumi.String("GlobalTimeFilter"),
					DisplayName:                      pulumi.String("Global Time Filter"),
					DataSource:                       pulumi.String("GLOBAL"),
					IsStandardTimeRangeFilter:        pulumi.Bool(true),
					IsStandardTimeRangeFilterEnabled: pulumi.Bool(true),
					FilterOperatorAndFieldValues: chronicle.NativeDashboardFilterFilterOperatorAndFieldValueArray{
						&chronicle.NativeDashboardFilterFilterOperatorAndFieldValueArgs{
							FilterOperator: pulumi.String("PAST"),
							FieldValues: pulumi.StringArray{
								pulumi.String("1"),
								pulumi.String("DAY"),
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_chronicle_nativedashboard" "my_basic_dashboard" {
  location     = "us"
  instance     = "00000000-0000-0000-0000-000000000000"
  display_name = "dashboard"
  description  = "dashboard_description"
  access       = "DASHBOARD_PRIVATE"
  type         = "CUSTOM"
  filters {
    id                                    = "GlobalTimeFilter"
    display_name                          = "Global Time Filter"
    data_source                           = "GLOBAL"
    is_standard_time_range_filter         = true
    is_standard_time_range_filter_enabled = true
    filter_operator_and_field_values {
      filter_operator = "PAST"
      field_values    = ["1", "DAY"]
    }
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.chronicle.NativeDashboard;
import com.pulumi.gcp.chronicle.NativeDashboardArgs;
import com.pulumi.gcp.chronicle.inputs.NativeDashboardFilterArgs;
import com.pulumi.gcp.chronicle.inputs.NativeDashboardFilterFilterOperatorAndFieldValueArgs;
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 myBasicDashboard = new NativeDashboard("myBasicDashboard", NativeDashboardArgs.builder()
            .location("us")
            .instance("00000000-0000-0000-0000-000000000000")
            .displayName("dashboard")
            .description("dashboard_description")
            .access("DASHBOARD_PRIVATE")
            .type("CUSTOM")
            .filters(NativeDashboardFilterArgs.builder()
                .id("GlobalTimeFilter")
                .displayName("Global Time Filter")
                .dataSource("GLOBAL")
                .isStandardTimeRangeFilter(true)
                .isStandardTimeRangeFilterEnabled(true)
                .filterOperatorAndFieldValues(NativeDashboardFilterFilterOperatorAndFieldValueArgs.builder()
                    .filterOperator("PAST")
                    .fieldValues(
                        "1",
                        "DAY")
                    .build())
                .build())
            .build());

    }
}

resources:
  myBasicDashboard:
    type: gcp:chronicle:NativeDashboard
    name: my_basic_dashboard
    properties:
      location: us
      instance: 00000000-0000-0000-0000-000000000000
      displayName: dashboard
      description: dashboard_description
      access: DASHBOARD_PRIVATE
      type: CUSTOM
      filters:
        - id: GlobalTimeFilter
          displayName: Global Time Filter
          dataSource: GLOBAL
          isStandardTimeRangeFilter: true
          isStandardTimeRangeFilterEnabled: true
          filterOperatorAndFieldValues:
            - filterOperator: PAST
              fieldValues:
                - '1'
                - DAY

Import

NativeDashboard can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/instances/{{instance}}/nativeDashboards/{{dashboard_id}}
• {{project}}/{{location}}/{{instance}}/{{dashboard_id}}
• {{location}}/{{instance}}/{{dashboard_id}}

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

$ pulumi import gcp:chronicle/nativeDashboard:NativeDashboard default projects/{{project}}/locations/{{location}}/instances/{{instance}}/nativeDashboards/{{dashboard_id}}
$ pulumi import gcp:chronicle/nativeDashboard:NativeDashboard default {{project}}/{{location}}/{{instance}}/{{dashboard_id}}
$ pulumi import gcp:chronicle/nativeDashboard:NativeDashboard default {{location}}/{{instance}}/{{dashboard_id}}

Constructors

NativeDashboard(String name, {NativeDashboardArgs? args, CustomResourceOptions? options})

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

NativeDashboard.reference(String urn)

Creates a typed reference to an existing NativeDashboard resource.

Properties

access ↔ Output<String?>

The access level of the dashboard. Possible values: DASHBOARD_PRIVATE DASHBOARD_PUBLIC

late, final

charts ↔ Output<List<NativeDashboardChart>>

A list of charts included in the dashboard definition. Structure is documented below.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The creation time of the dashboard.

late, final

createUserId ↔ Output<String>

The ID of the user who created the dashboard.

late, final

dashboardId ↔ Output<String>

The unique ID of the Dashboard.

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

description ↔ Output<String?>

A description of the dashboard.

late, final

displayName ↔ Output<String>

The display name/title of the dashboard visible to users.

late, final

etag ↔ Output<String>

Server-computed checksum for optimistic concurrency control, sent on update and delete requests.

late, final

filters ↔ Output<List<NativeDashboardFilter>?>

Global filters defined for the dashboard. Structure is documented below.

late, final

fingerprint ↔ Output<String>

(Output) The server-generated fingerprint of the dashboard definition.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

instance ↔ Output<String>

The ID of the Chronicle instance.

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isPinned ↔ Output<bool?>

Whether the dashboard is pinned by the user.

late, final

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

lastViewedTime ↔ Output<String>

(Output) The time when this dashboard was last viewed.

late, final

location ↔ Output<String>

The location of the Chronicle instance.

late, final

name ↔ Output<String>

The full resource name of the dashboard.

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

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

type ↔ Output<String?>

The type of dashboard. Possible values: CURATED, PRIVATE, PUBLIC, CUSTOM, MARKETPLACE

late, final

updateTime ↔ Output<String>

The time when the dashboard was last edited.

late, final

updateUserId ↔ Output<String>

The ID of the user who last edited the dashboard.

late, final

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

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