Class CfnDataSource.ServiceNowConfigurationProperty

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

Inheritance

object

CfnDataSource.ServiceNowConfigurationProperty

Implements

CfnDataSource.IServiceNowConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Kendra

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDataSource.ServiceNowConfigurationProperty : CfnDataSource.IServiceNowConfigurationProperty

Syntax (vb)

Public Class CfnDataSource.ServiceNowConfigurationProperty Implements CfnDataSource.IServiceNowConfigurationProperty

Remarks

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

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

Constructors

ServiceNowConfigurationProperty()

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

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.

Constructors

ServiceNowConfigurationProperty()

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

public ServiceNowConfigurationProperty()

Remarks

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

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" }
                 }
             };

Properties

AuthenticationType

The type of authentication used to connect to the ServiceNow instance.

public string? AuthenticationType { get; set; }

Property Value

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 .

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

HostUrl

The ServiceNow instance that the data source connects to.

public string HostUrl { get; set; }

Property Value

string

Remarks

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

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

KnowledgeArticleConfiguration

Configuration information for crawling knowledge articles in the ServiceNow site.

public object? KnowledgeArticleConfiguration { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnDataSource.IServiceNowKnowledgeArticleConfigurationProperty

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.

public string SecretArn { get; set; }

Property Value

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 .

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

ServiceCatalogConfiguration

Configuration information for crawling service catalogs in the ServiceNow site.

public object? ServiceCatalogConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDataSource.IServiceNowServiceCatalogConfigurationProperty

ServiceNowBuildVersion

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

public string ServiceNowBuildVersion { get; set; }

Property Value

string

Remarks

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

Implements

CfnDataSource.IServiceNowConfigurationProperty