Class: Aws::Kendra::Types::ServiceNowConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_typeString

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 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].

[1]: docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html

Returns:

  • (String)


9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
# File 'lib/aws-sdk-kendra/types.rb', line 9279

class ServiceNowConfiguration < Struct.new(
  :host_url,
  :secret_arn,
  :service_now_build_version,
  :knowledge_article_configuration,
  :service_catalog_configuration,
  :authentication_type)
  SENSITIVE = []
  include Aws::Structure
end

#host_urlString

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

Returns:

  • (String)


9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
# File 'lib/aws-sdk-kendra/types.rb', line 9279

class ServiceNowConfiguration < Struct.new(
  :host_url,
  :secret_arn,
  :service_now_build_version,
  :knowledge_article_configuration,
  :service_catalog_configuration,
  :authentication_type)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_article_configurationTypes::ServiceNowKnowledgeArticleConfiguration

Configuration information for crawling knowledge articles in the ServiceNow site.



9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
# File 'lib/aws-sdk-kendra/types.rb', line 9279

class ServiceNowConfiguration < Struct.new(
  :host_url,
  :secret_arn,
  :service_now_build_version,
  :knowledge_article_configuration,
  :service_catalog_configuration,
  :authentication_type)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arnString

The Amazon Resource Name (ARN) of the 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].

[1]: docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html

Returns:

  • (String)


9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
# File 'lib/aws-sdk-kendra/types.rb', line 9279

class ServiceNowConfiguration < Struct.new(
  :host_url,
  :secret_arn,
  :service_now_build_version,
  :knowledge_article_configuration,
  :service_catalog_configuration,
  :authentication_type)
  SENSITIVE = []
  include Aws::Structure
end

#service_catalog_configurationTypes::ServiceNowServiceCatalogConfiguration

Configuration information for crawling service catalogs in the ServiceNow site.



9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
# File 'lib/aws-sdk-kendra/types.rb', line 9279

class ServiceNowConfiguration < Struct.new(
  :host_url,
  :secret_arn,
  :service_now_build_version,
  :knowledge_article_configuration,
  :service_catalog_configuration,
  :authentication_type)
  SENSITIVE = []
  include Aws::Structure
end

#service_now_build_versionString

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

Returns:

  • (String)


9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
# File 'lib/aws-sdk-kendra/types.rb', line 9279

class ServiceNowConfiguration < Struct.new(
  :host_url,
  :secret_arn,
  :service_now_build_version,
  :knowledge_article_configuration,
  :service_catalog_configuration,
  :authentication_type)
  SENSITIVE = []
  include Aws::Structure
end