AWS::Kendra::DataSource OneDriveConfiguration
Provides the configuration information to connect to OneDrive as your data source.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "DisableLocalGroups" :
Boolean
, "ExclusionPatterns" :[ String, ... ]
, "FieldMappings" :[ DataSourceToIndexFieldMapping, ... ]
, "InclusionPatterns" :[ String, ... ]
, "OneDriveUsers" :OneDriveUsers
, "SecretArn" :String
, "TenantDomain" :String
}
YAML
DisableLocalGroups:
Boolean
ExclusionPatterns:- String
FieldMappings:- DataSourceToIndexFieldMapping
InclusionPatterns:- String
OneDriveUsers:OneDriveUsers
SecretArn:String
TenantDomain:String
Properties
DisableLocalGroups
-
TRUE
to disable local groups information.Required: No
Type: Boolean
Update requires: No interruption
ExclusionPatterns
-
A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the file name.
Required: No
Type: Array of String
Minimum:
1
Maximum:
50 | 100
Update requires: No interruption
FieldMappings
-
A list of
DataSourceToIndexFieldMapping
objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use theUpdateIndex
API before you map to OneDrive fields. For more information, see Mapping data source fields. The OneDrive data source field names must exist in your OneDrive custom metadata.Required: No
Type: Array of DataSourceToIndexFieldMapping
Maximum:
100
Update requires: No interruption
InclusionPatterns
-
A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the file name.
Required: No
Type: Array of String
Minimum:
1
Maximum:
50 | 100
Update requires: No interruption
OneDriveUsers
-
A list of user accounts whose documents should be indexed.
Required: Yes
Type: OneDriveUsers
Update requires: No interruption
SecretArn
-
The Amazon Resource Name (ARN) of an Amazon Secrets Manager secret that contains the user name and password to connect to OneDrive. The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.
Required: Yes
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:
1
Maximum:
1284
Update requires: No interruption
TenantDomain
-
The Azure Active Directory domain of the organization.
Required: Yes
Type: String
Pattern:
^([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-z]{2,}$
Minimum:
1
Maximum:
256
Update requires: No interruption