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

harness.platform.Filters

Explore with Pulumi AI

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

    Example Usage

    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 pulumi
import pulumi_harness as harness

test = harness.platform.Filters("test",
    identifier="identifier",
    name="name",
    org_id="org_id",
    project_id="project_id",
    type="Connector",
    filter_properties={
        "tags": ["foo:bar"],
        "filter_type": "Connector",
    },
    filter_visibility="EveryOne")

    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.NewFilters(ctx, "test", &platform.FiltersArgs{
			Identifier: pulumi.String("identifier"),
			Name:       pulumi.String("name"),
			OrgId:      pulumi.String("org_id"),
			ProjectId:  pulumi.String("project_id"),
			Type:       pulumi.String("Connector"),
			FilterProperties: &platform.FiltersFilterPropertiesArgs{
				Tags: pulumi.StringArray{
					pulumi.String("foo:bar"),
				},
				FilterType: pulumi.String("Connector"),
			},
			FilterVisibility: pulumi.String("EveryOne"),
		})
		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.Filters("test", new()
    {
        Identifier = "identifier",
        Name = "name",
        OrgId = "org_id",
        ProjectId = "project_id",
        Type = "Connector",
        FilterProperties = new Harness.Platform.Inputs.FiltersFilterPropertiesArgs
        {
            Tags = new[]
            {
                "foo:bar",
            },
            FilterType = "Connector",
        },
        FilterVisibility = "EveryOne",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.platform.Filters;
import com.pulumi.harness.platform.FiltersArgs;
import com.pulumi.harness.platform.inputs.FiltersFilterPropertiesArgs;
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 Filters("test", FiltersArgs.builder()
            .identifier("identifier")
            .name("name")
            .orgId("org_id")
            .projectId("project_id")
            .type("Connector")
            .filterProperties(FiltersFilterPropertiesArgs.builder()
                .tags("foo:bar")
                .filterType("Connector")
                .build())
            .filterVisibility("EveryOne")
            .build());

    }
}

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

    Create Filters Resource

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

    Constructor syntax

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

