Docs Home
We recommend new projects start with resources from the AWS provider.
aws-native.resourceexplorer2.getIndex
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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)
public static Output<GetIndexResult> getIndex(GetIndexArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:resourceexplorer2:getIndex
arguments:
# arguments dictionaryThe 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- Index
State Pulumi.Aws Native. Resource Explorer2. Index State Indicates the current state of the index. For example:
CREATING- 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.
Aws Native. Resource Explorer2. Index Type - 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- Index
State IndexState Enum Indicates the current state of the index. For example:
CREATING- 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
Index
Type - 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- index
State IndexState Indicates the current state of the index. For example:
CREATING- 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
Index
Type - 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- index
State IndexState Indicates the current state of the index. For example:
CREATING- {[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
Index
Type - 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- 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
Index
Type - 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- index
State "ACTIVE" | "CREATING" | "DELETING" | "DELETED" | "UPDATING" Indicates the current state of the index. For example:
CREATING- 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
We recommend new projects start with resources from the AWS provider.