@pulumi/gcp/chronicle/nativeDashboard.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * A configuration for a native dashboard within a Google SecOps (Chronicle) instance.
 *
 * To get more information about NativeDashboard, see:
 *
 * * [API documentation](https://cloud.google.com/chronicle/docs/reference/rest/v1/projects.locations.instances.nativeDashboards)
 * * How-to Guides
 *     * [Google SecOps Guides](https://cloud.google.com/chronicle/docs/secops/secops-overview)
 *
 * ## Example Usage
 *
 * ### Chronicle Nativedashboard Basic
 *
 * ```typescript
 * 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
 *
 * 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:
 *
 * ```sh
 * $ 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}}
 * ```
 */
export declare class NativeDashboard extends pulumi.CustomResource {
    /**
     * Get an existing NativeDashboard resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NativeDashboardState, opts?: pulumi.CustomResourceOptions): NativeDashboard;
    /**
     * Returns true if the given object is an instance of NativeDashboard.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is NativeDashboard;
    /**
     * The access level of the dashboard.
     * Possible values:
     * DASHBOARD_PRIVATE
     * DASHBOARD_PUBLIC
     */
    readonly access: pulumi.Output<string | undefined>;
    /**
     * A list of charts included in the dashboard definition.
     * Structure is documented below.
     */
    readonly charts: pulumi.Output<outputs.chronicle.NativeDashboardChart[]>;
    /**
     * The creation time of the dashboard.
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * The ID of the user who created the dashboard.
     */
    readonly createUserId: pulumi.Output<string>;
    /**
     * The unique ID of the Dashboard.
     */
    readonly dashboardId: pulumi.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.
     */
    readonly deletionPolicy: pulumi.Output<string>;
    /**
     * A description of the dashboard.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The display name/title of the dashboard visible to users.
     */
    readonly displayName: pulumi.Output<string>;
    /**
     * Server-computed checksum for optimistic concurrency control,
     * sent on update and delete requests.
     */
    readonly etag: pulumi.Output<string>;
    /**
     * Global filters defined for the dashboard.
     * Structure is documented below.
     */
    readonly filters: pulumi.Output<outputs.chronicle.NativeDashboardFilter[] | undefined>;
    /**
     * (Output)
     * The server-generated fingerprint of the dashboard definition.
     */
    readonly fingerprint: pulumi.Output<string>;
    /**
     * The ID of the Chronicle instance.
     */
    readonly instance: pulumi.Output<string>;
    /**
     * Whether the dashboard is pinned by the user.
     */
    readonly isPinned: pulumi.Output<boolean | undefined>;
    /**
     * (Output)
     * The time when this dashboard was last viewed.
     */
    readonly lastViewedTime: pulumi.Output<string>;
    /**
     * The location of the Chronicle instance.
     */
    readonly location: pulumi.Output<string>;
    /**
     * The full resource name of the dashboard.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * The type of dashboard.
     * Possible values:
     * CURATED, PRIVATE, PUBLIC, CUSTOM, MARKETPLACE
     */
    readonly type: pulumi.Output<string | undefined>;
    /**
     * The time when the dashboard was last edited.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * The ID of the user who last edited the dashboard.
     */
    readonly updateUserId: pulumi.Output<string>;
    /**
     * Create a NativeDashboard resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: NativeDashboardArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering NativeDashboard resources.
 */
export interface NativeDashboardState {
    /**
     * The access level of the dashboard.
     * Possible values:
     * DASHBOARD_PRIVATE
     * DASHBOARD_PUBLIC
     */
    access?: pulumi.Input<string | undefined>;
    /**
     * A list of charts included in the dashboard definition.
     * Structure is documented below.
     */
    charts?: pulumi.Input<pulumi.Input<inputs.chronicle.NativeDashboardChart>[] | undefined>;
    /**
     * The creation time of the dashboard.
     */
    createTime?: pulumi.Input<string | undefined>;
    /**
     * The ID of the user who created the dashboard.
     */
    createUserId?: pulumi.Input<string | undefined>;
    /**
     * The unique ID of the Dashboard.
     */
    dashboardId?: pulumi.Input<string | undefined>;
    /**
     * 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.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * A description of the dashboard.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * The display name/title of the dashboard visible to users.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * Server-computed checksum for optimistic concurrency control,
     * sent on update and delete requests.
     */
    etag?: pulumi.Input<string | undefined>;
    /**
     * Global filters defined for the dashboard.
     * Structure is documented below.
     */
    filters?: pulumi.Input<pulumi.Input<inputs.chronicle.NativeDashboardFilter>[] | undefined>;
    /**
     * (Output)
     * The server-generated fingerprint of the dashboard definition.
     */
    fingerprint?: pulumi.Input<string | undefined>;
    /**
     * The ID of the Chronicle instance.
     */
    instance?: pulumi.Input<string | undefined>;
    /**
     * Whether the dashboard is pinned by the user.
     */
    isPinned?: pulumi.Input<boolean | undefined>;
    /**
     * (Output)
     * The time when this dashboard was last viewed.
     */
    lastViewedTime?: pulumi.Input<string | undefined>;
    /**
     * The location of the Chronicle instance.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * The full resource name of the dashboard.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * The type of dashboard.
     * Possible values:
     * CURATED, PRIVATE, PUBLIC, CUSTOM, MARKETPLACE
     */
    type?: pulumi.Input<string | undefined>;
    /**
     * The time when the dashboard was last edited.
     */
    updateTime?: pulumi.Input<string | undefined>;
    /**
     * The ID of the user who last edited the dashboard.
     */
    updateUserId?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a NativeDashboard resource.
 */
export interface NativeDashboardArgs {
    /**
     * The access level of the dashboard.
     * Possible values:
     * DASHBOARD_PRIVATE
     * DASHBOARD_PUBLIC
     */
    access?: pulumi.Input<string | undefined>;
    /**
     * A list of charts included in the dashboard definition.
     * Structure is documented below.
     */
    charts?: pulumi.Input<pulumi.Input<inputs.chronicle.NativeDashboardChart>[] | undefined>;
    /**
     * 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.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * A description of the dashboard.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * The display name/title of the dashboard visible to users.
     */
    displayName: pulumi.Input<string>;
    /**
     * Global filters defined for the dashboard.
     * Structure is documented below.
     */
    filters?: pulumi.Input<pulumi.Input<inputs.chronicle.NativeDashboardFilter>[] | undefined>;
    /**
     * The ID of the Chronicle instance.
     */
    instance: pulumi.Input<string>;
    /**
     * Whether the dashboard is pinned by the user.
     */
    isPinned?: pulumi.Input<boolean | undefined>;
    /**
     * The location of the Chronicle instance.
     */
    location: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * The type of dashboard.
     * Possible values:
     * CURATED, PRIVATE, PUBLIC, CUSTOM, MARKETPLACE
     */
    type?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=nativeDashboard.d.ts.map