Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. resourceexplorer2
  5. getIndex

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.resourceexplorer2.getIndex

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::ResourceExplorer2::Index Resource Type

    Using getIndex

    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 getIndex(args: GetIndexArgs, opts?: InvokeOptions): Promise<GetIndexResult>
function getIndexOutput(args: GetIndexOutputArgs, opts?: InvokeOptions): Output<GetIndexResult>
    def get_index(arn: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetIndexResult
def get_index_output(arn: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetIndexResult]
    func LookupIndex(ctx *Context, args *LookupIndexArgs, opts ...InvokeOption) (*LookupIndexResult, error)
func LookupIndexOutput(ctx *Context, args *LookupIndexOutputArgs, opts ...InvokeOption) LookupIndexResultOutput

    > Note: This function is named LookupIndex in the Go SDK.

    public static class GetIndex 
{
    public static Task<GetIndexResult> InvokeAsync(GetIndexArgs args, InvokeOptions? opts = null)
    public static Output<GetIndexResult> Invoke(GetIndexInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIndexResult> getIndex(GetIndexArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:resourceexplorer2:getIndex
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string

    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

    Arn string

    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

    arn String

    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

    arn string

    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

    arn str

    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

    arn String

    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

    getIndex Result

    The following output properties are available:

    Arn string

    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

    IndexState Pulumi.AwsNative.ResourceExplorer2.IndexState

    Indicates the current state of the index. For example:

    CREATING

    Tags Dictionary<string, string>
    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.
    Type Pulumi.AwsNative.ResourceExplorer2.IndexType
    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 in the AWS Resource Explorer User Guide. .
    Arn string

    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

    IndexState IndexStateEnum

    Indicates the current state of the index. For example:

    CREATING

    Tags map[string]string
    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.
    Type IndexType
    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 in the AWS Resource Explorer User Guide. .
    arn String

    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

    indexState IndexState

    Indicates the current state of the index. For example:

    CREATING

    tags Map<String,String>
    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.
    type IndexType
    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 in the AWS Resource Explorer User Guide. .
    arn string

    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

    indexState IndexState

    Indicates the current state of the index. For example:

    CREATING

    tags {[key: string]: string}
    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.
    type IndexType
    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 in the AWS Resource Explorer User Guide. .
    arn str

    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

    index_state IndexState

    Indicates the current state of the index. For example:

    CREATING

    tags Mapping[str, str]
    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.
    type IndexType
    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 in the AWS Resource Explorer User Guide. .
    arn String

    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

    indexState "ACTIVE" | "CREATING" | "DELETING" | "DELETED" | "UPDATING"

    Indicates the current state of the index. For example:

    CREATING

    tags Map<String>
    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.
    type "LOCAL" | "AGGREGATOR"
    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 in the AWS Resource Explorer User Guide. .

    Supporting Types

    IndexState

    IndexType

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native