Package software.amazon.awscdk.services.qbusiness

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 Type	Method	Description
CfnRetriever.Builder	applicationId(String applicationId)	The identifier of the Amazon Q Business application using the retriever.
CfnRetriever	build()
CfnRetriever.Builder	configuration(IResolvable configuration)	Provides information on how the retriever used for your Amazon Q Business application is configured.
CfnRetriever.Builder	configuration(CfnRetriever.RetrieverConfigurationProperty configuration)	Provides information on how the retriever used for your Amazon Q Business application is configured.
static CfnRetriever.Builder	create(software.constructs.Construct scope, String id)
CfnRetriever.Builder	displayName(String displayName)	The name of your retriever.
CfnRetriever.Builder	roleArn(String roleArn)	The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
CfnRetriever.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs that identify or categorize the retriever.
CfnRetriever.Builder	type(String type)	The type of your retriever.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

@Stability(Stable)
public CfnRetriever.Builder applicationId(String 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:

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

configuration

@Stability(Stable)
public CfnRetriever.Builder configuration(IResolvable 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:

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

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:

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

displayName

@Stability(Stable)
public CfnRetriever.Builder displayName(String displayName)

The name of your retriever.

Parameters:

displayName - The name of your retriever. This parameter is required.

Returns:

this

See Also:

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

type

@Stability(Stable)
public CfnRetriever.Builder type(String type)

The type of your retriever.

Parameters:

type - The type of your retriever. This parameter is required.

Returns:

this

See Also:

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

roleArn

@Stability(Stable)
public CfnRetriever.Builder roleArn(String 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:

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

tags

@Stability(Stable)
public CfnRetriever.Builder tags(List<? extends CfnTag> 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:

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

build

@Stability(Stable)
public CfnRetriever build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnRetriever>

Returns:

a newly built instance of CfnRetriever.