AWS::QBusiness::Retriever - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::QBusiness::Retriever

Adds a retriever to your Amazon Q Business application.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::QBusiness::Retriever",
  "Properties" : {
      "ApplicationId" : String,
      "Configuration" : RetrieverConfiguration,
      "DisplayName" : String,
      "RoleArn" : String,
      "Tags" : [ Tag, ... ],
      "Type" : String
    }
}

YAML

Type: AWS::QBusiness::Retriever
Properties:
  ApplicationId: String
  Configuration: 
    RetrieverConfiguration
  DisplayName: String
  RoleArn: String
  Tags: 
    - Tag
  Type: String

Properties

ApplicationId

The identifier of the Amazon Q Business application using the retriever.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$

Minimum: 36

Maximum: 36

Update requires: Replacement

Configuration

Provides information on how the retriever used for your Amazon Q Business application is configured.

Required: Yes

Type: RetrieverConfiguration

Update requires: No interruption

DisplayName

The name of your retriever.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$

Minimum: 1

Maximum: 1000

Update requires: No interruption

RoleArn

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

Required: No

Type: String

Pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$

Minimum: 0

Maximum: 1284

Update requires: No interruption

Tags

A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Type

The type of your retriever.

Required: Yes

Type: String

Allowed values: NATIVE_INDEX | KENDRA_INDEX

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the retriever ID. For example:

{"Ref": "retriever-id"}

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The Unix timestamp when the retriever was created.

RetrieverArn

The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

RetrieverId

The identifier of the retriever used by your Amazon Q Business application.

Status

The status of your retriever.

UpdatedAt

The Unix timestamp when the retriever was last updated.