github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/quicksight/templateAlias.go (about)

     1  // Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
     2  // *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
     3  
     4  package quicksight
     5  
     6  import (
     7  	"context"
     8  	"reflect"
     9  
    10  	"errors"
    11  	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
    12  	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    13  )
    14  
    15  // Resource for managing an AWS QuickSight Template Alias.
    16  //
    17  // ## Example Usage
    18  //
    19  // ### Basic Usage
    20  //
    21  // <!--Start PulumiCodeChooser -->
    22  // ```go
    23  // package main
    24  //
    25  // import (
    26  //
    27  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
    28  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    29  //
    30  // )
    31  //
    32  //	func main() {
    33  //		pulumi.Run(func(ctx *pulumi.Context) error {
    34  //			_, err := quicksight.NewTemplateAlias(ctx, "example", &quicksight.TemplateAliasArgs{
    35  //				AliasName:             pulumi.String("example-alias"),
    36  //				TemplateId:            pulumi.Any(test.TemplateId),
    37  //				TemplateVersionNumber: pulumi.Any(test.VersionNumber),
    38  //			})
    39  //			if err != nil {
    40  //				return err
    41  //			}
    42  //			return nil
    43  //		})
    44  //	}
    45  //
    46  // ```
    47  // <!--End PulumiCodeChooser -->
    48  //
    49  // ## Import
    50  //
    51  // Using `pulumi import`, import QuickSight Template Alias using the AWS account ID, template ID, and alias name separated by a comma (`,`). For example:
    52  //
    53  // ```sh
    54  // $ pulumi import aws:quicksight/templateAlias:TemplateAlias example 123456789012,example-id,example-alias
    55  // ```
    56  type TemplateAlias struct {
    57  	pulumi.CustomResourceState
    58  
    59  	// Display name of the template alias.
    60  	AliasName pulumi.StringOutput `pulumi:"aliasName"`
    61  	// Amazon Resource Name (ARN) of the template alias.
    62  	Arn pulumi.StringOutput `pulumi:"arn"`
    63  	// AWS account ID.
    64  	AwsAccountId pulumi.StringOutput `pulumi:"awsAccountId"`
    65  	// ID of the template.
    66  	TemplateId pulumi.StringOutput `pulumi:"templateId"`
    67  	// Version number of the template.
    68  	//
    69  	// The following arguments are optional:
    70  	TemplateVersionNumber pulumi.IntOutput `pulumi:"templateVersionNumber"`
    71  }
    72  
    73  // NewTemplateAlias registers a new resource with the given unique name, arguments, and options.
    74  func NewTemplateAlias(ctx *pulumi.Context,
    75  	name string, args *TemplateAliasArgs, opts ...pulumi.ResourceOption) (*TemplateAlias, error) {
    76  	if args == nil {
    77  		return nil, errors.New("missing one or more required arguments")
    78  	}
    79  
    80  	if args.AliasName == nil {
    81  		return nil, errors.New("invalid value for required argument 'AliasName'")
    82  	}
    83  	if args.TemplateId == nil {
    84  		return nil, errors.New("invalid value for required argument 'TemplateId'")
    85  	}
    86  	if args.TemplateVersionNumber == nil {
    87  		return nil, errors.New("invalid value for required argument 'TemplateVersionNumber'")
    88  	}
    89  	opts = internal.PkgResourceDefaultOpts(opts)
    90  	var resource TemplateAlias
    91  	err := ctx.RegisterResource("aws:quicksight/templateAlias:TemplateAlias", name, args, &resource, opts...)
    92  	if err != nil {
    93  		return nil, err
    94  	}
    95  	return &resource, nil
    96  }
    97  
    98  // GetTemplateAlias gets an existing TemplateAlias resource's state with the given name, ID, and optional
    99  // state properties that are used to uniquely qualify the lookup (nil if not required).
   100  func GetTemplateAlias(ctx *pulumi.Context,
   101  	name string, id pulumi.IDInput, state *TemplateAliasState, opts ...pulumi.ResourceOption) (*TemplateAlias, error) {
   102  	var resource TemplateAlias
   103  	err := ctx.ReadResource("aws:quicksight/templateAlias:TemplateAlias", name, id, state, &resource, opts...)
   104  	if err != nil {
   105  		return nil, err
   106  	}
   107  	return &resource, nil
   108  }
   109  
   110  // Input properties used for looking up and filtering TemplateAlias resources.
   111  type templateAliasState struct {
   112  	// Display name of the template alias.
   113  	AliasName *string `pulumi:"aliasName"`
   114  	// Amazon Resource Name (ARN) of the template alias.
   115  	Arn *string `pulumi:"arn"`
   116  	// AWS account ID.
   117  	AwsAccountId *string `pulumi:"awsAccountId"`
   118  	// ID of the template.
   119  	TemplateId *string `pulumi:"templateId"`
   120  	// Version number of the template.
   121  	//
   122  	// The following arguments are optional:
   123  	TemplateVersionNumber *int `pulumi:"templateVersionNumber"`
   124  }
   125  
   126  type TemplateAliasState struct {
   127  	// Display name of the template alias.
   128  	AliasName pulumi.StringPtrInput
   129  	// Amazon Resource Name (ARN) of the template alias.
   130  	Arn pulumi.StringPtrInput
   131  	// AWS account ID.
   132  	AwsAccountId pulumi.StringPtrInput
   133  	// ID of the template.
   134  	TemplateId pulumi.StringPtrInput
   135  	// Version number of the template.
   136  	//
   137  	// The following arguments are optional:
   138  	TemplateVersionNumber pulumi.IntPtrInput
   139  }
   140  
   141  func (TemplateAliasState) ElementType() reflect.Type {
   142  	return reflect.TypeOf((*templateAliasState)(nil)).Elem()
   143  }
   144  
   145  type templateAliasArgs struct {
   146  	// Display name of the template alias.
   147  	AliasName string `pulumi:"aliasName"`
   148  	// AWS account ID.
   149  	AwsAccountId *string `pulumi:"awsAccountId"`
   150  	// ID of the template.
   151  	TemplateId string `pulumi:"templateId"`
   152  	// Version number of the template.
   153  	//
   154  	// The following arguments are optional:
   155  	TemplateVersionNumber int `pulumi:"templateVersionNumber"`
   156  }
   157  
   158  // The set of arguments for constructing a TemplateAlias resource.
   159  type TemplateAliasArgs struct {
   160  	// Display name of the template alias.
   161  	AliasName pulumi.StringInput
   162  	// AWS account ID.
   163  	AwsAccountId pulumi.StringPtrInput
   164  	// ID of the template.
   165  	TemplateId pulumi.StringInput
   166  	// Version number of the template.
   167  	//
   168  	// The following arguments are optional:
   169  	TemplateVersionNumber pulumi.IntInput
   170  }
   171  
   172  func (TemplateAliasArgs) ElementType() reflect.Type {
   173  	return reflect.TypeOf((*templateAliasArgs)(nil)).Elem()
   174  }
   175  
   176  type TemplateAliasInput interface {
   177  	pulumi.Input
   178  
   179  	ToTemplateAliasOutput() TemplateAliasOutput
   180  	ToTemplateAliasOutputWithContext(ctx context.Context) TemplateAliasOutput
   181  }
   182  
   183  func (*TemplateAlias) ElementType() reflect.Type {
   184  	return reflect.TypeOf((**TemplateAlias)(nil)).Elem()
   185  }
   186  
   187  func (i *TemplateAlias) ToTemplateAliasOutput() TemplateAliasOutput {
   188  	return i.ToTemplateAliasOutputWithContext(context.Background())
   189  }
   190  
   191  func (i *TemplateAlias) ToTemplateAliasOutputWithContext(ctx context.Context) TemplateAliasOutput {
   192  	return pulumi.ToOutputWithContext(ctx, i).(TemplateAliasOutput)
   193  }
   194  
   195  // TemplateAliasArrayInput is an input type that accepts TemplateAliasArray and TemplateAliasArrayOutput values.
   196  // You can construct a concrete instance of `TemplateAliasArrayInput` via:
   197  //
   198  //	TemplateAliasArray{ TemplateAliasArgs{...} }
   199  type TemplateAliasArrayInput interface {
   200  	pulumi.Input
   201  
   202  	ToTemplateAliasArrayOutput() TemplateAliasArrayOutput
   203  	ToTemplateAliasArrayOutputWithContext(context.Context) TemplateAliasArrayOutput
   204  }
   205  
   206  type TemplateAliasArray []TemplateAliasInput
   207  
   208  func (TemplateAliasArray) ElementType() reflect.Type {
   209  	return reflect.TypeOf((*[]*TemplateAlias)(nil)).Elem()
   210  }
   211  
   212  func (i TemplateAliasArray) ToTemplateAliasArrayOutput() TemplateAliasArrayOutput {
   213  	return i.ToTemplateAliasArrayOutputWithContext(context.Background())
   214  }
   215  
   216  func (i TemplateAliasArray) ToTemplateAliasArrayOutputWithContext(ctx context.Context) TemplateAliasArrayOutput {
   217  	return pulumi.ToOutputWithContext(ctx, i).(TemplateAliasArrayOutput)
   218  }
   219  
   220  // TemplateAliasMapInput is an input type that accepts TemplateAliasMap and TemplateAliasMapOutput values.
   221  // You can construct a concrete instance of `TemplateAliasMapInput` via:
   222  //
   223  //	TemplateAliasMap{ "key": TemplateAliasArgs{...} }
   224  type TemplateAliasMapInput interface {
   225  	pulumi.Input
   226  
   227  	ToTemplateAliasMapOutput() TemplateAliasMapOutput
   228  	ToTemplateAliasMapOutputWithContext(context.Context) TemplateAliasMapOutput
   229  }
   230  
   231  type TemplateAliasMap map[string]TemplateAliasInput
   232  
   233  func (TemplateAliasMap) ElementType() reflect.Type {
   234  	return reflect.TypeOf((*map[string]*TemplateAlias)(nil)).Elem()
   235  }
   236  
   237  func (i TemplateAliasMap) ToTemplateAliasMapOutput() TemplateAliasMapOutput {
   238  	return i.ToTemplateAliasMapOutputWithContext(context.Background())
   239  }
   240  
   241  func (i TemplateAliasMap) ToTemplateAliasMapOutputWithContext(ctx context.Context) TemplateAliasMapOutput {
   242  	return pulumi.ToOutputWithContext(ctx, i).(TemplateAliasMapOutput)
   243  }
   244  
   245  type TemplateAliasOutput struct{ *pulumi.OutputState }
   246  
   247  func (TemplateAliasOutput) ElementType() reflect.Type {
   248  	return reflect.TypeOf((**TemplateAlias)(nil)).Elem()
   249  }
   250  
   251  func (o TemplateAliasOutput) ToTemplateAliasOutput() TemplateAliasOutput {
   252  	return o
   253  }
   254  
   255  func (o TemplateAliasOutput) ToTemplateAliasOutputWithContext(ctx context.Context) TemplateAliasOutput {
   256  	return o
   257  }
   258  
   259  // Display name of the template alias.
   260  func (o TemplateAliasOutput) AliasName() pulumi.StringOutput {
   261  	return o.ApplyT(func(v *TemplateAlias) pulumi.StringOutput { return v.AliasName }).(pulumi.StringOutput)
   262  }
   263  
   264  // Amazon Resource Name (ARN) of the template alias.
   265  func (o TemplateAliasOutput) Arn() pulumi.StringOutput {
   266  	return o.ApplyT(func(v *TemplateAlias) pulumi.StringOutput { return v.Arn }).(pulumi.StringOutput)
   267  }
   268  
   269  // AWS account ID.
   270  func (o TemplateAliasOutput) AwsAccountId() pulumi.StringOutput {
   271  	return o.ApplyT(func(v *TemplateAlias) pulumi.StringOutput { return v.AwsAccountId }).(pulumi.StringOutput)
   272  }
   273  
   274  // ID of the template.
   275  func (o TemplateAliasOutput) TemplateId() pulumi.StringOutput {
   276  	return o.ApplyT(func(v *TemplateAlias) pulumi.StringOutput { return v.TemplateId }).(pulumi.StringOutput)
   277  }
   278  
   279  // Version number of the template.
   280  //
   281  // The following arguments are optional:
   282  func (o TemplateAliasOutput) TemplateVersionNumber() pulumi.IntOutput {
   283  	return o.ApplyT(func(v *TemplateAlias) pulumi.IntOutput { return v.TemplateVersionNumber }).(pulumi.IntOutput)
   284  }
   285  
   286  type TemplateAliasArrayOutput struct{ *pulumi.OutputState }
   287  
   288  func (TemplateAliasArrayOutput) ElementType() reflect.Type {
   289  	return reflect.TypeOf((*[]*TemplateAlias)(nil)).Elem()
   290  }
   291  
   292  func (o TemplateAliasArrayOutput) ToTemplateAliasArrayOutput() TemplateAliasArrayOutput {
   293  	return o
   294  }
   295  
   296  func (o TemplateAliasArrayOutput) ToTemplateAliasArrayOutputWithContext(ctx context.Context) TemplateAliasArrayOutput {
   297  	return o
   298  }
   299  
   300  func (o TemplateAliasArrayOutput) Index(i pulumi.IntInput) TemplateAliasOutput {
   301  	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *TemplateAlias {
   302  		return vs[0].([]*TemplateAlias)[vs[1].(int)]
   303  	}).(TemplateAliasOutput)
   304  }
   305  
   306  type TemplateAliasMapOutput struct{ *pulumi.OutputState }
   307  
   308  func (TemplateAliasMapOutput) ElementType() reflect.Type {
   309  	return reflect.TypeOf((*map[string]*TemplateAlias)(nil)).Elem()
   310  }
   311  
   312  func (o TemplateAliasMapOutput) ToTemplateAliasMapOutput() TemplateAliasMapOutput {
   313  	return o
   314  }
   315  
   316  func (o TemplateAliasMapOutput) ToTemplateAliasMapOutputWithContext(ctx context.Context) TemplateAliasMapOutput {
   317  	return o
   318  }
   319  
   320  func (o TemplateAliasMapOutput) MapIndex(k pulumi.StringInput) TemplateAliasOutput {
   321  	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *TemplateAlias {
   322  		return vs[0].(map[string]*TemplateAlias)[vs[1].(string)]
   323  	}).(TemplateAliasOutput)
   324  }
   325  
   326  func init() {
   327  	pulumi.RegisterInputType(reflect.TypeOf((*TemplateAliasInput)(nil)).Elem(), &TemplateAlias{})
   328  	pulumi.RegisterInputType(reflect.TypeOf((*TemplateAliasArrayInput)(nil)).Elem(), TemplateAliasArray{})
   329  	pulumi.RegisterInputType(reflect.TypeOf((*TemplateAliasMapInput)(nil)).Elem(), TemplateAliasMap{})
   330  	pulumi.RegisterOutputType(TemplateAliasOutput{})
   331  	pulumi.RegisterOutputType(TemplateAliasArrayOutput{})
   332  	pulumi.RegisterOutputType(TemplateAliasMapOutput{})
   333  }