TemplateAlias class
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: Number(test.versionNumber),
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.TemplateAlias("example",
alias_name="example-alias",
template_id=test["templateId"],
template_version_number=int(test["versionNumber"]))
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,
});
});
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.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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_quicksight_templatealias" "example" {
alias_name = "example-alias"
template_id = test.templateId
template_version_number = test.versionNumber
}
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.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 TemplateAlias("example", TemplateAliasArgs.builder()
.aliasName("example-alias")
.templateId(test.templateId())
.templateVersionNumber(test.versionNumber())
.build());
}
}
resources:
example:
type: aws:quicksight:TemplateAlias
properties:
aliasName: example-alias
templateId: ${test.templateId}
templateVersionNumber: ${test.versionNumber}
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
Constructors
- TemplateAlias(String name, {TemplateAliasArgs? args, CustomResourceOptions? options})
-
Creates a new TemplateAlias.
nameThe Pulumi resource name.argsArguments used to configure this TemplateAlias. The set of arguments for TemplateAlias.optionsResource options controlling this resource's behavior. - TemplateAlias.reference(String urn)
- Creates a typed reference to an existing TemplateAlias resource.
Properties
-
aliasName
↔ Output<
String> -
Display name of the template alias.
latefinal
-
arn
↔ Output<
String> -
ARN of the template alias.
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
- 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
-
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
-
templateId
↔ Output<
String> -
ID of the template.
latefinal
-
templateVersionNumber
↔ Output<
int> -
Version number of the template.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
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
Static Methods
-
get(
String name, Input< String> id, {TemplateAliasState? state, CustomResourceOptions? options}) → TemplateAlias -
Gets an existing TemplateAlias resource's state with the given
nameandid.