Llama AWS CodeBuild con Step Functions

Step Functions puede controlar ciertos AWS servicios directamente desde Lenguaje de estados de Amazon (ASL). Para obtener más información, consulte Trabajo con otros servicios y Cómo pasar parámetros a una API de servicio.

En qué se diferencia la CodeBuild integración optimizada de la integración del CodeBuild AWS SDK

• Se admite el patrón de integración Ejecutar un trabajo (.sync).

• Después de llamar StopBuild oStopBuildBatch, la compilación o el lote de compilaciones no se pueden eliminar inmediatamente hasta que se complete algún trabajo interno CodeBuild para finalizar el estado de la compilación o compilaciones. Si se intenta usar BatchDeleteBuilds o DeleteBuildBatch durante este período, no se podrá eliminar la compilación o el lote de compilación. Las integraciones de servicios optimizados para BatchDeleteBuilds y DeleteBuildBatch incluyen un reintento interno para simplificar el caso de uso de eliminar justo después de detener.

La integración del AWS Step Functions servicio le AWS CodeBuild permite usar Step Functions para activar, detener y administrar compilaciones, y compartir informes de compilación. Con Step Functions puede diseñar y ejecutar canalizaciones de integración continua para validar los cambios de software para las aplicaciones.

No todas las API admiten todos los patrones de integración, como se muestra en la tabla siguiente.

API	Respuesta de la solicitud	Ejecutar un trabajo (.sync)
StartBuild	✓	✓
StopBuild	✓
BatchDeleteBuilds	✓
BatchGetReports	✓
StartBuildBatch	✓	✓
StopBuildBatch	✓
RetryBuildBatch	✓	✓
DeleteBuildBatch	✓

nota

Los parámetros Step Functions se expresan en PascalCase, incluso si la API de servicio nativa está en CamelCase. Por ejemplo, podría usar la acción de la API de Step Functions startSyncExecution y especificar su parámetro como StateMachineArn.

CodeBuild API y sintaxis compatibles:

• StartBuild

  • Sintaxis de la solicitud

  • Parámetros admitidos:

    • ProjectName

    • ArtifactsOverride

    • BuildspecOverride

    • CacheOverride

    • CertificateOverride

    • ComputeTypeOverride

    • EncryptionKeyOverride

    • EnvironmentTypeOverride

    • EnvironmentVariablesOverride

    • GitCloneDepthOverride

    • GitSubmodulesConfigOverride

    • IdempotencyToken

    • ImageOverride

    • ImagePullCredentialsTypeOverride

    • InsecureSslOverride

    • LogsConfigOverride

    • PrivilegedModeOverride

    • QueuedTimeoutInMinutesOverride

    • RegistryCredentialOverride

    • ReportBuildStatusOverride

    • SecondaryArtifactsOverride

    • SecondarySourcesOverride

    • SecondarySourcesVersionOverride

    • ServiceRoleOverride

    • SourceAuthOverride

    • SourceLocationOverride

    • SourceTypeOverride

    • SourceVersion

    • TimeoutInMinutesOverride

  • Sintaxis de la respuesta

• StopBuild

  • Sintaxis de la solicitud

  • Parámetros admitidos:

    • Id

  • Sintaxis de la respuesta

• BatchDeleteBuilds

  • Sintaxis de la solicitud

  • Parámetros admitidos:

    • Ids

  • Sintaxis de la respuesta

• BatchGetReports

  • Sintaxis de la solicitud

  • Parámetros admitidos:

    • ReportArns

  • Sintaxis de la respuesta

• StartBuildBatch

  • Sintaxis de la solicitud

  • Parámetros admitidos:

    • ProjectName

    • ArtifactsOverride

    • BuildBatchConfigOverride

    • BuildspecOverride

    • BuildTimeoutInMinutesOverride

    • CacheOverride

    • CertificateOverride

    • ComputeTypeOverride

    • DebugSessionEnabled

    • EncryptionKeyOverride

    • EnvironmentTypeOverride

    • EnvironmentVariablesOverride

    • GitCloneDepthOverride

    • GitSubmodulesConfigOverride

    • IdempotencyToken

    • ImageOverride

    • ImagePullCredentialsTypeOverride

    • InsecureSslOverride

    • LogsConfigOverride

    • PrivilegedModeOverride

    • QueuedTimeoutInMinutesOverride

    • RegistryCredentialOverride

    • ReportBuildBatchStatusOverride

    • SecondaryArtifactsOverride

    • SecondarySourcesOverride

    • SecondarySourcesVersionOverride

    • ServiceRoleOverride

    • SourceAuthOverride

    • SourceLocationOverride

    • SourceTypeOverride

    • SourceVersion

  • Sintaxis de la respuesta

• StopBuildBatch

  • Sintaxis de la solicitud

  • Parámetros admitidos:

    • Id

  • Sintaxis de la respuesta

• RetryBuildBatch

  • Sintaxis de la solicitud

  • Parámetros admitidos:

    • Id

    • IdempotencyToken

    • RetryType

  • Sintaxis de la respuesta

• DeleteBuildBatch

  • Sintaxis de la solicitud

  • Parámetros admitidos:

    • Id

  • Sintaxis de la respuesta

nota

Puede usar el operador de descenso recursivo de JSONPath (..) para BatchDeleteBuilds. Esto devuelve una matriz y le permite convertir el campo Arn de StartBuild en un parámetro Ids plural, como se muestra en el siguiente ejemplo.

"BatchDeleteBuilds": {
    "Type": "Task",
    "Resource": "arn:aws:states:::codebuild:batchDeleteBuilds",
    "Parameters": {
        "Ids.$": "$.Build..Arn"
    },
    "Next": "MyNextState"
},

Para obtener información sobre cómo configurar IAM los permisos cuando se utilizan Step Functions con otros AWS servicios, consultePolíticas de IAM para servicios integrados.