데이터 소스 템플릿 스키마 - Amazon Kendra

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

데이터 소스 템플릿 스키마

다음은 템플릿이 지원되는 데이터 소스의 템플릿 스키마입니다.

Adobe Experience Manager 템플릿 스키마

데이터 소스 스키마를 TemplateConfiguration 객체의 일부로 포함하는 JSON을 포함합니다. Adobe Experience Manager 호스트 URL, 인증 유형, 그리고 연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 클라우드 서비스형 Adobe Experience Manager(AEM) 또는 AEM 온프레미스 중에서 무엇을 사용할지 여부를 제공합니다. 또한 데이터 소스 유형으로 AEM, 보안 인증 정보의 암호 및 기타 필수 구성을 지정합니다. 그런 다음 CreateDataSource를 호출할 때 TEMPLATEType으로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. 자세한 정보는 Adobe Experience Manager JSON 스키마을 참조하세요.

다음 표는 AEM JSON 스키마의 매개변수를 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보.
aemUrl Adobe Experience Manager 호스트 URL. 예를 들어 AEM 온프레미스를 사용하는 경우 호스트 이름과 포트를 포함해야 합니다. https://hostname:port 클라우드 서비스형 AEM을 사용하는 경우 작성자 URL을 사용할 수 있습니다. https://author-xxxxxx-xxxxxxx.adobeaemcloud.com
authType 사용하는 인증 유형(Basic 또는 OAuth2).
deploymentType 사용하는 Adobe Experience Manager 유형(CLOUD 또는 ON_PREMISE).
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
  • 페이지를 방문하십시오

  • asset

Adobe Experience Manager페이지 및 자산의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 개체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
timeZoneId

AEM On-Premise를 사용하고 서버의 시간대가 Amazon Kendra AEM 커넥터 또는 인덱스의 시간대와 다른 경우 AEM 커넥터 또는 색인에 맞춰 서버 시간대를 지정할 수 있습니다.

AEM 온-프레미스의 기본 시간대는 AEM 커넥터 또는 인덱스의 시간대입니다. Amazon Kendra 클라우드 서비스형 AEM의 기본 시간대는 그리니치 표준시입니다.

  • pageRootPaths

  • assetRootPaths

페이지 및 자산의 루트 경로 목록. 예를 들어 페이지의 루트 경로는 /content/sub일 수 있고 자산의 루트 경로는 /content/sub/asset1일 수 있습니다.
crawlAssets 자산을 크롤링할 true.
crawlPages 페이지를 크롤링할 true.
  • pagePathInclusion패턴

  • pageNameInclusion패턴

  • assetPathInclusion패턴

  • assetTypeInclusion패턴

  • assetNameInclusion패턴

Adobe Experience Manager 데이터 소스에서 특정 페이지 및 자산을 포함하는 정규식 패턴 목록. 패턴과 일치하는 항목은 인덱스에 포함됩니다. 패턴과 일치하지 않는 항목은 인덱스에서 제외됩니다. 페이지 또는 자산이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 콘텐츠는 인덱스에 포함되지 않습니다.
  • pagePathExclusion패턴

  • pageNameExclusion패턴

  • assetPathExclusion패턴

  • assetTypeInclusion패턴

  • assetNameInclusion패턴

Adobe Experience Manager 데이터 소스에서 특정 페이지 및 자산을 제외하는 정규식 패턴 목록. 패턴과 일치하는 항목은 인덱스에서 제외됩니다. 패턴과 일치하지 않는 항목은 인덱스에 포함됩니다. 페이지 또는 자산이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 콘텐츠는 인덱스에 포함되지 않습니다.
pageComponents 인덱싱하려는 특정 페이지 구성 요소의 목록.
contentFragmentVariations 인덱싱하려는 Adobe Experience Manager 내용 조각의 저장된 특정 변형의 이름 목록.
type 데이터 소스의 유형. AEM을 데이터 소스 유형으로 지정합니다.
enableIdentityCrawler true Amazon Kendra의 ID 크롤러를 사용하여 사용자 및 그룹의 ID/주체 정보를 특정 문서에 대한 액세스 권한과 동기화합니다. ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 PutPrincipalMappingAPI를 사용하여 사용자 및 그룹 액세스 정보를 업로드할 수도 있습니다.
syncMode

데이터 소스 콘텐츠가 Amazon Kendra 변경될 때 색인을 업데이트하는 방법을 지정하십시오. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretArn Adobe Experience Manager에 연결하는 데 필요한 키-값 쌍이 포함된 AWS Secrets Manager 암호의 Amazon 리소스 이름 (ARN). 이러한 키-값 쌍에 대한 자세한 내용은 Adobe Experience Manager의 연결 지침을 참조하십시오.
version 현재 지원되는 이 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "aemUrl": { "type": "string", "pattern": "https:.*" }, "authType": { "type": "string", "enum": ["Basic", "OAuth2"] }, "deploymentType": { "type": "string", "enum": ["CLOUD","ON_PREMISE"] } }, "required": [ "aemUrl", "authType", "deploymentType" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "page": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "asset": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "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": { "timeZoneId": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT0", "Greenwich", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROK", "Singapore", "SystemV/AST4", "SystemV/AST4ADT", "SystemV/CST6", "SystemV/CST6CDT", "SystemV/EST5", "SystemV/EST5EDT", "SystemV/HST10", "SystemV/MST7", "SystemV/MST7MDT", "SystemV/PST8", "SystemV/PST8PDT", "SystemV/YST9", "SystemV/YST9YDT", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu", "EST", "HST", "MST", "ACT", "AET", "AGT", "ART", "AST", "BET", "BST", "CAT", "CNT", "CST", "CTT", "EAT", "ECT", "IET", "IST", "JST", "MIT", "NET", "NST", "PLT", "PNT", "PRT", "PST", "SST", "VST" ] }, "pageRootPaths": { "type": "array", "items": { "type": "string" } }, "assetRootPaths": { "type": "array", "items": { "type": "string" } }, "crawlAssets": { "type": "boolean" }, "crawlPages": { "type": "boolean" }, "pagePathInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pagePathExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pageNameInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pageNameExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetPathInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetPathExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetTypeInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetTypeExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetNameInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetNameExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pageComponents": { "type": "array", "items": { "type": "object" } }, "contentFragmentVariations": { "type": "array", "items": { "type": "object" } }, "cugExemptedPrincipals": { "type": "array", "items": { "type": "string" } } }, "required": [] }, "type": { "type": "string", "pattern": "AEM" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

Amazon FSx (Windows) 템플릿 스키마

데이터 소스 스키마를 TemplateConfiguration 객체의 일부로 포함하는 JSON을 포함합니다. 연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 파일 시스템 ID를 제공합니다. 또한 데이터 원본의 유형FSX, 인증 자격 증명의 암호 및 기타 필요한 구성을 지정해야 합니다. 그런 다음 CreateDataSource를 호출할 때 TEMPLATEType으로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Amazon FSx (윈도우) JSON 스키마를 참조하세요.

다음 표에서는 Amazon FSx (Windows) JSON 스키마의 매개 변수에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보.
fileSystemId Amazon FSx 파일 시스템의 식별자입니다. 파일 시스템 ID는 Amazon FSx 콘솔의 파일 시스템 대시보드에서 찾을 수 있습니다.
fileSystemType Amazon FSx 파일 시스템 유형. 파일 시스템 Windows File Server 유형으로 사용하려면 지정하십시오WINDOWS.
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
모두 Amazon FSx 데이터 원본에 있는 파일의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 개체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
isCrawlAcl trueACL이 있고 액세스 제어에 사용하려는 경우 문서에 대한 액세스 제어 목록 (ACL) 정보를 크롤링하려면 ACL은 사용자와 그룹이 액세스할 수 있는 문서를 지정합니다. ACL 정보는 검색 결과를 문서에 대한 사용자 또는 그룹의 액세스 권한을 기준으로 필터링하는 데 사용됩니다. 자세한 내용은 사용자 컨텍스트 필터링을 참조하세요.
inclusionPatterns Amazon FSx 데이터 원본에 특정 파일을 포함하기 위한 정규 표현식 패턴 목록입니다. 패턴과 일치하는 파일은 인덱스에 포함됩니다. 패턴과 일치하지 않는 파일은 인덱스에서 제외됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
exclusionPatterns Amazon FSx 데이터 원본에서 특정 파일을 제외하기 위한 정규 표현식 패턴 목록입니다. 패턴과 일치하는 파일은 인덱스에서 제외됩니다. 패턴과 일치하지 않는 파일은 인덱스에 포함됩니다. 파일이 제외 및 포함 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
enableIdentityCrawler true Amazon Kendra의 ID 크롤러를 사용하여 사용자 및 그룹의 ID/주체 정보를 특정 문서에 대한 액세스 권한과 동기화하는 데 사용됩니다. ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 PutPrincipalMappingAPI를 사용하여 사용자 및 그룹 액세스 정보를 업로드할 수도 있습니다.
syncMode

데이터 소스 콘텐츠가 Amazon Kendra 변경될 때 색인을 업데이트하는 방법을 지정하십시오. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

type 데이터 소스의 유형. Windows 파일 시스템 데이터 원본의 경우 지정하십시오FSX.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "fileSystemId": { "type": "string", "pattern": "fs-.*" }, "fileSystemType": { "type": "string", "pattern": "WINDOWS" } }, "required": ["fileSystemId", "fileSystemType"] } } }, "repositoryConfigurations": { "type": "object", "properties": { "All": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] } }, "required": ["All"] }, "additionalProperties": { "type": "object", "properties": { "isCrawlAcl": { "type": "boolean" }, "exclusionPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionPatterns": { "type": "array", "items": { "type": "string" } } }, "required": [] }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "type" : { "type" : "string", "pattern": "FSX" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "enableIdentityCrawler", "additionalProperties", "type" ] }

Amazon FSx (NetApp ONTAP) 템플릿 스키마

데이터 소스 스키마를 TemplateConfiguration 객체의 일부로 포함하는 JSON을 포함합니다. 연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 파일 시스템 ID와 SVM (스토리지 가상 머신) 을 제공합니다. 또한 데이터 소스의 유형FSXONTAP, 인증 자격 증명의 암호 및 기타 필요한 구성을 지정해야 합니다. 그런 다음 CreateDataSource를 호출할 때 TEMPLATEType으로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Amazon FSx (NetApp ONTAP) JSON 스키마를 참조하세요.

다음 표는 Amazon FSx (NetApp ONTAP) JSON 스키마의 매개 변수를 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보.
fileSystemId Amazon FSx 파일 시스템의 식별자입니다. 파일 시스템 ID는 Amazon FSx 콘솔의 파일 시스템 대시보드에서 찾을 수 있습니다. Amazon FSx 콘솔에서 NetApp ONTAP용 파일 시스템을 생성하는 방법에 대한 자세한 내용은 FSx for ONTAP 사용 설명서의 NetAppONTAP 시작 안내서를 참조하십시오.
fileSystemType Amazon FSx 파일 시스템 유형. 파일 시스템 NetApp ONTAP 유형으로 사용하려면 지정하십시오ONTAP.
SVMid Amazon FSx 파일 시스템에서 사용되는 스토리지 가상 머신 (SVM) 의 식별자입니다. NetApp ONTAP Amazon FSx 콘솔의 파일 시스템 대시보드로 이동하여 파일 시스템 ID를 선택한 다음 스토리지 가상 시스템을 선택하면 SVM ID를 찾을 수 있습니다. Amazon FSx 콘솔에서 파일 시스템을 생성하는 방법에 대한 자세한 내용은 사용 FSx for ONTAP 설명서의 NetApp ONTAP 시작 안내서를 참조하십시오. NetApp ONTAP
프로토콜 유형 Windows용 CIFS (공용 인터넷 파일 시스템) 프로토콜을 사용하는지, Linux용 네트워크 파일 시스템 (NFS) 프로토콜을 사용하는지 여부.
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
파일 Amazon FSx 데이터 원본에 있는 파일의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 개체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요. 데이터 원본 필드 이름은 파일의 사용자 지정 메타데이터에 있어야 합니다.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
crawlAcl trueACL이 있고 액세스 제어에 사용하려는 경우 문서에 대한 액세스 제어 목록 (ACL) 정보를 크롤링합니다. ACL은 사용자와 그룹이 액세스할 수 있는 문서를 지정합니다. ACL 정보는 검색 결과를 문서에 대한 사용자 또는 그룹의 액세스 권한을 기준으로 필터링하는 데 사용됩니다. 자세한 내용은 사용자 컨텍스트 필터링을 참조하세요.
inclusionPatterns Amazon FSx 데이터 원본에 특정 파일을 포함하기 위한 정규 표현식 패턴 목록입니다. 패턴과 일치하는 파일은 인덱스에 포함됩니다. 패턴과 일치하지 않는 파일은 인덱스에서 제외됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
exclusionPatterns Amazon FSx 데이터 원본에서 특정 파일을 제외하기 위한 정규 표현식 패턴 목록입니다. 패턴과 일치하는 파일은 인덱스에서 제외됩니다. 패턴과 일치하지 않는 파일은 인덱스에 포함됩니다. 파일이 제외 및 포함 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
type 데이터 소스의 유형. NetApp ONTAP파일 시스템 데이터 원본의 경우 지정하십시오FSXONTAP.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정합니다. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretArn

파일 시스템에 연결하는 데 필요한 키-값 쌍이 포함된 AWS Secrets Manager 암호의 Amazon 리소스 이름 (ARN). Amazon FSx 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.

{ "username": "user@corp.example.com", "password": "password" }

Amazon FSx 파일 시스템에 NFS 프로토콜을 사용하는 경우 암호는 다음 키와 함께 JSON 구조에 저장됩니다.

{ "leftId": "left ID", "rightId": "right ID", "preSharedKey": "pre-shared key" }
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "fileSystemId": { "type": "string", "pattern": "^(fs-[0-9a-f]{8,21})$" }, "fileSystemType": { "type": "string", "enum": ["ONTAP"] }, "svmId": { "type": "string", "pattern": "^(svm-[0-9a-f]{17,21})$" }, "protocolType": { "type": "string", "enum": [ "CIFS", "NFS" ] } }, "required": [ "fileSystemId", "fileSystemType" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "file": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string", "pattern": "^([a-zA-Z_]{1,20})$" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string", "pattern": "^([a-zA-Z_]{1,20})$" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ], "maxItems": 50 } }, "required": [ "fieldMappings" ] } }, "required": [ "file" ] }, "additionalProperties": { "type": "object", "properties": { "crawlAcl": { "type": "boolean" }, "inclusionPatterns": { "type": "array", "items": { "type": "string", "maxLength": 30 }, "maxItems": 100 }, "exclusionPatterns": { "type": "array", "items": { "type": "string", "maxLength": 30 }, "maxItems": 100 } } }, "type": { "type": "string", "pattern": "FSXONTAP" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "secretArn": { "type": "string", "pattern": "arn:aws:secretsmanager:.*" } }, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "secretArn", "type" ] }

Alfresco 템플릿 스키마

데이터 소스 스키마를 TemplateConfiguration 객체의 일부로 포함하는 JSON을 포함합니다. Alfresco 사이트 ID, 리포지토리 URL, 사용자 인터페이스 URL, 인증 유형, 클라우드 또는 온프레미스 사용 여부, 크롤링하려는 콘텐츠 유형을 제공합니다. 이 정보는 연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 제공합니다. 또한 데이터 소스 유형으로 ALFRESCO, 보안 인증 정보의 암호 및 기타 필수 구성을 지정합니다. 그런 다음 CreateDataSource를 호출할 때 TEMPLATEType으로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Alfresco JSON 스키마를 참조하세요.

다음 표에는 Alfresco JSON 스키마의 매개 변수가 설명되어 있습니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보.
siteId Alfresco 사이트의 식별자.
repoUrl Alfresco 리포지토리의 URL. 리포지토리 URL은 Alfresco 관리자로부터 받을 수 있습니다. 예를 들어 Alfresco Cloud(PaaS)를 사용하는 경우 리포지토리 URL은 https://company.alfrescocloud.com과 같을 수 있습니다. 또는 Alfresco 온프레미스를 사용하는 경우 리포지토리 URL은 https://company-alfresco-instance.company-domain.suffix:port와 같을 수 있습니다.
webAppUrl Alfresco 사용자 인터페이스의 URL. Alfresco 사용자 인터페이스 URL은 Alfresco 관리자로부터 받을 수 있습니다. 예를 들어 사용자 인터페이스 URL은 https://example.com과 같을 수 있습니다.
repositoryAdditionalProperties 리포지토리/데이터 소스 엔드포인트와 연결하기 위한 추가 속성.
authType 사용하는 인증 유형(OAuth2 또는 Basic).
type (deployment) 사용하는 Alfresco 유형(PAAS 또는 ON-PREM).
crawlType 크롤링하려는 콘텐츠의 유형, 즉 ASPECT(Alfresco에서 'Aspect'로 표시된 콘텐츠), SITE_ID(특정 Alfresco 사이트 내 콘텐츠) 또는 ALL_SITES(모든 Alfresco 사이트의 콘텐츠).
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
  • 문서

  • 설명

Alfresco 문서 및 주석의 속성 또는 필드 이름을 인덱스 필드 이름에 매핑하는 객체 목록입니다. Amazon Kendra 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
aspectName

인덱싱하려는 특정 'Aspect'의 이름.

aspectProperties

인덱싱하려는 특정 'Aspect' 콘텐츠 속성의 목록.

enableFineGrained제어

'Aspects'를 크롤링할 true.

isCrawlComment

true댓글을 크롤링하려면.

  • inclusionFileName패턴

  • inclusionFileType패턴

  • inclusionFilePath패턴

