Package software.amazon.awscdk.services.qbusiness

Interface CfnPluginProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPluginProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:19.319Z")
@Stability(Stable)
public interface CfnPluginProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPlugin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.qbusiness.*;
 Object noAuthConfiguration;
 CfnPluginProps cfnPluginProps = CfnPluginProps.builder()
         .applicationId("applicationId")
         .authConfiguration(PluginAuthConfigurationProperty.builder()
                 .basicAuthConfiguration(BasicAuthConfigurationProperty.builder()
                         .roleArn("roleArn")
                         .secretArn("secretArn")
                         .build())
                 .noAuthConfiguration(noAuthConfiguration)
                 .oAuth2ClientCredentialConfiguration(OAuth2ClientCredentialConfigurationProperty.builder()
                         .roleArn("roleArn")
                         .secretArn("secretArn")
                         .build())
                 .build())
         .displayName("displayName")
         .type("type")
         // the properties below are optional
         .customPluginConfiguration(CustomPluginConfigurationProperty.builder()
                 .apiSchema(APISchemaProperty.builder()
                         .payload("payload")
                         .s3(S3Property.builder()
                                 .bucket("bucket")
                                 .key("key")
                                 .build())
                         .build())
                 .apiSchemaType("apiSchemaType")
                 .description("description")
                 .build())
         .serverUrl("serverUrl")
         .state("state")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPluginProps.Builder	A builder for CfnPluginProps
static final class	CfnPluginProps.Jsii$Proxy	An implementation for CfnPluginProps

Method Summary

Modifier and Type	Method	Description
static CfnPluginProps.Builder	builder()
String	getApplicationId()	The identifier of the application that will contain the plugin.
Object	getAuthConfiguration()	Authentication configuration information for an Amazon Q Business plugin.
default Object	getCustomPluginConfiguration()	Configuration information required to create a custom plugin.
String	getDisplayName()	The name of the plugin.
default String	getServerUrl()	The plugin server URL used for configuration.
default String	getState()	The current status of the plugin.
default List<CfnTag>	getTags()	A list of key-value pairs that identify or categorize the data source connector.
String	getType()	The type of the plugin.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationId

@Stability(Stable)
@NotNull
String getApplicationId()

The identifier of the application that will contain the plugin.

See Also:

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

getAuthConfiguration

@Stability(Stable)
@NotNull
Object getAuthConfiguration()

Authentication configuration information for an Amazon Q Business plugin.

See Also:

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

getDisplayName

@Stability(Stable)
@NotNull
String getDisplayName()

The name of the plugin.

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

The type of the plugin.

See Also:

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

getCustomPluginConfiguration

@Stability(Stable)
@Nullable
default Object getCustomPluginConfiguration()

Configuration information required to create a custom plugin.

See Also:

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

getServerUrl

@Stability(Stable)
@Nullable
default String getServerUrl()

The plugin server URL used for configuration.

See Also:

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

getState

@Stability(Stable)
@Nullable
default String getState()

The current status of the plugin.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnPluginProps.Builder builder()

Returns:

a CfnPluginProps.Builder of CfnPluginProps