Skip to content

AwsCodeBuildProjectEnvironment

Source code in docs_src/capo_securityhub/types/aws_code_build_project_environment.py
class AwsCodeBuildProjectEnvironment(TypedDict, closed=True):
    certificate: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The certificate to use with this build project.</p>"""
    environment_variables: NotRequired[
        "capo_securityhub.types.aws_code_build_project_environment_environment_variables_list.AwsCodeBuildProjectEnvironmentEnvironmentVariablesList"
    ]
    """<p>A set of environment variables to make available to builds for the build project.</p>"""
    privileged_mode: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Whether to allow the Docker daemon to run inside a Docker container. Set to <code>true</code> if the build project is used to build Docker images.</p>"""
    image_pull_credentials_type: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The type of credentials CodeBuild uses to pull images in your build.</p> <p>Valid values:</p> <ul> <li> <p> <code>CODEBUILD</code> specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the CodeBuild service principal.</p> </li> <li> <p> <code>SERVICE_ROLE</code> specifies that CodeBuild uses your build project's service role.</p> </li> </ul> <p>When you use a cross-account or private registry image, you must use <code>SERVICE_ROLE</code> credentials. When you use an CodeBuild curated image, you must use <code>CODEBUILD</code> credentials.</p>"""
    registry_credential: NotRequired[
        "capo_securityhub.types.aws_code_build_project_environment_registry_credential.AwsCodeBuildProjectEnvironmentRegistryCredential"
    ]
    """<p>The credentials for access to a private registry.</p>"""
    type: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The type of build environment to use for related builds.</p> <p>The environment type <code>ARM_CONTAINER</code> is available only in Regions US East (N. Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).</p> <p>The environment type <code>LINUX_CONTAINER</code> with compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).</p> <p>The environment type <code>LINUX_GPU_CONTAINER</code> is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).</p> <p>Valid values: <code>WINDOWS_CONTAINER</code> | <code>LINUX_CONTAINER</code> | <code>LINUX_GPU_CONTAINER</code> | <code>ARM_CONTAINER</code> </p>"""

certificate instance-attribute

certificate: NotRequired[NonEmptyString]

The certificate to use with this build project.

environment_variables instance-attribute

environment_variables: NotRequired[
    AwsCodeBuildProjectEnvironmentEnvironmentVariablesList
]

A set of environment variables to make available to builds for the build project.

image_pull_credentials_type instance-attribute

image_pull_credentials_type: NotRequired[NonEmptyString]

The type of credentials CodeBuild uses to pull images in your build.

Valid values:

  • CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the CodeBuild service principal.

  • SERVICE_ROLE specifies that CodeBuild uses your build project's service role.

When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.

privileged_mode instance-attribute

privileged_mode: NotRequired[Boolean]

Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.

registry_credential instance-attribute

registry_credential: NotRequired[AwsCodeBuildProjectEnvironmentRegistryCredential]

The credentials for access to a private registry.

type instance-attribute

type: NotRequired[NonEmptyString]

The type of build environment to use for related builds.

The environment type ARM_CONTAINER is available only in Regions US East (N. Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).

The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).

The environment type LINUX_GPU_CONTAINER is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).

Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER