Output is a wrapper for a monadic effect used to model async execution that allows Pulumi to track information about dependencies between resources and properties of data (whether it's known or a secret for instance).
Invariant: dataResult has to be registered in TaskTracker by the time it reaches the constructor here.
Value parameters
Attributes
- Companion
- object
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
Turns a secret into a plaintext! Only use if you know what you're doing.
Turns a secret into a plaintext! Only use if you know what you're doing.
THIS IS UNSAFE AND SHOULD BE USED WITH EXTREME CAUTION.
Attributes
- Returns
-
a plaintext Output, the value is no longer a secret
Turns a plaintext into a secret.
Turns a plaintext into a secret.
This is useful when you have a value that is sensitive in nature, such as a password or cryptographic key, that you don't want to be exposed.
Attributes
- Returns
-
a secret Output, the value is now a secret
Flat-maps the value of the Output using the given function.
Flat-maps the value of the Output using the given function.
Type parameters
- B
-
the type of the value
Value parameters
- f
-
the function to apply to the value
Attributes
- Returns
-
an Output with the flat-mapped value
- See also
-
flatMap(A => F[B])for flat-mapping with an effectful function
Flat-maps the value of the Output using the given effectful function.
Flat-maps the value of the Output using the given effectful function.
Type parameters
- B
-
the type of the value
- F
-
the effect type
Value parameters
- f
-
the effectful function to apply to the value
Attributes
- Returns
-
an Output with the flat-mapped value
- See also
-
flatMap(A => Output[B])for flat-mapping with Output-returning function
Mock variant of flatMap that will fail at compile time if used with a function that returns a value instead of an Output.
Mock variant of flatMap that will fail at compile time if used with a function that returns a value instead of an Output.
Value parameters
- f
-
function to apply to the value of the Output
Attributes
Maps the value of the Output using the given function.
Maps the value of the Output using the given function.
Value parameters
- f
-
the function to apply to the value
Attributes
- Returns
-
an Output with the mapped value
Recovers from a failed Output by applying the given effectful function to the Throwable. Can be used to recover with another property of the same type.
Recovers from a failed Output by applying the given effectful function to the Throwable. Can be used to recover with another property of the same type.
Type parameters
- F
-
the effect type
Value parameters
- f
-
the effectful function to apply to the Throwable
Attributes
- Returns
-
an Output with the recovered value
Recovers from a failed Output by applying the given effectful function to the Throwable. Can be used to recover with an effect of a different type.
Recovers from a failed Output by applying the given effectful function to the Throwable. Can be used to recover with an effect of a different type.
Type parameters
- B
-
the type of the recovered value
- F
-
the effect type
Value parameters
- f
-
the effectful function to apply to the Throwable
Attributes
- Returns
-
an Output with the recovered value
Applies the given function to the value of the Output and discards the result. Useful for logging or other side effects.
Applies the given function to the value of the Output and discards the result. Useful for logging or other side effects.
Value parameters
- f
-
the function to apply to the value
Attributes
- Returns
-
an Output with the original value
Applies the given functions to the value and error of the Output and discards the results. Useful for logging or other side effects. Only one of the functions will be called, depending on whether the Output is a success or a failure.
Applies the given functions to the value and error of the Output and discards the results. Useful for logging or other side effects. Only one of the functions will be called, depending on whether the Output is a success or a failure.
Value parameters
- f
-
the function to apply to the value
- onError
-
the function to apply to the error
Attributes
- Returns
-
an Output with the original value
Applies the given function to the error of the Output and discards the result. Useful for logging or other side effects.
Applies the given function to the error of the Output and discards the result. Useful for logging or other side effects.
Value parameters
- f
-
the function to apply to the error
Attributes
- Returns
-
an Output with the original value
Discards the value of the Output and replaces it with Unit. Useful for ignoring the value of an Output but preserving the metadata about dependencies, secrecy.
Discards the value of the Output and replaces it with Unit. Useful for ignoring the value of an Output but preserving the metadata about dependencies, secrecy.
Attributes
- Returns
-
an Output with the value of Unit
Combines Output with the given Output using the given Zippable, the default implementation results in a Tuple.
Combines Output with the given Output using the given Zippable, the default implementation results in a Tuple.
Type parameters
- B
-
the type of the other Output
Value parameters
- that
-
the other Output to combine with this one
- z
-
the Zippable instance that determines the behavior and the result type of the zip operation