constants

aws_config.constants.ZFILL = 6

Can support up to 999999 versions.

class aws_config.constants.S3MetadataKeyEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Enumerate the keys of AWS tags used in the project.

class aws_config.constants.AwsTagKeyEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Common AWS resource tag name enumeration.

After_param tech_project_name:

project name for tech

After_param tech_env_name:

sbx, prd, etc …

After_param tech_version:

software semantic version, 0.1.2

After_param tech_description:

short description

After_param tech_human_creator:

usually a name or email

After_param tech_machine_creator:

usually a machine identifier

After_param auto_active_time:

cron expression that to keep the resource active

After_param auto_delete_at:

datetime that to delete the resource

After_param bus_ou:

business organization unit

After_param bus_team:

the team in your business organization

After_param bus_project_name:

project name for business

After_param bus_owner:

the owner of the resource, usually an email

After_param bus_user:

who is using the resource, usually an email or a team name

After_param sec_confidentiality:

confidential level, public, secret, etc …

After_param sec_compliance:

HIPAA, PCI, etc …

aws_config.constants.ALL = 'all'

Special environment name to indicate all environment configs.

aws_config.constants.DATA = 'data'

dictionary key for config data

aws_config.constants.SECRET_DATA = 'secret_data'

dictionary key for config secret data

class aws_config.constants.EnvVarNameEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Common environment variable name enumeration.

After_param USER_ENV_NAME:

store the current environment name, e.g. “devops”, “sbx”, “tst”, “stg”, “prd”, etc. this environment variable has higher priority than the “ENV_NAME”

After_param USER_RUNTIME_NAME:

store the name of the current runtime, usually you should not use this environment variable directly, instead let the runtime module to detect that automatically. This var is useful when you want to override the runtime name for testing.

After_param USER_GIT_BRANCH_NAME:

store the name of the current git branch, usually you should not use this environment variable directly, instead let the git module to detect that automatically. This var is useful when you want to override the git branch name for testing.

After_param USER_GIT_COMMIT_ID:

store the name of the current git commit id, usually you should not use this environment variable directly, instead let the git module to detect that automatically. This var is useful when you want to override the git branch name for testing.

After_param USER_GIT_COMMIT_MESSAGE:

store the name of the current git commit message, usually you should not use this environment variable directly, instead let the git module to detect that automatically. This var is useful when you want to override the git branch name for testing.

After_param ENV_NAME:

store the current environment name. if the USER_ENV_NAME is set, use USER_ENV_NAME, otherwise, use this one.

After_param PROJECT_NAME:

store the name of the current project, the project name is part of the AWS resource naming convention

After_param PARAMETER_NAME:

store the name of AWS parameter for the configuration this environment variable is used in application runtime to get the configuration data from AWS parameter store