root
API
Generated with
root/besom.zio/ZIOModule

ZIOModule

besom.zio.ZIOModule
trait ZIOModule extends BesomModule

Attributes

Graph
Supertypes
trait BesomModule
trait EffectBesomModule
trait BesomSyntax
class Object
trait Matchable
class Any
Show all
Known subtypes
object Pulumi.type

Members list

Type members

Types

final override type Eff[+A] = Task[A]

Value members

Inherited methods

def component[A <: ComponentResource & Product : Typeable](name: NonEmptyString, typ: ResourceType, opts: ComponentResourceOptions)(f: ComponentBase ?=> A): Output[A]

Creates a new component resource.

Creates a new component resource.

Type parameters

A

the type of the component resource

Value parameters

ctx

the Besom context

f

the block of code that defines all the resources that should belong to the component

name

a unique resource name for this component

typ

the Pulumi ResourceType of the component resource

Attributes

Returns

the component resource instance

Inherited from:
BesomSyntax
def config(using ctx: Context): Config

Returns the current project configuration.

Returns the current project configuration.

Value parameters

ctx

the Besom context

Attributes

Returns

the current project Config instance

Inherited from:
BesomSyntax
def isDryRun(using ctx: Context): Boolean

A dry run is a program evaluation for purposes of planning, instead of performing a true deployment.

A dry run is a program evaluation for purposes of planning, instead of performing a true deployment.

Value parameters

ctx

the Besom context

Attributes

Returns

true if the current run is a dry run

Inherited from:
BesomSyntax
def log(using ctx: Context): Logger

Returns the current project logger.

Returns the current project logger.

Value parameters

ctx

the Besom context

Attributes

Returns

the current project besom.aliases.Logger instance

Inherited from:
BesomSyntax
def opts(using variant: ResourceOptsVariant): Constructor

Shortcut function allowing for uniform resource options syntax everywhere.

Shortcut function allowing for uniform resource options syntax everywhere.

Attributes

Inherited from:
BesomSyntax
def pulumiOrganization(using ctx: Context): Option[NonEmptyString]

Value parameters

ctx

the Besom context

Attributes

Returns

the organization of the current Pulumi stack.

Inherited from:
BesomSyntax
def pulumiProject(using ctx: Context): NonEmptyString

Value parameters

ctx

the Besom context

Attributes

Returns

the project name of the current Pulumi stack.

Inherited from:
BesomSyntax
def pulumiStack(using ctx: Context): NonEmptyString

Value parameters

ctx

the Besom context

Attributes

Returns

the stack name of the current Pulumi stack.

Inherited from:
BesomSyntax
def run(program: Context ?=> Stack): Unit

Run a besom.Pulumi program with a Besom besom.Context and export Stack outputs.

Run a besom.Pulumi program with a Besom besom.Context and export Stack outputs.

Inside Pulumi.run block you can use the following methods without Pulumi. prefix:

  • besom.internal.BesomSyntax.isDryRun - is the current run a dry run (planning instead of deployment)
  • besom.internal.BesomSyntax.config - provides access to the configuration and secrets
  • besom.internal.BesomSyntax.log - all your logging needs
  • besom.internal.BesomSyntax.urn - the URN of the current Pulumi stack
  • besom.internal.BesomSyntax.pulumiOrganization - the organization of the current Pulumi stack
  • besom.internal.BesomSyntax.pulumiProject - the project name of the current Pulumi stack
  • besom.internal.BesomSyntax.pulumiStack - the stack name of the current Pulumi stack

Should you need to use one of these methods outside of the Pulumi.run block, you can use the following using clauses:

  • (using Context) if you have a import besom.* clause on top of the file or
  • (using besom.Context) using a fully qualified name of the type.

There are also two other functions exported by besom.Pulumi:

  • besom.internal.BesomModule.component - creates a new component resource
  • besom.internal.BesomModule.opts - shortcut function allowing for uniform resource options syntax

Example:

import besom.*
import besom.api.aws

