Package com.pulumi.aws.quicksight

Class Dashboard

  • public class Dashboard
extends com.pulumi.resources.CustomResource
    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 com.pulumi.aws.quicksight.inputs.DashboardSourceEntitySourceTemplateDataSetReferenceArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 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()
             .sourceEntity(DashboardSourceEntityArgs.builder()
                 .sourceTemplate(DashboardSourceEntitySourceTemplateArgs.builder()
                     .dataSetReferences(DashboardSourceEntitySourceTemplateDataSetReferenceArgs.builder()
                         .dataSetArn(dataset.arn())
                         .dataSetPlaceholder("1")
                         .build())
                     .arn(source.arn())
                     .build())
                 .build())
             .dashboardId("example-id")
             .name("example-name")
             .versionDescription("version")
             .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.ArrayList;
 import java.util.Arrays;
 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()
             .definition(Map.ofEntries(
                 Map.entry("dataSetIdentifiersDeclarations", Arrays.asList(Map.ofEntries(
                     Map.entry("dataSetArn", dataset.arn()),
                     Map.entry("identifier", "1")
                 ))),
                 Map.entry("sheets", Arrays.asList(Map.ofEntries(
                     Map.entry("visuals", Arrays.asList(Map.of("lineChartVisual", Map.ofEntries(
                         Map.entry("title", Map.of("formatText", Map.of("plainText", "Line Chart Example"))),
                         Map.entry("chartConfiguration", Map.of("fieldWells", Map.of("lineChartAggregatedFieldWells", Map.ofEntries(
                             Map.entry("categories", Arrays.asList(Map.of("categoricalDimensionField", Map.ofEntries(
                                 Map.entry("column", Map.ofEntries(
                                     Map.entry("dataSetIdentifier", "1"),
                                     Map.entry("columnName", "Column1")
                                 )),
                                 Map.entry("fieldId", "1")
                             )))),
                             Map.entry("values", Arrays.asList(Map.of("categoricalMeasureField", Map.ofEntries(
                                 Map.entry("column", Map.ofEntries(
                                     Map.entry("dataSetIdentifier", "1"),
                                     Map.entry("columnName", "Column1")
                                 )),
                                 Map.entry("fieldId", "2"),
                                 Map.entry("aggregationFunction", "COUNT")
                             ))))
                         )))),
                         Map.entry("visualId", "LineChart")
                     )))),
                     Map.entry("title", "Example"),
                     Map.entry("sheetId", "Example1")
                 )))
             ))
             .dashboardId("example-id")
             .name("example-name")
             .versionDescription("version")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import a QuickSight Dashboard using the AWS account ID and dashboard ID separated by a comma (`,`). For example: ```sh $ pulumi import aws:quicksight/dashboard:Dashboard example 123456789012,example-id ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Dashboard​(java.lang.String name)  
      Dashboard​(java.lang.String name, DashboardArgs args)  
      Dashboard​(java.lang.String name, DashboardArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> awsAccountId()  
      com.pulumi.core.Output<java.lang.String> createdTime()  
      com.pulumi.core.Output<java.lang.String> dashboardId()  
      com.pulumi.core.Output<DashboardDashboardPublishOptions> dashboardPublishOptions()  
      static Dashboard get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DashboardState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> lastPublishedTime()  
      com.pulumi.core.Output<java.lang.String> lastUpdatedTime()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<DashboardParameters> parameters()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<DashboardPermission>>> permissions()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<DashboardSourceEntity>> sourceEntity()  
      com.pulumi.core.Output<java.lang.String> sourceEntityArn()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> themeArn()  
      com.pulumi.core.Output<java.lang.String> versionDescription()  
      com.pulumi.core.Output<java.lang.Integer> versionNumber()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Dashboard

        public Dashboard​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Dashboard

        public Dashboard​(java.lang.String name,
                 DashboardArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Dashboard

        public Dashboard​(java.lang.String name,
                 DashboardArgs args,
                 @Nullable
                 com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the dashboard.

      • awsAccountId

        public com.pulumi.core.Output<java.lang.String> awsAccountId()
        Returns:
        AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.

      • createdTime

        public com.pulumi.core.Output<java.lang.String> createdTime()
        Returns:
        Time that the dashboard was created.

      • dashboardId

        public com.pulumi.core.Output<java.lang.String> dashboardId()
        Returns:
        Identifier for the dashboard.

      • dashboardPublishOptions

        public com.pulumi.core.Output<DashboardDashboardPublishOptions> dashboardPublishOptions()
        Returns:
        Options for publishing the dashboard. See `dashboardPublishOptions`.

      • lastPublishedTime

        public com.pulumi.core.Output<java.lang.String> lastPublishedTime()
        Returns:
        Time that the dashboard was last published.

      • lastUpdatedTime

        public com.pulumi.core.Output<java.lang.String> lastUpdatedTime()
        Returns:
        Time that the dashboard was last updated.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Display name for the dashboard.

      • parameters

        public com.pulumi.core.Output<DashboardParameters> parameters()
        Returns:
        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

        public com.pulumi.core.Output<java.util.Optional<java.util.List<DashboardPermission>>> permissions()
        Returns:
        Set of resource permissions on the dashboard. Maximum of 64 items. See `permissions`.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • sourceEntity

        public com.pulumi.core.Output<java.util.Optional<DashboardSourceEntity>> sourceEntity()
        Returns:
        Entity that you are using as a source when you create the dashboard (template). Only one of `definition` or `sourceEntity` should be configured. See `sourceEntity`.

      • sourceEntityArn

        public com.pulumi.core.Output<java.lang.String> sourceEntityArn()
        Returns:
        ARN of a template that was used to create this dashboard.

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Dashboard creation status.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • themeArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> themeArn()
        Returns:
        ARN of the theme that is being used for this dashboard. The theme ARN must exist in the same AWS account where you create the dashboard.

      • versionDescription

        public com.pulumi.core.Output<java.lang.String> versionDescription()
        Returns:
        Description of the current dashboard version being created/updated. The following arguments are optional:

      • versionNumber

        public com.pulumi.core.Output<java.lang.Integer> versionNumber()
        Returns:
        Version number of the dashboard version.

      • get

        public static Dashboard get​(java.lang.String name,
                            com.pulumi.core.Output<java.lang.String> id,
                            @Nullable
                            DashboardState state,
                            @Nullable
                            com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.