@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
203 lines • 8.44 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The custom list is a list of objects, that can be saved as a shared resource, and can be used by playbooks.
*
* To get more information about CustomList, see:
*
* * [API documentation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.customLists)
* * How-to Guides
* * [Google SecOps Guides](https://cloud.google.com/chronicle/docs/secops/secops-overview)
*
* ## Example Usage
*
* ### Chronicle Customlist Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const sample = new gcp.chronicle.CustomList("sample", {
* location: "us",
* instance: "00000000-0000-0000-0000-000000000000",
* entityIdentifier: "filename.bin",
* category: "Approved Files",
* environments: JSON.stringify(["Default Environment"]),
* });
* ```
*
* ## Import
*
* CustomList can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/instances/{{instance}}/customLists/{{custom_list_id}}`
* * `{{project}}/{{location}}/{{instance}}/{{custom_list_id}}`
* * `{{location}}/{{instance}}/{{custom_list_id}}`
*
* When using the `pulumi import` command, CustomList can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:chronicle/customList:CustomList default projects/{{project}}/locations/{{location}}/instances/{{instance}}/customLists/{{custom_list_id}}
* $ pulumi import gcp:chronicle/customList:CustomList default {{project}}/{{location}}/{{instance}}/{{custom_list_id}}
* $ pulumi import gcp:chronicle/customList:CustomList default {{location}}/{{instance}}/{{custom_list_id}}
* ```
*/
export declare class CustomList extends pulumi.CustomResource {
/**
* Get an existing CustomList 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?: CustomListState, opts?: pulumi.CustomResourceOptions): CustomList;
/**
* Returns true if the given object is an instance of CustomList. 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 CustomList;
/**
* The value of the custom list.
* Maximum length: 1024 characters
*/
readonly category: pulumi.Output<string>;
/**
* Id of the Custom List record.
*/
readonly customListId: 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>;
/**
* The key of the custom list.
* Maximum length: 2048 characters
*/
readonly entityIdentifier: pulumi.Output<string>;
/**
* The environments to which the custom list is associated.
*/
readonly environments: 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 custom list.
*/
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>;
/**
* Create a CustomList 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: CustomListArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CustomList resources.
*/
export interface CustomListState {
/**
* The value of the custom list.
* Maximum length: 1024 characters
*/
category?: pulumi.Input<string | undefined>;
/**
* Id of the Custom List record.
*/
customListId?: 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>;
/**
* The key of the custom list.
* Maximum length: 2048 characters
*/
entityIdentifier?: pulumi.Input<string | undefined>;
/**
* The environments to which the custom list is associated.
*/
environments?: 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 custom list.
*/
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 set of arguments for constructing a CustomList resource.
*/
export interface CustomListArgs {
/**
* The value of the custom list.
* Maximum length: 1024 characters
*/
category: pulumi.Input<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.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The key of the custom list.
* Maximum length: 2048 characters
*/
entityIdentifier: pulumi.Input<string>;
/**
* The environments to which the custom list is associated.
*/
environments: 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=customList.d.ts.map