interface CfnPluginMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.QBusiness.Mixins.CfnPluginMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsqbusiness/mixins#CfnPluginMixinProps
Java	software.amazon.awscdk.mixins.preview.services.qbusiness.mixins.CfnPluginMixinProps
Python	aws_cdk.mixins_preview.aws_qbusiness.mixins.CfnPluginMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_qbusiness » mixins » CfnPluginMixinProps

Properties for CfnPluginPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as qbusiness_mixins } from '@aws-cdk/mixins-preview/aws-qbusiness';

declare const noAuthConfiguration: any;
const cfnPluginMixinProps: qbusiness_mixins.CfnPluginMixinProps = {
  applicationId: 'applicationId',
  authConfiguration: {
    basicAuthConfiguration: {
      roleArn: 'roleArn',
      secretArn: 'secretArn',
    },
    noAuthConfiguration: noAuthConfiguration,
    oAuth2ClientCredentialConfiguration: {
      authorizationUrl: 'authorizationUrl',
      roleArn: 'roleArn',
      secretArn: 'secretArn',
      tokenUrl: 'tokenUrl',
    },
  },
  customPluginConfiguration: {
    apiSchema: {
      payload: 'payload',
      s3: {
        bucket: 'bucket',
        key: 'key',
      },
    },
    apiSchemaType: 'apiSchemaType',
    description: 'description',
  },
  displayName: 'displayName',
  serverUrl: 'serverUrl',
  state: 'state',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
};

Properties

Name	Type	Description
applicationId?	string	The identifier of the application that will contain the plugin.
authConfiguration?	IResolvable | PluginAuthConfigurationProperty	Authentication configuration information for an Amazon Q Business plugin.
customPluginConfiguration?	IResolvable | CustomPluginConfigurationProperty	Configuration information required to create a custom plugin.
displayName?	string	The name of the plugin.
serverUrl?	string	The plugin server URL used for configuration.
state?	string	The current status of the plugin.
tags?	CfnTag[]	A list of key-value pairs that identify or categorize the data source connector.
type?	string	The type of the plugin.

---

applicationId?

Type: string (optional)

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

---

authConfiguration?

Type: IResolvable | PluginAuthConfigurationProperty (optional)

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

---

customPluginConfiguration?

Type: IResolvable | CustomPluginConfigurationProperty (optional)

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

---

displayName?

Type: string (optional)

The name of the plugin.

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

---

serverUrl?

Type: string (optional)

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

---

state?

Type: string (optional)

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

---

tags?

Type: CfnTag[] (optional)

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

---

type?

Type: string (optional)

The type of the plugin.

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