pulumi-aws-kotlin/com.pulumi.aws.quicksight.kotlin/AnalysisArgs

AnalysisArgs

data class AnalysisArgs(val analysisId: Output<String>? = null, val awsAccountId: Output<String>? = null, val name: Output<String>? = null, val parameters: Output<AnalysisParametersArgs>? = null, val permissions: Output<List<AnalysisPermissionArgs>>? = null, val recoveryWindowInDays: Output<Int>? = null, val sourceEntity: Output<AnalysisSourceEntityArgs>? = null, val tags: Output<Map<String, String>>? = null, val themeArn: Output<String>? = null) : ConvertibleToJava<AnalysisArgs>

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",
            }],
        },
    },
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.quicksight.Analysis("example",
    analysis_id="example-id",
    name="example-name",
    source_entity=aws.quicksight.AnalysisSourceEntityArgs(
        source_template=aws.quicksight.AnalysisSourceEntitySourceTemplateArgs(
            arn=source["arn"],
            data_set_references=[aws.quicksight.AnalysisSourceEntitySourceTemplateDataSetReferenceArgs(
                data_set_arn=dataset["arn"],
                data_set_placeholder="1",
            )],
        ),
    ))
Content copied to clipboard
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",
                    },
                },
            },
        },
    });
});
Content copied to clipboard
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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard
resources:
  example:
    type: aws:quicksight:Analysis
    properties:
      analysisId: example-id
      name: example-name
      sourceEntity:
        sourceTemplate:
          arn: ${source.arn}
          dataSetReferences:
            - dataSetArn: ${dataset.arn}
              dataSetPlaceholder: '1'
Content copied to clipboard

With Definition

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 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")
            .definition(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());
    }
}
Content copied to clipboard
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
Content copied to clipboard

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
Content copied to clipboard

Constructors

Link copied to clipboard
fun AnalysisArgs(analysisId: Output<String>? = null, awsAccountId: Output<String>? = null, name: Output<String>? = null, parameters: Output<AnalysisParametersArgs>? = null, permissions: Output<List<AnalysisPermissionArgs>>? = null, recoveryWindowInDays: Output<Int>? = null, sourceEntity: Output<AnalysisSourceEntityArgs>? = null, tags: Output<Map<String, String>>? = null, themeArn: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): AnalysisArgs

Properties

Link copied to clipboard
val analysisId: Output<String>? = null

Identifier for the analysis.

Link copied to clipboard
val awsAccountId: Output<String>? = null

AWS account ID.

Link copied to clipboard
val name: Output<String>? = null

Display name for the analysis. The following arguments are optional:

Link copied to clipboard
val parameters: Output<AnalysisParametersArgs>? = null

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.

Link copied to clipboard
val permissions: Output<List<AnalysisPermissionArgs>>? = null

A set of resource permissions on the analysis. Maximum of 64 items. See permissions.

Link copied to clipboard
val recoveryWindowInDays: Output<Int>? = null

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.

Link copied to clipboard
val sourceEntity: Output<AnalysisSourceEntityArgs>? = null

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.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val themeArn: Output<String>? = null

The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis.