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

Class CfnPluginPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPluginPropsMixin>

Enclosing class:

CfnPluginPropsMixin

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

A fluent builder for CfnPluginPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnPluginPropsMixin.Builder	applicationId(String applicationId)	The identifier of the application that will contain the plugin.
CfnPluginPropsMixin.Builder	authConfiguration(CfnPluginPropsMixin.PluginAuthConfigurationProperty authConfiguration)	Authentication configuration information for an Amazon Q Business plugin.
CfnPluginPropsMixin.Builder	authConfiguration(IResolvable authConfiguration)	Authentication configuration information for an Amazon Q Business plugin.
CfnPluginPropsMixin	build()
static CfnPluginPropsMixin.Builder	create()
static CfnPluginPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnPluginPropsMixin.Builder	customPluginConfiguration(CfnPluginPropsMixin.CustomPluginConfigurationProperty customPluginConfiguration)	Configuration information required to create a custom plugin.
CfnPluginPropsMixin.Builder	customPluginConfiguration(IResolvable customPluginConfiguration)	Configuration information required to create a custom plugin.
CfnPluginPropsMixin.Builder	displayName(String displayName)	The name of the plugin.
CfnPluginPropsMixin.Builder	serverUrl(String serverUrl)	The plugin server URL used for configuration.
CfnPluginPropsMixin.Builder	state(String state)	The current status of the plugin.
CfnPluginPropsMixin.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs that identify or categorize the data source connector.
CfnPluginPropsMixin.Builder	type(String type)	The type of the plugin.

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 CfnPluginPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnPluginPropsMixin.Builder.

create

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

Returns:

a new instance of CfnPluginPropsMixin.Builder.

applicationId

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

The identifier of the application that will contain the plugin.

Parameters:

applicationId - The identifier of the application that will contain the plugin. This parameter is required.

Returns:

this

See Also:

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

authConfiguration

@Stability(Stable)
public CfnPluginPropsMixin.Builder authConfiguration(IResolvable authConfiguration)

Authentication configuration information for an Amazon Q Business plugin.

Parameters:

authConfiguration - Authentication configuration information for an Amazon Q Business plugin. This parameter is required.

Returns:

this

See Also:

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

authConfiguration

@Stability(Stable)
public CfnPluginPropsMixin.Builder authConfiguration(CfnPluginPropsMixin.PluginAuthConfigurationProperty authConfiguration)

Authentication configuration information for an Amazon Q Business plugin.

Parameters:

authConfiguration - Authentication configuration information for an Amazon Q Business plugin. This parameter is required.

Returns:

this

See Also:

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

customPluginConfiguration

@Stability(Stable)
public CfnPluginPropsMixin.Builder customPluginConfiguration(IResolvable customPluginConfiguration)

Configuration information required to create a custom plugin.

Parameters:

customPluginConfiguration - Configuration information required to create a custom plugin. This parameter is required.

Returns:

this

See Also:

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

customPluginConfiguration

@Stability(Stable)
public CfnPluginPropsMixin.Builder customPluginConfiguration(CfnPluginPropsMixin.CustomPluginConfigurationProperty customPluginConfiguration)

Configuration information required to create a custom plugin.

Parameters:

customPluginConfiguration - Configuration information required to create a custom plugin. This parameter is required.

Returns:

this

See Also:

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

displayName

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

The name of the plugin.

Parameters:

displayName - The name of the plugin. This parameter is required.

Returns:

this

See Also:

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

serverUrl

@Stability(Stable)
public CfnPluginPropsMixin.Builder serverUrl(String serverUrl)

The plugin server URL used for configuration.

Parameters:

serverUrl - The plugin server URL used for configuration. This parameter is required.

Returns:

this

See Also:

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

state

@Stability(Stable)
public CfnPluginPropsMixin.Builder state(String state)

The current status of the plugin.

Parameters:

state - The current status of the plugin. This parameter is required.

Returns:

this

See Also:

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

tags

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

A list of key-value pairs that identify or categorize the data source connector.

You can also use tags to help control access to the data source connector. 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 data source connector. This parameter is required.

Returns:

this

See Also:

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

type

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

The type of the plugin.

Parameters:

type - The type of the plugin. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnPluginPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnPluginPropsMixin.