Skip to content
v2.278.0

OneDriveConfigurationProperty Struct ​

Provides the configuration information to connect to OneDrive as your data source.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const oneDriveConfigurationProperty: kendra.CfnDataSource.OneDriveConfigurationProperty = {
  oneDriveUsers: {
    oneDriveUserList: ['oneDriveUserList'],
    oneDriveUserS3Path: {
      bucket: 'bucket',
      key: 'key',
    },
  },
  secretArn: 'secretArn',
  tenantDomain: 'tenantDomain',

  // the properties below are optional
  disableLocalGroups: false,
  exclusionPatterns: ['exclusionPatterns'],
  fieldMappings: [{
    dataSourceFieldName: 'dataSourceFieldName',
    indexFieldName: 'indexFieldName',

    // the properties below are optional
    dateFieldFormat: 'dateFieldFormat',
  }],
  inclusionPatterns: ['inclusionPatterns'],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra

one_drive_configuration_property = kendra.CfnDataSource.OneDriveConfigurationProperty(
    one_drive_users=kendra.CfnDataSource.OneDriveUsersProperty(
        one_drive_user_list=["oneDriveUserList"],
        one_drive_user_s3_path=kendra.CfnDataSource.S3PathProperty(
            bucket="bucket",
            key="key"
        )
    ),
    secret_arn="secretArn",
    tenant_domain="tenantDomain",

    # the properties below are optional
    disable_local_groups=False,
    exclusion_patterns=["exclusionPatterns"],
    field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
        data_source_field_name="dataSourceFieldName",
        index_field_name="indexFieldName",

        # the properties below are optional
        date_field_format="dateFieldFormat"
    )],
    inclusion_patterns=["inclusionPatterns"]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.kendra.*;

OneDriveConfigurationProperty oneDriveConfigurationProperty = OneDriveConfigurationProperty.builder()
        .oneDriveUsers(OneDriveUsersProperty.builder()
                .oneDriveUserList(List.of("oneDriveUserList"))
                .oneDriveUserS3Path(S3PathProperty.builder()
                        .bucket("bucket")
                        .key("key")
                        .build())
                .build())
        .secretArn("secretArn")
        .tenantDomain("tenantDomain")

        // the properties below are optional
        .disableLocalGroups(false)
        .exclusionPatterns(List.of("exclusionPatterns"))
        .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                .dataSourceFieldName("dataSourceFieldName")
                .indexFieldName("indexFieldName")

                // the properties below are optional
                .dateFieldFormat("dateFieldFormat")
                .build()))
        .inclusionPatterns(List.of("inclusionPatterns"))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;

var oneDriveConfigurationProperty = new OneDriveConfigurationProperty {
    OneDriveUsers = new OneDriveUsersProperty {
        OneDriveUserList = new [] { "oneDriveUserList" },
        OneDriveUserS3Path = new S3PathProperty {
            Bucket = "bucket",
            Key = "key"
        }
    },
    SecretArn = "secretArn",
    TenantDomain = "tenantDomain",

    // the properties below are optional
    DisableLocalGroups = false,
    ExclusionPatterns = new [] { "exclusionPatterns" },
    FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
        DataSourceFieldName = "dataSourceFieldName",
        IndexFieldName = "indexFieldName",

        // the properties below are optional
        DateFieldFormat = "dateFieldFormat"
    } },
    InclusionPatterns = new [] { "inclusionPatterns" }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

oneDriveConfigurationProperty := &OneDriveConfigurationProperty{
	OneDriveUsers: &OneDriveUsersProperty{
		OneDriveUserList: []*string{
			jsii.String("oneDriveUserList"),
		},
		OneDriveUserS3Path: &S3PathProperty{
			Bucket: jsii.String("bucket"),
			Key: jsii.String("key"),
		},
	},
	SecretArn: jsii.String("secretArn"),
	TenantDomain: jsii.String("tenantDomain"),

	// the properties below are optional
	DisableLocalGroups: jsii.Boolean(false),
	ExclusionPatterns: []*string{
		jsii.String("exclusionPatterns"),
	},
	FieldMappings: []interface{}{
		&DataSourceToIndexFieldMappingProperty{
			DataSourceFieldName: jsii.String("dataSourceFieldName"),
			IndexFieldName: jsii.String("indexFieldName"),

			// the properties below are optional
			DateFieldFormat: jsii.String("dateFieldFormat"),
		},
	},
	InclusionPatterns: []*string{
		jsii.String("inclusionPatterns"),
	},
}

Properties ​

disableLocalGroupsoptionalboolean | IResolvabledisable_local_groupsoptionaltyping.Union[bool, IResolvable]disableLocalGroupsoptionalBooleanDisableLocalGroupsoptionalboolDisableLocalGroupsoptionalinterface{} #
`TRUE` to disable local groups information.
exclusionPatternsoptionalstring[]exclusion_patternsoptionaltyping.List[str]exclusionPatternsoptionalList<String>ExclusionPatternsoptionalstring[]ExclusionPatternsoptional*[]*string #
A list of regular expression patterns to exclude certain documents in your OneDrive.
notes

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.

fieldMappingsoptionalIResolvable | IResolvable | CfnDataSource.DataSourceToIndexFieldMappingProperty[]field_mappingsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataSourceToIndexFieldMappingProperty]]]fieldMappingsoptionalIResolvableFieldMappingsoptionalIResolvableFieldMappingsoptionalinterface{} #
A list of `DataSourceToIndexFieldMapping` objects that map OneDrive data source attributes or field names to Amazon Kendra index field names.
notes

To create custom fields, use the UpdateIndex 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.

inclusionPatternsoptionalstring[]inclusion_patternsoptionaltyping.List[str]inclusionPatternsoptionalList<String>InclusionPatternsoptionalstring[]InclusionPatternsoptional*[]*string #
A list of regular expression patterns to include certain documents in your OneDrive.
notes

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.

oneDriveUsersIResolvable | CfnDataSource.OneDriveUsersPropertyone_drive_userstyping.Union[IResolvable, OneDriveUsersProperty]oneDriveUsersIResolvableOneDriveUsersIResolvableOneDriveUsersinterface{} required #
A list of user accounts whose documents should be indexed.
secretArnstringsecret_arnstrsecretArnStringSecretArnstringSecretArn*string required #
The Amazon Resource Name (ARN) of an AWS 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.

tenantDomainstringtenant_domainstrtenantDomainStringTenantDomainstringTenantDomain*string required #
The Azure Active Directory domain of the organization.