Show / Hide Table of Contents

Class Alias

Alias is a description of prior named used for a resource. It can be processed in the context of a resource creation to determine what the full aliased URN would be.

Use Urn in the case where a prior URN is known and can just be specified in full. Otherwise, provide some subset of the other properties in this type to generate an appropriate urn from the pre-existing values of the Resource with certain parts overridden.

The presence of a property indicates if its value should be used. If absent (i.e. null), then the value is not used.

Note: because of the above, there needs to be special handling to indicate that the previous Parent of a Resource was null. Specifically, pass in:

Aliases = { new Alias { NoParent = true } }
Inheritance
object
Alias
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Pulumi
Assembly: Pulumi.dll
Syntax
public sealed class Alias

Properties

View Source

Name

The previous name of the resource. If null, the current name of the resource is used.

Declaration
public Input<string>? Name { get; set; }
Property Value
Type Description
Input<string>
View Source

NoParent

Used to indicate the resource previously had no parent. If false this property is ignored.

To specify no original parent, use new Alias { NoParent = true }.

Only specify one of Parent or ParentUrn or NoParent.
Declaration
public bool NoParent { get; set; }
Property Value
Type Description
bool
View Source

Parent

The previous parent of the resource. If null, the current parent of the resource is used.

To specify no original parent, use new Alias { NoParent = true }.

Only specify one of Parent or ParentUrn or NoParent.
Declaration
public Resource? Parent { get; set; }
Property Value
Type Description
Resource
View Source

ParentUrn

The previous parent of the resource. If null, the current parent of the resource is used.

To specify no original parent, use new Alias { NoParent = true }.

Only specify one of Parent or ParentUrn or NoParent.
Declaration
public Input<string>? ParentUrn { get; set; }
Property Value
Type Description
Input<string>
View Source

Project

The previous project of the resource. If null, defaults to the value of Pulumi.IDeployment.ProjectName.

Declaration
public Input<string>? Project { get; set; }
Property Value
Type Description
Input<string>
View Source

Stack

The previous stack of the resource. If null, defaults to the value of Pulumi.IDeployment.StackName.

Declaration
public Input<string>? Stack { get; set; }
Property Value
Type Description
Input<string>
View Source

Type

The previous type of the resource. If null, the current type of the resource is used.

Declaration
public Input<string>? Type { get; set; }
Property Value
Type Description
Input<string>
View Source

Urn

The previous urn to alias to. If this is provided, no other properties in this type should be provided.

Declaration
public string? Urn { get; set; }
Property Value
Type Description
string
  • View Source
Back to top Copyright 2016-2023, Pulumi Corporation.