runway.core package

Core Runway API.

class runway.core.Runway

Bases: object

Runway’s core functionality.

__init__(config: runway.config.RunwayConfig, context: runway.context.RunwayContext) → None

Instantiate class.

Parameters:

• config – Runway config.

• context – Runway context.

deploy(deployments: list[RunwayDeploymentDefinition] | None = None) → None

Deploy action.

Parameters:

deployments – List of deployments to run. If not provided, all deployments in the config will be run.

destroy(deployments: list[RunwayDeploymentDefinition] | None = None) → None

Destroy action.

Parameters:

deployments – List of deployments to run. If not provided, all deployments in the config will be run in reverse.

get_env_vars(deployments: list[RunwayDeploymentDefinition] | None = None) → dict[str, Any]

Get env_vars defined in the config.

Parameters:

deployments – List of deployments to get env_vars from.

Returns:

Resolved env_vars from the deployments.

init(deployments: list[RunwayDeploymentDefinition] | None = None) → None

Init action.

Parameters:

deployments – List of deployments to run. If not provided, all deployments in the config will be run.

plan(deployments: list[RunwayDeploymentDefinition] | None = None) → None

Plan action.

Parameters:

deployments – List of deployments to run. If not provided, all deployments in the config will be run.

static reverse_deployments(deployments: list[RunwayDeploymentDefinition]) → list[RunwayDeploymentDefinition]

Reverse deployments and the modules within them.

Parameters:

deployments – List of deployments to reverse.

Returns:

Deployments and modules in reverse order.

test() → None

Run tests defined in the config.

Subpackages

• runway.core.components package
  • DeployEnvironment
    • DeployEnvironment.__init__()
    • DeployEnvironment.aws_credentials
    • DeployEnvironment.aws_profile
    • DeployEnvironment.aws_region
    • DeployEnvironment.branch_name
    • DeployEnvironment.ci
    • DeployEnvironment.copy()
    • DeployEnvironment.debug
    • DeployEnvironment.ignore_git_branch
    • DeployEnvironment.log_name()
    • DeployEnvironment.max_concurrent_cfngin_stacks
    • DeployEnvironment.max_concurrent_modules
    • DeployEnvironment.max_concurrent_regions
    • DeployEnvironment.name
    • DeployEnvironment.verbose
  • Deployment
    • Deployment.__getitem__()
    • Deployment.__init__()
    • Deployment.assume_role_config
    • Deployment.deploy()
    • Deployment.destroy()
    • Deployment.env_vars_config
    • Deployment.init()
    • Deployment.plan()
    • Deployment.regions
    • Deployment.run()
    • Deployment.run_list()
    • Deployment.use_async
    • Deployment.validate_account_credentials()
  • Module
    • Module.__getitem__()
    • Module.__init__()
    • Module.child_modules
    • Module.deploy()
    • Module.destroy()
    • Module.environment_matches_defined
    • Module.environments
    • Module.fqn
    • Module.init()
    • Module.opts_from_file
    • Module.path
    • Module.payload
    • Module.plan()
    • Module.run()
    • Module.run_list()
    • Module.should_skip
    • Module.type
    • Module.use_async
  • ModulePath
    • ModulePath.__init__()
    • ModulePath.arguments
    • ModulePath.location
    • ModulePath.metadata
    • ModulePath.module_root
    • ModulePath.parse_obj()
    • ModulePath.source
    • ModulePath.uri
  • RunwayModuleType
    • RunwayModuleType.__init__()
• runway.core.providers package
  • Subpackages
    • runway.core.providers.aws package
      • AccountDetails
      • AssumeRole
      • BaseResponse
      • ResponseError
      • ResponseMetadata
      • Subpackages
      • Submodules

Submodules

• runway.core.type_defs module