Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. quicksight
  5. Template
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws

aws.quicksight.Template

Explore with Pulumi AI

AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws

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,
        },
    },
});
Copy
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"],
        },
    })
Copy
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
	})
}
Copy
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,
            },
        },
    });

});
Copy
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());

    }
}
Copy
resources:
  example:
    type: aws:quicksight:Template
    properties:
      templateId: example-id
      name: example-name
      versionDescription: version
      sourceEntity:
        sourceTemplate:
          arn: ${source.arn}
Copy

With Definition

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

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
Copy

Create Template Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Template(name: string, args: TemplateArgs, opts?: CustomResourceOptions);
@overload
def Template(resource_name: str,
             args: TemplateArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Template(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             template_id: Optional[str] = None,
             version_description: Optional[str] = None,
             aws_account_id: Optional[str] = None,
             name: Optional[str] = None,
             permissions: Optional[Sequence[TemplatePermissionArgs]] = None,
             source_entity: Optional[TemplateSourceEntityArgs] = None,
             tags: Optional[Mapping[str, str]] = None)
func NewTemplate(ctx *Context, name string, args TemplateArgs, opts ...ResourceOption) (*Template, error)
public Template(string name, TemplateArgs args, CustomResourceOptions? opts = null)
public Template(String name, TemplateArgs args)
public Template(String name, TemplateArgs args, CustomResourceOptions options)

type: aws:quicksight:Template
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TemplateArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TemplateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TemplateArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var templateResource = new Aws.Quicksight.Template("templateResource", new()
{
    TemplateId = "string",
    VersionDescription = "string",
    AwsAccountId = "string",
    Name = "string",
    Permissions = new[]
    {
        new Aws.Quicksight.Inputs.TemplatePermissionArgs
        {
            Actions = new[]
            {
                "string",
            },
            Principal = "string",
        },
    },
    SourceEntity = new Aws.Quicksight.Inputs.TemplateSourceEntityArgs
    {
        SourceAnalysis = new Aws.Quicksight.Inputs.TemplateSourceEntitySourceAnalysisArgs
        {
            Arn = "string",
            DataSetReferences = new[]
            {
                new Aws.Quicksight.Inputs.TemplateSourceEntitySourceAnalysisDataSetReferenceArgs
                {
                    DataSetArn = "string",
                    DataSetPlaceholder = "string",
                },
            },
        },
        SourceTemplate = new Aws.Quicksight.Inputs.TemplateSourceEntitySourceTemplateArgs
        {
            Arn = "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := quicksight.NewTemplate(ctx, "templateResource", &quicksight.TemplateArgs{
	TemplateId:         pulumi.String("string"),
	VersionDescription: pulumi.String("string"),
	AwsAccountId:       pulumi.String("string"),
	Name:               pulumi.String("string"),
	Permissions: quicksight.TemplatePermissionArray{
		&quicksight.TemplatePermissionArgs{
			Actions: pulumi.StringArray{
				pulumi.String("string"),
			},
			Principal: pulumi.String("string"),
		},
	},
	SourceEntity: &quicksight.TemplateSourceEntityArgs{
		SourceAnalysis: &quicksight.TemplateSourceEntitySourceAnalysisArgs{
			Arn: pulumi.String("string"),
			DataSetReferences: quicksight.TemplateSourceEntitySourceAnalysisDataSetReferenceArray{
				&quicksight.TemplateSourceEntitySourceAnalysisDataSetReferenceArgs{
					DataSetArn:         pulumi.String("string"),
					DataSetPlaceholder: pulumi.String("string"),
				},
			},
		},
		SourceTemplate: &quicksight.TemplateSourceEntitySourceTemplateArgs{
			Arn: pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var templateResource = new Template("templateResource", TemplateArgs.builder()
    .templateId("string")
    .versionDescription("string")
    .awsAccountId("string")
    .name("string")
    .permissions(TemplatePermissionArgs.builder()
        .actions("string")
        .principal("string")
        .build())
    .sourceEntity(TemplateSourceEntityArgs.builder()
        .sourceAnalysis(TemplateSourceEntitySourceAnalysisArgs.builder()
            .arn("string")
            .dataSetReferences(TemplateSourceEntitySourceAnalysisDataSetReferenceArgs.builder()
                .dataSetArn("string")
                .dataSetPlaceholder("string")
                .build())
            .build())
        .sourceTemplate(TemplateSourceEntitySourceTemplateArgs.builder()
            .arn("string")
            .build())
        .build())
    .tags(Map.of("string", "string"))
    .build());
Copy
template_resource = aws.quicksight.Template("templateResource",
    template_id="string",
    version_description="string",
    aws_account_id="string",
    name="string",
    permissions=[{
        "actions": ["string"],
        "principal": "string",
    }],
    source_entity={
        "source_analysis": {
            "arn": "string",
            "data_set_references": [{
                "data_set_arn": "string",
                "data_set_placeholder": "string",
            }],
        },
        "source_template": {
            "arn": "string",
        },
    },
    tags={
        "string": "string",
    })
Copy
const templateResource = new aws.quicksight.Template("templateResource", {
    templateId: "string",
    versionDescription: "string",
    awsAccountId: "string",
    name: "string",
    permissions: [{
        actions: ["string"],
        principal: "string",
    }],
    sourceEntity: {
        sourceAnalysis: {
            arn: "string",
            dataSetReferences: [{
                dataSetArn: "string",
                dataSetPlaceholder: "string",
            }],
        },
        sourceTemplate: {
            arn: "string",
        },
    },
    tags: {
        string: "string",
    },
});
Copy
type: aws:quicksight:Template
properties:
    awsAccountId: string
    name: string
    permissions:
        - actions:
            - string
          principal: string
    sourceEntity:
        sourceAnalysis:
            arn: string
            dataSetReferences:
                - dataSetArn: string
                  dataSetPlaceholder: string
        sourceTemplate:
            arn: string
    tags:
        string: string
    templateId: string
    versionDescription: string
Copy

Template Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Template resource accepts the following input properties:

TemplateId
This property is required.
Changes to this property will trigger replacement.
string
Identifier for the template.
VersionDescription This property is required. string

A description of the current template version being created/updated.

The following arguments are optional:

AwsAccountId Changes to this property will trigger replacement. string
AWS account ID.
Name string
Display name for the template.
Permissions List<TemplatePermission>
A set of resource permissions on the template. Maximum of 64 items. See permissions.
SourceEntity TemplateSourceEntity
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.
Tags Dictionary<string, string>
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.
TemplateId
This property is required.
Changes to this property will trigger replacement.
string
Identifier for the template.
VersionDescription This property is required. string

A description of the current template version being created/updated.

The following arguments are optional:

AwsAccountId Changes to this property will trigger replacement. string
AWS account ID.
Name string
Display name for the template.
Permissions []TemplatePermissionArgs
A set of resource permissions on the template. Maximum of 64 items. See permissions.
SourceEntity TemplateSourceEntityArgs
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.
Tags map[string]string
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.
templateId
This property is required.
Changes to this property will trigger replacement.
String
Identifier for the template.
versionDescription This property is required. String

A description of the current template version being created/updated.

The following arguments are optional:

awsAccountId Changes to this property will trigger replacement. String
AWS account ID.
name String
Display name for the template.
permissions List<TemplatePermission>
A set of resource permissions on the template. Maximum of 64 items. See permissions.
sourceEntity TemplateSourceEntity
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.
tags Map<String,String>
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.
templateId
This property is required.
Changes to this property will trigger replacement.
string
Identifier for the template.
versionDescription This property is required. string

A description of the current template version being created/updated.

The following arguments are optional:

awsAccountId Changes to this property will trigger replacement. string
AWS account ID.
name string
Display name for the template.
permissions TemplatePermission[]
A set of resource permissions on the template. Maximum of 64 items. See permissions.
sourceEntity TemplateSourceEntity
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.
tags {[key: string]: string}
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.
template_id
This property is required.
Changes to this property will trigger replacement.
str
Identifier for the template.
version_description This property is required. str

A description of the current template version being created/updated.

The following arguments are optional:

aws_account_id Changes to this property will trigger replacement. str
AWS account ID.
name str
Display name for the template.
permissions Sequence[TemplatePermissionArgs]
A set of resource permissions on the template. Maximum of 64 items. See permissions.
source_entity TemplateSourceEntityArgs
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.
tags Mapping[str, str]
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.
templateId
This property is required.
Changes to this property will trigger replacement.
String
Identifier for the template.
versionDescription This property is required. String

A description of the current template version being created/updated.

The following arguments are optional:

awsAccountId Changes to this property will trigger replacement. String
AWS account ID.
name String
Display name for the template.
permissions List<Property Map>
A set of resource permissions on the template. Maximum of 64 items. See permissions.
sourceEntity Property Map
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.
tags Map<String>
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Template resource produces the following output properties:

Arn string
ARN of the template.
CreatedTime string
The time that the template was created.
Id string
The provider-assigned unique ID for this managed resource.
LastUpdatedTime string
The time that the template was last updated.
SourceEntityArn string
Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
Status string
The template creation status.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

VersionNumber int
The version number of the template version.
Arn string
ARN of the template.
CreatedTime string
The time that the template was created.
Id string
The provider-assigned unique ID for this managed resource.
LastUpdatedTime string
The time that the template was last updated.
SourceEntityArn string
Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
Status string
The template creation status.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

VersionNumber int
The version number of the template version.
arn String
ARN of the template.
createdTime String
The time that the template was created.
id String
The provider-assigned unique ID for this managed resource.
lastUpdatedTime String
The time that the template was last updated.
sourceEntityArn String
Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
status String
The template creation status.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

versionNumber Integer
The version number of the template version.
arn string
ARN of the template.
createdTime string
The time that the template was created.
id string
The provider-assigned unique ID for this managed resource.
lastUpdatedTime string
The time that the template was last updated.
sourceEntityArn string
Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
status string
The template creation status.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

versionNumber number
The version number of the template version.
arn str
ARN of the template.
created_time str
The time that the template was created.
id str
The provider-assigned unique ID for this managed resource.
last_updated_time str
The time that the template was last updated.
source_entity_arn str
Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
status str
The template creation status.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

version_number int
The version number of the template version.
arn String
ARN of the template.
createdTime String
The time that the template was created.
id String
The provider-assigned unique ID for this managed resource.
lastUpdatedTime String
The time that the template was last updated.
sourceEntityArn String
Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
status String
The template creation status.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

versionNumber Number
The version number of the template version.

Look up Existing Template Resource

Get an existing Template resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TemplateState, opts?: CustomResourceOptions): Template
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        aws_account_id: Optional[str] = None,
        created_time: Optional[str] = None,
        last_updated_time: Optional[str] = None,
        name: Optional[str] = None,
        permissions: Optional[Sequence[TemplatePermissionArgs]] = None,
        source_entity: Optional[TemplateSourceEntityArgs] = None,
        source_entity_arn: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        template_id: Optional[str] = None,
        version_description: Optional[str] = None,
        version_number: Optional[int] = None) -> Template
func GetTemplate(ctx *Context, name string, id IDInput, state *TemplateState, opts ...ResourceOption) (*Template, error)
public static Template Get(string name, Input<string> id, TemplateState? state, CustomResourceOptions? opts = null)
public static Template get(String name, Output<String> id, TemplateState state, CustomResourceOptions options)
resources:  _:    type: aws:quicksight:Template    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
ARN of the template.
AwsAccountId Changes to this property will trigger replacement. string
AWS account ID.
CreatedTime string
The time that the template was created.
LastUpdatedTime string
The time that the template was last updated.
Name string
Display name for the template.
Permissions List<TemplatePermission>
A set of resource permissions on the template. Maximum of 64 items. See permissions.
SourceEntity TemplateSourceEntity
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.
SourceEntityArn string
Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
Status string
The template creation status.
Tags Dictionary<string, string>
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 Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

TemplateId Changes to this property will trigger replacement. string
Identifier for the template.
VersionDescription string

A description of the current template version being created/updated.

The following arguments are optional:

VersionNumber int
The version number of the template version.
Arn string
ARN of the template.
AwsAccountId Changes to this property will trigger replacement. string
AWS account ID.
CreatedTime string
The time that the template was created.
LastUpdatedTime string
The time that the template was last updated.
Name string
Display name for the template.
Permissions []TemplatePermissionArgs
A set of resource permissions on the template. Maximum of 64 items. See permissions.
SourceEntity TemplateSourceEntityArgs
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.
SourceEntityArn string
Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
Status string
The template creation status.
Tags map[string]string
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 map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

TemplateId Changes to this property will trigger replacement. string
Identifier for the template.
VersionDescription string

A description of the current template version being created/updated.

The following arguments are optional:

VersionNumber int
The version number of the template version.
arn String
ARN of the template.
awsAccountId Changes to this property will trigger replacement. String
AWS account ID.
createdTime String
The time that the template was created.
lastUpdatedTime String
The time that the template was last updated.
name String
Display name for the template.
permissions List<TemplatePermission>
A set of resource permissions on the template. Maximum of 64 items. See permissions.
sourceEntity TemplateSourceEntity
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.
sourceEntityArn String
Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
status String
The template creation status.
tags Map<String,String>
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 Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

templateId Changes to this property will trigger replacement. String
Identifier for the template.
versionDescription String

A description of the current template version being created/updated.

The following arguments are optional:

versionNumber Integer
The version number of the template version.
arn string
ARN of the template.
awsAccountId Changes to this property will trigger replacement. string
AWS account ID.
createdTime string
The time that the template was created.
lastUpdatedTime string
The time that the template was last updated.
name string
Display name for the template.
permissions TemplatePermission[]
A set of resource permissions on the template. Maximum of 64 items. See permissions.
sourceEntity TemplateSourceEntity
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.
sourceEntityArn string
Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
status string
The template creation status.
tags {[key: string]: string}
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 {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

templateId Changes to this property will trigger replacement. string
Identifier for the template.
versionDescription string

A description of the current template version being created/updated.

The following arguments are optional:

versionNumber number
The version number of the template version.
arn str
ARN of the template.
aws_account_id Changes to this property will trigger replacement. str
AWS account ID.
created_time str
The time that the template was created.
last_updated_time str
The time that the template was last updated.
name str
Display name for the template.
permissions Sequence[TemplatePermissionArgs]
A set of resource permissions on the template. Maximum of 64 items. See permissions.
source_entity TemplateSourceEntityArgs
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.
source_entity_arn str
Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
status str
The template creation status.
tags Mapping[str, str]
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.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

template_id Changes to this property will trigger replacement. str
Identifier for the template.
version_description str

A description of the current template version being created/updated.

The following arguments are optional:

version_number int
The version number of the template version.
arn String
ARN of the template.
awsAccountId Changes to this property will trigger replacement. String
AWS account ID.
createdTime String
The time that the template was created.
lastUpdatedTime String
The time that the template was last updated.
name String
Display name for the template.
permissions List<Property Map>
A set of resource permissions on the template. Maximum of 64 items. See permissions.
sourceEntity Property Map
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.
sourceEntityArn String
Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
status String
The template creation status.
tags Map<String>
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 Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

templateId Changes to this property will trigger replacement. String
Identifier for the template.
versionDescription String

A description of the current template version being created/updated.

The following arguments are optional:

versionNumber Number
The version number of the template version.

Supporting Types

TemplatePermission
, TemplatePermissionArgs

Actions This property is required. List<string>
List of IAM actions to grant or revoke permissions on.
Principal This property is required. string
ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.
Actions This property is required. []string
List of IAM actions to grant or revoke permissions on.
Principal This property is required. string
ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.
actions This property is required. List<String>
List of IAM actions to grant or revoke permissions on.
principal This property is required. String
ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.
actions This property is required. string[]
List of IAM actions to grant or revoke permissions on.
principal This property is required. string
ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.
actions This property is required. Sequence[str]
List of IAM actions to grant or revoke permissions on.
principal This property is required. str
ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.
actions This property is required. List<String>
List of IAM actions to grant or revoke permissions on.
principal This property is required. String
ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.

TemplateSourceEntity
, TemplateSourceEntityArgs

SourceAnalysis TemplateSourceEntitySourceAnalysis
The source analysis, if it is based on an analysis.. Only one of source_analysis or source_template should be configured. See source_analysis.
SourceTemplate TemplateSourceEntitySourceTemplate
The source template, if it is based on an template.. Only one of source_analysis or source_template should be configured. See source_template.
SourceAnalysis TemplateSourceEntitySourceAnalysis
The source analysis, if it is based on an analysis.. Only one of source_analysis or source_template should be configured. See source_analysis.
SourceTemplate TemplateSourceEntitySourceTemplate
The source template, if it is based on an template.. Only one of source_analysis or source_template should be configured. See source_template.
sourceAnalysis TemplateSourceEntitySourceAnalysis
The source analysis, if it is based on an analysis.. Only one of source_analysis or source_template should be configured. See source_analysis.
sourceTemplate TemplateSourceEntitySourceTemplate
The source template, if it is based on an template.. Only one of source_analysis or source_template should be configured. See source_template.
sourceAnalysis TemplateSourceEntitySourceAnalysis
The source analysis, if it is based on an analysis.. Only one of source_analysis or source_template should be configured. See source_analysis.
sourceTemplate TemplateSourceEntitySourceTemplate
The source template, if it is based on an template.. Only one of source_analysis or source_template should be configured. See source_template.
source_analysis TemplateSourceEntitySourceAnalysis
The source analysis, if it is based on an analysis.. Only one of source_analysis or source_template should be configured. See source_analysis.
source_template TemplateSourceEntitySourceTemplate
The source template, if it is based on an template.. Only one of source_analysis or source_template should be configured. See source_template.
sourceAnalysis Property Map
The source analysis, if it is based on an analysis.. Only one of source_analysis or source_template should be configured. See source_analysis.
sourceTemplate Property Map
The source template, if it is based on an template.. Only one of source_analysis or source_template should be configured. See source_template.

TemplateSourceEntitySourceAnalysis
, TemplateSourceEntitySourceAnalysisArgs

Arn This property is required. string
The Amazon Resource Name (ARN) of the resource.
DataSetReferences This property is required. List<TemplateSourceEntitySourceAnalysisDataSetReference>
A list of dataset references used as placeholders in the template. See data_set_references.
Arn This property is required. string
The Amazon Resource Name (ARN) of the resource.
DataSetReferences This property is required. []TemplateSourceEntitySourceAnalysisDataSetReference
A list of dataset references used as placeholders in the template. See data_set_references.
arn This property is required. String
The Amazon Resource Name (ARN) of the resource.
dataSetReferences This property is required. List<TemplateSourceEntitySourceAnalysisDataSetReference>
A list of dataset references used as placeholders in the template. See data_set_references.
arn This property is required. string
The Amazon Resource Name (ARN) of the resource.
dataSetReferences This property is required. TemplateSourceEntitySourceAnalysisDataSetReference[]
A list of dataset references used as placeholders in the template. See data_set_references.
arn This property is required. str
The Amazon Resource Name (ARN) of the resource.
data_set_references This property is required. Sequence[TemplateSourceEntitySourceAnalysisDataSetReference]
A list of dataset references used as placeholders in the template. See data_set_references.
arn This property is required. String
The Amazon Resource Name (ARN) of the resource.
dataSetReferences This property is required. List<Property Map>
A list of dataset references used as placeholders in the template. See data_set_references.

TemplateSourceEntitySourceAnalysisDataSetReference
, TemplateSourceEntitySourceAnalysisDataSetReferenceArgs

DataSetArn This property is required. string
Dataset Amazon Resource Name (ARN).
DataSetPlaceholder This property is required. string
Dataset placeholder.
DataSetArn This property is required. string
Dataset Amazon Resource Name (ARN).
DataSetPlaceholder This property is required. string
Dataset placeholder.
dataSetArn This property is required. String
Dataset Amazon Resource Name (ARN).
dataSetPlaceholder This property is required. String
Dataset placeholder.
dataSetArn This property is required. string
Dataset Amazon Resource Name (ARN).
dataSetPlaceholder This property is required. string
Dataset placeholder.
data_set_arn This property is required. str
Dataset Amazon Resource Name (ARN).
data_set_placeholder This property is required. str
Dataset placeholder.
dataSetArn This property is required. String
Dataset Amazon Resource Name (ARN).
dataSetPlaceholder This property is required. String
Dataset placeholder.

TemplateSourceEntitySourceTemplate
, TemplateSourceEntitySourceTemplateArgs

Arn This property is required. string
The Amazon Resource Name (ARN) of the resource.
Arn This property is required. string
The Amazon Resource Name (ARN) of the resource.
arn This property is required. String
The Amazon Resource Name (ARN) of the resource.
arn This property is required. string
The Amazon Resource Name (ARN) of the resource.
arn This property is required. str
The Amazon Resource Name (ARN) of the resource.
arn This property is required. String
The Amazon Resource Name (ARN) of the resource.

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
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws