runway.module.cloudformation module

Cloudformation module.

class runway.module.cloudformation.CloudFormation(context: RunwayContext, *, explicitly_enabled: Optional[bool] = False, logger: RunwayLogger = <RunwayLogger runway.module.cloudformation (WARNING)>, module_root: Path, name: Optional[str] = None, options: Optional[Union[Dict[str, Any], ModuleOptions]] = None, parameters: Optional[Dict[str, Any]] = None, **_: Any)[source]

Bases: runway.module.base.RunwayModule

CloudFormation (Stacker) Runway Module.

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.

logger: Union[PrefixAdaptor, RunwayLogger]
deploy()None[source]

Run deploy.

destroy()None[source]

Run destroy.

plan()None[source]

Run diff.

ctx: RunwayContext
explicitly_enabled: Optional[bool]
name: str
options: Union[Dict[str, Any], ModuleOptions]
region: str