« blib/lib/Paws/CodeBuild/ProjectCache.pm
↑ Summary
blib/lib/Paws/CodeBuild/ProjectFileSystemLocation.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeBuild::ProjectEnvironment; | ||
| 3 | use Moose; | ||
| 4 | has Certificate => (is => 'ro', isa => 'Str', request_name => 'certificate', traits => ['NameInRequest']); | ||
| 5 | has ComputeType => (is => 'ro', isa => 'Str', request_name => 'computeType', traits => ['NameInRequest'], required => 1); | ||
| 6 | has EnvironmentVariables => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::EnvironmentVariable]', request_name => 'environmentVariables', traits => ['NameInRequest']); | ||
| 7 | has Image => (is => 'ro', isa => 'Str', request_name => 'image', traits => ['NameInRequest'], required => 1); | ||
| 8 | has ImagePullCredentialsType => (is => 'ro', isa => 'Str', request_name => 'imagePullCredentialsType', traits => ['NameInRequest']); | ||
| 9 | has PrivilegedMode => (is => 'ro', isa => 'Bool', request_name => 'privilegedMode', traits => ['NameInRequest']); | ||
| 10 | has RegistryCredential => (is => 'ro', isa => 'Paws::CodeBuild::RegistryCredential', request_name => 'registryCredential', traits => ['NameInRequest']); | ||
| 11 | has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest'], required => 1); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::CodeBuild::ProjectEnvironment | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::CodeBuild::ProjectEnvironment object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { Certificate => $value, ..., Type => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodeBuild::ProjectEnvironment object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->Certificate | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Information about the build environment of the build project. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 Certificate => Str | ||
| 49 | |||
| 50 | The ARN of the Amazon S3 bucket, path prefix, and object key that | ||
| 51 | contains the PEM-encoded certificate for the build project. For more | ||
| 52 | information, see certificate | ||
| 53 | (https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate) | ||
| 54 | in the I<CodeBuild User Guide>. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> ComputeType => Str | ||
| 58 | |||
| 59 | Information about the compute resources the build project uses. | ||
| 60 | Available values include: | ||
| 61 | |||
| 62 | =over | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | C<BUILD_GENERAL1_SMALL>: Use up to 3 GB memory and 2 vCPUs for builds. | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | C<BUILD_GENERAL1_MEDIUM>: Use up to 7 GB memory and 4 vCPUs for builds. | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C<BUILD_GENERAL1_LARGE>: Use up to 16 GB memory and 8 vCPUs for builds, | ||
| 75 | depending on your environment type. | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | C<BUILD_GENERAL1_2XLARGE>: Use up to 145 GB memory, 72 vCPUs, and 824 | ||
| 80 | GB of SSD storage for builds. This compute type supports Docker images | ||
| 81 | up to 100 GB uncompressed. | ||
| 82 | |||
| 83 | =back | ||
| 84 | |||
| 85 | If you use C<BUILD_GENERAL1_LARGE>: | ||
| 86 | |||
| 87 | =over | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | For environment type C<LINUX_CONTAINER>, you can use up to 15 GB memory | ||
| 92 | and 8 vCPUs for builds. | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | For environment type C<LINUX_GPU_CONTAINER>, you can use up to 255 GB | ||
| 97 | memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | For environment type C<ARM_CONTAINER>, you can use up to 16 GB memory | ||
| 102 | and 8 vCPUs on ARM-based processors for builds. | ||
| 103 | |||
| 104 | =back | ||
| 105 | |||
| 106 | For more information, see Build Environment Compute Types | ||
| 107 | (https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html) | ||
| 108 | in the I<CodeBuild User Guide.> | ||
| 109 | |||
| 110 | |||
| 111 | =head2 EnvironmentVariables => ArrayRef[L<Paws::CodeBuild::EnvironmentVariable>] | ||
| 112 | |||
| 113 | A set of environment variables to make available to builds for this | ||
| 114 | build project. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 B<REQUIRED> Image => Str | ||
| 118 | |||
| 119 | The image tag or image digest that identifies the Docker image to use | ||
| 120 | for this build project. Use the following formats: | ||
| 121 | |||
| 122 | =over | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | For an image tag: | ||
| 127 | C<E<lt>registryE<gt>/E<lt>repositoryE<gt>:E<lt>tagE<gt>>. For example, | ||
| 128 | in the Docker repository that CodeBuild uses to manage its Docker | ||
| 129 | images, this would be C<aws/codebuild/standard:4.0>. | ||
| 130 | |||
| 131 | =item * | ||
| 132 | |||
| 133 | For an image digest: | ||
| 134 | C<E<lt>registryE<gt>/E<lt>repositoryE<gt>@E<lt>digestE<gt>>. For | ||
| 135 | example, to specify an image with the digest | ||
| 136 | "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," | ||
| 137 | use | ||
| 138 | C<E<lt>registryE<gt>/E<lt>repositoryE<gt>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf>. | ||
| 139 | |||
| 140 | =back | ||
| 141 | |||
| 142 | For more information, see Docker images provided by CodeBuild | ||
| 143 | (https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html) | ||
| 144 | in the I<CodeBuild user guide>. | ||
| 145 | |||
| 146 | |||
| 147 | =head2 ImagePullCredentialsType => Str | ||
| 148 | |||
| 149 | The type of credentials CodeBuild uses to pull images in your build. | ||
| 150 | There are two valid values: | ||
| 151 | |||
| 152 | =over | ||
| 153 | |||
| 154 | =item * | ||
| 155 | |||
| 156 | C<CODEBUILD> specifies that CodeBuild uses its own credentials. This | ||
| 157 | requires that you modify your ECR repository policy to trust CodeBuild | ||
| 158 | service principal. | ||
| 159 | |||
| 160 | =item * | ||
| 161 | |||
| 162 | C<SERVICE_ROLE> specifies that CodeBuild uses your build project's | ||
| 163 | service role. | ||
| 164 | |||
| 165 | =back | ||
| 166 | |||
| 167 | When you use a cross-account or private registry image, you must use | ||
| 168 | SERVICE_ROLE credentials. When you use an CodeBuild curated image, you | ||
| 169 | must use CODEBUILD credentials. | ||
| 170 | |||
| 171 | |||
| 172 | =head2 PrivilegedMode => Bool | ||
| 173 | |||
| 174 | Enables running the Docker daemon inside a Docker container. Set to | ||
| 175 | true only if the build project is used to build Docker images. | ||
| 176 | Otherwise, a build that attempts to interact with the Docker daemon | ||
| 177 | fails. The default setting is C<false>. | ||
| 178 | |||
| 179 | You can initialize the Docker daemon during the install phase of your | ||
| 180 | build by adding one of the following sets of commands to the install | ||
| 181 | phase of your buildspec file: | ||
| 182 | |||
| 183 | If the operating system's base image is Ubuntu Linux: | ||
| 184 | |||
| 185 | C<- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock | ||
| 186 | --host=tcp://0.0.0.0:2375 --storage-driver=overlay&> | ||
| 187 | |||
| 188 | C<- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"> | ||
| 189 | |||
| 190 | If the operating system's base image is Alpine Linux and the previous | ||
| 191 | command does not work, add the C<-t> argument to C<timeout>: | ||
| 192 | |||
| 193 | C<- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock | ||
| 194 | --host=tcp://0.0.0.0:2375 --storage-driver=overlay&> | ||
| 195 | |||
| 196 | C<- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"> | ||
| 197 | |||
| 198 | |||
| 199 | =head2 RegistryCredential => L<Paws::CodeBuild::RegistryCredential> | ||
| 200 | |||
| 201 | The credentials for access to a private registry. | ||
| 202 | |||
| 203 | |||
| 204 | =head2 B<REQUIRED> Type => Str | ||
| 205 | |||
| 206 | The type of build environment to use for related builds. | ||
| 207 | |||
| 208 | =over | ||
| 209 | |||
| 210 | =item * | ||
| 211 | |||
| 212 | The environment type C<ARM_CONTAINER> is available only in regions US | ||
| 213 | East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), | ||
| 214 | Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and | ||
| 215 | EU (Frankfurt). | ||
| 216 | |||
| 217 | =item * | ||
| 218 | |||
| 219 | The environment type C<LINUX_CONTAINER> with compute type | ||
| 220 | C<build.general1.2xlarge> is available only in regions US East (N. | ||
| 221 | Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU | ||
| 222 | (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia | ||
| 223 | Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China | ||
| 224 | (Beijing), and China (Ningxia). | ||
| 225 | |||
| 226 | =item * | ||
| 227 | |||
| 228 | The environment type C<LINUX_GPU_CONTAINER> is available only in | ||
| 229 | regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada | ||
| 230 | (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific | ||
| 231 | (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific | ||
| 232 | (Sydney) , China (Beijing), and China (Ningxia). | ||
| 233 | |||
| 234 | =back | ||
| 235 | |||
| 236 | =over | ||
| 237 | |||
| 238 | =item * | ||
| 239 | |||
| 240 | The environment types C<WINDOWS_CONTAINER> and | ||
| 241 | C<WINDOWS_SERVER_2019_CONTAINER> are available only in regions US East | ||
| 242 | (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland). | ||
| 243 | |||
| 244 | =back | ||
| 245 | |||
| 246 | For more information, see Build environment compute types | ||
| 247 | (https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html) | ||
| 248 | in the I<CodeBuild user guide>. | ||
| 249 | |||
| 250 | |||
| 251 | |||
| 252 | =head1 SEE ALSO | ||
| 253 | |||
| 254 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeBuild> | ||
| 255 | |||
| 256 | =head1 BUGS and CONTRIBUTIONS | ||
| 257 | |||
| 258 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 259 | |||
| 260 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 261 | |||
| 262 | =cut | ||
| 263 |