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

Fields

get (all properties)

Name	Datatype	Description
▶action_configurations	array
application_id	string
▶authentication_detail	object
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.

list (identifiers only)

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

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	data_accessors	INSERT	ApplicationId, ActionConfigurations, DisplayName, Principal, region
delete_resource	data_accessors	DELETE	Identifier, region
update_resource	data_accessors	UPDATE	Identifier, PatchDocument, region
list_resources	data_accessors_list_only	SELECT	region
get_resource	data_accessors	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual data_accessor.

SELECT
  region,
  action_configurations,
  application_id,
  authentication_detail,
  created_at,
  data_accessor_arn,
  data_accessor_id,
  display_name,
  idc_application_arn,
  principal,
  tags,
  updated_at
FROM awscc.qbusiness.data_accessors
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ application_id }}|{{ data_accessor_id }}';

list (identifiers only)

Lists all data_accessors in a region.

SELECT
  region,
  application_id,
  data_accessor_id
FROM awscc.qbusiness.data_accessors_list_only
WHERE
  region = 'us-east-1';

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 awscc.qbusiness.data_accessors (
  ActionConfigurations,
  ApplicationId,
  DisplayName,
  Principal,
  region
)
SELECT
  '{{ action_configurations }}',
  '{{ application_id }}',
  '{{ display_name }}',
  '{{ principal }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.qbusiness.data_accessors (
  ActionConfigurations,
  ApplicationId,
  AuthenticationDetail,
  DisplayName,
  Principal,
  Tags,
  region
)
SELECT
  '{{ action_configurations }}',
  '{{ application_id }}',
  '{{ authentication_detail }}',
  '{{ display_name }}',
  '{{ 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: action_configurations
        value:
          - action: '{{ action }}'
            filter_configuration:
              document_attribute_filter:
                and_all_filters:
                  - null
                or_all_filters:
                  - null
                not_filter: null
                equals_to:
                  name: '{{ name }}'
                  value: null
                contains_all: null
                contains_any: null
                greater_than: null
                greater_than_or_equals: null
                less_than: null
                less_than_or_equals: null
      - name: application_id
        value: '{{ application_id }}'
      - name: authentication_detail
        value:
          authentication_type: '{{ authentication_type }}'
          authentication_configuration: null
          external_ids:
            - '{{ external_ids[0] }}'
      - name: display_name
        value: '{{ display_name }}'
      - name: principal
        value: '{{ principal }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.qbusiness.data_accessors
SET PatchDocument = string('{{ {
    "ActionConfigurations": action_configurations,
    "AuthenticationDetail": authentication_detail,
    "DisplayName": display_name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_id }}|{{ data_accessor_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.qbusiness.data_accessors
WHERE
  Identifier = '{{ application_id }}|{{ data_accessor_id }}' 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:CreateDataAccessorWithTti,
qbusiness:TagResource,
sso:CreateApplication,
sso:PutApplicationAuthenticationMethod,
sso:PutApplicationGrant,
sso:PutApplicationAccessScope,
sso:DescribeTrustedTokenIssuer

Read

qbusiness:GetDataAccessor,
qbusiness:ListTagsForResource

Update

qbusiness:GetDataAccessor,
qbusiness:ListTagsForResource,
qbusiness:TagResource,
qbusiness:UntagResource,
qbusiness:UpdateDataAccessor,
sso:PutApplicationAuthenticationMethod,
sso:PutApplicationGrant,
sso:PutApplicationAccessScope,
sso:DescribeTrustedTokenIssuer,
sso:UpdateApplication

Delete

qbusiness:DeleteDataAccessor,
qbusiness:GetDataAccessor,
sso:DeleteApplication

List

qbusiness:ListDataAccessors