Skip to content

Create Pull Through Cache Rule

ecr_create_pull_through_cache_rule R Documentation

Creates a pull through cache rule

Description

Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry source in your Amazon ECR private registry. For more information, see Using pull through cache rules in the Amazon Elastic Container Registry User Guide.

Usage

ecr_create_pull_through_cache_rule(ecrRepositoryPrefix,
  upstreamRegistryUrl, registryId, upstreamRegistry, credentialArn,
  customRoleArn, upstreamRepositoryPrefix)

Arguments

ecrRepositoryPrefix

[required] The repository name prefix to use when caching images from the source registry.

There is always an assumed / applied to the end of the prefix. If you specify ecr-public as the prefix, Amazon ECR treats that as ⁠ecr-public/⁠.
upstreamRegistryUrl

[required] The registry URL of the upstream public registry to use as the source for the pull through cache rule. The following is the syntax to use for each supported upstream registry.

  • Amazon ECR (ecr) – ⁠dkr.ecr.<region>.amazonaws.com⁠

  • Amazon ECR Public (ecr-public) – public.ecr.aws

  • Docker Hub (docker-hub) – ⁠registry-1.docker.io⁠

  • GitHub Container Registry (github-container-registry) – ghcr.io

  • GitLab Container Registry (gitlab-container-registry) – registry.gitlab.com

  • Kubernetes (k8s) – registry.k8s.io

  • Microsoft Azure Container Registry (azure-container-registry) – ⁠<custom>.azurecr.io⁠

  • Quay (quay) – quay.io
registryId

The Amazon Web Services account ID associated with the registry to create the pull through cache rule for. If you do not specify a registry, the default registry is assumed.
upstreamRegistry

The name of the upstream registry.
credentialArn

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.
customRoleArn

Amazon Resource Name (ARN) of the IAM role to be assumed by Amazon ECR to authenticate to the ECR upstream registry. This role must be in the same account as the registry that you are configuring.
upstreamRepositoryPrefix

The repository name prefix of the upstream registry to match with the upstream repository name. When this field isn't specified, Amazon ECR will use the ROOT.

Value

A list with the following syntax:

list(
  ecrRepositoryPrefix = "string",
  upstreamRegistryUrl = "string",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  registryId = "string",
  upstreamRegistry = "ecr"|"ecr-public"|"quay"|"k8s"|"docker-hub"|"github-container-registry"|"azure-container-registry"|"gitlab-container-registry",
  credentialArn = "string",
  customRoleArn = "string",
  upstreamRepositoryPrefix = "string"
)

Request syntax

svc$create_pull_through_cache_rule(
  ecrRepositoryPrefix = "string",
  upstreamRegistryUrl = "string",
  registryId = "string",
  upstreamRegistry = "ecr"|"ecr-public"|"quay"|"k8s"|"docker-hub"|"github-container-registry"|"azure-container-registry"|"gitlab-container-registry",
  credentialArn = "string",
  customRoleArn = "string",
  upstreamRepositoryPrefix = "string"
)