CfnPluginPropsMixin

class aws_cdk.mixins_preview.aws_qbusiness.mixins.CfnPluginPropsMixin(props, *, strategy=None)

Bases: Mixin

Information about an Amazon Q Business plugin and its configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html
CloudformationResource:: AWS::QBusiness::Plugin
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

# no_auth_configuration: Any

cfn_plugin_props_mixin = qbusiness_mixins.CfnPluginPropsMixin(qbusiness_mixins.CfnPluginMixinProps(
    application_id="applicationId",
    auth_configuration=qbusiness_mixins.CfnPluginPropsMixin.PluginAuthConfigurationProperty(
        basic_auth_configuration=qbusiness_mixins.CfnPluginPropsMixin.BasicAuthConfigurationProperty(
            role_arn="roleArn",
            secret_arn="secretArn"
        ),
        no_auth_configuration=no_auth_configuration,
        o_auth2_client_credential_configuration=qbusiness_mixins.CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty(
            authorization_url="authorizationUrl",
            role_arn="roleArn",
            secret_arn="secretArn",
            token_url="tokenUrl"
        )
    ),
    custom_plugin_configuration=qbusiness_mixins.CfnPluginPropsMixin.CustomPluginConfigurationProperty(
        api_schema=qbusiness_mixins.CfnPluginPropsMixin.APISchemaProperty(
            payload="payload",
            s3=qbusiness_mixins.CfnPluginPropsMixin.S3Property(
                bucket="bucket",
                key="key"
            )
        ),
        api_schema_type="apiSchemaType",
        description="description"
    ),
    display_name="displayName",
    server_url="serverUrl",
    state="state",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::QBusiness::Plugin.

Parameters:

props (Union[CfnPluginMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['applicationId', 'authConfiguration', 'customPluginConfiguration', 'displayName', 'serverUrl', 'state', 'tags', 'type']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

APISchemaProperty

class CfnPluginPropsMixin.APISchemaProperty(*, payload=None, s3=None)

Bases: object

Contains details about the OpenAPI schema for a custom plugin.

For more information, see custom plugin OpenAPI schemas . You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

Parameters:

payload (Optional[str]) – The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
s3 (Union[IResolvable, S3Property, Dict[str, Any], None]) – Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-apischema.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.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

a_pISchema_property = qbusiness_mixins.CfnPluginPropsMixin.APISchemaProperty(
    payload="payload",
    s3=qbusiness_mixins.CfnPluginPropsMixin.S3Property(
        bucket="bucket",
        key="key"
    )
)

Attributes

payload

The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-apischema.html#cfn-qbusiness-plugin-apischema-payload

s3

Contains details about the S3 object containing the OpenAPI schema for a custom plugin.

The schema could be in either JSON or YAML format.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-apischema.html#cfn-qbusiness-plugin-apischema-s3

BasicAuthConfigurationProperty

class CfnPluginPropsMixin.BasicAuthConfigurationProperty(*, role_arn=None, secret_arn=None)

Bases: object

Information about the basic authentication credentials used to configure a plugin.

Parameters:

role_arn (Optional[str]) – The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
secret_arn (Optional[str]) – The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-basicauthconfiguration.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.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

basic_auth_configuration_property = qbusiness_mixins.CfnPluginPropsMixin.BasicAuthConfigurationProperty(
    role_arn="roleArn",
    secret_arn="secretArn"
)

Attributes

role_arn

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-basicauthconfiguration.html#cfn-qbusiness-plugin-basicauthconfiguration-rolearn

secret_arn

The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-basicauthconfiguration.html#cfn-qbusiness-plugin-basicauthconfiguration-secretarn

CustomPluginConfigurationProperty

class CfnPluginPropsMixin.CustomPluginConfigurationProperty(*, api_schema=None, api_schema_type=None, description=None)

Bases: object

Configuration information required to create a custom plugin.

Parameters:

api_schema (Union[IResolvable, APISchemaProperty, Dict[str, Any], None]) – Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
api_schema_type (Optional[str]) – The type of OpenAPI schema to use.
description (Optional[str]) – A description for your custom plugin configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.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.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

custom_plugin_configuration_property = qbusiness_mixins.CfnPluginPropsMixin.CustomPluginConfigurationProperty(
    api_schema=qbusiness_mixins.CfnPluginPropsMixin.APISchemaProperty(
        payload="payload",
        s3=qbusiness_mixins.CfnPluginPropsMixin.S3Property(
            bucket="bucket",
            key="key"
        )
    ),
    api_schema_type="apiSchemaType",
    description="description"
)

Attributes

api_schema

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.

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

api_schema_type

The type of OpenAPI schema to use.

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

description

A description for your custom plugin configuration.

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

OAuth2ClientCredentialConfigurationProperty

class CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty(*, authorization_url=None, role_arn=None, secret_arn=None, token_url=None)

Bases: object

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

Parameters:

authorization_url (Optional[str]) – The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.
role_arn (Optional[str]) – The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
secret_arn (Optional[str]) – The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
token_url (Optional[str]) – The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.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.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

o_auth2_client_credential_configuration_property = qbusiness_mixins.CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty(
    authorization_url="authorizationUrl",
    role_arn="roleArn",
    secret_arn="secretArn",
    token_url="tokenUrl"
)

Attributes

authorization_url

The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.html#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-authorizationurl

role_arn

The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.html#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-rolearn

secret_arn

The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.html#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-secretarn

token_url

The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.html#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-tokenurl

PluginAuthConfigurationProperty

class CfnPluginPropsMixin.PluginAuthConfigurationProperty(*, basic_auth_configuration=None, no_auth_configuration=None, o_auth2_client_credential_configuration=None)

Bases: object

Authentication configuration information for an Amazon Q Business plugin.

Parameters:

basic_auth_configuration (Union[IResolvable, BasicAuthConfigurationProperty, Dict[str, Any], None]) – Information about the basic authentication credentials used to configure a plugin.
no_auth_configuration (Any) – Information about invoking a custom plugin without any authentication.
o_auth2_client_credential_configuration (Union[IResolvable, OAuth2ClientCredentialConfigurationProperty, Dict[str, Any], None]) – Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.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.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

# no_auth_configuration: Any

plugin_auth_configuration_property = qbusiness_mixins.CfnPluginPropsMixin.PluginAuthConfigurationProperty(
    basic_auth_configuration=qbusiness_mixins.CfnPluginPropsMixin.BasicAuthConfigurationProperty(
        role_arn="roleArn",
        secret_arn="secretArn"
    ),
    no_auth_configuration=no_auth_configuration,
    o_auth2_client_credential_configuration=qbusiness_mixins.CfnPluginPropsMixin.OAuth2ClientCredentialConfigurationProperty(
        authorization_url="authorizationUrl",
        role_arn="roleArn",
        secret_arn="secretArn",
        token_url="tokenUrl"
    )
)

Attributes

basic_auth_configuration

Information about the basic authentication credentials used to configure a plugin.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.html#cfn-qbusiness-plugin-pluginauthconfiguration-basicauthconfiguration

no_auth_configuration

Information about invoking a custom plugin without any authentication.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.html#cfn-qbusiness-plugin-pluginauthconfiguration-noauthconfiguration

o_auth2_client_credential_configuration

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.html#cfn-qbusiness-plugin-pluginauthconfiguration-oauth2clientcredentialconfiguration

S3Property

class CfnPluginPropsMixin.S3Property(*, bucket=None, key=None)

Bases: object

Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.

Parameters:

bucket (Optional[str]) – The name of the S3 bucket that contains the file.
key (Optional[str]) – The name of the file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-s3.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.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

s3_property = qbusiness_mixins.CfnPluginPropsMixin.S3Property(
    bucket="bucket",
    key="key"
)

Attributes

bucket

The name of the S3 bucket that contains the file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-s3.html#cfn-qbusiness-plugin-s3-bucket

key

The name of the file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-s3.html#cfn-qbusiness-plugin-s3-key