@aws-cdk/aws-apprunner-alpha.ImageRepository

Experimental

@aws-cdk/aws-apprunner-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ImageRepository Struct

Describes a source image repository.

Stability

Experimental

Source

lib/service.ts

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

imageConfiguration?optionalImageConfigurationimage_configuration?optionalImageConfigurationimageConfiguration?optionalImageConfigurationImageConfiguration?optionalImageConfigurationImageConfiguration?optionalImageConfiguration#

Configuration for running the identified image.

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

imageIdentifierstringimage_identifierstrimageIdentifierStringImageIdentifierstringImageIdentifier*stringrequired#

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\/.*).

imageRepositoryTypeImageRepositoryTypeimage_repository_typeImageRepositoryTypeimageRepositoryTypeImageRepositoryTypeImageRepositoryTypeImageRepositoryTypeImageRepositoryTypeImageRepositoryTyperequired#

The type of the image repository.

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