constants#

class aws_ops_alpha.constants.CommonEnvNameEnum(value)[source]#

Common environment name enumeration.

class aws_ops_alpha.constants.EnvVarNameEnum(value)[source]#

Common environment variable name enumeration.

Parameters:

  • 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”

  • 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.

  • 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.

  • 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.

  • 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.

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

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

  • 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

class aws_ops_alpha.constants.AwsTagNameEnum(value)[source]#

Common AWS resource tag name enumeration.

Parameters:

  • tech_project_name – project name for tech

  • tech_env_name – sbx, prd, etc …

  • tech_version – software semantic version, 0.1.2

  • tech_description – short description

  • tech_human_creator – usually a name or email

  • tech_machine_creator – usually a machine identifier

  • auto_active_time – cron expression that to keep the resource active

  • auto_delete_at – datetime that to delete the resource

  • bus_ou – business organization unit

  • bus_team – the team in your business organization

  • bus_project_name – project name for business

  • bus_owner – the owner of the resource, usually an email

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

  • sec_confidentiality – confidential level, public, secret, etc …

  • sec_compliance – HIPAA, PCI, etc …

class aws_ops_alpha.constants.AwsOpsSemanticBranchEnum(value)[source]#

Common Semantic branch name enumeration.

Parameters:

  • app – for arbitrary application deployment and integration test

  • lbd – AWS Lambda stuff

  • awslambda – AWS Lambda stuff

  • layer – AWS Lambda layer stuff

  • ecr – AWS Elastic Container Registry stuff, build and push container image

  • ami – Amazon Machine Image stuff, build and push VM image

  • glue – AWS Glue job

  • batch – AWS Batch

  • apigateway – AWS API Gateway

  • ecs – AWS Elastic Container Service, container application stuff

  • sfn – AWS StepFunction stuff

  • airflow – AWS managed airflow