Package software.amazon.awscdk.services.qbusiness

Class CfnRetrieverProps.Builder

java.lang.Object

software.amazon.awscdk.services.qbusiness.CfnRetrieverProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRetrieverProps>

Enclosing interface:

CfnRetrieverProps

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

A builder for CfnRetrieverProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnRetrieverProps.Builder	applicationId(String applicationId)	Sets the value of CfnRetrieverProps.getApplicationId()
CfnRetrieverProps	build()	Builds the configured instance.
CfnRetrieverProps.Builder	configuration(IResolvable configuration)	Sets the value of CfnRetrieverProps.getConfiguration()
CfnRetrieverProps.Builder	configuration(CfnRetriever.RetrieverConfigurationProperty configuration)	Sets the value of CfnRetrieverProps.getConfiguration()
CfnRetrieverProps.Builder	displayName(String displayName)	Sets the value of CfnRetrieverProps.getDisplayName()
CfnRetrieverProps.Builder	roleArn(String roleArn)	Sets the value of CfnRetrieverProps.getRoleArn()
CfnRetrieverProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnRetrieverProps.getTags()
CfnRetrieverProps.Builder	type(String type)	Sets the value of CfnRetrieverProps.getType()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

applicationId

@Stability(Stable)
public CfnRetrieverProps.Builder applicationId(String applicationId)

Sets the value of CfnRetrieverProps.getApplicationId()

Parameters:

applicationId - The identifier of the Amazon Q Business application using the retriever. This parameter is required.

Returns:

this

configuration

@Stability(Stable)
public CfnRetrieverProps.Builder configuration(IResolvable configuration)

Sets the value of CfnRetrieverProps.getConfiguration()

Parameters:

configuration - Provides information on how the retriever used for your Amazon Q Business application is configured. This parameter is required.

Returns:

this

configuration

@Stability(Stable)
public CfnRetrieverProps.Builder configuration(CfnRetriever.RetrieverConfigurationProperty configuration)

Sets the value of CfnRetrieverProps.getConfiguration()

Parameters:

configuration - Provides information on how the retriever used for your Amazon Q Business application is configured. This parameter is required.

Returns:

this

displayName

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

Sets the value of CfnRetrieverProps.getDisplayName()

Parameters:

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

Returns:

this

type

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

Sets the value of CfnRetrieverProps.getType()

Parameters:

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

Returns:

this

roleArn

@Stability(Stable)
public CfnRetrieverProps.Builder roleArn(String roleArn)

Sets the value of CfnRetrieverProps.getRoleArn()

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.

Returns:

this

tags

@Stability(Stable)
public CfnRetrieverProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnRetrieverProps.getTags()

Parameters:

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: _ . : / = + -

Returns:

this

build

@Stability(Stable)
public CfnRetrieverProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnRetrieverProps

Throws:

NullPointerException - if any required attribute was not provided