aws_codeseeder._classes

Module Contents

Classes

CodeSeederConfig	Configuration dataclass
EnvVar	EnvVar dataclass
EnvVarType	str(object='') -> str
ModuleImporterEnum	str(object='') -> str
RegistryEntry
SessionSingleton
SingletonMeta	This is a thread-safe implementation of Singleton.

Attributes

ConfigureDecorator
ConfigureFn
RemoteFunctionDecorator
RemoteFunctionFn

class aws_codeseeder._classes.CodeSeederConfig

Configuration dataclass

Parameters

• timeout (Optional[int], optional) – Set the CodeBuild execution timeout, by default 30

• python_modules (Optional[List[str]], optional) – List of python modules to install during CodeBuild execution, by default None

• pythonpipx_modules (Optional[List[str]], optional) – List of python modules that leverage CLI to install during CodeBuild execution, by default None

• local_modules (Optional[Dict[str, str]], optional) – Name and Location of local python modules to bundle and install during CodeBuild execution, by default None

• requirements_files (Optional[Dict[str, str]], optional) – Local requirements.txt files to bundle and install during CodeBuild execution, by default None

• codebuild_image (Optional[str], optional) – Alternative container image to use during CodeBuild execution, by default None

• codebuild_role (Optional[str], optional) – Alternative IAM Role to use during CodeBuild execution, by default None

• codebuild_environment_type (Optional[str], optional) – Alternative Environment to use for the CodeBuild execution (e.g. LINUX_CONTAINER), by default None

• codebuild_compute_type (Optional[str], optional) – Alternative Compute to use for the CodeBuild execution (e.g. BUILD_GENERAL1_SMALL), by default None

• npm_mirror (Optional[str]) – Global config for the npm mirror to use, by default None

• pypi_mirror (Optional[str]) – Global config for the pypi mirror to use, by default None

• install_commands (Optional[List[str]], optional) – Commands to execute during the Install phase of the CodeBuild execution, by default None

• pre_build_commands (Optional[List[str]], optional) – Commands to execute during the PreBuild phase of the CodeBuild execution, by default None

• pre_execution_commands (Optional[List[str]], optional) – Commands to execute during the Build phase of the CodeBuild execution prior to calling the remote_function, by default None

• build_commands (Optional[List[str]], optional) – Commands to execute during the Build phase of the CodeBuild execution after calling the remote_functin, by default None

• post_build_commands (Optional[List[str]], optional) – Commands to execute during the PostBuild phase of the CodeBuild execution, by default None

• dirs (Optional[Dict[str, str]], optional) – Name and Location of local directories to bundle and include in the CodeBuild exeuction,by default None

• files (Optional[Dict[str, str]], optional) – Name and Location of local files to bundle and include in the CodeBuild execution, by default None

• env_vars (Optional[Dict[str, Union[str, EnvVar]]], optional) – Environment variables to set in the CodeBuild execution, by default None

• exported_env_vars (Optional[List[str], optional) – Environment variables to export from the CodeBuild execution, by default None

• abort_phases_on_failure (bool) – Toggle aborting CodeBuild Phases when an execution failure occurs, by default True

• runtime_versions (Optional[Dict[str, str]], optional) – Runtime versions (e.g. python, nodejs) to install, by default {"python": "3.7", "nodejs": "12", "docker": "19"}

• prebuilt_bundle (Optional[str]) – Provide S3 path to a prebuild bundle to use to deploy

abort_phases_on_failure: bool = True

build_commands: Optional[List[str]]

codebuild_compute_type: Optional[str]

codebuild_environment_type: Optional[str]

codebuild_image: Optional[str]

codebuild_role: Optional[str]

dirs: Optional[Dict[str, str]]

env_vars: Optional[Dict[str, Union[str, EnvVar]]]

exported_env_vars: Optional[List[str]]

files: Optional[Dict[str, str]]

install_commands: Optional[List[str]]

local_modules: Optional[Dict[str, str]]

npm_mirror: Optional[str]

post_build_commands: Optional[List[str]]

pre_build_commands: Optional[List[str]]

pre_execution_commands: Optional[List[str]]

prebuilt_bundle: Optional[str]

pypi_mirror: Optional[str]

python_modules: Optional[List[str]]

pythonpipx_modules: Optional[List[str]]

requirements_files: Optional[Dict[str, str]]

runtime_versions: Optional[Dict[str, str]]

timeout: Optional[int] = 30

class aws_codeseeder._classes.EnvVar

EnvVar dataclass

This class is used to define environment variables made available inside of CodeBuild. Use of this class enables delcaration of all environment variable types that CodeBuild supports.

Parameters

• value (string) – The value for the environment variable. The effect of this value varies depending on the type of environment variable created. See the AWS official documention for usage information: https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.variables https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager

• type (EnvVarType) – The type of environment variable: PLAINTEXT, PARAMETER_STORE, or SECRETS_MANAGER. See the AWS official documentation for usage, by default PLAINTEXT

type: EnvVarType

value: str

class aws_codeseeder._classes.EnvVarType

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

PARAMETER_STORE = 'PARAMETER_STORE'

PLAINTEXT = 'PLAINTEXT'

SECRETS_MANAGER = 'SECRETS_MANAGER'

class aws_codeseeder._classes.ModuleImporterEnum

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

CODESEEDER_CLI = 'codeseeder-cli'

OTHER = 'other'

class aws_codeseeder._classes.RegistryEntry

config_function: Optional[ConfigureFn]

config_object: CodeSeederConfig

configured: bool = False

deploy_if_not_exists: bool = False

lock: threading.Lock

remote_functions: Dict[str, RemoteFunctionFn]

stack_outputs: Optional[Dict[str, str]]

class aws_codeseeder._classes.SessionSingleton

property value: Optional[boto3.Session]

class aws_codeseeder._classes.SingletonMeta

Bases: type

This is a thread-safe implementation of Singleton.

aws_codeseeder._classes.ConfigureDecorator

aws_codeseeder._classes.ConfigureFn

aws_codeseeder._classes.RemoteFunctionDecorator

aws_codeseeder._classes.RemoteFunctionFn