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

Class CfnRetrieverMixinProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRetrieverMixinProps>

Enclosing interface:

CfnRetrieverMixinProps

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

A builder for CfnRetrieverMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnRetrieverMixinProps.Builder	applicationId(String applicationId)	Sets the value of CfnRetrieverMixinProps.getApplicationId()
CfnRetrieverMixinProps	build()	Builds the configured instance.
CfnRetrieverMixinProps.Builder	configuration(CfnRetrieverPropsMixin.RetrieverConfigurationProperty configuration)	Sets the value of CfnRetrieverMixinProps.getConfiguration()
CfnRetrieverMixinProps.Builder	configuration(IResolvable configuration)	Sets the value of CfnRetrieverMixinProps.getConfiguration()
CfnRetrieverMixinProps.Builder	displayName(String displayName)	Sets the value of CfnRetrieverMixinProps.getDisplayName()
CfnRetrieverMixinProps.Builder	roleArn(String roleArn)	Sets the value of CfnRetrieverMixinProps.getRoleArn()
CfnRetrieverMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnRetrieverMixinProps.getTags()
CfnRetrieverMixinProps.Builder	type(String type)	Sets the value of CfnRetrieverMixinProps.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 CfnRetrieverMixinProps.Builder applicationId(String applicationId)

Sets the value of CfnRetrieverMixinProps.getApplicationId()

Parameters:

applicationId - The identifier of the Amazon Q Business application using the retriever.

Returns:

this

configuration

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

Sets the value of CfnRetrieverMixinProps.getConfiguration()

Parameters:

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

Returns:

this

configuration

@Stability(Stable)
public CfnRetrieverMixinProps.Builder configuration(CfnRetrieverPropsMixin.RetrieverConfigurationProperty configuration)

Sets the value of CfnRetrieverMixinProps.getConfiguration()

Parameters:

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

Returns:

this

displayName

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

Sets the value of CfnRetrieverMixinProps.getDisplayName()

Parameters:

displayName - The name of your retriever.

Returns:

this

roleArn

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

Sets the value of CfnRetrieverMixinProps.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 CfnRetrieverMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnRetrieverMixinProps.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

type

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

Sets the value of CfnRetrieverMixinProps.getType()

Parameters:

type - The type of your retriever.

Returns:

this

build

@Stability(Stable)
public CfnRetrieverMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnRetrieverMixinProps

Throws:

NullPointerException - if any required attribute was not provided