:orphan: :py:mod:`aws_codeseeder._classes` ================================= .. py:module:: aws_codeseeder._classes Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: aws_codeseeder._classes.CodeSeederConfig aws_codeseeder._classes.EnvVar aws_codeseeder._classes.EnvVarType aws_codeseeder._classes.ModuleImporterEnum aws_codeseeder._classes.RegistryEntry aws_codeseeder._classes.SessionSingleton aws_codeseeder._classes.SingletonMeta Attributes ~~~~~~~~~~ .. autoapisummary:: aws_codeseeder._classes.ConfigureDecorator aws_codeseeder._classes.ConfigureFn aws_codeseeder._classes.RemoteFunctionDecorator aws_codeseeder._classes.RemoteFunctionFn .. py:class:: CodeSeederConfig Configuration dataclass :param timeout: Set the CodeBuild execution timeout, by default 30 :type timeout: Optional[int], optional :param python_modules: List of python modules to install during CodeBuild execution, by default None :type python_modules: Optional[List[str]], optional :param pythonpipx_modules: List of python modules that leverage CLI to install during CodeBuild execution, by default None :type pythonpipx_modules: Optional[List[str]], optional :param local_modules: Name and Location of local python modules to bundle and install during CodeBuild execution, by default None :type local_modules: Optional[Dict[str, str]], optional :param requirements_files: Local requirements.txt files to bundle and install during CodeBuild execution, by default None :type requirements_files: Optional[Dict[str, str]], optional :param codebuild_image: Alternative container image to use during CodeBuild execution, by default None :type codebuild_image: Optional[str], optional :param codebuild_role: Alternative IAM Role to use during CodeBuild execution, by default None :type codebuild_role: Optional[str], optional :param codebuild_environment_type: Alternative Environment to use for the CodeBuild execution (e.g. LINUX_CONTAINER), by default None :type codebuild_environment_type: Optional[str], optional :param codebuild_compute_type: Alternative Compute to use for the CodeBuild execution (e.g. BUILD_GENERAL1_SMALL), by default None :type codebuild_compute_type: Optional[str], optional :param npm_mirror: Global config for the npm mirror to use, by default None :type npm_mirror: Optional[str] :param pypi_mirror: Global config for the pypi mirror to use, by default None :type pypi_mirror: Optional[str] :param install_commands: Commands to execute during the Install phase of the CodeBuild execution, by default None :type install_commands: Optional[List[str]], optional :param pre_build_commands: Commands to execute during the PreBuild phase of the CodeBuild execution, by default None :type pre_build_commands: Optional[List[str]], optional :param pre_execution_commands: Commands to execute during the Build phase of the CodeBuild execution prior to calling the remote_function, by default None :type pre_execution_commands: Optional[List[str]], optional :param build_commands: Commands to execute during the Build phase of the CodeBuild execution after calling the remote_functin, by default None :type build_commands: Optional[List[str]], optional :param post_build_commands: Commands to execute during the PostBuild phase of the CodeBuild execution, by default None :type post_build_commands: Optional[List[str]], optional :param dirs: Name and Location of local directories to bundle and include in the CodeBuild exeuction,by default None :type dirs: Optional[Dict[str, str]], optional :param files: Name and Location of local files to bundle and include in the CodeBuild execution, by default None :type files: Optional[Dict[str, str]], optional :param env_vars: Environment variables to set in the CodeBuild execution, by default None :type env_vars: Optional[Dict[str, Union[str, EnvVar]]], optional :param exported_env_vars: Environment variables to export from the CodeBuild execution, by default None :type exported_env_vars: Optional[List[str], optional :param abort_phases_on_failure: Toggle aborting CodeBuild Phases when an execution failure occurs, by default True :type abort_phases_on_failure: bool :param runtime_versions: Runtime versions (e.g. python, nodejs) to install, by default ``{"python": "3.7", "nodejs": "12", "docker": "19"}`` :type runtime_versions: Optional[Dict[str, str]], optional :param prebuilt_bundle: Provide S3 path to a prebuild bundle to use to deploy :type prebuilt_bundle: Optional[str] .. py:attribute:: abort_phases_on_failure :type: bool :value: True .. py:attribute:: build_commands :type: Optional[List[str]] .. py:attribute:: codebuild_compute_type :type: Optional[str] .. py:attribute:: codebuild_environment_type :type: Optional[str] .. py:attribute:: codebuild_image :type: Optional[str] .. py:attribute:: codebuild_role :type: Optional[str] .. py:attribute:: dirs :type: Optional[Dict[str, str]] .. py:attribute:: env_vars :type: Optional[Dict[str, Union[str, EnvVar]]] .. py:attribute:: exported_env_vars :type: Optional[List[str]] .. py:attribute:: files :type: Optional[Dict[str, str]] .. py:attribute:: install_commands :type: Optional[List[str]] .. py:attribute:: local_modules :type: Optional[Dict[str, str]] .. py:attribute:: npm_mirror :type: Optional[str] .. py:attribute:: post_build_commands :type: Optional[List[str]] .. py:attribute:: pre_build_commands :type: Optional[List[str]] .. py:attribute:: pre_execution_commands :type: Optional[List[str]] .. py:attribute:: prebuilt_bundle :type: Optional[str] .. py:attribute:: pypi_mirror :type: Optional[str] .. py:attribute:: python_modules :type: Optional[List[str]] .. py:attribute:: pythonpipx_modules :type: Optional[List[str]] .. py:attribute:: requirements_files :type: Optional[Dict[str, str]] .. py:attribute:: runtime_versions :type: Optional[Dict[str, str]] .. py:attribute:: timeout :type: Optional[int] :value: 30 .. py:class:: 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. :param value: 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 value: string :param type: The type of environment variable: PLAINTEXT, PARAMETER_STORE, or SECRETS_MANAGER. See the AWS official documentation for usage, by default PLAINTEXT :type type: EnvVarType .. py:attribute:: type :type: EnvVarType .. py:attribute:: value :type: str .. py:class:: EnvVarType Bases: :py:obj:`str`, :py:obj:`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'. .. py:attribute:: PARAMETER_STORE :value: 'PARAMETER_STORE' .. py:attribute:: PLAINTEXT :value: 'PLAINTEXT' .. py:attribute:: SECRETS_MANAGER :value: 'SECRETS_MANAGER' .. py:class:: ModuleImporterEnum Bases: :py:obj:`str`, :py:obj:`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'. .. py:attribute:: CODESEEDER_CLI :value: 'codeseeder-cli' .. py:attribute:: OTHER :value: 'other' .. py:class:: RegistryEntry .. py:attribute:: config_function :type: Optional[ConfigureFn] .. py:attribute:: config_object :type: CodeSeederConfig .. py:attribute:: configured :type: bool :value: False .. py:attribute:: deploy_if_not_exists :type: bool :value: False .. py:attribute:: lock :type: threading.Lock .. py:attribute:: remote_functions :type: Dict[str, RemoteFunctionFn] .. py:attribute:: stack_outputs :type: Optional[Dict[str, str]] .. py:class:: SessionSingleton .. py:property:: value :type: Optional[boto3.Session] .. py:class:: SingletonMeta Bases: :py:obj:`type` This is a thread-safe implementation of Singleton. .. py:data:: ConfigureDecorator .. py:data:: ConfigureFn .. py:data:: RemoteFunctionDecorator .. py:data:: RemoteFunctionFn