runway.cfngin.hooks.awslambda package

Hooks for AWS Lambda.

class runway.cfngin.hooks.awslambda.PythonFunction

Bases: AwsLambdaHook[PythonProject]

Hook for creating an AWS Lambda Function using Python runtime.

BUILD_LAYER: ClassVar[bool] = False

Flag to denote that this hook creates a Lambda Function deployment package.

__init__(context: runway.context.CfnginContext, **kwargs: Any) → None

Instantiate class.

args: PythonHookArgs

Parsed hook arguments.

cleanup() → None

Cleanup after execution.

cleanup_on_error() → None

Cleanup after an error has occurred.

property deployment_package: DeploymentPackage[PythonProject]

AWS Lambda deployment package.

pre_deploy() → Any

Run during the pre_deploy stage.

property project: PythonProject

Project being deployed as an AWS Lambda Function.

class runway.cfngin.hooks.awslambda.PythonLayer

Bases: PythonFunction

Hook for creating an AWS Lambda Layer using Python runtime.

BUILD_LAYER: ClassVar[bool] = True

Flag to denote that this hook creates a Lambda Layer deployment package.

Subpackages

• runway.cfngin.hooks.awslambda.models package
  • Submodules
    • runway.cfngin.hooks.awslambda.models.args module
      • AwsLambdaHookArgs
      • DockerOptions
      • PythonHookArgs
    • runway.cfngin.hooks.awslambda.models.responses module
      • AwsLambdaHookDeployResponse
• runway.cfngin.hooks.awslambda.python_requirements package
  • PythonDeploymentPackage
    • PythonDeploymentPackage.gitignore_filter
    • PythonDeploymentPackage.insert_layer_dir()
    • PythonDeploymentPackage.project
  • PythonDockerDependencyInstaller
    • PythonDockerDependencyInstaller.__init__()
    • PythonDockerDependencyInstaller.bind_mounts
    • PythonDockerDependencyInstaller.environment_variables
    • PythonDockerDependencyInstaller.install_commands
    • PythonDockerDependencyInstaller.python_version
    • PythonDockerDependencyInstaller.runtime
  • PythonProject
    • PythonProject.DEFAULT_CACHE_DIR_NAME
    • PythonProject.cleanup()
    • PythonProject.docker
    • PythonProject.install_dependencies()
    • PythonProject.metadata_files
    • PythonProject.pip
    • PythonProject.pipenv
    • PythonProject.poetry
    • PythonProject.project_type
    • PythonProject.requirements_txt
    • PythonProject.runtime
    • PythonProject.supported_metadata_files
    • PythonProject.tmp_requirements_txt

Submodules

• runway.cfngin.hooks.awslambda.base_classes module
  • AwsLambdaHook
    • AwsLambdaHook.BUILD_LAYER
    • AwsLambdaHook.__init__()
    • AwsLambdaHook.build_response()
    • AwsLambdaHook.cleanup()
    • AwsLambdaHook.cleanup_on_error()
    • AwsLambdaHook.ctx
    • AwsLambdaHook.deployment_package
    • AwsLambdaHook.plan()
    • AwsLambdaHook.post_deploy()
    • AwsLambdaHook.post_destroy()
    • AwsLambdaHook.pre_deploy()
    • AwsLambdaHook.pre_destroy()
    • AwsLambdaHook.project
  • Project
    • Project.DEFAULT_CACHE_DIR_NAME
    • Project.__init__()
    • Project.args
    • Project.build_directory
    • Project.cache_dir
    • Project.cleanup()
    • Project.cleanup_on_error()
    • Project.compatible_architectures
    • Project.compatible_runtimes
    • Project.ctx
    • Project.dependency_directory
    • Project.install_dependencies()
    • Project.license
    • Project.metadata_files
    • Project.project_root
    • Project.project_type
    • Project.runtime
    • Project.source_code
    • Project.supported_metadata_files
• runway.cfngin.hooks.awslambda.constants module
  • AWS_SAM_BUILD_IMAGE_PREFIX
  • DEFAULT_IMAGE_NAME
  • DEFAULT_IMAGE_TAG
