class Aws::Kendra::Types::ServiceNowConfiguration
Provides configuration information required to connect to a ServiceNow data source.
@note When making an API call, you may pass ServiceNowConfiguration
data as a hash: { host_url: "ServiceNowHostUrl", # required secret_arn: "SecretArn", # required service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS knowledge_article_configuration: { crawl_attachments: false, include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"], exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"], document_data_field_name: "DataSourceFieldName", # required document_title_field_name: "DataSourceFieldName", field_mappings: [ { data_source_field_name: "DataSourceFieldName", # required date_field_format: "DataSourceDateFieldFormat", index_field_name: "IndexFieldName", # required }, ], filter_query: "ServiceNowKnowledgeArticleFilterQuery", }, service_catalog_configuration: { crawl_attachments: false, include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"], exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"], document_data_field_name: "DataSourceFieldName", # required document_title_field_name: "DataSourceFieldName", field_mappings: [ { data_source_field_name: "DataSourceFieldName", # required date_field_format: "DataSourceDateFieldFormat", index_field_name: "IndexFieldName", # required }, ], }, authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2 }
@!attribute [rw] host_url
The ServiceNow instance that the data source connects to. The host endpoint should look like the following: `\{instance\}.service-now.com.` @return [String]
@!attribute [rw] secret_arn
The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. @return [String]
@!attribute [rw] service_now_build_version
The identifier of the release that the ServiceNow host is running. If the host is not running the `LONDON` release, use `OTHERS`. @return [String]
@!attribute [rw] knowledge_article_configuration
Provides configuration information for crawling knowledge articles in the ServiceNow site. @return [Types::ServiceNowKnowledgeArticleConfiguration]
@!attribute [rw] service_catalog_configuration
Provides configuration information for crawling service catalogs in the ServiceNow site. @return [Types::ServiceNowServiceCatalogConfiguration]
@!attribute [rw] authentication_type
Determines the type of authentication used to connect to the ServiceNow instance. If you choose `HTTP_BASIC`, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the `SecretArn` field. When you choose `OAUTH2`, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to. When you use `OAUTH2` authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see [Using a ServiceNow data source][1]. [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html @return [String]
@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowConfiguration AWS API Documentation
Constants
- SENSITIVE