resource_explorer_setups

Creates, updates, deletes, gets or lists a resource_explorer_setups resource.

Overview

Name	resource_explorer_setups
Type	Resource
Id	aws.resource_explorer_2.resource_explorer_setups

Fields

The following fields are returned by SELECT queries:

get_resource_explorer_setup

Name	Datatype	Description
index	object	The status information for the Resource Explorer index in this Region.
region	string	The Amazon Web Services Region for which this status information applies. (pattern: <code>[a-z-]+-[a-z]+-[0-9]</code>)
view	object	The status information for the Resource Explorer view in this Region.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_resource_explorer_setup	select	region		Retrieves the status and details of a Resource Explorer setup operation. This operation returns information about the progress of creating or deleting Resource Explorer configurations across Regions.
create_resource_explorer_setup	insert	region, RegionList, ViewName		Creates a Resource Explorer setup configuration across multiple Amazon Web Services Regions. This operation sets up indexes and views in the specified Regions. This operation can also be used to set an aggregator Region for cross-Region resource search.
delete_resource_explorer_setup	delete	region		Deletes a Resource Explorer setup configuration. This operation removes indexes and views from the specified Regions or all Regions where Resource Explorer is configured.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_resource_explorer_setup

Retrieves the status and details of a Resource Explorer setup operation. This operation returns information about the progress of creating or deleting Resource Explorer configurations across Regions.

SELECT
index,
region,
view
FROM aws.resource_explorer_2.resource_explorer_setups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_resource_explorer_setup

Creates a Resource Explorer setup configuration across multiple Amazon Web Services Regions. This operation sets up indexes and views in the specified Regions. This operation can also be used to set an aggregator Region for cross-Region resource search.

INSERT INTO aws.resource_explorer_2.resource_explorer_setups (
RegionList,
AggregatorRegions,
ViewName,
region
)
SELECT 
'{{ RegionList }}' /* required */,
'{{ AggregatorRegions }}',
'{{ ViewName }}' /* required */,
'{{ region }}'
RETURNING
task_id
;

Manifest

# Description fields are for documentation purposes
- name: resource_explorer_setups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the resource_explorer_setups resource.
  - name: RegionList
    value:
      - "{{ RegionList }}"
  - name: AggregatorRegions
    value:
      - "{{ AggregatorRegions }}"
  - name: ViewName
    value: "{{ ViewName }}"

DELETE examples

delete_resource_explorer_setup

Deletes a Resource Explorer setup configuration. This operation removes indexes and views from the specified Regions or all Regions where Resource Explorer is configured.

DELETE FROM aws.resource_explorer_2.resource_explorer_setups
WHERE region = '{{ region }}' --required
;