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

EffectBesomModule

besom.internal.EffectBesomModule
trait EffectBesomModule extends BesomSyntax

An abstract effect Besom module, which can be implemented for different effect types.

Type parameters

Eff

the effect type

Attributes

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

Members list

Type members

Types

type Eff[+A]

Value members

Concrete methods

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 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 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

Abstract fields

lazy protected val rt: Runtime[Eff]

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
Generated with