Crear el archivo JSON Especifique el archivo JSON Creación del proyecto

Crear un proyecto de compilación (AWS CLI)

Para obtener más información sobre el usoAWS CLI de CodeBuild, consulteReferencia de la línea de comandos.

Para crear un proyecto de CodeBuild compilación mediante elAWS CLI, cree una estructura de proyecto con formato JSON, rellene la estructura y ejecute el create-projectcomando para crear el proyecto.

Crear el archivo JSON

Cree un archivo JSON básico con el create-projectcomando, mediante la--generate-cli-skeleton opción:


aws codebuild create-project --generate-cli-skeleton > <json-file>

Esto crea un archivo JSON con la ruta y el nombre de archivo especificados por<json-file>.

Especifique el archivo JSON

Modifique los datos JSON de la siguiente manera y guarde los resultados.


{
  "name": "<project-name>",
  "description": "<description>",
  "source": {
    "type": "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "BITBUCKET" | "S3" | "NO_SOURCE",
    "location": "<source-location>",
    "gitCloneDepth": "<git-clone-depth>",
    "buildspec": "<buildspec>",
    "InsecureSsl": "<insecure-ssl>",
    "reportBuildStatus": "<report-build-status>",
    "buildStatusConfig": {
      "context": "<context>",
      "targetUrl": "<target-url>"
    },
    "gitSubmodulesConfig": {
      "fetchSubmodules": "<fetch-submodules>"
    },
    "auth": {
      "type": "<auth-type>",
      "resource": "<auth-resource>"
    },
    "sourceIdentifier": "<source-identifier>"
  },
  "secondarySources": [
    {
        "type": "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "BITBUCKET" | "S3" | "NO_SOURCE",
        "location": "<source-location>",
        "gitCloneDepth": "<git-clone-depth>",
        "buildspec": "<buildspec>",
        "InsecureSsl": "<insecure-ssl>",
        "reportBuildStatus": "<report-build-status>",
        "auth": {
          "type": "<auth-type>",
          "resource": "<auth-resource>"
        },
        "sourceIdentifier": "<source-identifier>"
    }
  ],
  "secondarySourceVersions": [
    {
      "sourceIdentifier": "<secondary-source-identifier>",
      "sourceVersion": "<secondary-source-version>"
    }
  ],
  "sourceVersion": "<source-version>",
  "artifacts": {
    "type": "CODEPIPELINE" | "S3" | "NO_ARTIFACTS",
    "location": "<artifacts-location>",
    "path": "<artifacts-path>",
    "namespaceType": "<artifacts-namespacetype>",
    "name": "<artifacts-name>",
    "overrideArtifactName": "<override-artifact-name>",
    "packaging": "<artifacts-packaging>"
  },
  "secondaryArtifacts": [
    {
      "type": "CODEPIPELINE" | "S3" | "NO_ARTIFACTS",
      "location": "<secondary-artifact-location>",
      "path": "<secondary-artifact-path>",
      "namespaceType": "<secondary-artifact-namespaceType>",
      "name": "<secondary-artifact-name>",
      "packaging": "<secondary-artifact-packaging>",
      "artifactIdentifier": "<secondary-artifact-identifier>"
    }
  ],
  "cache": {
    "type": "<cache-type>",
    "location": "<cache-location>",
    "mode": [
      "<cache-mode>"
    ]
  },
  "environment": {
    "type": "LINUX_CONTAINER" | "LINUX_GPU_CONTAINER" | "ARM_CONTAINER" | "WINDOWS_SERVER_2019_CONTAINER",
    "image": "<image>",
    "computeType": "BUILD_GENERAL1_SMALL" | "BUILD_GENERAL1_MEDIUM" | "BUILD_GENERAL1_LARGE" | "BUILD_GENERAL1_2XLARGE",
    "certificate": "<certificate>",
    "environmentVariables": [
      {
        "name": "<environmentVariable-name>",
        "value": "<environmentVariable-value>",
        "type": "<environmentVariable-type>"
      }
    ],
    "registryCredential": [
      {
        "credential": "<credential-arn-or-name>",
        "credentialProvider": "<credential-provider>"
      }
    ],
    "imagePullCredentialsType": "CODEBUILD" | "SERVICE_ROLE",
    "privilegedMode": "<privileged-mode>"
  },
  "serviceRole": "<service-role>",
  "timeoutInMinutes": <timeout>,
  "queuedTimeoutInMinutes": <queued-timeout>,
  "encryptionKey": "<encryption-key>",
  "tags": [
    {
      "key": "<tag-key>",
      "value": "<tag-value>"
    }
  ],
  "vpcConfig": {
    "securityGroupIds": [
         "<security-group-id>"
    ],
    "subnets": [
         "<subnet-id>"
    ],
    "vpcId": "<vpc-id>"
  },
  "badgeEnabled": "<badge-enabled>",
  "logsConfig": {
    "cloudWatchLogs": {
      "status": "<cloudwatch-logs-status>",
      "groupName": "<group-name>",
      "streamName": "<stream-name>"
    },
    "s3Logs": {
      "status": "<s3-logs-status>",
      "location": "<s3-logs-location>",
      "encryptionDisabled": "<s3-logs-encryption-disabled>"
    }
  },
  "fileSystemLocations": [
    {
      "type": "EFS",
      "location": "<EFS-DNS-name-1>:/<directory-path>",
      "mountPoint": "<mount-point>",
      "identifier": "<efs-identifier>",
      "mountOptions": "<efs-mount-options>"
    }
  ],
  "buildBatchConfig": {
    "serviceRole": "<batch-service-role>",
    "combineArtifacts": <combine-artifacts>,
    "restrictions": {
      "maximumBuildsAllowed": <max-builds>,
      "computeTypesAllowed": [
        "<compute-type>"
      ]
    },
    "timeoutInMins": <batch-timeout>,
    "batchReportMode": "REPORT_AGGREGATED_BATCH" | "REPORT_INDIVIDUAL_BUILDS"
  },
  "concurrentBuildLimit": <concurrent-build-limit>
}

