« blib/lib/Paws/CodeBuild/ProjectBuildBatchConfig.pm
↑ Summary
blib/lib/Paws/CodeBuild/ProjectEnvironment.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeBuild::ProjectCache; | ||
| 3 | use Moose; | ||
| 4 | has Location => (is => 'ro', isa => 'Str', request_name => 'location', traits => ['NameInRequest']); | ||
| 5 | has Modes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'modes', traits => ['NameInRequest']); | ||
| 6 | has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest'], required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::CodeBuild::ProjectCache | ||
| 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::ProjectCache object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Location => $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::ProjectCache object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Location | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Information about the cache for the build project. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 Location => Str | ||
| 44 | |||
| 45 | Information about the cache location: | ||
| 46 | |||
| 47 | =over | ||
| 48 | |||
| 49 | =item * | ||
| 50 | |||
| 51 | C<NO_CACHE> or C<LOCAL>: This value is ignored. | ||
| 52 | |||
| 53 | =item * | ||
| 54 | |||
| 55 | C<S3>: This is the S3 bucket name/prefix. | ||
| 56 | |||
| 57 | =back | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 Modes => ArrayRef[Str|Undef] | ||
| 62 | |||
| 63 | An array of strings that specify the local cache modes. You can use one | ||
| 64 | or more local cache modes at the same time. This is only used for | ||
| 65 | C<LOCAL> cache types. | ||
| 66 | |||
| 67 | Possible values are: | ||
| 68 | |||
| 69 | =over | ||
| 70 | |||
| 71 | =item LOCAL_SOURCE_CACHE | ||
| 72 | |||
| 73 | Caches Git metadata for primary and secondary sources. After the cache | ||
| 74 | is created, subsequent builds pull only the change between commits. | ||
| 75 | This mode is a good choice for projects with a clean working directory | ||
| 76 | and a source that is a large Git repository. If you choose this option | ||
| 77 | and your project does not use a Git repository (GitHub, GitHub | ||
| 78 | Enterprise, or Bitbucket), the option is ignored. | ||
| 79 | |||
| 80 | =item LOCAL_DOCKER_LAYER_CACHE | ||
| 81 | |||
| 82 | Caches existing Docker layers. This mode is a good choice for projects | ||
| 83 | that build or pull large Docker images. It can prevent the performance | ||
| 84 | issues caused by pulling large Docker images down from the network. | ||
| 85 | |||
| 86 | =over | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | You can use a Docker layer cache in the Linux environment only. | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | The C<privileged> flag must be set so that your project has the | ||
| 95 | required Docker permissions. | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | You should consider the security implications before you use a Docker | ||
| 100 | layer cache. | ||
| 101 | |||
| 102 | =back | ||
| 103 | |||
| 104 | =item LOCAL_CUSTOM_CACHE | ||
| 105 | |||
| 106 | Caches directories you specify in the buildspec file. This mode is a | ||
| 107 | good choice if your build scenario is not suited to one of the other | ||
| 108 | three local cache modes. If you use a custom cache: | ||
| 109 | |||
| 110 | =over | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | Only directories can be specified for caching. You cannot specify | ||
| 115 | individual files. | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | Symlinks are used to reference cached directories. | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | Cached directories are linked to your build before it downloads its | ||
| 124 | project sources. Cached items are overridden if a source item has the | ||
| 125 | same name. Directories are specified using cache paths in the buildspec | ||
| 126 | file. | ||
| 127 | |||
| 128 | =back | ||
| 129 | |||
| 130 | =back | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head2 B<REQUIRED> Type => Str | ||
| 135 | |||
| 136 | The type of cache used by the build project. Valid values include: | ||
| 137 | |||
| 138 | =over | ||
| 139 | |||
| 140 | =item * | ||
| 141 | |||
| 142 | C<NO_CACHE>: The build project does not use any cache. | ||
| 143 | |||
| 144 | =item * | ||
| 145 | |||
| 146 | C<S3>: The build project reads and writes from and to S3. | ||
| 147 | |||
| 148 | =item * | ||
| 149 | |||
| 150 | C<LOCAL>: The build project stores a cache locally on a build host that | ||
| 151 | is only available to that build host. | ||
| 152 | |||
| 153 | =back | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head1 SEE ALSO | ||
| 159 | |||
| 160 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeBuild> | ||
| 161 | |||
| 162 | =head1 BUGS and CONTRIBUTIONS | ||
| 163 | |||
| 164 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 165 | |||
| 166 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 167 | |||
| 168 | =cut | ||
| 169 |