Package software.amazon.awscdk.services.kendra

Class CfnQuerySuggestionsBlockList.Builder

java.lang.Object

software.amazon.awscdk.services.kendra.CfnQuerySuggestionsBlockList.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnQuerySuggestionsBlockList>

Enclosing class:

CfnQuerySuggestionsBlockList

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

A fluent builder for CfnQuerySuggestionsBlockList.

Method Summary

Modifier and Type	Method	Description
CfnQuerySuggestionsBlockList	build()
static CfnQuerySuggestionsBlockList.Builder	create(software.constructs.Construct scope, String id)
CfnQuerySuggestionsBlockList.Builder	description(String description)	A description for the block list.
CfnQuerySuggestionsBlockList.Builder	indexId(String indexId)	The identifier of the index for the block list.
CfnQuerySuggestionsBlockList.Builder	name(String name)	The name of the block list.
CfnQuerySuggestionsBlockList.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the block list text file.
CfnQuerySuggestionsBlockList.Builder	sourceS3Path(IResolvable sourceS3Path)	Information required to find a specific file in an Amazon S3 bucket.
CfnQuerySuggestionsBlockList.Builder	sourceS3Path(CfnQuerySuggestionsBlockList.S3PathProperty sourceS3Path)	Information required to find a specific file in an Amazon S3 bucket.
CfnQuerySuggestionsBlockList.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs that identify or categorize the block list.

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

indexId

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

The identifier of the index for the block list.

Parameters:

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

Returns:

this

See Also:

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

name

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

The name of the block list.

Parameters:

name - The name of the block list. This parameter is required.

Returns:

this

See Also:

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

roleArn

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

The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the block list text file.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the block list text file. This parameter is required.

Returns:

this

See Also:

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

sourceS3Path

@Stability(Stable)
public CfnQuerySuggestionsBlockList.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-querysuggestionsblocklist.html#cfn-kendra-querysuggestionsblocklist-sources3path

sourceS3Path

@Stability(Stable)
public CfnQuerySuggestionsBlockList.Builder sourceS3Path(CfnQuerySuggestionsBlockList.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-querysuggestionsblocklist.html#cfn-kendra-querysuggestionsblocklist-sources3path

description

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

A description for the block list.

Parameters:

description - A description for the block list. This parameter is required.

Returns:

this

See Also:

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

tags

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

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

Parameters:

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

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnQuerySuggestionsBlockList build()

Specified by:

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

Returns:

a newly built instance of CfnQuerySuggestionsBlockList.