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

A Pulumi package for creating and managing Harness resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Resource for creating a Harness Resource Group
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as harness from "@pulumi/harness";
 *
 * const test = new harness.platform.ResourceGroup("test", {
 *     identifier: "identifier",
 *     name: "name",
 *     description: "test",
 *     tags: ["foo:bar"],
 *     accountId: "account_id",
 *     allowedScopeLevels: ["account"],
 *     includedScopes: [{
 *         filter: "EXCLUDING_CHILD_SCOPES",
 *         accountId: "account_id",
 *     }],
 *     resourceFilters: [{
 *         includeAllResources: false,
 *         resources: [{
 *             resourceType: "CONNECTOR",
 *             attributeFilters: [{
 *                 attributeName: "category",
 *                 attributeValues: ["CLOUD_COST"],
 *             }],
 *         }],
 *     }],
 * });
 * ```
 *
 * ## Import
 *
 * The `pulumi import` command can be used, for example:
 *
 * Import account level resource group
 *
 * ```sh
 * $ pulumi import harness:platform/resourceGroup:ResourceGroup example <resource_group_id>
 * ```
 *
 * Import org level resource group
 *
 * ```sh
 * $ pulumi import harness:platform/resourceGroup:ResourceGroup example <ord_id>/<resource_group_id>
 * ```
 *
 * Import project level resource group
 *
 * ```sh
 * $ pulumi import harness:platform/resourceGroup:ResourceGroup example <org_id>/<project_id>/<resource_group_id>
 * ```
 */
export declare class ResourceGroup extends pulumi.CustomResource {
    /**
     * Get an existing ResourceGroup 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?: ResourceGroupState, opts?: pulumi.CustomResourceOptions): ResourceGroup;
    /**
     * Returns true if the given object is an instance of ResourceGroup.  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 ResourceGroup;
    /**
     * Account Identifier of the account
     */
    readonly accountId: pulumi.Output<string>;
    /**
     * The scope levels at which this resource group can be used
     */
    readonly allowedScopeLevels: pulumi.Output<string[]>;
    /**
     * Color of the environment.
     */
    readonly color: pulumi.Output<string>;
    /**
     * Description of the resource.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Unique identifier of the resource.
     */
    readonly identifier: pulumi.Output<string>;
    /**
     * Included scopes; default selected based on resource group scope if not specified.
     */
    readonly includedScopes: pulumi.Output<outputs.platform.ResourceGroupIncludedScope[] | undefined>;
    /**
     * Name of the resource.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Unique identifier of the organization.
     */
    readonly orgId: pulumi.Output<string | undefined>;
    /**
     * Unique identifier of the project.
     */
    readonly projectId: pulumi.Output<string | undefined>;
    /**
     * Contains resource filter for a resource group
     */
    readonly resourceFilters: pulumi.Output<outputs.platform.ResourceGroupResourceFilter[] | undefined>;
    /**
     * Tags to associate with the resource.
     */
    readonly tags: pulumi.Output<string[] | undefined>;
    /**
     * Create a ResourceGroup 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: ResourceGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ResourceGroup resources.
 */
export interface ResourceGroupState {
    /**
     * Account Identifier of the account
     */
    accountId?: pulumi.Input<string>;
    /**
     * The scope levels at which this resource group can be used
     */
    allowedScopeLevels?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Color of the environment.
     */
    color?: pulumi.Input<string>;
    /**
     * Description of the resource.
     */
    description?: pulumi.Input<string>;
    /**
     * Unique identifier of the resource.
     */
    identifier?: pulumi.Input<string>;
    /**
     * Included scopes; default selected based on resource group scope if not specified.
     */
    includedScopes?: pulumi.Input<pulumi.Input<inputs.platform.ResourceGroupIncludedScope>[]>;
    /**
     * Name of the resource.
     */
    name?: pulumi.Input<string>;
    /**
     * Unique identifier of the organization.
     */
    orgId?: pulumi.Input<string>;
    /**
     * Unique identifier of the project.
     */
    projectId?: pulumi.Input<string>;
    /**
     * Contains resource filter for a resource group
     */
    resourceFilters?: pulumi.Input<pulumi.Input<inputs.platform.ResourceGroupResourceFilter>[]>;
    /**
     * Tags to associate with the resource.
     */
    tags?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
 * The set of arguments for constructing a ResourceGroup resource.
 */
export interface ResourceGroupArgs {
    /**
     * Account Identifier of the account
     */
    accountId: pulumi.Input<string>;
    /**
     * The scope levels at which this resource group can be used
     */
    allowedScopeLevels?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Color of the environment.
     */
    color?: pulumi.Input<string>;
    /**
     * Description of the resource.
     */
    description?: pulumi.Input<string>;
    /**
     * Unique identifier of the resource.
     */
    identifier: pulumi.Input<string>;
    /**
     * Included scopes; default selected based on resource group scope if not specified.
     */
    includedScopes?: pulumi.Input<pulumi.Input<inputs.platform.ResourceGroupIncludedScope>[]>;
    /**
     * Name of the resource.
     */
    name?: pulumi.Input<string>;
    /**
     * Unique identifier of the organization.
     */
    orgId?: pulumi.Input<string>;
    /**
     * Unique identifier of the project.
     */
    projectId?: pulumi.Input<string>;
    /**
     * Contains resource filter for a resource group
     */
    resourceFilters?: pulumi.Input<pulumi.Input<inputs.platform.ResourceGroupResourceFilter>[]>;
    /**
     * Tags to associate with the resource.
     */
    tags?: pulumi.Input<pulumi.Input<string>[]>;
}