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

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")
            .sourceEntity(AnalysisSourceEntityArgs.builder()
                .sourceTemplate(AnalysisSourceEntitySourceTemplateArgs.builder()
                    .arn(aws_quicksight_template.source().arn())
                    .dataSetReferences(AnalysisSourceEntitySourceTemplateDataSetReferenceArgs.builder()
                        .dataSetArn(aws_quicksight_data_set.dataset().arn())
                        .dataSetPlaceholder("1")
                        .build())
                    .build())
                .build())
            .build());
    }
}

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

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

AnalysisArgs

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

toJava

open override fun toJava(): AnalysisArgs

Properties

analysisId

val analysisId: Output<String>? = null

Identifier for the analysis.

awsAccountId

val awsAccountId: Output<String>? = null

AWS account ID.

name

val name: Output<String>? = null

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

parameters

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.

permissions

val permissions: Output<List<AnalysisPermissionArgs>>? = null

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

recoveryWindowInDays

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.

sourceEntity

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.