1. Packages
  2. Vantage
  3. API Docs
  4. SavedFilter
Vantage v0.0.3 published on Wednesday, Jan 31, 2024 by lbrlabs

vantage.SavedFilter

Explore with Pulumi AI

vantage logo
Vantage v0.0.3 published on Wednesday, Jan 31, 2024 by lbrlabs

    Manages a SavedFilter.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vantage = Lbrlabs.PulumiPackage.Vantage;
    
    return await Deployment.RunAsync(() => 
    {
        var demoFilter = new Vantage.SavedFilter("demoFilter", new()
        {
            Filter = "(costs.provider = 'aws')",
            Title = "Demo Saved Filter",
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-vantage/sdk/go/vantage"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vantage.NewSavedFilter(ctx, "demoFilter", &vantage.SavedFilterArgs{
    			Filter: pulumi.String("(costs.provider = 'aws')"),
    			Title:  pulumi.String("Demo Saved Filter"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vantage.SavedFilter;
    import com.pulumi.vantage.SavedFilterArgs;
    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 demoFilter = new SavedFilter("demoFilter", SavedFilterArgs.builder()        
                .filter("(costs.provider = 'aws')")
                .title("Demo Saved Filter")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_vantage as vantage
    
    demo_filter = vantage.SavedFilter("demoFilter",
        filter="(costs.provider = 'aws')",
        title="Demo Saved Filter")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as vantage from "@lbrlabs/pulumi-vantage";
    
    const demoFilter = new vantage.SavedFilter("demoFilter", {
        filter: "(costs.provider = 'aws')",
        title: "Demo Saved Filter",
    });
    
    resources:
      demoFilter:
        type: vantage:SavedFilter
        properties:
          filter: (costs.provider = 'aws')
          title: Demo Saved Filter
    

    Create SavedFilter Resource

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

    Constructor syntax

    new SavedFilter(name: string, args: SavedFilterArgs, opts?: CustomResourceOptions);
    @overload
    def SavedFilter(resource_name: str,
                    args: SavedFilterArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def SavedFilter(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    title: Optional[str] = None,
                    filter: Optional[str] = None,
                    workspace_token: Optional[str] = None)
    func NewSavedFilter(ctx *Context, name string, args SavedFilterArgs, opts ...ResourceOption) (*SavedFilter, error)
    public SavedFilter(string name, SavedFilterArgs args, CustomResourceOptions? opts = null)
    public SavedFilter(String name, SavedFilterArgs args)
    public SavedFilter(String name, SavedFilterArgs args, CustomResourceOptions options)
    
    type: vantage:SavedFilter
    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 SavedFilterArgs
    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 SavedFilterArgs
    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 SavedFilterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SavedFilterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SavedFilterArgs
    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 savedFilterResource = new Vantage.SavedFilter("savedFilterResource", new()
    {
        Title = "string",
        Filter = "string",
        WorkspaceToken = "string",
    });
    
    example, err := vantage.NewSavedFilter(ctx, "savedFilterResource", &vantage.SavedFilterArgs{
    	Title:          pulumi.String("string"),
    	Filter:         pulumi.String("string"),
    	WorkspaceToken: pulumi.String("string"),
    })
    
    var savedFilterResource = new SavedFilter("savedFilterResource", SavedFilterArgs.builder()
        .title("string")
        .filter("string")
        .workspaceToken("string")
        .build());
    
    saved_filter_resource = vantage.SavedFilter("savedFilterResource",
        title="string",
        filter="string",
        workspace_token="string")
    
    const savedFilterResource = new vantage.SavedFilter("savedFilterResource", {
        title: "string",
        filter: "string",
        workspaceToken: "string",
    });
    
    type: vantage:SavedFilter
    properties:
        filter: string
        title: string
        workspaceToken: string
    

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

    Title string
    Title of the Saved Filter
    Filter string
    VQL Query used for this saved filter.
    WorkspaceToken string
    Workspace token to add the saved filter into.
    Title string
    Title of the Saved Filter
    Filter string
    VQL Query used for this saved filter.
    WorkspaceToken string
    Workspace token to add the saved filter into.
    title String
    Title of the Saved Filter
    filter String
    VQL Query used for this saved filter.
    workspaceToken String
    Workspace token to add the saved filter into.
    title string
    Title of the Saved Filter
    filter string
    VQL Query used for this saved filter.
    workspaceToken string
    Workspace token to add the saved filter into.
    title str
    Title of the Saved Filter
    filter str
    VQL Query used for this saved filter.
    workspace_token str
    Workspace token to add the saved filter into.
    title String
    Title of the Saved Filter
    filter String
    VQL Query used for this saved filter.
    workspaceToken String
    Workspace token to add the saved filter into.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    Unique saved filter identifier
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    Unique saved filter identifier
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    Unique saved filter identifier
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    Unique saved filter identifier
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    Unique saved filter identifier
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    Unique saved filter identifier

    Look up Existing SavedFilter Resource

    Get an existing SavedFilter 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?: SavedFilterState, opts?: CustomResourceOptions): SavedFilter
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            filter: Optional[str] = None,
            title: Optional[str] = None,
            token: Optional[str] = None,
            workspace_token: Optional[str] = None) -> SavedFilter
    func GetSavedFilter(ctx *Context, name string, id IDInput, state *SavedFilterState, opts ...ResourceOption) (*SavedFilter, error)
    public static SavedFilter Get(string name, Input<string> id, SavedFilterState? state, CustomResourceOptions? opts = null)
    public static SavedFilter get(String name, Output<String> id, SavedFilterState 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:
    Filter string
    VQL Query used for this saved filter.
    Title string
    Title of the Saved Filter
    Token string
    Unique saved filter identifier
    WorkspaceToken string
    Workspace token to add the saved filter into.
    Filter string
    VQL Query used for this saved filter.
    Title string
    Title of the Saved Filter
    Token string
    Unique saved filter identifier
    WorkspaceToken string
    Workspace token to add the saved filter into.
    filter String
    VQL Query used for this saved filter.
    title String
    Title of the Saved Filter
    token String
    Unique saved filter identifier
    workspaceToken String
    Workspace token to add the saved filter into.
    filter string
    VQL Query used for this saved filter.
    title string
    Title of the Saved Filter
    token string
    Unique saved filter identifier
    workspaceToken string
    Workspace token to add the saved filter into.
    filter str
    VQL Query used for this saved filter.
    title str
    Title of the Saved Filter
    token str
    Unique saved filter identifier
    workspace_token str
    Workspace token to add the saved filter into.
    filter String
    VQL Query used for this saved filter.
    title String
    Title of the Saved Filter
    token String
    Unique saved filter identifier
    workspaceToken String
    Workspace token to add the saved filter into.

    Package Details

    Repository
    vantage lbrlabs/pulumi-vantage
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vantage Terraform Provider.
    vantage logo
    Vantage v0.0.3 published on Wednesday, Jan 31, 2024 by lbrlabs