software.amazon.awscdk.services.kendra

Class CfnFaq.Builder

java.lang.Object

software.amazon.awscdk.services.kendra.CfnFaq.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFaq>

Enclosing class:

CfnFaq

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

A fluent builder for CfnFaq.

Method Summary

Modifier and Type	Method and Description
CfnFaq	build()
static CfnFaq.Builder	create(software.constructs.Construct scope, String id)
CfnFaq.Builder	description(String description) A description of the FAQ.
CfnFaq.Builder	fileFormat(String fileFormat) The format of the input file.
CfnFaq.Builder	indexId(String indexId) The identifier of the index that contains the FAQ.
CfnFaq.Builder	name(String name) The name that you assigned the FAQ when you created or updated the FAQ.
CfnFaq.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ.
CfnFaq.Builder	s3Path(CfnFaq.S3PathProperty s3Path) The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.
CfnFaq.Builder	s3Path(IResolvable s3Path) The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.
CfnFaq.Builder	tags(List<? extends CfnTag> tags) An array of key-value pairs to apply to this resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnFaq.Builder create(software.constructs.Construct scope,
                                                             String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnFaq.S3PathProperty.Builder.

indexId

@Stability(value=Stable)
public CfnFaq.Builder indexId(String indexId)

The identifier of the index that contains the FAQ.

Parameters:

indexId - The identifier of the index that contains the FAQ. This parameter is required.

Returns:

this

name

@Stability(value=Stable)
public CfnFaq.Builder name(String name)

The name that you assigned the FAQ when you created or updated the FAQ.

Parameters:

name - The name that you assigned the FAQ when you created or updated the FAQ. This parameter is required.

Returns:

this

roleArn

@Stability(value=Stable)
public CfnFaq.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ.

Parameters:

roleArn - The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ. This parameter is required.

Returns:

this

s3Path

@Stability(value=Stable)
public CfnFaq.Builder s3Path(CfnFaq.S3PathProperty s3Path)

The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.

Parameters:

s3Path - The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data. This parameter is required.

Returns:

this

s3Path

@Stability(value=Stable)
public CfnFaq.Builder s3Path(IResolvable s3Path)

The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.

Parameters:

s3Path - The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public CfnFaq.Builder description(String description)

A description of the FAQ.

Parameters:

description - A description of the FAQ. This parameter is required.

Returns:

this

fileFormat

@Stability(value=Stable)
public CfnFaq.Builder fileFormat(String fileFormat)

The format of the input file.

You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

Valid values are:

• CSV
• CSV_WITH_HEADER
• JSON

Parameters:

fileFormat - The format of the input file. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnFaq.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnFaq build()

Specified by:

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