@aws-cdk_aws-apprunner-alpha.ImageRepository

interface ImageRepository ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.AppRunner.Alpha.ImageRepository
Gogithub.com/aws/aws-cdk-go/awscdkapprunneralpha/v2#ImageRepository
Javasoftware.amazon.awscdk.services.apprunner.alpha.ImageRepository
Pythonaws_cdk.aws_apprunner_alpha.ImageRepository
TypeScript (source)@aws-cdk/aws-apprunner-alpha ยป ImageRepository

Describes a source image repository.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apprunner_alpha from '@aws-cdk/aws-apprunner-alpha';

declare const secret: apprunner_alpha.Secret;
const imageRepository: apprunner_alpha.ImageRepository = {
  imageIdentifier: 'imageIdentifier',
  imageRepositoryType: apprunner_alpha.ImageRepositoryType.ECR_PUBLIC,

  // the properties below are optional
  imageConfiguration: {
    environment: {
      environmentKey: 'environment',
    },
    environmentSecrets: {
      environmentSecretsKey: secret,
    },
    environmentVariables: {
      environmentVariablesKey: 'environmentVariables',
    },
    port: 123,
    startCommand: 'startCommand',
  },
};

Properties

NameTypeDescription
imageIdentifier๐Ÿ”นstringThe identifier of the image.
imageRepositoryType๐Ÿ”นImageRepositoryTypeThe type of the image repository.
imageConfiguration?๐Ÿ”นImageConfigurationConfiguration for running the identified image.

imageIdentifier๐Ÿ”น

Type: string

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 for more details.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html for more details.)


imageRepositoryType๐Ÿ”น

Type: ImageRepositoryType

The type of the image repository.

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


imageConfiguration?๐Ÿ”น

Type: ImageConfiguration (optional, default: no image configuration will be passed. The default port will be 8080.)

Configuration for running the identified image.

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