runway.cfngin.actions.init module

CFNgin init action.

class runway.cfngin.actions.init.Action

Bases: BaseAction

Initialize environment.

__init__(context: CfnginContext, provider_builder: ProviderBuilder | None = None, cancel: threading.Event | None = None) → None

Instantiate class.

This class creates a copy of the context object prior to initialization as some of it can perform destructive actions on the context object.

Parameters:

• context – The context for the current run.

• provider_builder – An object that will build a provider that will be interacted with in order to perform the necessary actions.

• cancel – Cancel handler.

property cfngin_bucket: Bucket | None

CFNgin bucket.

Raises:

CfnginBucketRequired – cfngin_bucket not defined.

property default_cfngin_bucket_stack: CfnginStackDefinitionModel

CFNgin bucket stack.

post_run(*, dump: bool | str = False, outline: bool = False, **_Action__kwargs: Any) → None

Do nothing.

pre_run(*, dump: bool | str = False, outline: bool = False, **_Action__kwargs: Any) → None

Do nothing.

run(*, concurrency: int = 0, dump: bool | str = False, force: bool = False, outline: bool = False, tail: bool = False, upload_disabled: bool = True, **_kwargs: Any) → None

Run the action.

Parameters:

• concurrency – The maximum number of concurrent deployments.

• dump – Not used by this action

• force – Not used by this action.

• outline – Not used by this action.

• tail – Tail the stack’s events.

• upload_disabled – Not used by this action.

Raises:

CfnginBucketAccessDenied – Could not head cfngin_bucket.