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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::ServiceNowConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #authentication_type ⇒ String

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

• #host_url ⇒ String

  The ServiceNow instance that the data source connects to.

• #knowledge_article_configuration ⇒ Types::ServiceNowKnowledgeArticleConfiguration

  Configuration information for crawling knowledge articles in the ServiceNow site.

• #secret_arn ⇒ String

  The Amazon Resource Name (ARN) of the Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance.

• #service_catalog_configuration ⇒ Types::ServiceNowServiceCatalogConfiguration

  Configuration information for crawling service catalogs in the ServiceNow site.

• #service_now_build_version ⇒ String

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

Instance Attribute Details

#authentication_type ⇒ String

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)

# 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_url ⇒ String

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

Returns:

• (String)

# 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_configuration ⇒ Types::ServiceNowKnowledgeArticleConfiguration

Configuration information for crawling knowledge articles in the ServiceNow site.

Returns:

• (Types::ServiceNowKnowledgeArticleConfiguration)

# 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_arn ⇒ String

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)

# 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_configuration ⇒ Types::ServiceNowServiceCatalogConfiguration

Configuration information for crawling service catalogs in the ServiceNow site.

Returns:

• (Types::ServiceNowServiceCatalogConfiguration)

# 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_version ⇒ String

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

Returns:

• (String)

# 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