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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass ServiceNowConfiguration data as a hash:

{
  host_url: "ServiceNowHostUrl", # required
  secret_arn: "SecretArn", # required
  service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
  knowledge_article_configuration: {
    crawl_attachments: false,
    include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
    exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
    document_data_field_name: "DataSourceFieldName", # required
    document_title_field_name: "DataSourceFieldName",
    field_mappings: [
      {
        data_source_field_name: "DataSourceFieldName", # required
        date_field_format: "DataSourceDateFieldFormat",
        index_field_name: "IndexFieldName", # required
      },
    ],
  },
  service_catalog_configuration: {
    crawl_attachments: false,
    include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
    exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
    document_data_field_name: "DataSourceFieldName", # required
    document_title_field_name: "DataSourceFieldName",
    field_mappings: [
      {
        data_source_field_name: "DataSourceFieldName", # required
        date_field_format: "DataSourceDateFieldFormat",
        index_field_name: "IndexFieldName", # required
      },
    ],
  },
}

Provides configuration information required to connect to a ServiceNow data source.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #host_url ⇒ String

  The ServiceNow instance that the data source connects to.

• #knowledge_article_configuration ⇒ Types::ServiceNowKnowledgeArticleConfiguration

  Provides configuration information for crawling knowledge articles in the ServiceNow site.

• #secret_arn ⇒ String

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

• #service_catalog_configuration ⇒ Types::ServiceNowServiceCatalogConfiguration

  Provides 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

#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 5534

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

#knowledge_article_configuration ⇒ Types::ServiceNowKnowledgeArticleConfiguration

Provides configuration information for crawling knowledge articles in the ServiceNow site.

Returns:

• (Types::ServiceNowKnowledgeArticleConfiguration)

# File 'lib/aws-sdk-kendra/types.rb', line 5534

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

#secret_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 5534

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

#service_catalog_configuration ⇒ Types::ServiceNowServiceCatalogConfiguration

Provides configuration information for crawling service catalogs in the ServiceNow site.

Returns:

• (Types::ServiceNowServiceCatalogConfiguration)

# File 'lib/aws-sdk-kendra/types.rb', line 5534

class ServiceNowConfiguration < Struct.new(
  :host_url,
  :secret_arn,
  :service_now_build_version,
  :knowledge_article_configuration,
  :service_catalog_configuration)
  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 5534

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