{ "swagger": "2.0", "info": { "title": "Microsoft.AwsConnector", "version": "2024-12-01", "description": "Microsoft.AwsConnector Resource Provider management API.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "CodeBuildProjects" } ], "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/codeBuildProjects": { "get": { "operationId": "CodeBuildProjects_ListBySubscription", "tags": [ "CodeBuildProjects" ], "description": "List CodeBuildProject resources by subscription ID", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CodeBuildProjectListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CodeBuildProjects_ListBySubscription": { "$ref": "./examples/CodeBuildProjects_ListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/codeBuildProjects": { "get": { "operationId": "CodeBuildProjects_ListByResourceGroup", "tags": [ "CodeBuildProjects" ], "description": "List CodeBuildProject resources by resource group", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CodeBuildProjectListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CodeBuildProjects_ListByResourceGroup": { "$ref": "./examples/CodeBuildProjects_ListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/codeBuildProjects/{name}": { "get": { "operationId": "CodeBuildProjects_Get", "tags": [ "CodeBuildProjects" ], "description": "Get a CodeBuildProject", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of CodeBuildProject", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CodeBuildProject" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CodeBuildProjects_Get": { "$ref": "./examples/CodeBuildProjects_Get.json" } } }, "put": { "operationId": "CodeBuildProjects_CreateOrReplace", "tags": [ "CodeBuildProjects" ], "description": "Create a CodeBuildProject. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of CodeBuildProject", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/CodeBuildProject" } } ], "responses": { "200": { "description": "Resource 'CodeBuildProject' update operation succeeded", "schema": { "$ref": "#/definitions/CodeBuildProject" } }, "201": { "description": "Resource 'CodeBuildProject' create operation succeeded", "schema": { "$ref": "#/definitions/CodeBuildProject" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CodeBuildProjects_CreateOrReplace": { "$ref": "./examples/CodeBuildProjects_CreateOrReplace.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "CodeBuildProjects_Update", "tags": [ "CodeBuildProjects" ], "description": "Update a CodeBuildProject", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of CodeBuildProject", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/CodeBuildProjectTagsUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CodeBuildProject" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CodeBuildProjects_Update": { "$ref": "./examples/CodeBuildProjects_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "CodeBuildProjects_Delete", "tags": [ "CodeBuildProjects" ], "description": "Delete a CodeBuildProject", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of CodeBuildProject", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "CodeBuildProjects_Delete": { "$ref": "./examples/CodeBuildProjects_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } } }, "definitions": { "ArtifactNamespace": { "type": "string", "description": "ArtifactNamespace enum", "enum": [ "BUILD_ID", "NONE" ], "x-ms-enum": { "name": "ArtifactNamespace", "modelAsString": true, "values": [ { "name": "BUILD_ID", "value": "BUILD_ID", "description": "ArtifactNamespace enum BUILD_ID" }, { "name": "NONE", "value": "NONE", "description": "ArtifactNamespace enum NONE" } ] } }, "ArtifactNamespaceEnumValue": { "type": "object", "description": "Definition of ArtifactNamespaceEnumValue", "properties": { "value": { "$ref": "#/definitions/ArtifactNamespace", "description": "Property value" } } }, "ArtifactPackaging": { "type": "string", "description": "ArtifactPackaging enum", "enum": [ "NONE", "ZIP" ], "x-ms-enum": { "name": "ArtifactPackaging", "modelAsString": true, "values": [ { "name": "NONE", "value": "NONE", "description": "ArtifactPackaging enum NONE" }, { "name": "ZIP", "value": "ZIP", "description": "ArtifactPackaging enum ZIP" } ] } }, "ArtifactPackagingEnumValue": { "type": "object", "description": "Definition of ArtifactPackagingEnumValue", "properties": { "value": { "$ref": "#/definitions/ArtifactPackaging", "description": "Property value" } } }, "ArtifactsType": { "type": "string", "description": "ArtifactsType enum", "enum": [ "CODEPIPELINE", "NO_ARTIFACTS", "S3" ], "x-ms-enum": { "name": "ArtifactsType", "modelAsString": true, "values": [ { "name": "CODEPIPELINE", "value": "CODEPIPELINE", "description": "ArtifactsType enum CODEPIPELINE" }, { "name": "NO_ARTIFACTS", "value": "NO_ARTIFACTS", "description": "ArtifactsType enum NO_ARTIFACTS" }, { "name": "S3", "value": "S3", "description": "ArtifactsType enum S3" } ] } }, "ArtifactsTypeEnumValue": { "type": "object", "description": "Definition of ArtifactsTypeEnumValue", "properties": { "value": { "$ref": "#/definitions/ArtifactsType", "description": "Property value" } } }, "AwsCodeBuildProjectProperties": { "type": "object", "description": "Definition of awsCodeBuildProject", "properties": { "arn": { "type": "string", "description": "

The Amazon Resource Name (ARN) of the build project.

" }, "artifacts": { "$ref": "#/definitions/ProjectArtifacts", "description": "

Information about the build output artifacts for the build project.

" }, "badge": { "$ref": "#/definitions/ProjectBadge", "description": "

Information about the build badge for the build project.

" }, "buildBatchConfig": { "$ref": "#/definitions/ProjectBuildBatchConfig", "description": "

A ProjectBuildBatchConfig object that defines the batch build options for the project.

" }, "cache": { "$ref": "#/definitions/ProjectCache", "description": "

Information about the cache for the build project.

" }, "concurrentBuildLimit": { "type": "integer", "format": "int32", "description": "

The maximum number of concurrent builds that are allowed for this project.

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.

" }, "created": { "type": "string", "format": "date-time", "description": "

When the build project was created, expressed in Unix time format.

" }, "description": { "type": "string", "description": "

A description that makes the build project easy to identify.

" }, "encryptionKey": { "type": "string", "description": "

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).

" }, "environment": { "$ref": "#/definitions/ProjectEnvironment", "description": "

Information about the build environment for this build project.

" }, "fileSystemLocations": { "type": "array", "description": "

An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

", "items": { "$ref": "#/definitions/ProjectFileSystemLocation" }, "x-ms-identifiers": [] }, "lastModified": { "type": "string", "format": "date-time", "description": "

When the build project's settings were last modified, expressed in Unix time format.

" }, "logsConfig": { "$ref": "#/definitions/LogsConfig", "description": "

Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.

" }, "name": { "type": "string", "description": "

The name of the build project.

" }, "projectVisibility": { "$ref": "#/definitions/ProjectVisibilityTypeEnumValue", "description": "Property projectVisibility" }, "publicProjectAlias": { "type": "string", "description": "

Contains the project identifier used with the public build APIs.

" }, "queuedTimeoutInMinutes": { "type": "integer", "format": "int32", "description": "

The number of minutes a build is allowed to be queued before it times out.

" }, "resourceAccessRole": { "type": "string", "description": "

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

" }, "secondaryArtifacts": { "type": "array", "description": "

An array of ProjectArtifacts objects.

", "items": { "$ref": "#/definitions/ProjectArtifacts" }, "x-ms-identifiers": [] }, "secondarySourceVersions": { "type": "array", "description": "

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

", "items": { "$ref": "#/definitions/ProjectSourceVersion" }, "x-ms-identifiers": [] }, "secondarySources": { "type": "array", "description": "

An array of ProjectSource objects.

", "items": { "$ref": "#/definitions/ProjectSource" }, "x-ms-identifiers": [] }, "serviceRole": { "type": "string", "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.

" }, "source": { "$ref": "#/definitions/ProjectSource", "description": "

Information about the build input source code for this build project.

" }, "sourceVersion": { "type": "string", "description": "

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:

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

" }, "tags": { "type": "array", "description": "

A list of tag key and value pairs associated with this build project.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

", "items": { "$ref": "#/definitions/Tag" }, "x-ms-identifiers": [] }, "timeoutInMinutes": { "type": "integer", "format": "int32", "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.

" }, "vpcConfig": { "$ref": "#/definitions/VpcConfig", "description": "

Information about the VPC configuration that CodeBuild accesses.

" }, "webhook": { "$ref": "#/definitions/Webhook", "description": "

Information about a webhook that connects repository events to a build project in CodeBuild.

" } } }, "BatchReportModeType": { "type": "string", "description": "BatchReportModeType enum", "enum": [ "REPORT_AGGREGATED_BATCH", "REPORT_INDIVIDUAL_BUILDS" ], "x-ms-enum": { "name": "BatchReportModeType", "modelAsString": true, "values": [ { "name": "REPORT_AGGREGATED_BATCH", "value": "REPORT_AGGREGATED_BATCH", "description": "BatchReportModeType enum REPORT_AGGREGATED_BATCH" }, { "name": "REPORT_INDIVIDUAL_BUILDS", "value": "REPORT_INDIVIDUAL_BUILDS", "description": "BatchReportModeType enum REPORT_INDIVIDUAL_BUILDS" } ] } }, "BatchReportModeTypeEnumValue": { "type": "object", "description": "Definition of BatchReportModeTypeEnumValue", "properties": { "value": { "$ref": "#/definitions/BatchReportModeType", "description": "Property value" } } }, "BatchRestrictions": { "type": "object", "description": "Definition of BatchRestrictions", "properties": { "computeTypesAllowed": { "type": "array", "description": "

An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the CodeBuild User Guide for these values.

", "items": { "type": "string" } }, "maximumBuildsAllowed": { "type": "integer", "format": "int32", "description": "

Specifies the maximum number of builds allowed.

" } } }, "BucketOwnerAccess": { "type": "string", "description": "BucketOwnerAccess enum", "enum": [ "FULL", "NONE", "READ_ONLY" ], "x-ms-enum": { "name": "BucketOwnerAccess", "modelAsString": true, "values": [ { "name": "FULL", "value": "FULL", "description": "BucketOwnerAccess enum FULL" }, { "name": "NONE", "value": "NONE", "description": "BucketOwnerAccess enum NONE" }, { "name": "READ_ONLY", "value": "READ_ONLY", "description": "BucketOwnerAccess enum READ_ONLY" } ] } }, "BucketOwnerAccessEnumValue": { "type": "object", "description": "Definition of BucketOwnerAccessEnumValue", "properties": { "value": { "$ref": "#/definitions/BucketOwnerAccess", "description": "Property value" } } }, "BuildStatusConfig": { "type": "object", "description": "Definition of BuildStatusConfig", "properties": { "context": { "type": "string", "description": "

Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.

Bitbucket

This parameter is used for the name parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.

GitHub/GitHub Enterprise Server

This parameter is used for the context parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.

" }, "targetUrl": { "type": "string", "description": "

Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.

Bitbucket

This parameter is used for the url parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.

GitHub/GitHub Enterprise Server

This parameter is used for the target_url parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.

" } } }, "CacheMode": { "type": "string", "description": "CacheMode enum", "enum": [ "LOCAL_CUSTOM_CACHE", "LOCAL_DOCKER_LAYER_CACHE", "LOCAL_SOURCE_CACHE" ], "x-ms-enum": { "name": "CacheMode", "modelAsString": true, "values": [ { "name": "LOCAL_CUSTOM_CACHE", "value": "LOCAL_CUSTOM_CACHE", "description": "CacheMode enum LOCAL_CUSTOM_CACHE" }, { "name": "LOCAL_DOCKER_LAYER_CACHE", "value": "LOCAL_DOCKER_LAYER_CACHE", "description": "CacheMode enum LOCAL_DOCKER_LAYER_CACHE" }, { "name": "LOCAL_SOURCE_CACHE", "value": "LOCAL_SOURCE_CACHE", "description": "CacheMode enum LOCAL_SOURCE_CACHE" } ] } }, "CacheModeEnumValue": { "type": "object", "description": "Definition of CacheModeEnumValue", "properties": { "value": { "$ref": "#/definitions/CacheMode", "description": "Property value" } } }, "CacheType": { "type": "string", "description": "CacheType enum", "enum": [ "LOCAL", "NO_CACHE", "S3" ], "x-ms-enum": { "name": "CacheType", "modelAsString": true, "values": [ { "name": "LOCAL", "value": "LOCAL", "description": "CacheType enum LOCAL" }, { "name": "NO_CACHE", "value": "NO_CACHE", "description": "CacheType enum NO_CACHE" }, { "name": "S3", "value": "S3", "description": "CacheType enum S3" } ] } }, "CacheTypeEnumValue": { "type": "object", "description": "Definition of CacheTypeEnumValue", "properties": { "value": { "$ref": "#/definitions/CacheType", "description": "Property value" } } }, "CloudWatchLogsConfig": { "type": "object", "description": "Definition of CloudWatchLogsConfig", "properties": { "groupName": { "type": "string", "description": "

The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.

" }, "status": { "$ref": "#/definitions/LogsConfigStatusTypeEnumValue", "description": "

The current status of the logs in CloudWatch Logs for a build project. Valid values are:

" }, "streamName": { "type": "string", "description": "

The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.

" } } }, "CodeBuildProject": { "type": "object", "description": "A Microsoft.AwsConnector resource", "properties": { "properties": { "$ref": "#/definitions/CodeBuildProjectProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "CodeBuildProjectListResult": { "type": "object", "description": "The response of a CodeBuildProject list operation.", "properties": { "value": { "type": "array", "description": "The CodeBuildProject items on this page", "items": { "$ref": "#/definitions/CodeBuildProject" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "CodeBuildProjectProperties": { "type": "object", "description": "Definition of CodeBuildProject", "properties": { "awsProperties": { "$ref": "#/definitions/AwsCodeBuildProjectProperties", "description": "AWS Properties" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsTags": { "type": "object", "description": "AWS Tags", "additionalProperties": { "type": "string" } }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation.", "readOnly": true } } }, "CodeBuildProjectTagsUpdate": { "type": "object", "description": "The type used for updating tags in CodeBuildProject resources.", "properties": { "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } } }, "ComputeType": { "type": "string", "description": "ComputeType enum", "enum": [ "BUILD_GENERAL1_2XLARGE", "BUILD_GENERAL1_LARGE", "BUILD_GENERAL1_MEDIUM", "BUILD_GENERAL1_SMALL", "BUILD_GENERAL1_XLARGE", "BUILD_LAMBDA_10GB", "BUILD_LAMBDA_1GB", "BUILD_LAMBDA_2GB", "BUILD_LAMBDA_4GB", "BUILD_LAMBDA_8GB" ], "x-ms-enum": { "name": "ComputeType", "modelAsString": true, "values": [ { "name": "BUILD_GENERAL1_2XLARGE", "value": "BUILD_GENERAL1_2XLARGE", "description": "ComputeType enum BUILD_GENERAL1_2XLARGE" }, { "name": "BUILD_GENERAL1_LARGE", "value": "BUILD_GENERAL1_LARGE", "description": "ComputeType enum BUILD_GENERAL1_LARGE" }, { "name": "BUILD_GENERAL1_MEDIUM", "value": "BUILD_GENERAL1_MEDIUM", "description": "ComputeType enum BUILD_GENERAL1_MEDIUM" }, { "name": "BUILD_GENERAL1_SMALL", "value": "BUILD_GENERAL1_SMALL", "description": "ComputeType enum BUILD_GENERAL1_SMALL" }, { "name": "BUILD_GENERAL1_XLARGE", "value": "BUILD_GENERAL1_XLARGE", "description": "ComputeType enum BUILD_GENERAL1_XLARGE" }, { "name": "BUILD_LAMBDA_10GB", "value": "BUILD_LAMBDA_10GB", "description": "ComputeType enum BUILD_LAMBDA_10GB" }, { "name": "BUILD_LAMBDA_1GB", "value": "BUILD_LAMBDA_1GB", "description": "ComputeType enum BUILD_LAMBDA_1GB" }, { "name": "BUILD_LAMBDA_2GB", "value": "BUILD_LAMBDA_2GB", "description": "ComputeType enum BUILD_LAMBDA_2GB" }, { "name": "BUILD_LAMBDA_4GB", "value": "BUILD_LAMBDA_4GB", "description": "ComputeType enum BUILD_LAMBDA_4GB" }, { "name": "BUILD_LAMBDA_8GB", "value": "BUILD_LAMBDA_8GB", "description": "ComputeType enum BUILD_LAMBDA_8GB" } ] } }, "ComputeTypeEnumValue": { "type": "object", "description": "Definition of ComputeTypeEnumValue", "properties": { "value": { "$ref": "#/definitions/ComputeType", "description": "Property value" } } }, "CredentialProviderType": { "type": "string", "description": "CredentialProviderType enum", "enum": [ "SECRETS_MANAGER" ], "x-ms-enum": { "name": "CredentialProviderType", "modelAsString": true, "values": [ { "name": "SECRETS_MANAGER", "value": "SECRETS_MANAGER", "description": "CredentialProviderType enum SECRETS_MANAGER" } ] } }, "CredentialProviderTypeEnumValue": { "type": "object", "description": "Definition of CredentialProviderTypeEnumValue", "properties": { "value": { "$ref": "#/definitions/CredentialProviderType", "description": "Property value" } } }, "EnvironmentType": { "type": "string", "description": "EnvironmentType enum", "enum": [ "ARM_CONTAINER", "ARM_LAMBDA_CONTAINER", "LINUX_CONTAINER", "LINUX_GPU_CONTAINER", "LINUX_LAMBDA_CONTAINER", "WINDOWS_CONTAINER", "WINDOWS_SERVER_2019_CONTAINER" ], "x-ms-enum": { "name": "EnvironmentType", "modelAsString": true, "values": [ { "name": "ARM_CONTAINER", "value": "ARM_CONTAINER", "description": "EnvironmentType enum ARM_CONTAINER" }, { "name": "ARM_LAMBDA_CONTAINER", "value": "ARM_LAMBDA_CONTAINER", "description": "EnvironmentType enum ARM_LAMBDA_CONTAINER" }, { "name": "LINUX_CONTAINER", "value": "LINUX_CONTAINER", "description": "EnvironmentType enum LINUX_CONTAINER" }, { "name": "LINUX_GPU_CONTAINER", "value": "LINUX_GPU_CONTAINER", "description": "EnvironmentType enum LINUX_GPU_CONTAINER" }, { "name": "LINUX_LAMBDA_CONTAINER", "value": "LINUX_LAMBDA_CONTAINER", "description": "EnvironmentType enum LINUX_LAMBDA_CONTAINER" }, { "name": "WINDOWS_CONTAINER", "value": "WINDOWS_CONTAINER", "description": "EnvironmentType enum WINDOWS_CONTAINER" }, { "name": "WINDOWS_SERVER_2019_CONTAINER", "value": "WINDOWS_SERVER_2019_CONTAINER", "description": "EnvironmentType enum WINDOWS_SERVER_2019_CONTAINER" } ] } }, "EnvironmentTypeEnumValue": { "type": "object", "description": "Definition of EnvironmentTypeEnumValue", "properties": { "value": { "$ref": "#/definitions/EnvironmentType", "description": "Property value" } } }, "EnvironmentVariable": { "type": "object", "description": "Definition of EnvironmentVariable", "properties": { "name": { "type": "string", "description": "

The name or key of the environment variable.

" }, "type": { "$ref": "#/definitions/EnvironmentVariableTypeEnumValue", "description": "

The type of environment variable. Valid values include:

" }, "value": { "type": "string", "description": "

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs. PLAINTEXT 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 PARAMETER_STORE or SECRETS_MANAGER.

" } } }, "EnvironmentVariableType": { "type": "string", "description": "EnvironmentVariableType enum", "enum": [ "PARAMETER_STORE", "PLAINTEXT", "SECRETS_MANAGER" ], "x-ms-enum": { "name": "EnvironmentVariableType", "modelAsString": true, "values": [ { "name": "PARAMETER_STORE", "value": "PARAMETER_STORE", "description": "EnvironmentVariableType enum PARAMETER_STORE" }, { "name": "PLAINTEXT", "value": "PLAINTEXT", "description": "EnvironmentVariableType enum PLAINTEXT" }, { "name": "SECRETS_MANAGER", "value": "SECRETS_MANAGER", "description": "EnvironmentVariableType enum SECRETS_MANAGER" } ] } }, "EnvironmentVariableTypeEnumValue": { "type": "object", "description": "Definition of EnvironmentVariableTypeEnumValue", "properties": { "value": { "$ref": "#/definitions/EnvironmentVariableType", "description": "Property value" } } }, "FileSystemType": { "type": "string", "description": "FileSystemType enum", "enum": [ "EFS" ], "x-ms-enum": { "name": "FileSystemType", "modelAsString": true, "values": [ { "name": "EFS", "value": "EFS", "description": "FileSystemType enum EFS" } ] } }, "FileSystemTypeEnumValue": { "type": "object", "description": "Definition of FileSystemTypeEnumValue", "properties": { "value": { "$ref": "#/definitions/FileSystemType", "description": "Property value" } } }, "FilterGroup": { "type": "object", "description": "Definition of FilterGroup", "properties": { "webhookFilter": { "$ref": "#/definitions/WebhookFilter", "description": "Property webhookFilter" } } }, "GitSubmodulesConfig": { "type": "object", "description": "Definition of GitSubmodulesConfig", "properties": { "fetchSubmodules": { "type": "boolean", "description": "

Set to true to fetch Git submodules for your CodeBuild build project.

" } } }, "ImagePullCredentialsType": { "type": "string", "description": "ImagePullCredentialsType enum", "enum": [ "CODEBUILD", "SERVICE_ROLE" ], "x-ms-enum": { "name": "ImagePullCredentialsType", "modelAsString": true, "values": [ { "name": "CODEBUILD", "value": "CODEBUILD", "description": "ImagePullCredentialsType enum CODEBUILD" }, { "name": "SERVICE_ROLE", "value": "SERVICE_ROLE", "description": "ImagePullCredentialsType enum SERVICE_ROLE" } ] } }, "ImagePullCredentialsTypeEnumValue": { "type": "object", "description": "Definition of ImagePullCredentialsTypeEnumValue", "properties": { "value": { "$ref": "#/definitions/ImagePullCredentialsType", "description": "Property value" } } }, "LogsConfig": { "type": "object", "description": "Definition of LogsConfig", "properties": { "cloudWatchLogs": { "$ref": "#/definitions/CloudWatchLogsConfig", "description": "

Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.

" }, "s3Logs": { "$ref": "#/definitions/S3LogsConfig", "description": "

Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.

" } } }, "LogsConfigStatusType": { "type": "string", "description": "LogsConfigStatusType enum", "enum": [ "DISABLED", "ENABLED" ], "x-ms-enum": { "name": "LogsConfigStatusType", "modelAsString": true, "values": [ { "name": "DISABLED", "value": "DISABLED", "description": "LogsConfigStatusType enum DISABLED" }, { "name": "ENABLED", "value": "ENABLED", "description": "LogsConfigStatusType enum ENABLED" } ] } }, "LogsConfigStatusTypeEnumValue": { "type": "object", "description": "Definition of LogsConfigStatusTypeEnumValue", "properties": { "value": { "$ref": "#/definitions/LogsConfigStatusType", "description": "Property value" } } }, "ProjectArtifacts": { "type": "object", "description": "Definition of ProjectArtifacts", "properties": { "artifactIdentifier": { "type": "string", "description": "

An identifier for this artifact definition.

" }, "bucketOwnerAccess": { "$ref": "#/definitions/BucketOwnerAccessEnumValue", "description": "Property bucketOwnerAccess" }, "encryptionDisabled": { "type": "boolean", "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.

" }, "location": { "type": "string", "description": "

Information about the build output artifact location:

" }, "name": { "type": "string", "description": "

Along with path and namespaceType, the pattern that CodeBuild uses to name and store the output artifact:

For example:

" }, "namespaceType": { "$ref": "#/definitions/ArtifactNamespaceEnumValue", "description": "

Along with path and name, the pattern that CodeBuild uses to determine the name and location to store the output artifact:

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

" }, "overrideArtifactName": { "type": "boolean", "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.

" }, "packaging": { "$ref": "#/definitions/ArtifactPackagingEnumValue", "description": "

The type of build output artifact to create:

" }, "path": { "type": "string", "description": "

Along with namespaceType and name, the pattern that CodeBuild uses to name and store the output artifact:

For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.

" }, "type": { "$ref": "#/definitions/ArtifactsTypeEnumValue", "description": "

The type of build output artifact. Valid values include:

" } } }, "ProjectBadge": { "type": "object", "description": "Definition of ProjectBadge", "properties": { "badgeEnabled": { "type": "boolean", "description": "

Set this to true to generate a publicly accessible URL for your project's build badge.

" }, "badgeRequestUrl": { "type": "string", "description": "

The publicly-accessible URL through which you can access the build badge for your project.

" } } }, "ProjectBuildBatchConfig": { "type": "object", "description": "Definition of ProjectBuildBatchConfig", "properties": { "batchReportMode": { "$ref": "#/definitions/BatchReportModeTypeEnumValue", "description": "

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.

REPORT_AGGREGATED_BATCH

(Default) Aggregate all of the build statuses into a single status report.

REPORT_INDIVIDUAL_BUILDS

Send a separate status report for each individual build.

" }, "combineArtifacts": { "type": "boolean", "description": "

Specifies if the build artifacts for the batch build should be combined into a single artifact location.

" }, "restrictions": { "$ref": "#/definitions/BatchRestrictions", "description": "

A BatchRestrictions object that specifies the restrictions for the batch build.

" }, "serviceRole": { "type": "string", "description": "

Specifies the service role ARN for the batch build project.

" }, "timeoutInMins": { "type": "integer", "format": "int32", "description": "

Specifies the maximum amount of time, in minutes, that the batch build must be completed in.

" } } }, "ProjectCache": { "type": "object", "description": "Definition of ProjectCache", "properties": { "location": { "type": "string", "description": "

Information about the cache location:

" }, "modes": { "type": "array", "description": "

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 LOCAL cache types.

Possible values are:

LOCAL_SOURCE_CACHE

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.

LOCAL_DOCKER_LAYER_CACHE

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.

  • You can use a Docker layer cache in the Linux environment only.

  • The privileged flag must be set so that your project has the required Docker permissions.

  • You should consider the security implications before you use a Docker layer cache.

LOCAL_CUSTOM_CACHE

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:

", "items": { "$ref": "#/definitions/CacheMode" } }, "type": { "$ref": "#/definitions/CacheTypeEnumValue", "description": "

The type of cache used by the build project. Valid values include:

" } } }, "ProjectEnvironment": { "type": "object", "description": "Definition of ProjectEnvironment", "properties": { "certificate": { "type": "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 certificate in the CodeBuild User Guide.

" }, "computeType": { "$ref": "#/definitions/ComputeTypeEnumValue", "description": "

Information about the compute resources the build project uses. Available values include:

If you use BUILD_GENERAL1_SMALL:

If you use BUILD_GENERAL1_LARGE:

If you're using compute fleets during project creation, computeType will be ignored.

For more information, see Build Environment Compute Types in the CodeBuild User Guide.

" }, "environmentVariables": { "type": "array", "description": "

A set of environment variables to make available to builds for this build project.

", "items": { "$ref": "#/definitions/EnvironmentVariable" }, "x-ms-identifiers": [] }, "fleet": { "$ref": "#/definitions/ProjectFleet", "description": "

A ProjectFleet object to use for this build project.

" }, "image": { "type": "string", "description": "

The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:

For more information, see Docker images provided by CodeBuild in the CodeBuild user guide.

" }, "imagePullCredentialsType": { "$ref": "#/definitions/ImagePullCredentialsTypeEnumValue", "description": "

The type of credentials CodeBuild uses to pull images in your build. There are two valid values:

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.

" }, "privilegedMode": { "type": "boolean", "description": "

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 false.

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:

If the operating system's base image is Ubuntu Linux:

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

- timeout 15 sh -c 'until docker info; do echo .; sleep 1; done'

If the operating system's base image is Alpine Linux and the previous command does not work, add the -t argument to timeout:

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

- timeout -t 15 sh -c 'until docker info; do echo .; sleep 1; done'

" }, "registryCredential": { "$ref": "#/definitions/RegistryCredential", "description": "

The credentials for access to a private registry.

" }, "type": { "$ref": "#/definitions/EnvironmentTypeEnumValue", "description": "

The type of build environment to use for related builds.

If you're using compute fleets during project creation, type will be ignored.

For more information, see Build environment compute types in the CodeBuild user guide.

" } } }, "ProjectFileSystemLocation": { "type": "object", "description": "Definition of ProjectFileSystemLocation", "properties": { "identifier": { "type": "string", "description": "

The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the identifier in all capital letters to CODEBUILD_. For example, if you specify my_efs for identifier, a new environment variable is create named CODEBUILD_MY_EFS.

The identifier is used to mount your file system.

" }, "location": { "type": "string", "description": "

A string that specifies the location of the file system created by Amazon EFS. Its format is efs-dns-name:/directory-path. 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 fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory is my-efs-mount-directory, then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.

The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.

" }, "mountOptions": { "type": "string", "description": "

The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options.

" }, "mountPoint": { "type": "string", "description": "

The location in the container where you mount the file system.

" }, "type": { "$ref": "#/definitions/FileSystemTypeEnumValue", "description": "

The type of the file system. The one supported type is EFS.

" } } }, "ProjectFleet": { "type": "object", "description": "Definition of ProjectFleet", "properties": { "fleetArn": { "type": "string", "description": "

Specifies the compute fleet ARN for the build project.

" } } }, "ProjectSource": { "type": "object", "description": "Definition of ProjectSource", "properties": { "auth": { "$ref": "#/definitions/SourceAuth", "description": "

Information about the authorization settings for CodeBuild to access the source code to be built.

This information is for the CodeBuild console's use only. Your code should not get or set this information directly.

" }, "buildStatusConfig": { "$ref": "#/definitions/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 GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

" }, "buildspec": { "type": "string", "description": "

The buildspec file declaration to use for the builds in this build project.

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 CODEBUILD_SRC_DIR 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, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). 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 Buildspec File Name and Storage Location.

" }, "gitCloneDepth": { "type": "integer", "format": "int32", "description": "

Information about the Git clone depth for the build project.

" }, "gitSubmodulesConfig": { "$ref": "#/definitions/GitSubmodulesConfig", "description": "

Information about the Git submodules configuration for the build project.

" }, "insecureSsl": { "type": "boolean", "description": "

Enable this flag to ignore SSL warnings while connecting to the project source code.

" }, "location": { "type": "string", "description": "

Information about the location of the source code to be built. Valid values include:

If you specify CODEPIPELINE for the Type property, don't specify this property. For all of the other types, you must specify Location.

" }, "reportBuildStatus": { "type": "boolean", "description": "

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, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown.

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 Source provider access in the CodeBuild User Guide.

The status of a build triggered by a webhook is always reported to your source provider.

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.

" }, "sourceIdentifier": { "type": "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.

" }, "type": { "$ref": "#/definitions/SourceTypeEnumValue", "description": "

The type of repository that contains the source code to be built. Valid values include:

" } } }, "ProjectSourceVersion": { "type": "object", "description": "Definition of ProjectSourceVersion", "properties": { "sourceIdentifier": { "type": "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": { "type": "string", "description": "

The source version for the corresponding source identifier. If specified, must be one of:

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

" } } }, "ProjectVisibilityType": { "type": "string", "description": "ProjectVisibilityType enum", "enum": [ "PRIVATE", "PUBLIC_READ" ], "x-ms-enum": { "name": "ProjectVisibilityType", "modelAsString": true, "values": [ { "name": "PRIVATE", "value": "PRIVATE", "description": "ProjectVisibilityType enum PRIVATE" }, { "name": "PUBLIC_READ", "value": "PUBLIC_READ", "description": "ProjectVisibilityType enum PUBLIC_READ" } ] } }, "ProjectVisibilityTypeEnumValue": { "type": "object", "description": "Definition of ProjectVisibilityTypeEnumValue", "properties": { "value": { "$ref": "#/definitions/ProjectVisibilityType", "description": "Property value" } } }, "ProvisioningState": { "type": "string", "description": "The provisioning state of a resource.", "enum": [ "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Resource has been created." }, { "name": "Failed", "value": "Failed", "description": "Resource creation failed." }, { "name": "Canceled", "value": "Canceled", "description": "Resource creation was canceled." }, { "name": "Provisioning", "value": "Provisioning", "description": "The resource is being provisioned" }, { "name": "Updating", "value": "Updating", "description": "The resource is updating" }, { "name": "Deleting", "value": "Deleting", "description": "The resource is being deleted" }, { "name": "Accepted", "value": "Accepted", "description": "The resource create request has been accepted" } ] }, "readOnly": true }, "RegistryCredential": { "type": "object", "description": "Definition of RegistryCredential", "properties": { "credential": { "type": "string", "description": "

The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager.

The credential can use the name of the credentials only if they exist in your current Amazon Web Services Region.

" }, "credentialProvider": { "$ref": "#/definitions/CredentialProviderTypeEnumValue", "description": "

The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager.

" } } }, "S3LogsConfig": { "type": "object", "description": "Definition of S3LogsConfig", "properties": { "bucketOwnerAccess": { "$ref": "#/definitions/BucketOwnerAccessEnumValue", "description": "Property bucketOwnerAccess" }, "encryptionDisabled": { "type": "boolean", "description": "

Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.

" }, "location": { "type": "string", "description": "

The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket, and your path prefix is build-log, then acceptable formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log.

" }, "status": { "$ref": "#/definitions/LogsConfigStatusTypeEnumValue", "description": "

The current status of the S3 build logs. Valid values are:

" } } }, "SourceAuth": { "type": "object", "description": "Definition of SourceAuth", "properties": { "resource": { "type": "string", "description": "

The resource value that applies to the specified authorization type.

" }, "type": { "$ref": "#/definitions/SourceAuthTypeEnumValue", "description": "

The authorization type to use. Valid options are OAUTH or CODECONNECTIONS.

" } } }, "SourceAuthType": { "type": "string", "description": "SourceAuthType enum", "enum": [ "CODECONNECTIONS", "OAUTH" ], "x-ms-enum": { "name": "SourceAuthType", "modelAsString": true, "values": [ { "name": "CODECONNECTIONS", "value": "CODECONNECTIONS", "description": "SourceAuthType enum CODECONNECTIONS" }, { "name": "OAUTH", "value": "OAUTH", "description": "SourceAuthType enum OAUTH" } ] } }, "SourceAuthTypeEnumValue": { "type": "object", "description": "Definition of SourceAuthTypeEnumValue", "properties": { "value": { "$ref": "#/definitions/SourceAuthType", "description": "Property value" } } }, "SourceType": { "type": "string", "description": "SourceType enum", "enum": [ "BITBUCKET", "CODECOMMIT", "CODEPIPELINE", "GITHUB", "GITHUB_ENTERPRISE", "GITLAB", "GITLAB_SELF_MANAGED", "NO_SOURCE", "S3" ], "x-ms-enum": { "name": "SourceType", "modelAsString": true, "values": [ { "name": "BITBUCKET", "value": "BITBUCKET", "description": "SourceType enum BITBUCKET" }, { "name": "CODECOMMIT", "value": "CODECOMMIT", "description": "SourceType enum CODECOMMIT" }, { "name": "CODEPIPELINE", "value": "CODEPIPELINE", "description": "SourceType enum CODEPIPELINE" }, { "name": "GITHUB", "value": "GITHUB", "description": "SourceType enum GITHUB" }, { "name": "GITHUB_ENTERPRISE", "value": "GITHUB_ENTERPRISE", "description": "SourceType enum GITHUB_ENTERPRISE" }, { "name": "GITLAB", "value": "GITLAB", "description": "SourceType enum GITLAB" }, { "name": "GITLAB_SELF_MANAGED", "value": "GITLAB_SELF_MANAGED", "description": "SourceType enum GITLAB_SELF_MANAGED" }, { "name": "NO_SOURCE", "value": "NO_SOURCE", "description": "SourceType enum NO_SOURCE" }, { "name": "S3", "value": "S3", "description": "SourceType enum S3" } ] } }, "SourceTypeEnumValue": { "type": "object", "description": "Definition of SourceTypeEnumValue", "properties": { "value": { "$ref": "#/definitions/SourceType", "description": "Property value" } } }, "Tag": { "type": "object", "description": "Definition of Tag", "properties": { "key": { "type": "string", "description": "

The tag's key.

" }, "value": { "type": "string", "description": "

The tag's value.

" } } }, "VpcConfig": { "type": "object", "description": "Definition of VpcConfig", "properties": { "securityGroupIds": { "type": "array", "description": "

A list of one or more security groups IDs in your Amazon VPC.

", "items": { "type": "string" } }, "subnets": { "type": "array", "description": "

A list of one or more subnet IDs in your Amazon VPC.

", "items": { "type": "string" } }, "vpcId": { "type": "string", "description": "

The ID of the Amazon VPC.

" } } }, "Webhook": { "type": "object", "description": "Definition of Webhook", "properties": { "branchFilter": { "type": "string", "description": "

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 branchFilter is empty, then all branches are built.

It is recommended that you use filterGroups instead of branchFilter.

" }, "buildType": { "$ref": "#/definitions/WebhookBuildTypeEnumValue", "description": "

Specifies the type of build this webhook will trigger.

" }, "filterGroups": { "type": "array", "description": "

An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.

For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.

", "items": { "$ref": "#/definitions/FilterGroup" }, "x-ms-identifiers": [] }, "lastModifiedSecret": { "type": "string", "format": "date-time", "description": "

A timestamp that indicates the last time a repository's secret token was modified.

" }, "payloadUrl": { "type": "string", "description": "

The CodeBuild endpoint where webhook events are sent.

" }, "secret": { "type": "string", "description": "

The secret token of the associated repository.

A Bitbucket webhook does not support secret.

" }, "url": { "type": "string", "description": "

The URL to the webhook.

" } } }, "WebhookBuildType": { "type": "string", "description": "WebhookBuildType enum", "enum": [ "BUILD", "BUILD_BATCH" ], "x-ms-enum": { "name": "WebhookBuildType", "modelAsString": true, "values": [ { "name": "BUILD", "value": "BUILD", "description": "WebhookBuildType enum BUILD" }, { "name": "BUILD_BATCH", "value": "BUILD_BATCH", "description": "WebhookBuildType enum BUILD_BATCH" } ] } }, "WebhookBuildTypeEnumValue": { "type": "object", "description": "Definition of WebhookBuildTypeEnumValue", "properties": { "value": { "$ref": "#/definitions/WebhookBuildType", "description": "Property value" } } }, "WebhookFilter": { "type": "object", "description": "Definition of WebhookFilter", "properties": { "excludeMatchedPattern": { "type": "boolean", "description": "

Used to indicate that the pattern determines which webhook events do not trigger a build. If true, then a webhook event that does not match the pattern triggers a build. If false, then a webhook event that matches the pattern triggers a build.

" }, "pattern": { "type": "string", "description": "

For a WebHookFilter that uses EVENT type, a comma-separated string that specifies one or more events. For example, the webhook filter PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED allows all push, pull request created, and pull request updated events to trigger a build.

For a WebHookFilter that uses any of the other filter types, a regular expression pattern. For example, a WebHookFilter that uses HEAD_REF for its type and the pattern ^refs/heads/ triggers a build when the head reference is a branch with a reference name refs/heads/branch-name.

" }, "type": { "$ref": "#/definitions/WebhookFilterTypeEnumValue", "description": "

The type of webhook filter. There are nine webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH, COMMIT_MESSAGE, TAG_NAME, RELEASE_NAME, and WORKFLOW_NAME.

" } } }, "WebhookFilterType": { "type": "string", "description": "WebhookFilterType enum", "enum": [ "ACTOR_ACCOUNT_ID", "BASE_REF", "COMMIT_MESSAGE", "EVENT", "FILE_PATH", "HEAD_REF", "RELEASE_NAME", "TAG_NAME", "WORKFLOW_NAME" ], "x-ms-enum": { "name": "WebhookFilterType", "modelAsString": true, "values": [ { "name": "ACTOR_ACCOUNT_ID", "value": "ACTOR_ACCOUNT_ID", "description": "WebhookFilterType enum ACTOR_ACCOUNT_ID" }, { "name": "BASE_REF", "value": "BASE_REF", "description": "WebhookFilterType enum BASE_REF" }, { "name": "COMMIT_MESSAGE", "value": "COMMIT_MESSAGE", "description": "WebhookFilterType enum COMMIT_MESSAGE" }, { "name": "EVENT", "value": "EVENT", "description": "WebhookFilterType enum EVENT" }, { "name": "FILE_PATH", "value": "FILE_PATH", "description": "WebhookFilterType enum FILE_PATH" }, { "name": "HEAD_REF", "value": "HEAD_REF", "description": "WebhookFilterType enum HEAD_REF" }, { "name": "RELEASE_NAME", "value": "RELEASE_NAME", "description": "WebhookFilterType enum RELEASE_NAME" }, { "name": "TAG_NAME", "value": "TAG_NAME", "description": "WebhookFilterType enum TAG_NAME" }, { "name": "WORKFLOW_NAME", "value": "WORKFLOW_NAME", "description": "WebhookFilterType enum WORKFLOW_NAME" } ] } }, "WebhookFilterTypeEnumValue": { "type": "object", "description": "Definition of WebhookFilterTypeEnumValue", "properties": { "value": { "$ref": "#/definitions/WebhookFilterType", "description": "Property value" } } } }, "parameters": {} }