Package software.amazon.awscdk.services.qbusiness

Interface CfnRetrieverProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRetrieverProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:44.836Z")
@Stability(Stable)
public interface CfnRetrieverProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRetriever.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.qbusiness.*;
 CfnRetrieverProps cfnRetrieverProps = CfnRetrieverProps.builder()
         .applicationId("applicationId")
         .configuration(RetrieverConfigurationProperty.builder()
                 .kendraIndexConfiguration(KendraIndexConfigurationProperty.builder()
                         .indexId("indexId")
                         .build())
                 .nativeIndexConfiguration(NativeIndexConfigurationProperty.builder()
                         .indexId("indexId")
                         .build())
                 .build())
         .displayName("displayName")
         .type("type")
         // the properties below are optional
         .roleArn("roleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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	CfnRetrieverProps.Builder	A builder for CfnRetrieverProps
static final class	CfnRetrieverProps.Jsii$Proxy	An implementation for CfnRetrieverProps

Method Summary

Modifier and Type	Method	Description
static CfnRetrieverProps.Builder	builder()
String	getApplicationId()	The identifier of the Amazon Q Business application using the retriever.
Object	getConfiguration()	Provides information on how the retriever used for your Amazon Q Business application is configured.
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.
String	getType()	The type of your retriever.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationId

@Stability(Stable)
@NotNull
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)
@NotNull
Object getConfiguration()

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

Returns union: either IResolvable or CfnRetriever.RetrieverConfigurationProperty

See Also:

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

getDisplayName

@Stability(Stable)
@NotNull
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

getType

@Stability(Stable)
@NotNull
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

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

builder

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

Returns:

a CfnRetrieverProps.Builder of CfnRetrieverProps