Alfresco 데이터 소스에서 특정 파일을 포함하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에 포함됩니다. 패턴과 일치하지 않는 파일은 인덱스에서 제외됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
  • exclusionFileName패턴

  • exclusionFileType패턴

  • exclusionFilePath패턴

Alfresco 데이터 소스에서 특정 파일을 제외하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에서 제외됩니다. 패턴과 일치하지 않는 파일은 인덱스에 포함됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
type 데이터 소스의 유형. ALFRESCO을 데이터 소스 유형으로 지정합니다.
secretArn

연결에 필요한 키-값 쌍이 포함된 AWS Secrets Manager 비밀의 Amazon 리소스 이름 (ARN). Alfresco 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.

기본 인증을 사용하는 경우:

{ "username": "user name", "password": "password" }

OAuth 2.0 인증을 사용하는 경우

{ "clientId": "client ID", "clientSecret": "client secret", "tokenUrl": "token URL" }
syncMode

데이터 소스 콘텐츠가 Amazon Kendra 변경될 때 색인을 업데이트하는 방법을 지정하십시오. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

enableIdentityCrawler true Amazon Kendra의 ID 크롤러를 사용하여 특정 문서에 대한 액세스 권한이 있는 사용자 및 그룹의 ID/주체 정보를 동기화하는 데 사용합니다. ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 PutPrincipalMappingAPI를 사용하여 사용자 및 그룹 액세스 정보를 업로드할 수도 있습니다.
version 현재 지원되는 이 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "siteId": { "type": "string" }, "repoUrl": { "type": "string" }, "webAppUrl": { "type": "string" }, "repositoryAdditionalProperties": { "type": "object", "properties": { "authType": { "type": "string", "enum": [ "OAuth2", "Basic" ] }, "type": { "type": "string", "enum": [ "PAAS", "ON_PREM" ] }, "crawlType": { "type": "string", "enum": [ "ASPECT", "SITE_ID", "ALL_SITES" ] } } } } } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "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": { "anyOf": [ { "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" ] } } }, "additionalProperties": { "type": "object", "properties": { "aspectName": { "type": "string" }, "aspectProperties": { "type": "array" }, "enableFineGrainedControl": { "type": "boolean" }, "isCrawlComment": { "type": "boolean" }, "inclusionFileNamePatterns": { "type": "array" }, "exclusionFileNamePatterns": { "type": "array" }, "inclusionFileTypePatterns": { "type": "array" }, "exclusionFileTypePatterns": { "type": "array" }, "inclusionFilePathPatterns": { "type": "array" }, "exclusionFilePathPatterns": { "type": "array" } } }, "type": { "type": "string", "pattern": "ALFRESCO" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "enableIdentityCrawler": { "type": "boolean" }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] } }, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "type", "secretArn" ] }

Aurora (MySQL) 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 TemplateConfiguration객체의 일부로 포함합니다. 데이터 소스로 JDBC, 데이터 소스 유형으로 mysql, 보안 인증 정보의 암호, 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Aurora (MySQL) JSON 스키마를 참조하세요.

다음 표는 Aurora (MySQL) JSON 스키마의 매개 변수를 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스 연결을 위한 필수 구성 정보.
  • DBType - 사용하는 Java 데이터베이스의 유형 (,,mysql, db2 또는) postgresql oracle sqlserver

  • dbHost - 데이터베이스 호스트 이름.

  • dbPort - 데이터베이스 포트.

  • dbInstance - 데이터베이스 인스턴스.

repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다. 데이터 소스 유형과 비밀 ARN을 지정합니다.

문서

데이터베이스 콘텐츠의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 객체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션. 데이터베이스 데이터 소스에 특정 콘텐츠를 포함하거나 제외하는 데 사용합니다.
primaryKeys 데이터베이스 테이블의 기본 키를 입력합니다. 이는 데이터베이스 내의 테이블을 식별합니다.
titleColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
bodyColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
sqlQuery SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
timestampColumn 타임스탬프가 포함된 열의 이름을 입력합니다. Amazon Kendra 타임스탬프 정보를 사용하여 콘텐츠의 변경 사항을 감지하고 변경된 콘텐츠만 동기화합니다.
timestampFormat 콘텐츠 변경 사항을 감지하고 콘텐츠를 다시 동기화하는 데 사용할 타임스탬프 형식이 포함된 열의 이름을 입력합니다.
timezone 콘텐츠를 크롤링할 시간대가 포함된 열의 이름을 입력합니다.
changeDetectingColumns 콘텐츠 변경을 감지하는 Amazon Kendra 데 사용할 열 이름을 입력합니다. Amazon Kendra 이러한 열에 변경 사항이 있을 경우 콘텐츠를 다시 인덱싱합니다.
allowedUsersColumns 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
allowedGroupsColumn 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
sourceURIColumn 인덱싱할 소스 URL이 포함된 열의 이름을 입력합니다.
isSslEnabled SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
type 데이터 소스의 유형. JDBC을 데이터 소스 유형으로 지정합니다.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정하세요. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretArn 데이터베이스에 연결하는 데 필요한 사용자 이름 및 암호가 포함된 Secrets Manager 보안 암호의 Amazon 리소스 이름(ARN)입니다. 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "user name": "database user name", "password": "password" }
version 현재 지원되는 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

Aurora (PostgreSQL) 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 객체의 일부로 포함합니다. TemplateConfiguration 데이터 소스로 JDBC, 데이터 소스 유형으로 postgresql, 보안 인증 정보의 암호, 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Aurora (PostgreSQL) JSON 스키마를 참조하세요.

다음 표에서는 Aurora (PostgreSQL) JSON 스키마의 매개 변수에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스 연결을 위한 필수 구성 정보.
  • DbType - 사용하는 자바 데이터베이스 유형 (,,, 또는) mysql db2 postgresql oracle sqlserver

  • dbHost - 데이터베이스 호스트 이름.

  • dbPort - 데이터베이스 포트.

  • dbInstance - 데이터베이스 인스턴스.

repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다. 데이터 소스 유형과 비밀 ARN을 지정합니다.

문서

데이터베이스 콘텐츠의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 객체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션. 데이터베이스 데이터 소스에 특정 콘텐츠를 포함하거나 제외하는 데 사용합니다.
primaryKeys 데이터베이스 테이블의 기본 키를 입력합니다. 이는 데이터베이스 내의 테이블을 식별합니다.
titleColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
bodyColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
sqlQuery SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
timestampColumn 타임스탬프가 포함된 열의 이름을 입력합니다. Amazon Kendra 타임스탬프 정보를 사용하여 콘텐츠의 변경 사항을 감지하고 변경된 콘텐츠만 동기화합니다.
timestampFormat 콘텐츠 변경 사항을 감지하고 콘텐츠를 다시 동기화하는 데 사용할 타임스탬프 형식이 포함된 열의 이름을 입력합니다.
timezone 콘텐츠를 크롤링할 시간대가 포함된 열의 이름을 입력합니다.
changeDetectingColumns 콘텐츠 변경을 감지하는 Amazon Kendra 데 사용할 열 이름을 입력합니다. Amazon Kendra 이러한 열에 변경 사항이 있을 경우 콘텐츠를 다시 인덱싱합니다.
allowedUsersColumns 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
allowedGroupsColumn 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
sourceURIColumn 인덱싱할 소스 URL이 포함된 열의 이름을 입력합니다.
isSslEnabled SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
type 데이터 소스의 유형. JDBC을 데이터 소스 유형으로 지정합니다.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정하세요. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretArn 데이터베이스에 연결하는 데 필요한 사용자 이름 및 암호가 포함된 Secrets Manager 보안 암호의 Amazon 리소스 이름(ARN)입니다. 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "user name": "database user name", "password": "password" }
version 현재 지원되는 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

Amazon RDS (Microsoft SQL Server) 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 TemplateConfiguration개체의 일부로 포함합니다. 데이터 소스로 JDBC, 데이터 소스 유형으로 sqlserver, 보안 인증 정보의 암호, 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Amazon RDS (마이크로소프트 SQL 서버) JSON 스키마를 참조하세요.

다음 표에서는 Amazon RDS (Microsoft SQL Server) JSON 스키마의 매개 변수에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스 연결을 위한 필수 구성 정보.
  • DBType - 사용하는 Java 데이터베이스의 유형 (,, mysqldb2, postgresql 또는) oracle sqlserver

  • dbHost - 데이터베이스 호스트 이름.

  • dbPort - 데이터베이스 포트.

  • dbInstance - 데이터베이스 인스턴스.

repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다. 데이터 소스 유형과 비밀 ARN을 지정합니다.

문서

데이터베이스 콘텐츠의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 객체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션. 데이터베이스 데이터 소스에 특정 콘텐츠를 포함하거나 제외하는 데 사용합니다.
primaryKeys 데이터베이스 테이블의 기본 키를 입력합니다. 이는 데이터베이스 내의 테이블을 식별합니다.
titleColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
bodyColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
sqlQuery SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
timestampColumn 타임스탬프가 포함된 열의 이름을 입력합니다. Amazon Kendra 타임스탬프 정보를 사용하여 콘텐츠의 변경 사항을 감지하고 변경된 콘텐츠만 동기화합니다.
timestampFormat 콘텐츠 변경 사항을 감지하고 콘텐츠를 다시 동기화하는 데 사용할 타임스탬프 형식이 포함된 열의 이름을 입력합니다.
timezone 콘텐츠를 크롤링할 시간대가 포함된 열의 이름을 입력합니다.
changeDetectingColumns 콘텐츠 변경을 감지하는 Amazon Kendra 데 사용할 열 이름을 입력합니다. Amazon Kendra 이러한 열에 변경 사항이 있을 경우 콘텐츠를 다시 인덱싱합니다.
allowedUsersColumns 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
allowedGroupsColumn 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
sourceURIColumn 인덱싱할 소스 URL이 포함된 열의 이름을 입력합니다.
isSslEnabled SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
type 데이터 소스의 유형. JDBC을 데이터 소스 유형으로 지정합니다.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정하세요. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretArn 데이터베이스에 연결하는 데 필요한 사용자 이름 및 암호가 포함된 Secrets Manager 보안 암호의 Amazon 리소스 이름(ARN)입니다. 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "user name": "database user name", "password": "password" }
version 현재 지원되는 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

Amazon RDS (MySQL) 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 TemplateConfiguration객체의 일부로 포함합니다. 데이터 소스로 JDBC, 데이터 소스 유형으로 mysql, 보안 인증 정보의 암호, 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Amazon RDS (MySQL) JSON 스키마를 참조하세요.

다음 표는 Amazon RDS (MySQL) JSON 스키마의 매개 변수를 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스 연결을 위한 필수 구성 정보.
  • DBType - 사용하는 Java 데이터베이스의 유형 (,,mysql, db2 또는) postgresql oracle sqlserver

  • dbHost - 데이터베이스 호스트 이름.

  • dbPort - 데이터베이스 포트.

  • dbInstance - 데이터베이스 인스턴스.

repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다. 데이터 소스 유형과 비밀 ARN을 지정합니다.

문서

데이터베이스 콘텐츠의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 객체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션. 데이터베이스 데이터 소스에 특정 콘텐츠를 포함하거나 제외하는 데 사용합니다.
primaryKeys 데이터베이스 테이블의 기본 키를 입력합니다. 이는 데이터베이스 내의 테이블을 식별합니다.
titleColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
bodyColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
sqlQuery SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
timestampColumn 타임스탬프가 포함된 열의 이름을 입력합니다. Amazon Kendra 타임스탬프 정보를 사용하여 콘텐츠의 변경 사항을 감지하고 변경된 콘텐츠만 동기화합니다.
timestampFormat 콘텐츠 변경 사항을 감지하고 콘텐츠를 다시 동기화하는 데 사용할 타임스탬프 형식이 포함된 열의 이름을 입력합니다.
timezone 콘텐츠를 크롤링할 시간대가 포함된 열의 이름을 입력합니다.
changeDetectingColumns 콘텐츠 변경을 감지하는 Amazon Kendra 데 사용할 열 이름을 입력합니다. Amazon Kendra 이러한 열에 변경 사항이 있을 경우 콘텐츠를 다시 인덱싱합니다.
allowedUsersColumns 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
allowedGroupsColumn 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
sourceURIColumn 인덱싱할 소스 URL이 포함된 열의 이름을 입력합니다.
isSslEnabled SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
type 데이터 소스의 유형. JDBC을 데이터 소스 유형으로 지정합니다.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정하세요. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretArn 데이터베이스에 연결하는 데 필요한 사용자 이름 및 암호가 포함된 Secrets Manager 보안 암호의 Amazon 리소스 이름(ARN)입니다. 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "user name": "database user name", "password": "password" }
version 현재 지원되는 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

Amazon RDS (오라클) 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 TemplateConfiguration객체의 일부로 포함합니다. 데이터 소스로 JDBC, 데이터 소스 유형으로 oracle, 보안 인증 정보의 암호, 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Amazon RDS (Oracle) JSON 스키마를 참조하세요.

다음 표에서는 Amazon RDS (Oracle) JSON 스키마의 매개 변수에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스 연결을 위한 필수 구성 정보.
  • DBType - 사용하는 Java 데이터베이스 유형 (,, mysqldb2, postgresql 또는) oracle sqlserver

  • dbHost - 데이터베이스 호스트 이름.

  • dbPort - 데이터베이스 포트.

  • dbInstance - 데이터베이스 인스턴스.

repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다. 데이터 소스 유형과 비밀 ARN을 지정합니다.

문서

데이터베이스 콘텐츠의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 객체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션. 데이터베이스 데이터 소스에 특정 콘텐츠를 포함하거나 제외하는 데 사용합니다.
primaryKeys 데이터베이스 테이블의 기본 키를 입력합니다. 이는 데이터베이스 내의 테이블을 식별합니다.
titleColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
bodyColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
sqlQuery SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
timestampColumn 타임스탬프가 포함된 열의 이름을 입력합니다. Amazon Kendra 타임스탬프 정보를 사용하여 콘텐츠의 변경 사항을 감지하고 변경된 콘텐츠만 동기화합니다.
timestampFormat 콘텐츠 변경 사항을 감지하고 콘텐츠를 다시 동기화하는 데 사용할 타임스탬프 형식이 포함된 열의 이름을 입력합니다.
timezone 콘텐츠를 크롤링할 시간대가 포함된 열의 이름을 입력합니다.
changeDetectingColumns 콘텐츠 변경을 감지하는 Amazon Kendra 데 사용할 열 이름을 입력합니다. Amazon Kendra 이러한 열에 변경 사항이 있을 경우 콘텐츠를 다시 인덱싱합니다.
allowedUsersColumns 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
allowedGroupsColumn 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
sourceURIColumn 인덱싱할 소스 URL이 포함된 열의 이름을 입력합니다.
isSslEnabled SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
type 데이터 소스의 유형. JDBC을 데이터 소스 유형으로 지정합니다.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정하세요. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretArn 데이터베이스에 연결하는 데 필요한 사용자 이름 및 암호가 포함된 Secrets Manager 보안 암호의 Amazon 리소스 이름(ARN)입니다. 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "user name": "database user name", "password": "password" }
version 현재 지원되는 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

Amazon RDS (PostgreSQL) 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 객체의 일부로 포함합니다. TemplateConfiguration 데이터 소스로 JDBC, 데이터 소스 유형으로 postgresql, 보안 인증 정보의 암호, 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Amazon RDS (PostgreSQL) JSON 스키마를 참조하세요.

다음 표에서는 Amazon RDS (PostgreSQL) JSON 스키마의 매개 변수에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스 연결을 위한 필수 구성 정보.
  • DbType - 사용하는 자바 데이터베이스 유형 (,,, 또는) mysql db2 postgresql oracle sqlserver

  • dbHost - 데이터베이스 호스트 이름.

  • dbPort - 데이터베이스 포트.

  • dbInstance - 데이터베이스 인스턴스.

repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다. 데이터 소스 유형과 비밀 ARN을 지정합니다.

문서

데이터베이스 콘텐츠의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 객체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션. 데이터베이스 데이터 소스에 특정 콘텐츠를 포함하거나 제외하는 데 사용합니다.
primaryKeys 데이터베이스 테이블의 기본 키를 입력합니다. 이는 데이터베이스 내의 테이블을 식별합니다.
titleColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
bodyColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
sqlQuery SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
timestampColumn 타임스탬프가 포함된 열의 이름을 입력합니다. Amazon Kendra 타임스탬프 정보를 사용하여 콘텐츠의 변경 사항을 감지하고 변경된 콘텐츠만 동기화합니다.
timestampFormat 콘텐츠 변경 사항을 감지하고 콘텐츠를 다시 동기화하는 데 사용할 타임스탬프 형식이 포함된 열의 이름을 입력합니다.
timezone 콘텐츠를 크롤링할 시간대가 포함된 열의 이름을 입력합니다.
changeDetectingColumns 콘텐츠 변경을 감지하는 Amazon Kendra 데 사용할 열 이름을 입력합니다. Amazon Kendra 이러한 열에 변경 사항이 있을 경우 콘텐츠를 다시 인덱싱합니다.
allowedUsersColumns 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
allowedGroupsColumn 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
sourceURIColumn 인덱싱할 소스 URL이 포함된 열의 이름을 입력합니다.
isSslEnabled SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
type 데이터 소스의 유형. JDBC을 데이터 소스 유형으로 지정합니다.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정하세요. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretArn 데이터베이스에 연결하는 데 필요한 사용자 이름 및 암호가 포함된 Secrets Manager 보안 암호의 Amazon 리소스 이름(ARN)입니다. 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "user name": "database user name", "password": "password" }
version 현재 지원되는 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

Amazon S3 템플릿 스키마

