class MacBuildImage

Language	Type name
.NET	Amazon.CDK.AWS.CodeBuild.MacBuildImage
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscodebuild#MacBuildImage
Java	software.amazon.awscdk.services.codebuild.MacBuildImage
Python	aws_cdk.aws_codebuild.MacBuildImage
TypeScript (source)	aws-cdk-lib » aws_codebuild » MacBuildImage

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
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',

  // the properties below are optional
  assetName: 'assetName',
  buildArgs: {
    buildArgsKey: 'buildArgs',
  },
  buildSecrets: {
    buildSecretsKey: 'buildSecrets',
  },
  buildSsh: 'buildSsh',
  cacheDisabled: false,
  cacheFrom: [{
    type: 'type',

    // the properties below are optional
    params: {
      paramsKey: 'params',
    },
  }],
  cacheTo: {
    type: 'type',

    // the properties below are optional
    params: {
      paramsKey: 'params',
    },
  },
  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',
});

Properties

Name	Type	Description
defaultComputeType	ComputeType	The default ComputeType to use with this image, if one was not specified in BuildEnvironment#computeType explicitly.
imageId	string	The Docker image identifier that the build environment uses.
type	string	The type of build environment.
imagePullPrincipalType?	ImagePullPrincipalType	The type of principal that CodeBuild will use to pull this build Docker image.
repository?	IRepository	An optional ECR repository that the image is hosted in.
secretsManagerCredentials?	ISecret	The secretsManagerCredentials for access to a private registry.
static BASE_14	IBuildImage	Corresponds to the standard CodeBuild image aws/codebuild/macos-arm-base:14.

---

defaultComputeType

Type: ComputeType

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

---

imageId

Type: string

The Docker image identifier that the build environment uses.

---

type

Type: string

The type of build environment.

---

imagePullPrincipalType?

Type: ImagePullPrincipalType (optional)

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

---

repository?

Type: IRepository (optional)

An optional ECR repository that the image is hosted in.

---

secretsManagerCredentials?

Type: ISecret (optional)

The secretsManagerCredentials for access to a private registry.

---

static BASE_14

Type: IBuildImage

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

Methods

Name	Description
runScriptBuildspec(entrypoint)	Make a buildspec to run the indicated script.
validate(buildEnvironment)	Allows the image a chance to validate whether the passed configuration is correct.
static fromAsset(scope, id, props)	Uses an Docker image asset as a ARM MacOS build image.
static fromDockerRegistry(name, options?)	Makes an ARM MacOS build image from a Docker Hub image.
static fromEcrRepository(repository, tagOrDigest?)	Makes an ARM MacOS build image from an ECR repository.

---

runScriptBuildspec(entrypoint)

public runScriptBuildspec(entrypoint: string): BuildSpec

Parameters

• entrypoint string

Returns

• BuildSpec

Make a buildspec to run the indicated script.

---

validate(buildEnvironment)

public validate(buildEnvironment: BuildEnvironment): string[]

Parameters

• buildEnvironment BuildEnvironment

Returns

• string[]

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

---

static fromAsset(scope, id, props)

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.

---

static fromDockerRegistry(name, options?)

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.

---

static fromEcrRepository(repository, tagOrDigest?)

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.