@main def run = Pulumi.run {
 val bucket = aws.s3.Bucket("my-bucket")

 Stack.exports(bucketUrl = bucket.websiteEndpoint)
}

Value parameters

program

the program to run

Attributes

Inherited from:
EffectBesomModule
def urn(using ctx: Context): Output[URN]

The current project besom.types.URN

The current project besom.types.URN

Value parameters

ctx

the Besom context

Attributes

Returns

the current project besom.types.URN instance

Inherited from:
BesomSyntax

Concrete fields

lazy protected val rt: Runtime[Eff]

Extensions

Inherited extensions

extension [A <: RemoteComponentResource](cb: A)
def providers: Output[Map[String, ProviderResource]]

Attributes

Inherited from:
BesomSyntax
extension [A <: ComponentResource](cmpr: A)
def providers: Output[Map[String, ProviderResource]]

Attributes

Inherited from:
BesomSyntax
extension [A <: Resource](companion: ResourceCompanion[A])(implicit evidence$3: ResourceDecoder[A])
def get: Output[A]

Attributes

Inherited from:
BesomSyntax
extension [A <: CustomResource](cr: A)
def provider: Output[Option[ProviderResource]]

Attributes

Inherited from:
BesomSyntax
extension (os: Output[String])
def toNonEmptyOutput: Output[NonEmptyString]

Converts an Output of String to an Output of NonEmptyString which will be failed if the string is empty.

Converts an Output of String to an Output of NonEmptyString which will be failed if the string is empty.

Attributes

Inherited from:
BesomSyntax
extension [A <: ProviderResource](pr: A)
def provider: Output[Option[ProviderResource]]

Attributes

Inherited from:
BesomSyntax
extension (s: String)
def toNonEmpty: Option[NonEmptyString]

Converts a String to a NonEmptyString if it is not empty or blank.

Converts a String to a NonEmptyString if it is not empty or blank.

Attributes

Inherited from:
BesomSyntax
def toNonEmptyOrThrow: NonEmptyString

Converts a String to a NonEmptyString if it is not empty or blank, otherwise throws an IllegalArgumentException.

Converts a String to a NonEmptyString if it is not empty or blank, otherwise throws an IllegalArgumentException.

Attributes

Inherited from:
BesomSyntax
def toNonEmptyOutput: Output[NonEmptyString]

Converts a String to an Output of NonEmptyString if it is not empty or blank, otherwise returns a failed Output with an IllegalArgumentException.

Converts a String to an Output of NonEmptyString if it is not empty or blank, otherwise returns a failed Output with an IllegalArgumentException.

Attributes

Inherited from:
BesomSyntax

Implicits

Implicits

implicit def toFutureZIOTask[E <: Throwable]: ToFuture[[_] =>> IO[E, _$2]]

Exports

Inherited defined exports

final type Archive = Archive
Exported from types$

Attributes

Inherited from:
BesomModule
final type ArgsEncoder = ArgsEncoder
Exported from internal

Attributes

Inherited from:
BesomModule
final type Asset = Asset
Exported from types$

Attributes

Inherited from:
BesomModule
final type AssetOrArchive = AssetOrArchive
Exported from types$

Attributes

Inherited from:
BesomModule
final type BooleanEnum = BooleanEnum
Exported from types$

Attributes

Inherited from:
BesomModule
final type ComponentBase = ComponentBase
Exported from types$

Attributes

Inherited from:
BesomModule
final type ComponentResource = ComponentResource
Exported from types$

Attributes

Inherited from:
BesomModule
final val ComponentResourceOptions: ComponentResourceOptions.type
Exported from types

Attributes

Inherited from:
BesomModule
final type ComponentResourceOptions = ComponentResourceOptions
Exported from types$

Attributes

Inherited from:
BesomModule
final val Config: Config.type
Exported from types

Attributes

Inherited from:
BesomModule
final type Config = Config
Exported from types$

Attributes

Inherited from:
BesomModule
final type Context = Context
Exported from types$

Attributes

