| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeBuild::ProjectArtifacts; | ||
| 3 | use Moose; | ||
| 4 | has ArtifactIdentifier => (is => 'ro', isa => 'Str', request_name => 'artifactIdentifier', traits => ['NameInRequest']); | ||
| 5 | has EncryptionDisabled => (is => 'ro', isa => 'Bool', request_name => 'encryptionDisabled', traits => ['NameInRequest']); | ||
| 6 | has Location => (is => 'ro', isa => 'Str', request_name => 'location', traits => ['NameInRequest']); | ||
| 7 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 8 | has NamespaceType => (is => 'ro', isa => 'Str', request_name => 'namespaceType', traits => ['NameInRequest']); | ||
| 9 | has OverrideArtifactName => (is => 'ro', isa => 'Bool', request_name => 'overrideArtifactName', traits => ['NameInRequest']); | ||
| 10 | has Packaging => (is => 'ro', isa => 'Str', request_name => 'packaging', traits => ['NameInRequest']); | ||
| 11 | has Path => (is => 'ro', isa => 'Str', request_name => 'path', traits => ['NameInRequest']); | ||
| 12 | has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest'], required => 1); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CodeBuild::ProjectArtifacts | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::CodeBuild::ProjectArtifacts object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { ArtifactIdentifier => $value, ..., Type => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodeBuild::ProjectArtifacts object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->ArtifactIdentifier | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Information about the build output artifacts for the build project. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 ArtifactIdentifier => Str | ||
| 50 | |||
| 51 | An identifier for this artifact definition. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 EncryptionDisabled => Bool | ||
| 55 | |||
| 56 | Set to true if you do not want your output artifacts encrypted. This | ||
| 57 | option is valid only if your artifacts type is Amazon S3. If this is | ||
| 58 | set with another artifacts type, an invalidInputException is thrown. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 Location => Str | ||
| 62 | |||
| 63 | Information about the build output artifact location: | ||
| 64 | |||
| 65 | =over | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | If C<type> is set to C<CODEPIPELINE>, CodePipeline ignores this value | ||
| 70 | if specified. This is because CodePipeline manages its build output | ||
| 71 | locations instead of CodeBuild. | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | If C<type> is set to C<NO_ARTIFACTS>, this value is ignored if | ||
| 76 | specified, because no build output is produced. | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | If C<type> is set to C<S3>, this is the name of the output bucket. | ||
| 81 | |||
| 82 | =back | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 Name => Str | ||
| 87 | |||
| 88 | Along with C<path> and C<namespaceType>, the pattern that CodeBuild | ||
| 89 | uses to name and store the output artifact: | ||
| 90 | |||
| 91 | =over | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | If C<type> is set to C<CODEPIPELINE>, CodePipeline ignores this value | ||
| 96 | if specified. This is because CodePipeline manages its build output | ||
| 97 | names instead of CodeBuild. | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | If C<type> is set to C<NO_ARTIFACTS>, this value is ignored if | ||
| 102 | specified, because no build output is produced. | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | If C<type> is set to C<S3>, this is the name of the output artifact | ||
| 107 | object. If you set the name to be a forward slash ("/"), the artifact | ||
| 108 | is stored in the root of the output bucket. | ||
| 109 | |||
| 110 | =back | ||
| 111 | |||
| 112 | For example: | ||
| 113 | |||
| 114 | =over | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | If C<path> is set to C<MyArtifacts>, C<namespaceType> is set to | ||
| 119 | C<BUILD_ID>, and C<name> is set to C<MyArtifact.zip>, then the output | ||
| 120 | artifact is stored in C<MyArtifacts/E<lt>build-IDE<gt>/MyArtifact.zip>. | ||
| 121 | |||
| 122 | =item * | ||
| 123 | |||
| 124 | If C<path> is empty, C<namespaceType> is set to C<NONE>, and C<name> is | ||
| 125 | set to "C</>", the output artifact is stored in the root of the output | ||
| 126 | bucket. | ||
| 127 | |||
| 128 | =item * | ||
| 129 | |||
| 130 | If C<path> is set to C<MyArtifacts>, C<namespaceType> is set to | ||
| 131 | C<BUILD_ID>, and C<name> is set to "C</>", the output artifact is | ||
| 132 | stored in C<MyArtifacts/E<lt>build-IDE<gt>>. | ||
| 133 | |||
| 134 | =back | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 NamespaceType => Str | ||
| 139 | |||
| 140 | Along with C<path> and C<name>, the pattern that CodeBuild uses to | ||
| 141 | determine the name and location to store the output artifact: | ||
| 142 | |||
| 143 | =over | ||
| 144 | |||
| 145 | =item * | ||
| 146 | |||
| 147 | If C<type> is set to C<CODEPIPELINE>, CodePipeline ignores this value | ||
| 148 | if specified. This is because CodePipeline manages its build output | ||
| 149 | names instead of CodeBuild. | ||
| 150 | |||
| 151 | =item * | ||
| 152 | |||
| 153 | If C<type> is set to C<NO_ARTIFACTS>, this value is ignored if | ||
| 154 | specified, because no build output is produced. | ||
| 155 | |||
| 156 | =item * | ||
| 157 | |||
| 158 | If C<type> is set to C<S3>, valid values include: | ||
| 159 | |||
| 160 | =over | ||
| 161 | |||
| 162 | =item * | ||
| 163 | |||
| 164 | C<BUILD_ID>: Include the build ID in the location of the build output | ||
| 165 | artifact. | ||
| 166 | |||
| 167 | =item * | ||
| 168 | |||
| 169 | C<NONE>: Do not include the build ID. This is the default if | ||
| 170 | C<namespaceType> is not specified. | ||
| 171 | |||
| 172 | =back | ||
| 173 | |||
| 174 | =back | ||
| 175 | |||
| 176 | For example, if C<path> is set to C<MyArtifacts>, C<namespaceType> is | ||
| 177 | set to C<BUILD_ID>, and C<name> is set to C<MyArtifact.zip>, the output | ||
| 178 | artifact is stored in C<MyArtifacts/E<lt>build-IDE<gt>/MyArtifact.zip>. | ||
| 179 | |||
| 180 | |||
| 181 | =head2 OverrideArtifactName => Bool | ||
| 182 | |||
| 183 | If this flag is set, a name specified in the buildspec file overrides | ||
| 184 | the artifact name. The name specified in a buildspec file is calculated | ||
| 185 | at build time and uses the Shell Command Language. For example, you can | ||
| 186 | append a date and time to your artifact name so that it is always | ||
| 187 | unique. | ||
| 188 | |||
| 189 | |||
| 190 | =head2 Packaging => Str | ||
| 191 | |||
| 192 | The type of build output artifact to create: | ||
| 193 | |||
| 194 | =over | ||
| 195 | |||
| 196 | =item * | ||
| 197 | |||
| 198 | If C<type> is set to C<CODEPIPELINE>, CodePipeline ignores this value | ||
| 199 | if specified. This is because CodePipeline manages its build output | ||
| 200 | artifacts instead of CodeBuild. | ||
| 201 | |||
| 202 | =item * | ||
| 203 | |||
| 204 | If C<type> is set to C<NO_ARTIFACTS>, this value is ignored if | ||
| 205 | specified, because no build output is produced. | ||
| 206 | |||
| 207 | =item * | ||
| 208 | |||
| 209 | If C<type> is set to C<S3>, valid values include: | ||
| 210 | |||
| 211 | =over | ||
| 212 | |||
| 213 | =item * | ||
| 214 | |||
| 215 | C<NONE>: CodeBuild creates in the output bucket a folder that contains | ||
| 216 | the build output. This is the default if C<packaging> is not specified. | ||
| 217 | |||
| 218 | =item * | ||
| 219 | |||
| 220 | C<ZIP>: CodeBuild creates in the output bucket a ZIP file that contains | ||
| 221 | the build output. | ||
| 222 | |||
| 223 | =back | ||
| 224 | |||
| 225 | =back | ||
| 226 | |||
| 227 | |||
| 228 | |||
| 229 | =head2 Path => Str | ||
| 230 | |||
| 231 | Along with C<namespaceType> and C<name>, the pattern that CodeBuild | ||
| 232 | uses to name and store the output artifact: | ||
| 233 | |||
| 234 | =over | ||
| 235 | |||
| 236 | =item * | ||
| 237 | |||
| 238 | If C<type> is set to C<CODEPIPELINE>, CodePipeline ignores this value | ||
| 239 | if specified. This is because CodePipeline manages its build output | ||
| 240 | names instead of CodeBuild. | ||
| 241 | |||
| 242 | =item * | ||
| 243 | |||
| 244 | If C<type> is set to C<NO_ARTIFACTS>, this value is ignored if | ||
| 245 | specified, because no build output is produced. | ||
| 246 | |||
| 247 | =item * | ||
| 248 | |||
| 249 | If C<type> is set to C<S3>, this is the path to the output artifact. If | ||
| 250 | C<path> is not specified, C<path> is not used. | ||
| 251 | |||
| 252 | =back | ||
| 253 | |||
| 254 | For example, if C<path> is set to C<MyArtifacts>, C<namespaceType> is | ||
| 255 | set to C<NONE>, and C<name> is set to C<MyArtifact.zip>, the output | ||
| 256 | artifact is stored in the output bucket at | ||
| 257 | C<MyArtifacts/MyArtifact.zip>. | ||
| 258 | |||
| 259 | |||
| 260 | =head2 B<REQUIRED> Type => Str | ||
| 261 | |||
| 262 | The type of build output artifact. Valid values include: | ||
| 263 | |||
| 264 | =over | ||
| 265 | |||
| 266 | =item * | ||
| 267 | |||
| 268 | C<CODEPIPELINE>: The build project has build output generated through | ||
| 269 | CodePipeline. | ||
| 270 | |||
| 271 | The C<CODEPIPELINE> type is not supported for C<secondaryArtifacts>. | ||
| 272 | |||
| 273 | =item * | ||
| 274 | |||
| 275 | C<NO_ARTIFACTS>: The build project does not produce any build output. | ||
| 276 | |||
| 277 | =item * | ||
| 278 | |||
| 279 | C<S3>: The build project stores build output in Amazon S3. | ||
| 280 | |||
| 281 | =back | ||
| 282 | |||
| 283 | |||
| 284 | |||
| 285 | |||
| 286 | =head1 SEE ALSO | ||
| 287 | |||
| 288 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeBuild> | ||
| 289 | |||
| 290 | =head1 BUGS and CONTRIBUTIONS | ||
| 291 | |||
| 292 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 293 | |||
| 294 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 295 | |||
| 296 | =cut | ||
| 297 |