Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harness Provider
  3. API Docs
  4. platform
  5. PipelineFilters
Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-harness

harness.platform.PipelineFilters

Explore with Pulumi AI

harness logo
Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-harness

    Resource for creating Harness Pipeline Filters.

    Example Usage

    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 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",
            },
        },
    },
});

    import pulumi
import pulumi_harness as harness

test = harness.platform.PipelineFilters("test",
    identifier="identifier",
    name="name",
    org_id="org_id",
    project_id="project_id",
    type="PipelineSetup",
    filter_properties={
        "name": "pipeline_name",
        "description": "pipeline_description",
        "pipeline_identifiers": [
            "id1",
            "id2",
        ],
        "filter_type": "PipelineSetup",
    },
    filter_visibility="EveryOne")
# pipeline filter with tags
example_with_tags = harness.platform.PipelineFilters("example_with_tags",
    identifier="identifier",
    name="name",
    org_id="org_id",
    project_id="project_id",
    type="PipelineSetup",
    filter_properties={
        "filter_type": "PipelineSetup",
        "pipeline_tags": [
            {
                "key": "tag1",
                "value": "123",
            },
            {
                "key": "tag2",
                "value": "456",
            },
        ],
        "module_properties": {
            "cd": {
                "deployment_types": "Kubernetes",
                "service_names": [
                    "service1",
                    "service2",
                ],
                "environment_names": [
                    "env1",
                    "env2",
                ],
                "artifact_display_names": [
                    "artificatname1",
                    "artifact2",
                ],
            },
            "ci": {
                "build_type": "branch",
                "branch": "branch123",
                "repo_names": "repo1234",
            },
        },
    })

    package main

