YAML-Definition für die Aktion „AWS CDK Bootstrap“

Im Folgenden finden Sie die YAML-Definition der Bootstrap-Aktion.AWS CDK Informationen zur Verwendung dieser Aktion finden Sie unter. Bootstrapping einer AWS CDK App mit einem Workflow

Diese Aktionsdefinition ist als Abschnitt in einer umfassenderen Workflow-Definitionsdatei vorhanden. Weitere Informationen über diese Datei finden Sie unter YAML-Workflow-Definition.

Anmerkung

Die meisten der folgenden YAML-Eigenschaften haben entsprechende Benutzeroberflächenelemente im visuellen Editor. Verwenden Sie Strg+F, um nach einem UI-Element zu suchen. Das Element wird mit der zugehörigen YAML-Eigenschaft aufgelistet.

# The workflow definition starts here.
# See Eigenschaften der obersten Ebene for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.    
  CDKBootstrapAction_nn: 
    Identifier: aws/cdk-bootstrap@v1
    DependsOn:
      - action-name
    Compute:  
      Type: EC2 | Lambda
      Fleet: fleet-name
    Timeout: timeout-minutes
    Inputs:
      # Specify a source or an artifact, but not both.
      Sources:
        - source-name-1
      Artifacts:
        - artifact-name
    Outputs:
      Artifacts:
        - Name: cdk_bootstrap_artifacts
          Files: 
            - "cdk.out/**/*"
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Configuration:
      Region: us-west-2
      CdkCliVersion: version

CDKBootstrapAction

(Erforderlich)

Geben Sie den Namen der Aktion an. Alle Aktionsnamen müssen innerhalb des Workflows eindeutig sein. Aktionsnamen sind auf alphanumerische Zeichen (a-z, A-Z, 0-9), Bindestriche (-) und Unterstriche (_) beschränkt. Leerzeichen sind nicht erlaubt. Sie können keine Anführungszeichen verwenden, um Sonderzeichen und Leerzeichen in Aktionsnamen zuzulassen.

Standard: CDKBootstrapAction_nn.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“/Anzeigename der Aktion

Identifier

(CDKBootstrapAction/Identifier)

(Erforderlich)

Identifiziert die Aktion. Ändern Sie diese Eigenschaft nicht, es sei denn, Sie möchten die Version ändern. Weitere Informationen finden Sie unter Angabe der Haupt-, Neben- oder Patch-Version einer Aktion.

Standard: aws/cdk-bootstrap@v1.

Entsprechende Benutzeroberfläche: Workflow-Diagram/ CDKBootstrapAction _nn/ aws/cdk-bootstrap @v1 label

DependsOn

(CDKBootstrapAction/DependsOn)

(Optional)

Geben Sie eine Aktion, eine Aktionsgruppe oder ein Gate an, die erfolgreich ausgeführt werden müssen, damit diese Aktion ausgeführt werden kann.

Weitere Hinweise zur Funktion „Hängt davon ab“ finden Sie unter. Aktionen so konfigurieren, dass sie von anderen Aktionen abhängen

Entsprechende Benutzeroberfläche: Registerkarte „Eingaben“/„Hängt davon ab“ — optional

Compute

(CDKBootstrapAction/Compute)

(Optional)

Die Rechen-Engine, die zur Ausführung Ihrer Workflow-Aktionen verwendet wurde. Sie können die Berechnung entweder auf Workflow-Ebene oder auf Aktionsebene angeben, aber nicht beide. Wenn auf Workflow-Ebene angegeben, gilt die Rechenkonfiguration für alle im Workflow definierten Aktionen. Auf Workflow-Ebene können Sie auch mehrere Aktionen auf derselben Instanz ausführen. Weitere Informationen finden Sie unter Rechenleistung für mehrere Aktionen gemeinsam nutzen.

Entsprechende Benutzeroberfläche: keine

Type

