AWS::ResourceExplorer2::Index

Turns on Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index. Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation.

You can create either a local index that returns search results from only the Amazon Web Services Region in which the index exists, or you can create an aggregator index that returns search results from all Amazon Web Services Regions in the Amazon Web Services account.

For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see Turning on Resource Explorer to index your resources in an Amazon Web Services Region in the Amazon Resource Explorer User Guide.

If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, this operation also creates a service-linked role in your Amazon Web Services account that allows Resource Explorer to search for your resources and populate the index.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

{
  "Type" : "AWS::ResourceExplorer2::Index",
  "Properties" : {
      "Tags" : {Key: Value, ...},
      "Type" : String
    }
}

Type: AWS::ResourceExplorer2::Index
Properties:
  Tags: 
    Key: Value
  Type: String

Properties

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the new index. For example:

arn:aws:resource-explorer-2:us-east-1:123456789012:index/EXAMPLE8-90ab-cdef-fedc-EXAMPLE22222

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Examples

Turning on Resource Explorer in a Region by creating an index

{
    "Description": "Sample stack template that creates a Resource Explorer aggregator index",
    "Resources": {
        "SampleIndex": {
            "Type": "AWS::ResourceExplorer2::Index",
            "Properties": {
                "Type": "AGGREGATOR",
                "Tags": {
                    "Purpose": "ResourceExplorer Sample Stack"
                }
            }
        }
    }
}

AWSTemplateFormatVersion: "2010-09-09"
Description: A sample template that creates a Resource Explorer aggregator index
Resources:
  SampleIndex:
    Type: 'AWS::ResourceExplorer2::Index'
    Properties:
      Type: AGGREGATOR
      Tags:
        Purpose: ResourceExplorer Sample Stack