@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
396 lines • 15.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Represents a Chronicle Data Table, a multicolumn structure used to ingest your own data into Google SecOps.
*
* To get more information about DataTable, see:
*
* * [API documentation](https://cloud.google.com/chronicle/docs/reference/rest/v1/projects.locations.instances.dataTables)
* * How-to Guides
* * [Google SecOps Guides](https://cloud.google.com/chronicle/docs/secops/secops-overview)
*
* ## Example Usage
*
* ### Chronicle Data Table Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = new gcp.chronicle.DataTable("example", {
* location: "us",
* instance: "00000000-0000-0000-0000-000000000000",
* dataTableId: "terraform_test",
* description: "sample desc",
* columnInfos: [
* {
* columnIndex: 0,
* originalColumn: "username",
* columnType: "STRING",
* },
* {
* columnIndex: 1,
* originalColumn: "ip_address",
* columnType: "CIDR",
* },
* ],
* });
* export const dataTableName = example.name;
* export const dataTableId = example.dataTableId;
* export const dataTableUuid = example.dataTableUuid;
* export const dataTableDescription = example.description;
* export const dataTableCreateTime = example.createTime;
* ```
* ### Chronicle Data Table With Optional Fields
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const testScopeAllowEveryone = new gcp.chronicle.DataAccessScope("test_scope_allow_everyone", {
* location: "us",
* instance: "00000000-0000-0000-0000-000000000000",
* dataAccessScopeId: "tf-scope-opt",
* description: "scope-description",
* allowedDataAccessLabels: [{
* logType: "GCP_CLOUDAUDIT",
* }],
* });
* const exampleDt = new gcp.chronicle.DataTable("example_dt", {
* location: "us",
* instance: "00000000-0000-0000-0000-000000000000",
* dataTableId: "tf_test_full",
* description: "Comprehensive test table with all teh fields",
* rowTimeToLive: "48h",
* columnInfos: [
* {
* columnIndex: 0,
* originalColumn: "username",
* keyColumn: true,
* mappedColumnPath: "entity.user.userid",
* repeatedValues: false,
* },
* {
* columnIndex: 1,
* originalColumn: "ip_address",
* columnType: "CIDR",
* keyColumn: false,
* repeatedValues: false,
* },
* ],
* scopeInfo: {
* dataAccessScopes: [testScopeAllowEveryone.name],
* },
* }, {
* dependsOn: [testScopeAllowEveryone],
* });
* ```
*
* ## Import
*
* DataTable can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/instances/{{instance}}/dataTables/{{data_table_id}}`
* * `{{project}}/{{location}}/{{instance}}/{{data_table_id}}`
* * `{{location}}/{{instance}}/{{data_table_id}}`
*
* When using the `pulumi import` command, DataTable can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:chronicle/dataTable:DataTable default projects/{{project}}/locations/{{location}}/instances/{{instance}}/dataTables/{{data_table_id}}
* $ pulumi import gcp:chronicle/dataTable:DataTable default {{project}}/{{location}}/{{instance}}/{{data_table_id}}
* $ pulumi import gcp:chronicle/dataTable:DataTable default {{location}}/{{instance}}/{{data_table_id}}
* ```
*/
export declare class DataTable extends pulumi.CustomResource {
/**
* Get an existing DataTable 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?: DataTableState, opts?: pulumi.CustomResourceOptions): DataTable;
/**
* Returns true if the given object is an instance of DataTable. 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 DataTable;
/**
* The count of rows in the data table.
*/
readonly approximateRowCount: pulumi.Output<number>;
/**
* Details of all the columns in the table
* Structure is documented below.
*/
readonly columnInfos: pulumi.Output<outputs.chronicle.DataTableColumnInfo[] | undefined>;
/**
* Table create time
*/
readonly createTime: pulumi.Output<string>;
/**
* The ID to use for the data table. This is also the display name for
* the data table. It must satisfy the following requirements:
* - Starts with letter.
* - Contains only letters, numbers and underscore.
* - Must be unique and has length < 256.
*/
readonly dataTableId: pulumi.Output<string>;
/**
* Data table unique id
*/
readonly dataTableUuid: pulumi.Output<string>;
/**
* The policy governing the deletion of the data table.
* If set to `FORCE`, allows the deletion of the data table even if it contains rows.
* If set to `DEFAULT`,or if the field is omitted, the data table must be empty before it can be deleted.
*
* 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", the command will behave as if set to "DEFAULT".
*
* Possible values: DEFAULT, FORCE, PREVENT, ABANDON, DELETE
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* A user-provided description of the data table.
*/
readonly description: pulumi.Output<string>;
/**
* The unique display name of the data table.
*/
readonly displayName: pulumi.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.
*/
readonly instance: pulumi.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.
*/
readonly location: pulumi.Output<string>;
/**
* Identifier. The resource name of the data table
* Format:
* "{project}/locations/{region}/instances/{instance}/dataTables/{data_table}"
*/
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>;
/**
* User-provided TTL of the data table.
*/
readonly rowTimeToLive: pulumi.Output<string | undefined>;
/**
* Last update time of the TTL of the data table.
*/
readonly rowTimeToLiveUpdateTime: pulumi.Output<string>;
/**
* The count of rules using the data table.
*/
readonly ruleAssociationsCount: pulumi.Output<number>;
/**
* The resource names for the associated Rules that use this
* data table. Format:
* projects/{project}/locations/{location}/instances/{instance}/rules/{rule}.
* {rule} here refers to the rule id.
*/
readonly rules: pulumi.Output<string[]>;
/**
* DataTableScopeInfo specifies the scope info of the data table.
* Structure is documented below.
*/
readonly scopeInfo: pulumi.Output<outputs.chronicle.DataTableScopeInfo | undefined>;
/**
* Possible values:
* USER
* RULE
* SEARCH
*/
readonly updateSource: pulumi.Output<string>;
/**
* Table update time
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a DataTable 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: DataTableArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DataTable resources.
*/
export interface DataTableState {
/**
* The count of rows in the data table.
*/
approximateRowCount?: pulumi.Input<number | undefined>;
/**
* Details of all the columns in the table
* Structure is documented below.
*/
columnInfos?: pulumi.Input<pulumi.Input<inputs.chronicle.DataTableColumnInfo>[] | undefined>;
/**
* Table create time
*/
createTime?: pulumi.Input<string | undefined>;
/**
* The ID to use for the data table. This is also the display name for
* the data table. It must satisfy the following requirements:
* - Starts with letter.
* - Contains only letters, numbers and underscore.
* - Must be unique and has length < 256.
*/
dataTableId?: pulumi.Input<string | undefined>;
/**
* Data table unique id
*/
dataTableUuid?: pulumi.Input<string | undefined>;
/**
* The policy governing the deletion of the data table.
* If set to `FORCE`, allows the deletion of the data table even if it contains rows.
* If set to `DEFAULT`,or if the field is omitted, the data table must be empty before it can be deleted.
*
* 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", the command will behave as if set to "DEFAULT".
*
* Possible values: DEFAULT, FORCE, PREVENT, ABANDON, DELETE
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* A user-provided description of the data table.
*/
description?: pulumi.Input<string | undefined>;
/**
* The unique display name of the data table.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
instance?: pulumi.Input<string | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location?: pulumi.Input<string | undefined>;
/**
* Identifier. The resource name of the data table
* Format:
* "{project}/locations/{region}/instances/{instance}/dataTables/{data_table}"
*/
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>;
/**
* User-provided TTL of the data table.
*/
rowTimeToLive?: pulumi.Input<string | undefined>;
/**
* Last update time of the TTL of the data table.
*/
rowTimeToLiveUpdateTime?: pulumi.Input<string | undefined>;
/**
* The count of rules using the data table.
*/
ruleAssociationsCount?: pulumi.Input<number | undefined>;
/**
* The resource names for the associated Rules that use this
* data table. Format:
* projects/{project}/locations/{location}/instances/{instance}/rules/{rule}.
* {rule} here refers to the rule id.
*/
rules?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* DataTableScopeInfo specifies the scope info of the data table.
* Structure is documented below.
*/
scopeInfo?: pulumi.Input<inputs.chronicle.DataTableScopeInfo | undefined>;
/**
* Possible values:
* USER
* RULE
* SEARCH
*/
updateSource?: pulumi.Input<string | undefined>;
/**
* Table update time
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a DataTable resource.
*/
export interface DataTableArgs {
/**
* Details of all the columns in the table
* Structure is documented below.
*/
columnInfos?: pulumi.Input<pulumi.Input<inputs.chronicle.DataTableColumnInfo>[] | undefined>;
/**
* The ID to use for the data table. This is also the display name for
* the data table. It must satisfy the following requirements:
* - Starts with letter.
* - Contains only letters, numbers and underscore.
* - Must be unique and has length < 256.
*/
dataTableId: pulumi.Input<string>;
/**
* The policy governing the deletion of the data table.
* If set to `FORCE`, allows the deletion of the data table even if it contains rows.
* If set to `DEFAULT`,or if the field is omitted, the data table must be empty before it can be deleted.
*
* 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", the command will behave as if set to "DEFAULT".
*
* Possible values: DEFAULT, FORCE, PREVENT, ABANDON, DELETE
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* A user-provided description of the data table.
*/
description: pulumi.Input<string>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
instance: pulumi.Input<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: 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>;
/**
* User-provided TTL of the data table.
*/
rowTimeToLive?: pulumi.Input<string | undefined>;
/**
* DataTableScopeInfo specifies the scope info of the data table.
* Structure is documented below.
*/
scopeInfo?: pulumi.Input<inputs.chronicle.DataTableScopeInfo | undefined>;
}
//# sourceMappingURL=dataTable.d.ts.map