Package software.amazon.awscdk.services.kendra

Class CfnDataSourceProps.Builder

java.lang.Object

software.amazon.awscdk.services.kendra.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	build()	Builds the configured instance.
CfnDataSourceProps.Builder	customDocumentEnrichmentConfiguration(IResolvable customDocumentEnrichmentConfiguration)	Sets the value of CfnDataSourceProps.getCustomDocumentEnrichmentConfiguration()
CfnDataSourceProps.Builder	customDocumentEnrichmentConfiguration(CfnDataSource.CustomDocumentEnrichmentConfigurationProperty customDocumentEnrichmentConfiguration)	Sets the value of CfnDataSourceProps.getCustomDocumentEnrichmentConfiguration()
CfnDataSourceProps.Builder	dataSourceConfiguration(IResolvable dataSourceConfiguration)	Sets the value of CfnDataSourceProps.getDataSourceConfiguration()
CfnDataSourceProps.Builder	dataSourceConfiguration(CfnDataSource.DataSourceConfigurationProperty dataSourceConfiguration)	Sets the value of CfnDataSourceProps.getDataSourceConfiguration()
CfnDataSourceProps.Builder	description(String description)	Sets the value of CfnDataSourceProps.getDescription()
CfnDataSourceProps.Builder	indexId(String indexId)	Sets the value of CfnDataSourceProps.getIndexId()
CfnDataSourceProps.Builder	name(String name)	Sets the value of CfnDataSourceProps.getName()
CfnDataSourceProps.Builder	roleArn(String roleArn)	Sets the value of CfnDataSourceProps.getRoleArn()
CfnDataSourceProps.Builder	schedule(String schedule)	Sets the value of CfnDataSourceProps.getSchedule()
CfnDataSourceProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnDataSourceProps.getTags()
CfnDataSourceProps.Builder	type(String type)	Sets the value of CfnDataSourceProps.getType()

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

indexId

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

Sets the value of CfnDataSourceProps.getIndexId()

Parameters:

indexId - The identifier of the index you want to use with the data source connector. This parameter is required.

Returns:

this

name

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

Sets the value of CfnDataSourceProps.getName()

Parameters:

name - The name of the data source. This parameter is required.

Returns:

this

type

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

Sets the value of CfnDataSourceProps.getType()

Parameters:

type - The type of the data source. This parameter is required.

Returns:

this

customDocumentEnrichmentConfiguration

@Stability(Stable)
public CfnDataSourceProps.Builder customDocumentEnrichmentConfiguration(CfnDataSource.CustomDocumentEnrichmentConfigurationProperty customDocumentEnrichmentConfiguration)

Sets the value of CfnDataSourceProps.getCustomDocumentEnrichmentConfiguration()

Parameters:

customDocumentEnrichmentConfiguration - Configuration information for altering document metadata and content during the document ingestion process.

Returns:

this

customDocumentEnrichmentConfiguration

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

Sets the value of CfnDataSourceProps.getCustomDocumentEnrichmentConfiguration()

Parameters:

customDocumentEnrichmentConfiguration - Configuration information for altering document metadata and content during the document ingestion process.

Returns:

this

dataSourceConfiguration

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

Sets the value of CfnDataSourceProps.getDataSourceConfiguration()

Parameters:

dataSourceConfiguration - Configuration information for an Amazon Kendra data source. The contents of the configuration depend on the type of data source. You can only specify one type of data source in the configuration.

You can't specify the Configuration parameter when the Type parameter is set to CUSTOM .

The Configuration parameter is required for all other data sources.

Returns:

this

dataSourceConfiguration

@Stability(Stable)
public CfnDataSourceProps.Builder dataSourceConfiguration(CfnDataSource.DataSourceConfigurationProperty dataSourceConfiguration)

Sets the value of CfnDataSourceProps.getDataSourceConfiguration()

Parameters:

dataSourceConfiguration - Configuration information for an Amazon Kendra data source. The contents of the configuration depend on the type of data source. You can only specify one type of data source in the configuration.

You can't specify the Configuration parameter when the Type parameter is set to CUSTOM .

The Configuration parameter is required for all other data sources.

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

roleArn

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

Sets the value of CfnDataSourceProps.getRoleArn()

Parameters:

roleArn - The Amazon Resource Name (ARN) of a role with permission to access the data source. You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM .

The RoleArn parameter is required for all other data sources.

Returns:

this

schedule

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

Sets the value of CfnDataSourceProps.getSchedule()

Parameters:

schedule - Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index. If you don't set a schedule, Amazon Kendra doesn't periodically update the index.

Returns:

this

tags

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

Sets the value of CfnDataSourceProps.getTags()

Parameters:

tags - An array of key-value pairs to apply to this resource. For more information, see Tag .

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