permissions

Creates, updates, deletes or gets a permission resource or lists permissions in a region

Overview

Name	permissions
Type	Resource
Description	Definition of AWS::QBusiness::Permission Resource Type
Id	awscc.qbusiness.permissions

Fields

get (all properties)

Name	Datatype	Description
application_id	string
statement_id	string
actions	array
▶conditions	array
principal	string
region	string	AWS region.

list (identifiers only)

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

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	permissions	INSERT	ApplicationId, StatementId, Actions, Principal, region
delete_resource	permissions	DELETE	Identifier, region
list_resources	permissions_list_only	SELECT	region
get_resource	permissions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual permission.

SELECT
  region,
  application_id,
  statement_id,
  actions,
  conditions,
  principal
FROM awscc.qbusiness.permissions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_id }}|{{ statement_id }}';

list (identifiers only)

Lists all permissions in a region.

SELECT
  region,
  application_id,
  statement_id
FROM awscc.qbusiness.permissions_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.qbusiness.permissions (
  ApplicationId,
  StatementId,
  Actions,
  Principal,
  region
)
SELECT
  '{{ application_id }}',
  '{{ statement_id }}',
  '{{ actions }}',
  '{{ principal }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.qbusiness.permissions (
  ApplicationId,
  StatementId,
  Actions,
  Conditions,
  Principal,
  region
)
SELECT
  '{{ application_id }}',
  '{{ statement_id }}',
  '{{ actions }}',
  '{{ conditions }}',
  '{{ principal }}',
  '{{ 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: permission
  props:
    - name: application_id
      value: '{{ application_id }}'
    - name: statement_id
      value: '{{ statement_id }}'
    - name: actions
      value:
        - '{{ actions[0] }}'
    - name: conditions
      value:
        - condition_operator: '{{ condition_operator }}'
          condition_key: '{{ condition_key }}'
          condition_values:
            - '{{ condition_values[0] }}'
    - name: principal
      value: '{{ principal }}'

DELETE example

/*+ delete */
DELETE FROM awscc.qbusiness.permissions
WHERE
  Identifier = '{{ application_id }}|{{ statement_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 permissions resource, the following permissions are required:

Create

qbusiness:AssociatePermission,
qbusiness:PutResourcePolicy

Read

qbusiness:GetPolicy

Delete

qbusiness:DisassociatePermission,
qbusiness:PutResourcePolicy

List

qbusiness:GetPolicy