Creación del archivo JSON Rellene el archivo JSON Creación del proyecto

Crear un proyecto de compilación (AWS CLI)

Para obtener más información acerca del uso de laAWS CLIcon CodeBuild, consulte laReferencia de la línea de comandos.

Para crear un proyecto de compilación de CodeBuild mediante elAWS CLI, crea un formato JSONProyecto deestructura, rellene la estructura y llame alcreate-projectpara crear el proyecto.

Creación del archivo JSON

Cree un archivo JSON esqueleto con elcreate-project, utilizando el comando--generate-cli-skeletonopció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>.

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

source

Obligatorio. AOrigen del proyectoque 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:

origen/type

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.

origen/location

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

Para CodeCommit, la URL clon HTTPS al repositorio que contiene el código fuente y el archivo buildspec (por ejemplo,https://git-codecommit.<region-id>.amazonaws.com/v1/repos/<repo-name>).
Para Amazon S3, el nombre del bucket de entrada de la 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:
- En el caso de 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 clon HTTPS al repositorio que contiene el código fuente y el archivo buildspec. La dirección URL debe contener github.com. Debe conectar su cuenta de AWS a su cuenta de GitHub. Para ello, utilice la consola de CodeBuild para crear un proyecto de compilación.
1. En GitHubAutorizar solicitud, en laAcceso a la organizaciónsección, elija.Solicitud de accesojunto a cada repositorio al que desee que CodeBuild pueda obtener acceso en el.
2. Elija Authorize application. (Una vez conectado a su cuenta de GitHub, no es necesario que termine de crear el proyecto de compilación. Puede cerrar la consola de CodeBuild.)
En GitHub Enterprise Server, la URL clon HTTP o HTTPS al repositorio que contiene el código fuente y el archivo buildspec. Además, debe conectar su cuenta de AWS con su cuenta de GitHub Enterprise Server. Para ello, utilice la consola de CodeBuild para crear un proyecto de compilación.
1. Cree un token de acceso personal en GitHub Enterprise Server.
2. Copie dicho token en el portapapeles de forma que pueda utilizarlo cuando cree su proyecto de CodeBuild. Para obtener más información, consulte Creating a personal access token for the command line en el sitio web GitHub Help.
3. Cuando utilice la consola para crear su proyecto de CodeBuild, enFuente, paraProveedor de origen, eligeGitHub Enterprise.
4. En Personal Access Token, pegue el token que ha copiado en el portapapeles. Elija Save Token. Su cuenta de CodeBuild ya 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 consola de CodeBuild 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 consola de CodeBuild.)
En AWS CodePipeline, no especifique el valor location para source. CodePipeline no tiene en cuenta este valor porque, cuando se crea una canalización en CodePipeline, se especifica la ubicación del código fuente en la etapa Source de la canalización.

origen/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.

origen/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 especificación de compilación insertada, la ruta a un archivo de especificación de compilación alternativo en relación con el directorio raíz de su 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.

origen/auth

No utilizar. Este objeto se utiliza únicamente en la consola de CodeBuild.

origen/reportBuildStatus

Especifica si se debe enviar al proveedor de código fuente el estado de inicio y finalización de una compilación. Si define este valor con un proveedor de código fuente distinto de GitHub, GitHub Enterprise Server o Bitbucket, se genera una excepción invalidInputException.

Para poder informar del estado de 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.

origen/BuildStatusConfig

Contiene información que define cómo el proyecto de compilación de CodeBuild informa del estado de compilación al proveedor de origen. Esta opción se utiliza únicamente cuando el tipo de origen esGITHUB,GITHUB_ENTERPRISE, o bienBITBUCKET.

Fuente/BuildStatusConfig/context

En el caso de los orígenes de Bitbucket, este parámetro se utiliza para lanameen el estado de confirmación de Bitbucket. En los orígenes de GitHub, este parámetro se utiliza para lacontexten el estado de confirmación de GitHub.

Por ejemplo, puede tener elcontextcontiene el número de compilación y el activador webhook utilizando las variables de entorno CodeBuild:


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

Esto da como resultado que el contexto de la compilación #24 desencadena por un evento de solicitud de extracción de webhook:


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

Fuente/BuildStatusConfig/TargetURL

En el caso de los orígenes de Bitbucket, este parámetro se utiliza para laurlen el estado de confirmación de Bitbucket. En los orígenes de GitHub, este parámetro se utiliza para latarget_urlen el estado de confirmación de GitHub.

Por ejemplo, puede establecer la opcióntargetUrlDe 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 entorno de CodeBuild en eltargetUrlpara añadir información adicional a la URL. Por ejemplo, para agregar la región de compilación a la URL, establezca latargetUrla:


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

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


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

origen/gitSubmodulesConfig

Opcional. Información acerca de la configuración de submódulos de Git. Solo se utiliza con CodeCommit, GitHub Enterprise Server y Bitbucket.

Submódulos de fuente/GIT Config/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.

origen/InsecureSsl

Opcional. Solo se utiliza con GitHub Enterprise Server. Establezca este valor en true para omitir las advertencias de TLS al conectarse al repositorio del proyecto 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.

origen/SourceIdentifier

Un identificador definido por el usuario para el origen del proyecto. Opcional para el origen principal. Necesario para fuentes secundarias.

secondarySources

Opcional. Una matriz deOrigen del proyectoobjetos que contienen información sobre los orígenes secundarios de un proyecto de compilación. Puede añadir hasta 12 fuentes secundarias. LasecondarySourceslos objetos utilizan las mismas propiedades que utiliza elsourceobjeto. En un objeto de origen secundario, elsourceIdentifieres obligatorio.

secondarySourceVersions

Opcional. Una matriz deProjectSourceVersionobjetos. 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:

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

artifacts

Obligatorio. AArtefactos del proyectoque 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:

artifactos/type

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

CODEPIPELINE
NO_ARTIFACTS
S3

artifactos de/location