This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::Kendra::DataSource ServiceNowConfiguration
Provides the configuration information to connect to ServiceNow as your data source.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "AuthenticationType" :String, "HostUrl" :String, "KnowledgeArticleConfiguration" :ServiceNowKnowledgeArticleConfiguration, "SecretArn" :String, "ServiceCatalogConfiguration" :ServiceNowServiceCatalogConfiguration, "ServiceNowBuildVersion" :String}
YAML
AuthenticationType:StringHostUrl:StringKnowledgeArticleConfiguration:ServiceNowKnowledgeArticleConfigurationSecretArn:StringServiceCatalogConfiguration:ServiceNowServiceCatalogConfigurationServiceNowBuildVersion:String
Properties
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 theSecretArnfield. If you chooseOAUTH2, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.When you use
OAUTH2authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source.Required: No
Type: String
Allowed values:
HTTP_BASIC | OAUTH2Update requires: No interruption
HostUrl-
The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
Required: Yes
Type: String
Pattern:
^(?!(^(https?|ftp|file):\/\/))[a-z0-9-]+(\.service-now\.com)$Minimum:
1Maximum:
2048Update requires: No interruption
KnowledgeArticleConfiguration-
Configuration information for crawling knowledge articles in the ServiceNow site.
Required: No
Type: ServiceNowKnowledgeArticleConfiguration
Update requires: No interruption
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 Using a ServiceNow data source.
Required: Yes
Type: String
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}Minimum:
1Maximum:
1284Update requires: No interruption
ServiceCatalogConfiguration-
Configuration information for crawling service catalogs in the ServiceNow site.
Required: No
Type: ServiceNowServiceCatalogConfiguration
Update requires: No interruption
ServiceNowBuildVersion-
The identifier of the release that the ServiceNow host is running. If the host is not running the
LONDONrelease, useOTHERS.Required: Yes
Type: String
Allowed values:
LONDON | OTHERSUpdate requires: No interruption
