interface ServiceNowConfigurationProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins.CfnDataSourcePropsMixin.ServiceNowConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awskendra/mixins#CfnDataSourcePropsMixin_ServiceNowConfigurationProperty
Java	software.amazon.awscdk.mixins.preview.services.kendra.mixins.CfnDataSourcePropsMixin.ServiceNowConfigurationProperty
Python	aws_cdk.mixins_preview.aws_kendra.mixins.CfnDataSourcePropsMixin.ServiceNowConfigurationProperty
TypeScript	@aws-cdk/mixins-preview » aws_kendra » mixins » CfnDataSourcePropsMixin » ServiceNowConfigurationProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as kendra_mixins } from '@aws-cdk/mixins-preview/aws-kendra';
const serviceNowConfigurationProperty: kendra_mixins.CfnDataSourcePropsMixin.ServiceNowConfigurationProperty = {
  authenticationType: 'authenticationType',
  hostUrl: 'hostUrl',
  knowledgeArticleConfiguration: {
    crawlAttachments: false,
    documentDataFieldName: 'documentDataFieldName',
    documentTitleFieldName: 'documentTitleFieldName',
    excludeAttachmentFilePatterns: ['excludeAttachmentFilePatterns'],
    fieldMappings: [{
      dataSourceFieldName: 'dataSourceFieldName',
      dateFieldFormat: 'dateFieldFormat',
      indexFieldName: 'indexFieldName',
    }],
    filterQuery: 'filterQuery',
    includeAttachmentFilePatterns: ['includeAttachmentFilePatterns'],
  },
  secretArn: 'secretArn',
  serviceCatalogConfiguration: {
    crawlAttachments: false,
    documentDataFieldName: 'documentDataFieldName',
    documentTitleFieldName: 'documentTitleFieldName',
    excludeAttachmentFilePatterns: ['excludeAttachmentFilePatterns'],
    fieldMappings: [{
      dataSourceFieldName: 'dataSourceFieldName',
      dateFieldFormat: 'dateFieldFormat',
      indexFieldName: 'indexFieldName',
    }],
    includeAttachmentFilePatterns: ['includeAttachmentFilePatterns'],
  },
  serviceNowBuildVersion: 'serviceNowBuildVersion',
};

Properties

Name	Type	Description
authenticationType?	string	The type of authentication used to connect to the ServiceNow instance.
hostUrl?	string	The ServiceNow instance that the data source connects to.
knowledgeArticleConfiguration?	IResolvable | ServiceNowKnowledgeArticleConfigurationProperty	Configuration information for crawling knowledge articles in the ServiceNow site.
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.
serviceCatalogConfiguration?	IResolvable | ServiceNowServiceCatalogConfigurationProperty	Configuration information for crawling service catalogs in the ServiceNow site.
serviceNowBuildVersion?	string	The identifier of the release that the ServiceNow host is running.

---

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html#cfn-kendra-datasource-servicenowconfiguration-authenticationtype

---

hostUrl?

Type: string (optional)

The ServiceNow instance that the data source connects to.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html#cfn-kendra-datasource-servicenowconfiguration-hosturl

---

knowledgeArticleConfiguration?

Type: IResolvable | ServiceNowKnowledgeArticleConfigurationProperty (optional)

Configuration information for crawling knowledge articles in the ServiceNow site.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html#cfn-kendra-datasource-servicenowconfiguration-knowledgearticleconfiguration

---

secretArn?

Type: string (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html#cfn-kendra-datasource-servicenowconfiguration-secretarn

---

serviceCatalogConfiguration?

Type: IResolvable | ServiceNowServiceCatalogConfigurationProperty (optional)

Configuration information for crawling service catalogs in the ServiceNow site.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html#cfn-kendra-datasource-servicenowconfiguration-servicecatalogconfiguration

---

serviceNowBuildVersion?

Type: string (optional)

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

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html#cfn-kendra-datasource-servicenowconfiguration-servicenowbuildversion