plugins

Creates, updates, deletes or gets a plugin resource or lists plugins in a region

Overview

Name	plugins
Type	Resource
Description	Definition of AWS::QBusiness::Plugin Resource Type
Id	aws.qbusiness.plugins

Fields

Name	Datatype	Description
application_id	string
auth_configuration	undefined
build_status	string
created_at	string
custom_plugin_configuration	object
display_name	string
plugin_arn	string
plugin_id	string
server_url	string
state	string
tags	array
type	string
updated_at	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ApplicationId, AuthConfiguration, DisplayName, Type, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all plugins in a region.

SELECT
region,
application_id,
auth_configuration,
build_status,
created_at,
custom_plugin_configuration,
display_name,
plugin_arn,
plugin_id,
server_url,
state,
tags,
type,
updated_at
FROM aws.qbusiness.plugins
WHERE region = 'us-east-1';

Gets all properties from an individual plugin.

SELECT
region,
application_id,
auth_configuration,
build_status,
created_at,
custom_plugin_configuration,
display_name,
plugin_arn,
plugin_id,
server_url,
state,
tags,
type,
updated_at
FROM aws.qbusiness.plugins
WHERE region = 'us-east-1' AND data__Identifier = '<ApplicationId>|<PluginId>';

INSERT example

Use the following StackQL query and manifest file to create a new plugin resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.qbusiness.plugins (
 ApplicationId,
 AuthConfiguration,
 DisplayName,
 Type,
 region
)
SELECT 
'{{ ApplicationId }}',
 '{{ AuthConfiguration }}',
 '{{ DisplayName }}',
 '{{ Type }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.qbusiness.plugins (
 ApplicationId,
 AuthConfiguration,
 CustomPluginConfiguration,
 DisplayName,
 ServerUrl,
 State,
 Tags,
 Type,
 region
)
SELECT 
 '{{ ApplicationId }}',
 '{{ AuthConfiguration }}',
 '{{ CustomPluginConfiguration }}',
 '{{ DisplayName }}',
 '{{ ServerUrl }}',
 '{{ State }}',
 '{{ Tags }}',
 '{{ Type }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: plugin
    props:
      - name: ApplicationId
        value: '{{ ApplicationId }}'
      - name: AuthConfiguration
        value: null
      - name: CustomPluginConfiguration
        value:
          Description: '{{ Description }}'
          ApiSchemaType: '{{ ApiSchemaType }}'
          ApiSchema: null
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: ServerUrl
        value: '{{ ServerUrl }}'
      - name: State
        value: '{{ State }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Type
        value: '{{ Type }}'

DELETE example

/*+ delete */
DELETE FROM aws.qbusiness.plugins
WHERE data__Identifier = '<ApplicationId|PluginId>'
AND region = 'us-east-1';

Permissions

To operate on the plugins resource, the following permissions are required:

Create

iam:PassRole,
qbusiness:CreatePlugin,
qbusiness:GetPlugin,
qbusiness:ListTagsForResource,
qbusiness:TagResource,
qbusiness:UpdatePlugin

Read

qbusiness:GetPlugin,
qbusiness:ListTagsForResource

Update

iam:PassRole,
qbusiness:GetPlugin,
qbusiness:ListTagsForResource,
qbusiness:TagResource,
qbusiness:UntagResource,
qbusiness:UpdatePlugin

Delete

qbusiness:DeletePlugin,
qbusiness:GetPlugin

List

qbusiness:ListPlugins