Package com.pulumi.aws.quicksight

Class Analysis

  • public class Analysis
extends com.pulumi.resources.CustomResource
    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 com.pulumi.aws.quicksight.inputs.AnalysisSourceEntitySourceTemplateDataSetReferenceArgs;
 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 Analysis("example", AnalysisArgs.builder()
             .sourceEntity(AnalysisSourceEntityArgs.builder()
                 .sourceTemplate(AnalysisSourceEntitySourceTemplateArgs.builder()
                     .dataSetReferences(AnalysisSourceEntitySourceTemplateDataSetReferenceArgs.builder()
                         .dataSetArn(dataset.arn())
                         .dataSetPlaceholder("1")
                         .build())
                     .arn(source.arn())
                     .build())
                 .build())
             .analysisId("example-id")
             .name("example-name")
             .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.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 Analysis("example", AnalysisArgs.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")
                 )))
             ))
             .analysisId("example-id")
             .name("example-name")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import a QuickSight Analysis using the AWS account ID and analysis ID separated by a comma (`,`). For example: ```sh $ pulumi import aws:quicksight/analysis:Analysis 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
      Analysis​(java.lang.String name)  
      Analysis​(java.lang.String name, AnalysisArgs args)  
      Analysis​(java.lang.String name, AnalysisArgs 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> analysisId()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> awsAccountId()  
      com.pulumi.core.Output<java.lang.String> createdTime()  
      static Analysis get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AnalysisState 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<AnalysisParameters> parameters()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<AnalysisPermission>>> permissions()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> recoveryWindowInDays()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<AnalysisSourceEntity>> sourceEntity()  
      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()  

      • 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

      • Analysis

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

      • Analysis

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

      • Analysis

        public Analysis​(java.lang.String name,
                AnalysisArgs 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

      • analysisId

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

      • arn

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

      • 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 analysis was created.

      • lastPublishedTime

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

      • lastUpdatedTime

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

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Display name for the analysis. The following arguments are optional:

      • parameters

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

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

      • recoveryWindowInDays

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> recoveryWindowInDays()
        Returns:
        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`.

      • 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<AnalysisSourceEntity>> sourceEntity()
        Returns:
        Entity that you are using as a source when you create the analysis (template). Only one of `definition` or `sourceEntity` should be configured. See source_entity.

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Analysis 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 analysis. The theme ARN must exist in the same AWS account where you create the analysis.

      • get

        public static Analysis get​(java.lang.String name,
                           com.pulumi.core.Output<java.lang.String> id,
                           @Nullable
                           AnalysisState 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.