runway.cfngin.exceptions module

CFNgin exceptions.

exception runway.cfngin.exceptions.CancelExecution[source]

Bases: Exception

Raised when we want to cancel executing the plan.

exception runway.cfngin.exceptions.ChangesetDidNotStabilize(change_set_id)[source]

Bases: Exception

Raised when the applying a changeset fails.

Instantiate class.

Parameters

change_set_id (str) – The changeset that failed.

exception runway.cfngin.exceptions.FailedLookup(lookup, error, *args, **kwargs)[source]

Bases: Exception

Intermediary Exception to be converted to FailedVariableLookup.

Should be caught by error handling and runway.cfngin.exceptions.FailedVariableLookup raised instead to construct a propper error message.

Instantiate class.

Parameters
  • lookup (runway.cfngin.variables.VariableValueLookup) – Attempted lookup and resulted in an exception being raised.

  • error (Exception) – The exception that was raised.

exception runway.cfngin.exceptions.FailedVariableLookup(variable_name, lookup, error, *args, **kwargs)[source]

Bases: Exception

Lookup could not be resolved.

Raised when an exception is raised when trying to resolve a lookup.

Instantiate class.

Parameters
  • variable_name (str) – Name of the variable that failed to be resolved.

  • lookup (runway.cfngin.variables.VariableValueLookup) – Attempted lookup and resulted in an exception being raised.

  • error (Exception) – The exception that was raised.

exception runway.cfngin.exceptions.GraphError(exception, stack, dependency)[source]

Bases: Exception

Raised when the graph is invalid (e.g. acyclic dependencies).

Instantiate class.

Parameters
  • exception (Exception) – The exception that was raised by the invalid graph.

  • stack (str) – Name of the stack causing the error.

  • dependency (str) – Name of the dependency causing the error.

exception runway.cfngin.exceptions.ImproperlyConfigured(cls, error, *args, **kwargs)[source]

Bases: Exception

Raised when a componenet is improperly configured.

Instantiate class.

Parameters
  • cls (Any) – The class that was improperly configured.

  • error (Exception) – The exception that was raised when trying to use cls.

exception runway.cfngin.exceptions.InvalidConfig(errors)[source]

Bases: Exception

Provided config file is invalid.

Instantiate class.

Parameters

errors (Union[str, List[Union[Exception, str]]]) – Errors or error messages that are raised to identify that a config is invalid.

exception runway.cfngin.exceptions.InvalidDockerizePipConfiguration(msg)[source]

Bases: Exception

Raised when the provided configuration for dockerized pip is invalid.

Instantiate class.

Parameters

msg (str) – The reason for the error being raised.

exception runway.cfngin.exceptions.InvalidLookupCombination(lookup, lookups, value, *args, **kwargs)[source]

Bases: Exception

Improper use of lookups to result in a non-string return value.

Instantiate class.

Parameters
  • lookup (runway.cfngin.variables.VariableValueLookup) – The variable lookup that was attempted but did not return a string.

  • lookups (runway.cfngin.variables.VariableValueConcatenation) – The full variable concatenation the failing lookup is part of.

  • value (Any) – The non-string value returned by lookup.

exception runway.cfngin.exceptions.InvalidLookupConcatenation(lookup, lookups, *args, **kwargs)[source]

Bases: Exception

Intermediary Exception to be converted to InvalidLookupCombination.

Should be caught by error handling and runway.cfngin.exceptions.InvalidLookupCombination raised instead to construct a propper error message.

Instantiate class.

exception runway.cfngin.exceptions.InvalidUserdataPlaceholder(blueprint_name, exception_message, *args, **kwargs)[source]

Bases: Exception

Raised when a placeholder name in raw_user_data is not valid.

E.g ${100} would raise this.

Instantiate class.

Parameters
  • blueprint_name (str) – Name of the blueprint with invalid userdata placeholder.

  • exception_message (str) – Message from the exception that was raised while parsing the userdata.

exception runway.cfngin.exceptions.MissingEnvironment(key, *args, **kwargs)[source]

Bases: Exception

Raised when an environment lookup is used but the key doesn’t exist.

Instantiate class.

Parameters
  • key (str) – The key that was used but doesn’t exist in the

  • environment.

exception runway.cfngin.exceptions.MissingParameterException(parameters, *args, **kwargs)[source]

Bases: Exception

Raised if a required parameter with no default is missing.

Instantiate class.

Parameters

parameters (List[str]) – A list of the parameters that are missing.

exception runway.cfngin.exceptions.MissingVariable(blueprint_name, variable_name, *args, **kwargs)[source]

Bases: Exception

Raised when a variable with no default is not provided a value.

Instantiate class.

Parameters
  • blueprint_name (str) – Name of the blueprint.

  • variable_name (str) – Name of the variable missing a value.

exception runway.cfngin.exceptions.OutputDoesNotExist(stack_name, output, *args, **kwargs)[source]

Bases: Exception

Raised when a specific stack output does not exist.

Instantiate class.

Parameters
  • stack_name (str) – Name of the stack.

  • output (str) – The output that does not exist.

exception runway.cfngin.exceptions.PipError[source]

Bases: Exception

Raised when pip returns a non-zero exit code.

Instantiate class.

exception runway.cfngin.exceptions.PipenvError[source]

Bases: Exception

Raised when pipenv returns a non-zero exit code.

Instantiate class.

exception runway.cfngin.exceptions.PersistentGraphCannotLock(reason)[source]