데이터 소스 스키마를 템플릿 구성의 일부로 포함하는 JSON을 포함합니다. S3 버킷의 이름을 연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 제공합니다. 또한 데이터 소스 유형으로 S3, 기타 필수 구성을 지정합니다. 그런 다음 호출 TEMPLATE Type 시점으로 지정합니다 CreateDataSource.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. S3 JSON 스키마를 참조하세요.

다음 표에서는 Amazon S3 JSON 스키마의 파라미터에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보.
BucketName Amazon S3 버킷 이름.
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
  • inclusionPatterns

  • exclusionPatterns

  • inclusionPrefixes

  • exclusionPrefixes

Amazon S3 데이터 원본에 특정 파일을 포함하거나 제외하기 위한 정규 표현식 패턴 목록입니다. 패턴과 일치하는 파일은 인덱스에 포함됩니다. 패턴과 일치하지 않는 파일은 인덱스에서 제외됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
aclConfigurationFile경로 Amazon Kendra 인덱스의 문서에 대한 액세스를 제어하는 파일 경로.
metadataFilesPrefix 버킷 내 메타데이터 파일 위치.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정합니다. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

type 데이터 소스의 유형. S3을 데이터 소스 유형으로 지정합니다.
version 지원되는 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "BucketName": { "type": "string" } }, "required": [ "BucketName" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING" ] }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ "document" ] }, "additionalProperties": { "type": "object", "properties": { "inclusionPatterns": { "type": "array" }, "exclusionPatterns": { "type": "array" }, "inclusionPrefixes": { "type": "array" }, "exclusionPrefixes": { "type": "array" }, "aclConfigurationFilePath": { "type": "string" }, "metadataFilesPrefix": { "type": "string" } } }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL" ] }, "type": { "type": "string", "pattern": "S3" }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] } }, "required": [ "connectionConfiguration", "type", "syncMode", "repositoryConfigurations" ] }

Amazon Kendra 웹 크롤러 템플릿 스키마

데이터 소스 스키마를 TemplateConfiguration 객체의 일부로 포함하는 JSON을 포함합니다.

연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 시드 또는 시작 지점 URL을 제공하거나 사이트맵 URL을 제공할 수 있습니다. 모든 URL을 수동으로 나열하는 대신 시드 URL 목록의 텍스트 파일 또는 사이트맵 XML 파일을 저장하는 Amazon S3 버킷의 경로를 제공할 수 있습니다. 이 파일은 S3에서 ZIP 파일로 묶을 수 있습니다.

또한 데이터 소스 유형을 로 지정하고WEBCRAWLERV2, 웹 사이트에 인증이 필요한 경우 웹 사이트 인증 자격 증명 및 인증 유형, 기타 필요한 구성을 지정합니다.

그런 다음 CreateDataSource를 호출할 때 TEMPLATEType으로 지정합니다.

중요

Web Crawler v2.0 커넥터 생성은 에서 지원되지 않습니다. AWS CloudFormation지원이 필요한 경우 웹 크롤러 v1.0 커넥터를 사용하십시오. AWS CloudFormation

인덱싱할 웹 사이트를 선택할 때 Amazon 이용 정책과 기타 모든 Amazon 약관을 준수해야 합니다. Amazon Kendra 웹 크롤러는 자신의 웹 페이지 또는 인덱싱할 권한이 있는 웹 페이지를 인덱싱할 때만 사용해야 한다는 점을 기억하십시오. Amazon Kendra Web Crawler가 웹 사이트를 인덱싱하지 못하게 하는 방법을 알아보려면 Amazon Kendra 웹 크롤러용 robots.txt 파일 구성을 참조하세요.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Amazon Kendra 웹 크롤러 JSON 스키마를 참조하세요.

다음 표에서는 Amazon Kendra Web Crawler JSON 스키마의 매개 변수에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보.
siteMapUrls 크롤링하려는 웹 사이트의 사이트 맵 URL의 목록입니다. 최대 3개의 사이트 맵 URL을 나열할 수 있습니다.
s3 SeedUrl 시드 또는 시작 지점 URL의 목록을 저장하는 텍스트 파일의 S3 경로입니다. 예를 들어 s3://bucket-name/directory/입니다. 텍스트 파일의 각 URL은 별도의 줄에 형식을 지정해야 합니다. 최대 100개의 시드 URL을 한 파일에 나열할 수 있습니다.
s3 SiteMapUrl 사이트맵 XML 파일의 S3 경로. 예를 들어 s3://bucket-name/directory/입니다. 최대 3개의 사이트 맵 XML 파일을 나열할 수 있습니다. 여러 사이트맵 파일을 ZIP 파일로 묶어 Amazon S3 버킷에 저장할 수 있습니다.
seedUrlConnections 크롤링하려는 웹사이트의 시드 또는 시작점 URL 목록. 최대 100개의 시드 URL을 나열할 수 있습니다.
seedUrl 시드 또는 시작 지점 URL.
authentication 웹 사이트에 동일한 인증이 필요한 경우의 인증 유형이며, 그렇지 않으면 NoAuthentication를 지정합니다.
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
  • webPage

  • attachment

웹 페이지 및 웹 페이지 파일의 속성 또는 필드 이름을 매핑하여 필드 이름을 Amazon Kendra 인덱싱하는 객체 목록입니다. 예를 들어, HTML 웹 페이지 제목 태그를 _document_title 인덱스 필드에 매핑할 수 있습니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정합니다. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
rateLimit 1분간 웹 사이트 호스트당 크롤링되는 최대 URL 수입니다.
maxFileSize 크롤링할 웹 페이지나 첨부 파일의 최대 크기(MB 단위)입니다.
crawlDepth 시드 URL에서 크롤링할 레벨 수. 예를 들어 시드 URL 페이지는 깊이 1이고 이 페이지에서 크롤링되는 모든 하이퍼링크는 깊이 2입니다.
maxLinksPerUrl 웹 사이트를 크롤링할 때 포함시킬 웹 페이지의 최대 URL 수입니다. 이 수는 웹 페이지를 기준으로 합니다. 웹 사이트의 웹 페이지가 크롤링되면 웹 페이지가 링크하는 모든 URL도 크롤링됩니다. 웹 페이지의 URL은 표시되는 순서대로 크롤링됩니다.
crawlSubDomain true: 하위 도메인이 있는 웹 사이트 도메인을 크롤링합니다. 예를 들어, 시드 URL이 “abc.example.com“이면" “a.abc.example.com“ 및 “b.abc.example.com“도 크롤링됩니다. crawlSubDomain또는 crawlAllDomaintrue 설정하지 않으면 크롤링하려는 웹 사이트의 Amazon Kendra 도메인만 크롤링합니다.
crawlAllDomain true: 웹 페이지가 연결되는 하위 도메인과 기타 도메인이 있는 웹 사이트 도메인을 크롤링합니다. crawlSubDomain또는 crawlAllDomain 로 설정하지 않으면 크롤링하려는 true 웹 사이트의 Amazon Kendra 도메인만 크롤링합니다.
honorRobots true: 크롤링하려는 웹 사이트의 robots.txt 지침을 준수합니다. 이러한 지침은 Amazon Kendra Web Crawler가 웹 사이트를 크롤링하는 방식 (특정 콘텐츠만 Amazon Kendra 크롤링할 수 있는지 또는 어떤 콘텐츠도 크롤링하지 않는지 여부) 을 제어합니다.
crawlAttachments true: 웹 페이지가 링크된 파일을 크롤링합니다.
  • 포함 URL CrawlPatterns

  • 포함 URL IndexPatterns

특정 URL을 크롤링하고 해당 URL 웹 페이지의 하이퍼링크를 인덱싱하는 것을 포함하는 정규 표현식 패턴 목록. 패턴과 일치하는 URL은 인덱스에 포함됩니다. 패턴과 일치하지 않는 URL은 인덱스에서 제외됩니다. URL이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되며 URL/웹사이트의 웹 페이지는 인덱스에 포함되지 않습니다.
  • 제외 URL CrawlPatterns

  • 제외 URL IndexPatterns

특정 URL을 크롤링하고 해당 URL 웹 페이지의 하이퍼링크를 인덱싱하는 것을 제외하는 정규 표현식 패턴 목록. 패턴과 일치하는 URL은 인덱스에서 제외됩니다. 패턴과 일치하지 않는 URL은 인덱스에 포함됩니다. URL이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되며 URL/웹사이트의 웹 페이지는 인덱스에 포함되지 않습니다.
inclusionFileIndex패턴 특정 웹 페이지 파일을 포함하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에 포함됩니다. 패턴과 일치하지 않는 파일은 인덱스에서 제외됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
exclusionFileIndex패턴 특정 웹 페이지 파일을 제외하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에서 제외됩니다. 패턴과 일치하지 않는 파일은 인덱스에 포함됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
proxy 웹 프록시를 통해 내부 웹 사이트에 연결하는 데 필요한 구성 정보입니다.
host 내부 웹사이트에 연결하는 데 사용하려는 프록시 서버의 호스트 이름. 예를 들어, https://a.example.com/page1.html의 호스트 이름은 “a.example.com”입니다.
포트 내부 웹사이트에 연결하는 데 사용하려는 프록시 서버의 포트 번호. 예를 들어, 443은 HTTPS의 표준 포트입니다.
secretArn (proxy) 웹 사이트 호스트에 연결하는 데 웹 프록시 자격 증명이 필요한 경우 자격 증명을 저장하는 AWS Secrets Manager 암호를 만들 수 있습니다. 암호의 Amazon 리소스 이름(ARN)을 제공합니다.
type 데이터 소스의 유형. WEBCRAWLERV2을 데이터 소스 유형으로 지정합니다.
secretArn

웹 사이트에서 웹 사이트에 액세스하기 위해 인증이 필요한 경우 사용되는 AWS Secrets Manager 암호의 Amazon 리소스 이름 (ARN). JSON 키-값 쌍이 포함된 암호에 웹 사이트의 보안 인증을 저장합니다.

기본 또는 NTML/Kerberos를 사용하는 경우 사용자 이름 및 암호를 입력합니다. 암호의 JSON 키는 userNamepassword여야 합니다. NTLM 인증 프로토콜에는 암호 해싱이 포함되고 Kerberos 인증 프로토콜에는 암호 암호화가 포함됩니다.

SAML 또는 양식 인증을 사용하는 경우 사용자 이름과 암호를 입력하고, 사용자 이름 필드에 XPath(SAML을 사용하는 경우 사용자 이름 버튼), 암호 필드와 버튼에 XPaths, 로그인 페이지 URL을 입력합니다. 암호의 JSON 키는 userName, password, userNameFieldXpath, userNameButtonXpath, passwordFieldXpath, passwordButtonXpath, loginPageUrl이어야 합니다. 웹 브라우저의 개발자 도구를 사용하여 요소의 XPaths(XML 경로 언어)를 찾을 수 있습니다. XPaths는 일반적으로 다음 형식을 따릅니다. //tagname[@Attribute='Value']

Amazon Kendra 또한 시크릿에 포함된 엔드포인트 정보 (시드 URL) 가 데이터 소스 엔드포인트 구성 세부 정보에 지정된 엔드포인트 정보와 동일한지 확인합니다.

version 현재 지원되는 이 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "siteMapUrls": { "type": "array", "items":{ "type": "string", "pattern": "https://.*" } }, "s3SeedUrl": { "type": "string", "pattern": "s3:.*" }, "s3SiteMapUrl": { "type": "string", "pattern": "s3:.*" }, "seedUrlConnections": { "type": "array", "items": [ { "type": "object", "properties": { "seedUrl":{ "type": "string", "pattern": "https://.*" } }, "required": [ "seedUrl" ] } ] }, "authentication": { "type": "string", "enum": [ "NoAuthentication", "BasicAuth", "NTLM_Kerberos", "Form", "SAML" ] } } } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "webPage": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "additionalProperties": { "type": "object", "properties": { "rateLimit": { "type": "string", "default": "300" }, "maxFileSize": { "type": "string", "default": "50" }, "crawlDepth": { "type": "string", "default": "2" }, "maxLinksPerUrl": { "type": "string", "default": "100" }, "crawlSubDomain": { "type": "boolean", "default": false }, "crawlAllDomain": { "type": "boolean", "default": false }, "honorRobots": { "type": "boolean", "default": false }, "crawlAttachments": { "type": "boolean", "default": false }, "inclusionURLCrawlPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionURLCrawlPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionURLIndexPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionURLIndexPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileIndexPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileIndexPatterns": { "type": "array", "items": { "type": "string" } }, "proxy": { "type": "object", "properties": { "host": { "type": "string" }, "port": { "type": "string" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } } } }, "required": [ "rateLimit", "maxFileSize", "crawlDepth", "crawlSubDomain", "crawlAllDomain", "maxLinksPerUrl", "honorRobots" ] }, "type": { "type": "string", "pattern": "WEBCRAWLERV2" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "type", "additionalProperties" ] }

Confluence 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 개체의 일부로 포함합니다. TemplateConfiguration 연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 Confluence 호스트 URL, 호스팅 방법 및 인증 유형을 제공합니다. 또한 데이터 소스 유형으로 CONFLUENCEV2, 보안 인증 정보의 암호 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Confluence JSON 스키마를 참조하세요.

다음 표에서는 Confluence JSON 스키마의 파라미터에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보.
hostUrl Confluence 인스턴스의 URL. 예: https://example.confluence.com.
type Confluence 인스턴스의 호스팅 방법(SAASON_PREM)
authType Confluence 인스턴스의 인증 방법(예: Basic, OAuth2 또는 Personal-token)
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
  • space

  • 페이지를 방문하십시오

  • blog

  • 설명

  • attachment

Confluence 스페이스, 페이지, 블로그, 댓글 및 첨부 파일의 속성 또는 필드 이름을 인덱스 필드 이름에 매핑하는 객체 목록입니다. Amazon Kendra 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요. Confluence 데이터 소스 필드 이름은 Confluence 사용자 지정 메타데이터에 있어야 합니다.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
isCrawlAcl trueACL이 있고 액세스 제어에 사용하려는 경우 문서에 대한 액세스 제어 목록 (ACL) 정보를 크롤링하십시오. ACL은 사용자와 그룹이 액세스할 수 있는 문서를 지정합니다. ACL 정보는 검색 결과를 문서에 대한 사용자 또는 그룹의 액세스 권한을 기준으로 필터링하는 데 사용됩니다. 자세한 내용은 사용자 컨텍스트 필터링을 참조하세요.
fieldForUserId 사용자 ID로 사용자 이메일을 사용할지 email 여부를 지정하십시오. email기본적으로 사용되며 현재 지원되는 유일한 사용자 ID 유형입니다.
  • inclusionSpaceKey필터

  • exclusionSpaceKey필터

  • pageTitleRegEX

  • blogTitleRegEX

  • commentTitleRegEX

  • attachmentTitleRegEX

  • inclusionFileType패턴

  • exclusionFileType패턴

  • inclusionUrlPatterns

  • exclusionUrlPatterns

