Skip to content

/AWS1/CL_ECR=>CREATEPULLTHROUGHCACHERULE()

About CreatePullThroughCacheRule

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.

Method Signature

IMPORTING

Required arguments:

IV_ECRREPOSITORYPREFIX TYPE /AWS1/ECRPULLTHRUCACHERLREPO00 /AWS1/ECRPULLTHRUCACHERLREPO00

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

IV_UPSTREAMREGISTRYURL TYPE /AWS1/ECRURL /AWS1/ECRURL

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 Public (ecr-public) - public.ecr.aws

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

  • Quay (quay) - quay.io

  • Kubernetes (k8s) - registry.k8s.io

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

  • Microsoft Azure Container Registry (azure-container-registry) - .azurecr.io

Optional arguments:

IV_REGISTRYID TYPE /AWS1/ECRREGISTRYID /AWS1/ECRREGISTRYID

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.

IV_UPSTREAMREGISTRY TYPE /AWS1/ECRUPSTREAMREGISTRY /AWS1/ECRUPSTREAMREGISTRY

The name of the upstream registry.

IV_CREDENTIALARN TYPE /AWS1/ECRCREDENTIALARN /AWS1/ECRCREDENTIALARN

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

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_ECRCREPULLTHRUCACHE01 /AWS1/CL_ECRCREPULLTHRUCACHE01