Package com.pulumi.aws.quicksight

Class Template

  • public class Template
extends com.pulumi.resources.CustomResource
    Resource for managing a QuickSight Template. ## 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.Template;
 import com.pulumi.aws.quicksight.TemplateArgs;
 import com.pulumi.aws.quicksight.inputs.TemplateSourceEntityArgs;
 import com.pulumi.aws.quicksight.inputs.TemplateSourceEntitySourceTemplateArgs;
 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 Template("example", TemplateArgs.builder()
             .sourceEntity(TemplateSourceEntityArgs.builder()
                 .sourceTemplate(TemplateSourceEntitySourceTemplateArgs.builder()
                     .arn(source.arn())
                     .build())
                 .build())
             .templateId("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.Template;
 import com.pulumi.aws.quicksight.TemplateArgs;
 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 Template("example", TemplateArgs.builder()
             .definition(Map.ofEntries(
                 Map.entry("dataSetConfigurations", Arrays.asList(Map.ofEntries(
                     Map.entry("dataSetSchema", Map.of("columnSchemaLists", Arrays.asList(                    
                         Map.ofEntries(
                             Map.entry("name", "Column1"),
                             Map.entry("dataType", "STRING")
                         ),
                         Map.ofEntries(
                             Map.entry("name", "Column2"),
                             Map.entry("dataType", "INTEGER")
                         )))),
                     Map.entry("placeholder", "1")
                 ))),
                 Map.entry("sheets", Arrays.asList(Map.ofEntries(
                     Map.entry("visuals", Arrays.asList(Map.of("barChartVisual", Map.ofEntries(
                         Map.entry("chartConfiguration", Map.of("fieldWells", Map.of("barChartAggregatedFieldWells", Map.ofEntries(
                             Map.entry("categories", Arrays.asList(Map.of("categoricalDimensionField", Map.ofEntries(
                                 Map.entry("column", Map.ofEntries(
                                     Map.entry("columnName", "Column1"),
                                     Map.entry("dataSetIdentifier", "1")
                                 )),
                                 Map.entry("fieldId", "1")
                             )))),
                             Map.entry("values", Arrays.asList(Map.of("numericalMeasureField", Map.ofEntries(
                                 Map.entry("column", Map.ofEntries(
                                     Map.entry("columnName", "Column2"),
                                     Map.entry("dataSetIdentifier", "1")
                                 )),
                                 Map.entry("aggregationFunction", Map.of("simpleNumericalAggregation", "SUM")),
                                 Map.entry("fieldId", "2")
                             ))))
                         )))),
                         Map.entry("visualId", "BarChart")
                     )))),
                     Map.entry("title", "Test"),
                     Map.entry("sheetId", "Test1")
                 )))
             ))
             .templateId("example-id")
             .name("example-name")
             .versionDescription("version")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import a QuickSight Template using the AWS account ID and template ID separated by a comma (`,`). For example: ```sh $ pulumi import aws:quicksight/template:Template 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
      Template​(java.lang.String name)  
      Template​(java.lang.String name, TemplateArgs args)  
      Template​(java.lang.String name, TemplateArgs 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()  
      static Template get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, TemplateState 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> lastUpdatedTime()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<TemplatePermission>>> permissions()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<TemplateSourceEntity>> 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.lang.String> templateId()  
      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

      • Template

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

      • Template

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

      • Template

        public Template​(java.lang.String name,
                TemplateArgs 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 template.

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

      • lastUpdatedTime

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

      • name

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

      • permissions

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

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

      • sourceEntityArn

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

      • status

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

      • templateId

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

      • versionDescription

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

      • versionNumber

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

      • get

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