Confluence 데이터 소스에서 특정 파일을 포함 및/또는 제외하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에 포함됩니다. 패턴과 일치하지 않는 파일은 인덱스에서 제외됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
proxyHost 사용하는 웹 프록시의 호스트 이름 (http://또는 https:// 프로토콜 제외).

proxyPort

호스트 URL 전송 프로토콜에서 사용하는 포트 번호입니다. 이 값은 0~65535의 숫자 값이어야 합니다.
  • isCrawlPersonal스페이스

  • isCrawlArchived우주

  • isCrawlArchived페이지

  • isCrawlPage

  • isCrawlBlog

  • isCrawlPage코멘트

  • isCrawlPage첨부파일

  • isCrawlBlog코멘트

  • isCrawlBlog첨부파일

trueConfluence 개인 공간, 페이지, 블로그, 페이지 댓글, 페이지 첨부 파일, 블로그 댓글, 블로그 첨부 파일의 파일을 크롤링할 수 있습니다.
maxFileSizeInMegaBytes 크롤링할 수 있는 파일 크기 제한을 MB 단위로 지정하십시오. Amazon Kendra Amazon Kendra 정의한 크기 제한 내에 있는 파일만 크롤링합니다. 기본 파일 크기는 50MB입니다. 최대 파일 크기는 0MB보다 크고 50MB보다 작거나 같아야 합니다.
type 데이터 소스의 유형. CONFLUENCEV2을 데이터 소스 유형으로 지정합니다.
enableIdentityCrawler true Amazon Kendra의 ID 크롤러를 사용하여 특정 문서에 대한 액세스 권한이 있는 사용자 및 그룹의 ID/주체 정보를 동기화하는 데 사용합니다. ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 PutPrincipalMappingAPI를 사용하여 사용자 및 그룹 액세스 정보를 업로드할 수도 있습니다.
syncMode

데이터 소스 콘텐츠가 Amazon Kendra 변경될 때 색인을 업데이트하는 방법을 지정하십시오. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretARN Confluence에 연결하는 데 필요한 키-값 쌍이 포함된 AWS Secrets Manager 시크릿의 Amazon 리소스 이름 (ARN). 이러한 키-값 쌍에 대한 자세한 내용은 Confluence의 연결 지침을 참조하십시오.
version 현재 지원되는 이 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "https:.*" }, "type": { "type": "string", "enum": [ "SAAS", "ON_PREM" ] }, "authType": { "type": "string", "enum": [ "Basic", "OAuth2", "Personal-token" ] } }, "required": [ "hostUrl", "type", "authType" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "space": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "page": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "blog": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "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", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "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": { "usersAclS3FilePath": { "type": "string" }, "isCrawlAcl": { "type": "boolean" }, "fieldForUserId": { "type": "string" }, "inclusionSpaceKeyFilter": { "type": "array", "items": { "type": "string" } }, "exclusionSpaceKeyFilter": { "type": "array", "items": { "type": "string" } }, "pageTitleRegEX": { "type": "array", "items": { "type": "string" } }, "blogTitleRegEX": { "type": "array", "items": { "type": "string" } }, "commentTitleRegEX": { "type": "array", "items": { "type": "string" } }, "attachmentTitleRegEX": { "type": "array", "items": { "type": "string" } }, "isCrawlPersonalSpace": { "type": "boolean" }, "isCrawlArchivedSpace": { "type": "boolean" }, "isCrawlArchivedPage": { "type": "boolean" }, "isCrawlPage": { "type": "boolean" }, "isCrawlBlog": { "type": "boolean" }, "isCrawlPageComment": { "type": "boolean" }, "isCrawlPageAttachment": { "type": "boolean" }, "isCrawlBlogComment": { "type": "boolean" }, "isCrawlBlogAttachment": { "type": "boolean" }, "maxFileSizeInMegaBytes": { "type":"string" }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionUrlPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionUrlPatterns": { "type": "array", "items": { "type": "string" } }, "proxyHost": { "type": "string" }, "proxyPort": { "type": "string" } }, "required": [] }, "type": { "type": "string", "pattern": "CONFLUENCEV2" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

Dropbox 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 개체의 일부로 포함합니다. TemplateConfiguration 보안 인증을 저장하는 암호의 일부로 Dropbox 앱 키, 앱 암호, 액세스 토큰을 제공합니다. 또한 데이터 소스 유형으로 DROPBOX를 지정하고, 사용하려는 액세스 토큰 유형(임시 또는 영구) 및 기타 필요한 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Dropbox JSON 스키마를 참조하세요.

다음 표에는 Dropbox JSON 스키마의 매개 변수가 설명되어 있습니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보. 이 데이터 소스는 repositoryEndpointMetadata에 엔드포인트를 지정하지 않습니다. 대신 사용자가 제공하는 AWS Secrets Manager 비밀번호에 연결 정보가 포함됩니다. secretArn
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
  • 파일

  • paper

  • papert

  • shortcut

Dropbox 파일, Dropbox Paper의 속성 또는 필드 이름을 매핑하고 필드 이름을 Amazon Kendra 인덱싱하기 위한 바로가기를 매핑하는 개체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
syncMode

데이터 원본 콘텐츠가 Amazon Kendra 변경될 때 색인을 업데이트하는 방법을 명시하세요. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

enableIdentityCrawler true Amazon Kendra의 ID 크롤러를 사용하여 특정 문서에 대한 액세스 권한이 있는 사용자 및 그룹의 ID/주체 정보를 동기화하는 데 사용합니다. ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 PutPrincipalMappingAPI를 사용하여 사용자 및 그룹 액세스 정보를 업로드할 수도 있습니다.
secretARN Dropbox에 연결하는 데 필요한 키-값 쌍이 포함된 AWS Secrets Manager 비밀번호의 Amazon 리소스 이름 (ARN). 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "appKey": "Dropbox app key", "appSecret": "Dropbox app secret", "accesstoken": "temporary access token or refresh access token" }
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
isCrawlAcl trueACL이 있고 액세스 제어에 사용하려는 경우 문서의 액세스 제어 목록 (ACL) 정보를 크롤링하기 위해서입니다. ACL은 사용자와 그룹이 액세스할 수 있는 문서를 지정합니다. ACL 정보는 검색 결과를 문서에 대한 사용자 또는 그룹의 액세스 권한을 기준으로 필터링하는 데 사용됩니다. 자세한 내용은 사용자 컨텍스트 필터링을 참조하세요.
  • inclusionFileName패턴

  • inclusionFileType패턴

Dropbox 데이터 소스에서 특정 파일 이름 및 형식을 포함하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에 포함됩니다. 패턴과 일치하지 않는 파일은 인덱스에서 제외됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
  • exclusionFileName패턴

  • exclusionFileType패턴

Dropbox 데이터 소스에서 특정 파일 이름 및 형식을 제외하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에서 제외됩니다. 패턴과 일치하지 않는 파일은 인덱스에 포함됩니다. 파일이 제외 및 포함 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
  • crawlFile

  • crawlPaper

  • crawlPapert

  • crawlShortcut

true드롭박스에 있는 파일, 드롭박스 페이퍼 문서, 드롭박스 페이퍼 템플릿, 드롭박스에 저장된 웹페이지 바로가기를 크롤링할 수 있습니다.
type 데이터 소스의 유형. DROPBOX을 데이터 소스 유형으로 지정합니다.
tokenType 액세스 토큰 유형(영구 또는 임시 액세스 토큰)을 지정합니다. 4시간 후에 만료되는 일회용 액세스 토큰을 사용하는 것보다 Dropbox에서 만료되지 않는 새로 고침 액세스 토큰을 만드는 것이 좋습니다. Dropbox 개발자 콘솔에서 앱과 새로 고침 액세스 토큰을 만들고 암호에 액세스 토큰을 입력합니다.
version 현재 지원되는 이 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { } } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "file": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "LONG", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "paper": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "LONG", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "papert": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "LONG", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "shortcut": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "LONG", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] } } }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG" ] }, "enableIdentityCrawler": { "type": "boolean" }, "secretArn": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "isCrawlAcl": { "type": "boolean" }, "inclusionFileNamePatterns": { "type": "array" }, "exclusionFileNamePatterns": { "type": "array" }, "inclusionFileTypePatterns": { "type": "array" }, "exclusionFileTypePatterns": { "type": "array" }, "crawlFile": { "type": "boolean" }, "crawlPaper": { "type": "boolean" }, "crawlPapert": { "type": "boolean" }, "crawlShortcut": { "type": "boolean" } } }, "type": { "type": "string", "pattern": "DROPBOX" }, "tokenType": { "type": "string", "enum": [ "PERMANENT", "TEMPORARY" ] }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] } }, "additionalProperties": false, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "syncMode", "enableIdentityCrawler", "secretArn", "type", "tokenType" ] }

Drupal 템플릿 스키마

데이터 소스 스키마가 포함된 JSON을 개체의 일부로 포함합니다. TemplateConfiguration 연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 Drupal 호스트 URL과 인증 유형을 제공합니다. 또한 데이터 소스 유형으로 DRUPAL, 보안 인증 정보의 암호 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Drupal JSON 스키마를 참조하세요.

다음 표는 Drupal JSON 스키마의 매개 변수를 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보.
hostUrl Drupal 웹 사이트의 호스트 URL. <hostname><drupalsitename>예를 들어 https:///입니다.
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보.
  • content

  • 설명

  • attachment

Drupal 파일의 속성 또는 필드 이름을 매핑하는 객체 목록. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요. Drupal 데이터 소스 필드 이름이 Drupal 사용자 지정 메타데이터에 있어야 합니다.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
  • inclusionFileName패턴

  • articleTitleInclusion패턴

  • pageTitleInclusion패턴

  • customContentTitleInclusionPatterns

  • basicBlockTitleInclusionPatterns

  • customBlockTitleInclusionPatterns

Drupal 데이터 소스에서 특정 파일을 포함하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에 포함됩니다. 패턴과 일치하지 않는 파일은 인덱스에서 제외됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
  • exclusionFileName패턴

  • articleTitleExclusion패턴

  • pageTitleExclusion패턴

  • customContentTitleExclusionPatterns

  • basicBlockTitleExclusionPatterns

  • customBlockTitleExclusionPatterns

Drupal 데이터 소스에서 특정 파일을 제외하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에서 제외됩니다. 패턴과 일치하지 않는 파일은 인덱스에 포함됩니다. 파일이 제외 및 포함 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
contentDefinitions
  • contentType

  • fieldDefinition

  • isCrawlComments

  • isCrawlFiles

  • isCrawlArticle

  • isCrawlBasic페이지

  • isCrawlBasic블록

  • isCrawlCustomContentTypesList

크롤링할 콘텐츠 유형, 선택한 콘텐츠 유형에 대한 설명 및 첨부 파일을 크롤링할지 여부를 지정합니다.
type 데이터 소스의 유형. DRUPAL을 데이터 소스 유형으로 지정합니다.
authType 사용하는 인증 유형(BASIC-AUTH 또는 OAUTH2).
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정합니다. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

enableIdentityCrawler true Amazon Kendra의 ID 크롤러를 사용하여 특정 문서에 대한 액세스 권한이 있는 사용자 및 그룹의 ID/주체 정보를 동기화하는 데 사용합니다. ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 PutPrincipalMappingAPI를 사용하여 사용자 및 그룹 액세스 정보를 업로드할 수도 있습니다.
secretARN Drupal에 연결하는 데 필요한 키-값 쌍이 포함된 AWS Secrets Manager 비밀의 Amazon 리소스 이름 (ARN). 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.

기본 인증을 사용하는 경우:

{ "username": "user name", "passwords": "password" }

OAuth 2.0 인증을 사용하는 경우:

{ "username": "user name", "password": "password", "clientId": "client id", "clientSecret": "client secret" }
version 현재 지원되는 이 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "https:.*" } }, "required": [ "hostUrl" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "content": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "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" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "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": { "isCrawlArticle": { "type": "boolean" }, "isCrawlBasicPage": { "type": "boolean" }, "isCrawlBasicBlock": { "type": "boolean" }, "crawlCustomContentTypesList": { "type": "array", "items": { "type": "string" } }, "crawlCustomBlockTypesList": { "type": "array", "items": { "type": "string" } }, "filePath": { "anyOf": [ { "type": "string", "pattern": "s3:.*" }, { "type": "string", "pattern": "" } ] }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "articleTitleInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "articleTitleExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pageTitleInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pageTitleExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "customContentTitleInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "customContentTitleExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "basicBlockTitleInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "basicBlockTitleExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "customBlockTitleInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "customBlockTitleExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "contentDefinitions": { "type": "array", "items": { "properties": { "contentType": { "type": "string" }, "fieldDefinition": { "type": "array", "items": [ { "type": "object", "properties": { "machineName": { "type": "string" }, "type": { "type": "string" } }, "required": [ "machineName", "type" ] } ] }, "isCrawlComments": { "type": "boolean" }, "isCrawlFiles": { "type": "boolean" } } }, "required": [ "contentType", "fieldDefinition", "isCrawlComments", "isCrawlFiles" ] } }, "required": [] }, "type": { "type": "string", "pattern": "DRUPAL" }, "authType": { "type": "string", "enum": [ "BASIC-AUTH", "OAUTH2" ] }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "enableIdentityCrawler": { "type": "boolean" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

GitHub 템플릿 스키마

데이터 소스 스키마를 TemplateConfiguration개체의 일부로 포함하는 JSON을 포함합니다. 연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 GitHub 호스트 URL, 조직 이름, GitHub 클라우드 또는 GitHub 온프레미스 사용 여부를 제공합니다. 또한 데이터 소스 유형으로 GITHUB, 보안 인증 정보의 암호 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. GitHub JSON 스키마를 참조하세요.

다음 표에서는 GitHub JSON 스키마의 파라미터에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보.
type 유형을 SAAS 또는 ON_PREMISE 로 지정합니다.
hostUrl GitHub 호스트 URL. 예를 들어, GitHub SaaS/엔터프라이즈 클라우드를 사용하는 경우:. https://api.github.com 또는 GitHub 온프레미스/엔터프라이즈 서버를 사용하는 경우:. https://on-prem-host-url/api/v3/
organizationName GitHub 데스크톱에 로그인하고 프로필 사진 드롭다운에서 내 조직으로 이동하면 조직 이름을 찾을 수 있습니다.
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
  • GH리포지토리

  • GH 커밋

  • ghIssueDocument

  • ghIssueComment

  • ghIssueAttachment

  • GPR 문서

  • GPR 논평

  • GPR 첨부 파일

GitHub 콘텐츠의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 개체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
isCrawlAcl true문서에 대한 액세스 제어 목록 (ACL) 정보를 크롤링하려면 (ACL이 있고 액세스 제어에 사용하려는 경우) ACL은 사용자와 그룹이 액세스하고 검색할 수 있는 문서를 지정합니다. ACL 정보는 검색 결과를 문서에 대한 사용자 또는 그룹의 액세스 권한을 기준으로 필터링하는 데 사용됩니다. 자세한 내용은 사용자 컨텍스트 필터링을 참조하세요.
fieldForUserId ACL 크롤링에 사용할 사용자 ID 유형을 지정합니다. 사용자 ID로 사용자 이메일을 사용할지, 아니면 username 사용자 ID로 사용자 이름을 사용할지를 지정합니다. email 옵션을 지정하지 않는 경우 기본적으로 email 이 옵션이 사용됩니다.
리포지토리 필터 인덱싱하려는 특정 리포지토리 이름 및 브랜치 이름 목록.
크롤/리포지토리 true리포지토리를 크롤링하는 방법.
crawlRepositoryDocuments true리포지토리 문서를 크롤링합니다.
크롤링 문제 true크롤링 이슈를 위해서요.
crawlIssueComment true이슈 댓글을 크롤링하기 위해서요.
crawlIssueComment첨부 파일 true댓글 첨부 파일을 크롤링하려면
crawlPullRequest true풀 리퀘스트를 크롤링하기 위해서요.
crawlPullRequest코멘트 true풀 리퀘스트 댓글을 크롤링하려면
crawlPullRequestCommentAttachment true풀 리퀘스트 댓글 첨부 파일을 크롤링하기 위해서입니다.
  • inclusionFolderName패턴

  • inclusionFileType패턴

  • inclusionFileName패턴

GitHub데이터 원본에 특정 콘텐츠를 포함하기 위한 정규 표현식 패턴 목록입니다. 패턴과 일치하는 콘텐츠는 인덱스에 포함됩니다. 패턴과 일치하지 않는 콘텐츠는 인덱스에서 제외됩니다. 포함 패턴과 제외 패턴 모두에 일치하는 콘텐츠가 있는 경우 제외 패턴이 우선하며 콘텐츠는 색인에 포함되지 않습니다.
  • exclusionFolderName패턴

  • exclusionFileType패턴

  • exclusionFileName패턴

GitHub데이터 원본에서 특정 콘텐츠를 제외하기 위한 정규 표현식 패턴 목록입니다. 패턴과 일치하는 콘텐츠는 인덱스에서 제외됩니다. 패턴과 일치하지 않는 콘텐츠는 인덱스에 포함됩니다. 포함 패턴과 제외 패턴 모두에 일치하는 콘텐츠가 있는 경우 제외 패턴이 우선하며 콘텐츠는 색인에 포함되지 않습니다.
type 데이터 소스의 유형. GITHUB을 데이터 소스 유형으로 지정합니다.
enableIdentityCrawler true Amazon Kendra의 ID 크롤러를 사용하여 사용자 및 그룹의 ID/주체 정보를 특정 문서에 대한 액세스 권한과 동기화하는 데 사용합니다. ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 PutPrincipalMappingAPI를 사용하여 사용자 및 그룹 액세스 정보를 업로드할 수도 있습니다.
syncMode

데이터 소스 콘텐츠가 Amazon Kendra 변경될 때 색인을 업데이트하는 방법을 지정하십시오. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretArn

연결에 필요한 키-값 쌍이 포함된 AWS Secrets Manager 비밀의 Amazon 리소스 이름 (ARN). GitHub 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.

{ "personalToken": "token" }
version 현재 지원되는 이 템플릿의 버전입니다.

다음은 GitHub JSON 스키마입니다.

{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "type": { "type": "string" }, "hostUrl": { "type": "string", "pattern": "https://.*" }, "organizationName": { "type": "string" } }, "required": [ "type", "hostUrl", "organizationName" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "ghRepository": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghCommit": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghIssueDocument": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghIssueComment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghIssueAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghPRDocument": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghPRComment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghPRAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "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": { "isCrawlAcl": { "type": "boolean" }, "fieldForUserId": { "type": "string" }, "crawlRepository": { "type": "boolean" }, "crawlRepositoryDocuments": { "type": "boolean" }, "crawlIssue": { "type": "boolean" }, "crawlIssueComment": { "type": "boolean" }, "crawlIssueCommentAttachment": { "type": "boolean" }, "crawlPullRequest": { "type": "boolean" }, "crawlPullRequestComment": { "type": "boolean" }, "crawlPullRequestCommentAttachment": { "type": "boolean" }, "repositoryFilter": { "type": "array", "items": [ { "type": "object", "properties": { "repositoryName": { "type": "string" }, "branchNameList": { "type": "array", "items": { "type": "string" } } } } ] }, "inclusionFolderNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFolderNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } } }, "required": [] }, "type": { "type": "string", "pattern": "GITHUB" }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG" ] }, "enableIdentityCrawler": { "type": "boolean" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "enableIdentityCrawler" ] }

Gmail 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 개체의 TemplateConfiguration일부로 포함합니다. 데이터 소스 유형으로 GMAIL, 보안 인증 정보의 암호 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Gmail JSON 스키마를 참조하세요.

다음 표에는 Gmail JSON 스키마의 매개변수가 설명되어 있습니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보. 이 데이터 소스는 repositoryEndpointMetadata에 엔드포인트를 지정하지 않습니다. 대신 사용자가 제공하는 AWS Secrets Manager 비밀번호에 연결 정보가 포함됩니다. secretArn
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다. 데이터 소스 유형과 비밀 ARN을 지정합니다.
  • message

  • attachments

Gmail 메일과 첨부파일의 속성 또는 필드 이름을 Amazon Kendra 색인 필드 이름에 매핑하는 개체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
  • inclusionLabelName패턴

  • exclusionLabelName패턴

  • inclusionAttachmentType패턴

  • exclusionAttachmentType패턴

  • inclusionAttachmentName패턴

  • exclusionAttachmentName패턴

  • inclusionSubjectFilter

  • exclusionSubjectFilter

  • isSubjectAnd

  • inclusionFromFilter

  • exclusionFromFilter

  • inclusionToFilter

  • exclusionToFilter

  • inclusionCcFilter

  • exclusionCcFilter

  • inclusionBccFilter

  • exclusionBccFilter

