@pulumi/gcp/chronicle/environmentGroup.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Environment groups let you organize multiple environments into logical categories, making it easier to manage large organizations or multiple customers as a Managed Security Service Provider (MSSP).
 *
 * > **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 EnvironmentGroup, see:
 *
 * * [API documentation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.environmentGroups)
 * * How-to Guides
 *     * [Google SecOps Guides](https://cloud.google.com/chronicle/docs/secops/secops-overview)
 *
 * ## Example Usage
 *
 * ### Chronicle Environmentgroup Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const sample = new gcp.chronicle.EnvironmentGroup("sample", {
 *     location: "us",
 *     instance: "00000000-0000-0000-0000-000000000000",
 *     displayName: "myEnvironmentGroup",
 *     description: "My Environment Description",
 *     environmentsIds: ["Default Environment"],
 * });
 * ```
 *
 * ## Import
 *
 * EnvironmentGroup can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/instances/{{instance}}/environmentGroups/{{environment_group_id}}`
 * * `{{project}}/{{location}}/{{instance}}/{{environment_group_id}}`
 * * `{{location}}/{{instance}}/{{environment_group_id}}`
 *
 * When using the `pulumi import` command, EnvironmentGroup can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:chronicle/environmentGroup:EnvironmentGroup default projects/{{project}}/locations/{{location}}/instances/{{instance}}/environmentGroups/{{environment_group_id}}
 * $ pulumi import gcp:chronicle/environmentGroup:EnvironmentGroup default {{project}}/{{location}}/{{instance}}/{{environment_group_id}}
 * $ pulumi import gcp:chronicle/environmentGroup:EnvironmentGroup default {{location}}/{{instance}}/{{environment_group_id}}
 * ```
 */
export declare class EnvironmentGroup extends pulumi.CustomResource {
    /**
     * Get an existing EnvironmentGroup 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?: EnvironmentGroupState, opts?: pulumi.CustomResourceOptions): EnvironmentGroup;
    /**
     * Returns true if the given object is an instance of EnvironmentGroup.  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 EnvironmentGroup;
    /**
     * 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 EnvironmentGroup description.
     * This value is optional. This value should be up to
     * 250 characters, and valid characters are /a-z-/.
     */
    readonly description: pulumi.Output<string>;
    /**
     * The group name.
     */
    readonly displayName: pulumi.Output<string>;
    /**
     * Id of the environment group record.
     */
    readonly environmentGroupId: pulumi.Output<string>;
    /**
     * The environment IDs for the group.
     */
    readonly environmentsIds: 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 environment group.
     * Format:
     * projects/{project}/locations/{location}/instances/{instance}/environmentGroups/{environment_group}
     */
    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 EnvironmentGroup 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: EnvironmentGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering EnvironmentGroup resources.
 */
export interface EnvironmentGroupState {
    /**
     * 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 EnvironmentGroup description.
     * This value is optional. This value should be up to
     * 250 characters, and valid characters are /a-z-/.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * The group name.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * Id of the environment group record.
     */
    environmentGroupId?: pulumi.Input<string | undefined>;
    /**
     * The environment IDs for the group.
     */
    environmentsIds?: pulumi.Input<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 environment group.
     * Format:
     * projects/{project}/locations/{location}/instances/{instance}/environmentGroups/{environment_group}
     */
    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 EnvironmentGroup resource.
 */
export interface EnvironmentGroupArgs {
    /**
     * 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 EnvironmentGroup description.
     * This value is optional. This value should be up to
     * 250 characters, and valid characters are /a-z-/.
     */
    description: pulumi.Input<string>;
    /**
     * The group name.
     */
    displayName: pulumi.Input<string>;
    /**
     * The environment IDs for the group.
     */
    environmentsIds: pulumi.Input<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=environmentGroup.d.ts.map