Package software.amazon.awscdk.services.kendra

Class CfnDataSource.ServiceNowConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.kendra.CfnDataSource.ServiceNowConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataSource.ServiceNowConfigurationProperty>

Enclosing interface:

CfnDataSource.ServiceNowConfigurationProperty

@Stability(Stable)
public static final class CfnDataSource.ServiceNowConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataSource.ServiceNowConfigurationProperty>

A builder for CfnDataSource.ServiceNowConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDataSource.ServiceNowConfigurationProperty.Builder	authenticationType(String authenticationType)	Sets the value of CfnDataSource.ServiceNowConfigurationProperty.getAuthenticationType()
CfnDataSource.ServiceNowConfigurationProperty	build()	Builds the configured instance.
CfnDataSource.ServiceNowConfigurationProperty.Builder	hostUrl(String hostUrl)	Sets the value of CfnDataSource.ServiceNowConfigurationProperty.getHostUrl()
CfnDataSource.ServiceNowConfigurationProperty.Builder	knowledgeArticleConfiguration(IResolvable knowledgeArticleConfiguration)	Sets the value of CfnDataSource.ServiceNowConfigurationProperty.getKnowledgeArticleConfiguration()
CfnDataSource.ServiceNowConfigurationProperty.Builder	knowledgeArticleConfiguration(CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty knowledgeArticleConfiguration)	Sets the value of CfnDataSource.ServiceNowConfigurationProperty.getKnowledgeArticleConfiguration()
CfnDataSource.ServiceNowConfigurationProperty.Builder	secretArn(String secretArn)	Sets the value of CfnDataSource.ServiceNowConfigurationProperty.getSecretArn()
CfnDataSource.ServiceNowConfigurationProperty.Builder	serviceCatalogConfiguration(IResolvable serviceCatalogConfiguration)	Sets the value of CfnDataSource.ServiceNowConfigurationProperty.getServiceCatalogConfiguration()
CfnDataSource.ServiceNowConfigurationProperty.Builder	serviceCatalogConfiguration(CfnDataSource.ServiceNowServiceCatalogConfigurationProperty serviceCatalogConfiguration)	Sets the value of CfnDataSource.ServiceNowConfigurationProperty.getServiceCatalogConfiguration()
CfnDataSource.ServiceNowConfigurationProperty.Builder	serviceNowBuildVersion(String serviceNowBuildVersion)	Sets the value of CfnDataSource.ServiceNowConfigurationProperty.getServiceNowBuildVersion()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

hostUrl

@Stability(Stable)
public CfnDataSource.ServiceNowConfigurationProperty.Builder hostUrl(String hostUrl)

Sets the value of CfnDataSource.ServiceNowConfigurationProperty.getHostUrl()

Parameters:

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

Returns:

this

secretArn

@Stability(Stable)
public CfnDataSource.ServiceNowConfigurationProperty.Builder secretArn(String secretArn)

Sets the value of CfnDataSource.ServiceNowConfigurationProperty.getSecretArn()

Parameters:

secretArn - The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. This parameter is required. 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:

this

serviceNowBuildVersion

@Stability(Stable)
public CfnDataSource.ServiceNowConfigurationProperty.Builder serviceNowBuildVersion(String serviceNowBuildVersion)

Sets the value of CfnDataSource.ServiceNowConfigurationProperty.getServiceNowBuildVersion()

Parameters:

serviceNowBuildVersion - The identifier of the release that the ServiceNow host is running. This parameter is required. If the host is not running the LONDON release, use OTHERS .

Returns:

this

authenticationType

@Stability(Stable)
public CfnDataSource.ServiceNowConfigurationProperty.Builder authenticationType(String authenticationType)

Sets the value of CfnDataSource.ServiceNowConfigurationProperty.getAuthenticationType()

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 AWS 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:

this

knowledgeArticleConfiguration

@Stability(Stable)
public CfnDataSource.ServiceNowConfigurationProperty.Builder knowledgeArticleConfiguration(IResolvable knowledgeArticleConfiguration)

Sets the value of CfnDataSource.ServiceNowConfigurationProperty.getKnowledgeArticleConfiguration()

Parameters:

knowledgeArticleConfiguration - Configuration information for crawling knowledge articles in the ServiceNow site.

Returns:

this

knowledgeArticleConfiguration

@Stability(Stable)
public CfnDataSource.ServiceNowConfigurationProperty.Builder knowledgeArticleConfiguration(CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty knowledgeArticleConfiguration)

Sets the value of CfnDataSource.ServiceNowConfigurationProperty.getKnowledgeArticleConfiguration()

Parameters:

knowledgeArticleConfiguration - Configuration information for crawling knowledge articles in the ServiceNow site.

Returns:

this

serviceCatalogConfiguration

@Stability(Stable)
public CfnDataSource.ServiceNowConfigurationProperty.Builder serviceCatalogConfiguration(IResolvable serviceCatalogConfiguration)

Sets the value of CfnDataSource.ServiceNowConfigurationProperty.getServiceCatalogConfiguration()

Parameters:

serviceCatalogConfiguration - Configuration information for crawling service catalogs in the ServiceNow site.

Returns:

this

serviceCatalogConfiguration

@Stability(Stable)
public CfnDataSource.ServiceNowConfigurationProperty.Builder serviceCatalogConfiguration(CfnDataSource.ServiceNowServiceCatalogConfigurationProperty serviceCatalogConfiguration)

Sets the value of CfnDataSource.ServiceNowConfigurationProperty.getServiceCatalogConfiguration()

Parameters:

serviceCatalogConfiguration - Configuration information for crawling service catalogs in the ServiceNow site.

Returns:

this

build

@Stability(Stable)
public CfnDataSource.ServiceNowConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDataSource.ServiceNowConfigurationProperty>

Returns:

a new instance of CfnDataSource.ServiceNowConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided