Create ECR Repository with SAM to be used in Lambda Function with PackageType: Image

[vleandersson]

Describe your idea/feature/enhancement

When deploying Lambda Functions with SAM, using PackageType: Image I would like to define my ECR Repository in the same SAM template file

Proposal

It seems right now I am supposed to create my ECR repository separately, and then use the --image-repository flag on sam deploy (e.g. sam deploy --image-repository "123456789.dkr.ecr.us-east-1.amazonaws.com/my-repo"). This works fine, but it creates some deployment dependencies I would be keen to avoid.

To avoid this, I would propose to allow creating + deploying the ECR Repo with SAM, and then use the GetAtt function to attach the created repository URI to the function I intend to use this repository, e.g. ImageUri: !GetAtt MyECRRepository.RepositoryUri.

Note; I am actually not sure today how the ImageUri field is used on the lambda definition, as we are required to supply SAM with the --image-repository flag. I would personally be happy renaming this to EctRepositoryUri or similar to clarify the field usage.

So in my SAM template yaml file:

Resources:
  ###################################
  #          ECR Repositories
  ###################################
  MyECRRepository:
    Type: AWS::ECR::Repository
    Properties:
      RepositoryName: 'my-repository'

  ###################################
  #          LAMBDAS
  ###################################
  MyLambdaFunction:
    Type: AWS::Serverless::Function
    DependsOn:
      - MyECRRepository
    Properties:
      PackageType: Image

      # URI of the Amazon Elastic Container Registry (Amazon ECR) repository for the Lambda function's container image.
      ImageUri: !GetAtt MyECRRepository.RepositoryUri
    Metadata:
      Dockerfile: Dockerfile
      DockerContext: ./workspaces/myDockerContext
      DockerTag: my-own-tag

This would allow us to create repositories and images easier in SAM, while keeping deployments to different environments intact in one place.

Additional Details

Relates to #2447
@metaskills would be good to get your thoughts on this as well
@sriram-mv I believe you might have been adding some thoughts to this earlier
@stephenbawks added the following comment in the linked issue above
"The thing I was going to add here since I am little confused on the workflow. I was hoping to just create an ECR repository along with my Lambda but I do not see a way I can create that before it tries to upload the container when I do a deploy. So I guess I am just wondering with the way this works, do I need to have ECR created beforehand?"

[stephenbawks]

!GetAtt MyECRRepository.Arn will pull back the ECR arn

You can pass on the tag via parameter after you push up the image. Have to pull back the digest sha for it and then pass that into the sam build as a parameter.

The container build still has to happen before the sam build.

Still a chicken and egg since you have to have the ECR there before you can do anything.

[vleandersson]

@stephenbawks do you mean we got somewhere a dep on a lambda deploy to actually deploy ECR? Otherwise, it would be super neat if SAM could handle this race condition internally (with a dependsOn tag maybe?)

[sriram-mv]

Hey all There is RFC here at : #2675, please take a look!

@metaskills : ^

[metaskills]

Thanks, #2675 does not solve anything for me since it (and pull request #2815) focused solely on guided. Feels like a miss for me since we have no way to use --resolve-image-repos with sam package which AFAICT is what I have been asking for. I've been resorting to creating the ECR repo in the deploy scripts where build, package, and deploy are called.

[baggiponte]

Hi, sorry to necrobump. Let me see if I got this straight. Right now, if I have this template.yaml:

Resources:
  HelloWorldLambda:
    Type: AWS::Serverless::Function
    Properties:
      FunctionName: HelloWorldLambda
      PackageType: Image
      ImageUri: !Ref ECRRepository
      Events:
        HelloWorldApi:
          Type: Api
          Properties:
            Path: /hello
            Method: get

  ECRRepository:
    Type: AWS::ECR::Repository
    Properties:
      RepositoryName: hello-world-lambda

When I sam deploy I currently cannot tell it to push the image to the ECRRepository?