選取您的 Cookie 偏好設定

我們使用提供自身網站和服務所需的基本 Cookie 和類似工具。我們使用效能 Cookie 收集匿名統計資料，以便了解客戶如何使用我們的網站並進行改進。基本 Cookie 無法停用，但可以按一下「自訂」或「拒絕」以拒絕效能 Cookie。

如果您同意，AWS 與經核准的第三方也會使用 Cookie 提供實用的網站功能、記住您的偏好設定，並顯示相關內容，包括相關廣告。若要接受或拒絕所有非必要 Cookie，請按一下「接受」或「拒絕」。若要進行更詳細的選擇，請按一下「自訂」。

偏好設定
聯絡我們
意見回饋
AWS Documentation
建立 AWS 帳戶

Connecting Amazon Q Business to Google Drive using AWS CloudFormation

PDF
RSS
焦點模式
Connecting Amazon Q Business to Google Drive using AWS CloudFormation - Amazon Q Business
Google Drive configuration propertiesGoogle Drive JSON schemaGoogle Drive YAML schema
此頁面尚未翻譯為您的語言。 請求翻譯

You use the AWS::QBusiness::DataSource resource to connect a data source to your Amazon Q application.

Use the configuration property to provide a JSON or YAML schema with the necessary configuration details specific to your data source connector.

To learn more about AWS CloudFormation, see What is AWS CloudFormation? in the AWS CloudFormation User Guide.

Google Drive configuration properties

The following provides information about important configuration properties required in the schema.

Configuration Description Type Required
connectionConfiguration Configuration information for the data source.

object

This property has the following sub-property: repositoryEndpointMetadata.

 Yes
repositoryEndpointMetadata The endpoint information for the data source. This data source doesn't specify an endpoint. You choose your authentication type: serviceAccount and OAuth2. The connection information is included in an AWS Secrets Manager secret that you provide the secretArn.

object

This property has the following sub-property: authType.

 Yes
authType Choose between serviceAccount and OAuth2, based on your use case.

string

 Yes
repositoryConfigurations Configuration information for the content of the data source. For example, configuring specific types of content and field mappings.

object

This property has the following sub-properties: file and comment.

 Yes

  • file

  • comment

 A list of objects that map the attributes or field names of your Google Drive to Amazon Q index field names.

object

object

These properties have the following sub-properties.

  • indexFieldName

  • indexFieldType

  • dataSourceFieldName

  • dateFieldFormat

 No

indexFieldName

 The field name of your Google Drive to Amazon Q index field names.

string

 Yes

indexFieldType

 The field type of your Google Drive to Amazon Q index field names.

string

The allowed values are STRING, STRING_LIST, and DATE.

 Yes

dataSourceFieldName

 The data source field name of your Google Drive to Amazon Q index field names.

string

 Yes

dateFieldFormat

 The date format of your Google Drive to Amazon Q index field names.

string

Specify the date format in the form yyyy-MM-dd'T'HH:mm:ss'Z'

 No
additionalProperties Additional configuration options for your content in your data source

object

This property has the following sub-properties.

  • isCrawlAcl

  • isCrawlMyDriveAndSharedWithMe

  • isCrawlSharedDrives

  • isCrawlComment

  • fieldForUserId

  • maxFileSizeInMegaBytes

  • excludeUserAccounts

  • excludeSharedDrives

  • excludeMimeTypes

  • includeUserAccounts

  • includeSharedDrives

  • includeMimeTypes

  • includeTargetAudienceGroup

  • inclusionFileTypePatterns

  • inclusionFileNamePatterns

  • exclusionFileTypePatterns

  • exclusionFileNamePatterns

  • inclusionFilePathFilter

  • exclusionFilePathFilter

 Yes
isCrawlAcl Specify true to crawl access control information by default from documents.
Note

Amazon Q Business crawls ACL information to ensure responses are generated only from documents your end users have access to. See Authorization for more details.