(CDKBootstrapAction/Compute/Type)

(Erforderlich, wenn Compute es enthalten ist)

Der Typ der Compute Engine. Sie können einen der folgenden Werte verwenden:

• EC2 (visueller Editor) oder EC2 (YAML-Editor)

  Optimiert für Flexibilität bei Aktionsläufen.

• Lambda (visueller Editor) oder Lambda (YAML-Editor)

  Optimierte Startgeschwindigkeiten für Aktionen.

Weitere Informationen zu Datentypen finden Sie unter Berechnungstypen.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“ /Erweitert — optional/ Berechnungstyp

Fleet

(CDKBootstrapAction/Compute/Fleet)

(Optional)

Geben Sie die Maschine oder Flotte an, auf der Ihr Workflow oder Ihre Workflow-Aktionen ausgeführt werden sollen. Bei bedarfsgesteuerten Flotten stellt der Workflow zu Beginn einer Aktion die benötigten Ressourcen bereit, und die Maschinen werden zerstört, wenn die Aktion abgeschlossen ist. Beispiele für Flotten auf Abruf:Linux.x86-64.Large,. Linux.x86-64.XLarge Weitere Informationen zu Flotten auf Abruf finden Sie unter. Flotteneigenschaften auf Abruf

Bei bereitgestellten Flotten konfigurieren Sie eine Reihe von dedizierten Maschinen, um Ihre Workflow-Aktionen auszuführen. Diese Maschinen bleiben inaktiv und können sofort Aktionen ausführen. Weitere Informationen zu bereitgestellten Flotten finden Sie unter. Bereitgestellte Flotteneigenschaften

Wenn Fleet es weggelassen wird, ist die Standardeinstellung. Linux.x86-64.Large

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“ /Erweitert — optional/ Compute Fleet

Timeout

(CDKBootstrapAction/Timeout)

(Erforderlich)

Geben Sie an, wie lange die Aktion in Minuten (YAML-Editor) oder Stunden und Minuten (visueller Editor) ausgeführt werden kann, bevor die Aktion beendet wird. CodeCatalyst Das Minimum beträgt 5 Minuten und das Maximum ist unter beschriebenKontingente für Workflows. Das Standard-Timeout entspricht dem maximalen Timeout.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Timeout“ — optional

Inputs

(CDKBootstrapAction/Inputs)

(Optional)

Der Inputs Abschnitt definiert die Daten, die die AWS CDK Bootstrap-Aktion während einer Workflow-Ausführung benötigt.

Entsprechende Benutzeroberfläche: Registerkarte „Eingaben“

Anmerkung

Für jede AWS CDK Bootstrap-Aktion ist nur eine Eingabe (entweder eine Quelle oder ein Artefakt) zulässig.

Sources

(CDKBootstrapAction/Inputs/Sources)

(Erforderlich, wenn Ihre AWS CDK App in einem Quell-Repository gespeichert ist)

Wenn Ihre AWS CDK App in einem Quell-Repository gespeichert ist, geben Sie die Bezeichnung dieses Quell-Repositorys an. Die AWS CDK Bootstrap-Aktion synthetisiert die App in diesem Repository, bevor der Bootstrapping-Vorgang gestartet wird. Derzeit ist das einzige unterstützte Repository-Label. WorkflowSource

Wenn Ihre AWS CDK App nicht in einem Quell-Repository enthalten ist, muss sie sich in einem Artefakt befinden, das durch eine andere Aktion generiert wurde.

Weitere Informationen zu Quellen finden Sie unter Einen Workflow mit einem Quell-Repository verbinden.

Entsprechende Benutzeroberfläche: Registerkarte „Eingaben“/„Quellen“ — optional

Artifacts - input

(CDKBootstrapAction/Inputs/Artifacts)

(Erforderlich, wenn Ihre AWS CDK App in einem Ausgabeartefakt einer früheren Aktion gespeichert ist)

