Aktion „ AWS CloudFormation Stack bereitstellen“ YAML

Im Folgenden finden Sie die YAML Definition der AWS CloudFormation Stack-Aktion Deploy. Informationen zur Verwendung dieser Aktion finden Sie unterEinen AWS CloudFormation Stack bereitstellen.

Diese Aktionsdefinition ist als Abschnitt in einer umfassenderen Workflow-Definitionsdatei vorhanden. Weitere Informationen über diese Datei finden Sie unter YAMLWorkflow-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.    
  DeployCloudFormationStack:  
    Identifier: aws/cfn-deploy@v1
    DependsOn:
      - build-action
    Compute:  
      Type: EC2 | Lambda
      Fleet: fleet-name
    Timeout: timeout-minutes
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: DeployRole
    Inputs:
      Sources:
        - source-name-1
      Artifacts:
        - CloudFormation-artifact
    Configuration:
      name: stack-name
      region: us-west-2
      template: template-path
      role-arn: arn:aws:iam::123456789012:role/StackRole        
      capabilities: CAPABILITY_IAM,CAPABILITY_NAMED_IAM,CAPABILITY_AUTO_EXPAND
      parameter-overrides: KeyOne=ValueOne,KeyTwo=ValueTwo | path-to-JSON-file
      no-execute-changeset: 1|0
      fail-on-empty-changeset: 1|0
      disable-rollback: 1|0
      termination-protection: 1|0
      timeout-in-minutes: minutes
      notification-arns: arn:aws:sns:us-east-1:123456789012:MyTopic,arn:aws:sns:us-east-1:123456789012:MyOtherTopic
      monitor-alarm-arns: arn:aws:cloudwatch::123456789012:alarm/MyAlarm,arn:aws:cloudwatch::123456789012:alarm/MyOtherAlarm
      monitor-timeout-in-minutes: minutes       
      tags: '[{"Key":"MyKey1","Value":"MyValue1"},{"Key":"MyKey2","Value":"MyValue2"}]'

DeployCloudFormationStack

