Skip to content

Commit b090f87

Browse files
authored
Fix list in generated doc (#1434)
1 parent e572973 commit b090f87

11 files changed

+0
-62
lines changed

src/Enum/BucketOwnerAccess.php

-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
*
2525
* - If the bucket is configured with the **Bucket owner preferred** setting, the bucket owner owns the objects. The
2626
* uploading account will have object access as specified by the bucket's policy.
27-
* -
2827
* - Otherwise, the uploading account retains ownership of the objects.
2928
*
3029
* For more information about Amazon S3 object ownership, see Controlling ownership of uploaded objects using S3

src/ValueObject/Build.php

-12
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,10 @@ final class Build
4444
* The current status of the build. Valid values include:.
4545
*
4646
* - `FAILED`: The build failed.
47-
* -
4847
* - `FAULT`: The build faulted.
49-
* -
5048
* - `IN_PROGRESS`: The build is still in progress.
51-
* -
5249
* - `STOPPED`: The build stopped.
53-
* -
5450
* - `SUCCEEDED`: The build succeeded.
55-
* -
5651
* - `TIMED_OUT`: The build timed out.
5752
*/
5853
private $buildStatus;
@@ -71,9 +66,7 @@ final class Build
7166
* An identifier for the version of this build's source code.
7267
*
7368
* - For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
74-
* -
7569
* - For CodePipeline, the source revision provided by CodePipeline.
76-
* -
7770
* - For Amazon S3, this does not apply.
7871
*/
7972
private $resolvedSourceVersion;
@@ -103,16 +96,13 @@ final class Build
10396
* An array of `ProjectSourceVersion` objects. Each `ProjectSourceVersion` must be one of:.
10497
*
10598
* - For CodeCommit: the commit ID, branch, or Git tag to use.
106-
* -
10799
* - For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source
108100
* code you want to build. If a pull request ID is specified, it must use the format `pr/pull-request-ID` (for
109101
* example, `pr/25`). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the
110102
* default branch's HEAD commit ID is used.
111-
* -
112103
* - For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want
113104
* to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default
114105
* branch's HEAD commit ID is used.
115-
* -
116106
* - For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
117107
*/
118108
private $secondarySourceVersions;
@@ -166,9 +156,7 @@ final class Build
166156
* The entity that started the build. Valid values include:.
167157
*
168158
* - If CodePipeline started the build, the pipeline's name (for example, `codepipeline/my-demo-pipeline`).
169-
* -
170159
* - If an IAM user started the build, the user's name (for example, `MyUserName`).
171-
* -
172160
* - If the Jenkins plugin for CodeBuild started the build, the string `CodeBuild-Jenkins-Plugin`.
173161
*/
174162
private $initiator;

src/ValueObject/CloudWatchLogsConfig.php

-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ final class CloudWatchLogsConfig
1414
* The current status of the logs in CloudWatch Logs for a build project. Valid values are:.
1515
*
1616
* - `ENABLED`: CloudWatch Logs are enabled for this build project.
17-
* -
1817
* - `DISABLED`: CloudWatch Logs are not enabled for this build project.
1918
*/
2019
private $status;

src/ValueObject/EnvironmentVariable.php

-2
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,7 @@ final class EnvironmentVariable
3030
*
3131
* - `PARAMETER_STORE`: An environment variable stored in Systems Manager Parameter Store. To learn how to specify a
3232
* parameter store environment variable, see env/parameter-store [^1] in the *CodeBuild User Guide*.
33-
* -
3433
* - `PLAINTEXT`: An environment variable in plain text format. This is the default value.
35-
* -
3634
* - `SECRETS_MANAGER`: An environment variable stored in Secrets Manager. To learn how to specify a secrets manager
3735
* environment variable, see env/secrets-manager [^2] in the *CodeBuild User Guide*.
3836
*

src/ValueObject/ProjectArtifacts.php

-15
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ final class ProjectArtifacts
2121
* > The `CODEPIPELINE` type is not supported for `secondaryArtifacts`.
2222
*
2323
* - `NO_ARTIFACTS`: The build project does not produce any build output.
24-
* -
2524
* - `S3`: The build project stores build output in Amazon S3.
2625
*/
2726
private $type;
@@ -31,9 +30,7 @@ final class ProjectArtifacts
3130
*
3231
* - If `type` is set to `CODEPIPELINE`, CodePipeline ignores this value if specified. This is because CodePipeline
3332
* manages its build output locations instead of CodeBuild.
34-
* -
3533
* - If `type` is set to `NO_ARTIFACTS`, this value is ignored if specified, because no build output is produced.
36-
* -
3734
* - If `type` is set to `S3`, this is the name of the output bucket.
3835
*/
3936
private $location;
@@ -43,9 +40,7 @@ final class ProjectArtifacts
4340
*
4441
* - If `type` is set to `CODEPIPELINE`, CodePipeline ignores this value if specified. This is because CodePipeline
4542
* manages its build output names instead of CodeBuild.
46-
* -
4743
* - If `type` is set to `NO_ARTIFACTS`, this value is ignored if specified, because no build output is produced.
48-
* -
4944
* - If `type` is set to `S3`, this is the path to the output artifact. If `path` is not specified, `path` is not used.
5045
*
5146
* For example, if `path` is set to `MyArtifacts`, `namespaceType` is set to `NONE`, and `name` is set to
@@ -59,13 +54,10 @@ final class ProjectArtifacts
5954
*
6055
* - If `type` is set to `CODEPIPELINE`, CodePipeline ignores this value if specified. This is because CodePipeline
6156
* manages its build output names instead of CodeBuild.
62-
* -
6357
* - If `type` is set to `NO_ARTIFACTS`, this value is ignored if specified, because no build output is produced.
64-
* -
6558
* - If `type` is set to `S3`, valid values include:
6659
*
6760
* - `BUILD_ID`: Include the build ID in the location of the build output artifact.
68-
* -
6961
* - `NONE`: Do not include the build ID. This is the default if `namespaceType` is not specified.
7062
*
7163
*
@@ -79,20 +71,16 @@ final class ProjectArtifacts
7971
*
8072
* - If `type` is set to `CODEPIPELINE`, CodePipeline ignores this value if specified. This is because CodePipeline
8173
* manages its build output names instead of CodeBuild.
82-
* -
8374
* - If `type` is set to `NO_ARTIFACTS`, this value is ignored if specified, because no build output is produced.
84-
* -
8575
* - If `type` is set to `S3`, this is the name of the output artifact object. If you set the name to be a forward slash
8676
* ("/"), the artifact is stored in the root of the output bucket.
8777
*
8878
* For example:
8979
*
9080
* - If `path` is set to `MyArtifacts`, `namespaceType` is set to `BUILD_ID`, and `name` is set to `MyArtifact.zip`,
9181
* then the output artifact is stored in `MyArtifacts/<build-ID>/MyArtifact.zip`.
92-
* -
9382
* - If `path` is empty, `namespaceType` is set to `NONE`, and `name` is set to "`/`", the output artifact is stored in
9483
* the root of the output bucket.
95-
* -
9684
* - If `path` is set to `MyArtifacts`, `namespaceType` is set to `BUILD_ID`, and `name` is set to "`/`", the output
9785
* artifact is stored in `MyArtifacts/<build-ID>`.
9886
*/
@@ -103,14 +91,11 @@ final class ProjectArtifacts
10391
*
10492
* - If `type` is set to `CODEPIPELINE`, CodePipeline ignores this value if specified. This is because CodePipeline
10593
* manages its build output artifacts instead of CodeBuild.
106-
* -
10794
* - If `type` is set to `NO_ARTIFACTS`, this value is ignored if specified, because no build output is produced.
108-
* -
10995
* - If `type` is set to `S3`, valid values include:
11096
*
11197
* - `NONE`: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if
11298
* `packaging` is not specified.
113-
* -
11499
* - `ZIP`: CodeBuild creates in the output bucket a ZIP file that contains the build output.
115100
*/
116101
private $packaging;

src/ValueObject/ProjectCache.php

-7
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,7 @@ final class ProjectCache
1515
* The type of cache used by the build project. Valid values include:.
1616
*
1717
* - `NO_CACHE`: The build project does not use any cache.
18-
* -
1918
* - `S3`: The build project reads and writes from and to S3.
20-
* -
2119
* - `LOCAL`: The build project stores a cache locally on a build host that is only available to that build host.
2220
*/
2321
private $type;
@@ -26,7 +24,6 @@ final class ProjectCache
2624
* Information about the cache location:.
2725
*
2826
* - `NO_CACHE` or `LOCAL`: This value is ignored.
29-
* -
3027
* - `S3`: This is the S3 bucket name/prefix.
3128
*/
3229
private $location;
@@ -49,9 +46,7 @@ final class ProjectCache
4946
* can prevent the performance issues caused by pulling large Docker images down from the network.
5047
*
5148
* > - You can use a Docker layer cache in the Linux environment only.
52-
* > -
5349
* > - The `privileged` flag must be set so that your project has the required Docker permissions.
54-
* > -
5550
* > - You should consider the security implications before you use a Docker layer cache.
5651
* >
5752
*
@@ -61,9 +56,7 @@ final class ProjectCache
6156
* suited to one of the other three local cache modes. If you use a custom cache:
6257
*
6358
* - Only directories can be specified for caching. You cannot specify individual files.
64-
* -
6559
* - Symlinks are used to reference cached directories.
66-
* -
6760
* - Cached directories are linked to your build before it downloads its project sources. Cached items are overridden
6861
* if a source item has the same name. Directories are specified using cache paths in the buildspec file.
6962
*/

src/ValueObject/ProjectEnvironment.php

-9
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,10 @@ final class ProjectEnvironment
1616
*
1717
* - The environment type `ARM_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West
1818
* (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).
19-
* -
2019
* - The environment type `LINUX_CONTAINER` with compute type `build.general1.2xlarge` is available only in regions US
2120
* East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt),
2221
* Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and
2322
* China (Ningxia).
24-
* -
2523
* - The environment type `LINUX_GPU_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US
2624
* West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific
2725
* (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).
@@ -41,7 +39,6 @@ final class ProjectEnvironment
4139
*
4240
* - For an image tag: `<registry>/<repository>:<tag>`. For example, in the Docker repository that
4341
* CodeBuild uses to manage its Docker images, this would be `aws/codebuild/standard:4.0`.
44-
* -
4542
* - For an image digest: `<registry>/<repository>@<digest>`. For example, to specify an image with
4643
* the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use
4744
* `<registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf`.
@@ -56,21 +53,16 @@ final class ProjectEnvironment
5653
* Information about the compute resources the build project uses. Available values include:.
5754
*
5855
* - `BUILD_GENERAL1_SMALL`: Use up to 3 GB memory and 2 vCPUs for builds.
59-
* -
6056
* - `BUILD_GENERAL1_MEDIUM`: Use up to 7 GB memory and 4 vCPUs for builds.
61-
* -
6257
* - `BUILD_GENERAL1_LARGE`: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.
63-
* -
6458
* - `BUILD_GENERAL1_2XLARGE`: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute
6559
* type supports Docker images up to 100 GB uncompressed.
6660
*
6761
* If you use `BUILD_GENERAL1_LARGE`:
6862
*
6963
* - For environment type `LINUX_CONTAINER`, you can use up to 15 GB memory and 8 vCPUs for builds.
70-
* -
7164
* - For environment type `LINUX_GPU_CONTAINER`, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs
7265
* for builds.
73-
* -
7466
* - For environment type `ARM_CONTAINER`, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for
7567
* builds.
7668
*
@@ -128,7 +120,6 @@ final class ProjectEnvironment
128120
*
129121
* - `CODEBUILD` specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository
130122
* policy to trust CodeBuild service principal.
131-
* -
132123
* - `SERVICE_ROLE` specifies that CodeBuild uses your build project's service role.
133124
*
134125
* When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an

src/ValueObject/ProjectSource.php

-10
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,11 @@ final class ProjectSource
1414
* The type of repository that contains the source code to be built. Valid values include:.
1515
*
1616
* - `BITBUCKET`: The source code is in a Bitbucket repository.
17-
* -
1817
* - `CODECOMMIT`: The source code is in an CodeCommit repository.
19-
* -
2018
* - `CODEPIPELINE`: The source code settings are specified in the source action of a pipeline in CodePipeline.
21-
* -
2219
* - `GITHUB`: The source code is in a GitHub or GitHub Enterprise Cloud repository.
23-
* -
2420
* - `GITHUB_ENTERPRISE`: The source code is in a GitHub Enterprise Server repository.
25-
* -
2621
* - `NO_SOURCE`: The project does not have input source code.
27-
* -
2822
* - `S3`: The source code is in an Amazon S3 bucket.
2923
*/
3024
private $type;
@@ -35,16 +29,13 @@ final class ProjectSource
3529
* - For source code settings that are specified in the source action of a pipeline in CodePipeline, `location` should
3630
* not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a
3731
* pipeline's source action instead of this value.
38-
* -
3932
* - For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code
4033
* and the buildspec file (for example,
4134
* `https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>`).
42-
* -
4335
* - For source code in an Amazon S3 input bucket, one of the following.
4436
*
4537
* - The path to the ZIP file that contains the source code (for example,
4638
* `<bucket-name>/<path>/<object-name>.zip`).
47-
* -
4839
* - The path to the folder that contains the source code (for example,
4940
* `<bucket-name>/<path-to-source-code>/<folder>/`).
5041
*
@@ -55,7 +46,6 @@ final class ProjectSource
5546
* want to allow CodeBuild to have access to, and then choose **Authorize application**. (After you have connected to
5647
* your GitHub account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To
5748
* instruct CodeBuild to use this connection, in the `source` object, set the `auth` object's `type` value to `OAUTH`.
58-
* -
5949
* - For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the
6050
* buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the CodeBuild
6151
* console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on

src/ValueObject/ProjectSourceVersion.php

-3
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,13 @@ final class ProjectSourceVersion
1919
* The source version for the corresponding source identifier. If specified, must be one of:.
2020
*
2121
* - For CodeCommit: the commit ID, branch, or Git tag to use.
22-
* -
2322
* - For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source
2423
* code you want to build. If a pull request ID is specified, it must use the format `pr/pull-request-ID` (for
2524
* example, `pr/25`). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the
2625
* default branch's HEAD commit ID is used.
27-
* -
2826
* - For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want
2927
* to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default
3028
* branch's HEAD commit ID is used.
31-
* -
3229
* - For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
3330
*
3431
* For more information, see Source Version Sample with CodeBuild [^1] in the *CodeBuild User Guide*.

src/ValueObject/RegistryCredential.php

-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
* Information about credentials that provide access to a private Docker registry. When this is set:.
1010
*
1111
* - `imagePullCredentialsType` must be set to `SERVICE_ROLE`.
12-
* -
1312
* - images cannot be curated or an Amazon ECR image.
1413
*
1514
* For more information, see Private Registry with Secrets Manager Sample for CodeBuild [^1].

src/ValueObject/S3LogsConfig.php

-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ final class S3LogsConfig
1515
* The current status of the S3 build logs. Valid values are:.
1616
*
1717
* - `ENABLED`: S3 build logs are enabled for this build project.
18-
* -
1918
* - `DISABLED`: S3 build logs are not enabled for this build project.
2019
*/
2120
private $status;

0 commit comments

Comments
 (0)