Interface Alias

Alias is a partial 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.

Note there is a semantic difference between properties being absent from this type and properties having the undefined value. Specifically, there is a difference between:

{ name: "foo", parent: undefined } // and
{ name: "foo" }

The presence of a property indicates if its value should be used. If absent, then the value is not used. So, in the above while alias.parent is undefined for both, the first alias means "the original urn had no parent" while the second alias means "use the current parent".

Note: to indicate that a resource was previously parented by the root stack, it is recommended that you use:

aliases: [{ parent: pulumi.rootStackResource }]

This form is self-descriptive and makes the intent clearer than using:

aliases: [{ parent: undefined }]

interface Alias {
    name?: Input<string>;
    parent?: Resource | Input<string>;
    project?: Input<string>;
    stack?: Input<string>;
    type?: Input<string>;


name?: Input<string>

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

parent?: Resource | Input<string>

The previous parent of the resource. If not provided (i.e. { name: "foo" }), the current parent of the resource is used (opts.parent if provided, else the implicit stack resource parent).

To specify no original parent, use { parent: pulumi.rootStackResource }.

project?: Input<string>

The previous project of the resource. If not provided, defaults to pulumi.getProject().

stack?: Input<string>

The previous stack of the resource. If not provided, defaults to pulumi.getStack().

type?: Input<string>

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

Generated using TypeDoc