indices

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

Overview

Name	indices
Type	Resource
Description	Definition of AWS::QBusiness::Index Resource Type
Id	aws.qbusiness.indices

Fields

Name	Datatype	Description
application_id	string
capacity_configuration	object
created_at	string
description	string
display_name	string
document_attribute_configurations	array
index_arn	string
index_id	string
index_statistics	object
type	string
status	string
tags	array
updated_at	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ApplicationId, DisplayName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resource	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

List all indices in a region.

SELECT
region,
application_id,
index_id
FROM aws.qbusiness.indices
WHERE region = 'us-east-1';

Gets all properties from an index.

SELECT
region,
application_id,
capacity_configuration,
created_at,
description,
display_name,
document_attribute_configurations,
index_arn,
index_id,
index_statistics,
type,
status,
tags,
updated_at
FROM aws.qbusiness.indices
WHERE region = 'us-east-1' AND data__Identifier = '<ApplicationId>|<IndexId>';

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.qbusiness.indices (
 ApplicationId,
 DisplayName,
 region
)
SELECT 
'{{ ApplicationId }}',
 '{{ DisplayName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.qbusiness.indices (
 ApplicationId,
 CapacityConfiguration,
 Description,
 DisplayName,
 DocumentAttributeConfigurations,
 Type,
 Tags,
 region
)
SELECT 
 '{{ ApplicationId }}',
 '{{ CapacityConfiguration }}',
 '{{ Description }}',
 '{{ DisplayName }}',
 '{{ DocumentAttributeConfigurations }}',
 '{{ Type }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: index
    props:
      - name: ApplicationId
        value: '{{ ApplicationId }}'
      - name: CapacityConfiguration
        value:
          Units: null
      - name: Description
        value: '{{ Description }}'
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: DocumentAttributeConfigurations
        value:
          - Name: '{{ Name }}'
            Type: '{{ Type }}'
            Search: '{{ Search }}'
      - name: Type
        value: '{{ Type }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.qbusiness.indices
WHERE data__Identifier = '<ApplicationId|IndexId>'
AND region = 'us-east-1';

Permissions

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

Create

qbusiness:CreateIndex,
qbusiness:GetIndex,
qbusiness:ListTagsForResource,
qbusiness:TagResource,
qbusiness:UpdateIndex

Read

qbusiness:GetIndex,
qbusiness:ListTagsForResource

Update

qbusiness:GetIndex,
qbusiness:ListTagsForResource,
qbusiness:TagResource,
qbusiness:UntagResource,
qbusiness:UpdateIndex

Delete

qbusiness:DeleteIndex,
qbusiness:GetIndex

List

qbusiness:ListIndices