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

Class CfnThesaurusPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnThesaurusPropsMixin>

Enclosing class:

CfnThesaurusPropsMixin

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

A fluent builder for CfnThesaurusPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnThesaurusPropsMixin	build()
static CfnThesaurusPropsMixin.Builder	create()
static CfnThesaurusPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnThesaurusPropsMixin.Builder	description(String description)	A description for the thesaurus.
CfnThesaurusPropsMixin.Builder	indexId(String indexId)	The identifier of the index for the thesaurus.
CfnThesaurusPropsMixin.Builder	name(String name)	A name for the thesaurus.
CfnThesaurusPropsMixin.Builder	roleArn(String roleArn)	An IAM role that gives Amazon Kendra permissions to access the thesaurus file specified in SourceS3Path.
CfnThesaurusPropsMixin.Builder	sourceS3Path(CfnThesaurusPropsMixin.S3PathProperty sourceS3Path)	Information required to find a specific file in an Amazon S3 bucket.
CfnThesaurusPropsMixin.Builder	sourceS3Path(IResolvable sourceS3Path)	Information required to find a specific file in an Amazon S3 bucket.
CfnThesaurusPropsMixin.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 CfnThesaurusPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnThesaurusPropsMixin.Builder.

create

@Stability(Stable)
public static CfnThesaurusPropsMixin.Builder create()

Returns:

a new instance of CfnThesaurusPropsMixin.Builder.

description

@Stability(Stable)
public CfnThesaurusPropsMixin.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

indexId

@Stability(Stable)
public CfnThesaurusPropsMixin.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 CfnThesaurusPropsMixin.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 CfnThesaurusPropsMixin.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 CfnThesaurusPropsMixin.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 CfnThesaurusPropsMixin.Builder sourceS3Path(CfnThesaurusPropsMixin.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

tags

@Stability(Stable)
public CfnThesaurusPropsMixin.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 CfnThesaurusPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnThesaurusPropsMixin.