UNPKG

aws-cdk-lib

Version:

Version 2 of the AWS Cloud Development Kit library

74 lines (73 loc) 3.45 kB
import { BuildSpec } from './build-spec'; import { ComputeType } from './compute-type'; import { BuildEnvironment, IBuildImage, ImagePullPrincipalType, DockerImageOptions } from './project'; import * as ecr from '../../aws-ecr'; import * as secretsmanager from '../../aws-secretsmanager'; /** * A CodeBuild image running aarch64 Linux. * * This class has a bunch of public constants that represent the CodeBuild ARM images. * * You can also specify a custom image using the static method: * * - LinuxBuildImage.fromEcrRepository(repo[, tag]) * - LinuxBuildImage.fromDockerRegistry(image[, { secretsManagerCredentials }]) * * * @see https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html */ export declare class LinuxArmBuildImage implements IBuildImage { /** * Image "aws/codebuild/amazonlinux2-aarch64-standard:1.0". * @deprecated Use {@link LinuxArmBuildImage.AMAZON_LINUX_2_STANDARD_3_0} instead. * */ static readonly AMAZON_LINUX_2_STANDARD_1_0: IBuildImage; /** Image "aws/codebuild/amazonlinux2-aarch64-standard:2.0" based on Amazon Linux 2. */ static readonly AMAZON_LINUX_2_STANDARD_2_0: IBuildImage; /** Image "aws/codebuild/amazonlinux2-aarch64-standard:3.0" based on Amazon Linux 2023. */ static readonly AMAZON_LINUX_2_STANDARD_3_0: IBuildImage; /** Image "aws/codebuild/amazonlinux-aarch64-standard:2.0" based on Amazon Linux 2023. */ static readonly AMAZON_LINUX_2023_STANDARD_2_0: IBuildImage; /** Image "aws/codebuild/amazonlinux-aarch64-standard:3.0" based on Amazon Linux 2023. */ static readonly AMAZON_LINUX_2023_STANDARD_3_0: IBuildImage; /** * @returns a aarch-64 Linux build image from a Docker Hub image. */ static fromDockerRegistry(name: string, options?: DockerImageOptions): IBuildImage; /** * Returns an ARM image running Linux from an ECR repository. * * NOTE: if the repository is external (i.e. imported), then we won't be able to add * a resource policy statement for it so CodeBuild can pull the image. * * @see https://docs.aws.amazon.com/codebuild/latest/userguide/sample-ecr.html * * @param repository The ECR repository * @param tagOrDigest Image tag or digest (default "latest", digests must start with `sha256:`) * @returns An aarch64 Linux build image from an ECR repository. */ static fromEcrRepository(repository: ecr.IRepository, tagOrDigest?: string): IBuildImage; /** * Uses a Docker image provided by CodeBuild. * * @see https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html * * @param id The image identifier * @example 'aws/codebuild/amazonlinux2-aarch64-standard:1.0' * @returns A Docker image provided by CodeBuild. */ static fromCodeBuildImageId(id: string): IBuildImage; readonly type: string; readonly defaultComputeType = ComputeType.LARGE; readonly imageId: string; readonly imagePullPrincipalType?: ImagePullPrincipalType; readonly secretsManagerCredentials?: secretsmanager.ISecret; readonly repository?: ecr.IRepository; private constructor(); /** * Validates by checking the BuildEnvironments' images are not Lambda ComputeTypes * @param buildEnvironment BuildEnvironment */ validate(buildEnvironment: BuildEnvironment): string[]; runScriptBuildspec(entrypoint: string): BuildSpec; }