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

Class CfnQuerySuggestionsBlockListPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnQuerySuggestionsBlockListPropsMixin>

Enclosing class:

CfnQuerySuggestionsBlockListPropsMixin

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

A fluent builder for CfnQuerySuggestionsBlockListPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnQuerySuggestionsBlockListPropsMixin	build()
static CfnQuerySuggestionsBlockListPropsMixin.Builder	create()
static CfnQuerySuggestionsBlockListPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnQuerySuggestionsBlockListPropsMixin.Builder	description(String description)	A description for the block list.
CfnQuerySuggestionsBlockListPropsMixin.Builder	indexId(String indexId)	The identifier of the index for the block list.
CfnQuerySuggestionsBlockListPropsMixin.Builder	name(String name)	The name of the block list.
CfnQuerySuggestionsBlockListPropsMixin.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.
CfnQuerySuggestionsBlockListPropsMixin.Builder	sourceS3Path(CfnQuerySuggestionsBlockListPropsMixin.S3PathProperty sourceS3Path)	Information required to find a specific file in an Amazon S3 bucket.
CfnQuerySuggestionsBlockListPropsMixin.Builder	sourceS3Path(IResolvable sourceS3Path)	Information required to find a specific file in an Amazon S3 bucket.
CfnQuerySuggestionsBlockListPropsMixin.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 CfnQuerySuggestionsBlockListPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnQuerySuggestionsBlockListPropsMixin.Builder.

create

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

Returns:

a new instance of CfnQuerySuggestionsBlockListPropsMixin.Builder.

description

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

indexId

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

tags

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

Specified by:

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

Returns:

a newly built instance of CfnQuerySuggestionsBlockListPropsMixin.