File Coverage

blib/lib/Paws/CodeBuild/ProjectEnvironment.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CodeBuild::ProjectEnvironment;
2 1     1   623 use Moose;
  1         4  
  1         9  
3             has ComputeType => (is => 'ro', isa => 'Str', request_name => 'computeType', traits => ['NameInRequest'], required => 1);
4             has EnvironmentVariables => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::EnvironmentVariable]', request_name => 'environmentVariables', traits => ['NameInRequest']);
5             has Image => (is => 'ro', isa => 'Str', request_name => 'image', traits => ['NameInRequest'], required => 1);
6             has PrivilegedMode => (is => 'ro', isa => 'Bool', request_name => 'privilegedMode', traits => ['NameInRequest']);
7             has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest'], required => 1);
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::CodeBuild::ProjectEnvironment
15              
16             =head1 USAGE
17              
18             This class represents one of two things:
19              
20             =head3 Arguments in a call to a service
21              
22             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23             Each attribute should be used as a named argument in the calls that expect this type of object.
24              
25             As an example, if Att1 is expected to be a Paws::CodeBuild::ProjectEnvironment object:
26              
27             $service_obj->Method(Att1 => { ComputeType => $value, ..., Type => $value });
28              
29             =head3 Results returned from an API call
30              
31             Use accessors for each attribute. If Att1 is expected to be an Paws::CodeBuild::ProjectEnvironment object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->ComputeType
35              
36             =head1 DESCRIPTION
37              
38             Information about the build environment of the build project.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 B<REQUIRED> ComputeType => Str
44              
45             Information about the compute resources the build project will use.
46             Available values include:
47              
48             =over
49              
50             =item *
51              
52             C<BUILD_GENERAL1_SMALL>: Use up to 3 GB memory and 2 vCPUs for builds.
53              
54             =item *
55              
56             C<BUILD_GENERAL1_MEDIUM>: Use up to 7 GB memory and 4 vCPUs for builds.
57              
58             =item *
59              
60             C<BUILD_GENERAL1_LARGE>: Use up to 15 GB memory and 8 vCPUs for builds.
61              
62             =back
63              
64              
65              
66             =head2 EnvironmentVariables => ArrayRef[L<Paws::CodeBuild::EnvironmentVariable>]
67              
68             A set of environment variables to make available to builds for this
69             build project.
70              
71              
72             =head2 B<REQUIRED> Image => Str
73              
74             The ID of the Docker image to use for this build project.
75              
76              
77             =head2 PrivilegedMode => Bool
78              
79             If set to true, enables running the Docker daemon inside a Docker
80             container; otherwise, false or not specified (the default). This value
81             must be set to true only if this build project will be used to build
82             Docker images, and the specified build environment image is not one
83             provided by AWS CodeBuild with Docker support. Otherwise, all
84             associated builds that attempt to interact with the Docker daemon will
85             fail. Note that you must also start the Docker daemon so that your
86             builds can interact with it as needed. One way to do this is to
87             initialize the Docker daemon in the install phase of your build spec by
88             running the following build commands. (Do not run the following build
89             commands if the specified build environment image is provided by AWS
90             CodeBuild with Docker support.)
91              
92             C<- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock
93             --host=tcp://0.0.0.0:2375 --storage-driver=vfs& - timeout -t 15 sh -c
94             "until docker info; do echo .; sleep 1; done">
95              
96              
97             =head2 B<REQUIRED> Type => Str
98              
99             The type of build environment to use for related builds.
100              
101              
102              
103             =head1 SEE ALSO
104              
105             This class forms part of L<Paws>, describing an object used in L<Paws::CodeBuild>
106              
107             =head1 BUGS and CONTRIBUTIONS
108              
109             The source code is located here: https://github.com/pplu/aws-sdk-perl
110              
111             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
112              
113             =cut
114