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 ```java 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 ```java 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: ```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.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:
        The Amazon Resource Name (ARN) of the resource.

      • awsAccountId

        public com.pulumi.core.Output<java.lang.String> awsAccountId()
        Returns:
        AWS account ID.

      • createdTime

        public com.pulumi.core.Output<java.lang.String> createdTime()
        Returns:
        The 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 dashboard_publish_options.

      • lastPublishedTime

        public com.pulumi.core.Output<java.lang.String> lastPublishedTime()

      • lastUpdatedTime

        public com.pulumi.core.Output<java.lang.String> lastUpdatedTime()
        Returns:
        The 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:
        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

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

      • sourceEntity

        public com.pulumi.core.Output<java.util.Optional<DashboardSourceEntity>> sourceEntity()
        Returns:
        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

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

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        The 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 `default_tags` 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:
        A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

      • themeArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> themeArn()
        Returns:
        The Amazon Resource Name (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:
        A 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:
        The 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.