template_python_library package

Submodules

template_python_library.app module

Module contents

class ssm_parameter_config.SSMConfig(*, _env_file: Optional[DotenvType] = '<object object>', _env_file_encoding: Optional[str] = None, _env_nested_delimiter: Optional[str] = None, _secrets_dir: Optional[StrPath] = None, _local_ssm_path: Optional[StrPath] = None, _aws_ssm_path: Optional[str] = None, ssm_parameter: Optional[ssm_parameter_config.ssm_parameter.SSMParameter] = None)

Bases: pydantic.env_settings.BaseSettings

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

class Config

Bases: object

classmethod customise_sources(init_settings: Callable[[pydantic.env_settings.BaseSettings], Dict[str, Any]], env_settings: Callable[[pydantic.env_settings.BaseSettings], Dict[str, Any]], file_secret_settings: Callable[[pydantic.env_settings.BaseSettings], Dict[str, Any]])

export(exp_format='yaml', exclude_ssm=True, ssm_format=False, **dump_kwargs)

classmethod from_file(file: Union[str, os.PathLike, pathlib.PurePath]) → ssm_parameter_config.ssm_config.SSMConfig

classmethod from_object(obj: dict[str, Any])

classmethod from_parameter(parameter: ssm_parameter_config.ssm_parameter.SSMParameter) → ssm_parameter_config.ssm_config.SSMConfig

ssm_parameter: Optional[ssm_parameter_config.ssm_parameter.SSMParameter]

to_parameter(exp_format='yaml', ssm_parameter_path: Optional[str] = None, ignore_current: bool = False)

write_config(exp_format='yaml', ssm_parameter_path=None, local_path=None, as_cli_input: bool = False)

class ssm_parameter_config.SSMParameter(*, Name: str, Description: Optional[str] = None, Value: Optional[str] = None, Type: ssm_parameter_config.ssm_parameter.SSMType = SSMType.string, KeyId: Optional[str] = None, AllowedPattern: Optional[str] = None, Version: Optional[int] = None, LastModifiedDate: Optional[datetime.datetime] = None, Tier: ssm_parameter_config.ssm_parameter.SSMTier = SSMTier.standard, DataType: ssm_parameter_config.ssm_parameter.SSMDataType = SSMDataType.text, Tags: list[ssm_parameter_config.ssm_parameter.Tag] = [])

Bases: ssm_parameter_config.ssm_parameter.SSMPath

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

class Config

Bases: object

alias_generator() → unicode

exclude_none = True

allowed_pattern: Optional[str]

as_ssm_config() → SSMConfig

data_type: ssm_parameter_config.ssm_parameter.SSMDataType

property decoded_value

description: Optional[str]

classmethod get_parameter(name: str, default_value: str = '')

static get_parameter_value(val)

is_dir()

key_id: Optional[str]

last_modified_date: Optional[datetime.datetime]

lazy_dict()

put_parameter(new_value=None, as_cli_input: bool = False)

tags: list[ssm_parameter_config.ssm_parameter.Tag]

tier: ssm_parameter_config.ssm_parameter.SSMTier

type: ssm_parameter_config.ssm_parameter.SSMType

value: Optional[str]

version: Optional[int]

class ssm_parameter_config.SSMPath(*, name: str)

Bases: pydantic.main.BaseModel

kind of like a pathlib path, but not quite

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

fetch_parameters(path)

is_dir()

is_file()

iterdir() → Iterator[ssm_parameter_config.ssm_parameter.SSMPath]

name: str

property path

set_aws_client_kwargs(**kwargs)

property ssm_client