The #X Amz Target=CodeBuild 20161006.CreateProject API from Amazon CodeBuild — 1 operation(s) for #x amz target=codebuild 20161006.createproject.
openapi: 3.0.0
info:
version: '2016-10-06'
x-release: v4
title: 'AWS CodeBuild Builds #X Amz Target=CodeBuild 20161006.CreateProject API'
description: <fullname>CodeBuild</fullname> <p>CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild to use your own build tools. CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about CodeBuild, see the <i> <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/welcome.html">CodeBuild User Guide</a>.</i> </p>
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: codebuild
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codebuild-2016-10-06.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://codebuild.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS CodeBuild multi-region endpoint
- url: https://codebuild.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS CodeBuild multi-region endpoint
- url: http://codebuild.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS CodeBuild endpoint for China (Beijing) and China (Ningxia)
- url: https://codebuild.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS CodeBuild endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=CodeBuild 20161006.CreateProject'
paths:
/#X-Amz-Target=CodeBuild_20161006.CreateProject:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateProject
description: Creates a build project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProjectOutput'
examples:
CreateProject200Example:
summary: Default CreateProject 200 response
x-microcks-default: true
value:
project: example-value
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
CreateProject480Example:
summary: Default CreateProject 480 response
x-microcks-default: true
value: example-value
'481':
description: ResourceAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
examples:
CreateProject481Example:
summary: Default CreateProject 481 response
x-microcks-default: true
value: example-value
'482':
description: AccountLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/AccountLimitExceededException'
examples:
CreateProject482Example:
summary: Default CreateProject 482 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProjectInput'
examples:
CreateProjectRequestExample:
summary: Default CreateProject request
x-microcks-default: true
value:
name: example-resource
description: Example description
source: example-value
secondarySources: example-value
sourceVersion: 1.0.0
secondarySourceVersions: 1.0.0
artifacts: example-value
secondaryArtifacts: example-value
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeBuild_20161006.CreateProject
summary: Amazon CodeBuild Create Project
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=CodeBuild 20161006.CreateProject'
components:
schemas:
VpcConfig:
type: object
properties:
vpcId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The ID of the Amazon VPC.
subnets:
allOf:
- $ref: '#/components/schemas/Subnets'
- description: A list of one or more subnet IDs in your Amazon VPC.
securityGroupIds:
allOf:
- $ref: '#/components/schemas/SecurityGroupIds'
- description: A list of one or more security groups IDs in your Amazon VPC.
description: Information about the VPC configuration that CodeBuild accesses.
ArtifactNamespace:
type: string
enum:
- NONE
- BUILD_ID
Project:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/ProjectName'
- description: The name of the build project.
arn:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Resource Name (ARN) of the build project.
description:
allOf:
- $ref: '#/components/schemas/ProjectDescription'
- description: A description that makes the build project easy to identify.
source:
allOf:
- $ref: '#/components/schemas/ProjectSource'
- description: Information about the build input source code for this build project.
secondarySources:
allOf:
- $ref: '#/components/schemas/ProjectSources'
- description: 'An array of <code>ProjectSource</code> objects. '
sourceVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:</p> <ul> <li> <p>For CodeCommit: the commit ID, branch, or Git tag to use.</p> </li> <li> <p>For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). If a branch name is specified, the branch''s HEAD commit ID is used. If not specified, the default branch''s HEAD commit ID is used.</p> </li> <li> <p>For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch''s HEAD commit ID is used. If not specified, the default branch''s HEAD commit ID is used.</p> </li> <li> <p>For Amazon S3: the version ID of the object that represents the build input ZIP file to use.</p> </li> </ul> <p>If <code>sourceVersion</code> is specified at the build level, then that version takes precedence over this <code>sourceVersion</code> (at the project level). </p> <p>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>CodeBuild User Guide</i>. </p>'
secondarySourceVersions:
allOf:
- $ref: '#/components/schemas/ProjectSecondarySourceVersions'
- description: 'An array of <code>ProjectSourceVersion</code> objects. If <code>secondarySourceVersions</code> is specified at the build level, then they take over these <code>secondarySourceVersions</code> (at the project level). '
artifacts:
allOf:
- $ref: '#/components/schemas/ProjectArtifacts'
- description: Information about the build output artifacts for the build project.
secondaryArtifacts:
allOf:
- $ref: '#/components/schemas/ProjectArtifactsList'
- description: 'An array of <code>ProjectArtifacts</code> objects. '
cache:
allOf:
- $ref: '#/components/schemas/ProjectCache'
- description: Information about the cache for the build project.
environment:
allOf:
- $ref: '#/components/schemas/ProjectEnvironment'
- description: Information about the build environment for this build project.
serviceRole:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
timeoutInMinutes:
allOf:
- $ref: '#/components/schemas/TimeOut'
- description: How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
queuedTimeoutInMinutes:
allOf:
- $ref: '#/components/schemas/TimeOut'
- description: 'The number of minutes a build is allowed to be queued before it times out. '
encryptionKey:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: <p>The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.</p> <note> <p>You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </p> </note> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3). </p>
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: <p>A list of tag key and value pairs associated with this build project.</p> <p>These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.</p>
created:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: When the build project was created, expressed in Unix time format.
lastModified:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: When the build project's settings were last modified, expressed in Unix time format.
webhook:
allOf:
- $ref: '#/components/schemas/Webhook'
- description: Information about a webhook that connects repository events to a build project in CodeBuild.
vpcConfig:
allOf:
- $ref: '#/components/schemas/VpcConfig'
- description: Information about the VPC configuration that CodeBuild accesses.
badge:
allOf:
- $ref: '#/components/schemas/ProjectBadge'
- description: Information about the build badge for the build project.
logsConfig:
allOf:
- $ref: '#/components/schemas/LogsConfig'
- description: 'Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both. '
fileSystemLocations:
allOf:
- $ref: '#/components/schemas/ProjectFileSystemLocations'
- description: ' An array of <code>ProjectFileSystemLocation</code> objects for a CodeBuild build project. A <code>ProjectFileSystemLocation</code> object specifies the <code>identifier</code>, <code>location</code>, <code>mountOptions</code>, <code>mountPoint</code>, and <code>type</code> of a file system created using Amazon Elastic File System. '
buildBatchConfig:
allOf:
- $ref: '#/components/schemas/ProjectBuildBatchConfig'
- description: A <a>ProjectBuildBatchConfig</a> object that defines the batch build options for the project.
concurrentBuildLimit:
allOf:
- $ref: '#/components/schemas/WrapperInt'
- description: <p>The maximum number of concurrent builds that are allowed for this project.</p> <p>New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.</p>
projectVisibility:
$ref: '#/components/schemas/ProjectVisibilityType'
publicProjectAlias:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: 'Contains the project identifier used with the public build APIs. '
resourceAccessRole:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
description: Information about a build project.
NonEmptyString:
type: string
minLength: 1
CloudWatchLogsConfig:
type: object
required:
- status
properties:
status:
allOf:
- $ref: '#/components/schemas/LogsConfigStatusType'
- description: '<p>The current status of the logs in CloudWatch Logs for a build project. Valid values are:</p> <ul> <li> <p> <code>ENABLED</code>: CloudWatch Logs are enabled for this build project.</p> </li> <li> <p> <code>DISABLED</code>: CloudWatch Logs are not enabled for this build project.</p> </li> </ul>'
groupName:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The group name of the logs in CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. '
streamName:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The prefix of the stream name of the CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. '
description: ' Information about CloudWatch Logs for a build project. '
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
minItems: 0
maxItems: 50
ProjectFileSystemLocation:
type: object
properties:
type:
allOf:
- $ref: '#/components/schemas/FileSystemType'
- description: ' The type of the file system. The one supported type is <code>EFS</code>. '
location:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>A string that specifies the location of the file system created by Amazon EFS. Its format is <code>efs-dns-name:/directory-path</code>. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is <code>fs-abcd1234.efs.us-west-2.amazonaws.com</code>, and its mount directory is <code>my-efs-mount-directory</code>, then the <code>location</code> is <code>fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory</code>. </p> <p>The directory path in the format <code>efs-dns-name:/directory-path</code> is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system. </p>
mountPoint:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The location in the container where you mount the file system. '
identifier:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the <code>identifier</code> in all capital letters to <code>CODEBUILD_</code>. For example, if you specify <code>my_efs</code> for <code>identifier</code>, a new environment variable is create named <code>CODEBUILD_MY_EFS</code>. </p> <p> The <code>identifier</code> is used to mount your file system. </p>
mountOptions:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are <code>nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2</code>. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html">Recommended NFS Mount Options</a>. '
description: ' Information about a file system created by Amazon Elastic File System (EFS). For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html">What Is Amazon Elastic File System?</a> '
ProjectArtifacts:
type: object
required:
- type
properties:
type:
allOf:
- $ref: '#/components/schemas/ArtifactsType'
- description: '<p>The type of build output artifact. Valid values include:</p> <ul> <li> <p> <code>CODEPIPELINE</code>: The build project has build output generated through CodePipeline. </p> <note> <p>The <code>CODEPIPELINE</code> type is not supported for <code>secondaryArtifacts</code>.</p> </note> </li> <li> <p> <code>NO_ARTIFACTS</code>: The build project does not produce any build output.</p> </li> <li> <p> <code>S3</code>: The build project stores build output in Amazon S3.</p> </li> </ul>'
location:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>Information about the build output artifact location:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket.</p> </li> </ul>
path:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>Along with <code>namespaceType</code> and <code>name</code>, the pattern that CodeBuild uses to name and store the output artifact:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the path to the output artifact. If <code>path</code> is not specified, <code>path</code> is not used.</p> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in the output bucket at <code>MyArtifacts/MyArtifact.zip</code>.</p>
namespaceType:
allOf:
- $ref: '#/components/schemas/ArtifactNamespace'
- description: '<p>Along with <code>path</code> and <code>name</code>, the pattern that CodeBuild uses to determine the name and location to store the output artifact:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, valid values include:</p> <ul> <li> <p> <code>BUILD_ID</code>: Include the build ID in the location of the build output artifact.</p> </li> <li> <p> <code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified.</p> </li> </ul> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in <code>MyArtifacts/<build-ID>/MyArtifact.zip</code>.</p>'
name:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>Along with <code>path</code> and <code>namespaceType</code>, the pattern that CodeBuild uses to name and store the output artifact:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.</p> </li> </ul> <p>For example:</p> <ul> <li> <p> If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact is stored in <code>MyArtifacts/<build-ID>/MyArtifact.zip</code>. </p> </li> <li> <p> If <code>path</code> is empty, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in the root of the output bucket. </p> </li> <li> <p> If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in <code>MyArtifacts/<build-ID></code>. </p> </li> </ul>
packaging:
allOf:
- $ref: '#/components/schemas/ArtifactPackaging'
- description: '<p>The type of build output artifact to create:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, valid values include:</p> <ul> <li> <p> <code>NONE</code>: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified.</p> </li> <li> <p> <code>ZIP</code>: CodeBuild creates in the output bucket a ZIP file that contains the build output.</p> </li> </ul> </li> </ul>'
overrideArtifactName:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: ' If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. '
encryptionDisabled:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: ' Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown. '
artifactIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: ' An identifier for this artifact definition. '
bucketOwnerAccess:
$ref: '#/components/schemas/BucketOwnerAccess'
description: Information about the build output artifacts for the build project.
FileSystemType:
type: string
enum:
- EFS
GitCloneDepth:
type: integer
minimum: 0
EnvironmentVariables:
type: array
items:
$ref: '#/components/schemas/EnvironmentVariable'
CreateProjectOutput:
type: object
properties:
project:
allOf:
- $ref: '#/components/schemas/Project'
- description: Information about the build project that was created.
RegistryCredential:
type: object
required:
- credential
- credentialProvider
properties:
credential:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: <p> The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager. </p> <note> <p> The <code>credential</code> can use the name of the credentials only if they exist in your current Amazon Web Services Region. </p> </note>
credentialProvider:
allOf:
- $ref: '#/components/schemas/CredentialProviderType'
- description: ' The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager. '
description: '<p> Information about credentials that provide access to a private Docker registry. When this is set: </p> <ul> <li> <p> <code>imagePullCredentialsType</code> must be set to <code>SERVICE_ROLE</code>. </p> </li> <li> <p> images cannot be curated or an Amazon ECR image.</p> </li> </ul> <p> For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-private-registry.html">Private Registry with Secrets Manager Sample for CodeBuild</a>. </p>'
BucketOwnerAccess:
type: string
enum:
- NONE
- READ_ONLY
- FULL
description: <p>Specifies the bucket owner's access for objects that another account uploads to their Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has access to these objects. This property allows you to give the bucket owner access to these objects.</p> <note> <p>To use this property, your CodeBuild service role must have the <code>s3:PutBucketAcl</code> permission. This permission allows CodeBuild to modify the access control list for the bucket.</p> </note> <p>This property can be one of the following values:</p> <dl> <dt>NONE</dt> <dd> <p>The bucket owner does not have access to the objects. This is the default.</p> </dd> <dt>READ_ONLY</dt> <dd> <p>The bucket owner has read-only access to the objects. The uploading account retains ownership of the objects.</p> </dd> <dt>FULL</dt> <dd> <p>The bucket owner has full access to the objects. Object ownership is determined by the following criteria:</p> <ul> <li> <p>If the bucket is configured with the <b>Bucket owner preferred</b> setting, the bucket owner owns the objects. The uploading account will have object access as specified by the bucket's policy.</p> </li> <li> <p>Otherwise, the uploading account retains ownership of the objects.</p> </li> </ul> <p>For more information about Amazon S3 object ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling ownership of uploaded objects using S3 Object Ownership</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> </dd> </dl>
WrapperInt:
type: integer
SourceAuthType:
type: string
enum:
- OAUTH
String:
type: string
CacheType:
type: string
enum:
- NO_CACHE
- S3
- LOCAL
Webhook:
type: object
properties:
url:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The URL to the webhook.
payloadUrl:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The CodeBuild endpoint where webhook events are sent.
secret:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: <p>The secret token of the associated repository. </p> <note> <p>A Bitbucket webhook does not support <code>secret</code>. </p> </note>
branchFilter:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If <code>branchFilter</code> is empty, then all branches are built.</p> <note> <p>It is recommended that you use <code>filterGroups</code> instead of <code>branchFilter</code>. </p> </note>
filterGroups:
allOf:
- $ref: '#/components/schemas/FilterGroups'
- description: <p>An array of arrays of <code>WebhookFilter</code> objects used to determine which webhooks are triggered. At least one <code>WebhookFilter</code> in the array must specify <code>EVENT</code> as its <code>type</code>. </p> <p>For a build to be triggered, at least one filter group in the <code>filterGroups</code> array must pass. For a filter group to pass, each of its filters must pass. </p>
buildType:
allOf:
- $ref: '#/components/schemas/WebhookBuildType'
- description: Specifies the type of build this webhook will trigger.
lastModifiedSecret:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description:
# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-codebuild/refs/heads/main/openapi/amazon-codebuild-x-amz-target-codebuild-20161006-createproject-api-openapi.yml