Package com.pulumi.core.annotations

Annotation Interface Export

@Retention(RUNTIME) @Target(FIELD) public @interface Export
Annotation used by a mark Resource output properties.

Use this annotation in your Pulumi programs to mark outputs of ComponentResource.
Requirements:

  • annotate a field of type @see Output
  • the type T of the @see Output needs to be given explicitly using tree() and refs() parameters
  • if the type T is also generic, the tree shape of its generic parameter types must be given using tree() parameter otherwise it can be omitted

  • Element Details

    • name

      String name
      Returns:
      the exported output name of the annotated @see Output If not set, the name of the annotated field will be used.
      Default:
      ""

    • tree

      String tree
      Returns:
      the generic type parameter tree shape of the annotated @see Output
      Default:
      ""

    • refs

      Class<?>[] refs
      Returns:
      the generic type parameters of the @see tree() If not set, the assumption is that this is not a generic type.
      Default:
      {}