AWS::QBusiness::DataSource

QBusiness DataSource

Definition of AWS::QBusiness::DataSource Resource Type

Properties

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

Filter:

Property	Type	Flags
`ApplicationId`	`string`	RequiredCreate-only
`Configuration`	`Any`	Required
`DisplayName`	`string`	Required
`IndexId`	`string`	RequiredCreate-only
`Description`	`string`
`DocumentEnrichmentConfiguration`	`DocumentEnrichmentConfiguration`
`MediaExtractionConfiguration`	`MediaExtractionConfiguration`
`RoleArn`	`string`
`SyncSchedule`	`string`
`Tags`	`Array<Tag>`
`VpcConfiguration`	`DataSourceVpcConfiguration`

Return Values

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

Attribute	Type	Description
`CreatedAt`	`string`	-
`DataSourceArn`	`string`	-
`DataSourceId`	`string`	-
`Status`	`string`	-
`Type`	`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::DataSource

Resources:
  MyResource:
    Type: AWS::QBusiness::DataSource
    Properties:
      ApplicationId: "my-applicationid"
      IndexId: "my-indexid"
      Configuration: "value"
      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

iam:PassRoleqbusiness:CreateDataSourceqbusiness:GetDataSourceqbusiness:ListTagsForResourceqbusiness:TagResource

read

qbusiness:GetDataSourceqbusiness:ListTagsForResource

update

iam:PassRoleqbusiness:GetDataSourceqbusiness:ListTagsForResourceqbusiness:TagResourceqbusiness:UntagResourceqbusiness:UpdateDataSource

delete

qbusiness:DeleteDataSourceqbusiness:GetDataSource

list

qbusiness:ListDataSources

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

Properties17

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.

ApplicationIdIndexId

Related Resources

External Links

AWS Documentation