Verwalten AWS CodeBuild baut mit Step Functions

Sie können Step Functions integrieren mit AWS CodeBuild um Builds zu starten, zu stoppen und zu verwalten. Auf dieser Seite werden die unterstützten Funktionen aufgeführt, die CodeBuild APIs Sie mit Step verwenden können.

Um mehr über die Integration mit zu erfahren AWS Dienste in Step Functions, siehe Integrieren von -Services undÜbergeben von Parametern an einen Dienst API in Step Functions.

Mit der Step Functions Functions-Integration mit AWS CodeBuild Sie können Step Functions verwenden, um Builds auszulösen, zu stoppen und zu verwalten und Build-Berichte gemeinsam zu nutzen. Mit Step Functions können Sie Pipelines für die kontinuierliche Integration entwerfen und ausführen, um Ihre Softwareänderungen für Anwendungen zu validieren.

Hauptmerkmale der optimierten Integration CodeBuild

• Das Ausführen einer Aufgabe (.sync) Integrationsmuster wird unterstützt.

• Nachdem Sie StopBuild oder aufgerufen habenStopBuildBatch, kann der Build oder der Build-Batch erst gelöscht werden, wenn einige interne Arbeiten abgeschlossen sind, CodeBuild um den Status des Builds oder der Builds abzuschließen.

  Wenn Sie versuchen, BatchDeleteBuilds oder DeleteBuildBatch während dieses Zeitraums zu verwenden, wird der Build oder der Build-Batch möglicherweise nicht gelöscht.

  Die optimierten Serviceintegrationen DeleteBuildBatch bieten einen internen Wiederholungsversuch, um den Anwendungsfall des Löschens unmittelbar nach dem Beenden zu vereinfachen. BatchDeleteBuilds

Nicht alle APIs unterstützen alle Integrationsmuster, wie in der folgenden Tabelle dargestellt.

API	Request Response (Antwort anfordern)	Ausführen einer Aufgabe (.sync)
StartBuild	Unterstützt	Unterstützt
StopBuild	Unterstützt	Nicht unterstützt
BatchDeleteBuilds	Unterstützt	Nicht unterstützt
BatchGetReports	Unterstützt	Nicht unterstützt
StartBuildBatch	Unterstützt	Unterstützt
StopBuildBatch	Unterstützt	Nicht unterstützt
RetryBuildBatch	Unterstützt	Unterstützt
DeleteBuildBatch	Unterstützt	Nicht unterstützt

Parameter in Step Functions werden ausgedrückt in PascalCase

Auch wenn der native Dienst API aktiviert istcamelCase, z. B. die API AktionstartSyncExecution, geben Sie Parameter in an PascalCase, z. B.:StateMachineArn.

Unterstützt CodeBuild APIs

• StartBuild

  • Erforderliche Syntax

  • Unterstützte Parameter:

    • 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

  • Antwortsyntax

• StopBuild

  • Erforderliche Syntax

  • Unterstützte Parameter:

    • Id

  • Antwortsyntax

• BatchDeleteBuilds

  • Erforderliche Syntax

  • Unterstützte Parameter:

    • Ids

  • Antwortsyntax

• BatchGetReports

  • Erforderliche Syntax

  • Unterstützte Parameter:

    • ReportArns

  • Antwortsyntax

• StartBuildBatch

  • Erforderliche Syntax

  • Unterstützte Parameter:

    • 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

  • Antwortsyntax

• StopBuildBatch

  • Erforderliche Syntax

  • Unterstützte Parameter:

    • Id

  • Antwortsyntax

• RetryBuildBatch

  • Erforderliche Syntax

  • Unterstützte Parameter:

    • Id

    • IdempotencyToken

    • RetryType

  • Antwortsyntax

• DeleteBuildBatch

  • Erforderliche Syntax

  • Unterstützte Parameter:

    • Id

  • Antwortsyntax

Anmerkung

Sie können den JSONPath-(..)Operator für rekursiven Abstieg für BatchDeleteBuilds verwenden. Mit dem zurückgegebenen Array können Sie das Arn Feld von StartBuild in einen Ids Pluralparameter umwandeln, wie im folgenden Beispiel gezeigt.

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

