Skip to content

ImageBuildConfiguration

Source code in docs_src/capo_elastic_beanstalk/types/image_build_configuration.py
class ImageBuildConfiguration(TypedDict, closed=True):
    type: NotRequired["capo_elastic_beanstalk.types.image_build_type.ImageBuildType"]
    """<p>How Elastic Beanstalk builds the container image. Elastic Beanstalk rejects a <code>Build</code> that doesn't specify it.</p> <p>Valid values:</p> <ul> <li> <p> <code>docker</code> – Elastic Beanstalk builds the image from a Dockerfile in your source bundle. Specify the Dockerfile with <code>DockerfileLocation</code>.</p> </li> <li> <p> <code>buildpack</code> – Elastic Beanstalk builds the image with a Cloud Native Buildpacks builder. Specify the builder with <code>Buildpack</code>.</p> </li> </ul>"""
    dockerfile_location: NotRequired["capo_elastic_beanstalk.types.string.String"]
    """<p>The path to the Dockerfile within the source bundle, relative to the root of the source bundle. For example, <code>backend/Dockerfile</code>.</p> <p>Elastic Beanstalk uses this member only when <code>Type</code> is <code>docker</code>. If you don't specify it, Elastic Beanstalk uses the Dockerfile at the root of the source bundle.</p>"""
    buildpack: NotRequired["capo_elastic_beanstalk.types.string.String"]
    """<p>The Cloud Native Buildpacks builder image that Elastic Beanstalk uses to build the container image. For example, <code>paketobuildpacks/builder-jammy-base</code>.</p> <p>This member is required when <code>Type</code> is <code>buildpack</code>. Elastic Beanstalk doesn't provide a default builder.</p>"""
    architecture: NotRequired[
        "capo_elastic_beanstalk.types.architecture_type.ArchitectureType"
    ]
    """<p>The processor architecture that Elastic Beanstalk builds the container image for. The architecture must match the architecture of the instances in the environment that you deploy the application version to.</p> <p>Valid values:</p> <ul> <li> <p> <code>amd64</code> – x86-64 instances. This is the default.</p> </li> <li> <p> <code>arm64</code> – Amazon Web Services Graviton instances.</p> </li> </ul>"""
    code_build_service_role: NotRequired[
        "capo_elastic_beanstalk.types.non_empty_string.NonEmptyString"
    ]
    """<p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that CodeBuild assumes to run the build in your Amazon Web Services account. Elastic Beanstalk rejects a <code>Build</code> that doesn't specify this role.</p>"""
    compute_type: NotRequired["capo_elastic_beanstalk.types.compute_type.ComputeType"]
    """<p>The size of the compute resources that run the build. If you don't specify it, Elastic Beanstalk uses <code>BUILD_GENERAL1_MEDIUM</code>.</p> <p>Valid values:</p> <ul> <li> <p> <code>BUILD_GENERAL1_SMALL</code> – Use up to 3 GB memory and 2 vCPUs for builds.</p> </li> <li> <p> <code>BUILD_GENERAL1_MEDIUM</code> – Use up to 7 GB memory and 4 vCPUs for builds.</p> </li> <li> <p> <code>BUILD_GENERAL1_LARGE</code> – Use up to 15 GB memory and 8 vCPUs for builds.</p> </li> </ul>"""
    timeout_in_minutes: NotRequired["capo_elastic_beanstalk.types.boxed_int.BoxedInt"]
    """<p>How long, in minutes from 5 to 480 (8 hours), Elastic Beanstalk waits before stopping a build that hasn't completed. The default is 60 minutes.</p>"""

architecture instance-attribute

architecture: NotRequired[ArchitectureType]

The processor architecture that Elastic Beanstalk builds the container image for. The architecture must match the architecture of the instances in the environment that you deploy the application version to.

Valid values:

  • amd64 – x86-64 instances. This is the default.

  • arm64 – Amazon Web Services Graviton instances.

buildpack instance-attribute

buildpack: NotRequired[String]

The Cloud Native Buildpacks builder image that Elastic Beanstalk uses to build the container image. For example, paketobuildpacks/builder-jammy-base.

This member is required when Type is buildpack. Elastic Beanstalk doesn't provide a default builder.

code_build_service_role instance-attribute

code_build_service_role: NotRequired[NonEmptyString]

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that CodeBuild assumes to run the build in your Amazon Web Services account. Elastic Beanstalk rejects a Build that doesn't specify this role.

compute_type instance-attribute

compute_type: NotRequired[ComputeType]

The size of the compute resources that run the build. If you don't specify it, Elastic Beanstalk uses BUILD_GENERAL1_MEDIUM.

Valid values:

  • BUILD_GENERAL1_SMALL – Use up to 3 GB memory and 2 vCPUs for builds.

  • BUILD_GENERAL1_MEDIUM – Use up to 7 GB memory and 4 vCPUs for builds.

  • BUILD_GENERAL1_LARGE – Use up to 15 GB memory and 8 vCPUs for builds.

dockerfile_location instance-attribute

dockerfile_location: NotRequired[String]

The path to the Dockerfile within the source bundle, relative to the root of the source bundle. For example, backend/Dockerfile.

Elastic Beanstalk uses this member only when Type is docker. If you don't specify it, Elastic Beanstalk uses the Dockerfile at the root of the source bundle.

timeout_in_minutes instance-attribute

timeout_in_minutes: NotRequired[BoxedInt]

How long, in minutes from 5 to 480 (8 hours), Elastic Beanstalk waits before stopping a build that hasn't completed. The default is 60 minutes.

type instance-attribute

type: NotRequired[ImageBuildType]

How Elastic Beanstalk builds the container image. Elastic Beanstalk rejects a Build that doesn't specify it.

Valid values:

  • docker – Elastic Beanstalk builds the image from a Dockerfile in your source bundle. Specify the Dockerfile with DockerfileLocation.

  • buildpack – Elastic Beanstalk builds the image with a Cloud Native Buildpacks builder. Specify the builder with Buildpack.