Package software.amazon.awscdk.services.qbusiness

Class CfnIndexProps.Builder

java.lang.Object

software.amazon.awscdk.services.qbusiness.CfnIndexProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIndexProps>

Enclosing interface:

CfnIndexProps

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

A builder for CfnIndexProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnIndexProps.Builder	applicationId(String applicationId)	Sets the value of CfnIndexProps.getApplicationId()
CfnIndexProps	build()	Builds the configured instance.
CfnIndexProps.Builder	capacityConfiguration(IResolvable capacityConfiguration)	Sets the value of CfnIndexProps.getCapacityConfiguration()
CfnIndexProps.Builder	capacityConfiguration(CfnIndex.IndexCapacityConfigurationProperty capacityConfiguration)	Sets the value of CfnIndexProps.getCapacityConfiguration()
CfnIndexProps.Builder	description(String description)	Sets the value of CfnIndexProps.getDescription()
CfnIndexProps.Builder	displayName(String displayName)	Sets the value of CfnIndexProps.getDisplayName()
CfnIndexProps.Builder	documentAttributeConfigurations(List<? extends Object> documentAttributeConfigurations)	Sets the value of CfnIndexProps.getDocumentAttributeConfigurations()
CfnIndexProps.Builder	documentAttributeConfigurations(IResolvable documentAttributeConfigurations)	Sets the value of CfnIndexProps.getDocumentAttributeConfigurations()
CfnIndexProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnIndexProps.getTags()
CfnIndexProps.Builder	type(String type)	Sets the value of CfnIndexProps.getType()

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

applicationId

@Stability(Stable)
public CfnIndexProps.Builder applicationId(String applicationId)

Sets the value of CfnIndexProps.getApplicationId()

Parameters:

applicationId - The identifier of the Amazon Q Business application using the index. This parameter is required.

Returns:

this

displayName

@Stability(Stable)
public CfnIndexProps.Builder displayName(String displayName)

Sets the value of CfnIndexProps.getDisplayName()

Parameters:

displayName - The name of the index. This parameter is required.

Returns:

this

capacityConfiguration

@Stability(Stable)
public CfnIndexProps.Builder capacityConfiguration(IResolvable capacityConfiguration)

Sets the value of CfnIndexProps.getCapacityConfiguration()

Parameters:

capacityConfiguration - The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

Returns:

this

capacityConfiguration

@Stability(Stable)
public CfnIndexProps.Builder capacityConfiguration(CfnIndex.IndexCapacityConfigurationProperty capacityConfiguration)

Sets the value of CfnIndexProps.getCapacityConfiguration()

Parameters:

capacityConfiguration - The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

Returns:

this

description

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

Sets the value of CfnIndexProps.getDescription()

Parameters:

description - A description for the Amazon Q Business index.

Returns:

this

documentAttributeConfigurations

@Stability(Stable)
public CfnIndexProps.Builder documentAttributeConfigurations(IResolvable documentAttributeConfigurations)

Sets the value of CfnIndexProps.getDocumentAttributeConfigurations()

Parameters:

documentAttributeConfigurations - Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes .

Returns:

this

documentAttributeConfigurations

@Stability(Stable)
public CfnIndexProps.Builder documentAttributeConfigurations(List<? extends Object> documentAttributeConfigurations)

Sets the value of CfnIndexProps.getDocumentAttributeConfigurations()

Parameters:

documentAttributeConfigurations - Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes .

Returns:

this

tags

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

Sets the value of CfnIndexProps.getTags()

Parameters:

tags - A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -

Returns:

this

type

@Stability(Stable)
public CfnIndexProps.Builder type(String type)

Sets the value of CfnIndexProps.getType()

Parameters:

type - The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers .

Returns:

this

build

@Stability(Stable)
public CfnIndexProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnIndexProps

Throws:

NullPointerException - if any required attribute was not provided