UNPKG

@pulumi/harness

Version:

A Pulumi package for creating and managing Harness resources.

269 lines (268 loc) 8.74 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Resource for creating Harness Pipeline Filters. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as harness from "@pulumi/harness"; * * const test = new harness.platform.PipelineFilters("test", { * identifier: "identifier", * name: "name", * orgId: "org_id", * projectId: "project_id", * type: "PipelineSetup", * filterProperties: { * name: "pipeline_name", * description: "pipeline_description", * pipelineIdentifiers: [ * "id1", * "id2", * ], * filterType: "PipelineSetup", * }, * filterVisibility: "EveryOne", * }); * // pipeline execution filter consisiting services (service_identifiers) filter * const execution = new harness.platform.PipelineFilters("execution", { * identifier: "identifier", * name: "name", * orgId: "org_id", * projectId: "project_id", * type: "PipelineSetup", * filterProperties: { * name: "pipeline_name", * description: "pipeline_description", * pipelineIdentifiers: [ * "id1", * "id2", * ], * filterType: "PipelineExecution", * moduleProperties: { * cd: { * deploymentTypes: "Kubernetes", * serviceIdentifiers: ["nginx"], * }, * }, * }, * filterVisibility: "EveryOne", * }); * // pipeline filter with tags * const exampleWithTags = new harness.platform.PipelineFilters("example_with_tags", { * identifier: "identifier", * name: "name", * orgId: "org_id", * projectId: "project_id", * type: "PipelineSetup", * filterProperties: { * filterType: "PipelineSetup", * pipelineTags: [ * { * key: "tag1", * value: "123", * }, * { * key: "tag2", * value: "456", * }, * ], * moduleProperties: { * cd: { * deploymentTypes: "Kubernetes", * serviceNames: [ * "service1", * "service2", * ], * environmentNames: [ * "env1", * "env2", * ], * artifactDisplayNames: [ * "artificatname1", * "artifact2", * ], * }, * ci: { * buildType: "branch", * branch: "branch123", * repoNames: "repo1234", * }, * }, * }, * }); * const pipelinemoduleproperties = new harness.platform.PipelineFilters("pipelinemoduleproperties", { * identifier: "identifier", * name: "name", * orgId: testHarnessPlatformProject.orgId, * projectId: testHarnessPlatformProject.id, * type: "PipelineExecution", * filterProperties: { * filterType: "PipelineExecution", * pipelineName: "test", * pipelineTags: [ * { * key: "k1", * value: "v1", * }, * { * key: "k2", * value: "v2", * }, * ], * moduleProperties: { * cd: { * serviceDefinitionTypes: "Kubernetes", * serviceIdentifiers: ["K8"], * environmentIdentifiers: ["dev"], * artifactDisplayNames: ["artificatname1"], * }, * }, * }, * }); * ``` * * ## Import * * The `pulumi import` command can be used, for example: * * Import account level pipeline filter * * ```sh * $ pulumi import harness:platform/pipelineFilters:PipelineFilters example <filter_id>/<type> * ``` * * Import org level pipeline filter * * ```sh * $ pulumi import harness:platform/pipelineFilters:PipelineFilters example <ord_id>/<filter_id>/<type> * ``` * * Import project level pipeline filter * * ```sh * $ pulumi import harness:platform/pipelineFilters:PipelineFilters example <org_id>/<project_id>/<filter_id>/<type> * ``` */ export declare class PipelineFilters extends pulumi.CustomResource { /** * Get an existing PipelineFilters 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?: PipelineFiltersState, opts?: pulumi.CustomResourceOptions): PipelineFilters; /** * Returns true if the given object is an instance of PipelineFilters. 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 PipelineFilters; /** * Properties of the filters entity defined in Harness. */ readonly filterProperties: pulumi.Output<outputs.platform.PipelineFiltersFilterProperties>; /** * This indicates visibility of filters. By default, everyone can view this filter. */ readonly filterVisibility: pulumi.Output<string>; /** * Unique identifier of the resource. */ readonly identifier: pulumi.Output<string>; /** * Name of the pipeline filters. */ 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 pipeline filters. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment} */ readonly type: pulumi.Output<string>; /** * Create a PipelineFilters 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: PipelineFiltersArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering PipelineFilters resources. */ export interface PipelineFiltersState { /** * Properties of the filters entity defined in Harness. */ filterProperties?: pulumi.Input<inputs.platform.PipelineFiltersFilterProperties>; /** * This indicates visibility of filters. By default, everyone can view this filter. */ filterVisibility?: pulumi.Input<string>; /** * Unique identifier of the resource. */ identifier?: pulumi.Input<string>; /** * Name of the pipeline filters. */ name?: pulumi.Input<string>; /** * Organization Identifier for the Entity. */ orgId?: pulumi.Input<string>; /** * Project Identifier for the Entity. */ projectId?: pulumi.Input<string>; /** * Type of pipeline filters. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment} */ type?: pulumi.Input<string>; } /** * The set of arguments for constructing a PipelineFilters resource. */ export interface PipelineFiltersArgs { /** * Properties of the filters entity defined in Harness. */ filterProperties: pulumi.Input<inputs.platform.PipelineFiltersFilterProperties>; /** * This indicates visibility of filters. By default, everyone can view this filter. */ filterVisibility?: pulumi.Input<string>; /** * Unique identifier of the resource. */ identifier: pulumi.Input<string>; /** * Name of the pipeline filters. */ name?: pulumi.Input<string>; /** * Organization Identifier for the Entity. */ orgId?: pulumi.Input<string>; /** * Project Identifier for the Entity. */ projectId?: pulumi.Input<string>; /** * Type of pipeline filters. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment} */ type: pulumi.Input<string>; }