boolean

 No
fieldForUserId Specify field to use for UserId for ACL crawling.

string

 No
maxFileSizeInMegaBytes Specify the maximum single file size limit in MBs that Amazon Q will crawl. Amazon Q will crawl only the files within the size limit you define. The default file size is 50 MB. The maximum file size should be greater than 0MB and less than or equal to 50 MB. You can use up to 10 GB (10240 MB) if you set videoExtractionStatus to ENABLED in mediaExtractionConfiguration.videoExtractionConfiguration when using CreateDatasource or UpdateDatasource API. Otherwise, you can use up to 2 GB (2048 MB) if you set audioExtractionStatus to ENABLED in mediaExtractionConfiguration.audioExtractionConfiguration when using the CreateDatasource or UpdateDatasource API.

string

 No

  • iscrawlComment

 true to index comments in your Google Drive data source.

boolean

 No

  • isCrawlMyDriveAndSharedWithMe

 true to index MyDrive and Shared With Me Drives in your Google Drive data source.

boolean

 No

  • isCrawlSharedDrives

 true to index Shared Drives in your Google Drive data source.

boolean

 No

  • excludeUserAccounts

  • excludeSharedDrives

  • excludeMimeTypes

  • exclusionFileTypePatterns

  • exclusionFileNamePatterns

  • exclusionFilePathFilter

 A list of regular expression patterns to exclude specific files in your Google Drive data source. Files that match the patterns are excluded from the index. Files that don't match the patterns are included in the index. If a file matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.

array

 No

  • includeUserAccounts

  • includeSharedDrives

  • includeMimeTypes

  • includeTargetAudienceGroup

  • inclusionFileTypePatterns

  • inclusionFileNamePatterns

  • inclusionFilePathFilter

 A list of regular expression patterns to include specific files in your Google Drive data source. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.

array

 No
type The type of data source. We recommend GOOOGLEDRIVEV2 as your data source type.

string

Valid values are GOOOGLEDRIVEV2 and GOOGLEDRIVE.

 No
enableIdentityCrawler true to activate identity crawler. Identity crawler is activated by default. Crawling identity information on users and groups with access to certain documents is useful for user context filtering. Search results are filtered based on the user or their group access to documents.
Note

Amazon Q Business crawls identity information from your data source by default to ensure responses are generated only from documents end users have access to. For more information, see Identity crawler.

boolean

 Yes
syncMode Specify whether Amazon Q should update your index by syncing all documents or only new, modified, and deleted documents.

string

You can choose between the following options:

  • Use FORCED_FULL_CRAWL to freshly re-crawl all content and replace existing content each time your data source syncs with your index

  • Use FULL_CRAWL to incrementally crawl only new, modified, and deleted content each time your data source syncs with your index

  • Use CHANGE_LOG to incrementally crawl only new and modified content each time your data source syncs with your index.

 Yes
secretARN The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key-value pairs required to connect to your Google Drive.

string

The secret must contain a JSON structure with the following keys:

If using Google Service Account authentication:

{
    "clientEmail": "user account email",
    "adminAccountEmail": "service account email",
    "privateKey": "private key"
}

If using OAuth 2.0 authentication:

{
    "clientID": "OAuth client ID",
    "clientSecret": "client secret",
    "refreshToken": "refresh token"
}
 Yes
version The version of this template that's currently supported.

string

 No

Google Drive JSON schema for using the configuration property with AWS CloudFormation

The following is the Google Drive JSON schema and examples for the configuration property for AWS CloudFormation.

Google Drive JSON schema for using the configuration property with AWS CloudFormation