Inherited from:
BesomModule
final type CustomResource = CustomResource
Exported from types$

Attributes

Inherited from:
BesomModule
final val CustomResourceOptions: CustomResourceOptions.type
Exported from types

Attributes

Inherited from:
BesomModule
final type CustomResourceOptions = CustomResourceOptions
Exported from types$

Attributes

Inherited from:
BesomModule
final type CustomTimeouts = CustomTimeouts
Exported from types$

Attributes

Inherited from:
BesomModule
final val CustomTimeouts: CustomTimeouts.type
Exported from types

Attributes

Inherited from:
BesomModule
final type Decoder = Decoder
Exported from internal

Attributes

Inherited from:
BesomModule
final type Encoder = Encoder
Exported from internal

Attributes

Inherited from:
BesomModule
final type EnumCompanion = [V, E <: PulumiEnum[V]] =>> EnumCompanion[V, E]
Exported from types$

Attributes

Inherited from:
BesomModule
final type FunctionToken = FunctionToken
Exported from types$

Attributes

Inherited from:
BesomModule
final val FunctionToken: FunctionToken.type
Exported from types

Attributes

Inherited from:
BesomModule
final val Input: Input.type
Exported from types

Attributes

Inherited from:
BesomModule
final type Input = Input
Exported from Input$package$

Attributes

Inherited from:
BesomModule
final type IntegerEnum = IntegerEnum
Exported from types$

Attributes

Inherited from:
BesomModule
final type InvokeOptions = InvokeOptions
Exported from types$

Attributes

Inherited from:
BesomModule
final val Label: Label.type
Exported from types

Attributes

Inherited from:
BesomModule
final type Label = Label
Exported from types$

Attributes

Inherited from:
BesomModule
final type Logger = Logger
Exported from types$

Attributes

Inherited from:
BesomModule
final type MDC = MDC
Exported from types$

Attributes

Inherited from:
BesomModule
final val MDC: MDC.type
Exported from types

Attributes

Inherited from:
BesomModule
final type NonEmptyString = NonEmptyString
Exported from types$

Attributes

Inherited from:
BesomModule
final val NonEmptyString: NonEmptyString.type
Exported from types

Attributes

Inherited from:
BesomModule
final type NumberEnum = NumberEnum
Exported from types$

Attributes

Inherited from:
BesomModule
final type Output = Output
Exported from internal

Attributes

Inherited from:
BesomModule
final val Output: Output.type
Exported from types

Attributes

Inherited from:
BesomModule
final val OutputExtensions: OutputExtensions.type
Exported from types

Attributes

Inherited from:
BesomModule
final type OutputListOps = OutputListOps
Exported from OutputExtensionsFactory

Attributes

Inherited from:
BesomModule
final implicit def OutputListOps[A](output: Output[List[A]]): OutputListOps[A]
Exported from types

Attributes

Inherited from:
BesomModule
final type OutputOfTupleOps = [A <: NonEmptyTuple] =>> OutputOfTupleOps[A]
Exported from OutputExtensionsFactory

Attributes

Inherited from:
BesomModule
final implicit def OutputOfTupleOps[A <: NonEmptyTuple](output: Output[A]): OutputOfTupleOps[A]
Exported from types

Attributes

Inherited from:
BesomModule
final type OutputOptionListOps = OutputOptionListOps
Exported from OutputExtensionsFactory

Attributes

Inherited from:
BesomModule
final implicit def OutputOptionListOps[A](output: Output[Option[List[A]]]): OutputOptionListOps[A]
Exported from types

Attributes

Inherited from:
BesomModule
final type OutputOptionOps = OutputOptionOps
Exported from OutputExtensionsFactory

Attributes

Inherited from:
BesomModule
final implicit def OutputOptionOps[A](output: Output[Option[A]]): OutputOptionOps[A]
Exported from types

Attributes

Inherited from:
BesomModule
final val OutputSequenceOps: OutputSequenceOps.type
Exported from types

Attributes

