Package software.amazon.awscdk.services.qbusiness

Class CfnRetriever

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.qbusiness.CfnRetriever
All Implemented Interfaces:
IInspectable, ITaggableV2, IRetrieverRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:44.834Z") @Stability(Stable) public class CfnRetriever extends CfnResource implements IInspectable, IRetrieverRef, ITaggableV2
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.services.qbusiness.*;
 CfnRetriever cfnRetriever = CfnRetriever.Builder.create(this, "MyCfnRetriever")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRetriever

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

    • CfnRetriever

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

    • CfnRetriever

      @Stability(Stable) public CfnRetriever(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRetrieverProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The Unix timestamp when the retriever was created.

    • getAttrRetrieverArn

      @Stability(Stable) @NotNull public String getAttrRetrieverArn()
      The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

    • getAttrRetrieverId

      @Stability(Stable) @NotNull public String getAttrRetrieverId()
      The identifier of the retriever used by your Amazon Q Business application.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of your retriever.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The Unix timestamp when the retriever was last updated.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRetrieverRef

      @Stability(Stable) @NotNull public RetrieverReference getRetrieverRef()
      A reference to a Retriever resource.
      Specified by:
      getRetrieverRef in interface IRetrieverRef

    • getApplicationId

      @Stability(Stable) @NotNull public String getApplicationId()
      The identifier of the Amazon Q Business application using the retriever.

    • setApplicationId

      @Stability(Stable) public void setApplicationId(@NotNull String value)
      The identifier of the Amazon Q Business application using the retriever.

    • getConfiguration

      @Stability(Stable) @NotNull public Object getConfiguration()
      Provides information on how the retriever used for your Amazon Q Business application is configured.

      Returns union: either IResolvable or CfnRetriever.RetrieverConfigurationProperty

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@NotNull IResolvable value)
      Provides information on how the retriever used for your Amazon Q Business application is configured.

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@NotNull CfnRetriever.RetrieverConfigurationProperty value)
      Provides information on how the retriever used for your Amazon Q Business application is configured.

    • getDisplayName

      @Stability(Stable) @NotNull public String getDisplayName()
      The name of your retriever.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@NotNull String value)
      The name of your retriever.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of your retriever.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of your retriever.

    • getRoleArn

      @Stability(Stable) @Nullable public 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.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of key-value pairs that identify or categorize the retriever.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of key-value pairs that identify or categorize the retriever.