Interface CfnDataSource.IDataSourceConfigurationProperty

Provides the configuration information for an Amazon Kendra data source.

Namespace: Amazon.CDK.AWS.Kendra

Assembly: Amazon.CDK.AWS.Kendra.dll

Syntax (csharp)

public interface IDataSourceConfigurationProperty

Syntax (vb)

Public Interface IDataSourceConfigurationProperty

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// 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 dataSourceConfigurationProperty = new DataSourceConfigurationProperty {
    ConfluenceConfiguration = new ConfluenceConfigurationProperty {
        SecretArn = "secretArn",
        ServerUrl = "serverUrl",
        Version = "version",

        // the properties below are optional
        AttachmentConfiguration = new ConfluenceAttachmentConfigurationProperty {
            AttachmentFieldMappings = new [] { new ConfluenceAttachmentToIndexFieldMappingProperty {
                DataSourceFieldName = "dataSourceFieldName",
                IndexFieldName = "indexFieldName",

                // the properties below are optional
                DateFieldFormat = "dateFieldFormat"
            } },
            CrawlAttachments = false
        },
        BlogConfiguration = new ConfluenceBlogConfigurationProperty {
            BlogFieldMappings = new [] { new ConfluenceBlogToIndexFieldMappingProperty {
                DataSourceFieldName = "dataSourceFieldName",
                IndexFieldName = "indexFieldName",

                // the properties below are optional
                DateFieldFormat = "dateFieldFormat"
            } }
        },
        ExclusionPatterns = new [] { "exclusionPatterns" },
        InclusionPatterns = new [] { "inclusionPatterns" },
        PageConfiguration = new ConfluencePageConfigurationProperty {
            PageFieldMappings = new [] { new ConfluencePageToIndexFieldMappingProperty {
                DataSourceFieldName = "dataSourceFieldName",
                IndexFieldName = "indexFieldName",

                // the properties below are optional
                DateFieldFormat = "dateFieldFormat"
            } }
        },
        SpaceConfiguration = new ConfluenceSpaceConfigurationProperty {
            CrawlArchivedSpaces = false,
            CrawlPersonalSpaces = false,
            ExcludeSpaces = new [] { "excludeSpaces" },
            IncludeSpaces = new [] { "includeSpaces" },
            SpaceFieldMappings = new [] { new ConfluenceSpaceToIndexFieldMappingProperty {
                DataSourceFieldName = "dataSourceFieldName",
                IndexFieldName = "indexFieldName",

                // the properties below are optional
                DateFieldFormat = "dateFieldFormat"
            } }
        },
        VpcConfiguration = new DataSourceVpcConfigurationProperty {
            SecurityGroupIds = new [] { "securityGroupIds" },
            SubnetIds = new [] { "subnetIds" }
        }
    },
    DatabaseConfiguration = new DatabaseConfigurationProperty {
        ColumnConfiguration = new ColumnConfigurationProperty {
            ChangeDetectingColumns = new [] { "changeDetectingColumns" },
            DocumentDataColumnName = "documentDataColumnName",
            DocumentIdColumnName = "documentIdColumnName",

            // the properties below are optional
            DocumentTitleColumnName = "documentTitleColumnName",
            FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                DataSourceFieldName = "dataSourceFieldName",
                IndexFieldName = "indexFieldName",

                // the properties below are optional
                DateFieldFormat = "dateFieldFormat"
            } }
        },
        ConnectionConfiguration = new ConnectionConfigurationProperty {
            DatabaseHost = "databaseHost",
            DatabaseName = "databaseName",
            DatabasePort = 123,
            SecretArn = "secretArn",
            TableName = "tableName"
        },
        DatabaseEngineType = "databaseEngineType",

        // the properties below are optional
        AclConfiguration = new AclConfigurationProperty {
            AllowedGroupsColumnName = "allowedGroupsColumnName"
        },
        SqlConfiguration = new SqlConfigurationProperty {
            QueryIdentifiersEnclosingOption = "queryIdentifiersEnclosingOption"
        },
        VpcConfiguration = new DataSourceVpcConfigurationProperty {
            SecurityGroupIds = new [] { "securityGroupIds" },
            SubnetIds = new [] { "subnetIds" }
        }
    },
    GoogleDriveConfiguration = new GoogleDriveConfigurationProperty {
        SecretArn = "secretArn",

        // the properties below are optional
        ExcludeMimeTypes = new [] { "excludeMimeTypes" },
        ExcludeSharedDrives = new [] { "excludeSharedDrives" },
        ExcludeUserAccounts = new [] { "excludeUserAccounts" },
        ExclusionPatterns = new [] { "exclusionPatterns" },
        FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
            DataSourceFieldName = "dataSourceFieldName",
            IndexFieldName = "indexFieldName",

            // the properties below are optional
            DateFieldFormat = "dateFieldFormat"
        } },
        InclusionPatterns = new [] { "inclusionPatterns" }
    },
    OneDriveConfiguration = 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" }
    },
    S3Configuration = new S3DataSourceConfigurationProperty {
        BucketName = "bucketName",

        // the properties below are optional
        AccessControlListConfiguration = new AccessControlListConfigurationProperty {
            KeyPath = "keyPath"
        },
        DocumentsMetadataConfiguration = new DocumentsMetadataConfigurationProperty {
            S3Prefix = "s3Prefix"
        },
        ExclusionPatterns = new [] { "exclusionPatterns" },
        InclusionPatterns = new [] { "inclusionPatterns" },
        InclusionPrefixes = new [] { "inclusionPrefixes" }
    },
    SalesforceConfiguration = new SalesforceConfigurationProperty {
        SecretArn = "secretArn",
        ServerUrl = "serverUrl",

        // the properties below are optional
        ChatterFeedConfiguration = new SalesforceChatterFeedConfigurationProperty {
            DocumentDataFieldName = "documentDataFieldName",

            // the properties below are optional
            DocumentTitleFieldName = "documentTitleFieldName",
            FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                DataSourceFieldName = "dataSourceFieldName",
                IndexFieldName = "indexFieldName",

                // the properties below are optional
                DateFieldFormat = "dateFieldFormat"
            } },
            IncludeFilterTypes = new [] { "includeFilterTypes" }
        },
        CrawlAttachments = false,
        ExcludeAttachmentFilePatterns = new [] { "excludeAttachmentFilePatterns" },
        IncludeAttachmentFilePatterns = new [] { "includeAttachmentFilePatterns" },
        KnowledgeArticleConfiguration = new SalesforceKnowledgeArticleConfigurationProperty {
            IncludedStates = new [] { "includedStates" },

            // the properties below are optional
            CustomKnowledgeArticleTypeConfigurations = new [] { new SalesforceCustomKnowledgeArticleTypeConfigurationProperty {
                DocumentDataFieldName = "documentDataFieldName",
                Name = "name",

                // the properties below are optional
                DocumentTitleFieldName = "documentTitleFieldName",
                FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                    DataSourceFieldName = "dataSourceFieldName",
                    IndexFieldName = "indexFieldName",

                    // the properties below are optional
                    DateFieldFormat = "dateFieldFormat"
                } }
            } },
            StandardKnowledgeArticleTypeConfiguration = new SalesforceStandardKnowledgeArticleTypeConfigurationProperty {
                DocumentDataFieldName = "documentDataFieldName",

                // the properties below are optional
                DocumentTitleFieldName = "documentTitleFieldName",
                FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                    DataSourceFieldName = "dataSourceFieldName",
                    IndexFieldName = "indexFieldName",

                    // the properties below are optional
                    DateFieldFormat = "dateFieldFormat"
                } }
            }
        },
        StandardObjectAttachmentConfiguration = new SalesforceStandardObjectAttachmentConfigurationProperty {
            DocumentTitleFieldName = "documentTitleFieldName",
            FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                DataSourceFieldName = "dataSourceFieldName",
                IndexFieldName = "indexFieldName",

                // the properties below are optional
                DateFieldFormat = "dateFieldFormat"
            } }
        },
        StandardObjectConfigurations = new [] { new SalesforceStandardObjectConfigurationProperty {
            DocumentDataFieldName = "documentDataFieldName",
            Name = "name",

            // the properties below are optional
            DocumentTitleFieldName = "documentTitleFieldName",
            FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                DataSourceFieldName = "dataSourceFieldName",
                IndexFieldName = "indexFieldName",

                // the properties below are optional
                DateFieldFormat = "dateFieldFormat"
            } }
        } }
    },
    ServiceNowConfiguration = new ServiceNowConfigurationProperty {
        HostUrl = "hostUrl",
        SecretArn = "secretArn",
        ServiceNowBuildVersion = "serviceNowBuildVersion",

        // the properties below are optional
        AuthenticationType = "authenticationType",
        KnowledgeArticleConfiguration = new ServiceNowKnowledgeArticleConfigurationProperty {
            DocumentDataFieldName = "documentDataFieldName",

            // the properties below are optional
            CrawlAttachments = false,
            DocumentTitleFieldName = "documentTitleFieldName",
            ExcludeAttachmentFilePatterns = new [] { "excludeAttachmentFilePatterns" },
            FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                DataSourceFieldName = "dataSourceFieldName",
                IndexFieldName = "indexFieldName",

                // the properties below are optional
                DateFieldFormat = "dateFieldFormat"
            } },
            FilterQuery = "filterQuery",
            IncludeAttachmentFilePatterns = new [] { "includeAttachmentFilePatterns" }
        },
        ServiceCatalogConfiguration = new ServiceNowServiceCatalogConfigurationProperty {
            DocumentDataFieldName = "documentDataFieldName",

            // the properties below are optional
            CrawlAttachments = false,
            DocumentTitleFieldName = "documentTitleFieldName",
            ExcludeAttachmentFilePatterns = new [] { "excludeAttachmentFilePatterns" },
            FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                DataSourceFieldName = "dataSourceFieldName",
                IndexFieldName = "indexFieldName",

                // the properties below are optional
                DateFieldFormat = "dateFieldFormat"
            } },
            IncludeAttachmentFilePatterns = new [] { "includeAttachmentFilePatterns" }
        }
    },
    SharePointConfiguration = new SharePointConfigurationProperty {
        SecretArn = "secretArn",
        SharePointVersion = "sharePointVersion",
        Urls = new [] { "urls" },

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

            // the properties below are optional
            DateFieldFormat = "dateFieldFormat"
        } },
        InclusionPatterns = new [] { "inclusionPatterns" },
        SslCertificateS3Path = new S3PathProperty {
            Bucket = "bucket",
            Key = "key"
        },
        UseChangeLog = false,
        VpcConfiguration = new DataSourceVpcConfigurationProperty {
            SecurityGroupIds = new [] { "securityGroupIds" },
            SubnetIds = new [] { "subnetIds" }
        }
    },
    WebCrawlerConfiguration = new WebCrawlerConfigurationProperty {
        Urls = new WebCrawlerUrlsProperty {
            SeedUrlConfiguration = new WebCrawlerSeedUrlConfigurationProperty {
                SeedUrls = new [] { "seedUrls" },

                // the properties below are optional
                WebCrawlerMode = "webCrawlerMode"
            },
            SiteMapsConfiguration = new WebCrawlerSiteMapsConfigurationProperty {
                SiteMaps = new [] { "siteMaps" }
            }
        },

        // the properties below are optional
        AuthenticationConfiguration = new WebCrawlerAuthenticationConfigurationProperty {
            BasicAuthentication = new [] { new WebCrawlerBasicAuthenticationProperty {
                Credentials = "credentials",
                Host = "host",
                Port = 123
            } }
        },
        CrawlDepth = 123,
        MaxContentSizePerPageInMegaBytes = 123,
        MaxLinksPerPage = 123,
        MaxUrlsPerMinuteCrawlRate = 123,
        ProxyConfiguration = new ProxyConfigurationProperty {
            Host = "host",
            Port = 123,

            // the properties below are optional
            Credentials = "credentials"
        },
        UrlExclusionPatterns = new [] { "urlExclusionPatterns" },
        UrlInclusionPatterns = new [] { "urlInclusionPatterns" }
    },
    WorkDocsConfiguration = new WorkDocsConfigurationProperty {
        OrganizationId = "organizationId",

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

            // the properties below are optional
            DateFieldFormat = "dateFieldFormat"
        } },
        InclusionPatterns = new [] { "inclusionPatterns" },
        UseChangeLog = false
    }
};

