Package software.amazon.awscdk.mixins.preview.services.kendra.mixins

Class CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.mixins.preview.services.kendra.mixins.CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnDataSourcePropsMixin.ServiceNowConfigurationProperty

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

A builder for CfnDataSourcePropsMixin.ServiceNowConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.Builder	authenticationType(String authenticationType)	Sets the value of CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.getAuthenticationType()
CfnDataSourcePropsMixin.ServiceNowConfigurationProperty	build()	Builds the configured instance.
CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.Builder	hostUrl(String hostUrl)	Sets the value of CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.getHostUrl()
CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.Builder	knowledgeArticleConfiguration(IResolvable knowledgeArticleConfiguration)	Sets the value of CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.getKnowledgeArticleConfiguration()
CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.Builder	knowledgeArticleConfiguration(CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty knowledgeArticleConfiguration)	Sets the value of CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.getKnowledgeArticleConfiguration()
CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.Builder	secretArn(String secretArn)	Sets the value of CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.getSecretArn()
CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.Builder	serviceCatalogConfiguration(IResolvable serviceCatalogConfiguration)	Sets the value of CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.getServiceCatalogConfiguration()
CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.Builder	serviceCatalogConfiguration(CfnDataSourcePropsMixin.ServiceNowServiceCatalogConfigurationProperty serviceCatalogConfiguration)	Sets the value of CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.getServiceCatalogConfiguration()
CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.Builder	serviceNowBuildVersion(String serviceNowBuildVersion)	Sets the value of CfnDataSourcePropsMixin.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

authenticationType

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

Sets the value of CfnDataSourcePropsMixin.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

hostUrl

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

Sets the value of CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.getHostUrl()

Parameters:

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

Returns:

this

knowledgeArticleConfiguration

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

Sets the value of CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.getKnowledgeArticleConfiguration()

Parameters:

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

Returns:

this

knowledgeArticleConfiguration

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

Sets the value of CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.getKnowledgeArticleConfiguration()

Parameters:

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

Returns:

this

secretArn

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

Sets the value of CfnDataSourcePropsMixin.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. 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

serviceCatalogConfiguration

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

Sets the value of CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.getServiceCatalogConfiguration()

Parameters:

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

Returns:

this

serviceCatalogConfiguration

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

Sets the value of CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.getServiceCatalogConfiguration()

Parameters:

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

Returns:

this

serviceNowBuildVersion

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

Sets the value of CfnDataSourcePropsMixin.ServiceNowConfigurationProperty.getServiceNowBuildVersion()

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:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDataSourcePropsMixin.ServiceNowConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided