@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
191 lines • 8.38 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A SOAR domain designate a domain as internal, ensuring that entities associated with it are treated as organizational assets rather than external threats during ingestion.
*
* > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider.
* See Provider Versions for more details on beta resources.
*
* To get more information about SoarDomain, see:
*
* * [API documentation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.soarDomains)
* * How-to Guides
* * [Google SecOps Guides](https://cloud.google.com/chronicle/docs/secops/secops-overview)
*
* ## Example Usage
*
* ### Chronicle Soardomain Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const example = new gcp.chronicle.SoarDomain("example", {
* location: "us",
* instance: "00000000-0000-0000-0000-000000000000",
* displayName: "test.com",
* environmentsJson: "[\"Default Environment\"]",
* });
* ```
*
* ## Import
*
* SoarDomain can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/instances/{{instance}}/soarDomains/{{soar_domain_id}}`
* * `{{project}}/{{location}}/{{instance}}/{{soar_domain_id}}`
* * `{{location}}/{{instance}}/{{soar_domain_id}}`
*
* When using the `pulumi import` command, SoarDomain can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:chronicle/soarDomain:SoarDomain default projects/{{project}}/locations/{{location}}/instances/{{instance}}/soarDomains/{{soar_domain_id}}
* $ pulumi import gcp:chronicle/soarDomain:SoarDomain default {{project}}/{{location}}/{{instance}}/{{soar_domain_id}}
* $ pulumi import gcp:chronicle/soarDomain:SoarDomain default {{location}}/{{instance}}/{{soar_domain_id}}
* ```
*/
export declare class SoarDomain extends pulumi.CustomResource {
/**
* Get an existing SoarDomain 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?: SoarDomainState, opts?: pulumi.CustomResourceOptions): SoarDomain;
/**
* Returns true if the given object is an instance of SoarDomain. 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 SoarDomain;
/**
* 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>;
/**
* SoarDomain display name, limited to 4096 characters.
*/
readonly displayName: pulumi.Output<string>;
/**
* SoarDomain associated logical environments (json).
*/
readonly environmentsJson: 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 unique name(ID) of the SoarDomain.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/soarDomains/{soar_domain_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>;
/**
* Id of the domain record.
*/
readonly soarDomainId: pulumi.Output<string>;
/**
* Create a SoarDomain 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: SoarDomainArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SoarDomain resources.
*/
export interface SoarDomainState {
/**
* 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>;
/**
* SoarDomain display name, limited to 4096 characters.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* SoarDomain associated logical environments (json).
*/
environmentsJson?: 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 unique name(ID) of the SoarDomain.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/soarDomains/{soar_domain_id}
*/
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>;
/**
* Id of the domain record.
*/
soarDomainId?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a SoarDomain resource.
*/
export interface SoarDomainArgs {
/**
* 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>;
/**
* SoarDomain display name, limited to 4096 characters.
*/
displayName: pulumi.Input<string>;
/**
* SoarDomain associated logical environments (json).
*/
environmentsJson: 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=soarDomain.d.ts.map