Struct aws_sdk_kendra::types::ServiceNowConfiguration

#[non_exhaustive]
pub struct ServiceNowConfiguration {
    pub host_url: String,
    pub secret_arn: String,
    pub service_now_build_version: ServiceNowBuildVersionType,
    pub knowledge_article_configuration: Option<ServiceNowKnowledgeArticleConfiguration>,
    pub service_catalog_configuration: Option<ServiceNowServiceCatalogConfiguration>,
    pub authentication_type: Option<ServiceNowAuthenticationType>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

host_url: String

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

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.

service_now_build_version: ServiceNowBuildVersionType

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

knowledge_article_configuration: Option<ServiceNowKnowledgeArticleConfiguration>

Configuration information for crawling knowledge articles in the ServiceNow site.

service_catalog_configuration: Option<ServiceNowServiceCatalogConfiguration>

Configuration information for crawling service catalogs in the ServiceNow site.

authentication_type: Option<ServiceNowAuthenticationType>

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.

Implementations

impl ServiceNowConfiguration

pub fn host_url(&self) -> &str

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

pub fn secret_arn(&self) -> &str

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.

pub fn service_now_build_version(&self) -> &ServiceNowBuildVersionType

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

pub fn knowledge_article_configuration( &self ) -> Option<&ServiceNowKnowledgeArticleConfiguration>

Configuration information for crawling knowledge articles in the ServiceNow site.

pub fn service_catalog_configuration( &self ) -> Option<&ServiceNowServiceCatalogConfiguration>

Configuration information for crawling service catalogs in the ServiceNow site.

pub fn authentication_type(&self) -> Option<&ServiceNowAuthenticationType>

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.

impl ServiceNowConfiguration

pub fn builder() -> ServiceNowConfigurationBuilder

Creates a new builder-style object to manufacture ServiceNowConfiguration.

Trait Implementations

impl Clone for ServiceNowConfiguration

fn clone(&self) -> ServiceNowConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ServiceNowConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ServiceNowConfiguration

fn eq(&self, other: &ServiceNowConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ServiceNowConfiguration