CfnPluginProps

class aws_cdk.aws_qbusiness.CfnPluginProps(*, application_id, auth_configuration, display_name, type, custom_plugin_configuration=None, server_url=None, state=None, tags=None)

Bases: object

Properties for defining a CfnPlugin.

Parameters:

• application_id (str) – The identifier of the application that will contain the plugin.

• auth_configuration (Union[IResolvable, PluginAuthConfigurationProperty, Dict[str, Any]]) – Authentication configuration information for an Amazon Q Business plugin.

• display_name (str) – The name of the plugin.

• type (str) – The type of the plugin.

• custom_plugin_configuration (Union[IResolvable, CustomPluginConfigurationProperty, Dict[str, Any], None]) – Configuration information required to create a custom plugin.

• server_url (Optional[str]) – The plugin server URL used for configuration.

• state (Optional[str]) – The current status of the plugin.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_qbusiness as qbusiness

# no_auth_configuration: Any

cfn_plugin_props = qbusiness.CfnPluginProps(
    application_id="applicationId",
    auth_configuration=qbusiness.CfnPlugin.PluginAuthConfigurationProperty(
        basic_auth_configuration=qbusiness.CfnPlugin.BasicAuthConfigurationProperty(
            role_arn="roleArn",
            secret_arn="secretArn"
        ),
        no_auth_configuration=no_auth_configuration,
        o_auth2_client_credential_configuration=qbusiness.CfnPlugin.OAuth2ClientCredentialConfigurationProperty(
            role_arn="roleArn",
            secret_arn="secretArn"
        )
    ),
    display_name="displayName",
    type="type",

    # the properties below are optional
    custom_plugin_configuration=qbusiness.CfnPlugin.CustomPluginConfigurationProperty(
        api_schema=qbusiness.CfnPlugin.APISchemaProperty(
            payload="payload",
            s3=qbusiness.CfnPlugin.S3Property(
                bucket="bucket",
                key="key"
            )
        ),
        api_schema_type="apiSchemaType",
        description="description"
    ),
    server_url="serverUrl",
    state="state",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

application_id

The identifier of the application that will contain the plugin.

See:

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

auth_configuration

Authentication configuration information for an Amazon Q Business plugin.

See:

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

custom_plugin_configuration

Configuration information required to create a custom plugin.

See:

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

display_name

The name of the plugin.

See:

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

server_url

The plugin server URL used for configuration.

See:

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

state

The current status of the plugin.

See:

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

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

See:

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

:: .

type

The type of the plugin.

See:

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