root
API
Generated with
root/besom/besom.internal/BesomModule

BesomModule

besom.internal.BesomModule
trait BesomModule extends EffectBesomModule

The Besom module provides the core functionality of the Besom runtime.

Attributes

See also
Graph
Supertypes
trait BesomSyntax
class Object
trait Matchable
class Any
Known subtypes
object Pulumi.type

Members list

Type members

Inherited types

type Eff[+A]

Attributes

Inherited from:
EffectBesomModule

Value members

Inherited methods

def component[A <: ComponentResource & Product : Typeable](using ctx: Context)(name: NonEmptyString, typ: ResourceType, opts: ComponentResourceOptions)(f: Context ?=> 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 in the Besom besom.Context and export Stack outputs.

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

Inside Pulumi.run block you can use all methods without Pulumi. prefix. All functions that belong to Besom program but are defined outside the Pulumi.run block should have the following using clause: (using Context) or (using besom.Context) using a fully qualified name of the type.

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

Inherited fields

lazy protected val rt: Runtime[Eff]

Attributes

Inherited from:
EffectBesomModule

Extensions

Inherited extensions

extension [A <: Resource](companion: ResourceCompanion[A])(implicit evidence$3: ResourceDecoder[A], ctx: Context)
def get(name: Input[NonEmptyString], id: Input[ResourceId]): Output[A]

Attributes

Inherited from:
BesomSyntax
extension (os: Output[String])
def toNonEmptyOutput(using Context): 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 (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(using Context): 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

Exports

Defined exports

final type Archive = Archive
Exported from types$
final type ArgsEncoder = ArgsEncoder
Exported from internal
final type Asset = Asset
Exported from types$
final type AssetOrArchive = AssetOrArchive
Exported from types$
final type BooleanEnum = BooleanEnum
Exported from types$
final type ComponentBase = ComponentBase
Exported from types$
final type ComponentResource = ComponentResource
Exported from types$
final val Config: Config.type
Exported from types
final type Config = Config
Exported from types$
final type Context = Context
Exported from types$
final type CustomResource = CustomResource
Exported from types$
final val CustomResourceOptions: CustomResourceOptions.type
Exported from types
final type CustomTimeouts = CustomTimeouts
Exported from types$
final type Decoder = Decoder
Exported from internal
final type Encoder = Encoder
Exported from internal
final type EnumCompanion = [V, E <: PulumiEnum[V]] =>> EnumCompanion[V, E]
Exported from types$
final val FunctionToken: FunctionToken.type
Exported from types
final type FunctionToken = FunctionToken
Exported from types$
final val Input: Input.type
Exported from types
final type Input = Input
Exported from Input$package$
final type IntegerEnum = IntegerEnum
Exported from types$
final type InvokeOptions = InvokeOptions
Exported from types$
final val Label: Label.type
Exported from types
final type Label = Label
Exported from types$
final type Logger = Logger
Exported from types$
final val MDC: MDC.type
Exported from types
final type MDC = MDC
Exported from types$
final val NonEmptyString: NonEmptyString.type
Exported from types
final type NonEmptyString = NonEmptyString
Exported from types$
final type NumberEnum = NumberEnum
Exported from types$
final val Output: Output.type
Exported from types
final type Output = Output
Exported from internal
final val OutputExtensions: OutputExtensions.type
Exported from types
final implicit def OutputListOps[A](output: Output[List[A]]): OutputListOps[A]
Exported from types
final implicit def OutputOfTupleOps[A <: NonEmptyTuple](output: Output[A]): OutputOfTupleOps[A]
Exported from types
final type OutputOfTupleOps = [A <: NonEmptyTuple] =>> OutputOfTupleOps[A]
Exported from OutputExtensionsFactory
final implicit def OutputOptionListOps[A](output: Output[Option[List[A]]]): OutputOptionListOps[A]
Exported from types
final implicit def OutputOptionOps[A](output: Output[Option[A]]): OutputOptionOps[A]
Exported from types
final val OutputSequenceOps: OutputSequenceOps.type
Exported from types
final val OutputTraverseOps: OutputTraverseOps.type
Exported from types
final type ProviderArgsEncoder = ProviderArgsEncoder
Exported from internal
final type ProviderResource = ProviderResource
Exported from types$
final val ProviderType: ProviderType.type
Exported from types
final type ProviderType = ProviderType
Exported from types$
final val PulumiAny: PulumiAny.type
Exported from types
final type PulumiAny = PulumiAny
Exported from types$
final type PulumiEnum = PulumiEnum
Exported from types$
final val PulumiJson: PulumiJson.type
Exported from types
final type PulumiJson = PulumiJson
Exported from types$
final type PulumiToken = PulumiToken
Exported from types$
final type RegistersOutputs = [A <: ComponentResource & Product] =>> RegistersOutputs[A]
Exported from internal
final type ResourceCompanion = [A <: Resource] =>> ResourceCompanion[A]
Exported from internal
final type ResourceDecoder = [A <: Resource] =>> ResourceDecoder[A]
Exported from internal
final val ResourceId: ResourceId.type
Exported from types
final type ResourceId = ResourceId
Exported from types$
final val ResourceOptsVariant: ResourceOptsVariant.type
Exported from types
final val ResourceType: ResourceType.type
Exported from types
final type ResourceType = ResourceType
Exported from types$
final val Stack: Stack.type
Exported from types
final type Stack = Stack
Exported from types$
final val StackReference: StackReference.type
Exported from types
final type StackReference = StackReference
Exported from types$
final val StackReferenceArgs: StackReferenceArgs.type
Exported from types
final type StackReferenceArgs = StackReferenceArgs
Exported from types$
final type StringEnum = StringEnum
Exported from types$
final val URN: URN.type
Exported from types
final type URN = URN
Exported from types$
Generated with