Gmail 데이터 소스에서 특정 주제 이름의 메시지를 포함하거나 제외하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에 포함됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
beforeDateFilter 특정 날짜 이전에 포함할 메시지와 첨부 파일을 지정합니다.
afterDateFilter 특정 날짜 이후에 포함할 메시지와 첨부 파일을 지정합니다.
isCrawlAttachment 첨부 파일을 크롤링할지 여부를 선택하는 부울 값. 메시지는 자동으로 크롤링됩니다.
type 데이터 소스의 유형. GMAIL을 데이터 소스 유형으로 지정합니다.
shouldCrawlDraft메시지 초안 메시지를 크롤링할지 여부를 선택하는 부울 값.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정하세요. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

중요

영구 삭제된 Gmail 메시지를 업데이트하는 API가 없으므로 새 콘텐츠, 수정 콘텐츠, 삭제된 콘텐츠가 동기화됩니다.

  • Gmail에서 영구 삭제된 메일은 색인에서 삭제되지 않습니다. Amazon Kendra

  • Gmail 이메일 라벨의 변경사항을 동기화하지 않습니다.

Gmail 데이터 소스 라벨 변경사항과 영구 삭제된 이메일 메시지를 Amazon Kendra 색인에 동기화하려면 정기적으로 전체 크롤링을 실행해야 합니다.

secretARN Gmail에 연결하는 데 필요한 키-값 페어가 포함된 Secrets Manager 암호의 Amazon 리소스 이름(ARN). 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "adminAccountEmailId": "service account email", "clientEmailId": "user account email", "privateKey": "private key" }
version 현재 지원되는 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { } }, "repositoryConfigurations": { "type": "object", "properties": { "message": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "attachments": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING"] }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } } }, "required": [] }, "additionalProperties": { "type": "object", "properties": { "inclusionLabelNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionLabelNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionAttachmentTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionAttachmentTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionAttachmentNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionAttachmentNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionSubjectFilter": { "type": "array", "items": { "type": "string" } }, "exclusionSubjectFilter": { "type": "array", "items": { "type": "string" } }, "isSubjectAnd": { "type": "boolean" }, "inclusionFromFilter": { "type": "array", "items": { "type": "string" } }, "exclusionFromFilter": { "type": "array", "items": { "type": "string" } }, "inclusionToFilter": { "type": "array", "items": { "type": "string" } }, "exclusionToFilter": { "type": "array", "items": { "type": "string" } }, "inclusionCcFilter": { "type": "array", "items": { "type": "string" } }, "exclusionCcFilter": { "type": "array", "items": { "type": "string" } }, "inclusionBccFilter": { "type": "array", "items": { "type": "string" } }, "exclusionBccFilter": { "type": "array", "items": { "type": "string" } }, "beforeDateFilter": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "afterDateFilter": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "isCrawlAttachment": { "type": "boolean" }, "shouldCrawlDraftMessages": { "type": "boolean" } }, "required": [ "isCrawlAttachment", "shouldCrawlDraftMessages" ] }, "type" : { "type" : "string", "pattern": "GMAIL" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "secretArn": { "type": "string" }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] } }, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "syncMode", "secretArn", "type" ] }

Google Drive 템플릿 스키마

데이터 소스 스키마가 포함된 JSON을 개체의 일부로 포함하세요. TemplateConfiguration 데이터 소스 유형으로 GOOGLEDRIVE2, 보안 인증 정보의 암호 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Google Drive JSON 스키마를 참조하세요.

다음 표에는 Google 드라이브 JSON 스키마의 매개변수가 설명되어 있습니다.

구성 설명
connectionConfiguration 데이터 소스에 대한 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보. 이 데이터 소스는 엔드포인트를 지정하지 않습니다. 인증 유형: serviceAccountOAuth2를 선택합니다. 연결 정보는 사용자가 제공하는 AWS Secrets Manager 비밀번호에 포함됩니다. secretArn
authType 사용 사례를 기반으로 serviceAccount 또는 OAuth2 중에서 선택합니다.
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
  • 파일

  • 설명

Amazon Kendra 인덱스 필드 이름에 Google Drive의 속성 또는 필드 이름을 매핑하는 객체의 목록. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
  • maxFileSizeInMegaBytes

Amazon Kendra 크롤링해야 하는 파일 크기 제한을 MB 단위로 지정합니다.
  • iscrawlComment

trueGoogle 드라이브 데이터 소스의 댓글을 크롤링하려면
  • isCrawlMyDriveAndSharedWithMe

trueGoogle 드라이브 데이터 소스의 드라이브를 크롤링하여 내 MyDrive 드라이브와 공유하기
  • isCrawlShared드라이브

trueGoogle 드라이브 데이터 소스의 공유 드라이브를 크롤링하기.
isCrawlAcl trueACL이 있고 액세스 제어에 사용하려는 경우 문서의 ACL (액세스 제어 목록) 정보를 크롤링할 수 있습니다. ACL은 사용자와 그룹이 액세스하고 검색할 수 있는 문서를 지정합니다. ACL 정보는 검색 결과를 문서에 대한 사용자 또는 그룹의 액세스 권한을 기준으로 필터링하는 데 사용됩니다. 자세한 내용은 사용자 컨텍스트 필터링을 참조하세요.
  • excludeUserAccounts

  • excludeSharedDrives

  • excludeMimeTypes

  • exclusionFileType패턴

  • exclusionFileName패턴

  • exclusionFilePath필터

Google Drive 데이터 소스에서 특정 파일을 제외하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에서 제외됩니다. 패턴과 일치하지 않는 파일은 인덱스에 포함됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
  • includeUserAccounts

  • includeSharedDrives

  • includeMimeTypes

  • inclusionFileType패턴

  • inclusionFileName패턴

  • inclusionFilePath필터

Google Drive 데이터 소스에서 특정 파일을 포함하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에 포함됩니다. 패턴과 일치하지 않는 파일은 인덱스에서 제외됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
type 데이터 소스의 유형. GOOOGLEDRIVEV2을 데이터 소스 유형으로 지정합니다.
enableIdentityCrawler true Amazon Kendra의 ID 크롤러를 사용하여 사용자 및 그룹의 ID/주체 정보를 특정 문서에 대한 액세스 권한과 동기화합니다. ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 PutPrincipalMappingAPI를 사용하여 사용자 및 그룹 액세스 정보를 업로드할 수도 있습니다.
syncMode

데이터 소스 콘텐츠가 Amazon Kendra 변경될 때 색인을 업데이트하는 방법을 지정하십시오. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretARN Google 드라이브에 연결하는 데 필요한 키-값 쌍이 포함된 AWS Secrets Manager 비밀의 Amazon 리소스 이름 (ARN). 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.

Google 서비스 계정 인증을 사용하는 경우:

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

OAuth 2.0 인증을 사용하는 경우:

{ "clientID": "OAuth client ID", "clientSecret": "client secret", "refreshToken": "refresh token" }
version 현재 지원되는 이 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "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": { "type": "boolean" }, "isCrawlMyDriveAndSharedWithMe": { "type": "boolean" }, "isCrawlSharedDrives": { "type": "boolean" }, "isCrawlAcl": { "type": "boolean" }, "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" } } } }, "type": { "type": "string", "pattern": "GOOGLEDRIVEV2" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

IBM DB2 템플릿 스키마

데이터 소스 스키마가 포함된 JSON을 객체의 일부로 포함합니다. TemplateConfiguration 데이터 소스로 JDBC, 데이터 소스 유형으로 db2, 보안 인증 정보의 암호, 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. IBM DB2 JSON 스키마를 참조하세요.

다음 표에는 IBM DB2 JSON 스키마의 매개변수가 설명되어 있습니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스 연결을 위한 필수 구성 정보.
  • DBType - 사용하는 자바 데이터베이스 유형 (,,mysql, db2 또는). postgresql oracle sqlserver

  • dbHost - 데이터베이스 호스트 이름.

  • dbPort - 데이터베이스 포트.

  • dbInstance - 데이터베이스 인스턴스.

repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다. 데이터 소스 유형과 비밀 ARN을 지정합니다.

문서

데이터베이스 콘텐츠의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 객체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션. 데이터베이스 데이터 소스에 특정 콘텐츠를 포함하거나 제외하는 데 사용합니다.
primaryKeys 데이터베이스 테이블의 기본 키를 입력합니다. 이는 데이터베이스 내의 테이블을 식별합니다.
titleColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
bodyColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
sqlQuery SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
timestampColumn 타임스탬프가 포함된 열의 이름을 입력합니다. Amazon Kendra 타임스탬프 정보를 사용하여 콘텐츠의 변경 사항을 감지하고 변경된 콘텐츠만 동기화합니다.
timestampFormat 콘텐츠 변경 사항을 감지하고 콘텐츠를 다시 동기화하는 데 사용할 타임스탬프 형식이 포함된 열의 이름을 입력합니다.
timezone 콘텐츠를 크롤링할 시간대가 포함된 열의 이름을 입력합니다.
changeDetectingColumns 콘텐츠 변경을 감지하는 Amazon Kendra 데 사용할 열 이름을 입력합니다. Amazon Kendra 이러한 열에 변경 사항이 있을 경우 콘텐츠를 다시 인덱싱합니다.
allowedUsersColumns 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
allowedGroupsColumn 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
sourceURIColumn 인덱싱할 소스 URL이 포함된 열의 이름을 입력합니다.
isSslEnabled SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
type 데이터 소스의 유형. JDBC을 데이터 소스 유형으로 지정합니다.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정하세요. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretArn 데이터베이스에 연결하는 데 필요한 사용자 이름 및 암호가 포함된 Secrets Manager 보안 암호의 Amazon 리소스 이름(ARN)입니다. 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "user name": "database user name", "password": "password" }
version 현재 지원되는 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

Microsoft Exchange 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 TemplateConfiguration개체의 일부로 포함합니다. 테넌트 ID는 연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 제공합니다. 또한 데이터 소스 유형으로 MSEXCHANGE, 보안 인증 정보의 암호 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Microsoft Exchange JSON 스키마를 참조하세요.

다음 표에서는 Microsoft Exchange JSON 스키마의 매개 변수에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보.
tenantId Microsoft 365 테넌트 ID. 테넌트 ID는 Azure Active Directory 포털의 속성 또는 OAuth 애플리케이션에서 찾을 수 있습니다.
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
  • 이메일

  • attachment

  • calendar

  • contacts

  • notes

Microsoft Exchange 데이터 원본의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드에 매핑하는 개체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
inclusionPatterns Microsoft Exchange 데이터 소스에서 특정 파일을 포함하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에 포함됩니다. 패턴과 일치하지 않는 파일은 인덱스에서 제외됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
exclusionPatterns Microsoft Exchange 데이터 소스에서 특정 파일을 제외하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에서 제외됩니다. 패턴과 일치하지 않는 파일은 인덱스에 포함됩니다. 파일이 제외 및 포함 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
  • inclusionUsersList

  • inclusionUsersFile이름

  • inclusionDomainUsers

Microsoft Exchange 데이터 소스에서 특정 사용자 및 사용자 파일을 포함하는 정규식 패턴 목록. 패턴과 일치하는 사용자는 인덱스에 포함됩니다. 패턴과 일치하지 않는 사용자는 인덱스에서 제외됩니다. 사용자가 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 사용자는 인덱스에 포함되지 않습니다.
  • exclusionUsersList

  • exclusionUsersFile이름

  • exclusionDomainUsers

Microsoft Exchange 데이터 소스에서 특정 사용자 및 사용자 파일을 제외하는 정규식 패턴 목록. 패턴과 일치하는 사용자는 인덱스에서 제외됩니다. 패턴과 일치하지 않는 사용자는 인덱스에 포함됩니다. 사용자가 제외 및 포함 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 사용자는 인덱스에 포함되지 않습니다.
s3bucketName 사용할 S3 버킷의 이름.
  • crawlCalendar

  • crawlNotes

  • crawlContacts

  • crawlFolderAcl

trueMicrosoft Exchange 데이터 원본의 이러한 유형의 콘텐츠를 크롤링하고 제어 정보에 액세스할 수 있습니다.
startCalendarDate소요 시간 일정 콘텐츠의 특정 시작 날짜/시간을 구성할 수 있습니다.
endCalendarDate시간 일정 콘텐츠의 특정 종료 날짜/시간을 구성할 수 있습니다.
subject 메일 콘텐츠의 특정 제목 줄을 구성할 수 있습니다.
emailFrom '보낸 사람' 또는 보낸 사람 메일 콘텐츠에 대해 특정 이메일을 구성할 수 있습니다.
emailTo '받는 사람' 또는 받는 사람 메일 콘텐츠에 대해 특정 이메일을 구성할 수 있습니다.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정합니다. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

type 데이터 소스의 유형. MSEXCHANGE을 데이터 소스 유형으로 지정합니다.
secretARN Microsoft Exchange에 연결하는 데 필요한 키-값 쌍이 포함된 AWS Secrets Manager 암호의 Amazon 리소스 이름 (ARN) 입니다. 여기에는 Azure 포털에서 OAuth 애플리케이션을 만들 때 생성되는 클라이언트 ID와 클라이언트 암호가 포함됩니다.
version 현재 지원되는 이 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "tenantId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 } }, "required": ["tenantId"] } } }, "repositoryConfigurations": { "type": "object", "properties": { "email": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "DATE","LONG"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "calendar": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "contacts": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "notes": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": ["email" ] }, "additionalProperties": { "type": "object", "properties": { "inclusionPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionUsersList": { "type": "array", "items": { "type": "string", "format": "email" } }, "exclusionUsersList": { "type": "array", "items": { "type": "string", "format": "email" } }, "s3bucketName": { "type": "string" }, "inclusionUsersFileName": { "type": "string" }, "exclusionUsersFileName": { "type": "string" }, "inclusionDomainUsers": { "type": "array", "items": { "type": "string" } }, "exclusionDomainUsers": { "type": "array", "items": { "type": "string" } }, "crawlCalendar": { "type": "boolean" }, "crawlNotes": { "type": "boolean" }, "crawlContacts": { "type": "boolean" }, "crawlFolderAcl": { "type": "boolean" }, "startCalendarDateTime": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "endCalendarDateTime": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "subject": { "type": "array", "items": { "type": "string" } }, "emailFrom": { "type": "array", "items": { "type": "string", "format": "email" } }, "emailTo": { "type": "array", "items": { "type": "string", "format": "email" } } }, "required": [ ] }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "type" : { "type" : "string", "pattern": "MSEXCHANGE" }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

Microsoft OneDrive 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 TemplateConfiguration개체의 일부로 포함합니다. 테넌트 ID는 연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 제공합니다. 또한 데이터 소스 유형으로 ONEDRIVEV2, 보안 인증 정보의 암호 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. 마이크로소프트 OneDrive JSON 스키마를 참조하세요.

다음 표에서는 Microsoft OneDrive JSON 스키마의 매개 변수에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보.
tenantId Microsoft 365 테넌트 ID. 테넌트 ID는 Azure Active Directory 포털의 속성 또는 OAuth 애플리케이션에서 찾을 수 있습니다.
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
파일 Microsoft OneDrive 파일의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 개체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
  • userNameFilter

  • userFilterPath

  • inclusionFileType패턴

  • exclusionFileType패턴

  • inclusionFileName패턴

  • exclusionFileName패턴

  • inclusionFilePath패턴

  • exclusionFilePath패턴

  • inclusionOneNoteSectionNamePatterns

  • exclusionOneNoteSectionNamePatterns

  • inclusionOneNotePageNamePatterns

  • exclusionOneNotepageNamePatterns

특정 파일, OneNote 섹션, OneNote 페이지를 인덱싱하도록 선택하고 사용자 이름을 기준으로 필터링할 수 있습니다.
isUserNameOnS3 true: Amazon S3에 저장된 파일의 사용자 이름 목록을 제공합니다.
type 데이터 소스의 유형. ONEDRIVEV2을 데이터 소스 유형으로 지정합니다.
enableIdentityCrawler true Amazon Kendra의 ID 크롤러를 사용하여 사용자 및 그룹의 ID/주체 정보를 특정 문서에 대한 액세스 권한과 동기화합니다. ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 PutPrincipalMappingAPI를 사용하여 사용자 및 그룹 액세스 정보를 업로드할 수도 있습니다.
type 데이터 소스의 유형. ONEDRIVEV2을 데이터 소스 유형으로 지정합니다.
syncMode

데이터 소스 콘텐츠가 Amazon Kendra 변경될 때 색인을 업데이트하는 방법을 지정하십시오. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretARN Microsoft에 연결하는 데 필요한 키-값 쌍이 포함된 AWS Secrets Manager 시크릿의 Amazon 리소스 이름 (ARN) 입니다. OneDrive 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "clientId": "client ID", "clientSecret": "client secret" }
version 현재 지원되는 이 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "tenantId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 } }, "required": [ "tenantId" ] } }, "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", "STRING_LIST", "DATE", "LONG" ] }, "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": { "userNameFilter": { "type": "array", "items": { "type": "string" } }, "userFilterPath": { "type": "string" }, "isUserNameOnS3": { "type": "boolean" }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFilePathPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFilePathPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } } }, "required": [] }, "enableIdentityCrawler": { "type": "boolean" }, "type": { "type": "string", "pattern": "ONEDRIVEV2" }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

Microsoft SharePoint 템플릿 스키마

