Skip to content
v2.278.0

ServiceNowConfigurationProperty Struct ​

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
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'],
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra

service_now_configuration_property = kendra.CfnDataSource.ServiceNowConfigurationProperty(
    host_url="hostUrl",
    secret_arn="secretArn",
    service_now_build_version="serviceNowBuildVersion",

    # the properties below are optional
    authentication_type="authenticationType",
    knowledge_article_configuration=kendra.CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty(
        document_data_field_name="documentDataFieldName",

        # the properties below are optional
        crawl_attachments=False,
        document_title_field_name="documentTitleFieldName",
        exclude_attachment_file_patterns=["excludeAttachmentFilePatterns"],
        field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
            data_source_field_name="dataSourceFieldName",
            index_field_name="indexFieldName",

            # the properties below are optional
            date_field_format="dateFieldFormat"
        )],
        filter_query="filterQuery",
        include_attachment_file_patterns=["includeAttachmentFilePatterns"]
    ),
    service_catalog_configuration=kendra.CfnDataSource.ServiceNowServiceCatalogConfigurationProperty(
        document_data_field_name="documentDataFieldName",

        # the properties below are optional
        crawl_attachments=False,
        document_title_field_name="documentTitleFieldName",
        exclude_attachment_file_patterns=["excludeAttachmentFilePatterns"],
        field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
            data_source_field_name="dataSourceFieldName",
            index_field_name="indexFieldName",

            # the properties below are optional
            date_field_format="dateFieldFormat"
        )],
        include_attachment_file_patterns=["includeAttachmentFilePatterns"]
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.kendra.*;

ServiceNowConfigurationProperty serviceNowConfigurationProperty = ServiceNowConfigurationProperty.builder()
        .hostUrl("hostUrl")
        .secretArn("secretArn")
        .serviceNowBuildVersion("serviceNowBuildVersion")

        // the properties below are optional
        .authenticationType("authenticationType")
        .knowledgeArticleConfiguration(ServiceNowKnowledgeArticleConfigurationProperty.builder()
                .documentDataFieldName("documentDataFieldName")

                // the properties below are optional
                .crawlAttachments(false)
                .documentTitleFieldName("documentTitleFieldName")
                .excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns"))
                .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                        .dataSourceFieldName("dataSourceFieldName")
                        .indexFieldName("indexFieldName")

                        // the properties below are optional
                        .dateFieldFormat("dateFieldFormat")
                        .build()))
                .filterQuery("filterQuery")
                .includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
                .build())
        .serviceCatalogConfiguration(ServiceNowServiceCatalogConfigurationProperty.builder()
                .documentDataFieldName("documentDataFieldName")

                // the properties below are optional
                .crawlAttachments(false)
                .documentTitleFieldName("documentTitleFieldName")
                .excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns"))
                .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                        .dataSourceFieldName("dataSourceFieldName")
                        .indexFieldName("indexFieldName")

                        // the properties below are optional
                        .dateFieldFormat("dateFieldFormat")
                        .build()))
                .includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;

var serviceNowConfigurationProperty = new ServiceNowConfigurationProperty {
    HostUrl = "hostUrl",
    SecretArn = "secretArn",
    ServiceNowBuildVersion = "serviceNowBuildVersion",

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

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

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

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

            // the properties below are optional
            DateFieldFormat = "dateFieldFormat"
        } },
        IncludeAttachmentFilePatterns = new [] { "includeAttachmentFilePatterns" }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

serviceNowConfigurationProperty := &ServiceNowConfigurationProperty{
	HostUrl: jsii.String("hostUrl"),
	SecretArn: jsii.String("secretArn"),
	ServiceNowBuildVersion: jsii.String("serviceNowBuildVersion"),

	// the properties below are optional
	AuthenticationType: jsii.String("authenticationType"),
	KnowledgeArticleConfiguration: &ServiceNowKnowledgeArticleConfigurationProperty{
		DocumentDataFieldName: jsii.String("documentDataFieldName"),

		// the properties below are optional
		CrawlAttachments: jsii.Boolean(false),
		DocumentTitleFieldName: jsii.String("documentTitleFieldName"),
		ExcludeAttachmentFilePatterns: []*string{
			jsii.String("excludeAttachmentFilePatterns"),
		},
		FieldMappings: []interface{}{
			&DataSourceToIndexFieldMappingProperty{
				DataSourceFieldName: jsii.String("dataSourceFieldName"),
				IndexFieldName: jsii.String("indexFieldName"),

				// the properties below are optional
				DateFieldFormat: jsii.String("dateFieldFormat"),
			},
		},
		FilterQuery: jsii.String("filterQuery"),
		IncludeAttachmentFilePatterns: []*string{
			jsii.String("includeAttachmentFilePatterns"),
		},
	},
	ServiceCatalogConfiguration: &ServiceNowServiceCatalogConfigurationProperty{
		DocumentDataFieldName: jsii.String("documentDataFieldName"),

		// the properties below are optional
		CrawlAttachments: jsii.Boolean(false),
		DocumentTitleFieldName: jsii.String("documentTitleFieldName"),
		ExcludeAttachmentFilePatterns: []*string{
			jsii.String("excludeAttachmentFilePatterns"),
		},
		FieldMappings: []interface{}{
			&DataSourceToIndexFieldMappingProperty{
				DataSourceFieldName: jsii.String("dataSourceFieldName"),
				IndexFieldName: jsii.String("indexFieldName"),

				// the properties below are optional
				DateFieldFormat: jsii.String("dateFieldFormat"),
			},
		},
		IncludeAttachmentFilePatterns: []*string{
			jsii.String("includeAttachmentFilePatterns"),
		},
	},
}

Properties ​

authenticationTypeoptionalstringauthentication_typeoptionalstrauthenticationTypeoptionalStringAuthenticationTypeoptionalstringAuthenticationTypeoptional*string #
The type of authentication used to connect to the ServiceNow instance.
notes

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 .

hostUrlstringhost_urlstrhostUrlStringHostUrlstringHostUrl*string required #
The ServiceNow instance that the data source connects to.

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

knowledgeArticleConfigurationoptionalIResolvable | CfnDataSource.ServiceNowKnowledgeArticleConfigurationPropertyknowledge_article_configurationoptionaltyping.Union[IResolvable, ServiceNowKnowledgeArticleConfigurationProperty]knowledgeArticleConfigurationoptionalIResolvableKnowledgeArticleConfigurationoptionalIResolvableKnowledgeArticleConfigurationoptionalinterface{} #
Configuration information for crawling knowledge articles in the ServiceNow site.
secretArnstringsecret_arnstrsecretArnStringSecretArnstringSecretArn*string required #
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.
notes

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 .

serviceCatalogConfigurationoptionalIResolvable | CfnDataSource.ServiceNowServiceCatalogConfigurationPropertyservice_catalog_configurationoptionaltyping.Union[IResolvable, ServiceNowServiceCatalogConfigurationProperty]serviceCatalogConfigurationoptionalIResolvableServiceCatalogConfigurationoptionalIResolvableServiceCatalogConfigurationoptionalinterface{} #
Configuration information for crawling service catalogs in the ServiceNow site.
serviceNowBuildVersionstringservice_now_build_versionstrserviceNowBuildVersionStringServiceNowBuildVersionstringServiceNowBuildVersion*string required #
The identifier of the release that the ServiceNow host is running.

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