@overload
def Filters(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            filter_properties: Optional[FiltersFilterPropertiesArgs] = 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 NewFilters(ctx *Context, name string, args FiltersArgs, opts ...ResourceOption) (*Filters, error)
    public Filters(string name, FiltersArgs args, CustomResourceOptions? opts = null)
    public Filters(String name, FiltersArgs args)
public Filters(String name, FiltersArgs args, CustomResourceOptions options)

    type: harness:platform:Filters
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 FiltersArgs
    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 FiltersArgs
    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 FiltersArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FiltersArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FiltersArgs
    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 filtersResource = new Harness.Platform.Filters("filtersResource", new()
{
    FilterProperties = new Harness.Platform.Inputs.FiltersFilterPropertiesArgs
    {
        FilterType = "string",
        Tags = new[]
        {
            "string",
        },
    },
    Identifier = "string",
    Type = "string",
    FilterVisibility = "string",
    Name = "string",
    OrgId = "string",
    ProjectId = "string",
});

    example, err := platform.NewFilters(ctx, "filtersResource", &platform.FiltersArgs{
	FilterProperties: &platform.FiltersFilterPropertiesArgs{
		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 filtersResource = new Filters("filtersResource", FiltersArgs.builder()
    .filterProperties(FiltersFilterPropertiesArgs.builder()
        .filterType("string")
        .tags("string")
        .build())
    .identifier("string")
    .type("string")
    .filterVisibility("string")
    .name("string")
    .orgId("string")
    .projectId("string")
    .build());

    filters_resource = harness.platform.Filters("filtersResource",
    filter_properties={
        "filter_type": "string",
        "tags": ["string"],
    },
    identifier="string",
    type="string",
    filter_visibility="string",
    name="string",
    org_id="string",
    project_id="string")

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

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

    Filters 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 Filters resource accepts the following input properties:

    FilterProperties FiltersFilterProperties
    Properties of the filter entity defined in Harness.
    Identifier string
    Unique identifier of the resource
    Type string
    Type of filter. Currently supported types are {Connector, DelegateProfile, Delegate, EnvironmentGroup, FileStore, Environment}
    FilterVisibility string
    This indicates visibility of filter. By default, everyone can view this filter. Can either be EveryOne or OnlyCreator
    Name string
    Name of the Filter
    OrgId string
    organization Identifier for the Entity
    ProjectId string
    project Identifier for the Entity
    FilterProperties FiltersFilterPropertiesArgs
    Properties of the filter entity defined in Harness.
    Identifier string
    Unique identifier of the resource
    Type string
    Type of filter. Currently supported types are {Connector, DelegateProfile, Delegate, EnvironmentGroup, FileStore, Environment}
    FilterVisibility string
    This indicates visibility of filter. By default, everyone can view this filter. Can either be EveryOne or OnlyCreator
    Name string
    Name of the Filter
    OrgId string
    organization Identifier for the Entity
    ProjectId string
    project Identifier for the Entity
    filterProperties FiltersFilterProperties
    Properties of the filter entity defined in Harness.
    identifier String
    Unique identifier of the resource
    type String
    Type of filter. Currently supported types are {Connector, DelegateProfile, Delegate, EnvironmentGroup, FileStore, Environment}
    filterVisibility String
    This indicates visibility of filter. By default, everyone can view this filter. Can either be EveryOne or OnlyCreator
    name String
    Name of the Filter
    orgId String
    organization Identifier for the Entity
    projectId String
    project Identifier for the Entity
    filterProperties FiltersFilterProperties
    Properties of the filter entity defined in Harness.
    identifier string
    Unique identifier of the resource
    type string
    Type of filter. Currently supported types are {Connector, DelegateProfile, Delegate, EnvironmentGroup, FileStore, Environment}
    filterVisibility string
    This indicates visibility of filter. By default, everyone can view this filter. Can either be EveryOne or OnlyCreator
    name string
    Name of the Filter
    orgId string
    organization Identifier for the Entity
    projectId string
    project Identifier for the Entity
    filter_properties FiltersFilterPropertiesArgs
    Properties of the filter entity defined in Harness.
    identifier str
    Unique identifier of the resource
    type str
    Type of filter. Currently supported types are {Connector, DelegateProfile, Delegate, EnvironmentGroup, FileStore, Environment}
    filter_visibility str
    This indicates visibility of filter. By default, everyone can view this filter. Can either be EveryOne or OnlyCreator
    name str
    Name of the Filter
    org_id str
    organization Identifier for the Entity
    project_id str
    project Identifier for the Entity
    filterProperties Property Map
    Properties of the filter entity defined in Harness.
    identifier String
    Unique identifier of the resource
    type String
    Type of filter. Currently supported types are {Connector, DelegateProfile, Delegate, EnvironmentGroup, FileStore, Environment}
    filterVisibility String
    This indicates visibility of filter. By default, everyone can view this filter. Can either be EveryOne or OnlyCreator
    name String
    Name of the Filter
    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 Filters 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 Filters Resource

    Get an existing Filters 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?: FiltersState, opts?: CustomResourceOptions): Filters
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        filter_properties: Optional[FiltersFilterPropertiesArgs] = 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) -> Filters
    func GetFilters(ctx *Context, name string, id IDInput, state *FiltersState, opts ...ResourceOption) (*Filters, error)
    public static Filters Get(string name, Input<string> id, FiltersState? state, CustomResourceOptions? opts = null)
    public static Filters get(String name, Output<String> id, FiltersState 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 FiltersFilterProperties
    Properties of the filter entity defined in Harness.
    FilterVisibility string
    This indicates visibility of filter. By default, everyone can view this filter. Can either be EveryOne or OnlyCreator
    Identifier string
    Unique identifier of the resource
    Name string
    Name of the Filter
    OrgId string
    organization Identifier for the Entity
    ProjectId string
    project Identifier for the Entity
    Type string
    Type of filter. Currently supported types are {Connector, DelegateProfile, Delegate, EnvironmentGroup, FileStore, Environment}
    FilterProperties FiltersFilterPropertiesArgs
    Properties of the filter entity defined in Harness.
    FilterVisibility string
    This indicates visibility of filter. By default, everyone can view this filter. Can either be EveryOne or OnlyCreator
    Identifier string
    Unique identifier of the resource
    Name string
    Name of the Filter
    OrgId string
    organization Identifier for the Entity
    ProjectId string
    project Identifier for the Entity
    Type string
    Type of filter. Currently supported types are {Connector, DelegateProfile, Delegate, EnvironmentGroup, FileStore, Environment}
    filterProperties FiltersFilterProperties
    Properties of the filter entity defined in Harness.
    filterVisibility String
    This indicates visibility of filter. By default, everyone can view this filter. Can either be EveryOne or OnlyCreator
    identifier String
    Unique identifier of the resource
    name String
    Name of the Filter
    orgId String
    organization Identifier for the Entity
    projectId String
    project Identifier for the Entity
    type String
    Type of filter. Currently supported types are {Connector, DelegateProfile, Delegate, EnvironmentGroup, FileStore, Environment}
    filterProperties FiltersFilterProperties
    Properties of the filter entity defined in Harness.
    filterVisibility string
    This indicates visibility of filter. By default, everyone can view this filter. Can either be EveryOne or OnlyCreator
    identifier string
    Unique identifier of the resource
    name string
    Name of the Filter
    orgId string
    organization Identifier for the Entity
    projectId string
    project Identifier for the Entity
    type string
    Type of filter. Currently supported types are {Connector, DelegateProfile, Delegate, EnvironmentGroup, FileStore, Environment}
    filter_properties FiltersFilterPropertiesArgs
    Properties of the filter entity defined in Harness.
    filter_visibility str
    This indicates visibility of filter. By default, everyone can view this filter. Can either be EveryOne or OnlyCreator
    identifier str
    Unique identifier of the resource
    name str
    Name of the Filter
    org_id str
    organization Identifier for the Entity
    project_id str
    project Identifier for the Entity
    type str
    Type of filter. Currently supported types are {Connector, DelegateProfile, Delegate, EnvironmentGroup, FileStore, Environment}
    filterProperties Property Map
    Properties of the filter entity defined in Harness.
    filterVisibility String
    This indicates visibility of filter. By default, everyone can view this filter. Can either be EveryOne or OnlyCreator
    identifier String
    Unique identifier of the resource
    name String
    Name of the Filter
    orgId String
    organization Identifier for the Entity
    projectId String
    project Identifier for the Entity
    type String
    Type of filter. Currently supported types are {Connector, DelegateProfile, Delegate, EnvironmentGroup, FileStore, Environment}

    Supporting Types

    FiltersFilterProperties, FiltersFilterPropertiesArgs

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

    Import

    Import account level filter

    $ pulumi import harness:platform/filters:Filters example <filter_id>/<type>

    Import org level filter

    $ pulumi import harness:platform/filters:Filters example <ord_id>/<filter_id>/<type>

    Import project level filter

    $ pulumi import harness:platform/filters:Filters 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