Package software.amazon.awscdk.mixins.preview.services.qbusiness.mixins

Class CfnRetrieverPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.mixins.preview.core.Mixin

software.amazon.awscdk.mixins.preview.services.qbusiness.mixins.CfnRetrieverPropsMixin

All Implemented Interfaces:

IMixin, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:29.267Z")
@Stability(Stable)
public class CfnRetrieverPropsMixin
extends Mixin
implements IMixin

Adds a retriever to your Amazon Q Business application.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.mixins.preview.mixins.*;
 import software.amazon.awscdk.mixins.preview.services.qbusiness.mixins.*;
 CfnRetrieverPropsMixin cfnRetrieverPropsMixin = CfnRetrieverPropsMixin.Builder.create(CfnRetrieverMixinProps.builder()
         .applicationId("applicationId")
         .configuration(RetrieverConfigurationProperty.builder()
                 .kendraIndexConfiguration(KendraIndexConfigurationProperty.builder()
                         .indexId("indexId")
                         .build())
                 .nativeIndexConfiguration(NativeIndexConfigurationProperty.builder()
                         .indexId("indexId")
                         .build())
                 .build())
         .displayName("displayName")
         .roleArn("roleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build())
 .strategy(PropertyMergeStrategy.OVERRIDE)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnRetrieverPropsMixin.Builder	A fluent builder for CfnRetrieverPropsMixin.
static interface	CfnRetrieverPropsMixin.KendraIndexConfigurationProperty	Stores an Amazon Kendra index as a retriever.
static interface	CfnRetrieverPropsMixin.NativeIndexConfigurationProperty	Configuration information for an Amazon Q Business index.
static interface	CfnRetrieverPropsMixin.RetrieverConfigurationProperty	Provides information on how the retriever used for your Amazon Q Business application is configured.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.mixins.preview.core.IMixin

IMixin.Jsii$Default, 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
	CfnRetrieverPropsMixin(CfnRetrieverMixinProps props)	Create a mixin to apply properties to AWS::QBusiness::Retriever.
	CfnRetrieverPropsMixin(CfnRetrieverMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::QBusiness::Retriever.
protected	CfnRetrieverPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRetrieverPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

Methods inherited from class software.amazon.awscdk.mixins.preview.core.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

CfnRetrieverPropsMixin

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

CfnRetrieverPropsMixin

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

CfnRetrieverPropsMixin

@Stability(Stable)
public CfnRetrieverPropsMixin(@NotNull
 CfnRetrieverMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

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

Parameters:

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

options - Mixin options.

CfnRetrieverPropsMixin

@Stability(Stable)
public CfnRetrieverPropsMixin(@NotNull
 CfnRetrieverMixinProps props)

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

Parameters:

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

Method Details

applyTo

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

Apply the mixin properties to the construct.

Specified by:

applyTo in interface 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 IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

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

getStrategy

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