Interface CfnRetrieverProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnRetrieverProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-06T22:15:58.411Z")
@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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnRetrieverProps
static final class
An implementation forCfnRetrieverProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnRetrieverProps.Builder
builder()
The identifier of the Amazon Q Business application using the retriever.Provides information on how the retriever used for your Amazon Q Business application is configured.The name of your retriever.default String
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.getTags()
A list of key-value pairs that identify or categorize the retriever.getType()
The type of your retriever.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApplicationId
The identifier of the Amazon Q Business application using the retriever.- See Also:
-
getConfiguration
Provides information on how the retriever used for your Amazon Q Business application is configured.- See Also:
-
getDisplayName
The name of your retriever.- See Also:
-
getType
The type of your retriever.- See Also:
-
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:
-
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:
-
builder
- Returns:
- a
CfnRetrieverProps.Builder
ofCfnRetrieverProps
-