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	awscc.resourceexplorer2.indices

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

For more information, see AWS::ResourceExplorer2::Index.

Methods

Name	Resource	Accessible by	Required Params
create_resource	indices	INSERT	Type, region
delete_resource	indices	DELETE	Identifier, region
update_resource	indices	UPDATE	Identifier, PatchDocument, region
list_resources	indices_list_only	SELECT	region
get_resource	indices	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual index.

SELECT
  region,
  arn,
  tags,
  type,
  index_state
FROM awscc.resourceexplorer2.indices
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all indices in a region.

SELECT
  region,
  arn
FROM awscc.resourceexplorer2.indices_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.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 }}'

UPDATE example

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

/*+ update */
UPDATE awscc.resourceexplorer2.indices
SET PatchDocument = string('{{ {
    "Tags": tags,
    "Type": type
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.resourceexplorer2.indices
WHERE
  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