Wenn Ihre AWS CDK App in einem Artefakt enthalten ist, das durch eine vorherige Aktion generiert wurde, geben Sie dieses Artefakt hier an. Die AWS CDK Bootstrap-Aktion synthetisiert die App im angegebenen Artefakt zu einer CloudFormation Vorlage, bevor der Bootstrapping-Vorgang gestartet wird. Wenn Ihre AWS CDK App nicht in einem Artefakt enthalten ist, muss sie sich in Ihrem Quell-Repository befinden.

Weitere Informationen zu Artefakten, einschließlich Beispielen, finden Sie unter. Teilen von Daten zwischen Aktionen in einem Workflow mithilfe von Artefakten

Entsprechende Benutzeroberfläche: Registerkarte „Eingaben“/„Artefakte“ — optional

Outputs

(CDKBootstrapAction/Outputs)

(Optional)

Definiert die Daten, die von der Aktion während einer Workflow-Ausführung ausgegeben werden.

Entsprechende Benutzeroberfläche: Registerkarte „Ausgaben“

Artifacts - output

(CDKBootstrapAction/Outputs/Artifacts)

(Optional)

Geben Sie die durch die Aktion generierten Artefakte an. Sie können diese Artefakte als Eingabe in anderen Aktionen referenzieren.

Weitere Informationen zu Artefakten, einschließlich Beispielen, finden Sie unterTeilen von Daten zwischen Aktionen in einem Workflow mithilfe von Artefakten.

Entsprechende Benutzeroberfläche: Registerkarte Ausgaben/Artefakte

Name

(CDKBootstrapAction/Outputs/Artifacts/Name)

(Erforderlich, wenn Artifacts - output es enthalten ist)

Geben Sie den Namen des Artefakts an, das die AWS CloudFormation Vorlage enthalten soll, die zur Laufzeit durch die AWS CDK Bootstrap-Aktion synthetisiert wird. Der Standardwert ist cdk_bootstrap_artifacts. Wenn Sie kein Artefakt angeben, synthetisiert die Aktion die Vorlage, speichert sie jedoch nicht in einem Artefakt. Erwägen Sie, die synthetisierte Vorlage in einem Artefakt zu speichern, um sie zu Test- oder Fehlerbehebungszwecken aufzuzeichnen.

Entsprechende Benutzeroberfläche: Registerkarte Ausgaben/Artefakte/Artefakt hinzufügen/Namen des Artefakts erstellen

Files

(CDKBootstrapAction/Outputs/Artifacts/Files)

(Artifacts - outputErforderlich, falls enthalten)

Geben Sie die Dateien an, die in das Artefakt aufgenommen werden sollen. Sie müssen angeben"cdk.out/**/*", dass die synthetisierte AWS CloudFormation Vorlage Ihrer AWS CDK App eingeschlossen werden soll.

Anmerkung

cdk.outist das Standardverzeichnis, in dem synthetisierte Dateien gespeichert werden. Wenn Sie ein anderes Ausgabeverzeichnis als cdk.out in Ihrer cdk.json Datei angegeben haben, geben Sie dieses Verzeichnis hier statt ancdk.out.

Entsprechende Benutzeroberfläche: Registerkarte Ausgaben/Artefakte/Artefakte hinzufügen/Von build erzeugte Dateien

Environment

(CDKBootstrapAction/Environment)

(Erforderlich)

Geben Sie die Umgebung an, die für die Aktion verwendet werden soll. CodeCatalyst Die Aktion stellt eine Verbindung mit der AWS-Konto optionalen Amazon VPC her, die in der ausgewählten Umgebung angegeben ist. Die Aktion verwendet die in der Umgebung angegebene Standard-IAM-Rolle, um sich mit der Amazon VPC zu verbinden AWS-Konto, und verwendet die in der Amazon VPC-Verbindung angegebene IAM-Rolle, um eine Verbindung zur Amazon VPC herzustellen.

Anmerkung

Wenn die Standard-IAM-Rolle nicht über die für die Aktion erforderlichen Berechtigungen verfügt, können Sie die Aktion so konfigurieren, dass sie eine andere Rolle verwendet. Weitere Informationen finden Sie unter Einer Aktion eine andere IAM-Rolle zuweisen.

Weitere Informationen zu Umgebungen finden Sie unter Bereitstellung in AWS-Konten und VPCs mit Umgebungen CodeCatalyst undErstellen einer Umgebung.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Umgebung“

Name

(CDKBootstrapAction/Environment/Name)

(Erforderlich, wenn Environment es enthalten ist)

Geben Sie den Namen einer vorhandenen Umgebung an, die Sie der Aktion zuordnen möchten.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Umgebung“

Connections

(CDKBootstrapAction/Environment/Connections)

(Optional in neueren Versionen der Aktion; in älteren Versionen erforderlich)

Geben Sie die Kontoverbindung an, die der Aktion zugeordnet werden soll. Sie können unter maximal eine Kontoverbindung angebenEnvironment.

Wenn Sie keine Kontoverbindung angeben:

• Die Aktion verwendet die AWS-Konto Verbindung und die Standard-IAM-Rolle, die in der Umgebung in der CodeCatalyst Konsole angegeben sind. Informationen zum Hinzufügen einer Kontoverbindung und einer Standard-IAM-Rolle zur Umgebung finden Sie unter. Erstellen einer Umgebung

• Die Standard-IAM-Rolle muss die Richtlinien und Berechtigungen enthalten, die für die Aktion erforderlich sind. Informationen zu diesen Richtlinien und Berechtigungen finden Sie in der Beschreibung der Role-Eigenschaft in der YAML-Definitionsdokumentation der Aktion.

Weitere Informationen zu Kontoverbindungen finden Sie unterErmöglichen des Zugriffs auf AWS Ressourcen mit verbundenen AWS-Konten. Hinweise zum Hinzufügen einer Kontoverbindung zu einer Umgebung finden Sie unterErstellen einer Umgebung.

Entsprechende Benutzeroberfläche: Je nach Aktionsversion eine der folgenden Optionen:

• (Neuere Versionen) Registerkarte „Konfiguration“ /Umgebung/Was ist in meiner Umgebung? /Dreipunktmenü/ Rolle wechseln

• (Ältere Versionen) Registerkarte AWS „Konfiguration“ /„ Umgebung/Konto/Rolle“/Kontoverbindung

Name

(CDKBootstrapAction/Environment/Connections/Name)

Connections(Erforderlich, falls enthalten)

Geben Sie den Namen der Kontoverbindung an.

Entsprechende Benutzeroberfläche: Je nach Aktionsversion eine der folgenden Optionen:

• (Neuere Versionen) Registerkarte „Konfiguration“ /Umgebung/Was ist in meiner Umgebung? /Dreipunktmenü/ Rolle wechseln

• (Ältere Versionen) Registerkarte AWS „Konfiguration“ /„ Umgebung/Konto/Rolle“/Kontoverbindung

Role

(CDKBootstrapAction/Environment/Connections/Role)

Connections(Erforderlich, falls enthalten)

Geben Sie den Namen der IAM-Rolle an, mit der die AWS CDK Bootstrap-Aktion auf den Bootstrap-Stack zugreift AWS und ihn hinzufügt. Stellen Sie sicher, dass Sie die Rolle zu Ihrem CodeCatalyst Bereich hinzugefügt haben und dass die Rolle die folgenden Richtlinien enthält.

Wenn Sie keine IAM-Rolle angeben, verwendet die Aktion die Standard-IAM-Rolle, die in der Umgebung in der CodeCatalyst Konsole aufgeführt ist. Wenn Sie die Standardrolle in der Umgebung verwenden, stellen Sie sicher, dass sie über die folgenden Richtlinien verfügt.

