custom_permissions

Creates, updates, deletes or gets a custom_permission resource or lists custom_permissions in a region

Overview

Name	custom_permissions
Type	Resource
Description	Definition of the AWS::QuickSight::CustomPermissions Resource Type.
Id	aws.quicksight.custom_permissions

Fields

Name	Datatype	Description
arn	string
aws_account_id	string
capabilities	object
custom_permissions_name	string
tags	array
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	AwsAccountId, CustomPermissionsName, 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 custom_permissions in a region.

SELECT
region,
arn,
aws_account_id,
capabilities,
custom_permissions_name,
tags
FROM aws.quicksight.custom_permissions
WHERE region = 'us-east-1';

Gets all properties from an individual custom_permission.

SELECT
region,
arn,
aws_account_id,
capabilities,
custom_permissions_name,
tags
FROM aws.quicksight.custom_permissions
WHERE region = 'us-east-1' AND data__Identifier = '<AwsAccountId>|<CustomPermissionsName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.quicksight.custom_permissions (
 AwsAccountId,
 CustomPermissionsName,
 region
)
SELECT 
'{{ AwsAccountId }}',
 '{{ CustomPermissionsName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.quicksight.custom_permissions (
 AwsAccountId,
 Capabilities,
 CustomPermissionsName,
 Tags,
 region
)
SELECT 
 '{{ AwsAccountId }}',
 '{{ Capabilities }}',
 '{{ CustomPermissionsName }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: custom_permission
    props:
      - name: AwsAccountId
        value: '{{ AwsAccountId }}'
      - name: Capabilities
        value:
          ExportToCsv: '{{ ExportToCsv }}'
          ExportToExcel: null
          CreateAndUpdateThemes: null
          AddOrRunAnomalyDetectionForAnalyses: null
          ShareAnalyses: null
          CreateAndUpdateDatasets: null
          ShareDatasets: null
          SubscribeDashboardEmailReports: null
          CreateAndUpdateDashboardEmailReports: null
          ShareDashboards: null
          CreateAndUpdateThresholdAlerts: null
          RenameSharedFolders: null
          CreateSharedFolders: null
          CreateAndUpdateDataSources: null
          ShareDataSources: null
          ViewAccountSPICECapacity: null
          CreateSPICEDataset: null
      - name: CustomPermissionsName
        value: '{{ CustomPermissionsName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.quicksight.custom_permissions
WHERE data__Identifier = '<AwsAccountId|CustomPermissionsName>'
AND region = 'us-east-1';

Permissions

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

Create

quicksight:CreateCustomPermissions,
quicksight:TagResource

Read

quicksight:DescribeCustomPermissions,
quicksight:ListTagsForResource

Update

quicksight:UpdateCustomPermissions,
quicksight:TagResource,
quicksight:UntagResource,
quicksight:ListTagsForResource

Delete

quicksight:DeleteCustomPermissions

List

quicksight:ListCustomPermissions