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

BesomSyntax

besom.internal.BesomSyntax
trait BesomSyntax

This trait is the main export point that exposes Besom specific functions and types to the user. The only exception is the Output object which is exposed in BesomModule which extends this trait.

Attributes

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

Members list

Value members

Concrete 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

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

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

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

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

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

Value parameters

ctx

the Besom context

Attributes

Returns

the organization of the current Pulumi stack.

def pulumiProject(using ctx: Context): NonEmptyString

Value parameters

ctx

the Besom context

Attributes

Returns

the project name of the current Pulumi stack.

def pulumiStack(using ctx: Context): NonEmptyString

Value parameters

ctx

the Besom context

Attributes

Returns

the stack name of the current Pulumi stack.

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

Extensions

Extensions

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

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

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

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

Generated with