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	awscc.quicksight.custom_permissions

Fields

get (all properties)

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

list (identifiers only)

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

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	custom_permissions	INSERT	AwsAccountId, CustomPermissionsName, region
delete_resource	custom_permissions	DELETE	Identifier, region
update_resource	custom_permissions	UPDATE	Identifier, PatchDocument, region
list_resources	custom_permissions_list_only	SELECT	region
get_resource	custom_permissions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual custom_permission.

SELECT
  region,
  arn,
  aws_account_id,
  capabilities,
  custom_permissions_name,
  tags
FROM awscc.quicksight.custom_permissions
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ aws_account_id }}|{{ custom_permissions_name }}';

list (identifiers only)

Lists all custom_permissions in a region.

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

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 awscc.quicksight.custom_permissions (
  AwsAccountId,
  CustomPermissionsName,
  region
)
SELECT
  '{{ aws_account_id }}',
  '{{ custom_permissions_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.quicksight.custom_permissions (
  AwsAccountId,
  Capabilities,
  CustomPermissionsName,
  Tags,
  region
)
SELECT
  '{{ aws_account_id }}',
  '{{ capabilities }}',
  '{{ custom_permissions_name }}',
  '{{ 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: aws_account_id
        value: '{{ aws_account_id }}'
      - name: capabilities
        value:
          export_to_csv: '{{ export_to_csv }}'
          export_to_excel: null
          export_to_pdf: null
          print_reports: null
          create_and_update_themes: null
          add_or_run_anomaly_detection_for_analyses: null
          share_analyses: null
          create_and_update_datasets: null
          share_datasets: null
          subscribe_dashboard_email_reports: null
          create_and_update_dashboard_email_reports: null
          share_dashboards: null
          create_and_update_threshold_alerts: null
          rename_shared_folders: null
          create_shared_folders: null
          create_and_update_data_sources: null
          share_data_sources: null
          view_account_sp_ic_ecapacity: null
          create_sp_ic_edataset: null
          export_to_pdf_in_scheduled_reports: null
          export_to_csv_in_scheduled_reports: null
          export_to_excel_in_scheduled_reports: null
          include_content_in_scheduled_reports_email: null
      - name: custom_permissions_name
        value: '{{ custom_permissions_name }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.quicksight.custom_permissions
SET PatchDocument = string('{{ {
    "Capabilities": capabilities,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ aws_account_id }}|{{ custom_permissions_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.quicksight.custom_permissions
WHERE
  Identifier = '{{ aws_account_id }}|{{ custom_permissions_name }}' 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