(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: DeployCloudFormationStack_nn.

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

Identifier

(DeployCloudFormationStack/Identifier)

(Erforderlich)

Identifiziert die Aktion. Ändern Sie diese Eigenschaft nur, wenn Sie die Version ändern möchten. Weitere Informationen finden Sie unter Angabe der zu verwendenden Aktionsversion.

Standard: aws/cfn-deploy@v1.

Entsprechende Benutzeroberfläche: Workflow-Diagram/ DeployCloudFormationStack _nn/ aws/cfn-deploy @v1 label

DependsOn

(DeployCloudFormationStack/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 sequenzieren

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

Compute

(DeployCloudFormationStack/Compute)

(Optional)

Die Rechen-Engine, mit der Ihre Workflow-Aktionen ausgeführt wurden. 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

(DeployCloudFormationStack/Compute/Type)

(ComputeErforderlich, falls enthalten)

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

EC2(visueller Editor) oder EC2 (YAMLEditor)

Optimiert für Flexibilität bei Aktionsläufen.
Lambda (visueller Editor) oder Lambda (YAMLEditor)

Optimierte Startgeschwindigkeiten für Aktionen.

Weitere Informationen zu Datentypen finden Sie unter Berechnungstypen.

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

Fleet

(DeployCloudFormationStack/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

(DeployCloudFormationStack/Timeout)

(Optional)

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

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

Environment

(DeployCloudFormationStack/Environment)

(Erforderlich)

Geben Sie die CodeCatalyst Umgebung an, die für die Aktion verwendet werden soll. Die Aktion stellt eine Verbindung zu dem in der ausgewählten Umgebung VPC angegebenen AWS-Konto und optionalen Amazon her. Die Aktion verwendet die in der Umgebung angegebene IAM Standardrolle, um eine Verbindung zum herzustellen AWS-Konto, und verwendet die in der VPCAmazon-Verbindung angegebene IAM Rolle, um eine Verbindung zum Amazon herzustellenVPC.

Anmerkung

Wenn die IAM Standardrolle 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 Die IAM Rolle einer Aktion ändern.

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

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Umgebung“

Name

(DeployCloudFormationStack/Environment/Name)

(Erforderlich, falls Environment enthalten)

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

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Umgebung“

Connections

(DeployCloudFormationStack/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 IAM Standardrolle, die in der Umgebung in der CodeCatalyst Konsole angegeben sind. Informationen zum Hinzufügen einer Kontoverbindung und einer IAM Standardrolle zur Umgebung finden Sie unterErstellen einer Umgebung.
Die IAM Standardrolle 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 drin my-environment? /Dreipunktmenü/ Rolle wechseln
(Ältere Versionen) Registerkarte AWS „Konfiguration“ /„ Umgebung/Konto/Rolle“/Kontoverbindung

Name

(DeployCloudFormationStack/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 drin my-environment? /Dreipunktmenü/ Rolle wechseln
(Ältere Versionen) Registerkarte AWS „Konfiguration“ /„ Umgebung/Konto/Rolle“/Kontoverbindung

Role

(DeployCloudFormationStack/Environment/Connections/Role)

Connections(Erforderlich, falls enthalten)

Geben Sie den Namen der IAM Rolle an, die von der AWS CloudFormation Stack-Aktion Deploy für den Zugriff auf AWS den AWS CloudFormation Dienst verwendet wird. 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 IAM Standardrolle, 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.

Die folgende Berechtigungsrichtlinie:

Warnung

Beschränken Sie die Berechtigungen auf die in der folgenden Richtlinie angegebenen. Die Verwendung einer Rolle mit umfassenderen Berechtigungen kann ein Sicherheitsrisiko darstellen.


{
    "Version": "2012-10-17",
    "Statement": [{
    "Action": [
        "cloudformation:CreateStack",
        "cloudformation:DeleteStack",
        "cloudformation:Describe*",
        "cloudformation:UpdateStack",
        "cloudformation:CreateChangeSet",
        "cloudformation:DeleteChangeSet",
        "cloudformation:ExecuteChangeSet",
        "cloudformation:SetStackPolicy",
        "cloudformation:ValidateTemplate",
        "cloudformation:List*",
        "iam:PassRole"
    ],
    "Resource": "*",
    "Effect": "Allow"
}]
}

Anmerkung

Wenn die Rolle zum ersten Mal verwendet wird, verwenden Sie den folgenden Platzhalter in der Ressourcenrichtlinienanweisung 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 drin my-environment? /Dreipunktmenü/ Rolle wechseln
(Ältere Versionen) Registerkarte „Konfiguration“ /„ Umgebung/Konto/Rolle“/Rolle

Inputs

(DeployCloudFormationStack/Inputs)

(Optional)

In Inputs diesem Abschnitt werden die Daten definiert, die während einer Workflow-Ausführung benötigt werden. DeployCloudFormationStack

Anmerkung

Pro AWS CloudFormation Stack-Aktion vom Typ Deploy sind maximal vier Eingaben (eine Quelle und drei Artefakte) zulässig.

Wenn Sie auf Dateien verweisen müssen, die sich in verschiedenen Eingaben befinden (z. B. eine Quelle und ein Artefakt), ist die Quelleingabe die primäre Eingabe und das Artefakt die sekundäre Eingabe. Verweise auf Dateien in sekundären Eingaben benötigen ein spezielles Präfix, um sie von der primären Eingabe zu unterscheiden. Details hierzu finden Sie unter Beispiel: Referenzieren von Dateien in mehreren Artefakten.

Entsprechende Benutzeroberfläche: Registerkarte „Eingaben“

Sources

(DeployCloudFormationStack/Inputs/Sources)

(Erforderlich, wenn Ihre AWS SAM Vorlage CloudFormation oder Ihre Vorlage in einem Quell-Repository gespeichert ist)

Wenn Ihre AWS SAM Vorlage CloudFormation oder Ihre Vorlage in einem Quell-Repository gespeichert ist, geben Sie die Bezeichnung dieses Quell-Repositorys an. Derzeit ist das einzige unterstützte LabelWorkflowSource.

Wenn Ihre AWS SAM Vorlage CloudFormation oder nicht in einem Quell-Repository enthalten ist, muss sie sich in einem Artefakt befinden, das durch eine andere Aktion generiert wurde, oder in einem Amazon S3 S3-Bucket.

Weitere Informationen zu Quellen finden Sie unter Quell-Repositorys mit Workflows verbinden.

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

Artifacts - input

(DeployCloudFormationStack/Inputs/Artifacts)

(Erforderlich, wenn Ihre AWS SAM Vorlage CloudFormation oder Ihre Vorlage in einem Ausgabeartefakt einer vorherigen Aktion gespeichert ist)

Wenn die AWS SAM Vorlage CloudFormation oder, die Sie bereitstellen möchten, in einem Artefakt enthalten ist, das durch eine vorherige Aktion generiert wurde, geben Sie dieses Artefakt hier an. Wenn Ihre CloudFormation Vorlage nicht in einem Artefakt enthalten ist, muss sie sich in Ihrem Quell-Repository oder in einem Amazon S3 S3-Bucket befinden.

Weitere Informationen zu Artefakten, einschließlich Beispielen, finden Sie unter. Artefakte und Dateien zwischen Aktionen teilen

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

Configuration

(DeployCloudFormationStack/Configuration)

(Erforderlich)

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

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“

name

(DeployCloudFormationStack/Configuration/name)

(Erforderlich)

Geben Sie einen Namen für den CloudFormation Stack an, den die Aktion AWS CloudFormation Stack bereitstellen erstellt oder aktualisiert.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“/Name des Stacks

region

(DeployCloudFormationStack/Configuration/region)

(Erforderlich)

Geben Sie an, AWS-Region in welchem Bereich der Stack bereitgestellt werden soll. Eine Liste der Regionscodes finden Sie unter Regionale Endpunkte.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“/Region „Stack“

template

(DeployCloudFormationStack/Configuration/template)

(Erforderlich)

Geben Sie den Namen und den Pfad zu Ihrer Datei CloudFormation oder der AWS SAM Vorlagendatei an. Die Vorlage kann im JSON YAML Oder-Format vorliegen und sich in einem Quell-Repository, einem Artefakt aus einer vorherigen Aktion oder einem Amazon S3 S3-Bucket befinden. Wenn sich die Vorlagendatei in einem Quell-Repository oder Artefakt befindet, ist der Pfad relativ zur Quelle oder zum Artefakt-Stamm. Wenn sich die Vorlage in einem Amazon S3 S3-Bucket befindet, entspricht der Pfad dem URLObjektwert der Vorlage.

Beispiele:

./MyFolder/MyTemplate.json

MyFolder/MyTemplate.yml

https://MyBucket.s3.us-west-2.amazonaws.com/MyTemplate.yml

Anmerkung

Möglicherweise müssen Sie dem Dateipfad der Vorlage ein Präfix hinzufügen, um anzugeben, in welchem Artefakt oder in welcher Quelle die Vorlage gefunden werden soll. Weitere Informationen finden Sie unter Quell-Repository-Dateien referenzieren und Referenzieren von Dateien in einem Artefakt.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Vorlage“

role-arn

(DeployCloudFormationStack/Configuration/role-arn)

(Erforderlich)

Geben Sie den Amazon-Ressourcennamen (ARN) der Stack-Rolle an. CloudFormation verwendet diese Rolle, um auf Ressourcen in Ihrem Stack zuzugreifen und diese zu ändern. Zum Beispiel: arn:aws:iam::123456789012:role/StackRole.

Stellen Sie sicher, dass die Stack-Rolle Folgendes beinhaltet:

Eine oder mehrere Berechtigungsrichtlinien. Die Richtlinien hängen von den Ressourcen ab, die Sie in Ihrem Stack haben. Wenn Ihr Stack beispielsweise eine AWS Lambda Funktion enthält, müssen Sie Berechtigungen hinzufügen, die Zugriff auf Lambda gewähren. Wenn Sie das unter beschriebene Tutorial befolgt habenTutorial: Eine serverlose Anwendung bereitstellen, enthält es ein Verfahren mit dem Titel, Um eine Stack-Rolle zu erstellen das die Berechtigungen auflistet, die die Stack-Rolle benötigt, wenn Sie einen typischen serverlosen Anwendungsstapel bereitstellen.

Warnung
Beschränken Sie die Berechtigungen auf diejenigen, die der CloudFormation Dienst für den Zugriff auf Ressourcen in Ihrem Stack benötigt. Die Verwendung einer Rolle mit umfassenderen Berechtigungen kann ein Sicherheitsrisiko darstellen.

Die folgende Vertrauensrichtlinie:


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

Ordnen Sie diese Rolle optional Ihrer Kontoverbindung zu. Weitere Informationen zum Zuordnen einer IAM Rolle zu einer Kontoverbindung finden Sie unterIAMRollen zu Kontoverbindungen hinzufügen. Wenn Sie die Stack-Rolle nicht mit der Kontoverbindung verknüpfen, wird die Stack-Rolle nicht in der Dropdownliste Stack-Rolle im Visual Editor angezeigt. Die Rolle ARN kann jedoch trotzdem mithilfe des YAML Editors in dem role-arn Feld angegeben werden.

Anmerkung

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

capabilities

(DeployCloudFormationStack/Configuration/capabilities)

(Erforderlich)

Geben Sie eine Liste von IAM Funktionen an, die erforderlich sind, um bestimmte AWS CloudFormation Stacks erstellen zu können. In den meisten Fällen können Sie capabilities den Standardwert von CAPABILITY_IAM,CAPABILITY_NAMED_IAM,CAPABILITY_AUTO_EXPAND beibehalten.

Wenn Sie ##[error] requires capabilities: [capability-name] in den Protokollen Ihrer AWS CloudFormation Stack-Aktion „Bereitstellen“ etwas sehen, finden Sie unter Informationen Wie behebe IAM ich Funktionsfehler? zur Behebung des Problems.

Weitere Informationen zu IAM Funktionen finden Sie im IAMBenutzerhandbuch unter Bestätigung von IAM Ressourcen in AWS CloudFormation Vorlagen.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“ /Erweitert/Funktionen

parameter-overrides

(DeployCloudFormationStack/Configuration/parameter-overrides)

(Optional)

Geben Sie in Ihrer AWS CloudFormation AWS SAM Vorlage Parameter an, die keine Standardwerte haben oder für die Sie nicht standardmäßige Werte angeben möchten. Weitere Informationen zu Parametern finden Sie unter Parameter im AWS CloudFormation Benutzerhandbuch.

Die parameter-overrides Unterkunft akzeptiert:

Eine JSON Datei, die die Parameter und Werte enthält.
Eine durch Kommas getrennte Liste von Parametern und Werten.

Um eine Datei anzugeben JSON

Stellen Sie sicher, dass die JSON Datei eine der folgenden Syntaxen verwendet:
```
{
  "Parameters": {
    "Param1": "Value1",
    "Param2": "Value2",
    ...
  }
}
```
Oder...
```
[
  {
     "ParameterKey": "Param1",
     "ParameterValue": "Value1"
  },
  ...
]
```
(Es gibt andere Syntaxen, aber sie werden CodeCatalyst zum Zeitpunkt des Schreibens nicht unterstützt.) Weitere Informationen zum Angeben von CloudFormation Parametern in einer JSON Datei finden Sie unter Unterstützte JSON Syntax in der AWS CLI Befehlsreferenz.

Geben Sie den Pfad zur JSON Datei in einem der folgenden Formate an:

Wenn sich Ihre JSON Datei in einem Ausgabeartefakt einer früheren Aktion befindet, verwenden Sie:

file:///artifacts/current-action-name/output-artifact-name/path-to-json-file

Einzelheiten finden Sie in Beispiel 1.

Wenn sich Ihre JSON Datei in Ihrem Quell-Repository befindet, verwenden Sie:

file:///sources/WorkflowSource/path-to-json-file

Einzelheiten finden Sie in Beispiel 2.

Beispiel 1 — Die JSON Datei befindet sich in einem Ausgabeartefakt


##My workflow YAML
...
Actions:
  MyBuildAction:
    Identifier: aws/build@v1
    Outputs:
      Artifacts:
        - Name: ParamArtifact
          Files:
            - params.json
    Configuration:
    ...
  MyDeployCFNStackAction:
    Identifier: aws/cfn-deploy@v1
    Configuration:
      parameter-overrides: file:///artifacts/MyDeployCFNStackAction/ParamArtifact/params.json

Beispiel 2 — Die JSON Datei befindet sich in Ihrem Quell-Repository, in einem Ordner namens my/folder


##My workflow YAML
...
Actions:
  MyDeployCloudFormationStack:
    Identifier: aws/cfn-deploy@v1
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:
      parameter-overrides: file:///sources/WorkflowSource/my/folder/params.json

Um eine durch Kommas getrennte Liste von Parametern zu verwenden

Fügen Sie der parameter-overrides Eigenschaft Parameter-Name-Wert-Paare im folgenden Format hinzu:

param-1=value-1,param-2=value-2

Nehmen wir zum Beispiel die folgende Vorlage an: AWS CloudFormation
```
##My CloudFormation template

Description: My AWS CloudFormation template

Parameters:
  InstanceType:
    Description: Defines the Amazon EC2 compute for the production server.
    Type: String
    Default: t2.micro
    AllowedValues:
      - t2.micro
      - t2.small
      - t3.medium
    
Resources:
...
```
... Sie könnten die parameter-overrides Eigenschaft wie folgt festlegen:
```
##My workflow YAML
...
Actions:
...
  DeployCloudFormationStack:
    Identifier: aws/cfn-deploy@v1
    Configuration:
      parameter-overrides: InstanceType=t3.medium,UseVPC=true   
```
Anmerkung
Sie können einen Parameternamen ohne einen entsprechenden Wert angeben, indem Sie undefined ihn als Wert verwenden. Beispielsweise:
parameter-overrides: MyParameter=undefined
Das hat zur Folge, dass bei einem Stack-Update der vorhandene Parameterwert für den angegebenen Parameternamen CloudFormation verwendet wird.

Entsprechende Benutzeroberfläche:

Registerkarte „Konfiguration/Erweitert/Parameterüberschreibungen“
Registerkarte „Konfiguration/Erweitert/Parameter-Überschreibungen“/Geben Sie Überschreibungen mithilfe einer Datei an
Registerkarte „Konfiguration/Erweitert/Parameter-Überschreibungen“/Geben Sie Überschreibungen mithilfe eines Wertesatzes an

no-execute-changeset

(DeployCloudFormationStack/Configuration/no-execute-changeset)

(Optional)

Geben Sie an, ob Sie den CloudFormation Änderungssatz erstellen und dann CodeCatalyst beenden möchten, bevor Sie ihn ausführen. Auf diese Weise haben Sie die Möglichkeit, den Änderungssatz in der CloudFormation Konsole zu überprüfen. Wenn Sie feststellen, dass der Änderungssatz gut aussieht, deaktivieren Sie diese Option und führen Sie dann den Workflow erneut aus, sodass Sie den Änderungssatz erstellen und ausführen CodeCatalyst können, ohne ihn anzuhalten. Standardmäßig wird der Änderungssatz erstellt und ausgeführt, ohne ihn anzuhalten. Weitere Informationen finden Sie im AWS CloudFormation Deploy-Parameter in der AWS CLI Befehlsreferenz. Weitere Informationen zum Anzeigen von Änderungssätzen finden Sie im AWS CloudFormation Benutzerhandbuch unter Änderungssätze anzeigen.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“ /Erweitert/Änderungssatz nicht ausführen

fail-on-empty-changeset

(DeployCloudFormationStack/Configuration/fail-on-empty-changeset)

(Optional)

Geben Sie an, ob die Aktion „ AWS CloudFormation Stack bereitstellen“ fehlschlagen soll CodeCatalyst , wenn der CloudFormation Änderungssatz leer ist. (Wenn ein Änderungssatz leer ist, bedeutet dies, dass während der letzten Bereitstellung keine Änderungen am Stack vorgenommen wurden.) Standardmäßig kann die Aktion fortgesetzt werden, wenn der Änderungssatz leer ist, und es wird eine UPDATE_COMPLETE Meldung zurückgegeben, obwohl der Stack nicht aktualisiert wurde.

Weitere Informationen zu dieser Einstellung finden Sie im AWS CloudFormation Deploy-Parameter in der AWS CLI Befehlsreferenz. Weitere Informationen zu Änderungssätzen finden Sie unter Aktualisieren von Stacks mithilfe von Änderungssätzen im AWS CloudFormation Benutzerhandbuch.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“ /Erweitert/Fehler bei leerem Changeset

disable-rollback

(DeployCloudFormationStack/Configuration/disable-rollback)

(Optional)

Geben Sie an, ob Sie die Stack-Bereitstellung rückgängig CodeCatalyst machen möchten, falls sie fehlschlägt. Durch das Rollback wird der Stack in den letzten bekannten stabilen Zustand zurückversetzt. Standardmäßig werden Rollbacks aktiviert. Weitere Informationen zu dieser Einstellung finden Sie im AWS CloudFormation Deploy-Parameter in der AWS CLI Befehlsreferenz.

Weitere Informationen dazu, wie die Aktion AWS CloudFormation Stack bereitstellen Rollbacks behandelt, finden Sie unterRollbacks konfigurieren.

Weitere Informationen zum Rollback eines Stacks finden Sie unter Optionen für Stack-Fehler im AWS CloudFormation Benutzerhandbuch.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“ /Erweitert/Rollback deaktivieren

termination-protection

(DeployCloudFormationStack/Configuration/termination-protection)

(Optional)

Geben Sie an, ob der AWS CloudFormation Deploy-Stack dem Stack, den er bereitstellt, einen Kündigungsschutz hinzufügen soll. Wenn ein Benutzer versucht, einen Stack mit aktiviertem Beendigungsschutz zu löschen, schlägt das Löschen fehl und der Stack – einschließlich seines Status – bleibt unverändert. Standardmäßig ist der Kündigungsschutz deaktiviert. Weitere Informationen finden Sie im AWS CloudFormation Benutzerhandbuch unter Einen Stack vor dem Löschen schützen.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Erweitert/Kündigungsschutz“

timeout-in-minutes

(DeployCloudFormationStack/Configuration/timeout-in-minutes)

(Optional)

Geben Sie die Zeitspanne in Minuten an, die zur Verfügung stehen CloudFormation soll, bevor bei der Stackerstellung ein Timeout eintritt und der Stack-Status auf gesetzt wird. CREATE_FAILED Wenn der gesamte Stapel nicht in der vorgesehenen Zeit erstellt werden CloudFormation kann, schlägt die Erstellung des Stapels aufgrund eines Timeouts fehl und der Stapel wird zurückgesetzt.

Standardmäßig gibt es keinen Timeout für die Stack-Erstellung. Allerdings gibt es möglicherweise für einzelne Ressourcen einen Timeout, basierend auf der Art des von ihnen implementierten Services. Wenn beispielsweise eine einzelne Ressource in Ihrem Stack abläuft, läuft die Stack-Erstellung ebenfalls aus, auch wenn der von Ihnen angegebene Timeout für die Stack-Erstellung noch nicht erreicht wurde.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Erweitert/Timeout“ CloudFormation

notification-arns

(DeployCloudFormationStack/Configuration/notification-arns)

(Optional)

Geben Sie das ARN SNS Amazon-Thema an, CodeCatalyst an das Sie Benachrichtigungen senden möchten. z. B. arn:aws:sns:us-east-1:111222333:MyTopic. Wenn die Aktion „ AWS CloudFormation Stack bereitstellen“ ausgeführt wird CodeCatalyst , wird CloudFormation festgelegt, dass pro AWS CloudFormation Ereignis, das während der Erstellung oder Aktualisierung des Stacks auftritt, eine Benachrichtigung gesendet wird. (Die Ereignisse sind auf der Registerkarte Ereignisse der AWS CloudFormation Konsole für den Stack sichtbar.) Sie können bis zu fünf Themen angeben. Weitere Informationen finden Sie unter Was ist AmazonSNS? .

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration/Erweitert/Benachrichtigung“ ARNs

monitor-alarm-arns

(DeployCloudFormationStack/Configuration/monitor-alarm-arns)

(Optional)

Geben Sie den Amazon-Ressourcennamen (ARN) eines CloudWatch Amazon-Alarms an, der als Rollback-Trigger verwendet werden soll. z. B. arn:aws:cloudwatch::123456789012:alarm/MyAlarm. Sie können maximal fünf Rollback-Trigger haben.

Anmerkung

Wenn Sie einen CloudWatch Alarm angebenARN, müssen Sie auch zusätzliche Berechtigungen konfigurieren, damit die Aktion darauf zugreifen CloudWatch kann. Weitere Informationen finden Sie unter Rollbacks konfigurieren.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“ /„ Erweitert/Alarm überwachen“ ARNs

monitor-timeout-in-minutes

(DeployCloudFormationStack/Configuration/monitor-timeout-in-minutes)

(Optional)

Geben Sie einen Zeitraum zwischen 0 und 180 Minuten an, in dem die angegebenen Alarme CloudFormation überwacht werden. Die Überwachung beginnt, nachdem alle Stack-Ressourcen bereitgestellt wurden. Wenn der Alarm innerhalb der angegebenen Überwachungszeit auftritt, CloudFormation schlägt die Bereitstellung fehl und der gesamte Stack-Vorgang wird rückgängig gemacht.

Standard: 0. CloudFormation überwacht Alarme nur, während die Stack-Ressourcen bereitgestellt werden, nicht danach.

Entsprechende Benutzeroberfläche: Registerkarte „Konfiguration“ /„ Erweitert/Zeit überwachen“