@pulumi/harness
Version:
A Pulumi package for creating and managing Harness resources.
168 lines (167 loc) • 5.52 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for creating a Harness Filter. This resource support filters of types {Connector, DelegateProfile, Delegate, EnvironmentGroup, FileStore, Environment}
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as harness from "@pulumi/harness";
*
* const test = new harness.platform.Filters("test", {
* identifier: "identifier",
* name: "name",
* orgId: "org_id",
* projectId: "project_id",
* type: "Connector",
* filterProperties: {
* tags: ["foo:bar"],
* filterType: "Connector",
* },
* filterVisibility: "EveryOne",
* });
* ```
*
* ## Import
*
* The `pulumi import` command can be used, for example:
*
* Import account level filter
*
* ```sh
* $ pulumi import harness:platform/filters:Filters example <filter_id>/<type>
* ```
*
* Import org level filter
*
* ```sh
* $ pulumi import harness:platform/filters:Filters example <ord_id>/<filter_id>/<type>
* ```
*
* Import project level filter
*
* ```sh
* $ pulumi import harness:platform/filters:Filters example <org_id>/<project_id>/<filter_id>/<type>
* ```
*/
export declare class Filters extends pulumi.CustomResource {
/**
* Get an existing Filters 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?: FiltersState, opts?: pulumi.CustomResourceOptions): Filters;
/**
* Returns true if the given object is an instance of Filters. 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 Filters;
/**
* Properties of the filter entity defined in Harness.
*/
readonly filterProperties: pulumi.Output<outputs.platform.FiltersFilterProperties>;
/**
* This indicates visibility of filter. By default, everyone can view this filter. Can either be EveryOne or OnlyCreator
*/
readonly filterVisibility: pulumi.Output<string>;
/**
* Unique identifier of the resource
*/
readonly identifier: pulumi.Output<string>;
/**
* Name of the Filter
*/
readonly name: pulumi.Output<string>;
/**
* organization Identifier for the Entity
*/
readonly orgId: pulumi.Output<string | undefined>;
/**
* project Identifier for the Entity
*/
readonly projectId: pulumi.Output<string | undefined>;
/**
* Type of filter. Currently supported types are {Connector, DelegateProfile, Delegate, EnvironmentGroup, FileStore, Environment}
*/
readonly type: pulumi.Output<string>;
/**
* Create a Filters 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: FiltersArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Filters resources.
*/
export interface FiltersState {
/**
* Properties of the filter entity defined in Harness.
*/
filterProperties?: pulumi.Input<inputs.platform.FiltersFilterProperties>;
/**
* This indicates visibility of filter. By default, everyone can view this filter. Can either be EveryOne or OnlyCreator
*/
filterVisibility?: pulumi.Input<string>;
/**
* Unique identifier of the resource
*/
identifier?: pulumi.Input<string>;
/**
* Name of the Filter
*/
name?: pulumi.Input<string>;
/**
* organization Identifier for the Entity
*/
orgId?: pulumi.Input<string>;
/**
* project Identifier for the Entity
*/
projectId?: pulumi.Input<string>;
/**
* Type of filter. Currently supported types are {Connector, DelegateProfile, Delegate, EnvironmentGroup, FileStore, Environment}
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Filters resource.
*/
export interface FiltersArgs {
/**
* Properties of the filter entity defined in Harness.
*/
filterProperties: pulumi.Input<inputs.platform.FiltersFilterProperties>;
/**
* This indicates visibility of filter. By default, everyone can view this filter. Can either be EveryOne or OnlyCreator
*/
filterVisibility?: pulumi.Input<string>;
/**
* Unique identifier of the resource
*/
identifier: pulumi.Input<string>;
/**
* Name of the Filter
*/
name?: pulumi.Input<string>;
/**
* organization Identifier for the Entity
*/
orgId?: pulumi.Input<string>;
/**
* project Identifier for the Entity
*/
projectId?: pulumi.Input<string>;
/**
* Type of filter. Currently supported types are {Connector, DelegateProfile, Delegate, EnvironmentGroup, FileStore, Environment}
*/
type: pulumi.Input<string>;
}