software.amazon.awscdk.services.kendra

Interface CfnDataSource.ServiceNowConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.ServiceNowConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(value=Stable)
public static interface CfnDataSource.ServiceNowConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDataSource.ServiceNowConfigurationProperty.Builder A builder for CfnDataSource.ServiceNowConfigurationProperty
static class	CfnDataSource.ServiceNowConfigurationProperty.Jsii$Proxy An implementation for CfnDataSource.ServiceNowConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.ServiceNowConfigurationProperty.Builder	builder()
default String	getAuthenticationType() The type of authentication used to connect to the ServiceNow instance.
String	getHostUrl() The ServiceNow instance that the data source connects to.
default Object	getKnowledgeArticleConfiguration() Configuration information for crawling knowledge articles in the ServiceNow site.
String	getSecretArn() 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.
default Object	getServiceCatalogConfiguration() Configuration information for crawling service catalogs in the ServiceNow site.
String	getServiceNowBuildVersion() The identifier of the release that the ServiceNow host is running.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHostUrl

@Stability(value=Stable)
 @NotNull
String getHostUrl()

The ServiceNow instance that the data source connects to.

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

getSecretArn

@Stability(value=Stable)
 @NotNull
String getSecretArn()

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 .

getServiceNowBuildVersion

@Stability(value=Stable)
 @NotNull
String getServiceNowBuildVersion()

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

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

getAuthenticationType

@Stability(value=Stable)
 @Nullable
default String getAuthenticationType()

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 .

getKnowledgeArticleConfiguration

@Stability(value=Stable)
 @Nullable
default Object getKnowledgeArticleConfiguration()

Configuration information for crawling knowledge articles in the ServiceNow site.

getServiceCatalogConfiguration

@Stability(value=Stable)
 @Nullable
default Object getServiceCatalogConfiguration()

Configuration information for crawling service catalogs in the ServiceNow site.

builder

@Stability(value=Stable)
static CfnDataSource.ServiceNowConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.ServiceNowConfigurationProperty.Builder of CfnDataSource.ServiceNowConfigurationProperty