Package software.amazon.awscdk.services.qbusiness

Class CfnDataSourceProps.Builder

java.lang.Object

software.amazon.awscdk.services.qbusiness.CfnDataSourceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataSourceProps>

Enclosing interface:

CfnDataSourceProps

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

A builder for CfnDataSourceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDataSourceProps.Builder	applicationId(String applicationId)	Sets the value of CfnDataSourceProps.getApplicationId()
CfnDataSourceProps	build()	Builds the configured instance.
CfnDataSourceProps.Builder	configuration(Object configuration)	Sets the value of CfnDataSourceProps.getConfiguration()
CfnDataSourceProps.Builder	description(String description)	Sets the value of CfnDataSourceProps.getDescription()
CfnDataSourceProps.Builder	displayName(String displayName)	Sets the value of CfnDataSourceProps.getDisplayName()
CfnDataSourceProps.Builder	documentEnrichmentConfiguration(IResolvable documentEnrichmentConfiguration)	Sets the value of CfnDataSourceProps.getDocumentEnrichmentConfiguration()
CfnDataSourceProps.Builder	documentEnrichmentConfiguration(CfnDataSource.DocumentEnrichmentConfigurationProperty documentEnrichmentConfiguration)	Sets the value of CfnDataSourceProps.getDocumentEnrichmentConfiguration()
CfnDataSourceProps.Builder	indexId(String indexId)	Sets the value of CfnDataSourceProps.getIndexId()
CfnDataSourceProps.Builder	roleArn(String roleArn)	Sets the value of CfnDataSourceProps.getRoleArn()
CfnDataSourceProps.Builder	syncSchedule(String syncSchedule)	Sets the value of CfnDataSourceProps.getSyncSchedule()
CfnDataSourceProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnDataSourceProps.getTags()
CfnDataSourceProps.Builder	vpcConfiguration(IResolvable vpcConfiguration)	Sets the value of CfnDataSourceProps.getVpcConfiguration()
CfnDataSourceProps.Builder	vpcConfiguration(CfnDataSource.DataSourceVpcConfigurationProperty vpcConfiguration)	Sets the value of CfnDataSourceProps.getVpcConfiguration()

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

applicationId

@Stability(Stable)
public CfnDataSourceProps.Builder applicationId(String applicationId)

Sets the value of CfnDataSourceProps.getApplicationId()

Parameters:

applicationId - The identifier of the Amazon Q Business application the data source will be attached to. This parameter is required.

Returns:

this

configuration

@Stability(Stable)
public CfnDataSourceProps.Builder configuration(Object configuration)

Sets the value of CfnDataSourceProps.getConfiguration()

Parameters:

configuration - Configuration information to connect your data source repository to Amazon Q Business. This parameter is required. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.

Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:

• Amazon S3 JSON schema
• Web Crawler JSON schema

You can find configuration templates for your specific data source using the following steps:

• Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source of your choice.
• Then, from your specific data source connector page, select Using the API . You will find the JSON schema for your data source, including parameter descriptions, in this section.

Returns:

this

displayName

@Stability(Stable)
public CfnDataSourceProps.Builder displayName(String displayName)

Sets the value of CfnDataSourceProps.getDisplayName()

Parameters:

displayName - The name of the Amazon Q Business data source. This parameter is required.

Returns:

this

indexId

@Stability(Stable)
public CfnDataSourceProps.Builder indexId(String indexId)

Sets the value of CfnDataSourceProps.getIndexId()

Parameters:

indexId - The identifier of the index the data source is attached to. This parameter is required.

Returns:

this

description

@Stability(Stable)
public CfnDataSourceProps.Builder description(String description)

Sets the value of CfnDataSourceProps.getDescription()

Parameters:

description - A description for the data source connector.

Returns:

this

documentEnrichmentConfiguration

@Stability(Stable)
public CfnDataSourceProps.Builder documentEnrichmentConfiguration(IResolvable documentEnrichmentConfiguration)

Sets the value of CfnDataSourceProps.getDocumentEnrichmentConfiguration()

Parameters:

documentEnrichmentConfiguration - Provides the configuration information for altering document metadata and content during the document ingestion process. For more information, see Custom document enrichment .

Returns:

this

documentEnrichmentConfiguration

@Stability(Stable)
public CfnDataSourceProps.Builder documentEnrichmentConfiguration(CfnDataSource.DocumentEnrichmentConfigurationProperty documentEnrichmentConfiguration)

Sets the value of CfnDataSourceProps.getDocumentEnrichmentConfiguration()

Parameters:

documentEnrichmentConfiguration - Provides the configuration information for altering document metadata and content during the document ingestion process. For more information, see Custom document enrichment .

Returns:

this

roleArn

@Stability(Stable)
public CfnDataSourceProps.Builder roleArn(String roleArn)

Sets the value of CfnDataSourceProps.getRoleArn()

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

Returns:

this

syncSchedule

@Stability(Stable)
public CfnDataSourceProps.Builder syncSchedule(String syncSchedule)

Sets the value of CfnDataSourceProps.getSyncSchedule()

Parameters:

syncSchedule - Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM . If you do, you receive a ValidationException exception.

Returns:

this

tags

@Stability(Stable)
public CfnDataSourceProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnDataSourceProps.getTags()

Parameters:

tags - A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -

Returns:

this

vpcConfiguration

@Stability(Stable)
public CfnDataSourceProps.Builder vpcConfiguration(IResolvable vpcConfiguration)

Sets the value of CfnDataSourceProps.getVpcConfiguration()

Parameters:

vpcConfiguration - Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors .

Returns:

this

vpcConfiguration

@Stability(Stable)
public CfnDataSourceProps.Builder vpcConfiguration(CfnDataSource.DataSourceVpcConfigurationProperty vpcConfiguration)

Sets the value of CfnDataSourceProps.getVpcConfiguration()

Parameters:

vpcConfiguration - Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors .

Returns:

this

build

@Stability(Stable)
public CfnDataSourceProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDataSourceProps>

Returns:

a new instance of CfnDataSourceProps

Throws:

NullPointerException - if any required attribute was not provided