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

Dashboard

class Dashboard : KotlinCustomResource

Resource for managing a QuickSight Dashboard.

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.Dashboard;
import com.pulumi.aws.quicksight.DashboardArgs;
import com.pulumi.aws.quicksight.inputs.DashboardSourceEntityArgs;
import com.pulumi.aws.quicksight.inputs.DashboardSourceEntitySourceTemplateArgs;
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 Dashboard("example", DashboardArgs.builder()
            .dashboardId("example-id")
            .versionDescription("version")
            .sourceEntity(DashboardSourceEntityArgs.builder()
                .sourceTemplate(DashboardSourceEntitySourceTemplateArgs.builder()
                    .arn(aws_quicksight_template.source().arn())
                    .dataSetReferences(DashboardSourceEntitySourceTemplateDataSetReferenceArgs.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.Dashboard;
import com.pulumi.aws.quicksight.DashboardArgs;
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 Dashboard("example", DashboardArgs.builder()
            .dashboardId("example-id")
            .versionDescription("version")
            .definition(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());
    }
}

Import

Using pulumi import, import a QuickSight Dashboard using the AWS account ID and dashboard ID separated by a comma (,). For example:

$ pulumi import aws:quicksight/dashboard:Dashboard example 123456789012,example-id

Properties

arn

val arn: Output<String>

The Amazon Resource Name (ARN) of the resource.

awsAccountId

val awsAccountId: Output<String>

AWS account ID.

createdTime

val createdTime: Output<String>

The time that the dashboard was created.

dashboardId

val dashboardId: Output<String>

Identifier for the dashboard.

dashboardPublishOptions

val dashboardPublishOptions: Output<DashboardDashboardPublishOptions>

Options for publishing the dashboard. See dashboard_publish_options.

val id: Output<String>

lastPublishedTime

val lastPublishedTime: Output<String>

lastUpdatedTime

val lastUpdatedTime: Output<String>

The time that the dashboard was last updated.

name

val name: Output<String>

Display name for the dashboard.

parameters

val parameters: Output<DashboardParameters>

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values. See parameters.

permissions

val permissions: Output<List<DashboardPermission>>?

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

sourceEntity

val sourceEntity: Output<DashboardSourceEntity>?

The entity that you are using as a source when you create the dashboard (template). Only one of definition or source_entity should be configured. See source_entity.

sourceEntityArn

val sourceEntityArn: Output<String>

Amazon Resource Name (ARN) of a template that was used to create this dashboard.

status

val status: Output<String>

The dashboard creation status.