@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
294 lines • 12.5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* An environment is logical container for different networks or customers that are managed by the SOC or MSSP. This is useful for SOCs who provide services to several different networks, customers or business units within the organization. The Platform comes with a predefined environment named Default Environment.
*
* To get more information about Environment, see:
*
* * [API documentation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1/projects.locations.instances.environments)
* * How-to Guides
* * [Google SecOps Guides](https://cloud.google.com/chronicle/docs/secops/secops-overview)
*
* ## Example Usage
*
* ### Chronicle Environment Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const sample = new gcp.chronicle.Environment("sample", {
* location: "us",
* instance: "00000000-0000-0000-0000-000000000000",
* displayName: "MyEnvironment",
* description: "MyEnvironment is managed with Terraform",
* contact: "Contact",
* contactEmails: "example@example.com",
* contactPhone: "00000",
* aliasesJson: JSON.stringify([]),
* dataAccessScopesJson: JSON.stringify([]),
* retentionDuration: 3,
* deletionProtection: false,
* });
* ```
*
* ## Import
*
* Environment can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/instances/{{instance}}/environments/{{environment_id}}`
* * `{{project}}/{{location}}/{{instance}}/{{environment_id}}`
* * `{{location}}/{{instance}}/{{environment_id}}`
*
* When using the `pulumi import` command, Environment can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:chronicle/environment:Environment default projects/{{project}}/locations/{{location}}/instances/{{instance}}/environments/{{environment_id}}
* $ pulumi import gcp:chronicle/environment:Environment default {{project}}/{{location}}/{{instance}}/{{environment_id}}
* $ pulumi import gcp:chronicle/environment:Environment default {{location}}/{{instance}}/{{environment_id}}
* ```
*/
export declare class Environment extends pulumi.CustomResource {
/**
* Get an existing Environment 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?: EnvironmentState, opts?: pulumi.CustomResourceOptions): Environment;
/**
* Returns true if the given object is an instance of Environment. 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 Environment;
/**
* Environment nicknames.
*/
readonly aliasesJson: pulumi.Output<string | undefined>;
/**
* MAX_NAME_LENGTH = 256
* Name of the contact for the environment.
*/
readonly contact: pulumi.Output<string>;
/**
* MAX_NAME_LENGTH = 256
* Email of the contact for the environment. Multiple emails can be sepereated with the `;` character.
*/
readonly contactEmails: pulumi.Output<string>;
/**
* MAX_NAME_LENGTH = 256
* Phone number of the contact for the environment.
*/
readonly contactPhone: pulumi.Output<string>;
/**
* data access scopes.
*/
readonly dataAccessScopesJson: pulumi.Output<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.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the environment. Deleting an environment will remove all its data and all playbooks, environments, integrations instances, reports and agents related to the environment. Once you delete an environment, it cannot be reversed. Deleting environments via terraform destroy or pulumi up will only succeed if this field is false in the Terraform state.
*/
readonly deletionProtection: pulumi.Output<boolean | undefined>;
/**
* MAX_NAME_LENGTH = 256
* Description of the environment.
*/
readonly description: pulumi.Output<string>;
/**
* Name of the environment
* MAX_NAME_LENGTH = 256
*/
readonly displayName: pulumi.Output<string>;
/**
* Id of the environment record.
*/
readonly environmentId: 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 Environment.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/environments/{environment}
*/
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>;
/**
* Environment data retention in months.
*/
readonly retentionDuration: pulumi.Output<number>;
/**
* Create a Environment 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: EnvironmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Environment resources.
*/
export interface EnvironmentState {
/**
* Environment nicknames.
*/
aliasesJson?: pulumi.Input<string | undefined>;
/**
* MAX_NAME_LENGTH = 256
* Name of the contact for the environment.
*/
contact?: pulumi.Input<string | undefined>;
/**
* MAX_NAME_LENGTH = 256
* Email of the contact for the environment. Multiple emails can be sepereated with the `;` character.
*/
contactEmails?: pulumi.Input<string | undefined>;
/**
* MAX_NAME_LENGTH = 256
* Phone number of the contact for the environment.
*/
contactPhone?: pulumi.Input<string | undefined>;
/**
* data access scopes.
*/
dataAccessScopesJson?: 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>;
/**
* Whether Terraform will be prevented from destroying the environment. Deleting an environment will remove all its data and all playbooks, environments, integrations instances, reports and agents related to the environment. Once you delete an environment, it cannot be reversed. Deleting environments via terraform destroy or pulumi up will only succeed if this field is false in the Terraform state.
*/
deletionProtection?: pulumi.Input<boolean | undefined>;
/**
* MAX_NAME_LENGTH = 256
* Description of the environment.
*/
description?: pulumi.Input<string | undefined>;
/**
* Name of the environment
* MAX_NAME_LENGTH = 256
*/
displayName?: pulumi.Input<string | undefined>;
/**
* Id of the environment record.
*/
environmentId?: 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 Environment.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/environments/{environment}
*/
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>;
/**
* Environment data retention in months.
*/
retentionDuration?: pulumi.Input<number | undefined>;
}
/**
* The set of arguments for constructing a Environment resource.
*/
export interface EnvironmentArgs {
/**
* Environment nicknames.
*/
aliasesJson?: pulumi.Input<string | undefined>;
/**
* MAX_NAME_LENGTH = 256
* Name of the contact for the environment.
*/
contact: pulumi.Input<string>;
/**
* MAX_NAME_LENGTH = 256
* Email of the contact for the environment. Multiple emails can be sepereated with the `;` character.
*/
contactEmails: pulumi.Input<string>;
/**
* MAX_NAME_LENGTH = 256
* Phone number of the contact for the environment.
*/
contactPhone: pulumi.Input<string>;
/**
* data access scopes.
*/
dataAccessScopesJson?: 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>;
/**
* Whether Terraform will be prevented from destroying the environment. Deleting an environment will remove all its data and all playbooks, environments, integrations instances, reports and agents related to the environment. Once you delete an environment, it cannot be reversed. Deleting environments via terraform destroy or pulumi up will only succeed if this field is false in the Terraform state.
*/
deletionProtection?: pulumi.Input<boolean | undefined>;
/**
* MAX_NAME_LENGTH = 256
* Description of the environment.
*/
description: pulumi.Input<string>;
/**
* Name of the environment
* MAX_NAME_LENGTH = 256
*/
displayName: 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>;
/**
* Environment data retention in months.
*/
retentionDuration: pulumi.Input<number>;
}
//# sourceMappingURL=environment.d.ts.map