ServiceNowConfiguration - Amazon Kendra

ServiceNowConfiguration

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

Contents

AuthenticationType

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. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.

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.

Type: String

Valid Values: HTTP_BASIC | OAUTH2

Required: No

HostUrl

The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^(?!(^(https?|ftp|file):\/\/))[a-z0-9-]+(\.service-now\.com)$

Required: Yes

KnowledgeArticleConfiguration

Configuration information for crawling knowledge articles in the ServiceNow site.

Type: ServiceNowKnowledgeArticleConfiguration object

Required: No

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. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Authentication for a ServiceNow data source.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1284.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

ServiceCatalogConfiguration

Configuration information for crawling service catalogs in the ServiceNow site.

Type: ServiceNowServiceCatalogConfiguration object

Required: No

ServiceNowBuildVersion

The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.

Type: String

Valid Values: LONDON | OTHERS

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: