EcrConfig

Bases: BaseModel, NameValidationMixin

Configuration model for AWS ECR repository creation.

Defines the structure and validation rules for creating ECR repositories, with support for KMS encryption, image retention policies, and cross-account sharing.

Attributes:

Name	Type	Description
use_kms_key	bool	Enable KMS encryption for container image security
images_retained	Optional[int]	Maximum number of images to keep with automatic cleanup
shareable_with_all_envs	bool	Enable cross-account repository access patterns
ecr_repo_base_name	str	Base identifier for the repository following naming conventions

Source code in mare_aws_common_lib/models/ecr_config.py

class EcrConfig(BaseModel, NameValidationMixin):
    """Configuration model for AWS ECR repository creation.

    Defines the structure and validation rules for creating ECR repositories,
    with support for KMS encryption, image retention policies, and cross-account sharing.

    Attributes:
        use_kms_key: Enable KMS encryption for container image security
        images_retained: Maximum number of images to keep with automatic cleanup
        shareable_with_all_envs: Enable cross-account repository access patterns
        ecr_repo_base_name: Base identifier for the repository following naming conventions
    """

    model_config = ConfigDict(extra="forbid")

    use_kms_key: bool = Field(False, description="Whether to create and use a KMS key for ECR encryption")
    images_retained: Optional[int] = Field(
        default=None, ge=1, 
        le=1000,  # AWS ECR lifecycle policy limits
        description="Maximum number of images to retain (creates lifecycle policy if set)"
    )
    shareable_with_all_envs: bool = Field(default=False, description="Whether to create cross-account policies for all environments")
    ecr_repo_base_name: str = Field(...,min_length=1, description="Base name for the ECR repository")

    @field_validator('ecr_repo_base_name')
    @classmethod
    def validate_ecr_repo_name(cls, value: str) -> str:
        """Validate the ECR repo base name.

        Applies validation rules to ecr repo naming to ensure the 
        name meets AWS requirements and organizational standards.

        Args:
            value: Raw ecr repo base name from configuration

        Returns:
            Validated ecr repo base name

        Raises:
            ValueError: If the ecr repo name fails validation rules
        """
        return cls.validate_name(value)

validate_ecr_repo_name(value) classmethod

Validate the ECR repo base name.

Applies validation rules to ecr repo naming to ensure the name meets AWS requirements and organizational standards.

Parameters:

Name	Type	Description	Default
value	str	Raw ecr repo base name from configuration	required

Returns:

Type	Description
str	Validated ecr repo base name

Raises:

Type	Description
ValueError	If the ecr repo name fails validation rules

Source code in mare_aws_common_lib/models/ecr_config.py

@field_validator('ecr_repo_base_name')
@classmethod
def validate_ecr_repo_name(cls, value: str) -> str:
    """Validate the ECR repo base name.

    Applies validation rules to ecr repo naming to ensure the 
    name meets AWS requirements and organizational standards.

    Args:
        value: Raw ecr repo base name from configuration

    Returns:
        Validated ecr repo base name

    Raises:
        ValueError: If the ecr repo name fails validation rules
    """
    return cls.validate_name(value)

Example

from mare_aws_common_lib.models import EcrConfig

config = EcrConfig(
    ecr_repo_base_name="my-ecr",
    use_kms_key=True,
    images_retained=20,
    shareable_with_all_envs=True
)