데이터 소스 스키마를 TemplateConfiguration개체의 일부로 포함하는 JSON을 포함합니다. SharePoint 사이트 URL/URL, 도메인 및 필요한 경우 연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 테넌트 ID를 제공합니다. 또한 데이터 소스 유형으로 SHAREPOINTV2, 보안 인증 정보의 암호 및 기타 필수 구성을 지정합니다. 그런 다음 호출할 TEMPLATE유형으로 지정합니다. CreateDataSource

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. SharePoint JSON 스키마를 참조하세요.

다음 표에서는 Microsoft SharePoint JSON 스키마의 매개 변수에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보
tenantId SharePoint 계정의 테넌트 ID.
도메인 SharePoint 계정의 도메인.
siteUrls SharePoint 계정의 호스트 URL.
repositoryAdditionalProperties 리포지토리/데이터 소스 엔드포인트와 연결하기 위한 추가 속성.
s3bucketName Azure AD 자체 서명 Amazon S3 X.509 인증서를 저장하는 버킷의 이름입니다.
s3certificateName 버킷에 저장된 Azure AD 자체 서명 X.509 인증서의 이름입니다. Amazon S3
authType 사용하는 인증 유형 (예:,,, OAuth2 OAuth2CertificateOAuth2App, Basic 또는) OAuth2_RefreshToken NTLM Kerberos
version 사용하는 SharePoint 버전 (Server또는 Online 여부)
onPremVersion 사용하는 SharePoint 서버 버전 (예: 2013 20162019, 또는SubscriptionEdition)
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
  • 이벤트

  • 페이지를 방문하십시오

  • 파일

  • link

  • attachment

  • 설명

SharePoint콘텐츠의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 개체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
  • eventTitleFilterRegEx

  • pageTitleFilterRegEx

  • linkTitleFilterRegEx

  • inclusionFilePath

  • exclusionFilePath

  • inclusionFileType패턴

  • exclusionFileType패턴

  • inclusionFileName패턴

  • exclusionFileName패턴

  • inclusionOneNoteSectionNamePatterns

  • exclusionOneNoteSectionNamePatterns

  • inclusionOneNotePageNamePatterns

  • exclusionOneNotePageNamePatterns

데이터 원본에 특정 콘텐츠를 포함/제외하기 위한 정규 표현식 패턴 목록입니다. SharePoint 포함 패턴과 일치하는 콘텐츠 항목이 색인에 포함됩니다. 포함 패턴과 일치하지 않는 콘텐츠 항목은 색인에서 제외됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
  • crawlFiles

  • crawlPages

  • crawlEvents

  • crawlComments

  • crawlLinks

  • crawlAttachments

true이러한 유형의 콘텐츠를 크롤링하기 위해서입니다.
crawlAcl trueACL이 있고 액세스 제어에 사용하려는 경우 문서에 대한 액세스 제어 목록 (ACL) 정보를 크롤링합니다. ACL은 사용자와 그룹이 액세스하고 검색할 수 있는 문서를 지정합니다. ACL 정보는 검색 결과를 문서에 대한 사용자 또는 그룹의 액세스 권한을 기준으로 필터링하는 데 사용됩니다. 자세한 내용은 사용자 컨텍스트 필터링을 참조하세요.
fieldForUserId 사용자 ID로 사용자 이메일을 사용할지, 아니면 userPrincipalName 사용자 ID로 사용자 이름을 사용할지를 지정하십시오. email 옵션을 지정하지 않는 경우 기본적으로 email 이 옵션이 사용됩니다.
aclConfiguration ACLWithLDAPEmailFmtACLWithManualEmailFmt, 또는 중 하나를 지정합니다ACLWithUsernameFmtM.
emailDomain 이메일의 도메인. 예: “amazon.com”.
  • isCrawlLocalGroupMapping

  • isCrawlAdGroupMapping

true그룹 매핑 정보를 크롤링하기 위해서입니다.
proxyHost http://또는 https://프로토콜을 사용하지 않고 사용하는 웹 프록시의 호스트 이름.
proxyPort 호스트 URL 전송 프로토콜에서 사용하는 포트 번호입니다. 이 값은 0~65535의 숫자 값이어야 합니다.
type SHAREPOINTV2를 데이터 소스 유형으로 지정합니다.
enableIdentityCrawler true Amazon Kendra의 ID 크롤러를 사용하여 사용자 및 그룹의 ID/주체 정보를 특정 문서에 대한 액세스 권한과 동기화합니다. ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 PutPrincipalMappingAPI를 사용하여 사용자 및 그룹 액세스 정보를 업로드할 수도 있습니다.
syncMode

데이터 소스 콘텐츠가 Amazon Kendra 변경될 때 색인을 업데이트하는 방법을 지정하십시오. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretARN 연결에 필요한 키-값 쌍이 포함된 AWS Secrets Manager 비밀의 Amazon 리소스 이름 (ARN). SharePoint 이러한 키-값 쌍에 대한 자세한 내용은 온라인 및 서버의 연결 지침을 참조하십시오. SharePoint SharePoint
version 현재 지원되는 이 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "tenantId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "domain": { "type": "string" }, "siteUrls": { "type": "array", "items": { "type": "string", "pattern": "https://.*" } }, "repositoryAdditionalProperties": { "type": "object", "properties": { "s3bucketName": { "type": "string" }, "s3certificateName": { "type": "string" }, "authType": { "type": "string", "enum": [ "OAuth2", "OAuth2Certificate", "OAuth2App", "Basic", "OAuth2_RefreshToken", "NTLM", "Kerberos" ] }, "version": { "type": "string", "enum": [ "Server", "Online" ] }, "onPremVersion": { "type": "string", "enum": [ "", "2013", "2016", "2019", "SubscriptionEdition" ] } }, "required": [ "authType", "version" ] } }, "required": [ "siteUrls", "domain", "repositoryAdditionalProperties" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "event": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "page": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "file": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "link": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "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", "STRING_LIST", "DATE" ] }, "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": { "eventTitleFilterRegEx": { "type": "array", "items": { "type": "string" } }, "pageTitleFilterRegEx": { "type": "array", "items": { "type": "string" } }, "linkTitleFilterRegEx": { "type": "array", "items": { "type": "string" } }, "inclusionFilePath": { "type": "array", "items": { "type": "string" } }, "exclusionFilePath": { "type": "array", "items": { "type": "string" } }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "crawlFiles": { "type": "boolean" }, "crawlPages": { "type": "boolean" }, "crawlEvents": { "type": "boolean" }, "crawlComments": { "type": "boolean" }, "crawlLinks": { "type": "boolean" }, "crawlAttachments": { "type": "boolean" }, "crawlListData": { "type": "boolean" }, "crawlAcl": { "type": "boolean" }, "fieldForUserId": { "type": "string" }, "aclConfiguration": { "type": "string", "enum": [ "ACLWithLDAPEmailFmt", "ACLWithManualEmailFmt", "ACLWithUsernameFmt" ] }, "emailDomain": { "type": "string" }, "isCrawlLocalGroupMapping": { "type": "boolean" }, "isCrawlAdGroupMapping": { "type": "boolean" }, "proxyHost": { "type": "string" }, "proxyPort": { "type": "string" } }, "required": [ ] }, "type": { "type": "string", "pattern": "SHAREPOINTV2" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "enableIdentityCrawler", "syncMode", "additionalProperties", "secretArn", "type" ] }

Microsoft SQL Server 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 개체의 TemplateConfiguration일부로 포함합니다. 데이터 소스로 JDBC, 데이터 소스 유형으로 sqlserver, 보안 인증 정보의 암호, 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Microsoft SQL Server JSON 스키마를 참조하세요.

다음 표에서는 마이크로소프트 SQL Server JSON 스키마의 매개 변수에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스 연결을 위한 필수 구성 정보.
  • DBType - 사용하는 Java 데이터베이스의 유형 (,,, 또는) mysql db2 postgresql oracle sqlserver

  • dbHost - 데이터베이스 호스트 이름.

  • dbPort - 데이터베이스 포트.

  • dbInstance - 데이터베이스 인스턴스.

repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다. 데이터 소스 유형과 비밀 ARN을 지정합니다.

문서

데이터베이스 콘텐츠의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 객체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션. 데이터베이스 데이터 소스에 특정 콘텐츠를 포함하거나 제외하는 데 사용합니다.
primaryKeys 데이터베이스 테이블의 기본 키를 입력합니다. 이는 데이터베이스 내의 테이블을 식별합니다.
titleColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
bodyColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
sqlQuery SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
timestampColumn 타임스탬프가 포함된 열의 이름을 입력합니다. Amazon Kendra 타임스탬프 정보를 사용하여 콘텐츠의 변경 사항을 감지하고 변경된 콘텐츠만 동기화합니다.
timestampFormat 콘텐츠 변경 사항을 감지하고 콘텐츠를 다시 동기화하는 데 사용할 타임스탬프 형식이 포함된 열의 이름을 입력합니다.
timezone 콘텐츠를 크롤링할 시간대가 포함된 열의 이름을 입력합니다.
changeDetectingColumns 콘텐츠 변경을 감지하는 Amazon Kendra 데 사용할 열 이름을 입력합니다. Amazon Kendra 이러한 열에 변경 사항이 있을 경우 콘텐츠를 다시 인덱싱합니다.
allowedUsersColumns 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
allowedGroupsColumn 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
sourceURIColumn 인덱싱할 소스 URL이 포함된 열의 이름을 입력합니다.
isSslEnabled SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
type 데이터 소스의 유형. JDBC을 데이터 소스 유형으로 지정합니다.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정하세요. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretArn 데이터베이스에 연결하는 데 필요한 사용자 이름 및 암호가 포함된 Secrets Manager 보안 암호의 Amazon 리소스 이름(ARN)입니다. 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "user name": "database user name", "password": "password" }
version 현재 지원되는 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

Microsoft Teams 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 TemplateConfiguration개체의 일부로 포함합니다. 테넌트 ID는 연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 제공합니다. 또한 데이터 소스 유형으로 MSTEAMS, 보안 인증 정보의 암호 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Microsoft Teams JSON 스키마를 참조하세요.

다음 표는 Microsoft Teams JSON 스키마의 매개 변수에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보.
tenantId Microsoft 365 테넌트 ID. 테넌트 ID는 Azure Active Directory 포털의 속성 또는 OAuth 애플리케이션에서 찾을 수 있습니다.
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
  • chatMessage

  • chatAttachment

  • channelPost

  • channelWiki

  • channelAttachment

  • meetingChat

  • meetingFile

  • meetingNote

  • calendarMeeting

Microsoft Teams 콘텐츠의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 개체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
paymentModel Microsoft Teams 데이터 소스와 함께 사용할 결제 모델 유형을 지정합니다. 모델 A 결제 모델은 보안 준수가 필요한 라이선싱 및 결제 모델로 제한됩니다. 모델 B 결제 모델은 보안 준수가 필요하지 않은 라이선싱 및 결제 모델에 적합합니다.
  • inclusionTeamName필터

  • inclusionChannelName필터

  • inclusionFileName패턴

  • inclusionFileType패턴

  • inclusionUserEmail필터

  • inclusionOneNoteSectionNamePatterns

  • inclusionOneNotePageNamePatterns

Microsoft Teams 데이터 소스에서 특정 콘텐츠를 포함하는 정규식 패턴 목록. 패턴과 일치하는 콘텐츠는 인덱스에 포함됩니다. 패턴과 일치하지 않는 콘텐츠는 인덱스에서 제외됩니다. 콘텐츠가 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 콘텐츠는 인덱스에 포함되지 않습니다.
  • exclusionTeamName필터

  • exclusionChannelName필터

  • exclusionFileName패턴

  • exclusionFileType패턴

  • exclusionUserEmail필터

  • exclusionOneNoteSectionNamePatterns

  • exclusionOneNotePageNamePatterns

Microsoft Teams 데이터 소스에서 특정 콘텐츠를 제외하는 정규식 패턴 목록. 패턴과 일치하는 콘텐츠는 인덱스에서 제외됩니다. 패턴과 일치하지 않는 콘텐츠는 인덱스에 포함됩니다. 콘텐츠가 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 콘텐츠는 인덱스에 포함되지 않습니다.
  • isCrawlChat메시지

  • isCrawlChat첨부파일

  • isCrawlChannel포스트

  • isCrawlChannel첨부

  • isCrawlChannel위키

  • isCrawlCalendar미팅

  • isCrawlMeeting채팅

  • isCrawlMeeting파일

  • isCrawlMeeting노트

trueMicrosoft Teams 데이터 원본에서 이러한 유형의 콘텐츠를 크롤링할 수 있습니다.
startCalendarDate소요 시간 일정 콘텐츠의 특정 시작 날짜/시간을 구성할 수 있습니다.
endCalendarDate시간 일정 콘텐츠의 특정 종료 날짜/시간을 구성할 수 있습니다.
type 데이터 소스의 유형. MSTEAMS을 데이터 소스 유형으로 지정합니다.
enableIdentityCrawler true Amazon Kendra의 ID 크롤러를 사용하여 사용자 및 그룹의 ID/주체 정보를 특정 문서에 대한 액세스 권한과 동기화합니다. ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 PutPrincipalMappingAPI를 사용하여 사용자 및 그룹 액세스 정보를 업로드할 수도 있습니다.
syncMode

데이터 소스 콘텐츠가 Amazon Kendra 변경될 때 색인을 업데이트하는 방법을 지정하십시오. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretArn Microsoft Teams에 연결하는 데 필요한 키-값 쌍이 포함된 AWS Secrets Manager 시크릿의 Amazon 리소스 이름 (ARN). 여기에는 Azure 포털에서 OAuth 애플리케이션을 만들 때 생성되는 클라이언트 ID와 클라이언트 암호가 포함됩니다.
version 현재 지원되는 이 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "tenantId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 } }, "required": [ "tenantId" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "chatMessage": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "chatAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "channelPost": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "channelWiki": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "channelAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "meetingChat": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "meetingFile": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "meetingNote": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "calendarMeeting": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "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": { "paymentModel": { "type": "string", "enum": [ "A", "B", "Evaluation Mode" ] }, "inclusionTeamNameFilter": { "type": "array", "items": { "type": "string" } }, "exclusionTeamNameFilter": { "type": "array", "items": { "type": "string" } }, "inclusionChannelNameFilter": { "type": "array", "items": { "type": "string" } }, "exclusionChannelNameFilter": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionUserEmailFilter": { "type": "array", "items": { "type": "string" } }, "inclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "isCrawlChatMessage": { "type": "boolean" }, "isCrawlChatAttachment": { "type": "boolean" }, "isCrawlChannelPost": { "type": "boolean" }, "isCrawlChannelAttachment": { "type": "boolean" }, "isCrawlChannelWiki": { "type": "boolean" }, "isCrawlCalendarMeeting": { "type": "boolean" }, "isCrawlMeetingChat": { "type": "boolean" }, "isCrawlMeetingFile": { "type": "boolean" }, "isCrawlMeetingNote": { "type": "boolean" }, "startCalendarDateTime": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "endCalendarDateTime": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] } }, "required": [] }, "type": { "type": "string", "pattern": "MSTEAMS" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

Microsoft Yammer 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 객체의 일부로 포함합니다. TemplateConfiguration 데이터 소스 유형으로 YAMMER, 보안 인증 정보의 암호 및 기타 필수 구성을 지정합니다. 그런 다음 CreateDataSource호출할 때 TEMPLATE Type으로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다.

다음 표에서는 Microsoft Yammer JSON 스키마의 매개 변수에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스에 대한 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보. 이 데이터 소스는 repositoryEndpointMetadata에 엔드포인트를 지정하지 않습니다. 대신 사용자가 제공하는 AWS Secrets Manager 암호에 연결 정보가 포함됩니다. secretArn
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
  • community

  • 사용자

  • message

  • attachment

Amazon Kendra 인덱스 필드 이름에 Microsoft Yammer 콘텐츠의 속성 또는 필드 이름을 매핑하는 객체의 목록. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
inclusionPatterns Microsoft Yammer 데이터 소스에서 특정 파일을 포함하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에 포함됩니다. 패턴과 일치하지 않는 파일은 인덱스에서 제외됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
exclusionPatterns Microsoft Yammer 데이터 소스에서 특정 파일을 제외하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에서 제외됩니다. 패턴과 일치하지 않는 파일은 인덱스에 포함됩니다. 파일이 제외 및 포함 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
sinceDate Microsoft Yammer 커넥터가 특정 sinceDate 기반으로 콘텐츠를 크롤링하도록 sinceDate 파라미터를 구성하도록 선택할 수 있습니다.
communityNameFilter 특정 커뮤니티 콘텐츠를 인덱싱하도록 선택할 수 있습니다.
  • isCrawlMessage

  • isCrawlAttachment

  • isCrawlPrivate메시지

true메시지, 메시지 첨부 파일, 개인 메시지를 크롤링합니다.
type YAMMER을 데이터 소스 유형으로 지정합니다.
secretARN Microsoft Yammer에 연결하는 데 필요한 키-값 쌍이 포함된 AWS Secrets Manager 시크릿의 Amazon 리소스 이름 (ARN) 입니다. 여기에는 Azure 포털에서 OAuth 애플리케이션을 만들 때 생성되는 Microsoft Yammer 사용자 이름과 암호, 클라이언트 ID와 클라이언트 암호가 포함됩니다.
useChangeLog trueMicrosoft Yammer 변경 로그를 사용하여 색인에서 업데이트가 필요한 문서를 결정할 수 있습니다.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정합니다. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

