openapi: 3.0.0
info:
  version: '2016-10-06'
  x-release: v4
  title: 'AWS CodeBuild Builds #X Amz Target=CodeBuild 20161006.UpdateProject 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.UpdateProject'
paths:
  /#X-Amz-Target=CodeBuild_20161006.UpdateProject:
    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: UpdateProject
      description: Changes the settings of a build project.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateProjectOutput'
              examples:
                UpdateProject200Example:
                  summary: Default UpdateProject 200 response
                  x-microcks-default: true
                  value:
                    project: example-value
        '480':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                UpdateProject480Example:
                  summary: Default UpdateProject 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                UpdateProject481Example:
                  summary: Default UpdateProject 481 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProjectInput'
            examples:
              UpdateProjectRequestExample:
                summary: Default UpdateProject 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.UpdateProject
      summary: Amazon CodeBuild Update Project
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=CodeBuild 20161006.UpdateProject'
components:
  schemas:
    ArtifactPackaging:
      type: string
      enum:
      - NONE
      - ZIP
    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.
    ProjectSourceVersion:
      type: object
      required:
      - sourceIdentifier
      - sourceVersion
      properties:
        sourceIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. '
        sourceVersion:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: '<p>The source version for the corresponding source identifier. If specified, 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> 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>'
      description: ' A source identifier and its corresponding version. '
    Tag:
      type: object
      properties:
        key:
          allOf:
          - $ref: '#/components/schemas/KeyInput'
          - description: The tag's key.
        value:
          allOf:
          - $ref: '#/components/schemas/ValueInput'
          - description: The tag's value.
      description: <p>A tag, consisting of a key and a value.</p> <p>This tag is available for use by Amazon Web Services services that support tags in CodeBuild.</p>
    ArtifactNamespace:
      type: string
      enum:
      - NONE
      - BUILD_ID
    CacheMode:
      type: string
      enum:
      - LOCAL_DOCKER_LAYER_CACHE
      - LOCAL_SOURCE_CACHE
      - LOCAL_CUSTOM_CACHE
    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/&lt;alias-name&gt;</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
    WebhookFilterType:
      type: string
      enum:
      - EVENT
      - BASE_REF
      - HEAD_REF
      - ACTOR_ACCOUNT_ID
      - FILE_PATH
      - COMMIT_MESSAGE
    WebhookFilter:
      type: object
      required:
      - type
      - pattern
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/WebhookFilterType'
          - description: '<p> The type of webhook filter. There are six webhook filter types: <code>EVENT</code>, <code>ACTOR_ACCOUNT_ID</code>, <code>HEAD_REF</code>, <code>BASE_REF</code>, <code>FILE_PATH</code>, and <code>COMMIT_MESSAGE</code>. </p> <dl> <dt> EVENT </dt> <dd> <p> A webhook event triggers a build when the provided <code>pattern</code> matches one of five event types: <code>PUSH</code>, <code>PULL_REQUEST_CREATED</code>, <code>PULL_REQUEST_UPDATED</code>, <code>PULL_REQUEST_REOPENED</code>, and <code>PULL_REQUEST_MERGED</code>. The <code>EVENT</code> patterns are specified as a comma-separated string. For example, <code>PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull request created, and pull request updated events. </p> <note> <p> The <code>PULL_REQUEST_REOPENED</code> works with GitHub and GitHub Enterprise only. </p> </note> </dd> <dt> ACTOR_ACCOUNT_ID </dt> <dd> <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression <code>pattern</code>. </p> </dd> <dt> HEAD_REF </dt> <dd> <p> A webhook event triggers a build when the head reference matches the regular expression <code>pattern</code>. For example, <code>refs/heads/branch-name</code> and <code>refs/tags/tag-name</code>. </p> <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events. </p> </dd> <dt> BASE_REF </dt> <dd> <p> A webhook event triggers a build when the base reference matches the regular expression <code>pattern</code>. For example, <code>refs/heads/branch-name</code>. </p> <note> <p> Works with pull request events only. </p> </note> </dd> <dt> FILE_PATH </dt> <dd> <p> A webhook triggers a build when the path of a changed file matches the regular expression <code>pattern</code>. </p> <note> <p> Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events. </p> </note> </dd> <dt>COMMIT_MESSAGE</dt> <dd> <p>A webhook triggers a build when the head commit message matches the regular expression <code>pattern</code>.</p> <note> <p> Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events. </p> </note> </dd> </dl>'
        pattern:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p> For a <code>WebHookFilter</code> that uses <code>EVENT</code> type, a comma-separated string that specifies one or more events. For example, the webhook filter <code>PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> allows all push, pull request created, and pull request updated events to trigger a build. </p> <p> For a <code>WebHookFilter</code> that uses any of the other filter types, a regular expression pattern. For example, a <code>WebHookFilter</code> that uses <code>HEAD_REF</code> for its <code>type</code> and the pattern <code>^refs/heads/</code> triggers a build when the head reference is a branch with a reference name <code>refs/heads/branch-name</code>. </p>
        excludeMatchedPattern:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: ' Used to indicate that the <code>pattern</code> determines which webhook events do not trigger a build. If true, then a webhook event that does not match the <code>pattern</code> triggers a build. If false, then a webhook event that matches the <code>pattern</code> triggers a build. '
      description: ' A filter used to determine which webhooks trigger a build. '
    WebhookBuildType:
      type: string
      enum:
      - BUILD
      - BUILD_BATCH
    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. '
    WrapperBoolean:
      type: boolean
    Timestamp:
      type: string
      format: date-time
    EnvironmentVariable:
      type: object
      required:
      - name
      - value
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: The name or key of the environment variable.
        value:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The value of the environment variable.</p> <important> <p>We strongly discourage the use of <code>PLAINTEXT</code> environment variables to store sensitive values, especially Amazon Web Services secret key IDs and secret access keys. <code>PLAINTEXT</code> environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type <code>PARAMETER_STORE</code> or <code>SECRETS_MANAGER</code>. </p> </important>
        type:
          allOf:
          - $ref: '#/components/schemas/EnvironmentVariableType'
          - description: '<p>The type of environment variable. Valid values include:</p> <ul> <li> <p> <code>PARAMETER_STORE</code>: An environment variable stored in Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store">env/parameter-store</a> in the <i>CodeBuild User Guide</i>.</p> </li> <li> <p> <code>PLAINTEXT</code>: An environment variable in plain text format. This is the default value.</p> </li> <li> <p> <code>SECRETS_MANAGER</code>: An environment variable stored in Secrets Manager. To learn how to specify a secrets manager environment variable, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager">env/secrets-manager</a> in the <i>CodeBuild User Guide</i>.</p> </li> </ul>'
      description: Information about an environment variable for a build project or a build.
    ImagePullCredentialsType:
      type: string
      enum:
      - CODEBUILD
      - SERVICE_ROLE
    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> '
    S3LogsConfig:
      type: object
      required:
      - status
      properties:
        status:
          allOf:
          - $ref: '#/components/schemas/LogsConfigStatusType'
          - description: '<p>The current status of the S3 build logs. Valid values are:</p> <ul> <li> <p> <code>ENABLED</code>: S3 build logs are enabled for this build project.</p> </li> <li> <p> <code>DISABLED</code>: S3 build logs are not enabled for this build project.</p> </li> </ul>'
        location:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is <code>my-bucket</code>, and your path prefix is <code>build-log</code>, then acceptable formats are <code>my-bucket/build-log</code> or <code>arn:aws:s3:::my-bucket/build-log</code>. '
        encryptionDisabled:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: ' Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. '
        bucketOwnerAccess:
          $ref: '#/components/schemas/BucketOwnerAccess'
      description: ' Information about S3 logs for a build project. '
    TagList:
      type: array
      items:
        $ref: '#/components/schemas/Tag'
      minItems: 0
      maxItems: 50
    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/&lt;build-ID&gt;/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/&lt;build-ID&gt;/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/&lt;build-ID&gt;</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.
    LogsConfigStatusType:
      type: string
      enum:
      - ENABLED
      - DISABLED
    ProjectSource:
      type: object
      required:
      - type
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/SourceType'
          - description: '<p>The type of repository that contains the source code to be built. Valid values include:</p> <ul> <li> <p> <code>BITBUCKET</code>: The source code is in a Bitbucket repository.</p> </li> <li> <p> <code>CODECOMMIT</code>: The source code is in an CodeCommit repository.</p> </li> <li> <p> <code>CODEPIPELINE</code>: The source code settings are specified in the source action of a pipeline in CodePipeline.</p> </li> <li> <p> <code>GITHUB</code>: The source code is in a GitHub or GitHub Enterprise Cloud repository.</p> </li> <li> <p> <code>GITHUB_ENTERPRISE</code>: The source code is in a GitHub Enterprise Server repository.</p> </li> <li> <p> <code>NO_SOURCE</code>: The project does not have input source code.</p> </li> <li> <p> <code>S3</code>: The source code is in an Amazon S3 bucket.</p> </li> </ul>'
        location:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>Information about the location of the source code to be built. Valid values include:</p> <ul> <li> <p>For source code settings that are specified in the source action of a pipeline in CodePipeline, <code>location</code> should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.</p> </li> <li> <p>For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, <code>https://git-codecommit.&lt;region-ID&gt;.amazonaws.com/v1/repos/&lt;repo-name&gt;</code>).</p> </li> <li> <p>For source code in an Amazon S3 input bucket, one of the following. </p> <ul> <li> <p>The path to the ZIP file that contains the source code (for example, <code>&lt;bucket-name&gt;/&lt;path&gt;/&lt;object-name&gt;.zip</code>). </p> </li> <li> <p>The path to the folder that contains the source code (for example, <code>&lt;bucket-name&gt;/&lt;path-to-source-code&gt;/&lt;folder&gt;/</code>). </p> </li> </ul> </li> <li> <p>For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitHub account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub <b>Authorize application</b> page, for <b>Organization access</b>, choose <b>Request access</b> next to each repository you want to allow CodeBuild to have access to, and then choose <b>Authorize application</b>. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> <li> <p>For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket <b>Confirm access to your account</b> page, choose <b>Grant access</b>. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> </ul> <p> If you specify <code>CODEPIPELINE</code> for the <code>Type</code> property, don't specify this property. For all of the other types, you must specify <code>Location</code>. </p>
        gitCloneDepth:
          allOf:
          - $ref: '#/components/schemas/GitCloneDepth'
          - description: Information about the Git clone depth for the build project.
        gitSubmodulesConfig:
          allOf:
          - $ref: '#/components/schemas/GitSubmodulesConfig'
          - description: ' Information about the Git submodules configuration for the build project. '
        buildspec:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The buildspec file declaration to use for the builds in this build project.</p> <p> If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, <code>arn:aws:s3:::my-codebuild-sample2/buildspec.yml</code>). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>. </p>
        auth:
          allOf:
          - $ref: '#/components/schemas/SourceAuth'
          - description: <p>Information about the authorization settings for CodeBuild to access the source code to be built.</p> <p>This information is for the CodeBuild console's use only. Your code should not get or set this information directly.</p>
        reportBuildStatus:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: <p> Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an <code>invalidInputException</code> is thrown. </p> <p>To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html">Source provider access</a> in the <i>CodeBuild User Guide</i>.</p> <p>The status of a build triggered by a webhook is always reported to your source provider. </p> <p>If your project's builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.</p>
        buildStatusConfig:
          allOf:
          - $ref: '#/components/schemas/BuildStatusConfig'
          - description: Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is <code>GITHUB</code>, <code>GITHUB_ENTERPRISE</code>, or <code>BITBUCKET</code>.
        insecureSsl:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: Enable this flag to ignore SSL warnings while connecting to the project source code.
        sourceIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. '
      description: Information about the build input source code for the build project.
    ProjectBuildBatchConfig:
      type: object
      properties:
        serviceRole:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: Specifies the service role ARN for the batch build project.
        combineArtifacts:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: Specifies if the build artifacts for the batch build should be combined into a single artifact location.
        restrictions:
          allOf:
          - $ref: '#/components/schemas/BatchRestrictions'
          - description: A <code>BatchRestrictions</code> object that specifies the restrictions for the batch build.
        timeoutInMins:
          allOf:
          - $ref: '#/components/schemas/WrapperInt'
          - description: Specifies the maximum amount of time, in minutes, that the batch build must be completed in.
        batchReportMode:
          allOf:
          - $ref: '#/components/schemas/BatchReportModeType'
          - description: <p>Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.</p> <dl> <dt>REPORT_AGGREGATED_BATCH</dt> <dd> <p>(Default) Aggregate all of the build statuses into a single status report.</p> </dd> <dt>REPORT_INDIVIDUAL_BUILDS</dt> <dd> <p>Send a separate status report for each individual build.</p> </dd> </dl>
      description: Contains configuration information about a batch build project.
    ProjectDescription:
      type: string
      minLength: 0
      maxLength: 255
    FileSystemType:
      type: string
      enum:
      - EFS
    LogsConfig:
      type: object
      properties:
        cloudWatchLogs:
          allOf:
          - $ref: '#/components/schemas/CloudWatchLogsConfig'
          - description: ' Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default. '
        s3Logs:
          allOf:
          - $ref: '#/components/schemas/S3LogsConfig'
          - description: ' Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default. '
      description: ' Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both. '
    UpdateProjectInput:
      type: object
      required:
      - name
      title: UpdateProjectInput
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: <p>The name of the build project.</p> <note> <p>You cannot change a build project's name.</p> </note>
        description:
          allOf:
          - $ref: '#/components/schemas/ProjectDescription'
          - description: A new or replacement description of the build project.
        source:
          allOf:
          - $ref: '#/components/schemas/ProjectSource'
          - description: Information to be changed about the build input source code for the 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 to be changed about the build output artifacts for the build project.
        secondaryArtifacts:
          allOf:
          - $ref: '#/components/schemas/ProjectArtifactsList'
          - description: ' An array of <code>ProjectArtifact</code> objects. '
        cache:
          allOf:
          - $ref: '#/components/schemas/ProjectCache'
          - description: Stores recently used information so that it can be quickly accessed at a later time.
        environment:
          allOf:
          - $ref: '#/components/schemas/ProjectEnvironment'
          - description: Information to be changed about the build environment for the build project.
        serviceRole:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: The replacement 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: The replacement value 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.
        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/&lt;alias-name&gt;</code>). </p>
        tags:
          allOf:
          - $ref: '#/components/schemas/TagList'
          - description: <p>An updated 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>
        vpcConfig:
          allOf:
          - $ref: '#/components/schemas/VpcConfig'
          - description: VpcConfig enables CodeBuild to access resources in an Amazon VPC.
        badgeEnabled:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: Set this to true to generate a publicly accessible URL for your project's build badge.
        logsConfig:
          allOf:
          - $ref: '#/components/schemas/LogsConfig'
          - description: ' Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in 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:
          $ref: '#/components/schemas/ProjectBuildBatchConfig'
        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> <p>To remove this limit, set this value to -1.</p>
    GitCloneDepth:
      type: integer
      minimum: 0
    ValueInput:
      type: string
      pattern: ^([\p{L}\p{Z}\p{N}_.:/=@+\-]*)$
      minLength: 0
      maxLength: 255
    EnvironmentVariables:
      type: array
      items:
        $ref: '#/components/schemas/EnvironmentVariable'
    TimeOut:
      type: integer
      minimum: 5
      maximum: 480
    ProjectFileSystemLocations:
      type: array
      items:
        $ref: '#/components/schemas/ProjectFileSystemLocation'
    ProjectEnvironment:
      type: object
      required:
      - type
      - image
      - computeType
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/EnvironmentType'
          - description: <p>The type of build environment to use for related builds.</p> <ul> <li> <p>The environment type <code>ARM_CONTAINER</code> is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).</p> </li> <li> <p>The environment type <code>LINUX_CONTAINER</code> with compute type <code>build.general1.2xlarge</code> is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).</p> </li> <li> <p>The environment type <code>LINUX_GPU_CONTAINER</code> is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).</p> </li> </ul> <ul> <li> <p>The environment types <code>WINDOWS_CONTAINER</code> and <code>WINDOWS_SERVER_2019_CONTAINER</code> are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html">Build environment compute types</a> in the <i>CodeBuild user guide</i>.</p>
        image:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: '<p>The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:</p> <ul> <li> <p>For an image tag: <code>&lt;registry&gt;/&lt;repository&gt;:&lt;tag&gt;</code>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be <code>aws/codebuild/standard:4.0</code>. </p> </li> <li> <p>For an image digest: <code>&lt;registry&gt;/&lt;repository&gt;@&lt;digest&gt;</code>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use <code>&lt;registry&gt;/&lt;repository&gt;@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf</code>.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html">Docker images provided by CodeBuild</a> in the <i>CodeBuild user guide</i>.</p>'
        computeType:
          allOf:
          - $ref: '#/components/schemas/ComputeType'
          - description: '<p>Information about the compute resources the build project uses. Available values include:</p> <ul> <li> <p> <code>BUILD_GENERAL1_SMALL</code>: Use up to 3 GB memory and 2 vCPUs for builds.</p> </li> <li> <p> <code>BUILD_GENERAL1_MEDIUM</code>: Use up to 7 GB memory and 4 vCPUs for builds.</p> </li> <li> <p> <code>BUILD_GENERAL1_LARGE</code>: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.</p> </li> <li> <p> <code>BUILD_GENERAL1_2XLARGE</code>: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.</p> </li> </ul> <p> If you use <code>BUILD_GENERAL1_LARGE</code>: </p> <ul> <li> <p> For environment type <code>LINUX_CONTAINER</code>, you can use up to 15 GB memory and 8 vCPUs for builds. </p> </li> <li> <p> For environment type <code>LINUX_GPU_CONTAINER</code>, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.</p> </li> <li> <p> For environment type <code>ARM_CONTAINER</code>, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html">Build Environment Compute Types</a> in the <i>CodeBuild User Guide.</i> </p>'
        environmentVariables:
          allOf:
          - $ref: '#/components/schemas/EnvironmentVariables'
          - description: A set of environment variables to make available to builds for this build project.
        privilegedMode:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: <p>Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is <code>false</code>.</p> <p>You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:</p> <p>If the operating system's base image is Ubuntu Linux:</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp;</code> </p> <p> <code>- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"</code> </p> <p>If the operating system's base image is Alpine Linux and the previous command does not work, add the <code>-t</code> argument to <code>timeout</code>:</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp;</code> </p> <p> <code>- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"</code> </p>
        certificate:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate">certificate</a> in the <i>CodeBuild User Guide</i>.
        registryCredential:
          allOf:
          - $ref: '#/components/schemas/RegistryCredential'
          - description: ' The credentials for access to a private registry.'
        imagePullCredentialsType:
          allOf:
          - $ref: '#/components/schemas/ImagePullCredentialsType'
          - description: '<p> The type of credentials CodeBuild uses to pull images in your build. There are two valid values: </p> <ul> <li> <p> <code>CODEBUILD</code> specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal. </p> </li> <li> <p> <code>SERVICE_ROLE</code> specifies that CodeBuild uses your build project''s service role. </p> </li> </ul> <p> When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials. </p>'
      description: Information about the build environment of the build project.
    FilterGroups:
      type: array
      items:
        $ref: '#/components/schemas/FilterGroup'
    FilterGroup:
      type: array
      items:
        $ref: '#/components/schemas/WebhookFilter'
    EnvironmentType:
      type: string
      enum:
      - WINDOWS_CONTAINER
      - LINUX_CONTAINER
      - LINUX_GPU_CONTAINER
      - ARM_CONTAINER
      - WINDOWS_SERVER_2019_CONTAINER
    ProjectSecondarySourceVersions:
      type: array
      items:
        $ref: '#/components/schemas/ProjectSourceVersion'
      minItems: 0
      maxItems: 12
    CredentialProviderType:
      type: string
      enum:
      - SECRETS_MANAGER
    ProjectCacheModes:
      type: array
      items:
        $ref: '#/components/schemas/CacheMode'
    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>'
    BatchReportModeType:
      type: string
      enum:
      - REPORT_INDIVIDUAL_BUILDS
      - REPORT_AGGREGATED_BATCH
    BuildStatusConfig:
      type: object
      properties:
        context:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.</p> <dl> <dt>Bitbucket</dt> <dd> <p>This parameter is used for the <code>name</code> parameter in the Bitbucket commit status. For more information, see <a href="https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build">build</a> in the Bitbucket API documentation.</p> </dd> <dt>GitHub/GitHub Enterprise Server</dt> <dd> <p>This parameter is used for the <code>context</code> parameter in the GitHub commit status. For more information, see <a href="https://developer.github.com/v3/repos/statuses/#create-a-commit-status">Create a commit status</a> in the GitHub developer guide.</p> </dd> </dl>
        targetUrl:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.</p> <dl> <dt>Bitbucket</dt> <dd> <p>This parameter is used for the <code>url</code> parameter in the Bitbucket commit status. For more information, see <a href="https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build">build</a> in the Bitbucket API documentation.</p> </dd> <dt>GitHub/GitHub Enterprise Server</dt> <dd> <p>This parameter is used for the <code>target_url</code> parameter in the GitHub commit status. For more information, see <a href="https://developer.github.com/v3/repos/statuses/#create-a-commit-status">Create a commit status</a> in the GitHub developer guide.</p> </dd> </dl>
      description: 'Contains information that defines how the CodeBuild build project reports the build status to the source provider. '
    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>
    ProjectCache:
      type: object
      required:
      - type
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/CacheType'
          - description: '<p>The type of cache used by the build project. Valid values include:</p> <ul> <li> <p> <code>NO_CACHE</code>: The build project does not use any cache.</p> </li> <li> <p> <code>S3</code>: The build project reads and writes from and to S3.</p> </li> <li> <p> <code>LOCAL</code>: The build project stores a cache locally on a build host that is only available to that build host.</p> </li> </ul>'
        location:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: '<p>Information about the cache location: </p> <ul> <li> <p> <code>NO_CACHE</code> or <code>LOCAL</code>: This value is ignored.</p> </li> <li> <p> <code>S3</code>: This is the S3 bucket name/prefix.</p> </li> </ul>'
        modes:
          allOf:
          - $ref: '#/components/schemas/ProjectCacheModes'
          - description: '<p>An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for <code>LOCAL</code> cache types.</p> <p>Possible values are:</p> <dl> <dt>LOCAL_SOURCE_CACHE</dt> <dd> <p>Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored. </p> </dd> <dt>LOCAL_DOCKER_LAYER_CACHE</dt> <dd> <p>Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network. </p> <note> <ul> <li> <p>You can use a Docker layer cache in the Linux environment only. </p> </li> <li> <p>The <code>privileged</code> flag must be set so that your project has the required Docker permissions. </p> </li> <li> <p>You should consider the security implications before you use a Docker layer cache. </p> </li> </ul> </note> </dd> <dt>LOCAL_CUSTOM_CACHE</dt> <dd> <p>Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache: </p> <ul> <li> <p>Only directories can be specified for caching. You cannot specify individual files. </p> </li> <li> <p>Symlinks are used to reference cached directories. </p> </li> <li> <p>Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </p> </li> </ul> </dd> </dl>'
      description: Information about the cache for the build project.
    WrapperInt:
      type: integer
    ProjectSources:
      type: array
      items:
        $ref: '#/components/schemas/ProjectSource'
      minItems: 0
      maxItems: 12
    SourceAuthType:
      type: string
      enum:
      - OAUTH
    Subnets:
      type: array
      items:
        $ref: '#/components/schemas/NonEmptyString'
      maxItems: 16
    String:
      type: string
    SourceAuth:
      type: object
      required:
      - type
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/SourceAuthType'
          - description: <note> <p> This data type is deprecated and is no longer accurate or used. </p> </note> <p>The authorization type to use. The only valid value is <code>OAUTH</code>, which represents the OAuth authorization type.</p>
        resource:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The resource value that applies to the specified authorization type.
      description: <p>Information about the authorization settings for CodeBuild to access the source code to be built.</p> <p>This information is for the CodeBuild console's use only. Your code should not get or set this information directly.</p>
    UpdateProjectOutput:
      type: object
      properties:
        project:
          allOf:
          - $ref: '#/components/schemas/Project'
          - description: Information about the build project that was changed.
    CacheType:
      type: string
      enum:
      - NO_CACHE
      - S3
      - LOCAL
    EnvironmentVariableType:
      type: string
      enum:
      - PLAINTEXT
      - PARAMETER_STORE
      - SECRETS_MANAGER
    ComputeType:
      type: string
      enum:
      - BUILD_GENERAL1_SMALL
      - BUILD_GENERAL1_MEDIUM
      - BUILD_GENERAL1_LARGE
      - BUILD_GENERAL1_2XLARGE
    Boolean:
      type: boolean
    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: 'A timestamp that indicates the last time a repository''s secret token was modified. '
      description: Information about a webhook that connects repository events to a build project in CodeBuild.
    GitSubmodulesConfig:
      type: object
      required:
      - fetchSubmodules
      properties:
        fetchSubmodules:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: ' Set to true to fetch Git submodules for your CodeBuild build project. '
      description: ' Information about the Git submodules configuration for an CodeBuild build project. '
    InvalidInputException: {}
    ProjectArtifactsList:
      type: array
      items:
        $ref: '#/components/schemas/ProjectArtifacts'
      minItems: 0
      maxItems: 12
    BatchRestrictions:
      type: object
      properties:
        maximumBuildsAllowed:
          allOf:
          - $ref: '#/components/schemas/WrapperInt'
          - description: Specifies the maximum number of builds allowed.
        computeTypesAllowed:
          allOf:
          - $ref: '#/components/schemas/ComputeTypesAllowed'
          - description: 'An array of strings that specify the compute types that are allowed for the batch build. See <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html">Build environment compute types</a> in the <i>CodeBuild User Guide</i> for these values. '
      description: Specifies restrictions for the batch build.
    ProjectName:
      type: string
      pattern: '[A-Za-z0-9][A-Za-z0-9\-_]{1,254}'
      minLength: 2
      maxLength: 255
    SourceType:
      type: string
      enum:
      - CODECOMMIT
      - CODEPIPELINE
      - GITHUB
      - S3
      - BITBUCKET
      - GITHUB_ENTERPRISE
      - NO_SOURCE
    ComputeTypesAllowed:
      type: array
      items:
        $ref: '#/components/schemas/NonEmptyString'
    KeyInput:
      type: string
      pattern: ^([\p{L}\p{Z}\p{N}_.:/=@+\-]*)$
      minLength: 1
      maxLength: 127
    ProjectBadge:
      type: object
      properties:
        badgeEnabled:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: Set this to true to generate a publicly accessible URL for your project's build badge.
        badgeRequestUrl:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The publicly-accessible URL through which you can access the build badge for your project. '
      description: Information about the build badge for the build project.
    SecurityGroupIds:
      type: array
      items:
        $ref: '#/components/schemas/NonEmptyString'
      maxItems: 5
    ProjectVisibilityType:
      type: string
      enum:
      - PUBLIC_READ
      - PRIVATE
      description: <p>Specifies the visibility of the project's builds. Possible values are:</p> <dl> <dt>PUBLIC_READ</dt> <dd> <p>The project builds are visible to the public.</p> </dd> <dt>PRIVATE</dt> <dd> <p>The project builds are not visible to the public.</p> </dd> </dl>
    ResourceNotFoundException: {}
    ArtifactsType:
      type: string
      enum:
      - CODEPIPELINE
      - S3
      - NO_ARTIFACTS
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/codebuild/
x-hasEquivalentPaths: true