@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
219 lines • 10.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* The FindingsRefinementDeployment resource represents the deployment state of a findings refinement.
*
* To get more information about FindingsRefinementDeployment, see:
*
* * [API documentation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1/FindingsRefinementDeployment)
* * How-to Guides
* * [Google SecOps Guides](https://cloud.google.com/chronicle/docs/secops/secops-overview)
*
* ## Example Usage
*
* ### Chronicle Findings Refinement Deployment Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* import * as std from "@pulumi/std";
*
* const my_findings_refinement = new gcp.chronicle.FindingsRefinement("my-findings-refinement", {
* location: "us",
* instance: "00000000-0000-0000-0000-000000000000",
* displayName: "findings_refinement_display_name",
* type: "DETECTION_EXCLUSION",
* query: "network.dns.response = true",
* outcomeFilters: [{
* outcomeVariable: "risk_score",
* outcomeFilterOperator: "EQUAL",
* outcomeValue: "value",
* }],
* });
* const example = new gcp.chronicle.FindingsRefinementDeployment("example", {
* location: "us",
* instance: "00000000-0000-0000-0000-000000000000",
* findingsRefinement: pulumi.all([std.split({
* separator: "/",
* text: googleChronicleFindingsRefinement["my-findings-refinement"].name,
* }), std.split({
* separator: "/",
* text: googleChronicleFindingsRefinement["my-findings-refinement"].name,
* }).then(invoke => invoke.result).length]).apply(([invoke, length]) => invoke.result[length - 1]).apply(x =>String(x)),
* enabled: true,
* archived: false,
* });
* ```
*
* ## Import
*
* FindingsRefinementDeployment can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/instances/{{instance}}/findingsRefinements/{{findings_refinement}}/deployment`
* * `{{project}}/{{location}}/{{instance}}/{{findings_refinement}}`
* * `{{location}}/{{instance}}/{{findings_refinement}}`
*
* When using the `pulumi import` command, FindingsRefinementDeployment can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:chronicle/findingsRefinementDeployment:FindingsRefinementDeployment default projects/{{project}}/locations/{{location}}/instances/{{instance}}/findingsRefinements/{{findings_refinement}}/deployment
* $ pulumi import gcp:chronicle/findingsRefinementDeployment:FindingsRefinementDeployment default {{project}}/{{location}}/{{instance}}/{{findings_refinement}}
* $ pulumi import gcp:chronicle/findingsRefinementDeployment:FindingsRefinementDeployment default {{location}}/{{instance}}/{{findings_refinement}}
* ```
*/
export declare class FindingsRefinementDeployment extends pulumi.CustomResource {
/**
* Get an existing FindingsRefinementDeployment 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?: FindingsRefinementDeploymentState, opts?: pulumi.CustomResourceOptions): FindingsRefinementDeployment;
/**
* Returns true if the given object is an instance of FindingsRefinementDeployment. 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 FindingsRefinementDeployment;
/**
* The archive state of the findings refinement deployment.
* Cannot be set to true unless enabled is set to false.
* If currently set to true, enabled cannot be updated to true.
*/
readonly archived: pulumi.Output<boolean | undefined>;
/**
* Describes the detectors a detection exclusion is applied to.
* Structure is documented below.
*/
readonly detectionExclusionApplication: pulumi.Output<outputs.chronicle.FindingsRefinementDeploymentDetectionExclusionApplication | undefined>;
/**
* Whether the findings refinement is currently deployed continuously against
* incoming findings.
*/
readonly enabled: pulumi.Output<boolean | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
readonly findingsRefinement: 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>;
/**
* The resource name of the findings refinement deployment.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/findingsRefinements/{findings_refinement}/deployment
*/
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 timestamp when the findings refinement deployment was last updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a FindingsRefinementDeployment 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: FindingsRefinementDeploymentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering FindingsRefinementDeployment resources.
*/
export interface FindingsRefinementDeploymentState {
/**
* The archive state of the findings refinement deployment.
* Cannot be set to true unless enabled is set to false.
* If currently set to true, enabled cannot be updated to true.
*/
archived?: pulumi.Input<boolean | undefined>;
/**
* Describes the detectors a detection exclusion is applied to.
* Structure is documented below.
*/
detectionExclusionApplication?: pulumi.Input<inputs.chronicle.FindingsRefinementDeploymentDetectionExclusionApplication | undefined>;
/**
* Whether the findings refinement is currently deployed continuously against
* incoming findings.
*/
enabled?: pulumi.Input<boolean | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
findingsRefinement?: 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>;
/**
* The resource name of the findings refinement deployment.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/findingsRefinements/{findings_refinement}/deployment
*/
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 timestamp when the findings refinement deployment was last updated.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a FindingsRefinementDeployment resource.
*/
export interface FindingsRefinementDeploymentArgs {
/**
* The archive state of the findings refinement deployment.
* Cannot be set to true unless enabled is set to false.
* If currently set to true, enabled cannot be updated to true.
*/
archived?: pulumi.Input<boolean | undefined>;
/**
* Describes the detectors a detection exclusion is applied to.
* Structure is documented below.
*/
detectionExclusionApplication?: pulumi.Input<inputs.chronicle.FindingsRefinementDeploymentDetectionExclusionApplication | undefined>;
/**
* Whether the findings refinement is currently deployed continuously against
* incoming findings.
*/
enabled?: pulumi.Input<boolean | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
findingsRefinement: 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>;
}
//# sourceMappingURL=findingsRefinementDeployment.d.ts.map