enableIdentityCrawler true Amazon Kendra의 ID 크롤러를 사용하여 특정 문서에 대한 액세스 권한이 있는 사용자 및 그룹의 ID/주체 정보를 동기화하는 데 사용합니다. ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 PutPrincipalMappingAPI를 사용하여 사용자 및 그룹 액세스 정보를 업로드할 수도 있습니다.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { } } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "community": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "user": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "message": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "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": { "inclusionPatterns": { "type": "array" }, "exclusionPatterns": { "type": "array" }, "sinceDate": { "type": "string", "pattern": "^(19|2[0-9])[0-9]{2}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])((\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]))?$" }, "communityNameFilter": { "type": "array", "items": { "type": "string" } }, "isCrawlMessage": { "type": "boolean" }, "isCrawlAttachment": { "type": "boolean" }, "isCrawlPrivateMessage": { "type": "boolean" } }, "required": [ "sinceDate" ] }, "type": { "type": "string", "pattern": "YAMMER" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 }, "useChangeLog": { "type": "string", "enum": [ "true", "false" ] }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "enableIdentityCrawler": { "type": "boolean" }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] } }, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "type", "secretArn", "syncMode" ] }

MySQL 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 개체의 일부로 포함시키십시오. TemplateConfiguration 데이터 소스로 JDBC, 데이터 소스 유형으로 mysql, 보안 인증 정보의 암호, 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. MySQL JSON 스키마를 참조하세요.

다음 표는 MySQL JSON 스키마의 매개 변수를 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스 연결을 위한 필수 구성 정보.
  • DBType - 사용하는 자바 데이터베이스 유형 (,,mysql, db2 또는). postgresql oracle sqlserver

  • dbHost - 데이터베이스 호스트 이름.

  • dbPort - 데이터베이스 포트.

  • dbInstance - 데이터베이스 인스턴스.

repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다. 데이터 소스 유형과 비밀 ARN을 지정합니다.

문서

데이터베이스 콘텐츠의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 객체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션. 데이터베이스 데이터 소스에 특정 콘텐츠를 포함하거나 제외하는 데 사용합니다.
primaryKeys 데이터베이스 테이블의 기본 키를 입력합니다. 이는 데이터베이스 내의 테이블을 식별합니다.
titleColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
bodyColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
sqlQuery SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
timestampColumn 타임스탬프가 포함된 열의 이름을 입력합니다. Amazon Kendra 타임스탬프 정보를 사용하여 콘텐츠의 변경 사항을 감지하고 변경된 콘텐츠만 동기화합니다.
timestampFormat 콘텐츠 변경 사항을 감지하고 콘텐츠를 다시 동기화하는 데 사용할 타임스탬프 형식이 포함된 열의 이름을 입력합니다.
timezone 콘텐츠를 크롤링할 시간대가 포함된 열의 이름을 입력합니다.
changeDetectingColumns 콘텐츠 변경을 감지하는 Amazon Kendra 데 사용할 열 이름을 입력합니다. Amazon Kendra 이러한 열에 변경 사항이 있을 경우 콘텐츠를 다시 인덱싱합니다.
allowedUsersColumns 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
allowedGroupsColumn 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
sourceURIColumn 인덱싱할 소스 URL이 포함된 열의 이름을 입력합니다.
isSslEnabled SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
type 데이터 소스의 유형. JDBC을 데이터 소스 유형으로 지정합니다.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정하세요. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretArn 데이터베이스에 연결하는 데 필요한 사용자 이름 및 암호가 포함된 Secrets Manager 보안 암호의 Amazon 리소스 이름(ARN)입니다. 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "user name": "database user name", "password": "password" }
version 현재 지원되는 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

Oracle Database 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 TemplateConfiguration개체의 일부로 포함합니다. 데이터 소스로 JDBC, 데이터 소스 유형으로 oracle, 보안 인증 정보의 암호, 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Oracle Database JSON 스키마를 참조하세요.

다음 표에서는 Oracle 데이터베이스 JSON 스키마의 매개변수를 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스 연결을 위한 필수 구성 정보.
  • DBType - 사용하는 Java 데이터베이스 유형 (,, mysqldb2, postgresql 또는) oracle sqlserver

  • dbHost - 데이터베이스 호스트 이름.

  • dbPort - 데이터베이스 포트.

  • dbInstance - 데이터베이스 인스턴스.

repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다. 데이터 소스 유형과 비밀 ARN을 지정합니다.

문서

데이터베이스 콘텐츠의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 객체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션. 데이터베이스 데이터 소스에 특정 콘텐츠를 포함하거나 제외하는 데 사용합니다.
primaryKeys 데이터베이스 테이블의 기본 키를 입력합니다. 이는 데이터베이스 내의 테이블을 식별합니다.
titleColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
bodyColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
sqlQuery SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
timestampColumn 타임스탬프가 포함된 열의 이름을 입력합니다. Amazon Kendra 타임스탬프 정보를 사용하여 콘텐츠의 변경 사항을 감지하고 변경된 콘텐츠만 동기화합니다.
timestampFormat 콘텐츠 변경 사항을 감지하고 콘텐츠를 다시 동기화하는 데 사용할 타임스탬프 형식이 포함된 열의 이름을 입력합니다.
timezone 콘텐츠를 크롤링할 시간대가 포함된 열의 이름을 입력합니다.
changeDetectingColumns 콘텐츠 변경을 감지하는 Amazon Kendra 데 사용할 열 이름을 입력합니다. Amazon Kendra 이러한 열에 변경 사항이 있을 경우 콘텐츠를 다시 인덱싱합니다.
allowedUsersColumns 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
allowedGroupsColumn 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
sourceURIColumn 인덱싱할 소스 URL이 포함된 열의 이름을 입력합니다.
isSslEnabled SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
type 데이터 소스의 유형. JDBC을 데이터 소스 유형으로 지정합니다.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정하세요. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretArn 데이터베이스에 연결하는 데 필요한 사용자 이름 및 암호가 포함된 Secrets Manager 보안 암호의 Amazon 리소스 이름(ARN)입니다. 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "user name": "database user name", "password": "password" }
version 현재 지원되는 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

PostgreSQL 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 TemplateConfiguration개체의 일부로 포함합니다. 데이터 소스로 JDBC, 데이터 소스 유형으로 postgresql, 보안 인증 정보의 암호, 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. PostgreSQL JSON 스키마를 참조하세요.

다음 표에서는 PostgreSQL JSON 스키마의 매개 변수에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스 연결을 위한 필수 구성 정보.
  • DBType - 사용하는 자바 데이터베이스 유형 (,,, 또는). mysql db2 postgresql oracle sqlserver

  • dbHost - 데이터베이스 호스트 이름.

  • dbPort - 데이터베이스 포트.

  • dbInstance - 데이터베이스 인스턴스.

repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다. 데이터 소스 유형과 비밀 ARN을 지정합니다.

문서

데이터베이스 콘텐츠의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 객체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션. 데이터베이스 데이터 소스에 특정 콘텐츠를 포함하거나 제외하는 데 사용합니다.
primaryKeys 데이터베이스 테이블의 기본 키를 입력합니다. 이는 데이터베이스 내의 테이블을 식별합니다.
titleColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
bodyColumn 데이터베이스 테이블에 있는 문서 제목 열의 이름을 입력합니다.
sqlQuery SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
timestampColumn 타임스탬프가 포함된 열의 이름을 입력합니다. Amazon Kendra 타임스탬프 정보를 사용하여 콘텐츠의 변경 사항을 감지하고 변경된 콘텐츠만 동기화합니다.
timestampFormat 콘텐츠 변경 사항을 감지하고 콘텐츠를 다시 동기화하는 데 사용할 타임스탬프 형식이 포함된 열의 이름을 입력합니다.
timezone 콘텐츠를 크롤링할 시간대가 포함된 열의 이름을 입력합니다.
changeDetectingColumns 콘텐츠 변경을 감지하는 Amazon Kendra 데 사용할 열 이름을 입력합니다. Amazon Kendra 이러한 열에 변경 사항이 있을 경우 콘텐츠를 다시 인덱싱합니다.
allowedUsersColumns 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
allowedGroupsColumn 콘텐츠에 대한 액세스를 허용할 사용자 ID가 포함된 열의 이름을 입력합니다.
sourceURIColumn 인덱싱할 소스 URL이 포함된 열의 이름을 입력합니다.
isSslEnabled SELECT 및 JOIN 연산과 같은 SQL 쿼리 문을 입력합니다. SQL 쿼리는 32KB 미만이어야 합니다. Amazon Kendra 쿼리와 일치하는 모든 데이터베이스 콘텐츠를 크롤링합니다.
type 데이터 소스의 유형. JDBC을 데이터 소스 유형으로 지정합니다.
syncMode

데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정하세요. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretArn 데이터베이스에 연결하는 데 필요한 사용자 이름 및 암호가 포함된 Secrets Manager 보안 암호의 Amazon 리소스 이름(ARN)입니다. 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "user name": "database user name", "password": "password" }
version 현재 지원되는 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

Salesforce 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 TemplateConfiguration개체의 일부로 포함합니다. Salesforce 호스트 URL은 연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 제공합니다. 또한 데이터 소스 유형으로 SALESFORCEV2, 보안 인증 정보의 암호 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Salesforce JSON 스키마를 참조하세요.

다음 표에서는 Salesforce JSON 스키마의 매개 변수에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보.
hostUrl 인덱싱할 Salesforce 인스턴스의 URL.
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
  • account

  • contact

  • campaign

  • case

  • product

  • lead

  • contract

  • partner

  • profile

  • idea

  • pricebook

  • task

  • 솔루션

  • attachment

  • 사용자

  • 문서

  • knowledgeArticles

  • 그룹

  • opportunity

  • chatter

  • customEntity

Salesforce 엔티티의 속성 또는 필드 이름을 인덱스 필드 이름에 매핑하는 개체 목록입니다. Amazon Kendra 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
secretARN Salesforce에 연결하는 데 필요한 키-값 쌍이 포함된 AWS Secrets Manager 비밀의 Amazon 리소스 이름 (ARN). 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "authenticationUrl": "OAUTH endpoint that Amazon Kendra connects to get an OAUTH token", "consumerKey": "Application public key generated when you created your Salesforce application", "consumerSecret": "Application private key generated when you created your Salesforce application", "password": "Password associated with the user logging in to the Salesforce instance", "securityToken": "Token associated with the user account logging in to the Salesforce instance", "username": "User name of the user logging in to the Salesforce instance" }
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
  • accountFilter

  • contactFilter

  • caseFilter

  • campaignFilter

  • contractFilter

  • groupFilter

  • leadFilter

  • productFilter

  • opportunityFilter

  • partnerFilter

  • pricebookFilter

  • ideaFilter

  • profileFilter

  • taskFilter

  • solutionFilter

  • userFilter

  • chatterFilter

  • documentFilter

  • knowledgeArticleFilter

  • customEntities

필터링할 항목을 지정하는 문자열 모음.

inclusionPatterns

  • inclusionDocumentFileTypePatterns

  • inclusionDocumentFileNamePatterns

  • inclusionAccountFileTypePatterns

  • inclusionCampaignFileTypePatterns

  • inclusionDocumentFileNamePatterns

  • inclusionCampaignFileNamePatterns

  • inclusionCaseFileTypePatterns

  • inclusionCaseFileNamePatterns

  • inclusionContactFileTypePatterns

  • inclusionContractFileNamePatterns

  • inclusionLeadFileTypePatterns

  • inclusionLeadFileNamePatterns

  • inclusionOpportunityFileTypePatterns

  • inclusionOpportunityFileNamePatterns

  • inclusionSolutionFileTypePatterns

  • inclusionSolutionFileNamePatterns

  • inclusionTaskFileTypePatterns

  • inclusionTaskFileNamePatterns

  • inclusionGroupFileTypePatterns

  • inclusionGroupFileNamePatterns

  • inclusionChatterFileTypePatterns

  • inclusionChatterFileNamePatterns

  • inclusionCustomEntityFileTypePatterns

  • inclusionCustomEntityFileNamePatterns

Salesforce 데이터 소스에서 특정 파일을 포함하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에 포함됩니다. 패턴과 일치하지 않는 파일은 인덱스에서 제외됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.

exclusionPatterns

  • exclusionDocumentFileTypePatterns

  • exclusionDocumentFileNamePatterns

  • exclusionAccountFileTypePatterns

  • exclusionCampaignFileTypePatterns

  • exclusionCampaignFileNamePatterns

  • exclusionCaseFileTypePatterns

  • exclusionCaseFileNamePatterns

  • exclusionContactFileTypePatterns

  • exclusionContractFileNamePatterns

  • exclusionLeadFileTypePatterns

  • exclusionLeadFileNamePatterns

  • exclusionOpportunityFileTypePatterns

  • exclusionOpportunityFileNamePatterns

  • exclusionSolutionFileTypePatterns

  • exclusionSolutionFileNamePatterns

  • exclusionTaskFileTypePatterns

  • exclusionTaskFileNamePatterns

  • exclusionGroupFileTypePatterns

  • exclusionGroupFileNamePatterns

  • exclusionChatterFileTypePatterns

  • exclusionChatterFileNamePatterns

  • exclusionCustomEntityFileTypePatterns

  • exclusionCustomEntityFileNamePatterns

Salesforce 데이터 소스에서 특정 파일을 제외하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에서 제외됩니다. 패턴과 일치하지 않는 파일은 인덱스에 포함됩니다. 파일이 제외 및 포함 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
  • isCrawlAccount

  • isCrawlContact

  • isCrawlCase

  • isCrawlCampaign

  • isCrawlProduct

  • isCrawlLead

  • isCrawlContract

  • isCrawlPartner

  • isCrawlProfile

  • isCrawlIdea

  • isCrawlPricebook

  • isCrawlDocument

  • crawlSharedDocument

  • isCrawlGroup

  • isCrawlOpportunity

  • isCrawlChatter

  • isCrawlUser

  • isCrawlSolution

  • isCrawlTask

  • isCrawlAccount첨부 파일

  • isCrawlContact첨부파일

  • isCrawlCase첨부파일

  • isCrawlCampaign첨부파일

  • isCrawlLead첨부파일

  • isCrawlContract첨부파일

  • isCrawlGroup첨부파일

  • isCrawlOpportunity첨부파일

  • isCrawlChatter첨부파일

  • isCrawlSolution첨부파일

  • isCrawlTask첨부파일

  • isCrawlCustomEntityAttachments

  • isCrawlKnowledge기사

    • isCrawlDraft

    • isCrawlPublish

    • isCrawlArchived

trueSalesforce 계정에서 이러한 유형의 파일을 크롤링하려면
type 데이터 소스의 유형. SALESFORCEV2을 데이터 소스 유형으로 지정합니다.
enableIdentityCrawler true Amazon Kendra의 ID 크롤러를 사용하여 사용자 및 그룹의 ID/주체 정보를 특정 문서에 대한 액세스 권한과 동기화합니다. ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 PutPrincipalMappingAPI를 사용하여 사용자 및 그룹 액세스 정보를 업로드할 수도 있습니다.
syncMode

데이터 소스 콘텐츠가 Amazon Kendra 변경될 때 색인을 업데이트하는 방법을 지정하십시오. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

version 현재 지원되는 이 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "https:.*" } }, "required": [ "hostUrl" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "account": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "contact": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "campaign": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "case": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "product": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "lead": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "contract": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "partner": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "profile": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "idea": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "pricebook": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "task": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "solution": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "user": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "knowledgeArticles": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "group": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "opportunity": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "chatter": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "customEntity": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "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": { "accountFilter":{ "type": "array", "items": { "type": "string" } }, "contactFilter":{ "type": "array", "items": { "type": "string" } }, "caseFilter":{ "type": "array", "items": { "type": "string" } }, "campaignFilter":{ "type": "array", "items": { "type": "string" } }, "contractFilter":{ "type": "array", "items": { "type": "string" } }, "groupFilter":{ "type": "array", "items": { "type": "string" } }, "leadFilter":{ "type": "array", "items": { "type": "string" } }, "productFilter":{ "type": "array", "items": { "type": "string" } }, "opportunityFilter":{ "type": "array", "items": { "type": "string" } }, "partnerFilter":{ "type": "array", "items": { "type": "string" } }, "pricebookFilter":{ "type": "array", "items": { "type": "string" } }, "ideaFilter":{ "type": "array", "items": { "type": "string" } }, "profileFilter":{ "type": "array", "items": { "type": "string" } }, "taskFilter":{ "type": "array", "items": { "type": "string" } }, "solutionFilter":{ "type": "array", "items": { "type": "string" } }, "userFilter":{ "type": "array", "items": { "type": "string" } }, "chatterFilter":{ "type": "array", "items": { "type": "string" } }, "documentFilter":{ "type": "array", "items": { "type": "string" } }, "knowledgeArticleFilter":{ "type": "array", "items": { "type": "string" } }, "customEntities":{ "type": "array", "items": { "type": "string" } }, "isCrawlAccount": { "type": "boolean" }, "isCrawlContact": { "type": "boolean" }, "isCrawlCase": { "type": "boolean" }, "isCrawlCampaign": { "type": "boolean" }, "isCrawlProduct": { "type": "boolean" }, "isCrawlLead": { "type": "boolean" }, "isCrawlContract": { "type": "boolean" }, "isCrawlPartner": { "type": "boolean" }, "isCrawlProfile": { "type": "boolean" }, "isCrawlIdea": { "type": "boolean" }, "isCrawlPricebook": { "type": "boolean" }, "isCrawlDocument": { "type": "boolean" }, "crawlSharedDocument": { "type": "boolean" }, "isCrawlGroup": { "type": "boolean" }, "isCrawlOpportunity": { "type": "boolean" }, "isCrawlChatter": { "type": "boolean" }, "isCrawlUser": { "type": "boolean" }, "isCrawlSolution":{ "type": "boolean" }, "isCrawlTask":{ "type": "boolean" }, "isCrawlAccountAttachments": { "type": "boolean" }, "isCrawlContactAttachments": { "type": "boolean" }, "isCrawlCaseAttachments": { "type": "boolean" }, "isCrawlCampaignAttachments": { "type": "boolean" }, "isCrawlLeadAttachments": { "type": "boolean" }, "isCrawlContractAttachments": { "type": "boolean" }, "isCrawlGroupAttachments": { "type": "boolean" }, "isCrawlOpportunityAttachments": { "type": "boolean" }, "isCrawlChatterAttachments": { "type": "boolean" }, "isCrawlSolutionAttachments":{ "type": "boolean" }, "isCrawlTaskAttachments":{ "type": "boolean" }, "isCrawlCustomEntityAttachments":{ "type": "boolean" }, "isCrawlKnowledgeArticles": { "type": "object", "properties": { "isCrawlDraft": { "type": "boolean" }, "isCrawlPublish": { "type": "boolean" }, "isCrawlArchived": { "type": "boolean" } } }, "inclusionDocumentFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionDocumentFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionDocumentFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionDocumentFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionAccountFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionAccountFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionAccountFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionAccountFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionCampaignFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionCampaignFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionCampaignFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionCampaignFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionCaseFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionCaseFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionCaseFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionCaseFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionContactFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionContactFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionContactFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionContactFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionContractFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionContractFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionContractFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionContractFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionLeadFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionLeadFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionLeadFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionLeadFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionOpportunityFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionOpportunityFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionOpportunityFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionOpportunityFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionSolutionFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionSolutionFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionSolutionFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionSolutionFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionTaskFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionTaskFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionTaskFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionTaskFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionGroupFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionGroupFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionGroupFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionGroupFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionChatterFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionChatterFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionChatterFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionChatterFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionCustomEntityFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionCustomEntityFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionCustomEntityFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionCustomEntityFileNamePatterns":{ "type": "array", "items": { "type": "string" } } }, "required": [] }, "enableIdentityCrawler": { "type": "boolean" }, "type": { "type": "string", "pattern": "SALESFORCEV2" }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

