Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ResourceExplorer2.Types.Index

Description

Synopsis

data Index = Index' {
- arn :: Maybe Text
- region :: Maybe Text
- type' :: Maybe IndexType
}
newIndex :: Index
index_arn :: Lens' Index (Maybe Text)
index_region :: Lens' Index (Maybe Text)
index_type :: Lens' Index (Maybe IndexType)

Documentation

data Index Source #

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: newIndex smart constructor.

Constructors

Index'

Fields

arn :: Maybe Text
The Amazon resource name (ARN) of the index.
region :: Maybe Text
The Amazon Web Services Region in which the index exists.
type' :: Maybe IndexType
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.

Instances

Instances details

FromJSON Index Source #
Instance details Defined in Amazonka.ResourceExplorer2.Types.Index Methods parseJSON :: Value -> Parser Index # parseJSONList :: Value -> Parser [Index] #
Generic Index Source #
Instance details Defined in Amazonka.ResourceExplorer2.Types.Index Associated Types type Rep Index :: Type -> Type # Methods from :: Index -> Rep Index x # to :: Rep Index x -> Index #
Read Index Source #
Instance details Defined in Amazonka.ResourceExplorer2.Types.Index Methods readsPrec :: Int -> ReadS Index # readList :: ReadS [Index] # readPrec :: ReadPrec Index # readListPrec :: ReadPrec [Index] #
Show Index Source #
Instance details Defined in Amazonka.ResourceExplorer2.Types.Index Methods showsPrec :: Int -> Index -> ShowS # show :: Index -> String # showList :: [Index] -> ShowS #
NFData Index Source #
Instance details Defined in Amazonka.ResourceExplorer2.Types.Index Methods rnf :: Index -> () #
Eq Index Source #
Instance details Defined in Amazonka.ResourceExplorer2.Types.Index Methods (==) :: Index -> Index -> Bool # (/=) :: Index -> Index -> Bool #
Hashable Index Source #
Instance details Defined in Amazonka.ResourceExplorer2.Types.Index Methods hashWithSalt :: Int -> Index -> Int # hash :: Index -> Int #
type Rep Index Source #
Instance details Defined in Amazonka.ResourceExplorer2.Types.Index type Rep Index = D1 ('MetaData "Index" "Amazonka.ResourceExplorer2.Types.Index" "amazonka-resource-explorer-v2-2.0-DYDynTzMYCcKX3QLWjH6Yt" 'False) (C1 ('MetaCons "Index'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IndexType)))))

newIndex :: Index Source #

Create a value of Index with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:Index', index_arn - The Amazon resource name (ARN) of the index.

$sel:region:Index', index_region - The Amazon Web Services Region in which the index exists.

$sel:type':Index', index_type - 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.

index_arn :: Lens' Index (Maybe Text) Source #

The Amazon resource name (ARN) of the index.

index_region :: Lens' Index (Maybe Text) Source #

The Amazon Web Services Region in which the index exists.

index_type :: Lens' Index (Maybe IndexType) Source #

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.