RepositoryImage(image_name, *, credentials=None)¶
An image hosted in a public or private repository.
For images hosted in Amazon ECR, see EcrImage.
__init__(image_name, *, credentials=None)¶
Constructs a new instance of the RepositoryImage class.
ISecret]) – The secret to expose to the container that contains the credentials for the image repository. The supported value is the full ARN of an AWS Secrets Manager secret.
- Return type
Called when the image is used by a ContainerDefinition.
from_asset(directory, *, build_args=None, file=None, repository_name=None, target=None, extra_hash=None, exclude=None, follow=None)¶
Reference an image that’s constructed directly from sources on disk.
If you already have a
DockerImageAssetinstance, you can use the
str) – The directory containing the Dockerfile.
str]]) – Build args to pass to the
docker buildcommand. Since Docker build arguments are resolved before deployment, keys and values cannot refer to unresolved tokens (such as
queue.queueUrl). Default: - no build args are passed
str]) – Path to the Dockerfile (relative to the directory). Default: ‘Dockerfile’
str]) – ECR repository name. Specify this property if you need to statically address the image, e.g. from a Kubernetes Pod. Note, this is only the repository name, without the registry and the tag parts. Default: - the default ECR repository for CDK assets
str]) – Docker target to build to. Default: - no target
str]) – Extra information to encode into the fingerprint (e.g. build instructions and other inputs). Default: - hash is only based on source content
str]]) – Glob patterns to exclude from the copy. Default: nothing is excluded
FollowMode]) – A strategy for how to handle symlinks. Default: Never
- Return type
Use an existing
DockerImageAssetfor this container image.
Reference an image in an ECR repository.
from_registry(name, *, credentials=None)¶
Reference an image on DockerHub or another online registry.