runway.module package

Classes and utilities for working with each Runway module type.

Subpackages

• runway.module.staticsite package
  • StaticSite
    • StaticSite.__init__()
    • StaticSite.deploy()
    • StaticSite.destroy()
    • StaticSite.init()
    • StaticSite.plan()
    • StaticSite.sanitized_name
  • Subpackages
    • runway.module.staticsite.options package
      • RunwayStaticSiteExtraFileDataModel
      • RunwayStaticSiteModuleOptionsDataModel
      • RunwayStaticSitePreBuildStepDataModel
      • RunwayStaticSiteSourceHashingDataModel
      • RunwayStaticSiteSourceHashingDirectoryDataModel
      • StaticSiteOptions
    • runway.module.staticsite.parameters package
      • RunwayStaticSiteCustomErrorResponseDataModel
      • RunwayStaticSiteLambdaFunctionAssociationDataModel
      • RunwayStaticSiteModuleParametersDataModel
  • Submodules
    • runway.module.staticsite.handler module
      • StaticSite
    • runway.module.staticsite.utils module
      • add_url_scheme()

Submodules

• runway.module.base module
  • ModuleOptions
    • ModuleOptions.__eq__()
    • ModuleOptions.get()
  • RunwayModule
    • RunwayModule.__getitem__()
    • RunwayModule.__init__()
    • RunwayModule.deploy()
    • RunwayModule.destroy()
    • RunwayModule.init()
    • RunwayModule.plan()
  • RunwayModuleNpm
    • RunwayModuleNpm.__init__()
    • RunwayModuleNpm.check_for_npm()
    • RunwayModuleNpm.log_npm_command()
    • RunwayModuleNpm.npm_install()
    • RunwayModuleNpm.package_json_missing()
    • RunwayModuleNpm.warn_on_boto_env_vars()
• runway.module.cdk module
  • CloudDevelopmentKit
    • CloudDevelopmentKit.__init__()
    • CloudDevelopmentKit.cdk_bootstrap()
    • CloudDevelopmentKit.cdk_deploy()
    • CloudDevelopmentKit.cdk_destroy()
    • CloudDevelopmentKit.cdk_diff()
    • CloudDevelopmentKit.cdk_list()
    • CloudDevelopmentKit.cli_args
    • CloudDevelopmentKit.cli_args_context
    • CloudDevelopmentKit.deploy()
    • CloudDevelopmentKit.destroy()
    • CloudDevelopmentKit.gen_cmd()
    • CloudDevelopmentKit.init()
    • CloudDevelopmentKit.plan()
    • CloudDevelopmentKit.run_build_steps()
    • CloudDevelopmentKit.skip
  • CloudDevelopmentKitOptions
    • CloudDevelopmentKitOptions.build_steps
    • CloudDevelopmentKitOptions.data
    • CloudDevelopmentKitOptions.skip_npm_ci
    • CloudDevelopmentKitOptions.__init__()
    • CloudDevelopmentKitOptions.parse_obj()
• runway.module.cloudformation module
  • CloudFormation
    • CloudFormation.__init__()
    • CloudFormation.deploy()
    • CloudFormation.destroy()
    • CloudFormation.init()
    • CloudFormation.plan()
• runway.module.k8s module
  • K8s
    • K8s.__init__()
    • K8s.deploy()
    • K8s.destroy()
    • K8s.gen_cmd()
    • K8s.init()
    • K8s.kbenv
    • K8s.kubectl_apply()
    • K8s.kubectl_bin
    • K8s.kubectl_delete()
    • K8s.kubectl_kustomize()
    • K8s.plan()
    • K8s.skip
  • K8sOptions
    • K8sOptions.data
    • K8sOptions.deploy_environment
    • K8sOptions.kubectl_version
    • K8sOptions.path
    • K8sOptions.__init__()
    • K8sOptions.gen_overlay_dirs()
    • K8sOptions.get_overlay_dir()
    • K8sOptions.kustomize_config
    • K8sOptions.overlay_path
    • K8sOptions.parse_obj()
• runway.module.serverless module
  • Serverless
    • Serverless.__init__()
    • Serverless.cli_args
    • Serverless.deploy()
    • Serverless.destroy()
    • Serverless.env_file
    • Serverless.extend_serverless_yml()
    • Serverless.gen_cmd()
    • Serverless.init()
    • Serverless.plan()
    • Serverless.skip
    • Serverless.sls_deploy()
    • Serverless.sls_package()
    • Serverless.sls_print()
    • Serverless.sls_remove()
  • ServerlessArtifact
    • ServerlessArtifact.__init__()
    • ServerlessArtifact.source_hash
    • ServerlessArtifact.sync_with_s3()
  • ServerlessOptions
    • ServerlessOptions.data
    • ServerlessOptions.extend_serverless_yml
    • ServerlessOptions.promotezip
    • ServerlessOptions.skip_npm_ci
    • ServerlessOptions.__init__()
    • ServerlessOptions.args
    • ServerlessOptions.parse_obj()
    • ServerlessOptions.update_args()
  • gen_sls_config_files()
• runway.module.terraform module
  • Terraform
    • Terraform.__init__()
    • Terraform.auto_tfvars
    • Terraform.cleanup_dot_terraform()
    • Terraform.current_workspace
    • Terraform.deploy()
    • Terraform.destroy()
    • Terraform.env_file
    • Terraform.gen_command()
    • Terraform.handle_backend()
    • Terraform.handle_parameters()
    • Terraform.init()
    • Terraform.plan()
    • Terraform.run()
    • Terraform.skip
    • Terraform.terraform_apply()
    • Terraform.terraform_destroy()
    • Terraform.terraform_get()
    • Terraform.terraform_init()
    • Terraform.terraform_plan()
    • Terraform.terraform_workspace_list()
    • Terraform.terraform_workspace_new()
    • Terraform.terraform_workspace_select()
    • Terraform.terraform_workspace_show()
    • Terraform.tf_bin
    • Terraform.tfenv
    • Terraform.version
  • TerraformBackendConfig
    • TerraformBackendConfig.__init__()
    • TerraformBackendConfig.config_file
    • TerraformBackendConfig.gen_backend_filenames()
    • TerraformBackendConfig.get_backend_file()
    • TerraformBackendConfig.get_full_configuration()
    • TerraformBackendConfig.init_args
    • TerraformBackendConfig.parse_obj()
  • TerraformOptions
    • TerraformOptions.args
    • TerraformOptions.data
    • TerraformOptions.env
    • TerraformOptions.path
    • TerraformOptions.version
    • TerraformOptions.write_auto_tfvars
    • TerraformOptions.__init__()
    • TerraformOptions.backend_config
    • TerraformOptions.parse_obj()
  • gen_workspace_tfvars_files()
  • update_env_vars_with_tf_var_values()
• runway.module.utils module
  • format_npm_command_for_logging()
  • generate_node_command()
  • run_module_command()
  • use_npm_ci()