data_accessors

Creates, updates, deletes or gets a data_accessor resource or lists data_accessors in a region

Overview

Name	data_accessors
Type	Resource
Description	Definition of AWS::QBusiness::DataAccessor Resource Type
Id	aws.qbusiness.data_accessors

Fields

Name	Datatype	Description
action_configurations	array
application_id	string
created_at	string
data_accessor_arn	string
data_accessor_id	string
display_name	string
idc_application_arn	string
principal	string
tags	array
updated_at	string
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ApplicationId, ActionConfigurations, DisplayName, Principal, 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 data_accessors in a region.

SELECT
region,
action_configurations,
application_id,
created_at,
data_accessor_arn,
data_accessor_id,
display_name,
idc_application_arn,
principal,
tags,
updated_at
FROM aws.qbusiness.data_accessors
WHERE region = 'us-east-1';

Gets all properties from an individual data_accessor.

SELECT
region,
action_configurations,
application_id,
created_at,
data_accessor_arn,
data_accessor_id,
display_name,
idc_application_arn,
principal,
tags,
updated_at
FROM aws.qbusiness.data_accessors
WHERE region = 'us-east-1' AND data__Identifier = '<ApplicationId>|<DataAccessorId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.qbusiness.data_accessors (
 ActionConfigurations,
 ApplicationId,
 DisplayName,
 Principal,
 region
)
SELECT 
'{{ ActionConfigurations }}',
 '{{ ApplicationId }}',
 '{{ DisplayName }}',
 '{{ Principal }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.qbusiness.data_accessors (
 ActionConfigurations,
 ApplicationId,
 DisplayName,
 Principal,
 Tags,
 region
)
SELECT 
 '{{ ActionConfigurations }}',
 '{{ ApplicationId }}',
 '{{ DisplayName }}',
 '{{ Principal }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: data_accessor
    props:
      - name: ActionConfigurations
        value:
          - Action: '{{ Action }}'
            FilterConfiguration:
              DocumentAttributeFilter:
                AndAllFilters:
                  - null
                OrAllFilters:
                  - null
                NotFilter: null
                EqualsTo:
                  Name: '{{ Name }}'
                  Value: null
                ContainsAll: null
                ContainsAny: null
                GreaterThan: null
                GreaterThanOrEquals: null
                LessThan: null
                LessThanOrEquals: null
      - name: ApplicationId
        value: '{{ ApplicationId }}'
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: Principal
        value: '{{ Principal }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

qbusiness:CreateDataAccessor,
qbusiness:GetDataAccessor,
qbusiness:ListTagsForResource,
qbusiness:TagResource,
sso:CreateApplication,
sso:PutApplicationAuthenticationMethod,
sso:PutApplicationGrant,
sso:PutApplicationAccessScope

Read

qbusiness:GetDataAccessor,
qbusiness:ListTagsForResource

Update

qbusiness:GetDataAccessor,
qbusiness:ListTagsForResource,
qbusiness:TagResource,
qbusiness:UntagResource,
qbusiness:UpdateDataAccessor

Delete

qbusiness:DeleteDataAccessor,
qbusiness:GetDataAccessor,
sso:DeleteApplication

List

qbusiness:ListDataAccessors