Package software.amazon.awscdk.services.kendra

Class CfnDataSource.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataSource>

Enclosing class:

CfnDataSource

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

A fluent builder for CfnDataSource.

Method Summary

Modifier and Type	Method	Description
CfnDataSource	build()
static CfnDataSource.Builder	create(software.constructs.Construct scope, String id)
CfnDataSource.Builder	customDocumentEnrichmentConfiguration(IResolvable customDocumentEnrichmentConfiguration)	Configuration information for altering document metadata and content during the document ingestion process.
CfnDataSource.Builder	customDocumentEnrichmentConfiguration(CfnDataSource.CustomDocumentEnrichmentConfigurationProperty customDocumentEnrichmentConfiguration)	Configuration information for altering document metadata and content during the document ingestion process.
CfnDataSource.Builder	dataSourceConfiguration(IResolvable dataSourceConfiguration)	Configuration information for an Amazon Kendra data source.
CfnDataSource.Builder	dataSourceConfiguration(CfnDataSource.DataSourceConfigurationProperty dataSourceConfiguration)	Configuration information for an Amazon Kendra data source.
CfnDataSource.Builder	description(String description)	A description for the data source connector.
CfnDataSource.Builder	indexId(String indexId)	The identifier of the index you want to use with the data source connector.
CfnDataSource.Builder	languageCode(String languageCode)	The code for a language.
CfnDataSource.Builder	name(String name)	The name of the data source.
CfnDataSource.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of a role with permission to access the data source.
CfnDataSource.Builder	schedule(String schedule)	Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index.
CfnDataSource.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.
CfnDataSource.Builder	type(String type)	The type of the data source.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnDataSource.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnDataSource.Builder.

indexId

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-indexid

name

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

The name of the data source.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-name

type

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

The type of the data source.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-type

customDocumentEnrichmentConfiguration

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

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

Parameters:

customDocumentEnrichmentConfiguration - Configuration information for altering document metadata and content during the document ingestion process. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-customdocumentenrichmentconfiguration

customDocumentEnrichmentConfiguration

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

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

Parameters:

customDocumentEnrichmentConfiguration - Configuration information for altering document metadata and content during the document ingestion process. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-customdocumentenrichmentconfiguration

dataSourceConfiguration

@Stability(Stable)
public CfnDataSource.Builder dataSourceConfiguration(IResolvable 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.

Parameters:

dataSourceConfiguration - Configuration information for an Amazon Kendra data source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-datasourceconfiguration

dataSourceConfiguration

@Stability(Stable)
public CfnDataSource.Builder dataSourceConfiguration(CfnDataSource.DataSourceConfigurationProperty 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.

Parameters:

dataSourceConfiguration - Configuration information for an Amazon Kendra data source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-datasourceconfiguration

description

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

A description for the data source connector.

Parameters:

description - A description for the data source connector. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-description

languageCode

@Stability(Stable)
public CfnDataSource.Builder languageCode(String 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 .

Parameters:

languageCode - The code for a language. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-languagecode

roleArn

@Stability(Stable)
public CfnDataSource.Builder roleArn(String 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.

Parameters:

roleArn - The Amazon Resource Name (ARN) of a role with permission to access the data source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-rolearn

schedule

@Stability(Stable)
public CfnDataSource.Builder schedule(String 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.

Parameters:

schedule - Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-schedule

tags

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

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-tags

build

@Stability(Stable)
public CfnDataSource build()

Specified by:

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

Returns:

a newly built instance of CfnDataSource.