Sustituya lo siguiente:

name

Obligatorio. El nombre de este proyecto de compilación. Este nombre debe ser único en todos los proyectos de compilación de su cuenta de AWS.

description

Opcional. La descripción de este proyecto de compilación.

origen

Obligatorio. ProjectSourceObjeto que contiene información sobre la configuración del código fuente de este proyecto de compilación. Después de añadir un objeto source, puede añadir hasta 12 orígenes más mediante el secondarySources. Esta configuración incluye lo siguiente:

fuente/ tipo

Obligatorio. El tipo de repositorio que contiene el código fuente que se va a compilar. Los valores válidos son:

CODECOMMIT
CODEPIPELINE
GITHUB
GITHUB_ENTERPRISE
BITBUCKET
S3
NO_SOURCE

Si usa NO_SOURCE, la especificación de compilación no puede ser un archivo porque el proyecto no tiene un origen. En su lugar, debe usar el atributo buildspec para especificar una cadena con formato YAML para su especificación de compilación. Para obtener más información, consulte Ejemplo de proyecto sin un origen.

fuente/ ubicación

Obligatorio a menos que lo <source-type>defina comoCODEPIPELINE. La ubicación del código fuente para el tipo de repositorio especificado.

Para CodeCommit la URL de clonación HTTPS del repositorio que contiene el código fuente y el archivo especificaciones de compilación (por ejemplo,https://git-codecommit.<region-id>.amazonaws.com/v1/repos/<repo-name>).
Para Amazon S3, el nombre del bucket de entrada de compilación, seguido de la ruta y el nombre del archivo ZIP que contiene el código fuente y la especificación de compilación. Por ejemplo:
- Para un archivo ZIP ubicado en la raíz del depósito de entrada:<bucket-name>/<object-name>.zip.
- Para un archivo ZIP ubicado en una subcarpeta del bucket de entrada:<bucket-name>/<subfoler-path>/<object-name>.zip.
Para GitHub, la URL de clonación HTTPS del repositorio que contiene el código fuente y el archivo especificaciones de compilación. La dirección URL debe contener github.com. Debe conectar suAWS cuenta de a su GitHub cuenta. Para ello, utilice la CodeBuild consola para crear un proyecto de compilación.
1. En la página GitHub Autorizar la aplicación, en la sección Acceso a la organización, seleccione Solicitar acceso junto CodeBuild a cada repositorio al que desee acceder en.
2. Elija Authorize application. (Una vez conectado a su GitHub cuenta, no es necesario que termine de crear el proyecto de compilación. Puede cerrar la CodeBuild consola.)
Para GitHub Enterprise Server, la URL de clonación HTTP o HTTPS del repositorio que contiene el código fuente y el archivo especificaciones de compilación. También debe conectar suAWS cuenta a su cuenta de GitHub Enterprise Server. Para ello, utilice la CodeBuild consola para crear un proyecto de compilación.
1. Cree un token de acceso personal en GitHub Enterprise Server.
2. Copia este token en tu portapapeles para que puedas usarlo cuando crees tu CodeBuild proyecto. Para obtener más información, consulte Crear un token de acceso personal para la línea de comandos en el sitio web de GitHub ayuda.
3. Cuando utilice la consola para crear su CodeBuild proyecto, en Source, para el proveedor de código fuente, elija GitHubEnterprise.
4. En Personal Access Token, pegue el token que ha copiado en el portapapeles. Elija Save Token. Su CodeBuild cuenta ahora está conectada a su cuenta de GitHub Enterprise Server.
Para Bitbucket, la URL clon HTTPS al repositorio que contiene el código fuente y el archivo buildspec. La dirección URL debe contener bitbucket.org. Además, debe conectar su cuenta de AWS a su cuenta de Bitbucket. Para ello, utilice la CodeBuild consola para crear un proyecto de compilación.
1. Cuando use la consola para conectarse (o volver a conectarse) a Bitbucket, en la página Confirm access to your account de Bitbucket, elija Grant access. (Una vez conectado a su cuenta de Bitbucket, no es necesario que termine de crear el proyecto de compilación. Puede cerrar la CodeBuild consola.)
ParaAWS CodePipeline, no especifique unlocation valor parasource. CodePipeline ignora este valor porque al crear una canalización en CodePipeline, se especifica la ubicación del código fuente en la etapa de origen de la canalización.

fuente/ gitCloneDepth

Opcional. La profundidad del historial que se va a descargar. El valor mínimo es 0. Si esta valor es 0, superior a 25 o no se facilita, se descargará el historial completo con cada proyecto de compilación. Si el tipo de origen es Amazon S3, este valor no se admite.

fuente/ buildspec

Opcional. La definición o archivo de especificación de compilación que va a usar. Si este valor no se proporciona o se establece en una cadena vacía, el código fuente debe contener un archivo buildspec.yml en su directorio raíz. Si se establece este valor, puede ser una definición de especificaciones de compilación en línea, la ruta a un archivo de especificaciones de compilación alternativo en relación con el directorio raíz de la fuente principal o la ruta a un bucket de S3. El bucket debe encontrarse en la misma región de AWS que el proyecto de compilación. Especifique el archivo buildspec utilizando su ARN (por ejemplo, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). Para obtener más información, consulte Nombre de archivo y ubicación de almacenamiento de buildspec.

fuente/ autenticación

No utilizar. Este objeto solo lo usa la CodeBuild consola.

fuente/ reportBuildStatus

Especifica si se debe enviar al proveedor de código fuente el estado de inicio y finalización de una compilación. Si lo configuras con un proveedor de origen que no GitHub sea GitHub Enterprise Server o Bitbucket,invalidInputException se lanza un.

Para poder informar del estado de la compilación al proveedor de origen, el usuario asociado al proveedor de origen debe tener acceso de escritura al repositorio. Si el usuario no tiene acceso de escritura, el estado de compilación no se puede actualizar. Para obtener más información, consulte Acceso al proveedor de origen.

fuente/ buildStatusConfig

Contiene información que define cómo el proyecto de CodeBuild compilación informa del estado de compilación al proveedor de origen. Esta opción solo se usa cuando el tipo de fuente esGITHUBGITHUB_ENTERPRISE, oBITBUCKET.

fuente/buildStatusConfig/contexto

Para fuentes de Bitbucket, este parámetro se utiliza para elname parámetro en el estado de confirmación de Bitbucket. Para GitHub fuentes, este parámetro se utiliza para elcontext parámetro en el estado de GitHub confirmación.

Por ejemplo, puede hacer quecontext contengan el número de compilación y el disparador del webhook mediante las variables de CodeBuild entorno:


AWS CodeBuild sample-project Build #$CODEBUILD_BUILD_NUMBER - $CODEBUILD_WEBHOOK_TRIGGER

Esto hace que el contexto aparezca así para la compilación #24 activada por un evento de solicitud de extracción de webhook:


AWS CodeBuild sample-project Build #24 - pr/8

fuente/buildStatusConfig/TargetURL

Para fuentes de Bitbucket, este parámetro se utiliza para elurl parámetro en el estado de confirmación de Bitbucket. Para GitHub fuentes, este parámetro se utiliza para eltarget_url parámetro en el estado de GitHub confirmación.

Por ejemplo, puede establecer el enlacetargetUrl ahttps://aws.amazon.com/codebuild/<path to build> y el estado de confirmación se vinculará a esta URL.

También puede incluir variables de CodeBuild entorno en la URLtargetUrl para añadir información adicional a la URL. Por ejemplo, para añadir la región de compilación a la URL,targetUrl defina la siguiente manera:


"targetUrl": "https://aws.amazon.com/codebuild/<path to build>?region=$AWS_REGION"

Si la región de construcción esus-east-2, se ampliará a:


https://aws.amazon.com/codebuild/<path to build>?region=us-east-2

fuente/ gitSubmodulesConfig

Opcional. Información acerca de la configuración de submódulos de Git. Se usa solo con CodeCommit GitHub, GitHub Enterprise Server y Bitbucket.

gitSubmodulesConfigfuente//fetchSubmodules: Establezca fetchSubmodules en true si desea incluir submódulos de Git en el repositorio. Los submódulos de Git que se incluyan deben estar configurados como HTTPS.

fuente/ InsecureSsl

Opcional. Se usa solo con GitHub Enterprise Server. Defina este valortrue para ignorar las advertencias de TLS al conectarse al repositorio de proyectos de GitHub Enterprise Server. El valor predeterminado es false. InsecureSsl debe utilizarse con fines de prueba únicamente. No debe utilizarse en un entorno de producción.

fuente/ Identificador de fuente

Identificador definido por el usuario para la fuente del proyecto. Opcional para la fuente principal. Necesario para fuentes secundarias.

secondarySources

Opcional. Matriz de ProjectSourceobjetos que contiene información sobre las fuentes secundarias de un proyecto de construcción. Puede agregar hasta 12 fuentes secundarias. LossecondarySources objetos utilizan las mismas propiedades utilizadas por elorigen objeto. En un objeto de origen secundario,sourceIdentifier se requiere.

secondarySourceVersions

Opcional. Una matriz de objetos ProjectSourceVersion. Si se especifica secondarySourceVersions en el nivel de compilación, prevalece sobre esto.

sourceVersion

Opcional. La versión de la entrada de la compilación que se creará para este proyecto. Si no se especifica, se utiliza la versión más reciente. Si se especifica, debe ser una de las siguientes opciones:

Para CodeCommit el ID de confirmación, la ramificación o la etiqueta Git que se va a utilizar.
Para GitHub el ID de confirmación, el ID de solicitud de inserción, el nombre de ramificación o el nombre de etiqueta correspondiente a la versión de código fuente que desea compilar. Si se especifica un ID de solicitud de inserción, este debe tener el formato pr/pull-request-ID (por ejemplo, pr/25). Si se especifica un nombre de ramificación, se usa el ID de confirmación HEAD de la ramificación. Si no se especifica, se usa el ID de confirmación HEAD de la ramificación personalizada.
Para Bitbucket, el ID de confirmación, el nombre de ramificación o el nombre de etiqueta correspondiente a la versión de código fuente que desea compilar. Si se especifica un nombre de ramificación, se usa el ID de confirmación HEAD de la ramificación. Si no se especifica, se usa el ID de confirmación HEAD de la ramificación personalizada.
En Amazon S3, el ID de versión del objeto que representa el archivo ZIP de entrada de compilación que se va a utilizar.

Si se especifica sourceVersion en el nivel de compilación y, a continuación, esa versión prevalece sobre sourceVersion (en el nivel del proyecto). Para obtener más información, consulte Ejemplo de versión de origen con AWS CodeBuild.

artefactos

Obligatorio. ProjectArtifactsObjeto que contiene información sobre la configuración del artefacto de salida de este proyecto de compilación. Después de añadir un objeto artifacts, puede añadir hasta 12 artefactos más mediante el secondaryArtifacts. Esta configuración incluye lo siguiente:

artefactos/tipo

Obligatorio. El tipo de artefacto de salida de la compilación. Los valores válidos son:

CODEPIPELINE
NO_ARTIFACTS
S3

artefactos/ubicación