@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
94 lines (93 loc) • 5.68 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Definition of AWS::ResourceExplorer2::View Resource Type
*/
export declare class View extends pulumi.CustomResource {
/**
* Get an existing View resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): View;
/**
* Returns true if the given object is an instance of View. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is View;
/**
* An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view. When you use this view in a [Search](https://docs.aws.amazon.com/resource-explorer/latest/apireference/API_Search.html) operation, the filter string is combined with the search's `QueryString` parameter using a logical `AND` operator.
*
* For information about the supported syntax, see [Search query reference for Resource Explorer](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) in the *AWS Resource Explorer User Guide* .
*
* > This query string in the context of this operation supports only [filter prefixes](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters) with optional [operators](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators) . It doesn't support free-form text. For example, the string `region:us* service:ec2 -tag:stage=prod` includes all Amazon EC2 resources in any AWS Region that begin with the letters `us` and are *not* tagged with a key `Stage` that has the value `prod` .
*/
readonly filters: pulumi.Output<outputs.resourceexplorer2.ViewSearchFilter | undefined>;
/**
* A list of fields that provide additional information about the view.
*/
readonly includedProperties: pulumi.Output<outputs.resourceexplorer2.ViewIncludedProperty[] | undefined>;
/**
* The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.
*/
readonly scope: pulumi.Output<string | undefined>;
/**
* Tag key and value pairs that are attached to the view.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The ARN of the new view. For example:
*
* `arn:aws:resource-explorer-2:us-east-1:123456789012:view/MyView/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222`
*/
readonly viewArn: pulumi.Output<string>;
/**
* The name of the new view.
*/
readonly viewName: pulumi.Output<string>;
/**
* Create a View resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: ViewArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a View resource.
*/
export interface ViewArgs {
/**
* An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view. When you use this view in a [Search](https://docs.aws.amazon.com/resource-explorer/latest/apireference/API_Search.html) operation, the filter string is combined with the search's `QueryString` parameter using a logical `AND` operator.
*
* For information about the supported syntax, see [Search query reference for Resource Explorer](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) in the *AWS Resource Explorer User Guide* .
*
* > This query string in the context of this operation supports only [filter prefixes](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters) with optional [operators](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators) . It doesn't support free-form text. For example, the string `region:us* service:ec2 -tag:stage=prod` includes all Amazon EC2 resources in any AWS Region that begin with the letters `us` and are *not* tagged with a key `Stage` that has the value `prod` .
*/
filters?: pulumi.Input<inputs.resourceexplorer2.ViewSearchFilterArgs>;
/**
* A list of fields that provide additional information about the view.
*/
includedProperties?: pulumi.Input<pulumi.Input<inputs.resourceexplorer2.ViewIncludedPropertyArgs>[]>;
/**
* The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.
*/
scope?: pulumi.Input<string>;
/**
* Tag key and value pairs that are attached to the view.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The name of the new view.
*/
viewName?: pulumi.Input<string>;
}