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	awscc.qbusiness.plugins

Fields

get (all properties)

Name	Datatype	Description
application_id	string
auth_configuration	object
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.

list (identifiers only)

Name	Datatype	Description
application_id	string
plugin_id	string
region	string	AWS region.

For more information, see AWS::QBusiness::Plugin.

Methods

Name	Resource	Accessible by	Required Params
create_resource	plugins	INSERT	AuthConfiguration, DisplayName, Type, region
delete_resource	plugins	DELETE	Identifier, region
update_resource	plugins	UPDATE	Identifier, PatchDocument, region
list_resources	plugins_list_only	SELECT	region
get_resource	plugins	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.qbusiness.plugins
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_id }}|{{ plugin_id }}';

list (identifiers only)

Lists all plugins in a region.

SELECT
  region,
  application_id,
  plugin_id
FROM awscc.qbusiness.plugins_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.qbusiness.plugins (
  AuthConfiguration,
  DisplayName,
  Type,
  region
)
SELECT
  '{{ auth_configuration }}',
  '{{ display_name }}',
  '{{ type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.qbusiness.plugins (
  ApplicationId,
  AuthConfiguration,
  CustomPluginConfiguration,
  DisplayName,
  ServerUrl,
  State,
  Tags,
  Type,
  region
)
SELECT
  '{{ application_id }}',
  '{{ auth_configuration }}',
  '{{ custom_plugin_configuration }}',
  '{{ display_name }}',
  '{{ server_url }}',
  '{{ state }}',
  '{{ tags }}',
  '{{ type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: plugin
  props:
    - name: application_id
      value: '{{ application_id }}'
    - name: auth_configuration
      value: null
    - name: custom_plugin_configuration
      value:
        description: '{{ description }}'
        api_schema_type: '{{ api_schema_type }}'
        api_schema: null
    - name: display_name
      value: '{{ display_name }}'
    - name: server_url
      value: '{{ server_url }}'
    - name: state
      value: '{{ state }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: type
      value: '{{ type }}'

UPDATE example

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

/*+ update */
UPDATE awscc.qbusiness.plugins
SET PatchDocument = string('{{ {
    "AuthConfiguration": auth_configuration,
    "CustomPluginConfiguration": custom_plugin_configuration,
    "DisplayName": display_name,
    "ServerUrl": server_url,
    "State": state,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_id }}|{{ plugin_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.qbusiness.plugins
WHERE
  Identifier = '{{ application_id }}|{{ plugin_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

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

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