folders

Creates, updates, deletes or gets a folder resource or lists folders in a region

Overview

Name	folders
Type	Resource
Description	Definition of the AWS::QuickSight::Folder Resource Type.
Id	awscc.quicksight.folders

Fields

get (all properties)

Name	Datatype	Description
arn	string	<p>The Amazon Resource Name (ARN) for the folder.</p>
aws_account_id	string
created_time	string	<p>The time that the folder was created.</p>
folder_id	string
folder_type	string
last_updated_time	string	<p>The time that the folder was last updated.</p>
name	string
parent_folder_arn	string
▶permissions	array
sharing_model	string
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
aws_account_id	string
folder_id	string
region	string	AWS region.

For more information, see AWS::QuickSight::Folder.

Methods

Name	Resource	Accessible by	Required Params
create_resource	folders	INSERT	region
delete_resource	folders	DELETE	Identifier, region
update_resource	folders	UPDATE	Identifier, PatchDocument, region
list_resources	folders_list_only	SELECT	region
get_resource	folders	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual folder.

SELECT
  region,
  arn,
  aws_account_id,
  created_time,
  folder_id,
  folder_type,
  last_updated_time,
  name,
  parent_folder_arn,
  permissions,
  sharing_model,
  tags
FROM awscc.quicksight.folders
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ aws_account_id }}|{{ folder_id }}';

list (identifiers only)

Lists all folders in a region.

SELECT
  region,
  aws_account_id,
  folder_id
FROM awscc.quicksight.folders_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.quicksight.folders (
  AwsAccountId,
  FolderId,
  FolderType,
  Name,
  ParentFolderArn,
  Permissions,
  SharingModel,
  Tags,
  region
)
SELECT
  '{{ aws_account_id }}',
  '{{ folder_id }}',
  '{{ folder_type }}',
  '{{ name }}',
  '{{ parent_folder_arn }}',
  '{{ permissions }}',
  '{{ sharing_model }}',
  '{{ tags }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.quicksight.folders (
  AwsAccountId,
  FolderId,
  FolderType,
  Name,
  ParentFolderArn,
  Permissions,
  SharingModel,
  Tags,
  region
)
SELECT
  '{{ aws_account_id }}',
  '{{ folder_id }}',
  '{{ folder_type }}',
  '{{ name }}',
  '{{ parent_folder_arn }}',
  '{{ permissions }}',
  '{{ sharing_model }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: folder
    props:
      - name: aws_account_id
        value: '{{ aws_account_id }}'
      - name: folder_id
        value: '{{ folder_id }}'
      - name: folder_type
        value: '{{ folder_type }}'
      - name: name
        value: '{{ name }}'
      - name: parent_folder_arn
        value: '{{ parent_folder_arn }}'
      - name: permissions
        value:
          - principal: '{{ principal }}'
            actions:
              - '{{ actions[0] }}'
      - name: sharing_model
        value: '{{ sharing_model }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.quicksight.folders
SET PatchDocument = string('{{ {
    "Name": name,
    "Permissions": permissions,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ aws_account_id }}|{{ folder_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.quicksight.folders
WHERE
  Identifier = '{{ aws_account_id }}|{{ folder_id }}' AND
  region = 'us-east-1';

Permissions

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

Read

quicksight:DescribeFolder,
quicksight:DescribeFolderPermissions,
quicksight:ListTagsForResource

Create

quicksight:CreateFolder,
quicksight:DescribeFolder,
quicksight:UpdateFolderPermissions,
quicksight:DescribeFolderPermissions,
quicksight:TagResource,
quicksight:ListTagsForResource

Update

quicksight:DescribeFolder,
quicksight:UpdateFolder,
quicksight:DescribeFolderPermissions,
quicksight:UpdateFolderPermissions,
quicksight:ListTagsForResource,
quicksight:TagResource,
quicksight:UntagResource

Delete

quicksight:DeleteFolder

List

quicksight:ListFolders