Class CfnRetriever.Builder
java.lang.Object
software.amazon.awscdk.services.qbusiness.CfnRetriever.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnRetriever>
- Enclosing class:
CfnRetriever
@Stability(Stable)
public static final class CfnRetriever.Builder
extends Object
implements software.amazon.jsii.Builder<CfnRetriever>
A fluent builder for
CfnRetriever
.-
Method Summary
Modifier and TypeMethodDescriptionapplicationId
(String applicationId) The identifier of the Amazon Q Business application using the retriever.build()
configuration
(IResolvable configuration) Provides information on how the retriever used for your Amazon Q Business application is configured.configuration
(CfnRetriever.RetrieverConfigurationProperty configuration) Provides information on how the retriever used for your Amazon Q Business application is configured.static CfnRetriever.Builder
displayName
(String displayName) The name of your retriever.The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.A list of key-value pairs that identify or categorize the retriever.The type of your retriever.
-
Method Details
-
create
@Stability(Stable) public static CfnRetriever.Builder create(software.constructs.Construct scope, String id) - 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.- Returns:
- a new instance of
CfnRetriever.Builder
.
-
applicationId
The identifier of the Amazon Q Business application using the retriever.- Parameters:
applicationId
- The identifier of the Amazon Q Business application using the retriever. This parameter is required.- Returns:
this
- See Also:
-
configuration
Provides information on how the retriever used for your Amazon Q Business application is configured.- Parameters:
configuration
- Provides information on how the retriever used for your Amazon Q Business application is configured. This parameter is required.- Returns:
this
- See Also:
-
configuration
@Stability(Stable) public CfnRetriever.Builder configuration(CfnRetriever.RetrieverConfigurationProperty configuration) Provides information on how the retriever used for your Amazon Q Business application is configured.- Parameters:
configuration
- Provides information on how the retriever used for your Amazon Q Business application is configured. This parameter is required.- Returns:
this
- See Also:
-
displayName
The name of your retriever.- Parameters:
displayName
- The name of your retriever. This parameter is required.- Returns:
this
- See Also:
-
type
The type of your retriever.- Parameters:
type
- The type of your retriever. This parameter is required.- Returns:
this
- See Also:
-
roleArn
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.- Parameters:
roleArn
- The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret. This parameter is required.- Returns:
this
- See Also:
-
tags
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: _ . : / = + -
- Parameters:
tags
- A list of key-value pairs that identify or categorize the retriever. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnRetriever>
- Returns:
- a newly built instance of
CfnRetriever
.
-