Inherited from:
BesomModule
final type OutputStringStripMarginOps = OutputStringStripMarginOps
Exported from interpolator$

Attributes

Inherited from:
BesomModule
final val OutputTraverseOps: OutputTraverseOps.type
Exported from types

Attributes

Inherited from:
BesomModule
final type ProviderArgsEncoder = ProviderArgsEncoder
Exported from internal

Attributes

Inherited from:
BesomModule
final type ProviderResource = ProviderResource
Exported from types$

Attributes

Inherited from:
BesomModule
final type ProviderType = ProviderType
Exported from types$

Attributes

Inherited from:
BesomModule
final val ProviderType: ProviderType.type
Exported from types

Attributes

Inherited from:
BesomModule
final type PulumiAny = PulumiAny
Exported from types$

Attributes

Inherited from:
BesomModule
final val PulumiAny: PulumiAny.type
Exported from types

Attributes

Inherited from:
BesomModule
final type PulumiEnum = PulumiEnum
Exported from types$

Attributes

Inherited from:
BesomModule
final type PulumiInterpolationOps = PulumiInterpolationOps
Exported from interpolator$

Attributes

Inherited from:
BesomModule
final val PulumiJson: PulumiJson.type
Exported from types

Attributes

Inherited from:
BesomModule
final type PulumiJson = PulumiJson
Exported from types$

Attributes

Inherited from:
BesomModule
final type PulumiToken = PulumiToken
Exported from types$

Attributes

Inherited from:
BesomModule
final type RegistersOutputs = [A <: ComponentResource & Product] =>> RegistersOutputs[A]
Exported from internal

Attributes

Inherited from:
BesomModule
final type RemoteComponentResource = RemoteComponentResource
Exported from types$

Attributes

Inherited from:
BesomModule
final type ResourceCompanion = [A <: Resource] =>> ResourceCompanion[A]
Exported from internal

Attributes

Inherited from:
BesomModule
final type ResourceDecoder = [A <: Resource] =>> ResourceDecoder[A]
Exported from internal

Attributes

Inherited from:
BesomModule
final type ResourceId = ResourceId
Exported from types$

Attributes

Inherited from:
BesomModule
final val ResourceId: ResourceId.type
Exported from types

Attributes

Inherited from:
BesomModule
final val ResourceOptsVariant: ResourceOptsVariant.type
Exported from types

Attributes

Inherited from:
BesomModule
final type ResourceType = ResourceType
Exported from types$

Attributes

Inherited from:
BesomModule
final val ResourceType: ResourceType.type
Exported from types

Attributes

Inherited from:
BesomModule
final val Stack: Stack.type
Exported from types

Attributes

Inherited from:
BesomModule
final type Stack = Stack
Exported from types$

Attributes

Inherited from:
BesomModule
final type StackReference = StackReference
Exported from types$

Attributes

Inherited from:
BesomModule
final val StackReference: StackReference.type
Exported from types

Attributes

Inherited from:
BesomModule
final type StackReferenceArgs = StackReferenceArgs
Exported from types$

Attributes

Inherited from:
BesomModule
final val StackReferenceArgs: StackReferenceArgs.type
Exported from types

Attributes

Inherited from:
BesomModule
final type StackReferenceResourceOptions = StackReferenceResourceOptions
Exported from types$

Attributes

Inherited from:
BesomModule
final val StackReferenceResourceOptions: StackReferenceResourceOptions.type
Exported from types

Attributes

Inherited from:
BesomModule
final type StringEnum = StringEnum
Exported from types$

Attributes

Inherited from:
BesomModule
final type TypedStackReference = TypedStackReference
Exported from internal

Attributes

Inherited from:
BesomModule
final type URN = URN
Exported from types$

Attributes

Inherited from:
BesomModule
final val URN: URN.type
Exported from types

Attributes

Inherited from:
BesomModule
implicit def outputJsonReader[A](using jsonReader: JsonReader[A], ctx: Context): JsonReader[Output[A]]
Exported from types

Attributes

Inherited from:
BesomModule
Generated with