AWS::QBusiness::Index

QBusiness Index

Definition of AWS::QBusiness::Index Resource Type

Properties

7 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`ApplicationId`	`string`	RequiredCreate-only
`DisplayName`	`string`	Required
`CapacityConfiguration`	`IndexCapacityConfiguration`
`Description`	`string`
`DocumentAttributeConfigurations`	`Array<DocumentAttributeConfiguration>`
`Tags`	`Array<Tag>`
`Type`	`string`	Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`CreatedAt`	`string`	-
`IndexArn`	`string`	-
`IndexId`	`string`	-
`IndexStatistics`	`IndexStatistics`	-
`Status`	`string`	-
`UpdatedAt`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::QBusiness::Index

Resources:
  MyResource:
    Type: AWS::QBusiness::Index
    Properties:
      ApplicationId: "my-applicationid"
      DisplayName: "my-displayname"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

qbusiness:CreateIndexqbusiness:GetIndexqbusiness:ListTagsForResourceqbusiness:TagResourceqbusiness:UpdateIndex

read

qbusiness:GetIndexqbusiness:ListTagsForResource

update

qbusiness:GetIndexqbusiness:ListTagsForResourceqbusiness:TagResourceqbusiness:UntagResourceqbusiness:UpdateIndex

delete

qbusiness:DeleteIndexqbusiness:GetIndex

list

qbusiness:ListIndices

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceQBusiness

Properties13

Required2

TaggingSupported

Primary IDApplicationId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ApplicationIdType

Related Resources

External Links

AWS Documentation