aws.resourceexplorer.Search

Explore with Pulumi AI

AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

pulumi/pulumi-aws

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.resourceexplorer.Search({
    queryString: "region:us-west-2",
    viewArn: test.arn,
});

import pulumi
import pulumi_aws as aws

example = aws.resourceexplorer.search(query_string="region:us-west-2",
    view_arn=test["arn"])

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/resourceexplorer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resourceexplorer.Search(ctx, &resourceexplorer.SearchArgs{
			QueryString: "region:us-west-2",
			ViewArn:     pulumi.StringRef(test.Arn),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Aws.ResourceExplorer.Search.Invoke(new()
    {
        QueryString = "region:us-west-2",
        ViewArn = test.Arn,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.resourceexplorer.ResourceexplorerFunctions;
import com.pulumi.aws.resourceexplorer.inputs.SearchArgs;
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) {
        final var example = ResourceexplorerFunctions.Search(SearchArgs.builder()
            .queryString("region:us-west-2")
            .viewArn(test.arn())
            .build());

    }
}

variables:
  example:
    fn::invoke:
      Function: aws:resourceexplorer:Search
      Arguments:
        queryString: region:us-west-2
        viewArn: ${test.arn}

Using Search

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function search(args: SearchArgs, opts?: InvokeOptions): Promise<SearchResult>
function searchOutput(args: SearchOutputArgs, opts?: InvokeOptions): Output<SearchResult>

def search(query_string: Optional[str] = None,
           view_arn: Optional[str] = None,
           opts: Optional[InvokeOptions] = None) -> SearchResult
def search_output(query_string: Optional[pulumi.Input[str]] = None,
           view_arn: Optional[pulumi.Input[str]] = None,
           opts: Optional[InvokeOptions] = None) -> Output[SearchResult]

func Search(ctx *Context, args *SearchArgs, opts ...InvokeOption) (*SearchResult, error)
func SearchOutput(ctx *Context, args *SearchOutputArgs, opts ...InvokeOption) SearchResultOutput

public static class Search 
{
    public static Task<SearchResult> InvokeAsync(SearchArgs args, InvokeOptions? opts = null)
    public static Output<SearchResult> Invoke(SearchInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<SearchResult> search(SearchArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:resourceexplorer:Search
  arguments:
    # arguments dictionary

The following arguments are supported:

QueryString string

String that includes keywords and filters that specify the resources that you want to include in the results. For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer. The search is completely case insensitive. You can specify an empty string to return all results up to the limit of 1,000 total results. The operation can return only the first 1,000 results. If the resource you want is not included, then use a different value for QueryString to refine the results.