Package software.amazon.awscdk.services.kendra

Class CfnThesaurus.Builder

java.lang.Object

software.amazon.awscdk.services.kendra.CfnThesaurus.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnThesaurus>

Enclosing class:

CfnThesaurus

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

A fluent builder for CfnThesaurus.

Method Summary

Modifier and Type	Method	Description
CfnThesaurus	build()
static CfnThesaurus.Builder	create(software.constructs.Construct scope, String id)
CfnThesaurus.Builder	description(String description)	A description for the thesaurus.
CfnThesaurus.Builder	indexId(String indexId)	The identifier of the index for the thesaurus.
CfnThesaurus.Builder	name(String name)	A name for the thesaurus.
CfnThesaurus.Builder	roleArn(String roleArn)	An IAM role that gives Amazon Kendra permissions to access the thesaurus file specified in SourceS3Path.
CfnThesaurus.Builder	sourceS3Path(IResolvable sourceS3Path)	Information required to find a specific file in an Amazon S3 bucket.
CfnThesaurus.Builder	sourceS3Path(CfnThesaurus.S3PathProperty sourceS3Path)	Information required to find a specific file in an Amazon S3 bucket.
CfnThesaurus.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs that identify or categorize the thesaurus.

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 CfnThesaurus.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 CfnThesaurus.Builder.

indexId

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

The identifier of the index for the thesaurus.

Parameters:

indexId - The identifier of the index for the thesaurus. This parameter is required.

Returns:

this

See Also:

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

name

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

A name for the thesaurus.

Parameters:

name - A name for the thesaurus. This parameter is required.

Returns:

this

See Also:

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

roleArn

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

An IAM role that gives Amazon Kendra permissions to access the thesaurus file specified in SourceS3Path.

Parameters:

roleArn - An IAM role that gives Amazon Kendra permissions to access the thesaurus file specified in SourceS3Path. This parameter is required.

Returns:

this

See Also:

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

sourceS3Path

@Stability(Stable)
public CfnThesaurus.Builder sourceS3Path(IResolvable sourceS3Path)

Information required to find a specific file in an Amazon S3 bucket.

Parameters:

sourceS3Path - Information required to find a specific file in an Amazon S3 bucket. This parameter is required.

Returns:

this

See Also:

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

sourceS3Path

@Stability(Stable)
public CfnThesaurus.Builder sourceS3Path(CfnThesaurus.S3PathProperty sourceS3Path)

Information required to find a specific file in an Amazon S3 bucket.

Parameters:

sourceS3Path - Information required to find a specific file in an Amazon S3 bucket. This parameter is required.

Returns:

this

See Also:

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

description

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

A description for the thesaurus.

Parameters:

description - A description for the thesaurus. This parameter is required.

Returns:

this

See Also:

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

tags

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

A list of key-value pairs that identify or categorize the thesaurus.

Parameters:

tags - A list of key-value pairs that identify or categorize the thesaurus. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnThesaurus build()

Specified by:

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

Returns:

a newly built instance of CfnThesaurus.