Class: Aws::ResourceExplorer2::Types::Index

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-resourceexplorer2/types.rb

Overview

An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers. Creating an index in an Amazon Web Services Region turns on Resource Explorer and lets it discover your resources.

By default, an index is local, meaning that it contains information about resources in only the same Region as the index. However, you can promote the index of one Region in the account by calling UpdateIndexType to convert it into an aggregator index. The aggregator index receives a replicated copy of the index information from all other Regions where Resource Explorer is turned on. This allows search operations in that Region to return results from all Regions in the account.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The [Amazon resource name (ARN)] of the index.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (String) 


605
606
607
608
609
610
611
 
# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 605

class Index < Struct.new(
  :arn,
  :region,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ String

The Amazon Web Services Region in which the index exists.

Returns:

  • (String) 


605
606
607
608
609
610
611
 
# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 605

class Index < Struct.new(
  :arn,
  :region,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of index. It can be one of the following values:

  • ‘LOCAL` – The index contains information about resources from only the same Amazon Web Services Region.

  • ‘AGGREGATOR` – Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.

Returns:

  • (String) 


605
606
607
608
609
610
611
 
# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 605

class Index < Struct.new(
  :arn,
  :region,
  :type)
  SENSITIVE = []
  include Aws::Structure
end