AWS ECR Orb

CircleCI orb for interacting with Amazon's Elastic Container Registry (ECR).

Parameters

Following is the full list of parameters required by this orb's various commands and jobs. For details, see the listing in the Orb Registry.

Parameter	Type	Default	Description
account-url	env_var_name	AWS_ECR_ACCOUNT_URL	name of env var storing your ECR account URL
aws-access-key-id	env_var_name	AWS_ACCESS_KEY_ID	name of env var storing your AWS Access Key ID
aws-secret-access-key	env_var_name	AWS_SECRET_ACCESS_KEY	name of env var storing your AWS Secret Access Key
create-repo	boolean	false	set this to true to create the repository if it does not already exist
repo-scan-on-push	boolean	true	set this to true to scan the created repository for CVEs on push
dockerfile	string	Dockerfile	name of Dockerfile to use
executor	executor	default	name of any custom executor (default is machine: true)
extra-build-args	string	""	Extra flags to pass to docker build (see docs.docker.com/engine/reference/commandline/build)
path	string	.	path to Dockerfile, defaults to the working directory
profile-name	string	default	AWS profile name
region	env_var_name	AWS_REGION	name of env var storing your AWS region
repo	string	N/A	name of your ECR repository
tag	string	latest	Comma-separated string of ECR image tags
return-sha-var	string	SHA256	set this to the variable you want returned with the image SHA
no-output-timeout	string	latest	The amount of time to allow the docker build command to run before timing out (default is 10m)

Usage

See below for both simple and complete examples of this orb's build_and_push_image job. For details, see the listing in the Orb Registry.

Simple

version: 2.1

orbs:
  aws-ecr: circleci/aws-ecr@x.y.z

workflows:
  simple_build_and_push:
    jobs:
      # with default parameter values, the following would be sufficient to build and push an image to ECR
      - aws-ecr/build-and-push-image:
          repo: myRepositoryName

Complete

version: 2.1

orbs:
  aws-ecr: circleci/aws-ecr@x.y.z

workflows:
  complete_build_and_push:
    jobs:
      # build and push image to ECR
      - aws-ecr/build-and-push-image:

          # required if any necessary secrets are stored via Contexts
          context: myContext

          # AWS profile name, defaults to "default"
          profile-name: myProfileName

          # name of env var storing your AWS Access Key ID, defaults to AWS_ACCESS_KEY_ID
          aws-access-key-id: ACCESS_KEY_ID_ENV_VAR_NAME

          # name of env var storing your AWS Secret Access Key, defaults to AWS_SECRET_ACCESS_KEY
          aws-secret-access-key: SECRET_ACCESS_KEY_ENV_VAR_NAME

          # name of env var storing your AWS region, defaults to AWS_REGION
          region: AWS_REGION_ENV_VAR_NAME

          # name of env var storing your ECR account URL, defaults to AWS_ECR_ACCOUNT_URL
          account-url: AWS_ECR_ACCOUNT_URL_ENV_VAR_NAME

          # name of your ECR repository
          repo: myECRRepository

          # set this to true to create the repository if it does not already exist, defaults to "false"
          create-repo: true

          # set this to true to scan the created repository for CVEs on push, defaults to "true"
          repo-scan-on-push: true

          # ECR image tags (comma-separated string), defaults to "latest"
          tag: latest,myECRRepoTag

          # The return variable desired for the container SHA (default is `SHA256`)
          return-sha-var: MYIMAGE

          # name of Dockerfile to use, defaults to "Dockerfile"
          dockerfile: myDockerfile

          # path to Dockerfile, defaults to . (working directory)
          path: pathToMyDockerfile

          # The amount of time to allow the docker build command to run before timing out (default is `10m`)
          no-output-timeout: 15m

Contributing

We welcome issues to and pull requests against this repository! For further questions/comments about this or other orbs, visit CircleCI's Orbs discussion forum.