view release on metacpan or  search on metacpan

lib/Paws/CodeBuild/ProjectEnvironment.pm  view on Meta::CPAN

For an image tag:
C<E<lt>registryE<gt>/E<lt>repositoryE<gt>:E<lt>tagE<gt>>. For example,
in the Docker repository that CodeBuild uses to manage its Docker
images, this would be C<aws/codebuild/standard:4.0>.

=item *

For an image digest:
C<E<lt>registryE<gt>/E<lt>repositoryE<gt>@E<lt>digestE<gt>>. For
example, to specify an image with the digest
"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,"
use
C<E<lt>registryE<gt>/E<lt>repositoryE<gt>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf>.

=back

For more information, see Docker images provided by CodeBuild
(https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html)
in the I<CodeBuild user guide>.


=head2 ImagePullCredentialsType => Str

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

=over

=item *

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

=item *

C<SERVICE_ROLE> specifies that CodeBuild uses your build project's
service role.

=back

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.


=head2 PrivilegedMode => Bool

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 C<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:

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

C<- 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 C<-t> argument to C<timeout>:

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

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


=head2 RegistryCredential => L<Paws::CodeBuild::RegistryCredential>

The credentials for access to a private registry.


=head2 B<REQUIRED> Type => Str

The type of build environment to use for related builds.

=over

=item *

The environment type C<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).

=item *

The environment type C<LINUX_CONTAINER> with compute type
C<build.general1.2xlarge> is available only in regions US East (N.
Virginia), US East (Ohio), 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).

=item *

The environment type C<LINUX_GPU_CONTAINER> is available only in
regions US East (N. Virginia), US East (Ohio), 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).

=back

=over

=item *

The environment types C<WINDOWS_CONTAINER> and
C<WINDOWS_SERVER_2019_CONTAINER> are available only in regions US East
(N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).

=back

For more information, see Build environment compute types
(https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html)
in the I<CodeBuild user guide>.



=head1 SEE ALSO

This class forms part of L<Paws>, describing an object used in L<Paws::CodeBuild>