The following is the Google Drive JSON schema for the configuration property for AWS CloudFormation

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": ["GOOGLEDRIVEV2", "GOOGLEDRIVE"]
    },
    "syncMode": {
      "type": "string",
      "enum": ["FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG"]
    },
    "secretArn": {
      "type": "string",
      "minLength": 20,
      "maxLength": 2048
    },
    "enableIdentityCrawler": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "string",
          "enum": ["true", "false"]
        }
      ]
    },
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "authType": {
              "type": "string",
              "enum": ["serviceAccount", "OAuth2"]
            }
          },
          "required": ["authType"]
        }
      },
      "required": ["repositoryEndpointMetadata"]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "file": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": ["STRING", "DATE", "STRING_LIST", "LONG"]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": ["fieldMappings"]
        },
        "comment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": ["STRING", "DATE", "STRING_LIST"]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": ["fieldMappings"]
        }
      }
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "maxFileSizeInMegaBytes": {
          "type": "string"
        },
        "isCrawlComment": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "string",
              "enum": ["true", "false"]
            }
          ]
        },
        "isCrawlMyDriveAndSharedWithMe": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "string",
              "enum": ["true", "false"]
            }
          ]
        },
        "isCrawlSharedDrives": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "string",
              "enum": ["true", "false"]
            }
          ]
        },
        "isCrawlAcl": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "string",
              "enum": ["true", "false"]
            }
          ]
        },
        "fieldForUserId": {
          "type": "string"
        },
        "excludeUserAccounts": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "excludeSharedDrives": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "excludeMimeTypes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "includeUserAccounts": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "includeSharedDrives": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "includeMimeTypes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "includeTargetAudienceGroup": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionFileTypePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionFileNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionFileTypePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionFileNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionFilePathFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionFilePathFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "enableDeletionProtection": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "string",
              "enum": ["true", "false"]
            }
          ],
          "default": false
        },
        "deletionProtectionThreshold": {
          "type": "string",
          "default": "15"
        }
      }
    },
    "version": {
      "type": "string",
      "anyOf": [
        {
          "pattern": "1.0.0"
        }
      ]
    }
  },
  "required": [
    "type",
    "syncMode",
    "secretArn",
    "connectionConfiguration",
    "repositoryConfigurations",
    "additionalProperties"
  ]
}

Google Drive JSON schema example for using the configuration property with AWS CloudFormation

