Package com.pulumi.core

Class Alias

java.lang.Object
com.pulumi.core.Alias
public class Alias extends Object
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.

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 @see Resource was "null". Specifically, pass in: noParent()

See Also:

  • Method Details

    • noParent

      public static Alias noParent()
      Create an Alias with no parent. No parent can indicate a root resource.
      Returns:
      an Alias instance with no parent
      See Also:

    • withUrn

      public static Alias withUrn(String urn)
      Create an Alias for a given URN.
      Parameters:
      urn - the URN to use.
      Returns:
      an Alias instance with the given urn
      See Also:

    • builder

      public static Alias.Builder builder()
      Returns:
      an Alias Alias.Builder
      See Also:

    • getUrn

      public Optional<String> getUrn()
      The previous urn to alias to. If this is provided, no other properties in this type should be provided.

    • getName

      public Optional<Output<String>> getName()
      The previous name of the resource. If empty, the current name of the resource is used.

    • getType

      public Optional<Output<String>> getType()
      The previous type of the resource. If empty, the current type of the resource is used.

    • getStack

      public Optional<Output<String>> getStack()
      The previous stack of the resource. If empty, defaults to the value of @see Deployment.getStackName()

    • getProject

      public Optional<Output<String>> getProject()
      The previous project of the resource. If empty, defaults to the value of @see Deployment.getProjectName()

    • getParent

      public Optional<Resource> getParent()
      The previous parent of the resource. If empty, the current parent of the resource is used.

      To specify no original parent, use "noParent".

      Only specify one of "parent" or "parentUrn" or "noParent".

    • getParentUrn

      public Optional<Output<String>> getParentUrn()
      The previous parent of the resource. if empty, the current parent of the resource is used.

      To specify no original parent, use "noParent".

      Only specify one of "parent" or "parentUrn" or "noParent".

    • hasNoParent

      public boolean hasNoParent()
      Used to indicate the resource previously had no parent. If "false" this property is ignored.

      Only specify one of "parent" or "parentUrn" or "noParent".