Hide navigation sidebar

Hide table of contents sidebar

Skip to content

Toggle site navigation sidebar

Runway v2.8.3

Toggle table of contents sidebar

Runway v2.8.3

Runway

Installation
Upgrades
Getting Started Guide
Quickstart Guides
Toggle navigation of Quickstart Guides
Commands
Runway Config File
Lookups
Toggle navigation of Lookups
- cfn
- ecr
- env
- random.string
- ssm
- var
Defining Tests
Repo Structure

AWS Cloud Development Kit (CDK)

Configuration
Directory Structure
Advanced Features

CloudFormation & Troposphere

Configuration
Directory Structure
Advanced Features
Toggle navigation of Advanced Features
- Blueprints
- Hooks
  Toggle navigation of Hooks
- Lookups
  Toggle navigation of Lookups
- Persistent Graph
- Remote Sources
- Templates
Migrating from Stacker

Kubernetes

Configuration
Directory Structure
Examples
Advanced Features

Serverless Framework

Configuration
Directory Structure
Advanced Features

Static Site

Configuration
Directory Structure
Examples
Advanced Features

Terraform

Configuration
Directory Structure
Advanced Features

Developers Guide

API Docs
Toggle navigation of API Docs
- runway package
  Toggle navigation of runway package
  - runway.aws_sso_botocore package
    Toggle navigation of runway.aws_sso_botocore package
  - runway.blueprints package
    Toggle navigation of runway.blueprints package
    - runway.blueprints.k8s package
      Toggle navigation of runway.blueprints.k8s package
    - runway.blueprints.staticsite package
      Toggle navigation of runway.blueprints.staticsite package
    - runway.blueprints.tf_state module
  - runway.cfngin package
    Toggle navigation of runway.cfngin package
    - runway.cfngin.actions package
      Toggle navigation of runway.cfngin.actions package
    - runway.cfngin.blueprints package
      Toggle navigation of runway.cfngin.blueprints package
      - runway.cfngin.blueprints.variables package
        Toggle navigation of runway.cfngin.blueprints.variables package
        
        runway.cfngin.blueprints.variables.types module
      - runway.cfngin.blueprints.base module
      - runway.cfngin.blueprints.cfngin_bucket module
      - runway.cfngin.blueprints.raw module
      - runway.cfngin.blueprints.testutil module
      - runway.cfngin.blueprints.type_defs module
    - runway.cfngin.dag package
    - runway.cfngin.hooks package
      Toggle navigation of runway.cfngin.hooks package
      - runway.cfngin.hooks.awslambda package
        Toggle navigation of runway.cfngin.hooks.awslambda package
        
        runway.cfngin.hooks.awslambda.models package
        Toggle navigation of runway.cfngin.hooks.awslambda.models package
        
        runway.cfngin.hooks.awslambda.models.args module
        
        runway.cfngin.hooks.awslambda.models.responses module
        
        runway.cfngin.hooks.awslambda.python_requirements package
        
        runway.cfngin.hooks.awslambda.base_classes module
        
        runway.cfngin.hooks.awslambda.constants module
        
        runway.cfngin.hooks.awslambda.deployment_package module
        
        runway.cfngin.hooks.awslambda.docker module
        
        runway.cfngin.hooks.awslambda.exceptions module
        
        runway.cfngin.hooks.awslambda.source_code module
        
        runway.cfngin.hooks.awslambda.type_defs module
      - runway.cfngin.hooks.docker package
        Toggle navigation of runway.cfngin.hooks.docker package
        
        runway.cfngin.hooks.docker.image package
        
        runway.cfngin.hooks.docker.data_models module
        
        runway.cfngin.hooks.docker.hook_data module
      - runway.cfngin.hooks.ecr package
      - runway.cfngin.hooks.ssm package
        Toggle navigation of runway.cfngin.hooks.ssm package
        
        runway.cfngin.hooks.ssm.parameter module
      - runway.cfngin.hooks.staticsite package
        Toggle navigation of runway.cfngin.hooks.staticsite package
        
        runway.cfngin.hooks.staticsite.auth_at_edge package
        Toggle navigation of runway.cfngin.hooks.staticsite.auth_at_edge package
        
        runway.cfngin.hooks.staticsite.auth_at_edge.callback_url_retriever module
        
        runway.cfngin.hooks.staticsite.auth_at_edge.client_updater module
        
        runway.cfngin.hooks.staticsite.auth_at_edge.domain_updater module
        
        runway.cfngin.hooks.staticsite.auth_at_edge.lambda_config module
        
        runway.cfngin.hooks.staticsite.auth_at_edge.user_pool_id_retriever module
        
        runway.cfngin.hooks.staticsite.build_staticsite module
        
        runway.cfngin.hooks.staticsite.cleanup module
        
        runway.cfngin.hooks.staticsite.upload_staticsite module
        
        runway.cfngin.hooks.staticsite.utils module
      - runway.cfngin.hooks.acm module
      - runway.cfngin.hooks.aws_lambda module
      - runway.cfngin.hooks.base module
      - runway.cfngin.hooks.cleanup_s3 module
      - runway.cfngin.hooks.cleanup_ssm module
      - runway.cfngin.hooks.command module
      - runway.cfngin.hooks.ecs module
      - runway.cfngin.hooks.iam module
      - runway.cfngin.hooks.keypair module
      - runway.cfngin.hooks.protocols module
      - runway.cfngin.hooks.route53 module
      - runway.cfngin.hooks.utils module
    - runway.cfngin.logger package
    - runway.cfngin.lookups package
      Toggle navigation of runway.cfngin.lookups package
      - runway.cfngin.lookups.handlers package
        Toggle navigation of runway.cfngin.lookups.handlers package
        
        runway.cfngin.lookups.handlers.ami module
        
        runway.cfngin.lookups.handlers.awslambda module
        
        runway.cfngin.lookups.handlers.default module
        
        runway.cfngin.lookups.handlers.dynamodb module
        
        runway.cfngin.lookups.handlers.envvar module
        
        runway.cfngin.lookups.handlers.file module
        
        runway.cfngin.lookups.handlers.hook_data module
        
        runway.cfngin.lookups.handlers.kms module
        
        runway.cfngin.lookups.handlers.output module
        
        runway.cfngin.lookups.handlers.rxref module
        
        runway.cfngin.lookups.handlers.split module
        
        runway.cfngin.lookups.handlers.xref module
      - runway.cfngin.lookups.registry module
    - runway.cfngin.providers package
      Toggle navigation of runway.cfngin.providers package
      - runway.cfngin.providers.aws package
        Toggle navigation of runway.cfngin.providers.aws package
        
        runway.cfngin.providers.aws.default module
      - runway.cfngin.providers.base module
    - runway.cfngin.awscli_yamlhelper module
    - runway.cfngin.cfngin module
    - runway.cfngin.environment module
    - runway.cfngin.exceptions module
    - runway.cfngin.plan module
    - runway.cfngin.session_cache module
    - runway.cfngin.stack module
    - runway.cfngin.status module
    - runway.cfngin.tokenize_userdata module
    - runway.cfngin.ui module
    - runway.cfngin.utils module
  - runway.config package
    Toggle navigation of runway.config package
    - runway.config.components package
      Toggle navigation of runway.config.components package
      - runway.config.components.runway package
        Toggle navigation of runway.config.components.runway package
        
        runway.config.components.runway.base module
    - runway.config.models package
      Toggle navigation of runway.config.models package
      - runway.config.models.cfngin package
      - runway.config.models.runway package
        Toggle navigation of runway.config.models.runway package
        
        runway.config.models.runway.options package
        Toggle navigation of runway.config.models.runway.options package
        
        runway.config.models.runway.options.cdk module
        
        runway.config.models.runway.options.k8s module
        
        runway.config.models.runway.options.serverless module
        
        runway.config.models.runway.options.terraform module
      - runway.config.models.base module
      - runway.config.models.utils module
  - runway.context package
    Toggle navigation of runway.context package
    - runway.context.sys_info module
    - runway.context.type_defs module
  - runway.core package
    Toggle navigation of runway.core package
    - runway.core.components package
    - runway.core.providers package
      Toggle navigation of runway.core.providers package
      - runway.core.providers.aws package
        Toggle navigation of runway.core.providers.aws package
        
        runway.core.providers.aws.s3 package
        Toggle navigation of runway.core.providers.aws.s3 package
        
        runway.core.providers.aws.s3.exceptions module
        
        runway.core.providers.aws.type_defs module
    - runway.core.type_defs module
  - runway.dependency_managers package
    Toggle navigation of runway.dependency_managers package
    - runway.dependency_managers.base_classes module
  - runway.env_mgr package
    Toggle navigation of runway.env_mgr package
    - runway.env_mgr.kbenv module
    - runway.env_mgr.tfenv module
  - runway.lookups package
    Toggle navigation of runway.lookups package
    - runway.lookups.handlers package
      Toggle navigation of runway.lookups.handlers package
    - runway.lookups.registry module
  - runway.module package
    Toggle navigation of runway.module package
    - runway.module.staticsite package
      Toggle navigation of runway.module.staticsite package
    - runway.module.base module
    - runway.module.cdk module
    - runway.module.cloudformation module
    - runway.module.k8s module
    - runway.module.serverless module
    - runway.module.terraform module
    - runway.module.utils module
  - runway.sources package
    Toggle navigation of runway.sources package
    - runway.sources.git module
    - runway.sources.source module
  - runway.tests package
    Toggle navigation of runway.tests package
    - runway.tests.handlers package
      Toggle navigation of runway.tests.handlers package
    - runway.tests.registry module
  - runway.utils package
    Toggle navigation of runway.utils package
    - runway.utils.pydantic_validators package
  - runway.compat module
  - runway.constants module
  - runway.exceptions module
  - runway.mixins module
  - runway.s3_utils module
  - runway.type_defs module
  - runway.variables module
Advanced Configuration
Contribution Requirements
Custom Plugin Support
Getting Started

Maintainers Guide

Infrastructure
Maintenance Branchs
Release Process
Secrets

Additional Information

CHANGELOG
License
Terminology

Back to top

View this page

Toggle table of contents sidebar

runway.core.type_defs module¶

Type definitions.

Made with Furo