Search

suspend fun Search(argument: SearchPlainArgs): SearchResult

Data source for managing an AWS Resource Explorer Search.

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"])
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 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
})
}
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}

Return

A collection of values returned by Search.

Parameters

argument

A collection of arguments for invoking Search.


suspend fun Search(queryString: String, resourceCounts: List<SearchResourceCount>? = null, resources: List<SearchResource>? = null, viewArn: String? = null): SearchResult

Return

A collection of values returned by Search.

See also

Parameters

queryString

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. The following arguments are optional:

resourceCounts

Number of resources that match the query. See resource_count below.

resources

List of structures that describe the resources that match the query. See resources below.

viewArn

Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the AWS Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a 401 Unauthorized exception.


suspend fun Search(argument: suspend SearchPlainArgsBuilder.() -> Unit): SearchResult

Return

A collection of values returned by Search.

See also

Parameters

argument

Builder for com.pulumi.aws.resourceexplorer.kotlin.inputs.SearchPlainArgs.