Package com.pulumi.core.annotations

Annotation Type Export

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

    Use this annotation in your Pulumi programs to mark outputs of @see ComponentResource and @see Stack resources.
    Requirements:

    • annotate a field of type @see Output
    • the type T of the @see Output needs to be given explicitly using type parameter
    • if the type T is also generic, the list of its generic parameter types mus be given using parameters parameter

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.Class<?> type  

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String name  
      java.lang.Class<?>[] parameters  

    • Element Detail

      • type

        java.lang.Class<?> type
        Returns:
        the generic type parameter of the annotated @see Output

      • name

        java.lang.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:
        ""

      • parameters

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