Interface ImageConfiguration

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ImageConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-06T23:25:18.737Z") @Stability(Experimental) public interface ImageConfiguration extends software.amazon.jsii.JsiiSerializable
(experimental) Describes the configuration that AWS App Runner uses to run an App Runner service using an image pulled from a source image repository.

Example:

 import software.amazon.awscdk.services.iam.*;
 Service service = Service.Builder.create(this, "Service")
         .source(Source.fromEcrPublic(EcrPublicProps.builder()
                 .imageConfiguration(ImageConfiguration.builder().port(8000).build())
                 .imageIdentifier("public.ecr.aws/aws-containers/hello-app-runner:latest")
                 .build()))
         .build();
 service.addToRolePolicy(PolicyStatement.Builder.create()
         .effect(Effect.ALLOW)
         .actions(List.of("s3:GetObject"))
         .resources(List.of("*"))
         .build());
 

See Also:
  • Method Details

    • getEnvironment

      @Stability(Deprecated) @Deprecated @Nullable default Map<String,String> getEnvironment()
      Deprecated.
      use environmentVariables.
      (deprecated) Environment variables that are available to your running App Runner service.

      Default: - no environment variables

    • getEnvironmentSecrets

      @Stability(Experimental) @Nullable default Map<String,Secret> getEnvironmentSecrets()
      (experimental) Environment secrets that are available to your running App Runner service.

      Default: - no environment secrets

    • getEnvironmentVariables

      @Stability(Experimental) @Nullable default Map<String,String> getEnvironmentVariables()
      (experimental) Environment variables that are available to your running App Runner service.

      Default: - no environment variables

    • getPort

      @Stability(Experimental) @Nullable default Number getPort()
      (experimental) The port that your application listens to in the container.

      Default: 8080

    • getStartCommand

      @Stability(Experimental) @Nullable default String getStartCommand()
      (experimental) An optional command that App Runner runs to start the application in the source image.

      If specified, this command overrides the Docker image’s default start command.

      Default: - no start command

    • builder

      @Stability(Experimental) static ImageConfiguration.Builder builder()
      Returns:
      a ImageConfiguration.Builder of ImageConfiguration