CFNgin base action.
build_walker(concurrency: int) → Callable[[…], typing.Any]¶
Return a function for waling a graph.
runway.cfngin.plan.Planfor walking the graph.
If concurrency is 1 (no parallelism) this will return a simple topological walker that doesn’t use any multithreading.
If concurrency is 0, this will return a walker that will walk the graph as fast as the graph topology allows.
If concurrency is greater than 1, it will return a walker that will only execute a maximum of concurrency steps at any given time.
concurrency – Number of threads to use while walking.
Function to walk a
stack_template_url(bucket_name: str, blueprint: Blueprint, endpoint: str)¶
Produce an s3 url for a given blueprint.
bucket_name – The name of the S3 bucket where the resulting templates are stored.
blueprint – The blueprint object to create the URL to.
endpoint – The s3 endpoint used for the bucket.
BaseAction(context: CfnginContext, provider_builder: Optional[ProviderBuilder] = None, cancel: Optional[threading.Event] = None)¶
Actions perform the actual work of each Command.
Each action is responsible for building the
runway.cfngin.plan.Planthat will be executed.
An object that will build a provider that will be interacted with in order to perform the necessary actions.
Boto3 S3 client.
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.
Return a generic provider using the default region.
Used for running things like hooks.
build_provider() → Provider¶
Build a CFNgin provider.
pre_run(*, dump: Union[bool, str] = False, outline: bool = False, **_BaseAction__kwargs: typing.Any) → None¶
Perform steps before running the action.
post_run(*, dump: Union[bool, str] = False, outline: bool = False, **_BaseAction__kwargs: typing.Any) → None¶
Perform steps after running the action.
run(*, concurrency: int = 0, dump: Union[bool, str] = False, force: bool = False, outline: bool = False, tail: bool = False, **_kwargs: typing.Any) → None¶
Abstract method for running the action.
s3_stack_push(blueprint: Blueprint, force: bool = False) → str¶
Push the rendered blueprint’s template to S3.
Verifies that the template doesn’t already exist in S3 before pushing.
URL to the template in S3.