AWS::QBusiness::Retriever

QBusiness Retriever

Definition of AWS::QBusiness::Retriever Resource Type

Properties

6 configurable properties. 4 required. Click a row to see details.

Filter:

Property	Type	Flags
`ApplicationId`	`string`	RequiredCreate-only
`Configuration`	`RetrieverConfiguration`	Required
`DisplayName`	`string`	Required
`Type`	`string`	RequiredCreate-only
`RoleArn`	`string`
`Tags`	`Array<Tag>`

Return Values

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

Attribute	Type	Description
`CreatedAt`	`string`	-
`RetrieverArn`	`string`	-
`RetrieverId`	`string`	-
`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::Retriever

Resources:
  MyResource:
    Type: AWS::QBusiness::Retriever
    Properties:
      ApplicationId: "my-applicationid"
      Configuration: "value"
      DisplayName: "my-displayname"
      Type: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

iam:PassRoleqbusiness:CreateRetrieverqbusiness:GetRetrieverqbusiness:ListTagsForResourceqbusiness:TagResource

read

qbusiness:GetRetrieverqbusiness:ListTagsForResource

update

iam:PassRoleqbusiness:GetRetrieverqbusiness:ListTagsForResourceqbusiness:TagResourceqbusiness:UntagResourceqbusiness:UpdateRetriever

delete

qbusiness:DeleteRetrieverqbusiness:GetRetriever

list

qbusiness:ListRetrievers

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

Properties11

Required4

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