Analysis Args
Resource for managing a QuickSight Analysis.
Example Usage
From Source Template
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.quicksight.Analysis("example", {
analysisId: "example-id",
name: "example-name",
sourceEntity: {
sourceTemplate: {
arn: source.arn,
dataSetReferences: [{
dataSetArn: dataset.arn,
dataSetPlaceholder: "1",
}],
},
},
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.Analysis("example",
analysis_id="example-id",
name="example-name",
source_entity={
"source_template": {
"arn": source["arn"],
"data_set_references": [{
"data_set_arn": dataset["arn"],
"data_set_placeholder": "1",
}],
},
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Quicksight.Analysis("example", new()
{
AnalysisId = "example-id",
Name = "example-name",
SourceEntity = new Aws.Quicksight.Inputs.AnalysisSourceEntityArgs
{
SourceTemplate = new Aws.Quicksight.Inputs.AnalysisSourceEntitySourceTemplateArgs
{
Arn = source.Arn,
DataSetReferences = new[]
{
new Aws.Quicksight.Inputs.AnalysisSourceEntitySourceTemplateDataSetReferenceArgs
{
DataSetArn = dataset.Arn,
DataSetPlaceholder = "1",
},
},
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := quicksight.NewAnalysis(ctx, "example", &quicksight.AnalysisArgs{
AnalysisId: pulumi.String("example-id"),
Name: pulumi.String("example-name"),
SourceEntity: &quicksight.AnalysisSourceEntityArgs{
SourceTemplate: &quicksight.AnalysisSourceEntitySourceTemplateArgs{
Arn: pulumi.Any(source.Arn),
DataSetReferences: quicksight.AnalysisSourceEntitySourceTemplateDataSetReferenceArray{
&quicksight.AnalysisSourceEntitySourceTemplateDataSetReferenceArgs{
DataSetArn: pulumi.Any(dataset.Arn),
DataSetPlaceholder: pulumi.String("1"),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.Analysis;
import com.pulumi.aws.quicksight.AnalysisArgs;
import com.pulumi.aws.quicksight.inputs.AnalysisSourceEntityArgs;
import com.pulumi.aws.quicksight.inputs.AnalysisSourceEntitySourceTemplateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Analysis("example", AnalysisArgs.builder()
.analysisId("example-id")
.name("example-name")
.sourceEntity(AnalysisSourceEntityArgs.builder()
.sourceTemplate(AnalysisSourceEntitySourceTemplateArgs.builder()
.arn(source.arn())
.dataSetReferences(AnalysisSourceEntitySourceTemplateDataSetReferenceArgs.builder()
.dataSetArn(dataset.arn())
.dataSetPlaceholder("1")
.build())
.build())
.build())
.build());
}
}
resources:
example:
type: aws:quicksight:Analysis
properties:
analysisId: example-id
name: example-name
sourceEntity:
sourceTemplate:
arn: ${source.arn}
dataSetReferences:
- dataSetArn: ${dataset.arn}
dataSetPlaceholder: '1'
With Definition
resources:
example:
type: aws:quicksight:Analysis
properties:
analysisId: example-id
name: example-name
definition:
dataSetIdentifiersDeclarations:
- dataSetArn: ${dataset.arn}
identifier: '1'
sheets:
- title: Example
sheetId: Example1
visuals:
- lineChartVisual:
visualId: LineChart
title:
formatText:
plainText: Line Chart Example
chartConfiguration:
fieldWells:
lineChartAggregatedFieldWells:
categories:
- categoricalDimensionField:
fieldId: '1'
column:
dataSetIdentifier: '1'
columnName: Column1
values:
- categoricalMeasureField:
fieldId: '2'
column:
dataSetIdentifier: '1'
columnName: Column1
aggregationFunction: COUNT
Import
Using pulumi import
, import a QuickSight Analysis using the AWS account ID and analysis ID separated by a comma (,
). For example:
$ pulumi import aws:quicksight/analysis:Analysis example 123456789012,example-id
Constructors
Properties
Identifier for the analysis.
AWS account ID.
The parameters for the creation of the analysis, which you want to use to override the default settings. An analysis can have any type of parameters, and some parameters might accept multiple values. See parameters.
A set of resource permissions on the analysis. Maximum of 64 items. See permissions.
A value that specifies the number of days that Amazon QuickSight waits before it deletes the analysis. Use 0
to force deletion without recovery. Minimum value of 7
. Maximum value of 30
. Default to 30
.
The entity that you are using as a source when you create the analysis (template). Only one of definition
or source_entity
should be configured. See source_entity.