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

Class CfnIndexPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

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

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-14T18:32:16.019Z")
@Stability(Stable)
public class CfnIndexPropsMixin
extends Mixin
implements software.constructs.IMixin

Creates an Amazon Q Business index.

To determine if index creation has completed, check the Status field returned from a call to DescribeIndex . The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.qbusiness.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnIndexPropsMixin cfnIndexPropsMixin = CfnIndexPropsMixin.Builder.create(CfnIndexMixinProps.builder()
         .applicationId("applicationId")
         .capacityConfiguration(IndexCapacityConfigurationProperty.builder()
                 .units(123)
                 .build())
         .description("description")
         .displayName("displayName")
         .documentAttributeConfigurations(List.of(DocumentAttributeConfigurationProperty.builder()
                 .name("name")
                 .search("search")
                 .type("type")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnIndexPropsMixin.Builder	A fluent builder for CfnIndexPropsMixin.
static interface	CfnIndexPropsMixin.DocumentAttributeConfigurationProperty	Configuration information for document attributes.
static interface	CfnIndexPropsMixin.IndexCapacityConfigurationProperty	Provides information about index capacity configuration.
static interface	CfnIndexPropsMixin.IndexStatisticsProperty	Provides information about the number of documents in an index.
static interface	CfnIndexPropsMixin.TextDocumentStatisticsProperty	Provides information about text documents in an index.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnIndexPropsMixin(CfnIndexMixinProps props)	Create a mixin to apply properties to AWS::QBusiness::Index.
	CfnIndexPropsMixin(CfnIndexMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::QBusiness::Index.
protected	CfnIndexPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnIndexPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnIndexMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnIndexPropsMixin

protected CfnIndexPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnIndexPropsMixin

protected CfnIndexPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnIndexPropsMixin

@Stability(Stable)
public CfnIndexPropsMixin(@NotNull
 CfnIndexMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::QBusiness::Index.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnIndexPropsMixin

@Stability(Stable)
public CfnIndexPropsMixin(@NotNull
 CfnIndexMixinProps props)

Create a mixin to apply properties to AWS::QBusiness::Index.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnIndexMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()