aws / aws/aws-cdk

QuickSight: Proper Analysis or Template CDK Construct

Open
#19,212 10 comments 8 reactions 0 assignees View on GitHub
@aws-cdk/aws-quicksight blocked effort/medium feature-request needs-cfn p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### Description

Currently, the only way to create a QuickSight::Analysis is by giving it a QuickSight::Template as sourceEntity.
And the only way to create a QuickSight::Template is by giving it either a QuickSight::Template or a QuickSight::Analysis as source Entity.
So it is impossible to automate the creation of the Analysis completely.

### Use Case

We want to reduce manual steps when deploying our pipeline as much as possible. We also want to version control the visuals in our analysis.

### Proposed Solution

To properly automate QuickSight with CDK we need a way to define the Template with CDK, by perhaps passing it a json with the definition of all visuals in the analysis. This way we can source control the Analysis design and eliminate the manual steps for creating the analysis in the console.

Ideally there would be a way to call aws-describe-template to see the json of an analysis created with the console manually, that can then be included in the CDK src.

### Other information

_No response_

### Acknowledge

- [ ] I may be able to implement this feature request
- [ ] This feature might incur a breaking change

Contributor guide

Open the contributing guide

Research direction

Review the existing QuickSight::Analysis and QuickSight::Template CDK constructs, then compare their sourceEntity requirements with the QuickSight APIs described in the issue. Investigate whether aws-describe-template exposes the needed analysis definition and determine the construct and validation scope required for a fully reproducible analysis. Done means the feature works without a manually created source analysis and supports version-controlled definitions.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
analytics, cloud
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.