import (
	"github.com/pulumi/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{
			Identifier: pulumi.String("identifier"),
			Name:       pulumi.String("name"),
			OrgId:      pulumi.String("org_id"),
			ProjectId:  pulumi.String("project_id"),
			Type:       pulumi.String("PipelineSetup"),
			FilterProperties: &platform.PipelineFiltersFilterPropertiesArgs{
				Name:        pulumi.String("pipeline_name"),
				Description: pulumi.String("pipeline_description"),
				PipelineIdentifiers: pulumi.StringArray{
					pulumi.String("id1"),
					pulumi.String("id2"),
				},
				FilterType: pulumi.String("PipelineSetup"),
			},
			FilterVisibility: pulumi.String("EveryOne"),
		})
		if err != nil {
			return err
		}
		// pipeline filter with tags
		_, err = platform.NewPipelineFilters(ctx, "example_with_tags", &platform.PipelineFiltersArgs{
			Identifier: pulumi.String("identifier"),
			Name:       pulumi.String("name"),
			OrgId:      pulumi.String("org_id"),
			ProjectId:  pulumi.String("project_id"),
			Type:       pulumi.String("PipelineSetup"),
			FilterProperties: &platform.PipelineFiltersFilterPropertiesArgs{
				FilterType: pulumi.String("PipelineSetup"),
				PipelineTags: pulumi.StringMapArray{
					pulumi.StringMap{
						"key":   pulumi.String("tag1"),
						"value": pulumi.String("123"),
					},
					pulumi.StringMap{
						"key":   pulumi.String("tag2"),
						"value": pulumi.String("456"),
					},
				},
				ModuleProperties: &platform.PipelineFiltersFilterPropertiesModulePropertiesArgs{
					Cd: &platform.PipelineFiltersFilterPropertiesModulePropertiesCdArgs{
						DeploymentTypes: pulumi.String("Kubernetes"),
						ServiceNames: pulumi.StringArray{
							pulumi.String("service1"),
							pulumi.String("service2"),
						},
						EnvironmentNames: pulumi.StringArray{
							pulumi.String("env1"),
							pulumi.String("env2"),
						},
						ArtifactDisplayNames: pulumi.StringArray{
							pulumi.String("artificatname1"),
							pulumi.String("artifact2"),
						},
					},
					Ci: &platform.PipelineFiltersFilterPropertiesModulePropertiesCiArgs{
						BuildType: pulumi.String("branch"),
						Branch:    pulumi.String("branch123"),
						RepoNames: pulumi.String("repo1234"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test = new Harness.Platform.PipelineFilters("test", new()
    {
        Identifier = "identifier",
        Name = "name",
        OrgId = "org_id",
        ProjectId = "project_id",
        Type = "PipelineSetup",
        FilterProperties = new Harness.Platform.Inputs.PipelineFiltersFilterPropertiesArgs
        {
            Name = "pipeline_name",
            Description = "pipeline_description",
            PipelineIdentifiers = new[]
            {
                "id1",
                "id2",
            },
            FilterType = "PipelineSetup",
        },
        FilterVisibility = "EveryOne",
    });

    // pipeline filter with tags
    var exampleWithTags = new Harness.Platform.PipelineFilters("example_with_tags", new()
    {
        Identifier = "identifier",
        Name = "name",
        OrgId = "org_id",
        ProjectId = "project_id",
        Type = "PipelineSetup",
        FilterProperties = new Harness.Platform.Inputs.PipelineFiltersFilterPropertiesArgs
        {
            FilterType = "PipelineSetup",
            PipelineTags = new[]
            {
                
                {
                    { "key", "tag1" },
                    { "value", "123" },
                },
                
                {
                    { "key", "tag2" },
                    { "value", "456" },
                },
            },
            ModuleProperties = new Harness.Platform.Inputs.PipelineFiltersFilterPropertiesModulePropertiesArgs
            {
                Cd = new Harness.Platform.Inputs.PipelineFiltersFilterPropertiesModulePropertiesCdArgs
                {
                    DeploymentTypes = "Kubernetes",
                    ServiceNames = new[]
                    {
                        "service1",
                        "service2",
                    },
                    EnvironmentNames = new[]
                    {
                        "env1",
                        "env2",
                    },
                    ArtifactDisplayNames = new[]
                    {
                        "artificatname1",
                        "artifact2",
                    },
                },
                Ci = new Harness.Platform.Inputs.PipelineFiltersFilterPropertiesModulePropertiesCiArgs
                {
                    BuildType = "branch",
                    Branch = "branch123",
                    RepoNames = "repo1234",
                },
            },
        },
    });

});

    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 com.pulumi.harness.platform.inputs.PipelineFiltersFilterPropertiesModulePropertiesArgs;
import com.pulumi.harness.platform.inputs.PipelineFiltersFilterPropertiesModulePropertiesCdArgs;
import com.pulumi.harness.platform.inputs.PipelineFiltersFilterPropertiesModulePropertiesCiArgs;
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()
            .identifier("identifier")
            .name("name")
            .orgId("org_id")
            .projectId("project_id")
            .type("PipelineSetup")
            .filterProperties(PipelineFiltersFilterPropertiesArgs.builder()
                .name("pipeline_name")
                .description("pipeline_description")
                .pipelineIdentifiers(                
                    "id1",
                    "id2")
                .filterType("PipelineSetup")
                .build())
            .filterVisibility("EveryOne")
            .build());

        // pipeline filter with tags
        var exampleWithTags = new PipelineFilters("exampleWithTags", PipelineFiltersArgs.builder()
            .identifier("identifier")
            .name("name")
            .orgId("org_id")
            .projectId("project_id")
            .type("PipelineSetup")
            .filterProperties(PipelineFiltersFilterPropertiesArgs.builder()
                .filterType("PipelineSetup")
                .pipelineTags(                
                    Map.ofEntries(
                        Map.entry("key", "tag1"),
                        Map.entry("value", "123")
                    ),
                    Map.ofEntries(
                        Map.entry("key", "tag2"),
                        Map.entry("value", "456")
                    ))
                .moduleProperties(PipelineFiltersFilterPropertiesModulePropertiesArgs.builder()
                    .cd(PipelineFiltersFilterPropertiesModulePropertiesCdArgs.builder()
                        .deploymentTypes("Kubernetes")
                        .serviceNames(                        
                            "service1",
                            "service2")
                        .environmentNames(                        
                            "env1",
                            "env2")
                        .artifactDisplayNames(                        
                            "artificatname1",
                            "artifact2")
                        .build())
                    .ci(PipelineFiltersFilterPropertiesModulePropertiesCiArgs.builder()
                        .buildType("branch")
                        .branch("branch123")
                        .repoNames("repo1234")
                        .build())
                    .build())
                .build())
            .build());

    }
}

    resources:
  test:
    type: harness:platform:PipelineFilters
    properties:
      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 filter with tags
  exampleWithTags:
    type: harness:platform:PipelineFilters
    name: example_with_tags
    properties:
      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

    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.

    Constructor 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",
        Description = "string",
        ModuleProperties = new Harness.Platform.Inputs.PipelineFiltersFilterPropertiesModulePropertiesArgs
        {
            Cd = new Harness.Platform.Inputs.PipelineFiltersFilterPropertiesModulePropertiesCdArgs
            {
                ArtifactDisplayNames = new[]
                {
                    "string",
                },
                DeploymentTypes = "string",
                EnvironmentNames = new[]
                {
                    "string",
                },
                ServiceIdentifiers = new[]
                {
                    "string",
                },
                ServiceNames = new[]
                {
                    "string",
                },
            },
            Ci = new Harness.Platform.Inputs.PipelineFiltersFilterPropertiesModulePropertiesCiArgs
            {
                Branch = "string",
                BuildType = "string",
                CiExecutionInfo = new Harness.Platform.Inputs.PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfoArgs
                {
                    Event = "string",
                    PullRequest = new Harness.Platform.Inputs.PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfoPullRequestArgs
                    {
                        SourceBranch = "string",
                        TargetBranch = "string",
                    },
                },
                RepoNames = "string",
                Tag = "string",
            },
        },
        Name = "string",
        PipelineIdentifiers = new[]
        {
            "string",
        },
        PipelineTags = new[]
        {
            
            {
                { "string", "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"),
		Description: pulumi.String("string"),
		ModuleProperties: &platform.PipelineFiltersFilterPropertiesModulePropertiesArgs{
			Cd: &platform.PipelineFiltersFilterPropertiesModulePropertiesCdArgs{
				ArtifactDisplayNames: pulumi.StringArray{
					pulumi.String("string"),
				},
				DeploymentTypes: pulumi.String("string"),
				EnvironmentNames: pulumi.StringArray{
					pulumi.String("string"),
				},
				ServiceIdentifiers: pulumi.StringArray{
					pulumi.String("string"),
				},
				ServiceNames: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			Ci: &platform.PipelineFiltersFilterPropertiesModulePropertiesCiArgs{
				Branch:    pulumi.String("string"),
				BuildType: pulumi.String("string"),
				CiExecutionInfo: &platform.PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfoArgs{
					Event: pulumi.String("string"),
					PullRequest: &platform.PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfoPullRequestArgs{
						SourceBranch: pulumi.String("string"),
						TargetBranch: pulumi.String("string"),
					},
				},
				RepoNames: pulumi.String("string"),
				Tag:       pulumi.String("string"),
			},
		},
		Name: pulumi.String("string"),
		PipelineIdentifiers: pulumi.StringArray{
			pulumi.String("string"),
		},
		PipelineTags: pulumi.StringMapArray{
			pulumi.StringMap{
				"string": 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")
        .description("string")
        .moduleProperties(PipelineFiltersFilterPropertiesModulePropertiesArgs.builder()
            .cd(PipelineFiltersFilterPropertiesModulePropertiesCdArgs.builder()
                .artifactDisplayNames("string")
                .deploymentTypes("string")
                .environmentNames("string")
                .serviceIdentifiers("string")
                .serviceNames("string")
                .build())
            .ci(PipelineFiltersFilterPropertiesModulePropertiesCiArgs.builder()
                .branch("string")
                .buildType("string")
                .ciExecutionInfo(PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfoArgs.builder()
                    .event("string")
                    .pullRequest(PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfoPullRequestArgs.builder()
                        .sourceBranch("string")
                        .targetBranch("string")
                        .build())
                    .build())
                .repoNames("string")
                .tag("string")
                .build())
            .build())
        .name("string")
        .pipelineIdentifiers("string")
        .pipelineTags(Map.of("string", "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={
        "filter_type": "string",
        "description": "string",
        "module_properties": {
            "cd": {
                "artifact_display_names": ["string"],
                "deployment_types": "string",
                "environment_names": ["string"],
                "service_identifiers": ["string"],
                "service_names": ["string"],
            },
            "ci": {
                "branch": "string",
                "build_type": "string",
                "ci_execution_info": {
                    "event": "string",
                    "pull_request": {
                        "source_branch": "string",
                        "target_branch": "string",
                    },
                },
                "repo_names": "string",
                "tag": "string",
            },
        },
        "name": "string",
        "pipeline_identifiers": ["string"],
        "pipeline_tags": [{
            "string": "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",
        description: "string",
        moduleProperties: {
            cd: {
                artifactDisplayNames: ["string"],
                deploymentTypes: "string",
                environmentNames: ["string"],
                serviceIdentifiers: ["string"],
                serviceNames: ["string"],
            },
            ci: {
                branch: "string",
                buildType: "string",
                ciExecutionInfo: {
                    event: "string",
                    pullRequest: {
                        sourceBranch: "string",
                        targetBranch: "string",
                    },
                },
                repoNames: "string",
                tag: "string",
            },
        },
        name: "string",
        pipelineIdentifiers: ["string"],
        pipelineTags: [{
            string: "string",
        }],
        tags: ["string"],
    },
    identifier: "string",
    type: "string",
    filterVisibility: "string",
    name: "string",
    orgId: "string",
    projectId: "string",
});

    type: harness:platform:PipelineFilters
properties:
    filterProperties:
        description: string
        filterType: string
        moduleProperties:
            cd:
                artifactDisplayNames:
                    - string
                deploymentTypes: string
                environmentNames:
                    - string
                serviceIdentifiers:
                    - string
                serviceNames:
                    - string
            ci:
                branch: string
                buildType: string
                ciExecutionInfo:
                    event: string
                    pullRequest:
                        sourceBranch: string
                        targetBranch: string
                repoNames: string
                tag: string
        name: string
        pipelineIdentifiers:
            - string
        pipelineTags:
            - string: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PipelineFilters resource accepts the following input properties:

    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 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 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}.
    Description string
    description of the pipline filter.
    ModuleProperties PipelineFiltersFilterPropertiesModuleProperties
    module properties of the pipline filter.
    Name string
    Name of the pipeline filter.
    PipelineIdentifiers List<string>
    Pipeline identifiers to filter on.
    PipelineTags List<ImmutableDictionary<string, string>>
    Tags to associate with the pipeline. tags should be in the form of {key:key1, value:key1value}
    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}.
    Description string
    description of the pipline filter.
    ModuleProperties PipelineFiltersFilterPropertiesModuleProperties
    module properties of the pipline filter.
    Name string
    Name of the pipeline filter.
    PipelineIdentifiers []string
    Pipeline identifiers to filter on.
    PipelineTags []map[string]string
    Tags to associate with the pipeline. tags should be in the form of {key:key1, value:key1value}
    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}.
    description String
    description of the pipline filter.
    moduleProperties PipelineFiltersFilterPropertiesModuleProperties
    module properties of the pipline filter.
    name String
    Name of the pipeline filter.
    pipelineIdentifiers List<String>
    Pipeline identifiers to filter on.
    pipelineTags List<Map<String,String>>
    Tags to associate with the pipeline. tags should be in the form of {key:key1, value:key1value}
    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}.
    description string
    description of the pipline filter.
    moduleProperties PipelineFiltersFilterPropertiesModuleProperties
    module properties of the pipline filter.
    name string
    Name of the pipeline filter.
    pipelineIdentifiers string[]
    Pipeline identifiers to filter on.
    pipelineTags {[key: string]: string}[]
    Tags to associate with the pipeline. tags should be in the form of {key:key1, value:key1value}
    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}.
    description str
    description of the pipline filter.
    module_properties PipelineFiltersFilterPropertiesModuleProperties
    module properties of the pipline filter.
    name str
    Name of the pipeline filter.
    pipeline_identifiers Sequence[str]
    Pipeline identifiers to filter on.
    pipeline_tags Sequence[Mapping[str, str]]
    Tags to associate with the pipeline. tags should be in the form of {key:key1, value:key1value}
    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}.
    description String
    description of the pipline filter.
    moduleProperties Property Map
    module properties of the pipline filter.
    name String
    Name of the pipeline filter.
    pipelineIdentifiers List<String>
    Pipeline identifiers to filter on.
    pipelineTags List<Map<String>>
    Tags to associate with the pipeline. tags should be in the form of {key:key1, value:key1value}
    tags List<String>
    Tags to associate with the resource. Tags should be in the form name:value.

    PipelineFiltersFilterPropertiesModuleProperties, PipelineFiltersFilterPropertiesModulePropertiesArgs

    Cd PipelineFiltersFilterPropertiesModulePropertiesCd
    CD related properties to be filtered on.
    Ci PipelineFiltersFilterPropertiesModulePropertiesCi
    CI related properties to be filtered on.
    Cd PipelineFiltersFilterPropertiesModulePropertiesCd
    CD related properties to be filtered on.
    Ci PipelineFiltersFilterPropertiesModulePropertiesCi
    CI related properties to be filtered on.
    cd PipelineFiltersFilterPropertiesModulePropertiesCd
    CD related properties to be filtered on.
    ci PipelineFiltersFilterPropertiesModulePropertiesCi
    CI related properties to be filtered on.
    cd PipelineFiltersFilterPropertiesModulePropertiesCd
    CD related properties to be filtered on.
    ci PipelineFiltersFilterPropertiesModulePropertiesCi
    CI related properties to be filtered on.
    cd PipelineFiltersFilterPropertiesModulePropertiesCd
    CD related properties to be filtered on.
    ci PipelineFiltersFilterPropertiesModulePropertiesCi
    CI related properties to be filtered on.
    cd Property Map
    CD related properties to be filtered on.
    ci Property Map
    CI related properties to be filtered on.

    PipelineFiltersFilterPropertiesModulePropertiesCd, PipelineFiltersFilterPropertiesModulePropertiesCdArgs

    ArtifactDisplayNames List<string>
    Artifact display names of the CD pipeline.
    DeploymentTypes string
    Deployment type of the CD pipeline, eg. Kubernetes
    EnvironmentNames List<string>
    Environment names of the CD pipeline.
    ServiceIdentifiers List<string>
    Service identifiers of the CD pipeline.
    ServiceNames List<string>
    Service names of the CD pipeline.
    ArtifactDisplayNames []string
    Artifact display names of the CD pipeline.
    DeploymentTypes string
    Deployment type of the CD pipeline, eg. Kubernetes
    EnvironmentNames []string
    Environment names of the CD pipeline.
    ServiceIdentifiers []string
    Service identifiers of the CD pipeline.
    ServiceNames []string
    Service names of the CD pipeline.
    artifactDisplayNames List<String>
    Artifact display names of the CD pipeline.
    deploymentTypes String
    Deployment type of the CD pipeline, eg. Kubernetes
    environmentNames List<String>
    Environment names of the CD pipeline.
    serviceIdentifiers List<String>
    Service identifiers of the CD pipeline.
    serviceNames List<String>
    Service names of the CD pipeline.
    artifactDisplayNames string[]
    Artifact display names of the CD pipeline.
    deploymentTypes string
    Deployment type of the CD pipeline, eg. Kubernetes
    environmentNames string[]
    Environment names of the CD pipeline.
    serviceIdentifiers string[]
    Service identifiers of the CD pipeline.
    serviceNames string[]
    Service names of the CD pipeline.
    artifact_display_names Sequence[str]
    Artifact display names of the CD pipeline.
    deployment_types str
    Deployment type of the CD pipeline, eg. Kubernetes
    environment_names Sequence[str]
    Environment names of the CD pipeline.
    service_identifiers Sequence[str]
    Service identifiers of the CD pipeline.
    service_names Sequence[str]
    Service names of the CD pipeline.
    artifactDisplayNames List<String>
    Artifact display names of the CD pipeline.
    deploymentTypes String
    Deployment type of the CD pipeline, eg. Kubernetes
    environmentNames List<String>
    Environment names of the CD pipeline.
    serviceIdentifiers List<String>
    Service identifiers of the CD pipeline.
    serviceNames List<String>
    Service names of the CD pipeline.

    PipelineFiltersFilterPropertiesModulePropertiesCi, PipelineFiltersFilterPropertiesModulePropertiesCiArgs

    Branch string
    Branch which was used while building.
    BuildType string
    Build type of the pipeline. Possible values: branch.
    CiExecutionInfo PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfo
    CI execution info for the pipeline.
    RepoNames string
    name of the repository used in the pipeline.
    Tag string
    Tags to associate with the CI pipeline resource.
    Branch string
    Branch which was used while building.
    BuildType string
    Build type of the pipeline. Possible values: branch.
    CiExecutionInfo PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfo
    CI execution info for the pipeline.
    RepoNames string
    name of the repository used in the pipeline.
    Tag string
    Tags to associate with the CI pipeline resource.
    branch String
    Branch which was used while building.
    buildType String
    Build type of the pipeline. Possible values: branch.
    ciExecutionInfo PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfo
    CI execution info for the pipeline.
    repoNames String
    name of the repository used in the pipeline.
    tag String
    Tags to associate with the CI pipeline resource.
    branch string
    Branch which was used while building.
    buildType string
    Build type of the pipeline. Possible values: branch.
    ciExecutionInfo PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfo
    CI execution info for the pipeline.
    repoNames string
    name of the repository used in the pipeline.
    tag string
    Tags to associate with the CI pipeline resource.
    branch str
    Branch which was used while building.
    build_type str
    Build type of the pipeline. Possible values: branch.
    ci_execution_info PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfo
    CI execution info for the pipeline.
    repo_names str
    name of the repository used in the pipeline.
    tag str
    Tags to associate with the CI pipeline resource.
    branch String
    Branch which was used while building.
    buildType String
    Build type of the pipeline. Possible values: branch.
    ciExecutionInfo Property Map
    CI execution info for the pipeline.
    repoNames String
    name of the repository used in the pipeline.
    tag String
    Tags to associate with the CI pipeline resource.

    PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfo, PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfoArgs

    Event string
    Event for the ci execution, Possible values: pullRequest.
    PullRequest PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfoPullRequest
    The pull request details of the CI pipeline.
    Event string
    Event for the ci execution, Possible values: pullRequest.
    PullRequest PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfoPullRequest
    The pull request details of the CI pipeline.
    event String
    Event for the ci execution, Possible values: pullRequest.
    pullRequest PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfoPullRequest
    The pull request details of the CI pipeline.
    event string
    Event for the ci execution, Possible values: pullRequest.
    pullRequest PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfoPullRequest
    The pull request details of the CI pipeline.
    event str
    Event for the ci execution, Possible values: pullRequest.
    pull_request PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfoPullRequest
    The pull request details of the CI pipeline.
    event String
    Event for the ci execution, Possible values: pullRequest.
    pullRequest Property Map
    The pull request details of the CI pipeline.

    PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfoPullRequest, PipelineFiltersFilterPropertiesModulePropertiesCiCiExecutionInfoPullRequestArgs

    SourceBranch string
    Source branch of the pull request.
    TargetBranch string
    Target branch of the pull request.
    SourceBranch string
    Source branch of the pull request.
    TargetBranch string
    Target branch of the pull request.
    sourceBranch String
    Source branch of the pull request.
    targetBranch String
    Target branch of the pull request.
    sourceBranch string
    Source branch of the pull request.
    targetBranch string
    Target branch of the pull request.
    source_branch str
    Source branch of the pull request.
    target_branch str
    Target branch of the pull request.
    sourceBranch String
    Source branch of the pull request.
    targetBranch String
    Target branch of the pull request.

    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 pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi
    pulumi/pulumi-harness