1. Packages
  2. AWS
  3. API Docs
  4. quicksight
  5. TemplateAlias
AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi

aws.quicksight.TemplateAlias

Explore with Pulumi AI

Resource for managing an AWS QuickSight Template Alias.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.quicksight.TemplateAlias("example", {
    aliasName: "example-alias",
    templateId: test.templateId,
    templateVersionNumber: test.versionNumber,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.quicksight.TemplateAlias("example",
    alias_name="example-alias",
    template_id=test["templateId"],
    template_version_number=test["versionNumber"])
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.NewTemplateAlias(ctx, "example", &quicksight.TemplateAliasArgs{
			AliasName:             pulumi.String("example-alias"),
			TemplateId:            pulumi.Any(test.TemplateId),
			TemplateVersionNumber: pulumi.Any(test.VersionNumber),
		})
		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.TemplateAlias("example", new()
    {
        AliasName = "example-alias",
        TemplateId = test.TemplateId,
        TemplateVersionNumber = test.VersionNumber,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.TemplateAlias;
import com.pulumi.aws.quicksight.TemplateAliasArgs;
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 TemplateAlias("example", TemplateAliasArgs.builder()
            .aliasName("example-alias")
            .templateId(test.templateId())
            .templateVersionNumber(test.versionNumber())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:quicksight:TemplateAlias
    properties:
      aliasName: example-alias
      templateId: ${test.templateId}
      templateVersionNumber: ${test.versionNumber}
Copy

Create TemplateAlias Resource

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

Constructor syntax

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

@overload
def TemplateAlias(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  alias_name: Optional[str] = None,
                  template_id: Optional[str] = None,
                  template_version_number: Optional[int] = None,
                  aws_account_id: Optional[str] = None)
func NewTemplateAlias(ctx *Context, name string, args TemplateAliasArgs, opts ...ResourceOption) (*TemplateAlias, error)
public TemplateAlias(string name, TemplateAliasArgs args, CustomResourceOptions? opts = null)
public TemplateAlias(String name, TemplateAliasArgs args)
public TemplateAlias(String name, TemplateAliasArgs args, CustomResourceOptions options)
type: aws:quicksight:TemplateAlias
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. TemplateAliasArgs
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. TemplateAliasArgs
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. TemplateAliasArgs
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. TemplateAliasArgs
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. TemplateAliasArgs
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 templateAliasResource = new Aws.Quicksight.TemplateAlias("templateAliasResource", new()
{
    AliasName = "string",
    TemplateId = "string",
    TemplateVersionNumber = 0,
    AwsAccountId = "string",
});
Copy
example, err := quicksight.NewTemplateAlias(ctx, "templateAliasResource", &quicksight.TemplateAliasArgs{
	AliasName:             pulumi.String("string"),
	TemplateId:            pulumi.String("string"),
	TemplateVersionNumber: pulumi.Int(0),
	AwsAccountId:          pulumi.String("string"),
})
Copy
var templateAliasResource = new TemplateAlias("templateAliasResource", TemplateAliasArgs.builder()
    .aliasName("string")
    .templateId("string")
    .templateVersionNumber(0)
    .awsAccountId("string")
    .build());
Copy
template_alias_resource = aws.quicksight.TemplateAlias("templateAliasResource",
    alias_name="string",
    template_id="string",
    template_version_number=0,
    aws_account_id="string")
Copy
const templateAliasResource = new aws.quicksight.TemplateAlias("templateAliasResource", {
    aliasName: "string",
    templateId: "string",
    templateVersionNumber: 0,
    awsAccountId: "string",
});
Copy
type: aws:quicksight:TemplateAlias
properties:
    aliasName: string
    awsAccountId: string
    templateId: string
    templateVersionNumber: 0
Copy

TemplateAlias 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 TemplateAlias resource accepts the following input properties:

AliasName This property is required. string
Display name of the template alias.
TemplateId This property is required. string
ID of the template.
TemplateVersionNumber This property is required. int

Version number of the template.

The following arguments are optional:

AwsAccountId string
AWS account ID.
AliasName This property is required. string
Display name of the template alias.
TemplateId This property is required. string
ID of the template.
TemplateVersionNumber This property is required. int

Version number of the template.

The following arguments are optional:

AwsAccountId string
AWS account ID.
aliasName This property is required. String
Display name of the template alias.
templateId This property is required. String
ID of the template.
templateVersionNumber This property is required. Integer

Version number of the template.

The following arguments are optional:

awsAccountId String
AWS account ID.
aliasName This property is required. string
Display name of the template alias.
templateId This property is required. string
ID of the template.
templateVersionNumber This property is required. number

Version number of the template.

The following arguments are optional:

awsAccountId string
AWS account ID.
alias_name This property is required. str
Display name of the template alias.
template_id This property is required. str
ID of the template.
template_version_number This property is required. int

Version number of the template.

The following arguments are optional:

aws_account_id str
AWS account ID.
aliasName This property is required. String
Display name of the template alias.
templateId This property is required. String
ID of the template.
templateVersionNumber This property is required. Number

Version number of the template.

The following arguments are optional:

awsAccountId String
AWS account ID.

Outputs

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

Arn string
Amazon Resource Name (ARN) of the template alias.
Id string
The provider-assigned unique ID for this managed resource.
Arn string
Amazon Resource Name (ARN) of the template alias.
Id string
The provider-assigned unique ID for this managed resource.
arn String
Amazon Resource Name (ARN) of the template alias.
id String
The provider-assigned unique ID for this managed resource.
arn string
Amazon Resource Name (ARN) of the template alias.
id string
The provider-assigned unique ID for this managed resource.
arn str
Amazon Resource Name (ARN) of the template alias.
id str
The provider-assigned unique ID for this managed resource.
arn String
Amazon Resource Name (ARN) of the template alias.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing TemplateAlias Resource

Get an existing TemplateAlias 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?: TemplateAliasState, opts?: CustomResourceOptions): TemplateAlias
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alias_name: Optional[str] = None,
        arn: Optional[str] = None,
        aws_account_id: Optional[str] = None,
        template_id: Optional[str] = None,
        template_version_number: Optional[int] = None) -> TemplateAlias
func GetTemplateAlias(ctx *Context, name string, id IDInput, state *TemplateAliasState, opts ...ResourceOption) (*TemplateAlias, error)
public static TemplateAlias Get(string name, Input<string> id, TemplateAliasState? state, CustomResourceOptions? opts = null)
public static TemplateAlias get(String name, Output<String> id, TemplateAliasState state, CustomResourceOptions options)
resources:  _:    type: aws:quicksight:TemplateAlias    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:
AliasName string
Display name of the template alias.
Arn string
Amazon Resource Name (ARN) of the template alias.
AwsAccountId string
AWS account ID.
TemplateId string
ID of the template.
TemplateVersionNumber int

Version number of the template.

The following arguments are optional:

AliasName string
Display name of the template alias.
Arn string
Amazon Resource Name (ARN) of the template alias.
AwsAccountId string
AWS account ID.
TemplateId string
ID of the template.
TemplateVersionNumber int

Version number of the template.

The following arguments are optional:

aliasName String
Display name of the template alias.
arn String
Amazon Resource Name (ARN) of the template alias.
awsAccountId String
AWS account ID.
templateId String
ID of the template.
templateVersionNumber Integer

Version number of the template.

The following arguments are optional:

aliasName string
Display name of the template alias.
arn string
Amazon Resource Name (ARN) of the template alias.
awsAccountId string
AWS account ID.
templateId string
ID of the template.
templateVersionNumber number

Version number of the template.

The following arguments are optional:

alias_name str
Display name of the template alias.
arn str
Amazon Resource Name (ARN) of the template alias.
aws_account_id str
AWS account ID.
template_id str
ID of the template.
template_version_number int

Version number of the template.

The following arguments are optional:

aliasName String
Display name of the template alias.
arn String
Amazon Resource Name (ARN) of the template alias.
awsAccountId String
AWS account ID.
templateId String
ID of the template.
templateVersionNumber Number

Version number of the template.

The following arguments are optional:

Import

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

$ pulumi import aws:quicksight/templateAlias:TemplateAlias example 123456789012,example-id,example-alias
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.