AWS::QBusiness::Plugin

Information about an Amazon Q Business plugin and its configuration.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::QBusiness::Plugin",
  "Properties" : {
      "ApplicationId" : String,
      "AuthConfiguration" : PluginAuthConfiguration,
      "CustomPluginConfiguration" : CustomPluginConfiguration,
      "DisplayName" : String,
      "ServerUrl" : String,
      "State" : String,
      "Tags" : [ Tag, ... ],
      "Type" : String
    }
}

YAML

Type: AWS::QBusiness::Plugin
Properties:
  ApplicationId: String
  AuthConfiguration: 
    PluginAuthConfiguration
  CustomPluginConfiguration: 
    CustomPluginConfiguration
  DisplayName: String
  ServerUrl: String
  State: String
  Tags: 
    - Tag
  Type: String

Properties

ApplicationId

The identifier of the application that will contain the plugin.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$

Minimum: 36

Maximum: 36

Update requires: Replacement

AuthConfiguration

Authentication configuration information for an Amazon Q Business plugin.

Required: Yes

Type: PluginAuthConfiguration

Update requires: No interruption

CustomPluginConfiguration

Configuration information required to create a custom plugin.

Required: No

Type: CustomPluginConfiguration

Update requires: No interruption

DisplayName

The name of the plugin.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$

Minimum: 1

Maximum: 100

Update requires: No interruption

ServerUrl

The plugin server URL used for configuration.

Required: No

Type: String

Pattern: ^(https?|ftp|file)://([^\s]*)$

Minimum: 1

Maximum: 2048

Update requires: No interruption

State

The current status of the plugin.

Required: No

Type: String

Allowed values: ENABLED | DISABLED

Update requires: No interruption

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

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Type

The type of the plugin.

Required: Yes

Type: String

Allowed values: SERVICE_NOW | SALESFORCE | JIRA | ZENDESK | CUSTOM

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the application ID and plugin ID. For example:

{"Ref": "ApplicationId|PluginId"}

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

BuildStatus

The current status of a plugin. A plugin is modified asynchronously.

CreatedAt

The timestamp for when the plugin was created.

PluginArn

The Amazon Resource Name (ARN) of a plugin.

PluginId

The identifier of the plugin.

UpdatedAt

The timestamp for when the plugin was last updated.