You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodeBuild::Types::ProjectEnvironment

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb

Overview

Note:

When making an API call, you may pass ProjectEnvironment data as a hash:

{
  type: "WINDOWS_CONTAINER", # required, accepts WINDOWS_CONTAINER, LINUX_CONTAINER, LINUX_GPU_CONTAINER, ARM_CONTAINER
  image: "NonEmptyString", # required
  compute_type: "BUILD_GENERAL1_SMALL", # required, accepts BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE, BUILD_GENERAL1_2XLARGE
  environment_variables: [
    {
      name: "NonEmptyString", # required
      value: "String", # required
      type: "PLAINTEXT", # accepts PLAINTEXT, PARAMETER_STORE, SECRETS_MANAGER
    },
  ],
  privileged_mode: false,
  certificate: "String",
  registry_credential: {
    credential: "NonEmptyString", # required
    credential_provider: "SECRETS_MANAGER", # required, accepts SECRETS_MANAGER
  },
  image_pull_credentials_type: "CODEBUILD", # accepts CODEBUILD, SERVICE_ROLE
}

Information about the build environment of the build project.

Instance Attribute Summary collapse

Instance Attribute Details

#certificateString

The certificate to use with this build project.

Returns:

  • (String)


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2867

class ProjectEnvironment < Struct.new(
  :type,
  :image,
  :compute_type,
  :environment_variables,
  :privileged_mode,
  :certificate,
  :registry_credential,
  :image_pull_credentials_type)
  include Aws::Structure
end

#compute_typeString

Information about the compute resources the build project uses. Available values include:

  • 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 16 GB memory and 8 vCPUs for builds, depending on your environment type.

  • BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.

If you use BUILD_GENERAL1_LARGE:

  • For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.

  • For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.

  • For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.

For more information, see Build Environment Compute Types in the AWS CodeBuild User Guide.

Returns:

  • (String)


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2867

class ProjectEnvironment < Struct.new(
  :type,
  :image,
  :compute_type,
  :environment_variables,
  :privileged_mode,
  :certificate,
  :registry_credential,
  :image_pull_credentials_type)
  include Aws::Structure
end

#environment_variablesArray<Types::EnvironmentVariable>

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

Returns:



2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2867

class ProjectEnvironment < Struct.new(
  :type,
  :image,
  :compute_type,
  :environment_variables,
  :privileged_mode,
  :certificate,
  :registry_credential,
  :image_pull_credentials_type)
  include Aws::Structure
end

#imageString

The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:

  • For an image tag: registry/repository:tag. For example, to specify an image with the tag "latest," use registry/repository:latest.

  • For an image digest: registry/repository@digest. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.

Returns:

  • (String)


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2867

class ProjectEnvironment < Struct.new(
  :type,
  :image,
  :compute_type,
  :environment_variables,
  :privileged_mode,
  :certificate,
  :registry_credential,
  :image_pull_credentials_type)
  include Aws::Structure
end

#image_pull_credentials_typeString

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:

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

  • SERVICE_ROLE specifies that AWS 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 AWS CodeBuild curated image, you must use CODEBUILD credentials.

Returns:

  • (String)


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2867

class ProjectEnvironment < Struct.new(
  :type,
  :image,
  :compute_type,
  :environment_variables,
  :privileged_mode,
  :certificate,
  :registry_credential,
  :image_pull_credentials_type)
  include Aws::Structure
end

#privileged_modeBoolean

Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is false.

You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:

If the operating system's base image is Ubuntu Linux:

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"

If the operating system's base image is Alpine Linux and the previous command does not work, add the -t argument to timeout:

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

Returns:

  • (Boolean)


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2867

class ProjectEnvironment < Struct.new(
  :type,
  :image,
  :compute_type,
  :environment_variables,
  :privileged_mode,
  :certificate,
  :registry_credential,
  :image_pull_credentials_type)
  include Aws::Structure
end

#registry_credentialTypes::RegistryCredential

The credentials for access to a private registry.



2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2867

class ProjectEnvironment < Struct.new(
  :type,
  :image,
  :compute_type,
  :environment_variables,
  :privileged_mode,
  :certificate,
  :registry_credential,
  :image_pull_credentials_type)
  include Aws::Structure
end

#typeString

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), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (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), EU (Ireland), EU (London), EU (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), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).

Returns:

  • (String)


2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2867

class ProjectEnvironment < Struct.new(
  :type,
  :image,
  :compute_type,
  :environment_variables,
  :privileged_mode,
  :certificate,
  :registry_credential,
  :image_pull_credentials_type)
  include Aws::Structure
end