Package software.amazon.awscdk.services.apprunner.alpha

Interface ImageRepository

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ImageRepository.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:49.567Z")
@Stability(Experimental)
public interface ImageRepository
extends software.amazon.jsii.JsiiSerializable

(experimental) Describes a source image repository.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apprunner.alpha.*;
 Secret secret;
 ImageRepository imageRepository = ImageRepository.builder()
         .imageIdentifier("imageIdentifier")
         .imageRepositoryType(ImageRepositoryType.ECR_PUBLIC)
         // the properties below are optional
         .imageConfiguration(ImageConfiguration.builder()
                 .environment(Map.of(
                         "environmentKey", "environment"))
                 .environmentSecrets(Map.of(
                         "environmentSecretsKey", secret))
                 .environmentVariables(Map.of(
                         "environmentVariablesKey", "environmentVariables"))
                 .port(123)
                 .startCommand("startCommand")
                 .build())
         .build();
 

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ImageRepository.Builder	A builder for ImageRepository
static final class	ImageRepository.Jsii$Proxy	An implementation for ImageRepository

Method Summary

Modifier and Type	Method	Description
static ImageRepository.Builder	builder()
default ImageConfiguration	getImageConfiguration()	(experimental) Configuration for running the identified image.
String	getImageIdentifier()	(experimental) The identifier of the image.
ImageRepositoryType	getImageRepositoryType()	(experimental) The type of the image repository.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getImageIdentifier

@Stability(Experimental)
@NotNull
String getImageIdentifier()

(experimental) The identifier of the image.

For ECR_PUBLIC imageRepositoryType, the identifier domain should always be public.ecr.aws. For ECR, the pattern should be ([0-9]{12}.dkr.ecr.[a-z\-]+-[0-9]{1}.amazonaws.com\/.*).

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html

getImageRepositoryType

@Stability(Experimental)
@NotNull
ImageRepositoryType getImageRepositoryType()

(experimental) The type of the image repository.

This reflects the repository provider and whether the repository is private or public.

getImageConfiguration

@Stability(Experimental)
@Nullable
default ImageConfiguration getImageConfiguration()

(experimental) Configuration for running the identified image.

Default: - no image configuration will be passed. The default `port` will be 8080.

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-port

builder

@Stability(Experimental)
static ImageRepository.Builder builder()

Returns:

a ImageRepository.Builder of ImageRepository