Cloudformation-coverage-roadmap: AWS::QuickSight::*

[pgarbe]

1. Title

AWS::QuickSight::*

2. Scope of request

There'se no QuickSight resources available, although the scope of the API has recently been extended.

3. Expected behavior

Create DataSets, Analysis, Dashboards and Reportings via CloudFormation.

5. Helpful Links to speed up research and evaluation

https://docs.aws.amazon.com/quicksight/latest/APIReference/API_Operations.html

6. Category (required)

1. Analytics (Athena, EMR, Glue,...)

[AndrewCi]

Is there any sort of timeline or update on when additional CloudFormation support for QuickSight will be available?

[humanzz]

Hi there... any updates on this?

[matthewcarlisle]

Bueller?

[rianwouters]

It's quite unclear to me why AWS keeps on building specific resources.
If you would only standardize a bit on the format of the HTTP API of the services, a custom resource could easily be build to have cloudformation support readily available as soon as the Service`s HTTP API / SDK support is available.
See started this already almost 2 years ago, but it was especially difficult because there is hardly any standardisation in the SDK interfaces. See https://github.com/rianwouters/cfn-customresources

[benzaam]

Hi ! Any update on this? This would come handy, certainly with creating templates. This is currently a pain to do with the AWS CLI...

[moltar]

@rohits-spec do you have any insight as to how soon this is coming? We are planning our deployment of QS right now, and we need to know whether to use work arounds or if CF will be supported any day now?

Will this take:

• [ ] week
• [ ] month
• [ ] quarter

?

Thanks! ❤️

[aidansteele]

Quicksight now has CloudFormation support for:

• AWS::QuickSight::Analysis
• AWS::QuickSight::Dashboard
• AWS::QuickSight::Template
• AWS::QuickSight::Theme

I haven't actually tried them yet to see how complete they are, but they arrived yesterday!

[moltar]

Ah cool.

I was hoping there'd be support for actually deploying the QS service itself.

It's annoying to do manual setup in staging, dev and testing.

Especially when all other parts are already automated with CDK.

[rohits-spec]

Closing this issue as Quicksight onboarded CloudFormation on 1/14.

[otakusid]

Any chances that samples with CloudFormation resources configuration will be added to the documentation? It will be cool to have an example of an Analysis setup with some visualizations configuration

[pgarbe]

@rohits-spec I'd not close it. It's not usable at the moment.

[RemjeyLiu]

Also, would be cool if the following resources can be managed by CloudFormation too:

• Account Customization
• Namespace
• Users
• Groups
• Group Memberships
• Data Sources
• Data Sets
• Permissions (For Themes, Data Sources, Data Sets, Analyses, Templates, and Dashboards)

[rohits-spec]

Reopening this issue due to the concerns raised here by community members. I will work with Quicksight team and provide an update here.

[austinlasseter]

I agree with the commenters above. We need robust CloudFormation support for QuickSight. Re-building the same dashboards from scratch in dev, test and prod using nothing but the GUI... really kinda sucks.

[danieljamesscott]

Probably not quite the right place to ask for this for it, but API support for configuring VPC Connections to QuickSight would be nice. https://docs.aws.amazon.com/quicksight/latest/user/vpc-creating-a-connection-in-quicksight.html

Then adding CloudFormation support for it too would be wonderful!

[moltar]

Ha, @danieljamesscott was just looking for the exact same thing today. I guess there is no way, eh?

[danieljamesscott]

Ha, @danieljamesscott was just looking for the exact same thing today. I guess there is no way, eh?

Not that I've found. 😢

[gtfuhr]

Also, would be cool if the following resources can be managed by CloudFormation too:

• Account Customization
• Namespace
• Users
• Groups
• Group Memberships
• Data Sources
• Data Sets
• Permissions (For Themes, Data Sources, Data Sets, Analyses, Templates, and Dashboards)

Is there any estimate for the deployment of the DataSets, DataSources, and Permissions QuickSight/CloudFormation features?

[Lanayx]

Can anybody provide any examples of using these new CloudFormation or CDK constructs? The documentation is pretty useless

[mmuller88]

Here we go. Will do a blog post soon and create those CDK custom constructs
dataset.txt
datasource.txt

[accrisoftteam]

I recently attempted to use AWS::QuickSight::DataSource and ran into an Internal Error when attempting to use RdsParameters. We have worked around the issue thanks to AWS Support (use MySqlParameters instead) but wanted to mention it here as Support said it is reported as non-functional.

[mmuller88]

Here we go.
Post: https://martinmueller.dev/qs-constructs-eng/
GitHub Repo: https://github.com/mmuller88/cdk-quicksight-constructs

[mmuller88]

Lol looks like AWS added DataSource and DataSet in the meantime D: ?
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html

so this issue can be closed

[rohits-spec]

Quicksight has onboarded the datasource and dataset resources https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_QuickSight.html .

[nathanagez]

Hi @rohits-spec, I noticed that multiple fields are marked as not required _(Required: No)_ in the documentation while they are, for instance with AWS::QuickSight::DataSource the DataSetId and AwsAccountId fields are required.

Also, when deploying my CloudFormation template I'm getting this error:

AWSTemplateFormatVersion: 2010-09-09
Parameters:
  AthenaWorkGroup:
    Type: String
    Default: amplifysandbox-AthenaWorkGroup-dev
  env:
    Type: String
    Default: debug
  appName:
    Type: String
    Default: testNathan
Resources:
  QuickSightDataSource:
    Type: 'AWS::QuickSight::DataSource'
    Properties:
      AwsAccountId: !Ref 'AWS::AccountId'
      DataSourceId: cdkdatasource
      DataSourceParameters:
        AthenaParameters:
          WorkGroup: !Ref AthenaWorkGroup
      Permissions:
        - Actions:
            - 'quicksight:DescribeDataSource'
            - 'quicksight:DescribeDataSourcePermissions'
            - 'quicksight:PassDataSource'
            - 'quicksight:UpdateDataSource'
            - 'quicksight:DeleteDataSource'
            - 'quicksight:UpdateDataSourcePermissions'
          Principal: !Sub 
            - 'arn:aws:quicksight:us-west-2:${Account}:user/default/nathan'
            - Account: !Ref 'AWS::AccountId'
      Name: cdkdatasource
      Type: ATHENA

[mjdean1994]

@rohits-spec it seems to me like the features required to use QuickSight at an Enterprise level have not yet been enabled for CloudFormation.

The thing that immediately comes to mind is VPC Connection.

The DataSource object supports passing a VpcConnectionArn here: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html

But there is no way to create that resource through CloudFormation. That would mean having to create something manually through the UI.

At least for my organization, this makes it impossible to use QuickSight without direct UI access, which is very frowned upon in our production environments.

I would encourage the team to keep this issue open until QuickSight is fully supported through CloudFormation.

[padaszewski]

@rohits-spec The DataSource resource does not have the data source parameter for AWS IoT Analytics, which is the most important one for me atm, and also some others.