@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
263 lines • 10.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* BigQueryExport resource represents the BigQuery export configuration for a Chronicle instance.
*
* To get more information about BigQueryExport, see:
*
* * [API documentation](https://cloud.google.com/chronicle/docs/reference/rest/v1/projects.locations.instances.bigQueryExport)
* * How-to Guides
* * [BigQuery Export Overview](https://cloud.google.com/chronicle/docs/secops/bigquery-export-overview)
*
* ## Example Usage
*
* ### Chronicle Bigquery Export Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = new gcp.chronicle.BigQueryExport("example", {
* location: "us",
* instance: "00000000-0000-0000-0000-000000000000",
* udmEventsSettings: {
* enabled: true,
* retentionDays: 7,
* },
* });
* ```
* ### Chronicle Bigquery Export Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = new gcp.chronicle.BigQueryExport("example", {
* location: "us",
* instance: "00000000-0000-0000-0000-000000000000",
* bigQueryExportPackage: "BIG_QUERY_EXPORT_PACKAGE_BYOBQ",
* udmEventsSettings: {
* enabled: true,
* retentionDays: 7,
* },
* entityGraphSettings: {
* enabled: true,
* retentionDays: 7,
* },
* iocMatchesSettings: {
* enabled: true,
* retentionDays: 7,
* },
* ruleDetectionsSettings: {
* enabled: true,
* retentionDays: 7,
* },
* udmEventsAggregatesSettings: {
* enabled: true,
* retentionDays: 7,
* },
* });
* ```
*
* ## Import
*
* BigQueryExport can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/instances/{{instance}}/bigQueryExport`
* * `{{project}}/{{location}}/{{instance}}`
* * `{{location}}/{{instance}}`
*
* When using the `pulumi import` command, BigQueryExport can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:chronicle/bigQueryExport:BigQueryExport default projects/{{project}}/locations/{{location}}/instances/{{instance}}/bigQueryExport
* $ pulumi import gcp:chronicle/bigQueryExport:BigQueryExport default {{project}}/{{location}}/{{instance}}
* $ pulumi import gcp:chronicle/bigQueryExport:BigQueryExport default {{location}}/{{instance}}
* ```
*/
export declare class BigQueryExport extends pulumi.CustomResource {
/**
* Get an existing BigQueryExport 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?: BigQueryExportState, opts?: pulumi.CustomResourceOptions): BigQueryExport;
/**
* Returns true if the given object is an instance of BigQueryExport. 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 BigQueryExport;
/**
* The BigQueryExportPackage entitled for the Chronicle instance.
* Possible values are: `BIG_QUERY_EXPORT_PACKAGE_BYOBQ`, `BIG_QUERY_EXPORT_PACKAGE_ADVANCED`.
*/
readonly bigQueryExportPackage: pulumi.Output<string>;
/**
* The export settings for a data source.
* Structure is documented below.
*/
readonly entityGraphSettings: pulumi.Output<outputs.chronicle.BigQueryExportEntityGraphSettings>;
/**
* 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>;
/**
* The export settings for a data source.
* Structure is documented below.
*/
readonly iocMatchesSettings: pulumi.Output<outputs.chronicle.BigQueryExportIocMatchesSettings>;
/**
* 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 BigQueryExport.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/bigQueryExport
*/
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>;
/**
* Whether the BigQueryExport has been provisioned for the Chronicle instance.
*/
readonly provisioned: pulumi.Output<boolean>;
/**
* The export settings for a data source.
* Structure is documented below.
*/
readonly ruleDetectionsSettings: pulumi.Output<outputs.chronicle.BigQueryExportRuleDetectionsSettings>;
/**
* The export settings for a data source.
* Structure is documented below.
*/
readonly udmEventsAggregatesSettings: pulumi.Output<outputs.chronicle.BigQueryExportUdmEventsAggregatesSettings>;
/**
* The export settings for a data source.
* Structure is documented below.
*/
readonly udmEventsSettings: pulumi.Output<outputs.chronicle.BigQueryExportUdmEventsSettings>;
/**
* Create a BigQueryExport 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: BigQueryExportArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering BigQueryExport resources.
*/
export interface BigQueryExportState {
/**
* The BigQueryExportPackage entitled for the Chronicle instance.
* Possible values are: `BIG_QUERY_EXPORT_PACKAGE_BYOBQ`, `BIG_QUERY_EXPORT_PACKAGE_ADVANCED`.
*/
bigQueryExportPackage?: pulumi.Input<string | undefined>;
/**
* The export settings for a data source.
* Structure is documented below.
*/
entityGraphSettings?: pulumi.Input<inputs.chronicle.BigQueryExportEntityGraphSettings | 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>;
/**
* The export settings for a data source.
* Structure is documented below.
*/
iocMatchesSettings?: pulumi.Input<inputs.chronicle.BigQueryExportIocMatchesSettings | 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 BigQueryExport.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/bigQueryExport
*/
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>;
/**
* Whether the BigQueryExport has been provisioned for the Chronicle instance.
*/
provisioned?: pulumi.Input<boolean | undefined>;
/**
* The export settings for a data source.
* Structure is documented below.
*/
ruleDetectionsSettings?: pulumi.Input<inputs.chronicle.BigQueryExportRuleDetectionsSettings | undefined>;
/**
* The export settings for a data source.
* Structure is documented below.
*/
udmEventsAggregatesSettings?: pulumi.Input<inputs.chronicle.BigQueryExportUdmEventsAggregatesSettings | undefined>;
/**
* The export settings for a data source.
* Structure is documented below.
*/
udmEventsSettings?: pulumi.Input<inputs.chronicle.BigQueryExportUdmEventsSettings | undefined>;
}
/**
* The set of arguments for constructing a BigQueryExport resource.
*/
export interface BigQueryExportArgs {
/**
* The BigQueryExportPackage entitled for the Chronicle instance.
* Possible values are: `BIG_QUERY_EXPORT_PACKAGE_BYOBQ`, `BIG_QUERY_EXPORT_PACKAGE_ADVANCED`.
*/
bigQueryExportPackage?: pulumi.Input<string | undefined>;
/**
* The export settings for a data source.
* Structure is documented below.
*/
entityGraphSettings?: pulumi.Input<inputs.chronicle.BigQueryExportEntityGraphSettings | 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>;
/**
* The export settings for a data source.
* Structure is documented below.
*/
iocMatchesSettings?: pulumi.Input<inputs.chronicle.BigQueryExportIocMatchesSettings | 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>;
/**
* 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 export settings for a data source.
* Structure is documented below.
*/
ruleDetectionsSettings?: pulumi.Input<inputs.chronicle.BigQueryExportRuleDetectionsSettings | undefined>;
/**
* The export settings for a data source.
* Structure is documented below.
*/
udmEventsAggregatesSettings?: pulumi.Input<inputs.chronicle.BigQueryExportUdmEventsAggregatesSettings | undefined>;
/**
* The export settings for a data source.
* Structure is documented below.
*/
udmEventsSettings?: pulumi.Input<inputs.chronicle.BigQueryExportUdmEventsSettings | undefined>;
}
//# sourceMappingURL=bigQueryExport.d.ts.map