TemplateArgs

data class TemplateArgs(val awsAccountId: Output<String>? = null, val name: Output<String>? = null, val permissions: Output<List<TemplatePermissionArgs>>? = null, val sourceEntity: Output<TemplateSourceEntityArgs>? = null, val tags: Output<Map<String, String>>? = null, val templateId: Output<String>? = null, val versionDescription: Output<String>? = null) : ConvertibleToJava<TemplateArgs>

Resource for managing a QuickSight Template.

Example Usage

From Source Template

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.quicksight.Template("example", {
templateId: "example-id",
name: "example-name",
versionDescription: "version",
sourceEntity: {
sourceTemplate: {
arn: source.arn,
},
},
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.Template("example",
template_id="example-id",
name="example-name",
version_description="version",
source_entity={
"source_template": {
"arn": source["arn"],
},
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Quicksight.Template("example", new()
{
TemplateId = "example-id",
Name = "example-name",
VersionDescription = "version",
SourceEntity = new Aws.Quicksight.Inputs.TemplateSourceEntityArgs
{
SourceTemplate = new Aws.Quicksight.Inputs.TemplateSourceEntitySourceTemplateArgs
{
Arn = source.Arn,
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := quicksight.NewTemplate(ctx, "example", &quicksight.TemplateArgs{
TemplateId: pulumi.String("example-id"),
Name: pulumi.String("example-name"),
VersionDescription: pulumi.String("version"),
SourceEntity: &quicksight.TemplateSourceEntityArgs{
SourceTemplate: &quicksight.TemplateSourceEntitySourceTemplateArgs{
Arn: pulumi.Any(source.Arn),
},
},
})
if err != nil {
return err
}
return nil
})
}
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.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 Template("example", TemplateArgs.builder()
.templateId("example-id")
.name("example-name")
.versionDescription("version")
.sourceEntity(TemplateSourceEntityArgs.builder()
.sourceTemplate(TemplateSourceEntitySourceTemplateArgs.builder()
.arn(source.arn())
.build())
.build())
.build());
}
}
resources:
example:
type: aws:quicksight:Template
properties:
templateId: example-id
name: example-name
versionDescription: version
sourceEntity:
sourceTemplate:
arn: ${source.arn}

With Definition

resources:
example:
type: aws:quicksight:Template
properties:
templateId: example-id
name: example-name
versionDescription: version
definition:
dataSetConfigurations:
- dataSetSchema:
columnSchemaLists:
- name: Column1
dataType: STRING
- name: Column2
dataType: INTEGER
placeholder: '1'
sheets:
- title: Test
sheetId: Test1
visuals:
- barChartVisual:
visualId: BarChart
chartConfiguration:
fieldWells:
barChartAggregatedFieldWells:
categories:
- categoricalDimensionField:
fieldId: '1'
column:
columnName: Column1
dataSetIdentifier: '1'
values:
- numericalMeasureField:
fieldId: '2'
column:
columnName: Column2
dataSetIdentifier: '1'
aggregationFunction:
simpleNumericalAggregation: SUM

Import

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

$ pulumi import aws:quicksight/template:Template example 123456789012,example-id

Constructors

Link copied to clipboard
constructor(awsAccountId: Output<String>? = null, name: Output<String>? = null, permissions: Output<List<TemplatePermissionArgs>>? = null, sourceEntity: Output<TemplateSourceEntityArgs>? = null, tags: Output<Map<String, String>>? = null, templateId: Output<String>? = null, versionDescription: Output<String>? = null)

Properties

Link copied to clipboard
val awsAccountId: Output<String>? = null

AWS account ID.

Link copied to clipboard
val name: Output<String>? = null

Display name for the template.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

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.

Link copied to clipboard
val templateId: Output<String>? = null

Identifier for the template.

Link copied to clipboard
val versionDescription: Output<String>? = null

A description of the current template version being created/updated. The following arguments are optional:

Functions

Link copied to clipboard
open override fun toJava(): TemplateArgs