Package software.amazon.awscdk.cfnpropertymixins.services.qbusiness

Class CfnIndexPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.qbusiness.CfnIndexPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIndexPropsMixin>

Enclosing class:

CfnIndexPropsMixin

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

A fluent builder for CfnIndexPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnIndexPropsMixin.Builder	applicationId(String applicationId)	The identifier of the Amazon Q Business application using the index.
CfnIndexPropsMixin	build()
CfnIndexPropsMixin.Builder	capacityConfiguration(CfnIndexPropsMixin.IndexCapacityConfigurationProperty capacityConfiguration)	The capacity units you want to provision for your index.
CfnIndexPropsMixin.Builder	capacityConfiguration(IResolvable capacityConfiguration)	The capacity units you want to provision for your index.
static CfnIndexPropsMixin.Builder	create()
static CfnIndexPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnIndexPropsMixin.Builder	description(String description)	A description for the Amazon Q Business index.
CfnIndexPropsMixin.Builder	displayName(String displayName)	The name of the index.
CfnIndexPropsMixin.Builder	documentAttributeConfigurations(List<? extends Object> documentAttributeConfigurations)	Configuration information for document attributes.
CfnIndexPropsMixin.Builder	documentAttributeConfigurations(IResolvable documentAttributeConfigurations)	Configuration information for document attributes.
CfnIndexPropsMixin.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs that identify or categorize the index.
CfnIndexPropsMixin.Builder	type(String type)	The index type that's suitable for your needs.

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 CfnIndexPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnIndexPropsMixin.Builder.

create

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

Returns:

a new instance of CfnIndexPropsMixin.Builder.

applicationId

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

The identifier of the Amazon Q Business application using the index.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-applicationid

capacityConfiguration

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

The capacity units you want to provision for your index.

You can add and remove capacity to fit your usage needs.

Parameters:

capacityConfiguration - The capacity units you want to provision for your index. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-capacityconfiguration

capacityConfiguration

@Stability(Stable)
public CfnIndexPropsMixin.Builder capacityConfiguration(CfnIndexPropsMixin.IndexCapacityConfigurationProperty capacityConfiguration)

The capacity units you want to provision for your index.

You can add and remove capacity to fit your usage needs.

Parameters:

capacityConfiguration - The capacity units you want to provision for your index. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-capacityconfiguration

description

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

A description for the Amazon Q Business index.

Parameters:

description - A description for the Amazon Q Business index. This parameter is required.

Returns:

this

See Also:

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

displayName

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

The name of the index.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-displayname

documentAttributeConfigurations

@Stability(Stable)
public CfnIndexPropsMixin.Builder documentAttributeConfigurations(IResolvable 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 .

Parameters:

documentAttributeConfigurations - Configuration information for document attributes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-documentattributeconfigurations

documentAttributeConfigurations

@Stability(Stable)
public CfnIndexPropsMixin.Builder documentAttributeConfigurations(List<? extends Object> 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 .

Parameters:

documentAttributeConfigurations - Configuration information for document attributes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-documentattributeconfigurations

tags

@Stability(Stable)
public CfnIndexPropsMixin.Builder tags(List<? extends CfnTag> 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: _ . : / = + -

Parameters:

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

Returns:

this

See Also:

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

type

@Stability(Stable)
public CfnIndexPropsMixin.Builder type(String 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 .

Parameters:

type - The index type that's suitable for your needs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-type

build

@Stability(Stable)
public CfnIndexPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnIndexPropsMixin.