| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeBuild::Project; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest']); | ||
| 5 | has Artifacts => (is => 'ro', isa => 'Paws::CodeBuild::ProjectArtifacts', request_name => 'artifacts', traits => ['NameInRequest']); | ||
| 6 | has Badge => (is => 'ro', isa => 'Paws::CodeBuild::ProjectBadge', request_name => 'badge', traits => ['NameInRequest']); | ||
| 7 | has BuildBatchConfig => (is => 'ro', isa => 'Paws::CodeBuild::ProjectBuildBatchConfig', request_name => 'buildBatchConfig', traits => ['NameInRequest']); | ||
| 8 | has Cache => (is => 'ro', isa => 'Paws::CodeBuild::ProjectCache', request_name => 'cache', traits => ['NameInRequest']); | ||
| 9 | has ConcurrentBuildLimit => (is => 'ro', isa => 'Int', request_name => 'concurrentBuildLimit', traits => ['NameInRequest']); | ||
| 10 | has Created => (is => 'ro', isa => 'Str', request_name => 'created', traits => ['NameInRequest']); | ||
| 11 | has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']); | ||
| 12 | has EncryptionKey => (is => 'ro', isa => 'Str', request_name => 'encryptionKey', traits => ['NameInRequest']); | ||
| 13 | has Environment => (is => 'ro', isa => 'Paws::CodeBuild::ProjectEnvironment', request_name => 'environment', traits => ['NameInRequest']); | ||
| 14 | has FileSystemLocations => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::ProjectFileSystemLocation]', request_name => 'fileSystemLocations', traits => ['NameInRequest']); | ||
| 15 | has LastModified => (is => 'ro', isa => 'Str', request_name => 'lastModified', traits => ['NameInRequest']); | ||
| 16 | has LogsConfig => (is => 'ro', isa => 'Paws::CodeBuild::LogsConfig', request_name => 'logsConfig', traits => ['NameInRequest']); | ||
| 17 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 18 | has QueuedTimeoutInMinutes => (is => 'ro', isa => 'Int', request_name => 'queuedTimeoutInMinutes', traits => ['NameInRequest']); | ||
| 19 | has SecondaryArtifacts => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::ProjectArtifacts]', request_name => 'secondaryArtifacts', traits => ['NameInRequest']); | ||
| 20 | has SecondarySources => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::ProjectSource]', request_name => 'secondarySources', traits => ['NameInRequest']); | ||
| 21 | has SecondarySourceVersions => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::ProjectSourceVersion]', request_name => 'secondarySourceVersions', traits => ['NameInRequest']); | ||
| 22 | has ServiceRole => (is => 'ro', isa => 'Str', request_name => 'serviceRole', traits => ['NameInRequest']); | ||
| 23 | has Source => (is => 'ro', isa => 'Paws::CodeBuild::ProjectSource', request_name => 'source', traits => ['NameInRequest']); | ||
| 24 | has SourceVersion => (is => 'ro', isa => 'Str', request_name => 'sourceVersion', traits => ['NameInRequest']); | ||
| 25 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::CodeBuild::Tag]', request_name => 'tags', traits => ['NameInRequest']); | ||
| 26 | has TimeoutInMinutes => (is => 'ro', isa => 'Int', request_name => 'timeoutInMinutes', traits => ['NameInRequest']); | ||
| 27 | has VpcConfig => (is => 'ro', isa => 'Paws::CodeBuild::VpcConfig', request_name => 'vpcConfig', traits => ['NameInRequest']); | ||
| 28 | has Webhook => (is => 'ro', isa => 'Paws::CodeBuild::Webhook', request_name => 'webhook', traits => ['NameInRequest']); | ||
| 29 | |||
| 30 | 1; | ||
| 31 | |||
| 32 | ### main pod documentation begin ### | ||
| 33 | |||
| 34 | =head1 NAME | ||
| 35 | |||
| 36 | Paws::CodeBuild::Project | ||
| 37 | |||
| 38 | =head1 USAGE | ||
| 39 | |||
| 40 | This class represents one of two things: | ||
| 41 | |||
| 42 | =head3 Arguments in a call to a service | ||
| 43 | |||
| 44 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 45 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 46 | |||
| 47 | As an example, if Att1 is expected to be a Paws::CodeBuild::Project object: | ||
| 48 | |||
| 49 | $service_obj->Method(Att1 => { Arn => $value, ..., Webhook => $value }); | ||
| 50 | |||
| 51 | =head3 Results returned from an API call | ||
| 52 | |||
| 53 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodeBuild::Project object: | ||
| 54 | |||
| 55 | $result = $service_obj->Method(...); | ||
| 56 | $result->Att1->Arn | ||
| 57 | |||
| 58 | =head1 DESCRIPTION | ||
| 59 | |||
| 60 | Information about a build project. | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 Arn => Str | ||
| 66 | |||
| 67 | The Amazon Resource Name (ARN) of the build project. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 Artifacts => L<Paws::CodeBuild::ProjectArtifacts> | ||
| 71 | |||
| 72 | Information about the build output artifacts for the build project. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 Badge => L<Paws::CodeBuild::ProjectBadge> | ||
| 76 | |||
| 77 | Information about the build badge for the build project. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 BuildBatchConfig => L<Paws::CodeBuild::ProjectBuildBatchConfig> | ||
| 81 | |||
| 82 | A ProjectBuildBatchConfig object that defines the batch build options | ||
| 83 | for the project. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 Cache => L<Paws::CodeBuild::ProjectCache> | ||
| 87 | |||
| 88 | Information about the cache for the build project. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 ConcurrentBuildLimit => Int | ||
| 92 | |||
| 93 | The maximum number of concurrent builds that are allowed for this | ||
| 94 | project. | ||
| 95 | |||
| 96 | New builds are only started if the current number of builds is less | ||
| 97 | than or equal to this limit. If the current build count meets this | ||
| 98 | limit, new builds are throttled and are not run. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 Created => Str | ||
| 102 | |||
| 103 | When the build project was created, expressed in Unix time format. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 Description => Str | ||
| 107 | |||
| 108 | A description that makes the build project easy to identify. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 EncryptionKey => Str | ||
| 112 | |||
| 113 | The Key Management Service customer master key (CMK) to be used for | ||
| 114 | encrypting the build output artifacts. | ||
| 115 | |||
| 116 | You can use a cross-account KMS key to encrypt the build output | ||
| 117 | artifacts if your service role has permission to that key. | ||
| 118 | |||
| 119 | You can specify either the Amazon Resource Name (ARN) of the CMK or, if | ||
| 120 | available, the CMK's alias (using the format | ||
| 121 | C<alias/E<lt>alias-nameE<gt>>). If you don't specify a value, CodeBuild | ||
| 122 | uses the managed CMK for Amazon Simple Storage Service (Amazon S3). | ||
| 123 | |||
| 124 | |||
| 125 | =head2 Environment => L<Paws::CodeBuild::ProjectEnvironment> | ||
| 126 | |||
| 127 | Information about the build environment for this build project. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 FileSystemLocations => ArrayRef[L<Paws::CodeBuild::ProjectFileSystemLocation>] | ||
| 131 | |||
| 132 | An array of C<ProjectFileSystemLocation> objects for a CodeBuild build | ||
| 133 | project. A C<ProjectFileSystemLocation> object specifies the | ||
| 134 | C<identifier>, C<location>, C<mountOptions>, C<mountPoint>, and C<type> | ||
| 135 | of a file system created using Amazon Elastic File System. | ||
| 136 | |||
| 137 | |||
| 138 | =head2 LastModified => Str | ||
| 139 | |||
| 140 | When the build project's settings were last modified, expressed in Unix | ||
| 141 | time format. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 LogsConfig => L<Paws::CodeBuild::LogsConfig> | ||
| 145 | |||
| 146 | Information about logs for the build project. A project can create logs | ||
| 147 | in CloudWatch Logs, an S3 bucket, or both. | ||
| 148 | |||
| 149 | |||
| 150 | =head2 Name => Str | ||
| 151 | |||
| 152 | The name of the build project. | ||
| 153 | |||
| 154 | |||
| 155 | =head2 QueuedTimeoutInMinutes => Int | ||
| 156 | |||
| 157 | The number of minutes a build is allowed to be queued before it times | ||
| 158 | out. | ||
| 159 | |||
| 160 | |||
| 161 | =head2 SecondaryArtifacts => ArrayRef[L<Paws::CodeBuild::ProjectArtifacts>] | ||
| 162 | |||
| 163 | An array of C<ProjectArtifacts> objects. | ||
| 164 | |||
| 165 | |||
| 166 | =head2 SecondarySources => ArrayRef[L<Paws::CodeBuild::ProjectSource>] | ||
| 167 | |||
| 168 | An array of C<ProjectSource> objects. | ||
| 169 | |||
| 170 | |||
| 171 | =head2 SecondarySourceVersions => ArrayRef[L<Paws::CodeBuild::ProjectSourceVersion>] | ||
| 172 | |||
| 173 | An array of C<ProjectSourceVersion> objects. If | ||
| 174 | C<secondarySourceVersions> is specified at the build level, then they | ||
| 175 | take over these C<secondarySourceVersions> (at the project level). | ||
| 176 | |||
| 177 | |||
| 178 | =head2 ServiceRole => Str | ||
| 179 | |||
| 180 | The ARN of the Identity and Access Management role that enables | ||
| 181 | CodeBuild to interact with dependent Amazon Web Services services on | ||
| 182 | behalf of the Amazon Web Services account. | ||
| 183 | |||
| 184 | |||
| 185 | =head2 Source => L<Paws::CodeBuild::ProjectSource> | ||
| 186 | |||
| 187 | Information about the build input source code for this build project. | ||
| 188 | |||
| 189 | |||
| 190 | =head2 SourceVersion => Str | ||
| 191 | |||
| 192 | A version of the build input to be built for this project. If not | ||
| 193 | specified, the latest version is used. If specified, it must be one of: | ||
| 194 | |||
| 195 | =over | ||
| 196 | |||
| 197 | =item * | ||
| 198 | |||
| 199 | For CodeCommit: the commit ID, branch, or Git tag to use. | ||
| 200 | |||
| 201 | =item * | ||
| 202 | |||
| 203 | For GitHub: the commit ID, pull request ID, branch name, or tag name | ||
| 204 | that corresponds to the version of the source code you want to build. | ||
| 205 | If a pull request ID is specified, it must use the format | ||
| 206 | C<pr/pull-request-ID> (for example C<pr/25>). If a branch name is | ||
| 207 | specified, the branch's HEAD commit ID is used. If not specified, the | ||
| 208 | default branch's HEAD commit ID is used. | ||
| 209 | |||
| 210 | =item * | ||
| 211 | |||
| 212 | For Bitbucket: the commit ID, branch name, or tag name that corresponds | ||
| 213 | to the version of the source code you want to build. If a branch name | ||
| 214 | is specified, the branch's HEAD commit ID is used. If not specified, | ||
| 215 | the default branch's HEAD commit ID is used. | ||
| 216 | |||
| 217 | =item * | ||
| 218 | |||
| 219 | For Amazon S3: the version ID of the object that represents the build | ||
| 220 | input ZIP file to use. | ||
| 221 | |||
| 222 | =back | ||
| 223 | |||
| 224 | If C<sourceVersion> is specified at the build level, then that version | ||
| 225 | takes precedence over this C<sourceVersion> (at the project level). | ||
| 226 | |||
| 227 | For more information, see Source Version Sample with CodeBuild | ||
| 228 | (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) | ||
| 229 | in the I<CodeBuild User Guide>. | ||
| 230 | |||
| 231 | |||
| 232 | =head2 Tags => ArrayRef[L<Paws::CodeBuild::Tag>] | ||
| 233 | |||
| 234 | A list of tag key and value pairs associated with this build project. | ||
| 235 | |||
| 236 | These tags are available for use by Amazon Web Services services that | ||
| 237 | support CodeBuild build project tags. | ||
| 238 | |||
| 239 | |||
| 240 | =head2 TimeoutInMinutes => Int | ||
| 241 | |||
| 242 | How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait | ||
| 243 | before timing out any related build that did not get marked as | ||
| 244 | completed. The default is 60 minutes. | ||
| 245 | |||
| 246 | |||
| 247 | =head2 VpcConfig => L<Paws::CodeBuild::VpcConfig> | ||
| 248 | |||
| 249 | Information about the VPC configuration that CodeBuild accesses. | ||
| 250 | |||
| 251 | |||
| 252 | =head2 Webhook => L<Paws::CodeBuild::Webhook> | ||
| 253 | |||
| 254 | Information about a webhook that connects repository events to a build | ||
| 255 | project in CodeBuild. | ||
| 256 | |||
| 257 | |||
| 258 | |||
| 259 | =head1 SEE ALSO | ||
| 260 | |||
| 261 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeBuild> | ||
| 262 | |||
| 263 | =head1 BUGS and CONTRIBUTIONS | ||
| 264 | |||
| 265 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 266 | |||
| 267 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 268 | |||
| 269 | =cut | ||
| 270 |