AwsCodebuildProjectEnvironmentArgs

interface AwsCodebuildProjectEnvironmentArgs extends Omit<aws.types.input.codebuild.ProjectEnvironment, 'environmentVariables'> { certificate?: Input<string | undefined>; computeType: Input<string>; dockerServer?: Input<ProjectEnvironmentDockerServer | undefined>; environmentVariables?: Input<AwsCodebuildProjectEnvironmentVariableArgs>[]; fleet?: Input<ProjectEnvironmentFleet | undefined>; hostKernel?: Input<string | undefined>; image: Input<string>; imagePullCredentialsType?: Input<string | undefined>; privilegedMode?: Input<boolean | undefined>; registryCredential?: Input<ProjectEnvironmentRegistryCredential | undefined>; type: Input<string>; }

Project build-environment input for AwsCodebuildArgs.

Example

CODE
const environment: AwsCodebuildProjectEnvironmentArgs = {
  computeType: 'BUILD_GENERAL1_SMALL',
  image: 'public.ecr.aws/codebuild/amazonlinux2-x86_64-standard:5.0',
  type: 'LINUX_CONTAINER',
  environmentVariables: [{ name: 'BRANCH', value: 'main' }],
};

Hierarchy

  • ProjectEnvironment, "environmentVariables">
  • AwsCodebuildProjectEnvironmentArgs

Properties

certificate: Input<string | undefined>

Inherited from certificate

ARN of the S3 bucket, path prefix and object key that contains the PEM-encoded certificate.

computeType: Input<string>

Inherited from computeType

Information about the compute resources the build project will use. Valid values: BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE, BUILD_GENERAL1_XLARGE, BUILD_GENERAL1_2XLARGE, BUILD_LAMBDA_1GB, BUILD_LAMBDA_2GB, BUILD_LAMBDA_4GB, BUILD_LAMBDA_8GB, BUILD_LAMBDA_10GB. For additional information, see the CodeBuild User Guide.

dockerServer: Input<ProjectEnvironmentDockerServer | undefined>

Inherited from dockerServer

Configuration block. Detailed below.

environmentVariables: Input<AwsCodebuildProjectEnvironmentVariableArgs>[]

Optional environment variables injected into the build container.

fleet: Input<ProjectEnvironmentFleet | undefined>

Inherited from fleet

Configuration block. Detailed below.

hostKernel: Input<string | undefined>

Inherited from hostKernel

Host operating system kernel used for on-demand builds in the build project. This setting controls the kernel of the underlying build host. It does not change the build environment operating system, which is determined by the image you specify. Valid values: LINUX_KERNEL_4 (runs on an Amazon Linux 2 host, kernel 4.x), LINUX_KERNEL_6 (runs on an Amazon Linux 2023 host, kernel 6.x), LINUX_KERNEL_LATEST (runs on the latest supported host kernel). Applies to the LINUX_CONTAINER, ARM_CONTAINER, LINUX_EC2, and ARM_EC2 environment types; not applicable to Windows, Lambda, or Mac environment types. If not specified, CodeBuild selects a default.

image: Input<string>

Inherited from image

Docker image to use for this build project. Valid values include Docker images provided by CodeBuild ( e.g aws/codebuild/amazonlinux2-x86_64-standard:4.0), Docker Hub images (e.g., pulumi/pulumi:latest), and full Docker repository URIs such as those for ECR (e.g., 137112412989.dkr.ecr.us-west-2.amazonaws.com/amazonlinux:latest).

imagePullCredentialsType: Input<string | undefined>

Inherited from imagePullCredentialsType

Type of credentials AWS CodeBuild uses to pull images in your build. Valid values: CODEBUILD, SERVICE_ROLE. When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CodeBuild credentials. Defaults to CODEBUILD.

privilegedMode: Input<boolean | undefined>

Inherited from privilegedMode

Whether to enable running the Docker daemon inside a Docker container. Defaults to false.

registryCredential: Input<ProjectEnvironmentRegistryCredential | undefined>

Inherited from registryCredential

Configuration block. Detailed below.

type: Input<string>

Inherited from type

Type of build environment to use for related builds. Valid values: WINDOWS_CONTAINER (deprecated), LINUX_CONTAINER, LINUX_GPU_CONTAINER, ARM_CONTAINER, WINDOWS_SERVER_2019_CONTAINER, WINDOWS_SERVER_2022_CONTAINER, LINUX_LAMBDA_CONTAINER, ARM_LAMBDA_CONTAINER, LINUX_EC2, ARM_EC2, WINDOWS_EC2, MAC_ARM. For additional information, see the CodeBuild User Guide.