Anmerkung

Die in der folgenden Berechtigungsrichtlinie angegebenen Berechtigungen sind diejenigen, die der cdk bootstrap Befehl benötigt, um das Bootstrapping zum Zeitpunkt des Schreibens durchzuführen. Diese Berechtigungen können sich ändern, wenn der AWS CDK Bootstrap-Befehl geändert wird.

Warnung

Verwenden Sie diese Rolle nur mit der AWS CDK Bootstrap-Aktion. Sie ist sehr freizügig und ihre Verwendung zusammen mit anderen Aktionen kann ein Sicherheitsrisiko darstellen.

• Die folgende Berechtigungsrichtlinie:

  {
      "Version": "2012-10-17",
      "Statement": [
          {
              "Sid": "VisualEditor0",
              "Effect": "Allow",
              "Action": [
                  "iam:GetRole",
                  "ssm:GetParameterHistory",
                  "ecr:PutImageScanningConfiguration",
                  "cloudformation:*",
                  "iam:CreateRole",
                  "iam:AttachRolePolicy",
                  "ssm:GetParameters",
                  "iam:PutRolePolicy",
                  "ssm:GetParameter",
                  "ssm:DeleteParameters",
                  "ecr:DeleteRepository",
                  "ssm:PutParameter",
                  "ssm:DeleteParameter",
                  "iam:PassRole",
                  "ecr:SetRepositoryPolicy",
                  "ssm:GetParametersByPath",
                  "ecr:DescribeRepositories",
                  "ecr:GetLifecyclePolicy"
              ],
              "Resource": [
                  "arn:aws:ssm:aws-region:aws-account:parameter/cdk-bootstrap/*",
                  "arn:aws:cloudformation:aws-region:aws-account:stack/CDKToolkit/*",
                  "arn:aws:ecr:aws-region:aws-account:repository/cdk-*",
                  "arn:aws:iam::aws-account:role/cdk-*"
              ]
          },
          {
              "Sid": "VisualEditor1",
              "Effect": "Allow",
              "Action": [
                  "cloudformation:RegisterType",
                  "cloudformation:CreateUploadBucket",
                  "cloudformation:ListExports",
                  "cloudformation:DescribeStackDriftDetectionStatus",
                  "cloudformation:SetTypeDefaultVersion",
                  "cloudformation:RegisterPublisher",
                  "cloudformation:ActivateType",
                  "cloudformation:ListTypes",
                  "cloudformation:DeactivateType",
                  "cloudformation:SetTypeConfiguration",
                  "cloudformation:DeregisterType",
                  "cloudformation:ListTypeRegistrations",
                  "cloudformation:EstimateTemplateCost",
                  "cloudformation:DescribeAccountLimits",
                  "cloudformation:BatchDescribeTypeConfigurations",
                  "cloudformation:CreateStackSet",
                  "cloudformation:ListStacks",
                  "cloudformation:DescribeType",
                  "cloudformation:ListImports",
                  "s3:*",
                  "cloudformation:PublishType",
                  "ecr:CreateRepository",
                  "cloudformation:DescribePublisher",
                  "cloudformation:DescribeTypeRegistration",
                  "cloudformation:TestType",
                  "cloudformation:ValidateTemplate",
                  "cloudformation:ListTypeVersions"
              ],
              "Resource": "*"
          }
      ]
  }

  Anmerkung

  Wenn die Rolle zum ersten Mal verwendet wird, verwenden Sie den folgenden Platzhalter in der Ressourcenrichtlinien-Anweisung und grenzen Sie dann die Richtlinie mit dem Ressourcennamen ab, sobald sie verfügbar ist.

  "Resource": "*"

