Package software.amazon.awscdk.cfnpropertymixins.services.qbusiness

Class CfnRetrieverPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.qbusiness.CfnRetrieverPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRetrieverPropsMixin>

Enclosing class:

CfnRetrieverPropsMixin

@Stability(Stable)
public static final class CfnRetrieverPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnRetrieverPropsMixin>

A fluent builder for CfnRetrieverPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnRetrieverPropsMixin.Builder	applicationId(String applicationId)	The identifier of the Amazon Q Business application using the retriever.
CfnRetrieverPropsMixin	build()
CfnRetrieverPropsMixin.Builder	configuration(CfnRetrieverPropsMixin.RetrieverConfigurationProperty configuration)	Provides information on how the retriever used for your Amazon Q Business application is configured.
CfnRetrieverPropsMixin.Builder	configuration(IResolvable configuration)	Provides information on how the retriever used for your Amazon Q Business application is configured.
static CfnRetrieverPropsMixin.Builder	create()
static CfnRetrieverPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnRetrieverPropsMixin.Builder	displayName(String displayName)	The name of your retriever.
CfnRetrieverPropsMixin.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.
CfnRetrieverPropsMixin.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs that identify or categorize the retriever.
CfnRetrieverPropsMixin.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 CfnRetrieverPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnRetrieverPropsMixin.Builder.

create

@Stability(Stable)
public static CfnRetrieverPropsMixin.Builder create()

Returns:

a new instance of CfnRetrieverPropsMixin.Builder.

applicationId

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

roleArn

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

type

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

build

@Stability(Stable)
public CfnRetrieverPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnRetrieverPropsMixin.