@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
223 lines (222 loc) • 8.85 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A DataAccessLabel is a label on events to define user access to data.
*
* To get more information about DataAccessLabel, see:
*
* * [API documentation](https://cloud.google.com/chronicle/docs/reference/rest/v1/projects.locations.instances.dataAccessLabels)
* * How-to Guides
* * [Introduction to data RBAC](https://cloud.google.com/chronicle/docs/onboard/onboard-datarbac)
*
* ## Example Usage
*
* ### Chronicle Dataaccesslabel Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = new gcp.chronicle.DataAccessLabel("example", {
* location: "us",
* instance: "00000000-0000-0000-0000-000000000000",
* dataAccessLabelId: "label-id",
* udmQuery: "principal.hostname=\"google.com\"",
* description: "label-description",
* });
* ```
*
* ## Import
*
* DataAccessLabel can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/instances/{{instance}}/dataAccessLabels/{{data_access_label_id}}`
*
* * `{{project}}/{{location}}/{{instance}}/{{data_access_label_id}}`
*
* * `{{location}}/{{instance}}/{{data_access_label_id}}`
*
* When using the `pulumi import` command, DataAccessLabel can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:chronicle/dataAccessLabel:DataAccessLabel default projects/{{project}}/locations/{{location}}/instances/{{instance}}/dataAccessLabels/{{data_access_label_id}}
* ```
*
* ```sh
* $ pulumi import gcp:chronicle/dataAccessLabel:DataAccessLabel default {{project}}/{{location}}/{{instance}}/{{data_access_label_id}}
* ```
*
* ```sh
* $ pulumi import gcp:chronicle/dataAccessLabel:DataAccessLabel default {{location}}/{{instance}}/{{data_access_label_id}}
* ```
*/
export declare class DataAccessLabel extends pulumi.CustomResource {
/**
* Get an existing DataAccessLabel 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?: DataAccessLabelState, opts?: pulumi.CustomResourceOptions): DataAccessLabel;
/**
* Returns true if the given object is an instance of DataAccessLabel. 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 DataAccessLabel;
/**
* Output only. The user who created the data access label.
*/
readonly author: pulumi.Output<string>;
/**
* Output only. The time at which the data access label was created.
*/
readonly createTime: pulumi.Output<string>;
/**
* Required. The ID to use for the data access label, which will become the label's
* display name and the final component of the label's resource name. The
* maximum number of characters should be 63. Regex pattern is as per AIP:
* https://google.aip.dev/122#resource-id-segments
*/
readonly dataAccessLabelId: pulumi.Output<string>;
/**
* Optional. A description of the data access label for a human reader.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Output only. The short name displayed for the label as it appears on event data. This is same as data access label id.
*/
readonly displayName: pulumi.Output<string>;
/**
* The unique identifier for the Chronicle instance, which is the same as the customer ID.
*/
readonly instance: pulumi.Output<string>;
/**
* Output only. The user who last updated the data access label.
*/
readonly lastEditor: pulumi.Output<string>;
/**
* The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
*/
readonly location: pulumi.Output<string>;
/**
* The unique resource name of the data access label. This unique identifier is generated using values provided for the URL parameters.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label_id}
*/
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>;
/**
* A UDM query over event data.
*/
readonly udmQuery: pulumi.Output<string>;
/**
* Output only. The time at which the data access label was last updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a DataAccessLabel 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: DataAccessLabelArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DataAccessLabel resources.
*/
export interface DataAccessLabelState {
/**
* Output only. The user who created the data access label.
*/
author?: pulumi.Input<string>;
/**
* Output only. The time at which the data access label was created.
*/
createTime?: pulumi.Input<string>;
/**
* Required. The ID to use for the data access label, which will become the label's
* display name and the final component of the label's resource name. The
* maximum number of characters should be 63. Regex pattern is as per AIP:
* https://google.aip.dev/122#resource-id-segments
*/
dataAccessLabelId?: pulumi.Input<string>;
/**
* Optional. A description of the data access label for a human reader.
*/
description?: pulumi.Input<string>;
/**
* Output only. The short name displayed for the label as it appears on event data. This is same as data access label id.
*/
displayName?: pulumi.Input<string>;
/**
* The unique identifier for the Chronicle instance, which is the same as the customer ID.
*/
instance?: pulumi.Input<string>;
/**
* Output only. The user who last updated the data access label.
*/
lastEditor?: pulumi.Input<string>;
/**
* The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
*/
location?: pulumi.Input<string>;
/**
* The unique resource name of the data access label. This unique identifier is generated using values provided for the URL parameters.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label_id}
*/
name?: 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>;
/**
* A UDM query over event data.
*/
udmQuery?: pulumi.Input<string>;
/**
* Output only. The time at which the data access label was last updated.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a DataAccessLabel resource.
*/
export interface DataAccessLabelArgs {
/**
* Required. The ID to use for the data access label, which will become the label's
* display name and the final component of the label's resource name. The
* maximum number of characters should be 63. Regex pattern is as per AIP:
* https://google.aip.dev/122#resource-id-segments
*/
dataAccessLabelId: pulumi.Input<string>;
/**
* Optional. A description of the data access label for a human reader.
*/
description?: pulumi.Input<string>;
/**
* The unique identifier for the Chronicle instance, which is the same as the customer ID.
*/
instance: pulumi.Input<string>;
/**
* The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
*/
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>;
/**
* A UDM query over event data.
*/
udmQuery: pulumi.Input<string>;
}