interface ServiceNowConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.Kendra.CfnDataSource.ServiceNowConfigurationProperty
Java	software.amazon.awscdk.services.kendra.CfnDataSource.ServiceNowConfigurationProperty
Python	aws_cdk.aws_kendra.CfnDataSource.ServiceNowConfigurationProperty
TypeScript	@aws-cdk/aws-kendra » CfnDataSource » ServiceNowConfigurationProperty

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as kendra from '@aws-cdk/aws-kendra';
const serviceNowConfigurationProperty: kendra.CfnDataSource.ServiceNowConfigurationProperty = {
  hostUrl: 'hostUrl',
  secretArn: 'secretArn',
  serviceNowBuildVersion: 'serviceNowBuildVersion',

  // the properties below are optional
  authenticationType: 'authenticationType',
  knowledgeArticleConfiguration: {
    documentDataFieldName: 'documentDataFieldName',

    // the properties below are optional
    crawlAttachments: false,
    documentTitleFieldName: 'documentTitleFieldName',
    excludeAttachmentFilePatterns: ['excludeAttachmentFilePatterns'],
    fieldMappings: [{
      dataSourceFieldName: 'dataSourceFieldName',
      indexFieldName: 'indexFieldName',

      // the properties below are optional
      dateFieldFormat: 'dateFieldFormat',
    }],
    filterQuery: 'filterQuery',
    includeAttachmentFilePatterns: ['includeAttachmentFilePatterns'],
  },
  serviceCatalogConfiguration: {
    documentDataFieldName: 'documentDataFieldName',

    // the properties below are optional
    crawlAttachments: false,
    documentTitleFieldName: 'documentTitleFieldName',
    excludeAttachmentFilePatterns: ['excludeAttachmentFilePatterns'],
    fieldMappings: [{
      dataSourceFieldName: 'dataSourceFieldName',
      indexFieldName: 'indexFieldName',

      // the properties below are optional
      dateFieldFormat: 'dateFieldFormat',
    }],
    includeAttachmentFilePatterns: ['includeAttachmentFilePatterns'],
  },
};

Properties

Name	Type	Description
hostUrl	string	The ServiceNow instance that the data source connects to.
secretArn	string	The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance.
serviceNowBuildVersion	string	The identifier of the release that the ServiceNow host is running.
authenticationType?	string	The type of authentication used to connect to the ServiceNow instance.
knowledgeArticleConfiguration?	IResolvable | ServiceNowKnowledgeArticleConfigurationProperty	Configuration information for crawling knowledge articles in the ServiceNow site.
serviceCatalogConfiguration?	IResolvable | ServiceNowServiceCatalogConfigurationProperty	Configuration information for crawling service catalogs in the ServiceNow site.

---

hostUrl

Type: string

The ServiceNow instance that the data source connects to.

The host endpoint should look like the following: {instance}.service-now.com.

---

secretArn

Type: string

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance.

You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a ServiceNow data source .

---

serviceNowBuildVersion

Type: string

The identifier of the release that the ServiceNow host is running.

If the host is not running the LONDON release, use OTHERS .

---

authenticationType?

Type: string (optional)

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. If you choose OAUTH2 , Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.

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 .

---

knowledgeArticleConfiguration?

Type: IResolvable | ServiceNowKnowledgeArticleConfigurationProperty (optional)

Configuration information for crawling knowledge articles in the ServiceNow site.

---

serviceCatalogConfiguration?

Type: IResolvable | ServiceNowServiceCatalogConfigurationProperty (optional)

Configuration information for crawling service catalogs in the ServiceNow site.