Package software.amazon.awssdk.services.kendra.model

Interface ServiceNowConfiguration.Builder

    • Method Detail

      • hostUrl

        ServiceNowConfiguration.Builder hostUrl​(String hostUrl)

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

        Parameters:
        hostUrl - The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secretArn

        ServiceNowConfiguration.Builder secretArn​(String secretArn)

        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.

        Parameters:
        secretArn - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serviceNowBuildVersion

        ServiceNowConfiguration.Builder serviceNowBuildVersion​(String serviceNowBuildVersion)

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

        Parameters:
        serviceNowBuildVersion - The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ServiceNowBuildVersionType, ServiceNowBuildVersionType

      • serviceNowBuildVersion

        ServiceNowConfiguration.Builder serviceNowBuildVersion​(ServiceNowBuildVersionType serviceNowBuildVersion)

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

        Parameters:
        serviceNowBuildVersion - The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ServiceNowBuildVersionType, ServiceNowBuildVersionType

      • knowledgeArticleConfiguration

        ServiceNowConfiguration.Builder knowledgeArticleConfiguration​(ServiceNowKnowledgeArticleConfiguration knowledgeArticleConfiguration)

        Configuration information for crawling knowledge articles in the ServiceNow site.

        Parameters:
        knowledgeArticleConfiguration - Configuration information for crawling knowledge articles in the ServiceNow site.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serviceCatalogConfiguration

        ServiceNowConfiguration.Builder serviceCatalogConfiguration​(ServiceNowServiceCatalogConfiguration serviceCatalogConfiguration)

        Configuration information for crawling service catalogs in the ServiceNow site.

        Parameters:
        serviceCatalogConfiguration - Configuration information for crawling service catalogs in the ServiceNow site.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • authenticationType

        ServiceNowConfiguration.Builder authenticationType​(String authenticationType)

        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.

        Parameters:
        authenticationType - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ServiceNowAuthenticationType, ServiceNowAuthenticationType

      • authenticationType

        ServiceNowConfiguration.Builder authenticationType​(ServiceNowAuthenticationType authenticationType)

        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.

        Parameters:
        authenticationType - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ServiceNowAuthenticationType, ServiceNowAuthenticationType