Template class
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", {
sourceEntity: {
sourceTemplate: {
arn: source.arn,
},
},
templateId: "example-id",
name: "example-name",
versionDescription: "version",
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.Template("example",
source_entity={
"source_template": {
"arn": source["arn"],
},
},
template_id="example-id",
name="example-name",
version_description="version")
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()
{
SourceEntity = new Aws.Quicksight.Inputs.TemplateSourceEntityArgs
{
SourceTemplate = new Aws.Quicksight.Inputs.TemplateSourceEntitySourceTemplateArgs
{
Arn = source.Arn,
},
},
TemplateId = "example-id",
Name = "example-name",
VersionDescription = "version",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
SourceEntity: &quicksight.TemplateSourceEntityArgs{
SourceTemplate: &quicksight.TemplateSourceEntitySourceTemplateArgs{
Arn: pulumi.Any(source.Arn),
},
},
TemplateId: pulumi.String("example-id"),
Name: pulumi.String("example-name"),
VersionDescription: pulumi.String("version"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_quicksight_template" "example" {
source_entity = {
source_template = {
arn = source.arn
}
}
template_id = "example-id"
name = "example-name"
version_description = "version"
}
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());
}
}
resources:
example:
type: aws:quicksight:Template
properties:
sourceEntity:
sourceTemplate:
arn: ${source.arn}
templateId: example-id
name: example-name
versionDescription: version
With Definition
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.quicksight.Template("example", {
definition: {
dataSetConfigurations: [{
dataSetSchema: {
columnSchemaLists: [
{
name: "Column1",
dataType: "STRING",
},
{
name: "Column2",
dataType: "INTEGER",
},
],
},
placeholder: "1",
}],
sheets: [{
visuals: [{
barChartVisual: {
chartConfiguration: {
fieldWells: {
barChartAggregatedFieldWells: {
categories: [{
categoricalDimensionField: {
column: {
columnName: "Column1",
dataSetIdentifier: "1",
},
fieldId: "1",
},
}],
values: [{
numericalMeasureField: {
column: {
columnName: "Column2",
dataSetIdentifier: "1",
},
aggregationFunction: {
simpleNumericalAggregation: "SUM",
},
fieldId: "2",
},
}],
},
},
},
visualId: "BarChart",
},
}],
title: "Test",
sheetId: "Test1",
}],
},
templateId: "example-id",
name: "example-name",
versionDescription: "version",
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.Template("example",
definition={
"dataSetConfigurations": [{
"dataSetSchema": {
"columnSchemaLists": [
{
"name": "Column1",
"dataType": "STRING",
},
{
"name": "Column2",
"dataType": "INTEGER",
},
],
},
"placeholder": "1",
}],
"sheets": [{
"visuals": [{
"barChartVisual": {
"chartConfiguration": {
"fieldWells": {
"barChartAggregatedFieldWells": {
"categories": [{
"categoricalDimensionField": {
"column": {
"columnName": "Column1",
"dataSetIdentifier": "1",
},
"fieldId": "1",
},
}],
"values": [{
"numericalMeasureField": {
"column": {
"columnName": "Column2",
"dataSetIdentifier": "1",
},
"aggregationFunction": {
"simpleNumericalAggregation": "SUM",
},
"fieldId": "2",
},
}],
},
},
},
"visualId": "BarChart",
},
}],
"title": "Test",
"sheetId": "Test1",
}],
},
template_id="example-id",
name="example-name",
version_description="version")
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()
{
Definition =
{
{ "dataSetConfigurations", new[]
{
{
{ "dataSetSchema",
{
{ "columnSchemaLists", new[]
{
{
{ "name", "Column1" },
{ "dataType", "STRING" },
},
{
{ "name", "Column2" },
{ "dataType", "INTEGER" },
},
} },
} },
{ "placeholder", "1" },
},
} },
{ "sheets", new[]
{
{
{ "visuals", new[]
{
{
{ "barChartVisual",
{
{ "chartConfiguration",
{
{ "fieldWells",
{
{ "barChartAggregatedFieldWells",
{
{ "categories", new[]
{
{
{ "categoricalDimensionField",
{
{ "column",
{
{ "columnName", "Column1" },
{ "dataSetIdentifier", "1" },
} },
{ "fieldId", "1" },
} },
},
} },
{ "values", new[]
{
{
{ "numericalMeasureField",
{
{ "column",
{
{ "columnName", "Column2" },
{ "dataSetIdentifier", "1" },
} },
{ "aggregationFunction",
{
{ "simpleNumericalAggregation", "SUM" },
} },
{ "fieldId", "2" },
} },
},
} },
} },
} },
} },
{ "visualId", "BarChart" },
} },
},
} },
{ "title", "Test" },
{ "sheetId", "Test1" },
},
} },
},
TemplateId = "example-id",
Name = "example-name",
VersionDescription = "version",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
Definition: map[string][]map[string]interface{}{
"dataSetConfigurations": []map[string]interface{}{
map[string]interface{}{
"dataSetSchema": map[string][]map[string]string{
"columnSchemaLists": []map[string]string{
{
"name": "Column1",
"dataType": "STRING",
},
{
"name": "Column2",
"dataType": "INTEGER",
},
},
},
"placeholder": "1",
},
},
"sheets": []map[string]interface{}{
map[string]interface{}{
"visuals": []map[string]map[string]interface{}{
map[string]map[string]interface{}{
"barChartVisual": map[string]interface{}{
"chartConfiguration": map[string]map[string]map[string][]map[string]map[string]interface{}{
"fieldWells": map[string]map[string][]map[string]map[string]interface{}{
"barChartAggregatedFieldWells": map[string][]map[string]map[string]interface{}{
"categories": []map[string]map[string]interface{}{
map[string]map[string]interface{}{
"categoricalDimensionField": map[string]interface{}{
"column": map[string]string{
"columnName": "Column1",
"dataSetIdentifier": "1",
},
"fieldId": "1",
},
},
},
"values": []map[string]map[string]interface{}{
map[string]map[string]interface{}{
"numericalMeasureField": map[string]interface{}{
"column": map[string]string{
"columnName": "Column2",
"dataSetIdentifier": "1",
},
"aggregationFunction": map[string]string{
"simpleNumericalAggregation": "SUM",
},
"fieldId": "2",
},
},
},
},
},
},
"visualId": "BarChart",
},
},
},
"title": "Test",
"sheetId": "Test1",
},
},
},
TemplateId: pulumi.String("example-id"),
Name: pulumi.String("example-name"),
VersionDescription: pulumi.String("version"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_quicksight_template" "example" {
definition = {
"dataSetConfigurations" = [{
"dataSetSchema" = {
"columnSchemaLists" = [{
"name" = "Column1"
"dataType" = "STRING"
}, {
"name" = "Column2"
"dataType" = "INTEGER"
}]
}
"placeholder" = "1"
}]
"sheets" = [{
"visuals" = [{
"barChartVisual" = {
"chartConfiguration" = {
"fieldWells" = {
"barChartAggregatedFieldWells" = {
"categories" = [{
"categoricalDimensionField" = {
"column" = {
"columnName" = "Column1"
"dataSetIdentifier" = "1"
}
"fieldId" = "1"
}
}]
"values" = [{
"numericalMeasureField" = {
"column" = {
"columnName" = "Column2"
"dataSetIdentifier" = "1"
}
"aggregationFunction" = {
"simpleNumericalAggregation" = "SUM"
}
"fieldId" = "2"
}
}]
}
}
}
"visualId" = "BarChart"
}
}]
"title" = "Test"
"sheetId" = "Test1"
}]
}
template_id = "example-id"
name = "example-name"
version_description = "version"
}
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());
}
}
resources:
example:
type: aws:quicksight:Template
properties:
definition:
dataSetConfigurations:
- dataSetSchema:
columnSchemaLists:
- name: Column1
dataType: STRING
- name: Column2
dataType: INTEGER
placeholder: '1'
sheets:
- visuals:
- barChartVisual:
chartConfiguration:
fieldWells:
barChartAggregatedFieldWells:
categories:
- categoricalDimensionField:
column:
columnName: Column1
dataSetIdentifier: '1'
fieldId: '1'
values:
- numericalMeasureField:
column:
columnName: Column2
dataSetIdentifier: '1'
aggregationFunction:
simpleNumericalAggregation: SUM
fieldId: '2'
visualId: BarChart
title: Test
sheetId: Test1
templateId: example-id
name: example-name
versionDescription: version
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
- Template(String name, {TemplateArgs? args, CustomResourceOptions? options})
-
Creates a new Template.
nameThe Pulumi resource name.argsArguments used to configure this Template. The set of arguments for Template.optionsResource options controlling this resource's behavior. - Template.reference(String urn)
- Creates a typed reference to an existing Template resource.
Properties
-
arn
↔ Output<
String> -
ARN of the template.
latefinal
-
awsAccountId
↔ Output<
String> -
AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createdTime
↔ Output<
String> -
The time that the template was created.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
lastUpdatedTime
↔ Output<
String> -
The time that the template was last updated.
latefinal
-
name
↔ Output<
String> -
Display name for the template.
latefinal
-
permissions
↔ Output<
List< TemplatePermission> ?> -
A set of resource permissions on the template. Maximum of 64 items. See permissions.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sourceEntity
↔ Output<
TemplateSourceEntity?> -
The entity that you are using as a source when you create the template (analysis or template). Only one of
definitionorsourceEntityshould be configured. See source_entity.latefinal -
sourceEntityArn
↔ Output<
String> -
ARN of an analysis or template that was used to create this template.
latefinal
-
status
↔ Output<
String> -
The template creation status.
latefinal
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
templateId
↔ Output<
String> -
Identifier for the template.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
versionDescription
↔ Output<
String> -
A description of the current template version being created/updated.
latefinal
-
versionNumber
↔ Output<
int> -
The version number of the template version.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited