AWS SDK for C++  1.9.1
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::ServiceNowConfiguration Class Reference

#include <ServiceNowConfiguration.h>

Public Member Functions

 ServiceNowConfiguration ()
 
 ServiceNowConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
ServiceNowConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetHostUrl () const
 
bool HostUrlHasBeenSet () const
 
void SetHostUrl (const Aws::String &value)
 
void SetHostUrl (Aws::String &&value)
 
void SetHostUrl (const char *value)
 
ServiceNowConfigurationWithHostUrl (const Aws::String &value)
 
ServiceNowConfigurationWithHostUrl (Aws::String &&value)
 
ServiceNowConfigurationWithHostUrl (const char *value)
 
const Aws::StringGetSecretArn () const
 
bool SecretArnHasBeenSet () const
 
void SetSecretArn (const Aws::String &value)
 
void SetSecretArn (Aws::String &&value)
 
void SetSecretArn (const char *value)
 
ServiceNowConfigurationWithSecretArn (const Aws::String &value)
 
ServiceNowConfigurationWithSecretArn (Aws::String &&value)
 
ServiceNowConfigurationWithSecretArn (const char *value)
 
const ServiceNowBuildVersionTypeGetServiceNowBuildVersion () const
 
bool ServiceNowBuildVersionHasBeenSet () const
 
void SetServiceNowBuildVersion (const ServiceNowBuildVersionType &value)
 
void SetServiceNowBuildVersion (ServiceNowBuildVersionType &&value)
 
ServiceNowConfigurationWithServiceNowBuildVersion (const ServiceNowBuildVersionType &value)
 
ServiceNowConfigurationWithServiceNowBuildVersion (ServiceNowBuildVersionType &&value)
 
const ServiceNowKnowledgeArticleConfigurationGetKnowledgeArticleConfiguration () const
 
bool KnowledgeArticleConfigurationHasBeenSet () const
 
void SetKnowledgeArticleConfiguration (const ServiceNowKnowledgeArticleConfiguration &value)
 
void SetKnowledgeArticleConfiguration (ServiceNowKnowledgeArticleConfiguration &&value)
 
ServiceNowConfigurationWithKnowledgeArticleConfiguration (const ServiceNowKnowledgeArticleConfiguration &value)
 
ServiceNowConfigurationWithKnowledgeArticleConfiguration (ServiceNowKnowledgeArticleConfiguration &&value)
 
const ServiceNowServiceCatalogConfigurationGetServiceCatalogConfiguration () const
 
bool ServiceCatalogConfigurationHasBeenSet () const
 
void SetServiceCatalogConfiguration (const ServiceNowServiceCatalogConfiguration &value)
 
void SetServiceCatalogConfiguration (ServiceNowServiceCatalogConfiguration &&value)
 
ServiceNowConfigurationWithServiceCatalogConfiguration (const ServiceNowServiceCatalogConfiguration &value)
 
ServiceNowConfigurationWithServiceCatalogConfiguration (ServiceNowServiceCatalogConfiguration &&value)
 
const ServiceNowAuthenticationTypeGetAuthenticationType () const
 
bool AuthenticationTypeHasBeenSet () const
 
void SetAuthenticationType (const ServiceNowAuthenticationType &value)
 
void SetAuthenticationType (ServiceNowAuthenticationType &&value)
 
ServiceNowConfigurationWithAuthenticationType (const ServiceNowAuthenticationType &value)
 