IAMRichtlinien für Anrufe AWS CodeBuild

Die folgenden Beispielvorlagen zeigen, wie AWS Step Functions generiert IAM Richtlinien auf der Grundlage der Ressourcen in Ihrer State-Machine-Definition. Weitere Informationen erhalten Sie unter So generiert Step Functions IAM Richtlinien für integrierte Dienste und Entdecken Sie Serviceintegrationsmuster in Step Functions.

Ressourcen:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": [
                "sns:Publish"
            ],
            "Resource": [
                "arn:aws:sns:sa-east-1:123456789012:StepFunctionsSample-CodeBuildExecution1111-2222-3333-wJalrXUtnFEMI-SNSTopic-bPxRfiCYEXAMPLEKEY"
            ],
            "Effect": "Allow"
        },
        {
            "Action": [
                "codebuild:StartBuild",
                "codebuild:StopBuild",
                "codebuild:BatchGetBuilds",
                "codebuild:BatchGetReports"
            ],
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": [
                "events:PutTargets",
                "events:PutRule",
                "events:DescribeRule"
            ],
            "Resource": [
                "arn:aws:events:sa-east-1:123456789012:rule/StepFunctionsGetEventForCodeBuildStartBuildRule"
            ],
            "Effect": "Allow"
        }
    ]
}

StartBuild

Statische Ressourcen

Run a Job (.sync)

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "codebuild:StartBuild",
        "codebuild:StopBuild",
        "codebuild:BatchGetBuilds"
      ],
      "Resource": [
        "arn:aws:codebuild:[[region]]:[[accountId]]:project/[[projectName]]"
      ]
    },
    {
      "Effect": "Allow",
      "Action": [
        "events:PutTargets",
        "events:PutRule",
        "events:DescribeRule"
      ],
      "Resource": [
        "arn:aws:events:[[region]]:[[accountId]]:rule/StepFunctionsGetEventForCodeBuildStartBuildRule"
      ]
    }
  ]
}
        

Request Response

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "codebuild:StartBuild"
      ],
      "Resource": [
        "arn:aws:codebuild:[[region]]:[[accountId]]:project/[[projectName]]"
      ]
    }
  ]
}
        

Dynamische Ressourcen

Run a Job (.sync)

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "codebuild:StartBuild",
        "codebuild:StopBuild",
        "codebuild:BatchGetBuilds"
      ],
      "Resource": [
        "arn:aws:codebuild:[[region]]:*:project/*"
      ]
    },
    {
      "Effect": "Allow",
      "Action": [
        "events:PutTargets",
        "events:PutRule",
        "events:DescribeRule"
      ],
      "Resource": [
        "arn:aws:events:[[region]]:[[accountId]]:rule/StepFunctionsGetEventForCodeBuildStartBuildRule"
      ]
    }
  ]
}
        

Request Response

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "codebuild:StartBuild"
      ],
      "Resource": [
        "arn:aws:codebuild:[[region]]:*:project/*"
      ]
    }
  ]
}

StopBuild

Statische Ressourcen

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "codebuild:StopBuild"
      ],
      "Resource": [
        "arn:aws:codebuild:[[region]]:[[accountId]]:project/[[projectName]]"
      ]
    }
  ]
}

Dynamische Ressourcen

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "codebuild:StopBuild"
      ],
      "Resource": [
        "arn:aws:codebuild:[[region]]:*:project/*"
      ]
    }
  ]
}

BatchDeleteBuilds

Statische Ressourcen

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "codebuild:BatchDeleteBuilds"
      ],
      "Resource": [
        "arn:aws:codebuild:[[region]]:[[accountId]]:project/[[projectName]]"
      ]
    }
  ]
}

Dynamische Ressourcen

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "codebuild:BatchDeleteBuilds"
      ],
      "Resource": [
        "arn:aws:codebuild:[[region]]:*:project/*"
      ]
    }
  ]
}

BatchGetReports

