@pulumi/harness/platform/environmentGroup.d.ts

A Pulumi package for creating and managing Harness resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Resource for creating a Harness environment group.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as harness from "@pulumi/harness";
 *
 * const example = new harness.platform.EnvironmentGroup("example", {
 *     identifier: "identifier",
 *     orgId: "orgIdentifer",
 *     projectId: "projectIdentifier",
 *     color: "#0063F7",
 *     yaml: `environmentGroup:
 *   name: "name"
 *   identifier: "identifier"
 *   description: "temp"
 *   orgIdentifier: "orgIdentifer"
 *   projectIdentifier: "projectIdentifier"
 *   envIdentifiers: []
 * `,
 * });
 * ```
 *
 * ## Import
 *
 * The `pulumi import` command can be used, for example:
 *
 * Import account level environment group.
 *
 * ```sh
 * $ pulumi import harness:platform/environmentGroup:EnvironmentGroup example <environment_group_id>
 * ```
 *
 * Import org level environment group.
 *
 * ```sh
 * $ pulumi import harness:platform/environmentGroup:EnvironmentGroup example <org_id>/<environment_group_id>
 * ```
 *
 * Import project level environment group.
 *
 * ```sh
 * $ pulumi import harness:platform/environmentGroup:EnvironmentGroup example <org_id>/<project_id>/<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;
    /**
     * Color of the environment group.
     */
    readonly color: pulumi.Output<string>;
    /**
     * Enable this flag for force deletion of environment group
     */
    readonly forceDelete: pulumi.Output<boolean>;
    /**
     * identifier of the environment group.
     */
    readonly identifier: pulumi.Output<string>;
    /**
     * org_id of the environment group.
     */
    readonly orgId: pulumi.Output<string | undefined>;
    /**
     * project_id of the environment group.
     */
    readonly projectId: pulumi.Output<string | undefined>;
    /**
     * Env group YAML. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
     */
    readonly yaml: 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 {
    /**
     * Color of the environment group.
     */
    color?: pulumi.Input<string>;
    /**
     * Enable this flag for force deletion of environment group
     */
    forceDelete?: pulumi.Input<boolean>;
    /**
     * identifier of the environment group.
     */
    identifier?: pulumi.Input<string>;
    /**
     * org_id of the environment group.
     */
    orgId?: pulumi.Input<string>;
    /**
     * project_id of the environment group.
     */
    projectId?: pulumi.Input<string>;
    /**
     * Env group YAML. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
     */
    yaml?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a EnvironmentGroup resource.
 */
export interface EnvironmentGroupArgs {
    /**
     * Color of the environment group.
     */
    color?: pulumi.Input<string>;
    /**
     * Enable this flag for force deletion of environment group
     */
    forceDelete?: pulumi.Input<boolean>;
    /**
     * identifier of the environment group.
     */
    identifier: pulumi.Input<string>;
    /**
     * org_id of the environment group.
     */
    orgId?: pulumi.Input<string>;
    /**
     * project_id of the environment group.
     */
    projectId?: pulumi.Input<string>;
    /**
     * Env group YAML. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
     */
    yaml: pulumi.Input<string>;
}