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

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() `CfnDataSource.ServiceNowConfigurationProperty.AuthenticationType`.
String	getHostUrl() `CfnDataSource.ServiceNowConfigurationProperty.HostUrl`.
default Object	getKnowledgeArticleConfiguration() `CfnDataSource.ServiceNowConfigurationProperty.KnowledgeArticleConfiguration`.
String	getSecretArn() `CfnDataSource.ServiceNowConfigurationProperty.SecretArn`.
default Object	getServiceCatalogConfiguration() `CfnDataSource.ServiceNowConfigurationProperty.ServiceCatalogConfiguration`.
String	getServiceNowBuildVersion() `CfnDataSource.ServiceNowConfigurationProperty.ServiceNowBuildVersion`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAuthenticationType

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

`CfnDataSource.ServiceNowConfigurationProperty.AuthenticationType`.

getHostUrl

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

`CfnDataSource.ServiceNowConfigurationProperty.HostUrl`.

getKnowledgeArticleConfiguration

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

`CfnDataSource.ServiceNowConfigurationProperty.KnowledgeArticleConfiguration`.

getSecretArn

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

`CfnDataSource.ServiceNowConfigurationProperty.SecretArn`.

getServiceCatalogConfiguration

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

`CfnDataSource.ServiceNowConfigurationProperty.ServiceCatalogConfiguration`.

getServiceNowBuildVersion

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

`CfnDataSource.ServiceNowConfigurationProperty.ServiceNowBuildVersion`.

builder

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

Returns:

a CfnDataSource.ServiceNowConfigurationProperty.Builder of CfnDataSource.ServiceNowConfigurationProperty