The following is the Google Drive JSON schema example for the configuration property for AWS CloudFormation

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Description": "CloudFormation GOOGLEDRIVE Data Source Template",
  "Resources": {
    "DataSourceGoogleDrive": {
      "Type": "AWS::QBusiness::DataSource",
      "Properties": {
        "ApplicationId": "app12345-1234-1234-1234-123456789012",
        "IndexId": "indx1234-1234-1234-1234-123456789012",
        "DisplayName": "MyGoogleDriveDataSource",
        "RoleArn": "arn:aws:iam::123456789012:role/qbusiness-data-source-role",
        "Configuration": {
          "type": "GOOGLEDRIVEV2",
          "syncMode": "FULL_CRAWL",
          "secretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:my-google-drive-secret",
          "enableIdentityCrawler": "true",
          "connectionConfiguration": {
            "repositoryEndpointMetadata": {
              "authType": "OAuth2"
            }
          },
          "repositoryConfigurations": {
            "file": {
              "fieldMappings": [
                {
                  "indexFieldName": "file_id",
                  "indexFieldType": "STRING",
                  "dataSourceFieldName": "id",
                  "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                }
              ]
            },
            "comment": {
              "fieldMappings": [
                {
                  "indexFieldName": "comment_id",
                  "indexFieldType": "STRING",
                  "dataSourceFieldName": "id",
                  "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                }
              ]
            }
          },
          "additionalProperties": {
            "maxFileSizeInMegaBytes": "50",
            "isCrawlComment": "true",
            "isCrawlMyDriveAndSharedWithMe": "true",
            "isCrawlSharedDrives": "false",
            "isCrawlAcl": "true",
            "fieldForUserId": "user@example.com",
            "excludeUserAccounts": ["user1@example.com", "user2@example.com"],
            "excludeSharedDrives": ["SharedDrive1"],
            "excludeMimeTypes": ["application/vnd.google-apps.folder"],
            "includeUserAccounts": ["user3@example.com"],
            "includeSharedDrives": ["SharedDrive2"],
            "includeMimeTypes": [
              "application/pdf",
              "application/vnd.google-apps.document"
            ],
            "includeTargetAudienceGroup": ["group1@example.com"],
            "inclusionFileTypePatterns": ["*.pdf"],
            "inclusionFileNamePatterns": ["*report*"],
            "exclusionFileTypePatterns": ["*.tmp"],
            "exclusionFileNamePatterns": ["*draft*"],
            "inclusionFilePathFilter": ["documents/"],
            "exclusionFilePathFilter": ["drafts/"],
            "enableDeletionProtection": "true",
            "deletionProtectionThreshold": "15"
          }
        }
      }
    }
  }
}

Google Drive YAML schema for using the configuration property with AWS CloudFormation

The following is the Google Drive YAML schema and examples for the configuration property for AWS CloudFormation:

Google Drive YAML schema for using the configuration property with AWS CloudFormation

The following is the Google Drive YAML schema for the configuration property for AWS CloudFormation.

type: object
properties:
  type:
    type: string
    enum:
      - GOOGLEDRIVEV2
      - GOOGLEDRIVE
  syncMode:
    type: string
    enum:
      - FORCED_FULL_CRAWL
      - FULL_CRAWL
      - CHANGE_LOG
  secretArn:
    type: string
    minLength: 20
    maxLength: 2048
  enableIdentityCrawler:
    anyOf:
      - type: boolean
      - type: string
        enum:
          - true
          - false
  connectionConfiguration:
    type: object
    properties:
      repositoryEndpointMetadata:
        type: object
        properties:
          authType:
            type: string
            enum:
              - serviceAccount
              - OAuth2
        required:
          - authType
    required:
      - repositoryEndpointMetadata
  repositoryConfigurations:
    type: object
    properties:
      file:
        type: object
        properties:
          fieldMappings:
            type: array
            items:
              type: object
              properties:
                indexFieldName:
                  type: string
                indexFieldType:
                  type: string
                  enum:
                    - STRING
                    - DATE
                    - STRING_LIST
                    - LONG
                dataSourceFieldName:
                  type: string
                dateFieldFormat:
                  type: string
                  pattern: "yyyy-MM-dd'T'HH:mm:ss'Z'"
              required:
                - indexFieldName
                - indexFieldType
                - dataSourceFieldName
        required:
          - fieldMappings
      comment:
        type: object
        properties:
          fieldMappings:
            type: array
            items:
              type: object
              properties:
                indexFieldName:
                  type: string
                indexFieldType:
                  type: string
                  enum:
                    - STRING
                    - DATE
                    - STRING_LIST
                dataSourceFieldName:
                  type: string
                dateFieldFormat:
                  type: string
                  pattern: "yyyy-MM-dd'T'HH:mm:ss'Z'"
              required:
                - indexFieldName
                - indexFieldType
                - dataSourceFieldName
        required:
          - fieldMappings
  additionalProperties:
    type: object
    properties:
      maxFileSizeInMegaBytes:
        type: string
      isCrawlComment:
        anyOf:
          - type: boolean
          - type: string
            enum:
              - true
              - false
      isCrawlMyDriveAndSharedWithMe:
        anyOf:
          - type: boolean
          - type: string
            enum:
              - true
              - false
      isCrawlSharedDrives:
        anyOf:
          - type: boolean
          - type: string
            enum:
              - true
              - false
      isCrawlAcl:
        anyOf:
          - type: boolean
          - type: string
            enum:
              - true
              - false
      fieldForUserId:
        type: string
      excludeUserAccounts:
        type: array
        items:
          type: string
      excludeSharedDrives:
        type: array
        items:
          type: string
      excludeMimeTypes:
        type: array
        items:
          type: string
      includeUserAccounts:
        type: array
        items:
          type: string
      includeSharedDrives:
        type: array
        items:
          type: string
      includeMimeTypes:
        type: array
        items:
          type: string
      includeTargetAudienceGroup:
        type: array
        items:
          type: string
      inclusionFileTypePatterns:
        type: array
        items:
          type: string
      inclusionFileNamePatterns:
        type: array
        items:
          type: string
      exclusionFileTypePatterns:
        type: array
        items:
          type: string
      exclusionFileNamePatterns:
        type: array
        items:
          type: string
      inclusionFilePathFilter:
        type: array
        items:
          type: string
      exclusionFilePathFilter:
        type: array
        items:
          type: string
      enableDeletionProtection:
        anyOf:
          - type: boolean
          - type: string
            enum:
              - true
              - false
        default: false
      deletionProtectionThreshold:
        type: string
        default: "15"
  version:
    type: string
    anyOf:
      - pattern: 1.0.0
required:
  - type
  - syncMode
  - secretArn
  - connectionConfiguration
  - repositoryConfigurations
  - additionalProperties

Google Drive YAML schema example for using the configuration property with AWS CloudFormation

The following is the Google Drive YAML example for the Configuration property for AWS CloudFormation:

AWSTemplateFormatVersion: "2010-09-09"
Description: CloudFormation GOOGLEDRIVE Data Source Template
Resources:
  DataSourceGoogleDrive:
    Type: AWS::QBusiness::DataSource
    Properties:
      ApplicationId: app12345-1234-1234-1234-123456789012
      IndexId: indx1234-1234-1234-1234-123456789012
      DisplayName: MyGoogleDriveDataSource
      RoleArn: arn:aws:iam::123456789012:role/qbusiness-data-source-role
      Configuration:
        type: GOOGLEDRIVEV2
        syncMode: FULL_CRAWL
        secretArn: arn:aws:secretsmanager:us-west-2:123456789012:secret:my-google-drive-secret
        enableIdentityCrawler: "true"
        connectionConfiguration:
          repositoryEndpointMetadata:
            authType: OAuth2
        repositoryConfigurations:
          file:
            fieldMappings:
              - indexFieldName: file_id
                indexFieldType: STRING
                dataSourceFieldName: id
                dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z'
          comment:
            fieldMappings:
              - indexFieldName: comment_id
                indexFieldType: STRING
                dataSourceFieldName: id
                dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z'
        additionalProperties:
          maxFileSizeInMegaBytes: "50"
          isCrawlComment: "true"
          isCrawlMyDriveAndSharedWithMe: "true"
          isCrawlSharedDrives: "false"
          isCrawlAcl: "true"
          fieldForUserId: user@example.com
          excludeUserAccounts:
            - user1@example.com
            - user2@example.com
          excludeSharedDrives:
            - SharedDrive1
          excludeMimeTypes:
            - application/vnd.google-apps.folder
          includeUserAccounts:
            - user3@example.com
          includeSharedDrives:
            - SharedDrive2
          includeMimeTypes:
            - application/pdf
            - application/vnd.google-apps.document
          includeTargetAudienceGroup:
            - group1@example.com
          inclusionFileTypePatterns:
            - "*.pdf"
          inclusionFileNamePatterns:
            - "*report*"
          exclusionFileTypePatterns:
            - "*.tmp"
          exclusionFileNamePatterns:
            - "*draft*"
          inclusionFilePathFilter:
            - documents/
          exclusionFilePathFilter:
            - drafts/
          enableDeletionProtection: "true"
          deletionProtectionThreshold: "15"

在本頁面

下一個主題：

ACL crawling

上一個主題：

Using the API

需要協助？

隱私權網站條款Cookie 偏好設定
© 2025, Amazon Web Services, Inc.或其附屬公司。保留所有權利。