Step Functions で AWS CodeBuild ビルドを管理する

Step Functions を と統合 AWS CodeBuild して、ビルドを開始、停止、管理できます。このページには、Step Functions CodeBuild APIsで使用できるサポート対象 が一覧表示されます。

Step Functions は、 Amazon ステートメント言語 () から直接特定の AWS サービスを制御できますASL。詳細については、「他のサービスの統合」および「Step Functions APIのサービスへのパラメータの受け渡し」を参照してください。

と AWS Step Functions のサービス統合 AWS CodeBuild により、Step Functions を使用してビルドをトリガー、停止、管理したり、ビルドレポートを共有したりできます。Step Functions を使用すると、アプリケーションのソフトウェア変更を検証するための継続的統合パイプラインを設計および実行できます。

最適化 CodeBuild 統合と統合の違い CodeBuild AWS SDK

• ジョブの実行 (.sync) 統合パターンがサポートされています。

• StopBuild または を呼び出した後StopBuildBatch、ビルドまたはビルドバッチは、ビルドまたはビルドの状態を確定 CodeBuild するために 内で内部作業が完了するまですぐに削除できません。この期間中に BatchDeleteBuilds または DeleteBuildBatch を使おうとすると、構築または構築バッチは削除されない場合があります。BatchDeleteBuilds と DeleteBuildBatch のために最適化されたサービス統合には、内部再試行が含まれており、停止直後に削除するというユースケースを簡素化します。

次の表に示すように、すべての がすべての統合パターンAPIsをサポートしているわけではありません。

API	レスポンスのリクエスト	ジョブの実行 (.sync)
StartBuild	✓	✓
StopBuild	✓
BatchDeleteBuilds	✓
BatchGetReports	✓
StartBuildBatch	✓	✓
StopBuildBatch	✓
RetryBuildBatch	✓	✓
DeleteBuildBatch	✓

のパラメータStep Functionsは で表されます。 PascalCase

API アクション camelCaseなどのネイティブサービスAPIが にある場合でもstartSyncExecution、 などのパラメータを で指定します PascalCaseStateMachineArn。

サポートされている CodeBuild APIs と構文：

• StartBuild

  • リクエストの構文

  • サポートされているパラメータ:

    • 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

  • レスポンスの構文

• StopBuild

  • リクエストの構文

  • サポートされているパラメータ:

    • Id

  • レスポンスの構文

• BatchDeleteBuilds

  • リクエストの構文

  • サポートされているパラメータ:

    • Ids

  • レスポンスの構文

• BatchGetReports

  • リクエストの構文

  • サポートされているパラメータ:

    • ReportArns

  • レスポンスの構文

• StartBuildBatch

  • リクエストの構文

  • サポートされているパラメータ:

    • 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

  • レスポンスの構文

• StopBuildBatch

  • リクエストの構文

  • サポートされているパラメータ:

    • Id

  • レスポンスの構文

• RetryBuildBatch

  • リクエストの構文

  • サポートされているパラメータ:

    • Id

    • IdempotencyToken

    • RetryType

  • レスポンスの構文

• DeleteBuildBatch

  • リクエストの構文

  • サポートされているパラメータ:

    • Id

  • レスポンスの構文

注記

BatchDeleteBuilds には、JSONPath 再帰的降下 (..) 演算子を使用できます。これは配列を返し、次の例に示すように、Arn フィールドを StartBuild から複数形の Ids パラメータに変換できます。

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

を他の AWS サービスStep Functionsで使用するときにIAMアクセス許可を設定する方法については、「」を参照してくださいStep Functions が統合サービスのIAMポリシーを生成する方法。