• runway.cfngin.hooks.awslambda.deployment_package module
  • DeploymentPackage
    • DeploymentPackage.META_TAGS
    • DeploymentPackage.SIZE_EOCD
    • DeploymentPackage.ZIPFILE_PERMISSION_MASK
    • DeploymentPackage.__init__()
    • DeploymentPackage.archive_file
    • DeploymentPackage.bucket
    • DeploymentPackage.build()
    • DeploymentPackage.build_tag_set()
    • DeploymentPackage.code_sha256
    • DeploymentPackage.compatible_architectures
    • DeploymentPackage.compatible_runtimes
    • DeploymentPackage.delete()
    • DeploymentPackage.exists
    • DeploymentPackage.gitignore_filter
    • DeploymentPackage.init()
    • DeploymentPackage.insert_layer_dir()
    • DeploymentPackage.iterate_dependency_directory()
    • DeploymentPackage.license
    • DeploymentPackage.md5_checksum
    • DeploymentPackage.object_key
    • DeploymentPackage.object_version_id
    • DeploymentPackage.project
    • DeploymentPackage.runtime
    • DeploymentPackage.upload()
    • DeploymentPackage.usage_type
  • DeploymentPackageS3Object
    • DeploymentPackageS3Object.project
    • DeploymentPackageS3Object.build()
    • DeploymentPackageS3Object.code_sha256
    • DeploymentPackageS3Object.compatible_architectures
    • DeploymentPackageS3Object.compatible_runtimes
    • DeploymentPackageS3Object.delete()
    • DeploymentPackageS3Object.exists
    • DeploymentPackageS3Object.head
    • DeploymentPackageS3Object.license
    • DeploymentPackageS3Object.md5_checksum
    • DeploymentPackageS3Object.object_tags
    • DeploymentPackageS3Object.object_version_id
    • DeploymentPackageS3Object.runtime
    • DeploymentPackageS3Object.update_tags()
    • DeploymentPackageS3Object.upload()
• runway.cfngin.hooks.awslambda.docker module
  • DockerDependencyInstaller
    • DockerDependencyInstaller.CACHE_DIR
    • DockerDependencyInstaller.DEPENDENCY_DIR
    • DockerDependencyInstaller.PROJECT_DIR
    • DockerDependencyInstaller.__init__()
    • DockerDependencyInstaller.bind_mounts
    • DockerDependencyInstaller.build_image()
    • DockerDependencyInstaller.client
    • DockerDependencyInstaller.ctx
    • DockerDependencyInstaller.environment_variables
    • DockerDependencyInstaller.from_project()
    • DockerDependencyInstaller.image
    • DockerDependencyInstaller.install()
    • DockerDependencyInstaller.install_commands
    • DockerDependencyInstaller.log_docker_msg_bytes()
    • DockerDependencyInstaller.log_docker_msg_dict()
    • DockerDependencyInstaller.options
    • DockerDependencyInstaller.post_install_commands
    • DockerDependencyInstaller.pre_install_commands
    • DockerDependencyInstaller.pull_image()
    • DockerDependencyInstaller.run_command()
    • DockerDependencyInstaller.runtime
• runway.cfngin.hooks.awslambda.exceptions module
  • DeploymentPackageEmptyError
    • DeploymentPackageEmptyError.__init__()
    • DeploymentPackageEmptyError.archive_file
  • RuntimeMismatchError
    • RuntimeMismatchError.__init__()
    • RuntimeMismatchError.detected_runtime
    • RuntimeMismatchError.expected_runtime
• runway.cfngin.hooks.awslambda.source_code module
  • SourceCode
    • SourceCode.__eq__()
    • SourceCode.__fspath__()
    • SourceCode.__init__()
    • SourceCode.__iter__()
    • SourceCode.__str__()
    • SourceCode.__truediv__()
    • SourceCode.add_filter_rule()
    • SourceCode.gitignore_filter
    • SourceCode.md5_hash
    • SourceCode.project_root
    • SourceCode.root_directory
    • SourceCode.sorted()
• runway.cfngin.hooks.awslambda.type_defs module
  • AwsLambdaHookDeployResponseTypedDict