indices

Creates, updates, deletes or gets an index resource or lists indices in a region

Overview

Name	indices
Type	Resource
Description	Definition of AWS::ResourceExplorer2::Index Resource Type
Id	aws.resourceexplorer2.indices

Fields

Name	Datatype	Description
arn	string
tags	object
type	string
index_state	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Type, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all indices in a region.

SELECT
region,
arn,
tags,
type,
index_state
FROM aws.resourceexplorer2.indices
WHERE region = 'us-east-1';

Gets all properties from an individual index.

SELECT
region,
arn,
tags,
type,
index_state
FROM aws.resourceexplorer2.indices
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new index resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.resourceexplorer2.indices (
 Type,
 region
)
SELECT 
'{{ Type }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.resourceexplorer2.indices (
 Tags,
 Type,
 region
)
SELECT 
 '{{ Tags }}',
 '{{ Type }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: index
    props:
      - name: Tags
        value: {}
      - name: Type
        value: '{{ Type }}'

DELETE example

/*+ delete */
DELETE FROM aws.resourceexplorer2.indices
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the indices resource, the following permissions are required:

Create

resource-explorer-2:CreateIndex,
resource-explorer-2:GetIndex,
resource-explorer-2:TagResource,
resource-explorer-2:UpdateIndexType,
resource-explorer-2:DeleteIndex,
iam:CreateServiceLinkedRole

Update

resource-explorer-2:GetIndex,
resource-explorer-2:UpdateIndexType,
resource-explorer-2:TagResource,
resource-explorer-2:UntagResource,
resource-explorer-2:ListTagsForResource

Delete

resource-explorer-2:DeleteIndex,
resource-explorer-2:GetIndex,
resource-explorer-2:UntagResource

List

resource-explorer-2:ListIndexes

Read

resource-explorer-2:GetIndex