Implements IBuildImage

A CodeBuild image running ARM MacOS.

This class has a bunch of public constants that represent the most popular images.

You can also specify a custom image using one of the static methods:

• MacBuildImage.fromDockerRegistry(image[, { secretsManagerCredentials }])
• MacBuildImage.fromEcrRepository(repo[, tag])
• MacBuildImage.fromAsset(parent, id, props)

See also: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html

import * as cdk from 'aws-cdk-lib';
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
import { aws_ecr_assets as ecr_assets } from 'aws-cdk-lib';

declare const networkMode: ecr_assets.NetworkMode;
declare const platform: ecr_assets.Platform;
const macBuildImage = codebuild.MacBuildImage.fromAsset(this, 'MyMacBuildImage', {
  directory: 'directory',

  
  assetName: 'assetName',
  buildArgs: {
    buildArgsKey: 'buildArgs',
  },
  buildSecrets: {
    buildSecretsKey: 'buildSecrets',
  },
  buildSsh: 'buildSsh',
  cacheDisabled: false,
  cacheFrom: [{
    type: 'type',

    
    params: {
      paramsKey: 'params',
    },
  }],
  cacheTo: {
    type: 'type',

    
    params: {
      paramsKey: 'params',
    },
  },
  displayName: 'displayName',
  exclude: ['exclude'],
  extraHash: 'extraHash',
  file: 'file',
  followSymlinks: cdk.SymlinkFollowMode.NEVER,
  ignoreMode: cdk.IgnoreMode.GLOB,
  invalidation: {
    buildArgs: false,
    buildSecrets: false,
    buildSsh: false,
    extraHash: false,
    file: false,
    networkMode: false,
    outputs: false,
    platform: false,
    repositoryName: false,
    target: false,
  },
  networkMode: networkMode,
  outputs: ['outputs'],
  platform: platform,
  target: 'target',
});

Type: ComputeType

The default ComputeType to use with this image, if one was not specified in BuildEnvironment#computeType explicitly.

Type: string

The Docker image identifier that the build environment uses.

Type: string

The type of build environment.

Type: ImagePullPrincipalType (optional)

The type of principal that CodeBuild will use to pull this build Docker image.

Type: IRepository (optional)

An optional ECR repository that the image is hosted in.

Type: ISecret (optional)

The secretsManagerCredentials for access to a private registry.

Type: IBuildImage

Corresponds to the standard CodeBuild image aws/codebuild/macos-arm-base:14.

public runScriptBuildspec(entrypoint: string): BuildSpec

Parameters

• entrypoint string

Returns

• BuildSpec

Make a buildspec to run the indicated script.

public validate(buildEnvironment: BuildEnvironment): string[]

Parameters

• buildEnvironment BuildEnvironment

Returns

• string[]

Allows the image a chance to validate whether the passed configuration is correct.

public static fromAsset(scope: Construct, id: string, props: DockerImageAssetProps): IBuildImage

Parameters

• scope Construct
• id string
• props DockerImageAssetProps

Returns

• IBuildImage

Uses an Docker image asset as a ARM MacOS build image.

public static fromDockerRegistry(name: string, options?: DockerImageOptions): IBuildImage

Parameters

• name string
• options DockerImageOptions

Returns

• IBuildImage

Makes an ARM MacOS build image from a Docker Hub image.

public static fromEcrRepository(repository: IRepository, tagOrDigest?: string): IBuildImage

Parameters

• repository IRepository
• tagOrDigest string

Returns

• IBuildImage

Makes an ARM MacOS build image from an ECR repository.