Docs Packages
  1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. PipelineFilters
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs
lbrlabs/pulumi-harness

harness.platform.PipelineFilters

Explore with Pulumi AI

harness logo
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs
lbrlabs/pulumi-harness

    Resource for creating Harness Pipeline Filters.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Harness = Lbrlabs.PulumiPackage.Harness;

return await Deployment.RunAsync(() => 
{
    var test = new Harness.Platform.PipelineFilters("test", new()
    {
        FilterProperties = new Harness.Platform.Inputs.PipelineFiltersFilterPropertiesArgs
        {
            FilterType = "PipelineExecution",
            Tags = new[]
            {
                "foo:bar",
            },
        },
        FilterVisibility = "EveryOne",
        Identifier = "identifier",
        OrgId = "org_id",
        ProjectId = "project_id",
        Type = "PipelineExecution",
    });

});

    package main

import (
	"github.com/lbrlabs/pulumi-harness/sdk/go/harness/platform"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := platform.NewPipelineFilters(ctx, "test", &platform.PipelineFiltersArgs{
			FilterProperties: &platform.PipelineFiltersFilterPropertiesArgs{
				FilterType: pulumi.String("PipelineExecution"),
				Tags: pulumi.StringArray{
					pulumi.String("foo:bar"),
				},
			},
			FilterVisibility: pulumi.String("EveryOne"),
			Identifier:       pulumi.String("identifier"),
			OrgId:            pulumi.String("org_id"),
			ProjectId:        pulumi.String("project_id"),
			Type:             pulumi.String("PipelineExecution"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.platform.PipelineFilters;
import com.pulumi.harness.platform.PipelineFiltersArgs;
import com.pulumi.harness.platform.inputs.PipelineFiltersFilterPropertiesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new PipelineFilters("test", PipelineFiltersArgs.builder()        
            .filterProperties(PipelineFiltersFilterPropertiesArgs.builder()
                .filterType("PipelineExecution")
                .tags("foo:bar")
                .build())
            .filterVisibility("EveryOne")
            .identifier("identifier")
            .orgId("org_id")
            .projectId("project_id")
            .type("PipelineExecution")
            .build());

    }
}

    import pulumi
import lbrlabs_pulumi_harness as harness

test = harness.platform.PipelineFilters("test",
    filter_properties=harness.platform.PipelineFiltersFilterPropertiesArgs(
        filter_type="PipelineExecution",
        tags=["foo:bar"],
    ),
    filter_visibility="EveryOne",
    identifier="identifier",
    org_id="org_id",
    project_id="project_id",
    type="PipelineExecution")

    import * as pulumi from "@pulumi/pulumi";
import * as harness from "@lbrlabs/pulumi-harness";

const test = new harness.platform.PipelineFilters("test", {
    filterProperties: {
        filterType: "PipelineExecution",
        tags: ["foo:bar"],
    },
    filterVisibility: "EveryOne",
    identifier: "identifier",
    orgId: "org_id",
    projectId: "project_id",
    type: "PipelineExecution",
});

    resources:
  test:
    type: harness:platform:PipelineFilters
    properties:
      filterProperties:
        filterType: PipelineExecution
        tags:
          - foo:bar
      filterVisibility: EveryOne
      identifier: identifier
      orgId: org_id
      projectId: project_id
      type: PipelineExecution

    Create PipelineFilters Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PipelineFilters(name: string, args: PipelineFiltersArgs, opts?: CustomResourceOptions);
    @overload
def PipelineFilters(resource_name: str,
                    args: PipelineFiltersArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def PipelineFilters(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    filter_properties: Optional[PipelineFiltersFilterPropertiesArgs] = None,
                    identifier: Optional[str] = None,
                    type: Optional[str] = None,
                    filter_visibility: Optional[str] = None,
                    name: Optional[str] = None,
                    org_id: Optional[str] = None,
                    project_id: Optional[str] = None)
    func NewPipelineFilters(ctx *Context, name string, args PipelineFiltersArgs, opts ...ResourceOption) (*PipelineFilters, error)
    public PipelineFilters(string name, PipelineFiltersArgs args, CustomResourceOptions? opts = null)
    public PipelineFilters(String name, PipelineFiltersArgs args)
public PipelineFilters(String name, PipelineFiltersArgs args, CustomResourceOptions options)

    type: harness:platform:PipelineFilters
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PipelineFiltersArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PipelineFiltersArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PipelineFiltersArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PipelineFiltersArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PipelineFiltersArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var pipelineFiltersResource = new Harness.Platform.PipelineFilters("pipelineFiltersResource", new()
{
    FilterProperties = new Harness.Platform.Inputs.PipelineFiltersFilterPropertiesArgs
    {
        FilterType = "string",
        Tags = new[]
        {
            "string",
        },
    },
    Identifier = "string",
    Type = "string",
    FilterVisibility = "string",
    Name = "string",
    OrgId = "string",
    ProjectId = "string",
});

    example, err := platform.NewPipelineFilters(ctx, "pipelineFiltersResource", &platform.PipelineFiltersArgs{
	FilterProperties: &platform.PipelineFiltersFilterPropertiesArgs{
		FilterType: pulumi.String("string"),
		Tags: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Identifier:       pulumi.String("string"),
	Type:             pulumi.String("string"),
	FilterVisibility: pulumi.String("string"),
	Name:             pulumi.String("string"),
	OrgId:            pulumi.String("string"),
	ProjectId:        pulumi.String("string"),
})

    var pipelineFiltersResource = new PipelineFilters("pipelineFiltersResource", PipelineFiltersArgs.builder()        
    .filterProperties(PipelineFiltersFilterPropertiesArgs.builder()
        .filterType("string")
        .tags("string")
        .build())
    .identifier("string")
    .type("string")
    .filterVisibility("string")
    .name("string")
    .orgId("string")
    .projectId("string")
    .build());

    pipeline_filters_resource = harness.platform.PipelineFilters("pipelineFiltersResource",
    filter_properties=harness.platform.PipelineFiltersFilterPropertiesArgs(
        filter_type="string",
        tags=["string"],
    ),
    identifier="string",
    type="string",
    filter_visibility="string",
    name="string",
    org_id="string",
    project_id="string")

    const pipelineFiltersResource = new harness.platform.PipelineFilters("pipelineFiltersResource", {
    filterProperties: {
        filterType: "string",
        tags: ["string"],
    },
    identifier: "string",
    type: "string",
    filterVisibility: "string",
    name: "string",
    orgId: "string",
    projectId: "string",
});

    type: harness:platform:PipelineFilters
properties:
    filterProperties:
        filterType: string
        tags:
            - string
    filterVisibility: string
    identifier: string
    name: string
    orgId: string
    projectId: string
    type: string

    PipelineFilters Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The PipelineFilters resource accepts the following input properties:

    FilterProperties Lbrlabs.PulumiPackage.Harness.Platform.Inputs.PipelineFiltersFilterProperties
    Properties of the filters entity defined in Harness.
    Identifier string
    Unique identifier of the resource.
    Type string
    Type of pipeline filters. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}
    FilterVisibility string
    This indicates visibility of filters. By default, everyone can view this filter.
    Name string
    Name of the pipeline filters.
    OrgId string
    Organization Identifier for the Entity.
    ProjectId string
    Project Identifier for the Entity.
    FilterProperties PipelineFiltersFilterPropertiesArgs
    Properties of the filters entity defined in Harness.
    Identifier string
    Unique identifier of the resource.
    Type string
    Type of pipeline filters. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}
    FilterVisibility string
    This indicates visibility of filters. By default, everyone can view this filter.
    Name string
    Name of the pipeline filters.
    OrgId string
    Organization Identifier for the Entity.
    ProjectId string
    Project Identifier for the Entity.
    filterProperties PipelineFiltersFilterProperties
    Properties of the filters entity defined in Harness.
    identifier String
    Unique identifier of the resource.
    type String
    Type of pipeline filters. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}
    filterVisibility String
    This indicates visibility of filters. By default, everyone can view this filter.
    name String
    Name of the pipeline filters.
    orgId String
    Organization Identifier for the Entity.
    projectId String
    Project Identifier for the Entity.
    filterProperties PipelineFiltersFilterProperties
    Properties of the filters entity defined in Harness.
    identifier string
    Unique identifier of the resource.
    type string
    Type of pipeline filters. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}
    filterVisibility string
    This indicates visibility of filters. By default, everyone can view this filter.
    name string
    Name of the pipeline filters.
    orgId string
    Organization Identifier for the Entity.
    projectId string
    Project Identifier for the Entity.
    filter_properties PipelineFiltersFilterPropertiesArgs
    Properties of the filters entity defined in Harness.
    identifier str
    Unique identifier of the resource.
    type str
    Type of pipeline filters. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}
    filter_visibility str
    This indicates visibility of filters. By default, everyone can view this filter.
    name str
    Name of the pipeline filters.
    org_id str
    Organization Identifier for the Entity.
    project_id str
    Project Identifier for the Entity.
    filterProperties Property Map
    Properties of the filters entity defined in Harness.
    identifier String
    Unique identifier of the resource.
    type String
    Type of pipeline filters. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}
    filterVisibility String
    This indicates visibility of filters. By default, everyone can view this filter.
    name String
    Name of the pipeline filters.
    orgId String
    Organization Identifier for the Entity.
    projectId String
    Project Identifier for the Entity.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PipelineFilters resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing PipelineFilters Resource

    Get an existing PipelineFilters resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PipelineFiltersState, opts?: CustomResourceOptions): PipelineFilters
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        filter_properties: Optional[PipelineFiltersFilterPropertiesArgs] = None,
        filter_visibility: Optional[str] = None,
        identifier: Optional[str] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        project_id: Optional[str] = None,
        type: Optional[str] = None) -> PipelineFilters
    func GetPipelineFilters(ctx *Context, name string, id IDInput, state *PipelineFiltersState, opts ...ResourceOption) (*PipelineFilters, error)
    public static PipelineFilters Get(string name, Input<string> id, PipelineFiltersState? state, CustomResourceOptions? opts = null)
    public static PipelineFilters get(String name, Output<String> id, PipelineFiltersState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    FilterProperties Lbrlabs.PulumiPackage.Harness.Platform.Inputs.PipelineFiltersFilterProperties
    Properties of the filters entity defined in Harness.
    FilterVisibility string
    This indicates visibility of filters. By default, everyone can view this filter.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the pipeline filters.
    OrgId string
    Organization Identifier for the Entity.
    ProjectId string
    Project Identifier for the Entity.
    Type string
    Type of pipeline filters. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}
    FilterProperties PipelineFiltersFilterPropertiesArgs
    Properties of the filters entity defined in Harness.
    FilterVisibility string
    This indicates visibility of filters. By default, everyone can view this filter.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the pipeline filters.
    OrgId string
    Organization Identifier for the Entity.
    ProjectId string
    Project Identifier for the Entity.
    Type string
    Type of pipeline filters. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}
    filterProperties PipelineFiltersFilterProperties
    Properties of the filters entity defined in Harness.
    filterVisibility String
    This indicates visibility of filters. By default, everyone can view this filter.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the pipeline filters.
    orgId String
    Organization Identifier for the Entity.
    projectId String
    Project Identifier for the Entity.
    type String
    Type of pipeline filters. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}
    filterProperties PipelineFiltersFilterProperties
    Properties of the filters entity defined in Harness.
    filterVisibility string
    This indicates visibility of filters. By default, everyone can view this filter.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the pipeline filters.
    orgId string
    Organization Identifier for the Entity.
    projectId string
    Project Identifier for the Entity.
    type string
    Type of pipeline filters. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}
    filter_properties PipelineFiltersFilterPropertiesArgs
    Properties of the filters entity defined in Harness.
    filter_visibility str
    This indicates visibility of filters. By default, everyone can view this filter.
    identifier str
    Unique identifier of the resource.
    name str
    Name of the pipeline filters.
    org_id str
    Organization Identifier for the Entity.
    project_id str
    Project Identifier for the Entity.
    type str
    Type of pipeline filters. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}
    filterProperties Property Map
    Properties of the filters entity defined in Harness.
    filterVisibility String
    This indicates visibility of filters. By default, everyone can view this filter.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the pipeline filters.
    orgId String
    Organization Identifier for the Entity.
    projectId String
    Project Identifier for the Entity.
    type String
    Type of pipeline filters. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}

    Supporting Types

    PipelineFiltersFilterProperties, PipelineFiltersFilterPropertiesArgs

    FilterType string
    Corresponding Entity of the filters. Currently supported types are {Connector, DelegateProfile, Delegate, PipelineSetup, PipelineExecution, Deployment, Audit, Template, EnvironmentGroup, FileStore, CCMRecommendation, Anomaly, Environment}.
    Tags List<string>
    Tags to associate with the resource. Tags should be in the form name:value.
    FilterType string
    Corresponding Entity of the filters. Currently supported types are {Connector, DelegateProfile, Delegate, PipelineSetup, PipelineExecution, Deployment, Audit, Template, EnvironmentGroup, FileStore, CCMRecommendation, Anomaly, Environment}.
    Tags []string
    Tags to associate with the resource. Tags should be in the form name:value.
    filterType String
    Corresponding Entity of the filters. Currently supported types are {Connector, DelegateProfile, Delegate, PipelineSetup, PipelineExecution, Deployment, Audit, Template, EnvironmentGroup, FileStore, CCMRecommendation, Anomaly, Environment}.
    tags List<String>
    Tags to associate with the resource. Tags should be in the form name:value.
    filterType string
    Corresponding Entity of the filters. Currently supported types are {Connector, DelegateProfile, Delegate, PipelineSetup, PipelineExecution, Deployment, Audit, Template, EnvironmentGroup, FileStore, CCMRecommendation, Anomaly, Environment}.
    tags string[]
    Tags to associate with the resource. Tags should be in the form name:value.
    filter_type str
    Corresponding Entity of the filters. Currently supported types are {Connector, DelegateProfile, Delegate, PipelineSetup, PipelineExecution, Deployment, Audit, Template, EnvironmentGroup, FileStore, CCMRecommendation, Anomaly, Environment}.
    tags Sequence[str]
    Tags to associate with the resource. Tags should be in the form name:value.
    filterType String
    Corresponding Entity of the filters. Currently supported types are {Connector, DelegateProfile, Delegate, PipelineSetup, PipelineExecution, Deployment, Audit, Template, EnvironmentGroup, FileStore, CCMRecommendation, Anomaly, Environment}.
    tags List<String>
    Tags to associate with the resource. Tags should be in the form name:value.

    Import

    Import account level pipeline filter

     $ pulumi import harness:platform/pipelineFilters:PipelineFilters example <filter_id>/<type>

    Import org level pipeline filter

     $ pulumi import harness:platform/pipelineFilters:PipelineFilters example <ord_id>/<filter_id>/<type>

    Import project level pipeline filter

     $ pulumi import harness:platform/pipelineFilters:PipelineFilters example <org_id>/<project_id>/<filter_id>/<type>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    harness lbrlabs/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs
    lbrlabs/pulumi-harness