Interface CfnDataSource.IServiceNowConfigurationProperty
Provides the configuration information to connect to ServiceNow as your data source.
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IServiceNowConfigurationProperty
Syntax (vb)
Public Interface IServiceNowConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// 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" }
}
};
Synopsis
Properties
AuthenticationType | The type of authentication used to connect to the ServiceNow instance. |
HostUrl | The ServiceNow instance that the data source connects to. |
KnowledgeArticleConfiguration | Configuration information for crawling knowledge articles in the ServiceNow site. |
SecretArn | 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 | Configuration information for crawling service catalogs in the ServiceNow site. |
ServiceNowBuildVersion | The identifier of the release that the ServiceNow host is running. |
Properties
AuthenticationType
The type of authentication used to connect to the ServiceNow instance.
virtual string AuthenticationType { get; }
Property Value
System.String
Remarks
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 .
HostUrl
The ServiceNow instance that the data source connects to.
string HostUrl { get; }
Property Value
System.String
Remarks
The host endpoint should look like the following: {instance}.service-now.com.
KnowledgeArticleConfiguration
Configuration information for crawling knowledge articles in the ServiceNow site.
virtual object KnowledgeArticleConfiguration { get; }
Property Value
System.Object
Remarks
SecretArn
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.
string SecretArn { get; }
Property Value
System.String
Remarks
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 .
ServiceCatalogConfiguration
Configuration information for crawling service catalogs in the ServiceNow site.
virtual object ServiceCatalogConfiguration { get; }
Property Value
System.Object
Remarks
ServiceNowBuildVersion
The identifier of the release that the ServiceNow host is running.
string ServiceNowBuildVersion { get; }
Property Value
System.String
Remarks
If the host is not running the LONDON
release, use OTHERS
.