1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. TemplateFilters
Harness v0.1.2 published on Friday, Jul 19, 2024 by Pulumi

harness.platform.TemplateFilters

Explore with Pulumi AI

harness logo
Harness v0.1.2 published on Friday, Jul 19, 2024 by Pulumi

    Resource for creating a Harness Template Filters.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const test = new harness.platform.TemplateFilters("test", {
        identifier: "identifier",
        name: "name",
        orgId: "org_id",
        projectId: "project_id",
        type: "Template",
        filterProperties: {
            tags: ["foo:bar"],
            filterType: "Template",
        },
        filterVisibility: "EveryOne",
    });
    
    import pulumi
    import pulumi_harness as harness
    
    test = harness.platform.TemplateFilters("test",
        identifier="identifier",
        name="name",
        org_id="org_id",
        project_id="project_id",
        type="Template",
        filter_properties=harness.platform.TemplateFiltersFilterPropertiesArgs(
            tags=["foo:bar"],
            filter_type="Template",
        ),
        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.NewTemplateFilters(ctx, "test", &platform.TemplateFiltersArgs{
    			Identifier: pulumi.String("identifier"),
    			Name:       pulumi.String("name"),
    			OrgId:      pulumi.String("org_id"),
    			ProjectId:  pulumi.String("project_id"),
    			Type:       pulumi.String("Template"),
    			FilterProperties: &platform.TemplateFiltersFilterPropertiesArgs{
    				Tags: pulumi.StringArray{
    					pulumi.String("foo:bar"),
    				},
    				FilterType: pulumi.String("Template"),
    			},
    			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.TemplateFilters("test", new()
        {
            Identifier = "identifier",
            Name = "name",
            OrgId = "org_id",
            ProjectId = "project_id",
            Type = "Template",
            FilterProperties = new Harness.Platform.Inputs.TemplateFiltersFilterPropertiesArgs
            {
                Tags = new[]
                {
                    "foo:bar",
                },
                FilterType = "Template",
            },
            FilterVisibility = "EveryOne",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.TemplateFilters;
    import com.pulumi.harness.platform.TemplateFiltersArgs;
    import com.pulumi.harness.platform.inputs.TemplateFiltersFilterPropertiesArgs;
    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 TemplateFilters("test", TemplateFiltersArgs.builder()
                .identifier("identifier")
                .name("name")
                .orgId("org_id")
                .projectId("project_id")
                .type("Template")
                .filterProperties(TemplateFiltersFilterPropertiesArgs.builder()
                    .tags("foo:bar")
                    .filterType("Template")
                    .build())
                .filterVisibility("EveryOne")
                .build());
    
        }
    }
    
    resources:
      test:
        type: harness:platform:TemplateFilters
        properties:
          identifier: identifier
          name: name
          orgId: org_id
          projectId: project_id
          type: Template
          filterProperties:
            tags:
              - foo:bar
            filterType: Template
          filterVisibility: EveryOne
    

    Create TemplateFilters Resource

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

    Constructor syntax

    new TemplateFilters(name: string, args: TemplateFiltersArgs, opts?: CustomResourceOptions);
    @overload
    def TemplateFilters(resource_name: str,
                        args: TemplateFiltersArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def TemplateFilters(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        filter_properties: Optional[TemplateFiltersFilterPropertiesArgs] = 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 NewTemplateFilters(ctx *Context, name string, args TemplateFiltersArgs, opts ...ResourceOption) (*TemplateFilters, error)
    public TemplateFilters(string name, TemplateFiltersArgs args, CustomResourceOptions? opts = null)
    public TemplateFilters(String name, TemplateFiltersArgs args)
    public TemplateFilters(String name, TemplateFiltersArgs args, CustomResourceOptions options)
    
    type: harness:platform:TemplateFilters
    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 TemplateFiltersArgs
    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 TemplateFiltersArgs
    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 TemplateFiltersArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TemplateFiltersArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TemplateFiltersArgs
    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 templateFiltersResource = new Harness.Platform.TemplateFilters("templateFiltersResource", new()
    {
        FilterProperties = new Harness.Platform.Inputs.TemplateFiltersFilterPropertiesArgs
        {
            FilterType = "string",
            Tags = new[]
            {
                "string",
            },
        },
        Identifier = "string",
        Type = "string",
        FilterVisibility = "string",
        Name = "string",
        OrgId = "string",
        ProjectId = "string",
    });
    
    example, err := platform.NewTemplateFilters(ctx, "templateFiltersResource", &platform.TemplateFiltersArgs{
    	FilterProperties: &platform.TemplateFiltersFilterPropertiesArgs{
    		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 templateFiltersResource = new TemplateFilters("templateFiltersResource", TemplateFiltersArgs.builder()
        .filterProperties(TemplateFiltersFilterPropertiesArgs.builder()
            .filterType("string")
            .tags("string")
            .build())
        .identifier("string")
        .type("string")
        .filterVisibility("string")
        .name("string")
        .orgId("string")
        .projectId("string")
        .build());
    
    template_filters_resource = harness.platform.TemplateFilters("templateFiltersResource",
        filter_properties=harness.platform.TemplateFiltersFilterPropertiesArgs(
            filter_type="string",
            tags=["string"],
        ),
        identifier="string",
        type="string",
        filter_visibility="string",
        name="string",
        org_id="string",
        project_id="string")
    
    const templateFiltersResource = new harness.platform.TemplateFilters("templateFiltersResource", {
        filterProperties: {
            filterType: "string",
            tags: ["string"],
        },
        identifier: "string",
        type: "string",
        filterVisibility: "string",
        name: "string",
        orgId: "string",
        projectId: "string",
    });
    
    type: harness:platform:TemplateFilters
    properties:
        filterProperties:
            filterType: string
            tags:
                - string
        filterVisibility: string
        identifier: string
        name: string
        orgId: string
        projectId: string
        type: string
    

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

    FilterProperties TemplateFiltersFilterProperties
    Properties of the filters entity defined in Harness.
    Identifier string
    Unique identifier of the resource.
    Type string
    Type of template filters. Currently supported types are { Template}
    FilterVisibility string
    Only accept values "EveryOne" and "OnlyCreator". This indicates visibility of filters. By default, everyone can view this filter.
    Name string
    Name of the template filters.
    OrgId string
    Organization Identifier for the Entity.
    ProjectId string
    Project Identifier for the Entity.
    FilterProperties TemplateFiltersFilterPropertiesArgs
    Properties of the filters entity defined in Harness.
    Identifier string
    Unique identifier of the resource.
    Type string
    Type of template filters. Currently supported types are { Template}
    FilterVisibility string
    Only accept values "EveryOne" and "OnlyCreator". This indicates visibility of filters. By default, everyone can view this filter.
    Name string
    Name of the template filters.
    OrgId string
    Organization Identifier for the Entity.
    ProjectId string
    Project Identifier for the Entity.
    filterProperties TemplateFiltersFilterProperties
    Properties of the filters entity defined in Harness.
    identifier String
    Unique identifier of the resource.
    type String
    Type of template filters. Currently supported types are { Template}
    filterVisibility String
    Only accept values "EveryOne" and "OnlyCreator". This indicates visibility of filters. By default, everyone can view this filter.
    name String
    Name of the template filters.
    orgId String
    Organization Identifier for the Entity.
    projectId String
    Project Identifier for the Entity.
    filterProperties TemplateFiltersFilterProperties
    Properties of the filters entity defined in Harness.
    identifier string
    Unique identifier of the resource.
    type string
    Type of template filters. Currently supported types are { Template}
    filterVisibility string
    Only accept values "EveryOne" and "OnlyCreator". This indicates visibility of filters. By default, everyone can view this filter.
    name string
    Name of the template filters.
    orgId string
    Organization Identifier for the Entity.
    projectId string
    Project Identifier for the Entity.
    filter_properties TemplateFiltersFilterPropertiesArgs
    Properties of the filters entity defined in Harness.
    identifier str
    Unique identifier of the resource.
    type str
    Type of template filters. Currently supported types are { Template}
    filter_visibility str
    Only accept values "EveryOne" and "OnlyCreator". This indicates visibility of filters. By default, everyone can view this filter.
    name str
    Name of the template 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 template filters. Currently supported types are { Template}
    filterVisibility String
    Only accept values "EveryOne" and "OnlyCreator". This indicates visibility of filters. By default, everyone can view this filter.
    name String
    Name of the template 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 TemplateFilters 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 TemplateFilters Resource

    Get an existing TemplateFilters 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?: TemplateFiltersState, opts?: CustomResourceOptions): TemplateFilters
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            filter_properties: Optional[TemplateFiltersFilterPropertiesArgs] = 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) -> TemplateFilters
    func GetTemplateFilters(ctx *Context, name string, id IDInput, state *TemplateFiltersState, opts ...ResourceOption) (*TemplateFilters, error)
    public static TemplateFilters Get(string name, Input<string> id, TemplateFiltersState? state, CustomResourceOptions? opts = null)
    public static TemplateFilters get(String name, Output<String> id, TemplateFiltersState 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 TemplateFiltersFilterProperties
    Properties of the filters entity defined in Harness.
    FilterVisibility string
    Only accept values "EveryOne" and "OnlyCreator". This indicates visibility of filters. By default, everyone can view this filter.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the template filters.
    OrgId string
    Organization Identifier for the Entity.
    ProjectId string
    Project Identifier for the Entity.
    Type string
    Type of template filters. Currently supported types are { Template}
    FilterProperties TemplateFiltersFilterPropertiesArgs
    Properties of the filters entity defined in Harness.
    FilterVisibility string
    Only accept values "EveryOne" and "OnlyCreator". This indicates visibility of filters. By default, everyone can view this filter.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the template filters.
    OrgId string
    Organization Identifier for the Entity.
    ProjectId string
    Project Identifier for the Entity.
    Type string
    Type of template filters. Currently supported types are { Template}
    filterProperties TemplateFiltersFilterProperties
    Properties of the filters entity defined in Harness.
    filterVisibility String
    Only accept values "EveryOne" and "OnlyCreator". This indicates visibility of filters. By default, everyone can view this filter.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the template filters.
    orgId String
    Organization Identifier for the Entity.
    projectId String
    Project Identifier for the Entity.
    type String
    Type of template filters. Currently supported types are { Template}
    filterProperties TemplateFiltersFilterProperties
    Properties of the filters entity defined in Harness.
    filterVisibility string
    Only accept values "EveryOne" and "OnlyCreator". This indicates visibility of filters. By default, everyone can view this filter.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the template filters.
    orgId string
    Organization Identifier for the Entity.
    projectId string
    Project Identifier for the Entity.
    type string
    Type of template filters. Currently supported types are { Template}
    filter_properties TemplateFiltersFilterPropertiesArgs
    Properties of the filters entity defined in Harness.
    filter_visibility str
    Only accept values "EveryOne" and "OnlyCreator". This indicates visibility of filters. By default, everyone can view this filter.
    identifier str
    Unique identifier of the resource.
    name str
    Name of the template filters.
    org_id str
    Organization Identifier for the Entity.
    project_id str
    Project Identifier for the Entity.
    type str
    Type of template filters. Currently supported types are { Template}
    filterProperties Property Map
    Properties of the filters entity defined in Harness.
    filterVisibility String
    Only accept values "EveryOne" and "OnlyCreator". This indicates visibility of filters. By default, everyone can view this filter.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the template filters.
    orgId String
    Organization Identifier for the Entity.
    projectId String
    Project Identifier for the Entity.
    type String
    Type of template filters. Currently supported types are { Template}

    Supporting Types

    TemplateFiltersFilterProperties, TemplateFiltersFilterPropertiesArgs

    FilterType string
    Corresponding Entity of the filters. Currently supported types are {TemplateSetup, TemplateExecution, Template}.
    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 {TemplateSetup, TemplateExecution, Template}.
    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 {TemplateSetup, TemplateExecution, Template}.
    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 {TemplateSetup, TemplateExecution, Template}.
    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 {TemplateSetup, TemplateExecution, Template}.
    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 {TemplateSetup, TemplateExecution, Template}.
    tags List<String>
    Tags to associate with the resource. Tags should be in the form name:value.

    Import

    Import account level template filter

    $ pulumi import harness:platform/templateFilters:TemplateFilters example <filter_id>/<type>
    

    Import org level template filter

    $ pulumi import harness:platform/templateFilters:TemplateFilters example <org_id>/<filter_id>/<type>
    

    Import project level template filter

    $ pulumi import harness:platform/templateFilters:TemplateFilters 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.1.2 published on Friday, Jul 19, 2024 by Pulumi