Synopsis

Properties

ConfluenceConfiguration	Provides the configuration information to connect to Confluence as your data source.
DatabaseConfiguration	Provides the configuration information to connect to a database as your data source.
GoogleDriveConfiguration	Provides the configuration information to connect to Google Drive as your data source.
OneDriveConfiguration	Provides the configuration information to connect to Microsoft OneDrive as your data source.
S3Configuration	Provides the configuration information to connect to an Amazon S3 bucket as your data source.
SalesforceConfiguration	Provides the configuration information to connect to Salesforce as your data source.
ServiceNowConfiguration	Provides the configuration information to connect to ServiceNow as your data source.
SharePointConfiguration	Provides the configuration information to connect to Microsoft SharePoint as your data source.
WebCrawlerConfiguration	Provides the configuration information required for Amazon Kendra Web Crawler.
WorkDocsConfiguration	Provides the configuration information to connect to Amazon WorkDocs as your data source.

Properties

ConfluenceConfiguration

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

virtual object ConfluenceConfiguration { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-confluenceconfiguration

DatabaseConfiguration

Provides the configuration information to connect to a database as your data source.

virtual object DatabaseConfiguration { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-databaseconfiguration

GoogleDriveConfiguration

Provides the configuration information to connect to Google Drive as your data source.

virtual object GoogleDriveConfiguration { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-googledriveconfiguration

OneDriveConfiguration

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

virtual object OneDriveConfiguration { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-onedriveconfiguration

S3Configuration

Provides the configuration information to connect to an Amazon S3 bucket as your data source.

virtual object S3Configuration { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-s3configuration

SalesforceConfiguration

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

virtual object SalesforceConfiguration { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-salesforceconfiguration

ServiceNowConfiguration

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

virtual object ServiceNowConfiguration { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-servicenowconfiguration

SharePointConfiguration

Provides the configuration information to connect to Microsoft SharePoint as your data source.

virtual object SharePointConfiguration { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-sharepointconfiguration

WebCrawlerConfiguration

Provides the configuration information required for Amazon Kendra Web Crawler.

virtual object WebCrawlerConfiguration { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-webcrawlerconfiguration

WorkDocsConfiguration

Provides the configuration information to connect to Amazon WorkDocs as your data source.

virtual object WorkDocsConfiguration { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-workdocsconfiguration