Bases: Exception

Raised when the persistent graph in S3 cannot be locked.

Instantiate class.

exception runway.cfngin.exceptions.PersistentGraphCannotUnlock(reason)[source]

Bases: Exception

Raised when the persistent graph in S3 cannot be unlocked.

Instantiate class.

exception runway.cfngin.exceptions.PersistentGraphLocked(message=None, reason=None)[source]

Bases: Exception

Raised when the persistent graph in S3 is lock.

The action being executed requires it to be unlocked before attempted.

Instantiate class.

exception runway.cfngin.exceptions.PersistentGraphLockCodeMissmatch(provided_code, s3_code)[source]

Bases: Exception

Raised when the provided persistent graph lock code does not match.

The code used to unlock the persistent graph must match the s3 object lock code.

Instantiate class.

exception runway.cfngin.exceptions.PersistentGraphUnlocked(message=None, reason=None)[source]

Bases: Exception

Raised when the persistent graph in S3 is unlock.

The action being executed requires it to be locked before attempted.

Instantiate class.

exception runway.cfngin.exceptions.PlanFailed(failed_steps, *args, **kwargs)[source]

Bases: Exception

Raised if any step of a plan fails.

Instantiate class.

Parameters

failed_steps (List[runway.cfngin.plan.Step]) – The steps that failed.

exception runway.cfngin.exceptions.StackDidNotChange[source]

Bases: Exception

Raised when there are no changes to be made by the provider.

exception runway.cfngin.exceptions.StackDoesNotExist(stack_name, *args, **kwargs)[source]

Bases: Exception

Raised when a stack does not exist in AWS.

Instantiate class.

Parameters

stack_name (str) – Name of the stack that does not exist.

exception runway.cfngin.exceptions.StackUpdateBadStatus(stack_name, stack_status, reason, *args, **kwargs)[source]

Bases: Exception

Raised if the state of a stack can’t be handled.

Instantiate class.

Parameters
  • stack_name (str) – Name of the stack.

  • stack_status (str) – The stack’s status.

  • reason (str) – The reason for the current status.

exception runway.cfngin.exceptions.StackFailed(stack_name, status_reason=None)[source]

Bases: Exception

Raised when a stack action fails.

Primarily used with hooks that act on stacks.

Instantiate class.

Parameters
  • stack_name (str) – Name of the stack.

  • status_reason (str) – The reason for the current status.

exception runway.cfngin.exceptions.UnableToExecuteChangeSet(stack_name, change_set_id, execution_status)[source]

Bases: Exception

Raised if changeset execution status is not AVAILABLE.

Instantiate class.

Parameters
  • stack_name (str) – Name of the stack.

  • change_set_id (str) – The changeset that failed.

  • execution_status (str) – The value of the changeset’s ExecutionStatus attribute.

exception runway.cfngin.exceptions.UnhandledChangeSetStatus(stack_name, change_set_id, status, status_reason)[source]

Bases: Exception

Raised when creating a changeset failed for an unhandled reason.

Handled failure reasons include: no changes

Instantiate class.

Parameters
  • stack_name (str) – Name of the stack.

  • change_set_id (str) – The changeset that failed.

  • status (str) – The state that could not be handled.

  • status_reason (str) – Cause of the current state.

exception runway.cfngin.exceptions.UnknownLookupType(lookup_type, *args, **kwargs)[source]

Bases: Exception

Lookup type provided does not match a registered lookup.

Example

If a lookup of ${<lookup_type> query} is used and <lookup_type> is not a registered lookup, this exception will be raised.

Instantiate class.

Parameters

lookup_type (str) – Lookup type that was used but not registered.

exception runway.cfngin.exceptions.UnresolvedVariable(blueprint_name, variable, *args, **kwargs)[source]

Bases: Exception

Raised when trying to use a variable before it has been resolved.

Instantiate class.

Parameters
  • blueprint_name (str) – Name of the blueprint that tried to use the unresolved variables.

  • variable (runway.cfngin.variables.Variable) – The unresolved variable.

exception runway.cfngin.exceptions.UnresolvedVariableValue(lookup, *args, **kwargs)[source]

Bases: Exception

Intermediary Exception to be converted to UnresolvedVariable.

Should be caught by error handling and runway.cfngin.exceptions.UnresolvedVariable raised instead to construct a propper error message.

Instantiate class.

Parameters

lookup (runway.cfngin.variables.VariableValueLookup) – The lookup that is not resolved.

exception runway.cfngin.exceptions.UnresolvedVariables(blueprint_name, *args, **kwargs)[source]

Bases: Exception

Raised when trying to use variables before they has been resolved.

Instantiate class.

Parameters

blueprint_name (str) – Name of the blueprint that tried to use the unresolved variables.

exception runway.cfngin.exceptions.ValidatorError(variable, validator, value, exception=None)[source]

Bases: Exception

Used for errors raised by custom validators of blueprint variables.

Instantiate class.

Parameters
  • variable (str) – The variable that failed validation.

  • validator (str) – The validator that was not passed.

  • value (str) – The value of the variable that did not pass the validator.

  • exception (Exception) – The exception raised by the validator.

exception runway.cfngin.exceptions.VariableTypeRequired(blueprint_name, variable_name, *args, **kwargs)[source]

Bases: Exception

Raised when a variable defined in a blueprint is missing a type.

Instantiate class.

Parameters
  • blueprint_name (str) – Name of the blueprint.

  • variable_name (str) – Name of the variable missing a type.