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

Interface CfnRetrieverMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRetrieverMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:30.914Z")
@Stability(Stable)
public interface CfnRetrieverMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnRetrieverPropsMixin.

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.*;
 CfnRetrieverMixinProps cfnRetrieverMixinProps = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRetrieverMixinProps.Builder	A builder for CfnRetrieverMixinProps
static final class	CfnRetrieverMixinProps.Jsii$Proxy	An implementation for CfnRetrieverMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnRetrieverMixinProps.Builder	builder()
default String	getApplicationId()	The identifier of the Amazon Q Business application using the retriever.
default Object	getConfiguration()	Provides information on how the retriever used for your Amazon Q Business application is configured.
default String	getDisplayName()	The name of your retriever.
default String	getRoleArn()	The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
default List<CfnTag>	getTags()	A list of key-value pairs that identify or categorize the retriever.
default String	getType()	The type of your retriever.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationId

@Stability(Stable)
@Nullable
default String getApplicationId()

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

See Also:

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

getConfiguration

@Stability(Stable)
@Nullable
default Object getConfiguration()

Provides information on how the retriever used for your Amazon Q Business application is configured.

Returns union: either IResolvable or CfnRetrieverPropsMixin.RetrieverConfigurationProperty

See Also:

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

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

The name of your retriever.

See Also:

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

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of key-value pairs that identify or categorize the retriever.

You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -

See Also:

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

getType

@Stability(Stable)
@Nullable
default String getType()

The type of your retriever.

See Also:

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

builder

@Stability(Stable)
static CfnRetrieverMixinProps.Builder builder()

Returns:

a CfnRetrieverMixinProps.Builder of CfnRetrieverMixinProps