Package software.amazon.awscdk.services.kendra

Class CfnFeaturedResultsSet.Builder

java.lang.Object

software.amazon.awscdk.services.kendra.CfnFeaturedResultsSet.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFeaturedResultsSet>

Enclosing class:

CfnFeaturedResultsSet

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

A fluent builder for CfnFeaturedResultsSet.

Method Summary

Modifier and Type	Method	Description
CfnFeaturedResultsSet	build()
static CfnFeaturedResultsSet.Builder	create(software.constructs.Construct scope, String id)
CfnFeaturedResultsSet.Builder	description(String description)	A description for the set of featured results.
CfnFeaturedResultsSet.Builder	featuredDocuments(List<? extends Object> featuredDocuments)	A list of document IDs for the documents you want to feature at the top of the search results page.
CfnFeaturedResultsSet.Builder	featuredDocuments(IResolvable featuredDocuments)	A list of document IDs for the documents you want to feature at the top of the search results page.
CfnFeaturedResultsSet.Builder	featuredResultsSetName(String featuredResultsSetName)	A name for the set of featured results.
CfnFeaturedResultsSet.Builder	indexId(String indexId)	The identifier of the index that you want to use for featuring results.
CfnFeaturedResultsSet.Builder	queryTexts(List<String> queryTexts)	A list of queries for featuring results.
CfnFeaturedResultsSet.Builder	status(String status)	The current status of the set of featured results.
CfnFeaturedResultsSet.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs that identify or categorize the featured results set.

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

featuredResultsSetName

@Stability(Stable)
public CfnFeaturedResultsSet.Builder featuredResultsSetName(String featuredResultsSetName)

A name for the set of featured results.

Parameters:

featuredResultsSetName - A name for the set of featured results. This parameter is required.

Returns:

this

See Also:

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

indexId

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

The identifier of the index that you want to use for featuring results.

Parameters:

indexId - The identifier of the index that you want to use for featuring results. This parameter is required.

Returns:

this

See Also:

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

description

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

A description for the set of featured results.

Parameters:

description - A description for the set of featured results. This parameter is required.

Returns:

this

See Also:

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

featuredDocuments

@Stability(Stable)
public CfnFeaturedResultsSet.Builder featuredDocuments(IResolvable featuredDocuments)

A list of document IDs for the documents you want to feature at the top of the search results page.

Parameters:

featuredDocuments - A list of document IDs for the documents you want to feature at the top of the search results page. This parameter is required.

Returns:

this

See Also:

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

featuredDocuments

@Stability(Stable)
public CfnFeaturedResultsSet.Builder featuredDocuments(List<? extends Object> featuredDocuments)

A list of document IDs for the documents you want to feature at the top of the search results page.

Parameters:

featuredDocuments - A list of document IDs for the documents you want to feature at the top of the search results page. This parameter is required.

Returns:

this

See Also:

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

queryTexts

@Stability(Stable)
public CfnFeaturedResultsSet.Builder queryTexts(List<String> queryTexts)

A list of queries for featuring results.

Parameters:

queryTexts - A list of queries for featuring results. This parameter is required.

Returns:

this

See Also:

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

status

@Stability(Stable)
public CfnFeaturedResultsSet.Builder status(String status)

The current status of the set of featured results.

When the value is ACTIVE, featured results are ready for use.

Parameters:

status - The current status of the set of featured results. This parameter is required.

Returns:

this

See Also:

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

tags

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

A list of key-value pairs that identify or categorize the featured results set.

Parameters:

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

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnFeaturedResultsSet build()

Specified by:

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

Returns:

a newly built instance of CfnFeaturedResultsSet.