ServiceNowConfigurationWithAuthenticationType (ServiceNowAuthenticationType &&value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 36 of file ServiceNowConfiguration.h.

Constructor & Destructor Documentation

◆ ServiceNowConfiguration() [1/2]

Aws::kendra::Model::ServiceNowConfiguration::ServiceNowConfiguration ( )

◆ ServiceNowConfiguration() [2/2]

Aws::kendra::Model::ServiceNowConfiguration::ServiceNowConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AuthenticationTypeHasBeenSet()

bool Aws::kendra::Model::ServiceNowConfiguration::AuthenticationTypeHasBeenSet ( ) const
inline

Determines 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 the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.

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.

Definition at line 288 of file ServiceNowConfiguration.h.

◆ GetAuthenticationType()

const ServiceNowAuthenticationType& Aws::kendra::Model::ServiceNowConfiguration::GetAuthenticationType ( ) const
inline

Determines 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 the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.

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.

Definition at line 273 of file ServiceNowConfiguration.h.

◆ GetHostUrl()

const Aws::String& Aws::kendra::Model::ServiceNowConfiguration::GetHostUrl ( ) const
inline

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

Definition at line 49 of file ServiceNowConfiguration.h.

◆ GetKnowledgeArticleConfiguration()

const ServiceNowKnowledgeArticleConfiguration& Aws::kendra::Model::ServiceNowConfiguration::GetKnowledgeArticleConfiguration ( ) const
inline

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

Definition at line 190 of file ServiceNowConfiguration.h.

◆ GetSecretArn()

const Aws::String& Aws::kendra::Model::ServiceNowConfiguration::GetSecretArn ( ) const
inline

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.

Definition at line 98 of file ServiceNowConfiguration.h.

◆ GetServiceCatalogConfiguration()

const ServiceNowServiceCatalogConfiguration& Aws::kendra::Model::ServiceNowConfiguration::GetServiceCatalogConfiguration ( ) const
inline

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

Definition at line 227 of file ServiceNowConfiguration.h.

◆ GetServiceNowBuildVersion()

const ServiceNowBuildVersionType& Aws::kendra::Model::ServiceNowConfiguration::GetServiceNowBuildVersion ( ) const
inline

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

Definition at line 148 of file ServiceNowConfiguration.h.

◆ HostUrlHasBeenSet()

bool Aws::kendra::Model::ServiceNowConfiguration::HostUrlHasBeenSet ( ) const
inline

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

Definition at line 55 of file ServiceNowConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::kendra::Model::ServiceNowConfiguration::Jsonize ( ) const

◆ KnowledgeArticleConfigurationHasBeenSet()

bool Aws::kendra::Model::ServiceNowConfiguration::KnowledgeArticleConfigurationHasBeenSet ( ) const
inline

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

Definition at line 196 of file ServiceNowConfiguration.h.

◆ operator=()

ServiceNowConfiguration& Aws::kendra::Model::ServiceNowConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SecretArnHasBeenSet()

bool Aws::kendra::Model::ServiceNowConfiguration::SecretArnHasBeenSet ( ) const
inline

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.

Definition at line 104 of file ServiceNowConfiguration.h.

◆ ServiceCatalogConfigurationHasBeenSet()

bool Aws::kendra::Model::ServiceNowConfiguration::ServiceCatalogConfigurationHasBeenSet ( ) const
inline

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

Definition at line 233 of file ServiceNowConfiguration.h.

◆ ServiceNowBuildVersionHasBeenSet()

bool Aws::kendra::Model::ServiceNowConfiguration::ServiceNowBuildVersionHasBeenSet ( ) const
inline

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

Definition at line 155 of file ServiceNowConfiguration.h.

◆ SetAuthenticationType() [1/2]

void Aws::kendra::Model::ServiceNowConfiguration::SetAuthenticationType ( const ServiceNowAuthenticationType value)
inline

Determines 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 the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.

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.

Definition at line 303 of file ServiceNowConfiguration.h.

◆ SetAuthenticationType() [2/2]

void Aws::kendra::Model::ServiceNowConfiguration::SetAuthenticationType ( ServiceNowAuthenticationType &&  value)
inline

Determines 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 the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.

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.

Definition at line 318 of file ServiceNowConfiguration.h.

◆ SetHostUrl() [1/3]

void Aws::kendra::Model::ServiceNowConfiguration::SetHostUrl ( Aws::String &&  value)
inline

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

Definition at line 67 of file ServiceNowConfiguration.h.

◆ SetHostUrl() [2/3]

void Aws::kendra::Model::ServiceNowConfiguration::SetHostUrl ( const Aws::String value)
inline

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

Definition at line 61 of file ServiceNowConfiguration.h.

◆ SetHostUrl() [3/3]

void Aws::kendra::Model::ServiceNowConfiguration::SetHostUrl ( const char *  value)
inline

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

Definition at line 73 of file ServiceNowConfiguration.h.

◆ SetKnowledgeArticleConfiguration() [1/2]

void Aws::kendra::Model::ServiceNowConfiguration::SetKnowledgeArticleConfiguration ( const ServiceNowKnowledgeArticleConfiguration value)
inline

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

Definition at line 202 of file ServiceNowConfiguration.h.

◆ SetKnowledgeArticleConfiguration() [2/2]

void Aws::kendra::Model::ServiceNowConfiguration::SetKnowledgeArticleConfiguration ( ServiceNowKnowledgeArticleConfiguration &&  value)
inline

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

Definition at line 208 of file ServiceNowConfiguration.h.

◆ SetSecretArn() [1/3]

void Aws::kendra::Model::ServiceNowConfiguration::SetSecretArn ( Aws::String &&  value)
inline

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.

Definition at line 116 of file ServiceNowConfiguration.h.

◆ SetSecretArn() [2/3]

void Aws::kendra::Model::ServiceNowConfiguration::SetSecretArn ( const Aws::String value)
inline

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.

Definition at line 110 of file ServiceNowConfiguration.h.

◆ SetSecretArn() [3/3]

void Aws::kendra::Model::ServiceNowConfiguration::SetSecretArn ( const char *  value)
inline

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.

Definition at line 122 of file ServiceNowConfiguration.h.

◆ SetServiceCatalogConfiguration() [1/2]

void Aws::kendra::Model::ServiceNowConfiguration::SetServiceCatalogConfiguration ( const ServiceNowServiceCatalogConfiguration value)
inline

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

Definition at line 239 of file ServiceNowConfiguration.h.

◆ SetServiceCatalogConfiguration() [2/2]

void Aws::kendra::Model::ServiceNowConfiguration::SetServiceCatalogConfiguration ( ServiceNowServiceCatalogConfiguration &&  value)
inline

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

Definition at line 245 of file ServiceNowConfiguration.h.

◆ SetServiceNowBuildVersion() [1/2]

void Aws::kendra::Model::ServiceNowConfiguration::SetServiceNowBuildVersion ( const ServiceNowBuildVersionType value)
inline

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

Definition at line 162 of file ServiceNowConfiguration.h.

◆ SetServiceNowBuildVersion() [2/2]

void Aws::kendra::Model::ServiceNowConfiguration::SetServiceNowBuildVersion ( ServiceNowBuildVersionType &&  value)
inline

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

Definition at line 169 of file ServiceNowConfiguration.h.

◆ WithAuthenticationType() [1/2]

ServiceNowConfiguration& Aws::kendra::Model::ServiceNowConfiguration::WithAuthenticationType ( const ServiceNowAuthenticationType value)
inline

Determines 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 the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.

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.

Definition at line 333 of file ServiceNowConfiguration.h.

◆ WithAuthenticationType() [2/2]

ServiceNowConfiguration& Aws::kendra::Model::ServiceNowConfiguration::WithAuthenticationType ( ServiceNowAuthenticationType &&  value)
inline

Determines 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 the SecretArn field. When you choose OAUTH2, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to.

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.

Definition at line 348 of file ServiceNowConfiguration.h.

◆ WithHostUrl() [1/3]

ServiceNowConfiguration& Aws::kendra::Model::ServiceNowConfiguration::WithHostUrl ( Aws::String &&  value)
inline

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

Definition at line 85 of file ServiceNowConfiguration.h.

◆ WithHostUrl() [2/3]

ServiceNowConfiguration& Aws::kendra::Model::ServiceNowConfiguration::WithHostUrl ( const Aws::String value)
inline

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

Definition at line 79 of file ServiceNowConfiguration.h.

◆ WithHostUrl() [3/3]

ServiceNowConfiguration& Aws::kendra::Model::ServiceNowConfiguration::WithHostUrl ( const char *  value)
inline

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

Definition at line 91 of file ServiceNowConfiguration.h.

◆ WithKnowledgeArticleConfiguration() [1/2]

ServiceNowConfiguration& Aws::kendra::Model::ServiceNowConfiguration::WithKnowledgeArticleConfiguration ( const ServiceNowKnowledgeArticleConfiguration value)
inline

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

Definition at line 214 of file ServiceNowConfiguration.h.

◆ WithKnowledgeArticleConfiguration() [2/2]

ServiceNowConfiguration& Aws::kendra::Model::ServiceNowConfiguration::WithKnowledgeArticleConfiguration ( ServiceNowKnowledgeArticleConfiguration &&  value)
inline

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

Definition at line 220 of file ServiceNowConfiguration.h.

◆ WithSecretArn() [1/3]

ServiceNowConfiguration& Aws::kendra::Model::ServiceNowConfiguration::WithSecretArn ( Aws::String &&  value)
inline

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.

Definition at line 134 of file ServiceNowConfiguration.h.

◆ WithSecretArn() [2/3]

ServiceNowConfiguration& Aws::kendra::Model::ServiceNowConfiguration::WithSecretArn ( const Aws::String value)
inline

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.

Definition at line 128 of file ServiceNowConfiguration.h.

◆ WithSecretArn() [3/3]

ServiceNowConfiguration& Aws::kendra::Model::ServiceNowConfiguration::WithSecretArn ( const char *  value)
inline

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.

Definition at line 140 of file ServiceNowConfiguration.h.

◆ WithServiceCatalogConfiguration() [1/2]

ServiceNowConfiguration& Aws::kendra::Model::ServiceNowConfiguration::WithServiceCatalogConfiguration ( const ServiceNowServiceCatalogConfiguration value)
inline

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

Definition at line 251 of file ServiceNowConfiguration.h.

◆ WithServiceCatalogConfiguration() [2/2]

ServiceNowConfiguration& Aws::kendra::Model::ServiceNowConfiguration::WithServiceCatalogConfiguration ( ServiceNowServiceCatalogConfiguration &&  value)
inline

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

Definition at line 257 of file ServiceNowConfiguration.h.

◆ WithServiceNowBuildVersion() [1/2]

ServiceNowConfiguration& Aws::kendra::Model::ServiceNowConfiguration::WithServiceNowBuildVersion ( const ServiceNowBuildVersionType value)
inline

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

Definition at line 176 of file ServiceNowConfiguration.h.

◆ WithServiceNowBuildVersion() [2/2]

ServiceNowConfiguration& Aws::kendra::Model::ServiceNowConfiguration::WithServiceNowBuildVersion ( ServiceNowBuildVersionType &&  value)
inline

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

Definition at line 183 of file ServiceNowConfiguration.h.


The documentation for this class was generated from the following file: