Package software.amazon.awscdk.cfnpropertymixins.services.kendra

Class CfnDataSourceMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.kendra.CfnDataSourceMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataSourceMixinProps>

Enclosing interface:

CfnDataSourceMixinProps

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

A builder for CfnDataSourceMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDataSourceMixinProps	build()	Builds the configured instance.
CfnDataSourceMixinProps.Builder	customDocumentEnrichmentConfiguration(CfnDataSourcePropsMixin.CustomDocumentEnrichmentConfigurationProperty customDocumentEnrichmentConfiguration)	Sets the value of CfnDataSourceMixinProps.getCustomDocumentEnrichmentConfiguration()
CfnDataSourceMixinProps.Builder	customDocumentEnrichmentConfiguration(IResolvable customDocumentEnrichmentConfiguration)	Sets the value of CfnDataSourceMixinProps.getCustomDocumentEnrichmentConfiguration()
CfnDataSourceMixinProps.Builder	dataSourceConfiguration(CfnDataSourcePropsMixin.DataSourceConfigurationProperty dataSourceConfiguration)	Sets the value of CfnDataSourceMixinProps.getDataSourceConfiguration()
CfnDataSourceMixinProps.Builder	dataSourceConfiguration(IResolvable dataSourceConfiguration)	Sets the value of CfnDataSourceMixinProps.getDataSourceConfiguration()
CfnDataSourceMixinProps.Builder	description(String description)	Sets the value of CfnDataSourceMixinProps.getDescription()
CfnDataSourceMixinProps.Builder	indexId(String indexId)	Sets the value of CfnDataSourceMixinProps.getIndexId()
CfnDataSourceMixinProps.Builder	indexId(IIndexRef indexId)	Sets the value of CfnDataSourceMixinProps.getIndexId()
CfnDataSourceMixinProps.Builder	languageCode(String languageCode)	Sets the value of CfnDataSourceMixinProps.getLanguageCode()
CfnDataSourceMixinProps.Builder	name(String name)	Sets the value of CfnDataSourceMixinProps.getName()
CfnDataSourceMixinProps.Builder	roleArn(String roleArn)	Sets the value of CfnDataSourceMixinProps.getRoleArn()
CfnDataSourceMixinProps.Builder	roleArn(IRoleRef roleArn)	Sets the value of CfnDataSourceMixinProps.getRoleArn()
CfnDataSourceMixinProps.Builder	schedule(String schedule)	Sets the value of CfnDataSourceMixinProps.getSchedule()
CfnDataSourceMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnDataSourceMixinProps.getTags()
CfnDataSourceMixinProps.Builder	type(String type)	Sets the value of CfnDataSourceMixinProps.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

customDocumentEnrichmentConfiguration

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

Sets the value of CfnDataSourceMixinProps.getCustomDocumentEnrichmentConfiguration()

Parameters:

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

Returns:

this

customDocumentEnrichmentConfiguration

@Stability(Stable)
public CfnDataSourceMixinProps.Builder customDocumentEnrichmentConfiguration(CfnDataSourcePropsMixin.CustomDocumentEnrichmentConfigurationProperty customDocumentEnrichmentConfiguration)

Sets the value of CfnDataSourceMixinProps.getCustomDocumentEnrichmentConfiguration()

Parameters:

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

Returns:

this

dataSourceConfiguration

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

Sets the value of CfnDataSourceMixinProps.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 CfnDataSourceMixinProps.Builder dataSourceConfiguration(CfnDataSourcePropsMixin.DataSourceConfigurationProperty dataSourceConfiguration)

Sets the value of CfnDataSourceMixinProps.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 CfnDataSourceMixinProps.Builder description(String description)

Sets the value of CfnDataSourceMixinProps.getDescription()

Parameters:

description - A description for the data source connector.

Returns:

this

indexId

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

Sets the value of CfnDataSourceMixinProps.getIndexId()

Parameters:

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

Returns:

this

indexId

@Stability(Stable)
public CfnDataSourceMixinProps.Builder indexId(IIndexRef indexId)

Sets the value of CfnDataSourceMixinProps.getIndexId()

Parameters:

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

Returns:

this

languageCode

@Stability(Stable)
public CfnDataSourceMixinProps.Builder languageCode(String languageCode)

Sets the value of CfnDataSourceMixinProps.getLanguageCode()

Parameters:

languageCode - The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .

Returns:

this

name

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

Sets the value of CfnDataSourceMixinProps.getName()

Parameters:

name - The name of the data source.

Returns:

this

roleArn

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

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

roleArn

@Stability(Stable)
public CfnDataSourceMixinProps.Builder roleArn(IRoleRef roleArn)

Sets the value of CfnDataSourceMixinProps.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 CfnDataSourceMixinProps.Builder schedule(String schedule)

Sets the value of CfnDataSourceMixinProps.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 CfnDataSourceMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnDataSourceMixinProps.getTags()

Parameters:

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

Returns:

this

type

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

Sets the value of CfnDataSourceMixinProps.getType()

Parameters:

type - The type of the data source.

Returns:

this

build

@Stability(Stable)
public CfnDataSourceMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDataSourceMixinProps

Throws:

NullPointerException - if any required attribute was not provided