runway.module.cloudformation module

Cloudformation module.

class runway.module.cloudformation.CloudFormation

Bases: RunwayModule[ModuleOptions | dict[str, Any]]

CloudFormation (CFNgin) Runway Module.

__init__(context: RunwayContext, *, explicitly_enabled: bool | None = False, logger: RunwayLogger = <RunwayLogger runway.module.cloudformation (WARNING)>, module_root: Path, name: str | None = None, options: dict[str, Any] | ModuleOptions | None = None, parameters: dict[str, Any] | None = None, **_: Any) → None

Instantiate class.

Parameters:

• context – Runway context object for the current session.

• explicitly_enabled – Whether or not the module is explicitly enabled. This is can be set in the event that the current environment being deployed to matches the defined environments of the module/deployment.

• logger – Used to write logs.

• module_root – Root path of the module.

• name – Name of the module.

• options – Options passed to the module class from the config as options or module_options if coming from the deployment level.

• parameters – Values to pass to the underlying infrastructure as code tool that will alter the resulting infrastructure being deployed. Used to templatize IaC.

deploy() → None

Run deploy.

destroy() → None

Run destroy.

init() → None

Run init.

plan() → None

Run diff.