• Die folgende benutzerdefinierte Vertrauensrichtlinie:

  {
      "Version": "2012-10-17",
      "Statement": [
          {
              "Sid": "",
              "Effect": "Allow",
              "Principal": {
                  "Service":  [
                     "codecatalyst-runner.amazonaws.com",
                     "codecatalyst.amazonaws.com"
                   ]
              },
              "Action": "sts:AssumeRole"
          }
      ]
  }

Anmerkung

Sie können die CodeCatalystWorkflowDevelopmentRole-spaceName Rolle mit dieser Aktion verwenden, wenn Sie möchten. Weitere Informationen über diese Rolle finden Sie unter Die CodeCatalystWorkflowDevelopmentRole-spaceNameRolle für Ihr Konto und Ihren Bereich erstellen. Beachten Sie, dass die CodeCatalystWorkflowDevelopmentRole-spaceName Rolle über volle Zugriffsberechtigungen verfügt, was ein Sicherheitsrisiko darstellen kann. Wir empfehlen, diese Rolle nur in Tutorials und Szenarien zu verwenden, in denen die Sicherheit weniger wichtig ist.

Entsprechende Benutzeroberfläche: Je nach Aktionsversion eine der folgenden Optionen:

• (Neuere Versionen) Registerkarte „Konfiguration“ /Umgebung/Was ist in meiner Umgebung? /Dreipunktmenü/ Rolle wechseln

• (Ältere Versionen) Registerkarte „Konfiguration“ /„ Umgebung/Konto/Rolle“/Rolle

Configuration

(CDKBootstrapAction/Configuration)

(Erforderlich)

Ein Abschnitt, in dem Sie die Konfigurationseigenschaften der Aktion definieren können.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“

Region

(CDKBootstrapAction/Configuration/Region)

(Erforderlich)

Geben Sie an, AWS-Region in welchem Bereich der Bootstrap-Stack bereitgestellt werden soll. Diese Region sollte mit der Region übereinstimmen, in der Ihre AWS CDK App bereitgestellt wird. Eine Liste der Regionscodes finden Sie unter Regionale Endpunkte.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Region“

CdkCliVersion

(CDKBootstrapAction/Configuration/CdkCliVersion)

(Optional)

Diese Eigenschaft ist in Version 1.0.13 oder höher der AWS CDK Bereitstellungsaktion und Version 1.0.8 oder höher der AWS CDK Bootstrap-Aktion verfügbar.

Geben Sie eines der folgenden Elemente an:

• Die Vollversion der AWS Cloud Development Kit (AWS CDK) Befehlszeilenschnittstelle (CLI) (auch AWS CDK Toolkit genannt), die diese Aktion verwenden soll. Beispiel: 2.102.1. Erwägen Sie die Angabe einer Vollversion, um Konsistenz und Stabilität beim Erstellen und Bereitstellen Ihrer Anwendung zu gewährleisten.

  Oder

• latest. Erwägen Sie latest die Angabe, um die neuesten Funktionen und Korrekturen der CDK-CLI nutzen zu können.

Die Aktion lädt die angegebene Version (oder die neueste Version) der AWS CDK CLI auf das CodeCatalyst Build-Image herunter und verwendet dann diese Version, um die Befehle auszuführen, die für die Bereitstellung Ihrer CDK-Anwendung oder das Bootstrap Ihrer AWS Umgebung erforderlich sind.

Eine Liste der unterstützten CDK-CLI-Versionen, die Sie verwenden können, finden Sie unter AWS CDK Versionen.

Wenn Sie diese Eigenschaft weglassen, verwendet die Aktion eine AWS CDK Standard-CLI-Version, die in einem der folgenden Themen beschrieben wird:

• CDK-CLI-Versionen, die von der Aktion „AWS CDK Deploy“ verwendet werden

• CDK-CLI-Versionen, die von der Aktion „AWS CDK Bootstrap“ verwendet werden

Entsprechende Benutzeroberfläche: Registerkarte „AWS CDK Konfiguration/CLI-Version“