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

Class CfnFaqMixinProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFaqMixinProps>

Enclosing interface:

CfnFaqMixinProps

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

A builder for CfnFaqMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnFaqMixinProps	build()	Builds the configured instance.
CfnFaqMixinProps.Builder	description(String description)	Sets the value of CfnFaqMixinProps.getDescription()
CfnFaqMixinProps.Builder	fileFormat(String fileFormat)	Sets the value of CfnFaqMixinProps.getFileFormat()
CfnFaqMixinProps.Builder	indexId(String indexId)	Sets the value of CfnFaqMixinProps.getIndexId()
CfnFaqMixinProps.Builder	languageCode(String languageCode)	Sets the value of CfnFaqMixinProps.getLanguageCode()
CfnFaqMixinProps.Builder	name(String name)	Sets the value of CfnFaqMixinProps.getName()
CfnFaqMixinProps.Builder	roleArn(String roleArn)	Sets the value of CfnFaqMixinProps.getRoleArn()
CfnFaqMixinProps.Builder	s3Path(CfnFaqPropsMixin.S3PathProperty s3Path)	Sets the value of CfnFaqMixinProps.getS3Path()
CfnFaqMixinProps.Builder	s3Path(IResolvable s3Path)	Sets the value of CfnFaqMixinProps.getS3Path()
CfnFaqMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnFaqMixinProps.getTags()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

description

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

Sets the value of CfnFaqMixinProps.getDescription()

Parameters:

description - A description for the FAQ.

Returns:

this

fileFormat

@Stability(Stable)
public CfnFaqMixinProps.Builder fileFormat(String fileFormat)

Sets the value of CfnFaqMixinProps.getFileFormat()

Parameters:

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

Returns:

this

indexId

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

Sets the value of CfnFaqMixinProps.getIndexId()

Parameters:

indexId - The identifier of the index that contains the FAQ.

Returns:

this

languageCode

@Stability(Stable)
public CfnFaqMixinProps.Builder languageCode(String languageCode)

Sets the value of CfnFaqMixinProps.getLanguageCode()

Parameters:

languageCode - The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .

Returns:

this

name

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

Sets the value of CfnFaqMixinProps.getName()

Parameters:

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

Returns:

this

roleArn

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

Sets the value of CfnFaqMixinProps.getRoleArn()

Parameters:

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

Returns:

this

s3Path

@Stability(Stable)
public CfnFaqMixinProps.Builder s3Path(IResolvable s3Path)

Sets the value of CfnFaqMixinProps.getS3Path()

Parameters:

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

Returns:

this

s3Path

@Stability(Stable)
public CfnFaqMixinProps.Builder s3Path(CfnFaqPropsMixin.S3PathProperty s3Path)

Sets the value of CfnFaqMixinProps.getS3Path()

Parameters:

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

Returns:

this

tags

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

Sets the value of CfnFaqMixinProps.getTags()

Parameters:

tags - An array of key-value pairs to apply to this resource. For more information, see Tag .

Returns:

this

build

@Stability(Stable)
public CfnFaqMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnFaqMixinProps

Throws:

NullPointerException - if any required attribute was not provided