ServiceNow 템플릿 스키마

데이터 소스 스키마를 TemplateConfiguration개체의 일부로 포함하는 JSON을 포함합니다. 연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 ServiceNow 호스트 URL, 인증 유형 및 인스턴스 버전을 제공합니다. 또한 데이터 소스 유형으로 SERVICENOWV2, 보안 인증 정보의 암호 및 기타 필수 구성을 지정합니다. 그런 다음 Type 호출할 때 TEMPLATE 로 지정합니다 CreateDataSource.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. ServiceNow JSON 스키마를 참조하세요.

다음 표에서는 ServiceNow JSON 스키마의 파라미터에 대해 설명합니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보.
hostUrl ServiceNow 호스트 URL. 예: your-domain.service-now.com.
authType 사용하는 인증 유형(basicAuth 또는 OAuth2).
servicenowInstanceVersion 사용하는 ServiceNow 버전. Tokyo,, SandiegoRome, 중에서 선택할 수 있습니다Others.
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
  • knowledgeArticle

  • attachment

  • serviceCatalog

  • incident

ServiceNow참조 문서, 첨부 파일, 서비스 카탈로그 및 인시던트의 속성 또는 필드 이름을 Amazon Kendra 색인 필드 이름에 매핑하는 개체 목록입니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요. ServiceNow 데이터 원본 필드 이름은 ServiceNow 사용자 지정 메타데이터에 있어야 합니다.
additional properties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
maxFileSizeInMegaBytes Amazon Kendra가 크롤링할 파일 크기 제한을 MB 단위로 지정합니다. Amazon Kendra는 사용자가 정의한 크기 제한 내에 있는 파일만 크롤링합니다. 기본 파일 크기는 50MB입니다. 최대 파일 크기는 0MB보다 크고 50MB보다 작거나 같아야 합니다.
  • knowledgeArticleFilter

  • incidentQueryFilter

  • serviceCatalogQuery필터

  • knowledgeArticleTitleRegExp

  • serviceCatalogTitleRegExp

  • incidentTitleReg경험치

  • inclusionFileType패턴

  • exclusionFileType패턴

  • inclusionFileName패턴

  • exclusionFileName패턴

  • incidentStateType

ServiceNow 데이터 원본에 특정 파일을 포함 및/또는 제외하기 위한 정규 표현식 패턴 목록입니다. 패턴과 일치하는 파일은 인덱스에 포함됩니다. 패턴과 일치하지 않는 파일은 인덱스에서 제외됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
  • isCrawlKnowledge기사

  • isCrawlKnowledgeArticleAttachment

  • includePublicArticles전용

  • isCrawlService카탈로그

  • isCrawlServiceCatalogAttachment

  • isCrawlActiveServiceCatalog

  • isCrawlInactiveServiceCatalog

  • isCrawlIncident

  • isCrawlIncident첨부파일

  • isCrawlActive인시던트

  • isCrawlInactive인시던트

  • ACL 적용하기 ForKnowledgeArticle

  • ACL 적용하기 ForServiceCatalog

  • ACL 적용하기 ForIncident

true ServiceNow 지식 문서, 서비스 카탈로그, 인시던트 및 첨부 파일을 크롤링합니다.
type 데이터 소스의 유형. SERVICENOWV2을 데이터 소스 유형으로 지정합니다.
enableIdentityCrawler true Amazon Kendra의 ID 크롤러를 사용하여 사용자 및 그룹의 ID/주체 정보를 특정 문서에 대한 액세스 권한과 동기화합니다. ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 PutPrincipalMappingAPI를 사용하여 사용자 및 그룹 액세스 정보를 업로드할 수도 있습니다.
syncMode

데이터 소스 콘텐츠가 Amazon Kendra 변경될 때 색인을 업데이트하는 방법을 지정하십시오. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

secretARN 연결에 필요한 키-값 쌍이 포함된 AWS Secrets Manager 비밀의 Amazon 리소스 이름 (ARN). ServiceNow 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "username": "user name", "password": "password" }
OAuth2 인증을 사용하는 경우 암호에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.
{ "username": "user name", "password": "password", "clientId": "client id", "clientSecret": "client secret" }
version 현재 지원되는 템플릿의 버전.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "^(?!(^(https?|ftp|file):\/\/))[a-z0-9-]+(.service-now.com|.servicenowservices.com)$", "minLength": 1, "maxLength": 2048 }, "authType": { "type": "string", "enum": [ "basicAuth", "OAuth2" ] }, "servicenowInstanceVersion": { "type": "string", "enum": [ "Tokyo", "Sandiego", "Rome", "Others" ] } }, "required": [ "hostUrl", "authType", "servicenowInstanceVersion" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "knowledgeArticle": { "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" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "LONG", "DATE", "STRING_LIST" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "serviceCatalog": { "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" ] }, "incident": { "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" }, "isCrawlKnowledgeArticle": { "type": "boolean" }, "isCrawlKnowledgeArticleAttachment": { "type": "boolean" }, "includePublicArticlesOnly": { "type": "boolean" }, "knowledgeArticleFilter": { "type": "string" }, "incidentQueryFilter": { "type": "string" }, "serviceCatalogQueryFilter": { "type": "string" }, "isCrawlServiceCatalog": { "type": "boolean" }, "isCrawlServiceCatalogAttachment": { "type": "boolean" }, "isCrawlActiveServiceCatalog": { "type": "boolean" }, "isCrawlInactiveServiceCatalog": { "type": "boolean" }, "isCrawlIncident": { "type": "boolean" }, "isCrawlIncidentAttachment": { "type": "boolean" }, "isCrawlActiveIncident": { "type": "boolean" }, "isCrawlInactiveIncident": { "type": "boolean" }, "applyACLForKnowledgeArticle": { "type": "boolean" }, "applyACLForServiceCatalog": { "type": "boolean" }, "applyACLForIncident": { "type": "boolean" }, "incidentStateType": { "type": "array", "items": { "type": "string", "enum": [ "Open", "Open - Unassigned", "Resolved", "All" ] } }, "knowledgeArticleTitleRegExp": { "type": "string" }, "serviceCatalogTitleRegExp": { "type": "string" }, "incidentTitleRegExp": { "type": "string" }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } } }, "required": [] }, "type": { "type": "string", "pattern": "SERVICENOWV2" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }

슬랙 템플릿 스키마

데이터 소스 스키마를 객체의 TemplateConfiguration일부로 포함하는 JSON을 포함합니다. 호스트 URL은 연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 제공합니다. 또한 데이터 소스 유형으로 SLACK, 보안 인증 정보의 암호 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. 슬랙 JSON 스키마를 참조하세요.

다음 표에는 Slack JSON 스키마의 파라미터가 설명되어 있습니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보.
팀 ID 슬랙 메인 페이지 URL에서 복사한 슬랙 팀 ID.
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
모두 Slack콘텐츠의 속성 또는 필드 이름을 Amazon Kendra 인덱스 필드 이름에 매핑하는 객체 목록입니다.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
inclusionPatterns Slack데이터 원본에 특정 콘텐츠를 포함하기 위한 정규 표현식 패턴 목록입니다. 패턴과 일치하는 콘텐츠는 인덱스에 포함됩니다. 패턴과 일치하지 않는 콘텐츠는 인덱스에서 제외됩니다. 포함 패턴과 제외 패턴 모두에 일치하는 콘텐츠가 있는 경우 제외 패턴이 우선하며 콘텐츠는 색인에 포함되지 않습니다.
exclusionPatterns 데이터 원본에서 특정 콘텐츠를 제외하기 위한 정규 표현식 패턴 목록입니다. Slack 패턴과 일치하는 콘텐츠는 인덱스에서 제외됩니다. 패턴과 일치하지 않는 콘텐츠는 색인에 포함됩니다. 포함 패턴과 제외 패턴 모두에 일치하는 콘텐츠가 있는 경우 제외 패턴이 우선하며 해당 콘텐츠는 색인에 포함되지 않습니다.
crawlBotMessages true봇 메시지를 크롤링하기 위해서입니다.
제외/보관됨 true보관된 메시지의 크롤링을 제외하려면
대화 유형 인덱싱하려는 대화 유형 (PUBLIC_CHANNEL, 및 PRIVATE_CHANNEL 여부). GROUP_MESSAGE DIRECT_MESSAGE
채널 필터 색인을 생성할지 여부에 관계없이 private_channel 인덱싱하려는 채널 유형입니다. public_channel
sinceDate Slack커넥터가 특정 내용을 기반으로 콘텐츠를 크롤링하도록 sinceDate 매개 변수를 구성하도록 선택할 수 있습니다. sinceDate
룩백 커넥터가 마지막 Slack 커넥터 동기화 전까지 지정된 시간까지 업데이트 또는 삭제된 콘텐츠를 크롤링하도록 lookBack 매개변수를 구성할 수 있습니다.
syncMode

데이터 원본 콘텐츠가 Amazon Kendra 변경될 때 색인을 업데이트하는 방법을 지정합니다. 다음 중에서 선택할 수 있습니다.

  • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

  • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하려는 경우 Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

type 데이터 소스의 유형. SLACK을 데이터 소스 유형으로 지정합니다.
enableIdentityCrawler true Amazon Kendra의 ID 크롤러를 사용하여 특정 문서에 대한 액세스 권한이 있는 사용자 및 그룹의 ID/주체 정보를 동기화하는 데 사용합니다. ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 PutPrincipalMappingAPI를 사용하여 사용자 및 그룹 액세스 정보를 업로드할 수도 있습니다.
secretArn

연결에 필요한 키-값 쌍이 포함된 AWS Secrets Manager 비밀의 Amazon 리소스 이름 (ARN). Slack 비밀에는 다음 키가 있는 JSON 구조가 포함되어야 합니다.

{ "slackToken": "token" }
version 현재 지원되는 이 템플릿의 버전입니다.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "teamId": { "type": "string" } }, "required": ["teamId"] } } }, "repositoryConfigurations": { "type": "object", "properties": { "All": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE","LONG"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "exclusionPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionPatterns": { "type": "array", "items": { "type": "string" } }, "crawlBotMessages": { "type": "boolean" }, "excludeArchived": { "type": "boolean" }, "conversationType": { "type": "array", "items": { "type": "string", "enum": [ "PUBLIC_CHANNEL", "PRIVATE_CHANNEL", "GROUP_MESSAGE", "DIRECT_MESSAGE" ] } }, "channelFilter": { "type": "object", "properties": { "private_channel": { "type": "array", "items": { "type": "string" } }, "public_channel": { "type": "array", "items": { "type": "string" } } } }, "channelIdFilter": { "type": "array", "items": { "type": "string" } }, "sinceDate": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "lookBack": { "type": "string", "pattern": "^[0-9]*$" } }, "required": [ ] }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "type" : { "type" : "string", "pattern": "SLACK" }, "enableIdentityCrawler": { "type": "boolean" }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type", "enableIdentityCrawler" ] }

Zendesk 템플릿 스키마

데이터 소스 스키마를 포함하는 JSON을 객체의 일부로 포함합니다. TemplateConfiguration 호스트 URL은 연결 구성 또는 리포지토리 엔드포인트 세부 정보의 일부로 제공합니다. 또한 데이터 소스 유형으로 ZENDESK, 보안 인증 정보의 암호 및 기타 필수 구성을 지정합니다. 그런 다음 Type CreateDataSource호출할 때 TEMPLATE 로 지정합니다.

이 개발자 안내서에 제공된 템플릿을 사용할 수 있습니다. Zendesk JSON 스키마를 참조하세요.

다음 표에는 Zendesk JSON 스키마의 파라미터가 설명되어 있습니다.

구성 설명
connectionConfiguration 데이터 소스의 엔드포인트의 구성 정보.
repositoryEndpointMetadata 데이터 소스의 엔드포인트 정보.
hostURL Zendesk 호스트 URL. 예: https://yoursubdomain.zendesk.com.
repositoryConfigurations 데이터 소스 콘텐츠의 구성 정보. 특정 유형의 콘텐츠 및 필드 매핑을 구성하는 경우를 예로 들 수 있습니다.
  • ticket

  • ticketComment

  • ticketCommentAttachment

  • article

  • articleComment

  • articleAttachment

  • communityTopic

  • communityPostComment

Amazon Kendra 인덱스 필드 이름에 Zendesk 티켓의 속성 또는 필드 이름을 매핑하는 객체의 목록. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.
secretARN Zendesk에 연결하는 데 필요한 키-값 쌍이 포함된 AWS Secrets Manager 비밀번호의 Amazon 리소스 이름 (ARN). 암호에는 호스트 URL, 클라이언트 ID, 클라이언트 암호, 사용자 이름 및 암호 키로 구성된 JSON 구조가 포함되어야 합니다.
additionalProperties 데이터 소스의 콘텐츠에 대한 추가 구성 옵션.
organizationNameFilter 특정 조직 내에 있는 티켓을 인덱싱하도록 선택할 수 있습니다.
sinceDate Zendesk 커넥터가 특정 sinceDate 기반으로 콘텐츠를 크롤링하도록 sinceDate 파라미터를 구성하도록 선택할 수 있습니다.
inclusionPatterns Zendesk 데이터 소스에서 특정 파일을 포함하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에 포함됩니다. 패턴과 일치하지 않는 파일은 인덱스에서 제외됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
exclusionPatterns Zendesk 데이터 소스에서 특정 파일을 제외하는 정규식 패턴 목록. 패턴과 일치하는 파일은 인덱스에서 제외됩니다. 패턴과 일치하지 않는 파일은 인덱스에 포함됩니다. 파일이 포함 및 제외 패턴과 모두 일치하는 경우 제외 패턴이 우선 적용되고 파일은 인덱스에 포함되지 않습니다.
  • isCrawlTicket

  • isCrawlTicket댓글 달기

  • isCrawlTicketCommentAttachment

  • isCrawlArticle

  • isCrawlArticle코멘트

  • isCrawlArticle첨부파일

  • isCrawlCommunity주제

  • isCrawlCommunity포스트

  • isCrawlCommunityPostComment

이러한 유형의 콘텐츠를 크롤링하려면 true "“를 입력하세요.
type ZENDESK을 데이터 소스 유형으로 지정합니다.
useChangeLog Zendesk 변경 로그를 사용하여 색인에서 업데이트가 필요한 문서를 결정하려면 true "“를 입력하세요. 변경 로그의 크기에 따라 Zendesk에서 문서를 스캔하는 것이 더 빠를 수 있습니다. Zendesk 데이터 소스를 인덱스와 처음으로 동기화하는 경우 모든 문서가 스캔됩니다.
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "https:.*" } }, "required": [ "hostUrl" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "ticket": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "ticketComment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "ticketCommentAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "article": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "communityPostComment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "articleComment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "articleAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "communityTopic": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] } } }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 }, "additionalProperties": { "type": "object", "properties": { "organizationNameFilter": { "type": "array" }, "sinceDate": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$" }, "inclusionPatterns": { "type": "array" }, "exclusionPatterns": { "type": "array" }, "isCrawTicket": { "type": "string" }, "isCrawTicketComment": { "type": "string" }, "isCrawTicketCommentAttachment": { "type": "string" }, "isCrawlArticle": { "type": "string" }, "isCrawlArticleAttachment": { "type": "string" }, "isCrawlArticleComment": { "type": "string" }, "isCrawlCommunityTopic": { "type": "string" }, "isCrawlCommunityPost": { "type": "string" }, "isCrawlCommunityPostComment": { "type": "string" } } }, "type": { "type": "string", "pattern": "ZENDESK" }, "useChangeLog": { "type": "string", "enum": ["true", "false"] } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "additionalProperties": false, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "useChangeLog", "secretArn", "type" ] }