Statische Ressourcen

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "codebuild:BatchGetReports"
      ],
      "Resource": [
        "arn:aws:codebuild:[[region]]:[[accountId]]:report-group/[[reportName]]"
      ]
    }
  ]
}

Dynamische Ressourcen

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "codebuild:BatchGetReports"
      ],
      "Resource": [
        "arn:aws:codebuild:[[region]]:*:report-group/*"
      ]
    }
  ]
}

StartBuildBatch

Statische Ressourcen

Run a Job (.sync)

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "codebuild:StartBuildBatch",
                "codebuild:StopBuildBatch",
                "codebuild:BatchGetBuildBatches"
            ],
            "Resource": [
                "arn:aws:codebuild:[[region]]:[[accountId]]:project/[[projectName]]"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "events:PutTargets",
                "events:PutRule",
                "events:DescribeRule"
            ],
            "Resource": [
                "arn:aws:events:[[region]]:[[accountId]]:rule/StepFunctionsGetEventForCodeBuildStartBuildBatchRule"
            ]
        }
    ]
}
        

Request Response

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "codebuild:StartBuildBatch"
            ],
            "Resource": [
                "arn:aws:codebuild:[[region]]:[[accountId]]:project/[[projectName]]"
            ]
        }
    ]
}
        

Dynamische Ressourcen

Run a Job (.sync)

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "codebuild:StartBuildBatch",
                "codebuild:StopBuildBatch",
                "codebuild:BatchGetBuildBatches"
            ],
            "Resource": [
                "arn:aws:codebuild:[[region]]:[[accountId]]:project/*"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "events:PutTargets",
                "events:PutRule",
                "events:DescribeRule"
            ],
            "Resource": [
                "arn:aws:events:[[region]]:[[accountId]]:rule/StepFunctionsGetEventForCodeBuildStartBuildBatchRule"
            ]
        }
    ]
}
        

Request Response

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "codebuild:StartBuildBatch"
            ],
            "Resource": [
                "arn:aws:codebuild:[[region]]:[[accountId]]:project/*"
            ]
        }
    ]
}

StopBuildBatch

Statische Ressourcen

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "codebuild:StopBuildBatch"
            ],
            "Resource": [
                "arn:aws:codebuild:[[region]]:[[accountId]]:project/[[projectName]]"
            ]
        }
    ]
}

Dynamische Ressourcen

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "codebuild:StopBuildBatch"
            ],
            "Resource": [
                "arn:aws:codebuild:[[region]]:[[accountId]]:project/*"
            ]
        }
    ]
}

RetryBuildBatch

Statische Ressourcen

Run a Job (.sync)

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "codebuild:RetryBuildBatch",
                "codebuild:StopBuildBatch",
                "codebuild:BatchGetBuildBatches"
            ],
            "Resource": [
                "arn:aws:codebuild:[[region]]:[[accountId]]:project/[[projectName]]"
            ]
        }
    ]
}
        

Request Response

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "codebuild:RetryBuildBatch"
            ],
            "Resource": [
                "arn:aws:codebuild:[[region]]:[[accountId]]:project/[[projectName]]"
            ]
        }
    ]
}
        

Dynamische Ressourcen

Run a Job (.sync)

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "codebuild:RetryBuildBatch",
                "codebuild:StopBuildBatch",
                "codebuild:BatchGetBuildBatches"
            ],
            "Resource": [
                "arn:aws:codebuild:[[region]]:[[accountId]]:project/*"
            ]
        }
    ]
}
        

Request Response

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "codebuild:RetryBuildBatch"
            ],
            "Resource": [
                "arn:aws:codebuild:[[region]]:[[accountId]]:project/*"
            ]
        }
    ]
}

DeleteBuildBatch

Statische Ressourcen

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "codebuild:DeleteBuildBatch"
            ],
            "Resource": [
                "arn:aws:codebuild:[[region]]:[[accountId]]:project/[[projectName]]"
            ]
        }
    ]
}

Dynamische Ressourcen

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "codebuild:DeleteBuildBatch"
            ],
            "Resource": [
                "arn:aws:codebuild:[[region]]:[[accountId]]:project/*"
            ]
        }
    ]
}