UNPKG

@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)

97 lines (96 loc) 3.97 kB
import * as pulumi from "@pulumi/pulumi"; import * as enums from "../types/enums"; /** * Definition of AWS::ResourceExplorer2::Index Resource Type * * ## Example Usage * ### Example * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws_native from "@pulumi/aws-native"; * * const sampleIndex = new aws_native.resourceexplorer2.Index("sampleIndex", { * type: aws_native.resourceexplorer2.IndexType.Aggregator, * tags: { * purpose: "ResourceExplorer Sample Stack", * }, * }); * * ``` * ### Example * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws_native from "@pulumi/aws-native"; * * const sampleIndex = new aws_native.resourceexplorer2.Index("sampleIndex", { * type: aws_native.resourceexplorer2.IndexType.Aggregator, * tags: { * purpose: "ResourceExplorer Sample Stack", * }, * }); * * ``` */ export declare class Index extends pulumi.CustomResource { /** * Get an existing Index 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): Index; /** * Returns true if the given object is an instance of Index. 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 Index; /** * The ARN of the new index for the AWS Region . For example: * * `arn:aws:resource-explorer-2:us-east-1:123456789012:index/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222` */ readonly arn: pulumi.Output<string>; /** * Indicates the current state of the index. For example: * * `CREATING` */ readonly indexState: pulumi.Output<enums.resourceexplorer2.IndexState>; /** * The specified tags are attached to only the index created in this AWS Region . The tags don't attach to any of the resources listed in the index. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Specifies the type of the index in this Region. For information about the aggregator index and how it differs from a local index, see [Turning on cross-Region search by creating an aggregator index](https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) in the *AWS Resource Explorer User Guide.* . */ readonly type: pulumi.Output<enums.resourceexplorer2.IndexType>; /** * Create a Index 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: IndexArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a Index resource. */ export interface IndexArgs { /** * The specified tags are attached to only the index created in this AWS Region . The tags don't attach to any of the resources listed in the index. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * Specifies the type of the index in this Region. For information about the aggregator index and how it differs from a local index, see [Turning on cross-Region search by creating an aggregator index](https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) in the *AWS Resource Explorer User Guide.* . */ type: pulumi.Input<enums.resourceexplorer2.IndexType>; }